10b11dbf7SMasahiro Yamada# 20b11dbf7SMasahiro Yamada# Serial device configuration 30b11dbf7SMasahiro Yamada# 40b11dbf7SMasahiro Yamada 50b11dbf7SMasahiro Yamadamenu "Serial drivers" 60b11dbf7SMasahiro Yamada 78c458588SHans de Goedeconfig REQUIRE_SERIAL_CONSOLE 88c458588SHans de Goede bool "Require a serial port for console" 98c458588SHans de Goede # Running without a serial console is not supported by the 108c458588SHans de Goede # non-dm serial code 118c458588SHans de Goede depends on DM_SERIAL 128c458588SHans de Goede default y 138c458588SHans de Goede help 148c458588SHans de Goede Require a serial port for the console, and panic if none is found 158c458588SHans de Goede during serial port initialization (default y). Set this to n on 168c458588SHans de Goede boards which have no debug serial port whatsoever. 178c458588SHans de Goede 18*92c55b68SSimon Glassconfig SERIAL_PRESENT 19*92c55b68SSimon Glass bool "Provide a serial driver" 20*92c55b68SSimon Glass depends on DM_SERIAL 21*92c55b68SSimon Glass default y 22*92c55b68SSimon Glass help 23*92c55b68SSimon Glass In very space-constrained devices even the full UART driver is too 24*92c55b68SSimon Glass large. In this case the debug UART can still be used in some cases. 25*92c55b68SSimon Glass This option enables the full UART in U-Boot, so if is it disabled, 26*92c55b68SSimon Glass the full UART driver will be omitted, thus saving space. 27*92c55b68SSimon Glass 28*92c55b68SSimon Glassconfig SPL_SERIAL_PRESENT 29*92c55b68SSimon Glass bool "Provide a serial driver in SPL" 30*92c55b68SSimon Glass depends on DM_SERIAL 31*92c55b68SSimon Glass default y 32*92c55b68SSimon Glass help 33*92c55b68SSimon Glass In very space-constrained devices even the full UART driver is too 34*92c55b68SSimon Glass large. In this case the debug UART can still be used in some cases. 35*92c55b68SSimon Glass This option enables the full UART in SPL, so if is it disabled, 36*92c55b68SSimon Glass the full UART driver will be omitted, thus saving space. 37*92c55b68SSimon Glass 38da333ae7SMasahiro Yamadaconfig DM_SERIAL 39da333ae7SMasahiro Yamada bool "Enable Driver Model for serial drivers" 40da333ae7SMasahiro Yamada depends on DM 41da333ae7SMasahiro Yamada help 42f94a1bedSSimon Glass Enable driver model for serial. This replaces 43f94a1bedSSimon Glass drivers/serial/serial.c with the serial uclass, which 44f94a1bedSSimon Glass implements serial_putc() etc. The uclass interface is 45f94a1bedSSimon Glass defined in include/serial.h. 46ff247b7aSMasahiro Yamada 472f964aa7SSimon Glassconfig DEBUG_UART 482f964aa7SSimon Glass bool "Enable an early debug UART for debugging" 492f964aa7SSimon Glass help 502f964aa7SSimon Glass The debug UART is intended for use very early in U-Boot to debug 512f964aa7SSimon Glass problems when an ICE or other debug mechanism is not available. 522f964aa7SSimon Glass 532f964aa7SSimon Glass To use it you should: 542f964aa7SSimon Glass - Make sure your UART supports this interface 552f964aa7SSimon Glass - Enable CONFIG_DEBUG_UART 562f964aa7SSimon Glass - Enable the CONFIG for your UART to tell it to provide this interface 572f964aa7SSimon Glass (e.g. CONFIG_DEBUG_UART_NS16550) 582f964aa7SSimon Glass - Define the required settings as needed (see below) 592f964aa7SSimon Glass - Call debug_uart_init() before use 602f964aa7SSimon Glass - Call debug_uart_putc() to output a character 612f964aa7SSimon Glass 622f964aa7SSimon Glass Depending on your platform it may be possible to use this UART before 632f964aa7SSimon Glass a stack is available. 642f964aa7SSimon Glass 652f964aa7SSimon Glass If your UART does not support this interface you can probably add 662f964aa7SSimon Glass support quite easily. Remember that you cannot use driver model and 672f964aa7SSimon Glass it is preferred to use no stack. 682f964aa7SSimon Glass 692f964aa7SSimon Glass You must not use this UART once driver model is working and the 702f964aa7SSimon Glass serial drivers are up and running (done in serial_init()). Otherwise 712f964aa7SSimon Glass the drivers may conflict and you will get strange output. 722f964aa7SSimon Glass 7321d00436SSimon Glasschoice 7421d00436SSimon Glass prompt "Select which UART will provide the debug UART" 7521d00436SSimon Glass depends on DEBUG_UART 76b1e361b6SThomas Chou default DEBUG_UART_NS16550 7721d00436SSimon Glass 78220e8021SThomas Chouconfig DEBUG_UART_ALTERA_JTAGUART 79220e8021SThomas Chou bool "Altera JTAG UART" 80220e8021SThomas Chou help 81220e8021SThomas Chou Select this to enable a debug UART using the altera_jtag_uart driver. 82220e8021SThomas Chou You will need to provide parameters to make this work. The driver will 83220e8021SThomas Chou be available until the real driver model serial is running. 84220e8021SThomas Chou 85da2f838dSThomas Chouconfig DEBUG_UART_ALTERA_UART 86da2f838dSThomas Chou bool "Altera UART" 87da2f838dSThomas Chou help 88da2f838dSThomas Chou Select this to enable a debug UART using the altera_uart driver. 89da2f838dSThomas Chou You will need to provide parameters to make this work. The driver will 90da2f838dSThomas Chou be available until the real driver model serial is running. 91da2f838dSThomas Chou 9221d00436SSimon Glassconfig DEBUG_UART_NS16550 9321d00436SSimon Glass bool "ns16550" 9421d00436SSimon Glass help 9521d00436SSimon Glass Select this to enable a debug UART using the ns16550 driver. You 9621d00436SSimon Glass will need to provide parameters to make this work. The driver will 9721d00436SSimon Glass be available until the real driver model serial is running. 9821d00436SSimon Glass 99275854baSSimon Glassconfig DEBUG_EFI_CONSOLE 100275854baSSimon Glass bool "EFI" 101275854baSSimon Glass depends on EFI_APP 102275854baSSimon Glass help 103275854baSSimon Glass Select this to enable a debug console which calls back to EFI to 104275854baSSimon Glass output to the console. This can be useful for early debugging of 105275854baSSimon Glass U-Boot when running on top of EFI (Extensive Firmware Interface). 106275854baSSimon Glass This is a type of BIOS used by PCs. 107275854baSSimon Glass 108bf6e7022SSimon Glassconfig DEBUG_UART_S5P 109bf6e7022SSimon Glass bool "Samsung S5P" 110bf6e7022SSimon Glass help 111bf6e7022SSimon Glass Select this to enable a debug UART using the serial_s5p driver. You 112bf6e7022SSimon Glass will need to provide parameters to make this work. The driver will 113bf6e7022SSimon Glass be available until the real driver-model serial is running. 114bf6e7022SSimon Glass 115c54c0a4cSSimon Glassconfig DEBUG_UART_ZYNQ 116c54c0a4cSSimon Glass bool "Xilinx Zynq" 117c54c0a4cSSimon Glass help 1186bf87dacSMichal Simek Select this to enable a debug UART using the serial_zynq driver. You 119c54c0a4cSSimon Glass will need to provide parameters to make this work. The driver will 120c54c0a4cSSimon Glass be available until the real driver-model serial is running. 121c54c0a4cSSimon Glass 122e43ce3fcSFrancois Retiefconfig DEBUG_UART_APBUART 123e43ce3fcSFrancois Retief depends on LEON3 124e43ce3fcSFrancois Retief bool "Gaisler APBUART" 125e43ce3fcSFrancois Retief help 126e43ce3fcSFrancois Retief Select this to enable a debug UART using the serial_leon3 driver. You 127e43ce3fcSFrancois Retief will need to provide parameters to make this work. The driver will 128e43ce3fcSFrancois Retief be available until the real driver model serial is running. 129e43ce3fcSFrancois Retief 13021d00436SSimon Glassendchoice 13121d00436SSimon Glass 1322f964aa7SSimon Glassconfig DEBUG_UART_BASE 1332f964aa7SSimon Glass hex "Base address of UART" 1342f964aa7SSimon Glass depends on DEBUG_UART 1352f964aa7SSimon Glass help 1362f964aa7SSimon Glass This is the base address of your UART for memory-mapped UARTs. 1372f964aa7SSimon Glass 1382f964aa7SSimon Glass A default should be provided by your board, but if not you will need 1392f964aa7SSimon Glass to use the correct value here. 1402f964aa7SSimon Glass 1412f964aa7SSimon Glassconfig DEBUG_UART_CLOCK 1422f964aa7SSimon Glass int "UART input clock" 1432f964aa7SSimon Glass depends on DEBUG_UART 1442f964aa7SSimon Glass help 1452f964aa7SSimon Glass The UART input clock determines the speed of the internal UART 1462f964aa7SSimon Glass circuitry. The baud rate is derived from this by dividing the input 1472f964aa7SSimon Glass clock down. 1482f964aa7SSimon Glass 1492f964aa7SSimon Glass A default should be provided by your board, but if not you will need 1502f964aa7SSimon Glass to use the correct value here. 1512f964aa7SSimon Glass 152dd0b0122SSimon Glassconfig DEBUG_UART_SHIFT 153dd0b0122SSimon Glass int "UART register shift" 154dd0b0122SSimon Glass depends on DEBUG_UART 155dd0b0122SSimon Glass default 0 if DEBUG_UART 156dd0b0122SSimon Glass help 157dd0b0122SSimon Glass Some UARTs (notably ns16550) support different register layouts 158dd0b0122SSimon Glass where the registers are spaced either as bytes, words or some other 159dd0b0122SSimon Glass value. Use this value to specify the shift to use, where 0=byte 160dd0b0122SSimon Glass registers, 2=32-bit word registers, etc. 161dd0b0122SSimon Glass 1620e977bc1SSimon Glassconfig DEBUG_UART_BOARD_INIT 1630e977bc1SSimon Glass bool "Enable board-specific debug UART init" 1640e977bc1SSimon Glass depends on DEBUG_UART 1650e977bc1SSimon Glass help 1660e977bc1SSimon Glass Some boards need to set things up before the debug UART can be used. 1670e977bc1SSimon Glass On these boards a call to debug_uart_init() is insufficient. When 1680e977bc1SSimon Glass this option is enabled, the function board_debug_uart_init() will 1690e977bc1SSimon Glass be called when debug_uart_init() is called. You can put any code 1700e977bc1SSimon Glass here that is needed to set up the UART ready for use, such as set 1710e977bc1SSimon Glass pin multiplexing or enable clocks. 1720e977bc1SSimon Glass 173c7fefcb9SSimon Glassconfig DEBUG_UART_ANNOUNCE 174c7fefcb9SSimon Glass bool "Show a message when the debug UART starts up" 175c7fefcb9SSimon Glass depends on DEBUG_UART 176c7fefcb9SSimon Glass help 177c7fefcb9SSimon Glass Enable this option to show a message when the debug UART is ready 178c7fefcb9SSimon Glass for use. You will see a message like "<debug_uart> " as soon as 179c7fefcb9SSimon Glass U-Boot has the UART ready for use (i.e. your code calls 180c7fefcb9SSimon Glass debug_uart_init()). This can be useful just as a check that 181c7fefcb9SSimon Glass everything is working. 182c7fefcb9SSimon Glass 183220e8021SThomas Chouconfig ALTERA_JTAG_UART 184220e8021SThomas Chou bool "Altera JTAG UART support" 185220e8021SThomas Chou depends on DM_SERIAL 186220e8021SThomas Chou help 187220e8021SThomas Chou Select this to enable an JTAG UART for Altera devices.The JTAG UART 188220e8021SThomas Chou core implements a method to communicate serial character streams 189220e8021SThomas Chou between a host PC and a Qsys system on an Altera FPGA. Please find 190220e8021SThomas Chou details on the "Embedded Peripherals IP User Guide" of Altera. 191220e8021SThomas Chou 192220e8021SThomas Chouconfig ALTERA_JTAG_UART_BYPASS 193220e8021SThomas Chou bool "Bypass output when no connection" 194220e8021SThomas Chou depends on ALTERA_JTAG_UART 195220e8021SThomas Chou help 196220e8021SThomas Chou Bypass console output and keep going even if there is no JTAG 197220e8021SThomas Chou terminal connection with the host. The console output will resume 198220e8021SThomas Chou once the JTAG terminal is connected. Without the bypass, the console 199220e8021SThomas Chou output will wait forever until a JTAG terminal is connected. If you 200220e8021SThomas Chou not are sure, say Y. 201220e8021SThomas Chou 202da2f838dSThomas Chouconfig ALTERA_UART 203da2f838dSThomas Chou bool "Altera UART support" 204da2f838dSThomas Chou depends on DM_SERIAL 205da2f838dSThomas Chou help 206da2f838dSThomas Chou Select this to enable an UART for Altera devices. Please find 207da2f838dSThomas Chou details on the "Embedded Peripherals IP User Guide" of Altera. 208da2f838dSThomas Chou 2099e39003eSThomas Chouconfig SYS_NS16550 2109e39003eSThomas Chou bool "NS16550 UART or compatible" 2119e39003eSThomas Chou help 2129e39003eSThomas Chou Support NS16550 UART or compatible. This can be enabled in the 2139e39003eSThomas Chou device tree with the correct input clock frequency. If the input 2149e39003eSThomas Chou clock frequency is not defined in the device tree, the macro 2159e39003eSThomas Chou CONFIG_SYS_NS16550_CLK defined in a legacy board header file will 2169e39003eSThomas Chou be used. It can be a constant or a function to get clock, eg, 2179e39003eSThomas Chou get_serial_clock(). 2189e39003eSThomas Chou 219af282245SSimon Glassconfig SANDBOX_SERIAL 220af282245SSimon Glass bool "Sandbox UART support" 2212ea65f3eSMasahiro Yamada depends on SANDBOX 222af282245SSimon Glass help 223af282245SSimon Glass Select this to enable a seral UART for sandbox. This is required to 224af282245SSimon Glass operate correctly, otherwise you will see no serial output from 225af282245SSimon Glass sandbox. The emulated UART will display to the console and console 226af282245SSimon Glass input will be fed into the UART. This allows you to interact with 227af282245SSimon Glass U-Boot. 228af282245SSimon Glass 229af282245SSimon Glass The operation of the console is controlled by the -t command-line 230af282245SSimon Glass flag. In raw mode, U-Boot sees all characters from the terminal 231af282245SSimon Glass before they are processed, including Ctrl-C. In cooked mode, Ctrl-C 232af282245SSimon Glass is processed by the terminal, and terminates U-Boot. Valid options 233af282245SSimon Glass are: 234af282245SSimon Glass 235af282245SSimon Glass -t raw-with-sigs Raw mode, Ctrl-C will terminate U-Boot 236af282245SSimon Glass -t raw Raw mode, Ctrl-C is processed by U-Boot 237af282245SSimon Glass -t cooked Cooked mode, Ctrl-C terminates 238af282245SSimon Glass 239ff247b7aSMasahiro Yamadaconfig UNIPHIER_SERIAL 240b6ef3a3fSMasahiro Yamada bool "Support for UniPhier on-chip UART" 2412ea65f3eSMasahiro Yamada depends on ARCH_UNIPHIER 242ff247b7aSMasahiro Yamada help 243b6ef3a3fSMasahiro Yamada If you have a UniPhier based board and want to use the on-chip 244b6ef3a3fSMasahiro Yamada serial ports, say Y to this option. If unsure, say N. 245dcfe4a54SSimon Glass 2460b11dbf7SMasahiro Yamadaendmenu 247