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 1892c55b68SSimon Glassconfig SERIAL_PRESENT 1992c55b68SSimon Glass bool "Provide a serial driver" 2092c55b68SSimon Glass depends on DM_SERIAL 2192c55b68SSimon Glass default y 2292c55b68SSimon Glass help 2392c55b68SSimon Glass In very space-constrained devices even the full UART driver is too 2492c55b68SSimon Glass large. In this case the debug UART can still be used in some cases. 2592c55b68SSimon Glass This option enables the full UART in U-Boot, so if is it disabled, 2692c55b68SSimon Glass the full UART driver will be omitted, thus saving space. 2792c55b68SSimon Glass 2892c55b68SSimon Glassconfig SPL_SERIAL_PRESENT 2992c55b68SSimon Glass bool "Provide a serial driver in SPL" 3092c55b68SSimon Glass depends on DM_SERIAL 3192c55b68SSimon Glass default y 3292c55b68SSimon Glass help 3392c55b68SSimon Glass In very space-constrained devices even the full UART driver is too 3492c55b68SSimon Glass large. In this case the debug UART can still be used in some cases. 3592c55b68SSimon Glass This option enables the full UART in SPL, so if is it disabled, 3692c55b68SSimon Glass the full UART driver will be omitted, thus saving space. 3792c55b68SSimon 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 92*60b49761SWills Wangconfig DEBUG_UART_AR933X 93*60b49761SWills Wang bool "QCA/Atheros ar933x" 94*60b49761SWills Wang depends on AR933X_UART 95*60b49761SWills Wang help 96*60b49761SWills Wang Select this to enable a debug UART using the ar933x uart driver. 97*60b49761SWills Wang You will need to provide parameters to make this work. The 98*60b49761SWills Wang driver will be available until the real driver model serial is 99*60b49761SWills Wang running. 100*60b49761SWills Wang 10121d00436SSimon Glassconfig DEBUG_UART_NS16550 10221d00436SSimon Glass bool "ns16550" 10321d00436SSimon Glass help 10421d00436SSimon Glass Select this to enable a debug UART using the ns16550 driver. You 10521d00436SSimon Glass will need to provide parameters to make this work. The driver will 10621d00436SSimon Glass be available until the real driver model serial is running. 10721d00436SSimon Glass 108275854baSSimon Glassconfig DEBUG_EFI_CONSOLE 109275854baSSimon Glass bool "EFI" 110275854baSSimon Glass depends on EFI_APP 111275854baSSimon Glass help 112275854baSSimon Glass Select this to enable a debug console which calls back to EFI to 113275854baSSimon Glass output to the console. This can be useful for early debugging of 114275854baSSimon Glass U-Boot when running on top of EFI (Extensive Firmware Interface). 115275854baSSimon Glass This is a type of BIOS used by PCs. 116275854baSSimon Glass 117bf6e7022SSimon Glassconfig DEBUG_UART_S5P 118bf6e7022SSimon Glass bool "Samsung S5P" 119bf6e7022SSimon Glass help 120bf6e7022SSimon Glass Select this to enable a debug UART using the serial_s5p driver. You 121bf6e7022SSimon Glass will need to provide parameters to make this work. The driver will 122bf6e7022SSimon Glass be available until the real driver-model serial is running. 123bf6e7022SSimon Glass 1244166ba3bSMichal Simekconfig DEBUG_UART_UARTLITE 1254166ba3bSMichal Simek bool "Xilinx Uartlite" 1264166ba3bSMichal Simek help 1274166ba3bSMichal Simek Select this to enable a debug UART using the serial_uartlite driver. 1284166ba3bSMichal Simek You will need to provide parameters to make this work. The driver will 1294166ba3bSMichal Simek be available until the real driver-model serial is running. 1304166ba3bSMichal Simek 131966bfa73SMichal Simekconfig DEBUG_UART_ARM_DCC 132966bfa73SMichal Simek bool "ARM DCC" 133966bfa73SMichal Simek help 134966bfa73SMichal Simek Select this to enable a debug UART using the ARM JTAG DCC port. 135966bfa73SMichal Simek The DCC port can be used for very early debugging and doesn't require 136966bfa73SMichal Simek any additional setting like address/baudrate/clock. On systems without 137966bfa73SMichal Simek any serial interface this is the easiest way how to get console. 138966bfa73SMichal Simek Every ARM core has own DCC port which is the part of debug interface. 139966bfa73SMichal Simek This port is available at least on ARMv6, ARMv7, ARMv8 and XScale 140966bfa73SMichal Simek architectures. 141966bfa73SMichal Simek 142c54c0a4cSSimon Glassconfig DEBUG_UART_ZYNQ 143c54c0a4cSSimon Glass bool "Xilinx Zynq" 144c54c0a4cSSimon Glass help 1456bf87dacSMichal Simek Select this to enable a debug UART using the serial_zynq driver. You 146c54c0a4cSSimon Glass will need to provide parameters to make this work. The driver will 147c54c0a4cSSimon Glass be available until the real driver-model serial is running. 148c54c0a4cSSimon Glass 149e43ce3fcSFrancois Retiefconfig DEBUG_UART_APBUART 150e43ce3fcSFrancois Retief depends on LEON3 151e43ce3fcSFrancois Retief bool "Gaisler APBUART" 152e43ce3fcSFrancois Retief help 153e43ce3fcSFrancois Retief Select this to enable a debug UART using the serial_leon3 driver. You 154e43ce3fcSFrancois Retief will need to provide parameters to make this work. The driver will 155e43ce3fcSFrancois Retief be available until the real driver model serial is running. 156e43ce3fcSFrancois Retief 15719de8150SSergey Temerkhanovconfig DEBUG_UART_PL010 15819de8150SSergey Temerkhanov bool "pl010" 15919de8150SSergey Temerkhanov help 16019de8150SSergey Temerkhanov Select this to enable a debug UART using the pl01x driver with the 16119de8150SSergey Temerkhanov PL010 UART type. You will need to provide parameters to make this 16219de8150SSergey Temerkhanov work. The driver will be available until the real driver model 16319de8150SSergey Temerkhanov serial is running. 16419de8150SSergey Temerkhanov 16519de8150SSergey Temerkhanovconfig DEBUG_UART_PL011 16619de8150SSergey Temerkhanov bool "pl011" 16719de8150SSergey Temerkhanov help 16819de8150SSergey Temerkhanov Select this to enable a debug UART using the pl01x driver with the 16919de8150SSergey Temerkhanov PL011 UART type. You will need to provide parameters to make this 17019de8150SSergey Temerkhanov work. The driver will be available until the real driver model 17119de8150SSergey Temerkhanov serial is running. 17219de8150SSergey Temerkhanov 1739e160ee8SPaul Thackerconfig DEBUG_UART_PIC32 1749e160ee8SPaul Thacker bool "Microchip PIC32" 1759e160ee8SPaul Thacker depends on PIC32_SERIAL 1769e160ee8SPaul Thacker help 1779e160ee8SPaul Thacker Select this to enable a debug UART using the serial_pic32 driver. You 1789e160ee8SPaul Thacker will need to provide parameters to make this work. The driver will 1799e160ee8SPaul Thacker be available until the real driver model serial is running. 1809e160ee8SPaul Thacker 181d5cf3297SMasahiro Yamadaconfig DEBUG_UART_UNIPHIER 182d5cf3297SMasahiro Yamada bool "UniPhier on-chip UART" 183d5cf3297SMasahiro Yamada depends on ARCH_UNIPHIER 184d5cf3297SMasahiro Yamada help 185d5cf3297SMasahiro Yamada Select this to enable a debug UART using the UniPhier on-chip UART. 186d5cf3297SMasahiro Yamada You will need to provide DEBUG_UART_BASE to make this work. The 187d5cf3297SMasahiro Yamada driver will be available until the real driver-model serial is 188d5cf3297SMasahiro Yamada running. 189d5cf3297SMasahiro Yamada 19021d00436SSimon Glassendchoice 19121d00436SSimon Glass 1922f964aa7SSimon Glassconfig DEBUG_UART_BASE 1932f964aa7SSimon Glass hex "Base address of UART" 1942f964aa7SSimon Glass depends on DEBUG_UART 1952f964aa7SSimon Glass help 1962f964aa7SSimon Glass This is the base address of your UART for memory-mapped UARTs. 1972f964aa7SSimon Glass 1982f964aa7SSimon Glass A default should be provided by your board, but if not you will need 1992f964aa7SSimon Glass to use the correct value here. 2002f964aa7SSimon Glass 2012f964aa7SSimon Glassconfig DEBUG_UART_CLOCK 2022f964aa7SSimon Glass int "UART input clock" 2032f964aa7SSimon Glass depends on DEBUG_UART 2042f964aa7SSimon Glass help 2052f964aa7SSimon Glass The UART input clock determines the speed of the internal UART 2062f964aa7SSimon Glass circuitry. The baud rate is derived from this by dividing the input 2072f964aa7SSimon Glass clock down. 2082f964aa7SSimon Glass 2092f964aa7SSimon Glass A default should be provided by your board, but if not you will need 2102f964aa7SSimon Glass to use the correct value here. 2112f964aa7SSimon Glass 212dd0b0122SSimon Glassconfig DEBUG_UART_SHIFT 213dd0b0122SSimon Glass int "UART register shift" 214dd0b0122SSimon Glass depends on DEBUG_UART 215dd0b0122SSimon Glass default 0 if DEBUG_UART 216dd0b0122SSimon Glass help 217dd0b0122SSimon Glass Some UARTs (notably ns16550) support different register layouts 218dd0b0122SSimon Glass where the registers are spaced either as bytes, words or some other 219dd0b0122SSimon Glass value. Use this value to specify the shift to use, where 0=byte 220dd0b0122SSimon Glass registers, 2=32-bit word registers, etc. 221dd0b0122SSimon Glass 2220e977bc1SSimon Glassconfig DEBUG_UART_BOARD_INIT 2230e977bc1SSimon Glass bool "Enable board-specific debug UART init" 2240e977bc1SSimon Glass depends on DEBUG_UART 2250e977bc1SSimon Glass help 2260e977bc1SSimon Glass Some boards need to set things up before the debug UART can be used. 2270e977bc1SSimon Glass On these boards a call to debug_uart_init() is insufficient. When 2280e977bc1SSimon Glass this option is enabled, the function board_debug_uart_init() will 2290e977bc1SSimon Glass be called when debug_uart_init() is called. You can put any code 2300e977bc1SSimon Glass here that is needed to set up the UART ready for use, such as set 2310e977bc1SSimon Glass pin multiplexing or enable clocks. 2320e977bc1SSimon Glass 233c7fefcb9SSimon Glassconfig DEBUG_UART_ANNOUNCE 234c7fefcb9SSimon Glass bool "Show a message when the debug UART starts up" 235c7fefcb9SSimon Glass depends on DEBUG_UART 236c7fefcb9SSimon Glass help 237c7fefcb9SSimon Glass Enable this option to show a message when the debug UART is ready 238c7fefcb9SSimon Glass for use. You will see a message like "<debug_uart> " as soon as 239c7fefcb9SSimon Glass U-Boot has the UART ready for use (i.e. your code calls 240c7fefcb9SSimon Glass debug_uart_init()). This can be useful just as a check that 241c7fefcb9SSimon Glass everything is working. 242c7fefcb9SSimon Glass 24319de8150SSergey Temerkhanovconfig DEBUG_UART_SKIP_INIT 24419de8150SSergey Temerkhanov bool "Skip UART initialization" 24519de8150SSergey Temerkhanov help 24619de8150SSergey Temerkhanov Select this if the UART you want to use for debug output is already 24719de8150SSergey Temerkhanov initialized by the time U-Boot starts its execution. 24819de8150SSergey Temerkhanov 249220e8021SThomas Chouconfig ALTERA_JTAG_UART 250220e8021SThomas Chou bool "Altera JTAG UART support" 251220e8021SThomas Chou depends on DM_SERIAL 252220e8021SThomas Chou help 253220e8021SThomas Chou Select this to enable an JTAG UART for Altera devices.The JTAG UART 254220e8021SThomas Chou core implements a method to communicate serial character streams 255220e8021SThomas Chou between a host PC and a Qsys system on an Altera FPGA. Please find 256220e8021SThomas Chou details on the "Embedded Peripherals IP User Guide" of Altera. 257220e8021SThomas Chou 258220e8021SThomas Chouconfig ALTERA_JTAG_UART_BYPASS 259220e8021SThomas Chou bool "Bypass output when no connection" 260220e8021SThomas Chou depends on ALTERA_JTAG_UART 261220e8021SThomas Chou help 262220e8021SThomas Chou Bypass console output and keep going even if there is no JTAG 263220e8021SThomas Chou terminal connection with the host. The console output will resume 264220e8021SThomas Chou once the JTAG terminal is connected. Without the bypass, the console 265220e8021SThomas Chou output will wait forever until a JTAG terminal is connected. If you 266220e8021SThomas Chou not are sure, say Y. 267220e8021SThomas Chou 268da2f838dSThomas Chouconfig ALTERA_UART 269da2f838dSThomas Chou bool "Altera UART support" 270da2f838dSThomas Chou depends on DM_SERIAL 271da2f838dSThomas Chou help 272da2f838dSThomas Chou Select this to enable an UART for Altera devices. Please find 273da2f838dSThomas Chou details on the "Embedded Peripherals IP User Guide" of Altera. 274da2f838dSThomas Chou 275*60b49761SWills Wangconfig AR933X_UART 276*60b49761SWills Wang bool "QCA/Atheros ar933x UART support" 277*60b49761SWills Wang depends on DM_SERIAL && SOC_AR933X 278*60b49761SWills Wang help 279*60b49761SWills Wang Select this to enable UART support for QCA/Atheros ar933x 280*60b49761SWills Wang devices. This driver uses driver model and requires a device 281*60b49761SWills Wang tree binding to operate, please refer to the document at 282*60b49761SWills Wang doc/device-tree-bindings/serial/qca,ar9330-uart.txt. 283*60b49761SWills Wang 2845ed07cf5SBin Mengconfig FSL_LPUART 2855ed07cf5SBin Meng bool "Freescale LPUART support" 2865ed07cf5SBin Meng help 2875ed07cf5SBin Meng Select this to enable a Low Power UART for Freescale VF610 and 2885ed07cf5SBin Meng QorIQ Layerscape devices. 2895ed07cf5SBin Meng 2909e160ee8SPaul Thackerconfig PIC32_SERIAL 2919e160ee8SPaul Thacker bool "Support for Microchip PIC32 on-chip UART" 2929e160ee8SPaul Thacker depends on DM_SERIAL && MACH_PIC32 2939e160ee8SPaul Thacker default y 2949e160ee8SPaul Thacker help 2959e160ee8SPaul Thacker Support for the UART found on Microchip PIC32 SoC's. 2969e160ee8SPaul Thacker 2979e39003eSThomas Chouconfig SYS_NS16550 2989e39003eSThomas Chou bool "NS16550 UART or compatible" 2999e39003eSThomas Chou help 3009e39003eSThomas Chou Support NS16550 UART or compatible. This can be enabled in the 3019e39003eSThomas Chou device tree with the correct input clock frequency. If the input 3029e39003eSThomas Chou clock frequency is not defined in the device tree, the macro 3039e39003eSThomas Chou CONFIG_SYS_NS16550_CLK defined in a legacy board header file will 3049e39003eSThomas Chou be used. It can be a constant or a function to get clock, eg, 3059e39003eSThomas Chou get_serial_clock(). 3069e39003eSThomas Chou 307af282245SSimon Glassconfig SANDBOX_SERIAL 308af282245SSimon Glass bool "Sandbox UART support" 3092ea65f3eSMasahiro Yamada depends on SANDBOX 310af282245SSimon Glass help 311af282245SSimon Glass Select this to enable a seral UART for sandbox. This is required to 312af282245SSimon Glass operate correctly, otherwise you will see no serial output from 313af282245SSimon Glass sandbox. The emulated UART will display to the console and console 314af282245SSimon Glass input will be fed into the UART. This allows you to interact with 315af282245SSimon Glass U-Boot. 316af282245SSimon Glass 317af282245SSimon Glass The operation of the console is controlled by the -t command-line 318af282245SSimon Glass flag. In raw mode, U-Boot sees all characters from the terminal 319af282245SSimon Glass before they are processed, including Ctrl-C. In cooked mode, Ctrl-C 320af282245SSimon Glass is processed by the terminal, and terminates U-Boot. Valid options 321af282245SSimon Glass are: 322af282245SSimon Glass 323af282245SSimon Glass -t raw-with-sigs Raw mode, Ctrl-C will terminate U-Boot 324af282245SSimon Glass -t raw Raw mode, Ctrl-C is processed by U-Boot 325af282245SSimon Glass -t cooked Cooked mode, Ctrl-C terminates 326af282245SSimon Glass 327ff247b7aSMasahiro Yamadaconfig UNIPHIER_SERIAL 328b6ef3a3fSMasahiro Yamada bool "Support for UniPhier on-chip UART" 3292ea65f3eSMasahiro Yamada depends on ARCH_UNIPHIER 330ff247b7aSMasahiro Yamada help 331b6ef3a3fSMasahiro Yamada If you have a UniPhier based board and want to use the on-chip 332b6ef3a3fSMasahiro Yamada serial ports, say Y to this option. If unsure, say N. 333dcfe4a54SSimon Glass 33454e24d33SMichal Simekconfig XILINX_UARTLITE 33554e24d33SMichal Simek bool "Xilinx Uarlite support" 33680cce262SRicardo Ribalda Delgado depends on DM_SERIAL && (MICROBLAZE || ARCH_ZYNQ || ARCH_ZYNQMP || 4xx) 33754e24d33SMichal Simek help 33854e24d33SMichal Simek If you have a Xilinx based board and want to use the uartlite 33954e24d33SMichal Simek serial ports, say Y to this option. If unsure, say N. 34054e24d33SMichal Simek 341142a20c3SMateusz Kulikowskiconfig MSM_SERIAL 342142a20c3SMateusz Kulikowski bool "Qualcomm on-chip UART" 343142a20c3SMateusz Kulikowski depends on DM_SERIAL 344142a20c3SMateusz Kulikowski help 345142a20c3SMateusz Kulikowski Support Data Mover UART used on Qualcomm Snapdragon SoCs. 346142a20c3SMateusz Kulikowski It should support all Qualcomm devices with UARTDM version 1.4, 347142a20c3SMateusz Kulikowski for example APQ8016 and MSM8916. 348142a20c3SMateusz Kulikowski Single baudrate is supported in current implementation (115200). 3490b11dbf7SMasahiro Yamadaendmenu 350