Skip to contentSkip to conversation

Add generic early debug UART feature

PATCH Superseded Simon Glass 2 participants 9 messages Jan 27, 2015 – Feb 19, 2015

lore
Share & tools
lore
#0 lore raw

v2 cover Add generic early debug UART feature

This series adds debug UART infrastructure which can in principle be used on any architecture. It works best with those that don't need a stack to call functions (e.g. ARM, PowerPC).

This came up in a discussion on the mailing list here:

    https://patchwork.ozlabs.org/patch/384613/

My concerns at the time were:
- it doesn't need to be written in assembler
- it doesn't need to be ARM-specific
- it only supports one serial driver

This potentially creates a problem where to support n architectures and m serial drivers we need n * m lots of assembler-coded functions. For example, in Linux for ARM we have:

../plat-spear/include/plat/debug-macro.S
../mach-s5pc100/include/mach/debug-macro.S
../mach-shark/include/mach/debug-macro.S
../mach-spear3xx/include/mach/debug-macro.S
../mach-sa1100/include/mach/debug-macro.S
../mach-l7200/include/mach/debug-macro.S
../mach-mv78xx0/include/mach/debug-macro.S
../mach-realview/include/mach/debug-macro.S
../mach-mmp/include/mach/debug-macro.S
../mach-s3c64xx/include/mach/debug-macro.S
../mach-s5pv210/include/mach/debug-macro.S
../mach-clps711x/include/mach/debug-macro.S
../mach-versatile/include/mach/debug-macro.S
../mach-iop32x/include/mach/debug-macro.S
../mach-ebsa110/include/mach/debug-macro.S
../mach-ux500/include/mach/debug-macro.S
../mach-orion5x/include/mach/debug-macro.S
../mach-lpc32xx/include/mach/debug-macro.S
../mach-vt8500/include/mach/debug-macro.S
../mach-rpc/include/mach/debug-macro.S
../mach-kirkwood/include/mach/debug-macro.S
../mach-spear6xx/include/mach/debug-macro.S
../mach-footbridge/include/mach/debug-macro.S
../mach-davinci/include/mach/debug-macro.S
../plat-samsung/include/plat/debug-macro.S
../mach-spear13xx/include/mach/debug-macro.S
../mach-exynos/include/mach/debug-macro.S
../mach-exynos/include/mach/regs-debug.h
../mach-dove/include/mach/debug-macro.S
../mach-omap1/include/mach/debug-macro.S
../mach-u300/include/mach/debug-macro.S
../mach-bcm2835/include/mach/debug-macro.S
../mach-h720x/include/mach/debug-macro.S
../mach-ep93xx/include/mach/debug-macro.S
../mach-gemini/include/mach/debug-macro.S
../mach-s3c24xx/include/mach/debug-macro.S
../mach-at91/include/mach/debug-macro.S
../mach-ixp4xx/include/mach/debug-macro.S
../mach-nomadik/include/mach/debug-macro.S
../mach-cns3xxx/include/mach/debug-macro.S
../mach-mxs/include/mach/debug-macro.S
../mach-iop33x/include/mach/debug-macro.S
../mach-ks8695/include/mach/debug-macro.S
../mach-netx/include/mach/debug-macro.S
../mach-iop13xx/include/mach/debug-macro.S
../mach-integrator/include/mach/debug-macro.S
../mach-msm/include/mach/debug-macro.S
../mach-pxa/include/mach/debug-macro.S
../mach-s5p64x0/include/mach/debug-macro.S
../mach-prima2/include/mach/debug-macro.S
../mach-omap2/include/mach/debug-macro.S

This series provides a possible alternative. It works by allowing any serial driver to export one init function and provide a putc() function. These can be used to output debug data before the real serial driver is available. Only one debug UART can be used at a time, and its address and serial clock must be provided statically in Kconfig.

This implementation does not depend on driver model being set up, and it is possible for it to operate without a stack on some architectures (e.g. PowerPC, ARM). It provides the same features as the ARM-specific debug.S but with more UART and architecture support.

As an example, here is the code generated for printch() by gcc 4.8 on ARM using the ns16550 driver (Tegra Seaboard):

0013b3b0 <printch>:

  13b3b0:       e59f201c        ldr     r2, [pc, #28]   ; 13b3d4 <printch+0x24>
  13b3b4:       e5d23305        ldrb    r3, [r2, #773]  ; 0x305
  13b3b8:       e6ef3073        uxtb    r3, r3
  13b3bc:       e3130020        tst     r3, #32
  13b3c0:       0afffffb        beq     13b3b4 <printch+0x4>
  13b3c4:       e6ef0070        uxtb    r0, r0
  13b3c8:       e59f3004        ldr     r3, [pc, #4]    ; 13b3d4 <printch+0x24>
  13b3cc:       e5c30300        strb    r0, [r3, #768]  ; 0x300
  13b3d0:       e12fff1e        bx      lr
  13b3d4:       70006000        .word   0x70006000

The PowerPC 4xx code (ELDK-5.3) for printhex8() is this:

0102db44 <printhex8>:

 102db44:       3c c0 ef 60     lis     r6,-4256
 102db48:       3c e0 ef 60     lis     r7,-4256
 102db4c:       39 20 00 1c     li      r9,28
 102db50:       60 c6 03 05     ori     r6,r6,773
 102db54:       60 e7 03 00     ori     r7,r7,768
 102db58:       7c 6a 4c 30     srw     r10,r3,r9
 102db5c:       55 4a 07 3e     clrlwi  r10,r10,28
 102db60:       2b 8a 00 09     cmplwi  cr7,r10,9
 102db64:       39 0a 00 30     addi    r8,r10,48
 102db68:       40 9d 00 08     ble-    cr7,102db70 <printhex8+0x2c>
 102db6c:       39 0a 00 57     addi    r8,r10,87
 102db70:       7c 00 04 ac     sync
 102db74:       89 46 00 00     lbz     r10,0(r6)
 102db78:       0c 0a 00 00     twi     0,r10,0
 102db7c:       4c 00 01 2c     isync
 102db80:       55 4a 06 b4     rlwinm  r10,r10,0,26,26
 102db84:       71 45 00 ff     andi.   r5,r10,255
 102db88:       41 82 ff e8     beq+    102db70 <printhex8+0x2c>
 102db8c:       55 08 06 3e     clrlwi  r8,r8,24
 102db90:       7c 00 04 ac     sync
 102db94:       99 07 00 00     stb     r8,0(r7)
 102db98:       2f 89 00 00     cmpwi   cr7,r9,0
 102db9c:       39 29 ff fc     addi    r9,r9,-4
 102dba0:       40 9e ff b8     bne+    cr7,102db58 <printhex8+0x14>
 102dba4:       4e 80 00 20     blr

However this is somewhat toolchain-dependent. For example, some toolchains may spill over the available registers and use the stack. It would be nice to have a way to tell gcc not to do that.

This is not offered as a catch-all solution, but I believe it has value for many use cases.

Changes in v2:
- Add asmlinkage to exported functions
- Split series out on its own
- Add x86 support (asmlinkage, so it still needs a stack at present)
- Add better cover letter

Simon Glass (3):
serial: Support an early UART for debugging
serial: ns16550: Add access functions that don't need platdata
serial: ns16550: Support debug UART

 drivers/serial/Kconfig   |  59 ++++++++++++++++++++
 drivers/serial/ns16550.c |  98 ++++++++++++++++++++++++++-------
 include/debug_uart.h     | 139 +++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 276 insertions(+), 20 deletions(-)
 create mode 100644 include/debug_uart.h
Signature · 1 line
2.2.0.rc0.207.ga3a616c
#1 lore raw

PATCH v2 1/3 serial: Support an early UART for debugging

This came up in a discussion on the mailing list here:

https://patchwork.ozlabs.org/patch/384613/

My concerns at the time were:
- it doesn't need to be written in assembler
- it doesn't need to be ARM-specific

This patch provides a possible alternative. It works by allowing any serial driver to export one init function and provide a putc() function. These can be used to output debug data before the real serial driver is available.

This implementation does not depend on driver model, and it is possible for it to operate without a stack on some architectures (e.g. PowerPC, ARM). It provides the same features as the ARM-specific debug.S but with more UART and architecture support.

---

Changes in v2:
- Add asmlinkage to exported functions

 drivers/serial/Kconfig |  46 ++++++++++++++++
 include/debug_uart.h   | 139 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 185 insertions(+)
 create mode 100644 include/debug_uart.h
drivers/serial/Kconfig +46 -0
index a0b6e02..268bb42 100644
@@ -5,6 +5,52 @@ config DM_SERIAL
 	  If you want to use driver model for serial drivers, say Y.
 	  To use legacy serial drivers, say N.
 
+config DEBUG_UART
+	bool "Enable an early debug UART for debugging"
+	help
+	  The debug UART is intended for use very early in U-Boot to debug
+	  problems when an ICE or other debug mechanism is not available.
+
+	  To use it you should:
+	  - Make sure your UART supports this interface
+	  - Enable CONFIG_DEBUG_UART
+	  - Enable the CONFIG for your UART to tell it to provide this interface
+	        (e.g. CONFIG_DEBUG_UART_NS16550)
+	  - Define the required settings as needed (see below)
+	  - Call debug_uart_init() before use
+	  - Call debug_uart_putc() to output a character
+
+	  Depending on your platform it may be possible to use this UART before
+	  a stack is available.
+
+	  If your UART does not support this interface you can probably add
+	  support quite easily. Remember that you cannot use driver model and
+	  it is preferred to use no stack.
+
+	  You must not use this UART once driver model is working and the
+	  serial drivers are up and running (done in serial_init()). Otherwise
+	  the drivers may conflict and you will get strange output.
+
+config DEBUG_UART_BASE
+	hex "Base address of UART"
+	depends on DEBUG_UART
+	help
+	  This is the base address of your UART for memory-mapped UARTs.
+
+	  A default should be provided by your board, but if not you will need
+	  to use the correct value here.
+
+config DEBUG_UART_CLOCK
+	int "UART input clock"
+	depends on DEBUG_UART
+	help
+	  The UART input clock determines the speed of the internal UART
+	  circuitry. The baud rate is derived from this by dividing the input
+	  clock down.
+
+	  A default should be provided by your board, but if not you will need
+	  to use the correct value here.
+
 config UNIPHIER_SERIAL
 	bool "UniPhier on-chip UART support"
 	depends on ARCH_UNIPHIER && DM_SERIAL
include/debug_uart.h new file +139 -0

139 lines not on this page · raw message

Signature · 1 line
2.2.0.rc0.207.ga3a616c
#2 lore raw

PATCH v2 1/3 serial: Support an early UART for debugging

Quoted 20 lines · Simon Glass

This came up in a discussion on the mailing list here:

https://patchwork.ozlabs.org/patch/384613/

My concerns at the time were:
- it doesn't need to be written in assembler
- it doesn't need to be ARM-specific

This patch provides a possible alternative. It works by allowing any serial driver to export one init function and provide a putc() function. These can be used to output debug data before the real serial driver is available.

This implementation does not depend on driver model, and it is possible for it to operate without a stack on some architectures (e.g. PowerPC, ARM). It provides the same features as the ARM-specific debug.S but with more UART and architecture support.

---

Quoted 8 lines

Changes in v2:
- Add asmlinkage to exported functions

 drivers/serial/Kconfig |  46 ++++++++++++++++
 include/debug_uart.h   | 139 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 185 insertions(+)
 create mode 100644 include/debug_uart.h

As discussed let's bring this in.

Applied to u-boot-dm.

(Removed these Kconfig options from minnowmax_defconfig as the same time to avoid a build error. We can always enable it later)

#3 lore raw

PATCH v2 2/3 serial: ns16550: Add access functions that don't need platdata

In reply to Simon Glass

For the debug UART we need to be able to provide any parameters before driver model is set up. Add parameters to the low-level access functions to make this possible.

---

Changes in v2: None

 drivers/serial/ns16550.c | 48 ++++++++++++++++++++++++++++++------------------
 1 file changed, 30 insertions(+), 18 deletions(-)
drivers/serial/ns16550.c +30 -18
index 70c9462..57e6125 100644
@@ -55,17 +55,9 @@ DECLARE_GLOBAL_DATA_PTR;
 #endif /* CONFIG_SYS_NS16550_IER */
 
 #ifdef CONFIG_DM_SERIAL
-static void ns16550_writeb(NS16550_t port, int offset, int value)
-{
-	struct ns16550_platdata *plat = port->plat;
-	unsigned char *addr;
 
-	offset *= 1 << plat->reg_shift;
-	addr = map_sysmem(plat->base, 0) + offset;
-	/*
-	 * As far as we know it doesn't make sense to support selection of
-	 * these options at run-time, so use the existing CONFIG options.
-	 */
+static inline void serial_out_shift(unsigned char *addr, int shift, int value)
+{
 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
 	outb(value, (ulong)addr);
 #elif defined(CONFIG_SYS_NS16550_MEM32) && !defined(CONFIG_SYS_BIG_ENDIAN)
@@ -73,19 +65,14 @@ static void ns16550_writeb(NS16550_t port, int offset, int value)
 #elif defined(CONFIG_SYS_NS16550_MEM32) && defined(CONFIG_SYS_BIG_ENDIAN)
 	out_be32(addr, value);
 #elif defined(CONFIG_SYS_BIG_ENDIAN)
-	writeb(value, addr + (1 << plat->reg_shift) - 1);
+	writeb(value, addr + (1 << shift) - 1);
 #else
 	writeb(value, addr);
 #endif
 }
 
-static int ns16550_readb(NS16550_t port, int offset)
+static inline int serial_in_shift(unsigned char *addr, int shift)
 {
-	struct ns16550_platdata *plat = port->plat;
-	unsigned char *addr;
-
-	offset *= 1 << plat->reg_shift;
-	addr = map_sysmem(plat->base, 0) + offset;
 #ifdef CONFIG_SYS_NS16550_PORT_MAPPED
 	return inb((ulong)addr);
 #elif defined(CONFIG_SYS_NS16550_MEM32) && !defined(CONFIG_SYS_BIG_ENDIAN)
@@ -93,12 +80,37 @@ static int ns16550_readb(NS16550_t port, int offset)
 #elif defined(CONFIG_SYS_NS16550_MEM32) && defined(CONFIG_SYS_BIG_ENDIAN)
 	return in_be32(addr);
 #elif defined(CONFIG_SYS_BIG_ENDIAN)
-	return readb(addr + (1 << plat->reg_shift) - 1);
+	return readb(addr + (1 << reg_shift) - 1);
 #else
 	return readb(addr);
 #endif
 }
 
+static void ns16550_writeb(NS16550_t port, int offset, int value)
+{
+	struct ns16550_platdata *plat = port->plat;
+	unsigned char *addr;
+
+	offset *= 1 << plat->reg_shift;
+	addr = map_sysmem(plat->base, 0) + offset;
+	/*
+	 * As far as we know it doesn't make sense to support selection of
+	 * these options at run-time, so use the existing CONFIG options.
+	 */
+	serial_out_shift(addr, plat->reg_shift, value);
+}
+
+static int ns16550_readb(NS16550_t port, int offset)
+{
+	struct ns16550_platdata *plat = port->plat;
+	unsigned char *addr;
+
+	offset *= 1 << plat->reg_shift;
+	addr = map_sysmem(plat->base, 0) + offset;
+
+	return serial_in_shift(addr, plat->reg_shift);
+}
+
 /* We can clean these up once everything is moved to driver model */
 #define serial_out(value, addr)	\
 	ns16550_writeb(com_port, addr - (unsigned char *)com_port, value)
Signature · 1 line
2.2.0.rc0.207.ga3a616c
#4 lore raw

PATCH v2 2/3 serial: ns16550: Add access functions that don't need platdata

Quoted 11 lines · Simon Glass

For the debug UART we need to be able to provide any parameters before driver model is set up. Add parameters to the low-level access functions to make this possible.

---

Changes in v2: None

 drivers/serial/ns16550.c | 48 ++++++++++++++++++++++++++++++------------------
 1 file changed, 30 insertions(+), 18 deletions(-)

Applied to u-boot-dm.

#5 lore raw

PATCH v2 3/3 serial: ns16550: Support debug UART

In reply to Simon Glass

Add debug UART functions to permit ns16550 to provide an early debug UART. Try to avoid using the stack so that this can be called from assembler before a stack is set up (at least on ARM and PowerPC).

---

Changes in v2:
- Split series out on its own
- Add x86 support (asmlinkage, so it still needs a stack at present)
- Add better cover letter

 drivers/serial/Kconfig   | 13 +++++++++++++
 drivers/serial/ns16550.c | 50 ++++++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 61 insertions(+), 2 deletions(-)
drivers/serial/Kconfig +13 -0
index 268bb42..9d0d4c3 100644
@@ -31,6 +31,19 @@ config DEBUG_UART
 	  serial drivers are up and running (done in serial_init()). Otherwise
 	  the drivers may conflict and you will get strange output.
 
+choice
+	prompt "Select which UART will provide the debug UART"
+	depends on DEBUG_UART
+
+config DEBUG_UART_NS16550
+	bool "ns16550"
+	help
+	  Select this to enable a debug UART using the ns16550 driver. You
+	  will need to provide parameters to make this work. The driver will
+	  be available until the real driver model serial is running.
+
+endchoice
+
 config DEBUG_UART_BASE
 	hex "Base address of UART"
 	depends on DEBUG_UART
drivers/serial/ns16550.c +48 -2

71 lines not on this page · raw message

Signature · 1 line
2.2.0.rc0.207.ga3a616c
#6 lore raw

PATCH v2 3/3 serial: ns16550: Support debug UART

Quoted 11 lines · Simon Glass

Add debug UART functions to permit ns16550 to provide an early debug UART. Try to avoid using the stack so that this can be called from assembler before a stack is set up (at least on ARM and PowerPC).

---

Changes in v2:
- Split series out on its own
- Add x86 support (asmlinkage, so it still needs a stack at present)
- Add better cover letter

Applied to u-boot-dm.

#7 lore raw

v2 cover Add generic early debug UART feature

In reply to Simon Glass

+tom, and pruning the cc list a little

Hi,

Quoted 3 lines · Simon Glass

This series adds debug UART infrastructure which can in principle be used on any architecture. It works best with those that don't need a stack to call functions (e.g. ARM, PowerPC).

I'd really quite like to apply this series. I have used it on PowerPC and x86 and found it quite useful. Any objections?

- Simon

#8 lore raw

v2 cover Add generic early debug UART feature

Quoted 11 lines · Simon Glass

+tom, and pruning the cc list a little

Hi,

Quoted 3 lines · Simon Glass

This series adds debug UART infrastructure which can in principle be used on any architecture. It works best with those that don't need a stack to call functions (e.g. ARM, PowerPC).

I'd really quite like to apply this series. I have used it on PowerPC and x86 and found it quite useful. Any objections?

No, lets take it and work from there.

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20150218/d48bd631/attachment.sig>