xref: /openbmc/u-boot/drivers/serial/Kconfig (revision 6bf87dac)
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
18da333ae7SMasahiro Yamadaconfig DM_SERIAL
19da333ae7SMasahiro Yamada	bool "Enable Driver Model for serial drivers"
20da333ae7SMasahiro Yamada	depends on DM
21da333ae7SMasahiro Yamada	help
22f94a1bedSSimon Glass	  Enable driver model for serial. This replaces
23f94a1bedSSimon Glass	  drivers/serial/serial.c with the serial uclass, which
24f94a1bedSSimon Glass	  implements serial_putc() etc. The uclass interface is
25f94a1bedSSimon Glass	  defined in include/serial.h.
26ff247b7aSMasahiro Yamada
272f964aa7SSimon Glassconfig DEBUG_UART
282f964aa7SSimon Glass	bool "Enable an early debug UART for debugging"
292f964aa7SSimon Glass	help
302f964aa7SSimon Glass	  The debug UART is intended for use very early in U-Boot to debug
312f964aa7SSimon Glass	  problems when an ICE or other debug mechanism is not available.
322f964aa7SSimon Glass
332f964aa7SSimon Glass	  To use it you should:
342f964aa7SSimon Glass	  - Make sure your UART supports this interface
352f964aa7SSimon Glass	  - Enable CONFIG_DEBUG_UART
362f964aa7SSimon Glass	  - Enable the CONFIG for your UART to tell it to provide this interface
372f964aa7SSimon Glass	        (e.g. CONFIG_DEBUG_UART_NS16550)
382f964aa7SSimon Glass	  - Define the required settings as needed (see below)
392f964aa7SSimon Glass	  - Call debug_uart_init() before use
402f964aa7SSimon Glass	  - Call debug_uart_putc() to output a character
412f964aa7SSimon Glass
422f964aa7SSimon Glass	  Depending on your platform it may be possible to use this UART before
432f964aa7SSimon Glass	  a stack is available.
442f964aa7SSimon Glass
452f964aa7SSimon Glass	  If your UART does not support this interface you can probably add
462f964aa7SSimon Glass	  support quite easily. Remember that you cannot use driver model and
472f964aa7SSimon Glass	  it is preferred to use no stack.
482f964aa7SSimon Glass
492f964aa7SSimon Glass	  You must not use this UART once driver model is working and the
502f964aa7SSimon Glass	  serial drivers are up and running (done in serial_init()). Otherwise
512f964aa7SSimon Glass	  the drivers may conflict and you will get strange output.
522f964aa7SSimon Glass
5321d00436SSimon Glasschoice
5421d00436SSimon Glass	prompt "Select which UART will provide the debug UART"
5521d00436SSimon Glass	depends on DEBUG_UART
56b1e361b6SThomas Chou	default DEBUG_UART_NS16550
5721d00436SSimon Glass
58220e8021SThomas Chouconfig DEBUG_UART_ALTERA_JTAGUART
59220e8021SThomas Chou	bool "Altera JTAG UART"
60220e8021SThomas Chou	help
61220e8021SThomas Chou	  Select this to enable a debug UART using the altera_jtag_uart driver.
62220e8021SThomas Chou	  You will need to provide parameters to make this work. The driver will
63220e8021SThomas Chou	  be available until the real driver model serial is running.
64220e8021SThomas Chou
65da2f838dSThomas Chouconfig DEBUG_UART_ALTERA_UART
66da2f838dSThomas Chou	bool "Altera UART"
67da2f838dSThomas Chou	help
68da2f838dSThomas Chou	  Select this to enable a debug UART using the altera_uart driver.
69da2f838dSThomas Chou	  You will need to provide parameters to make this work. The driver will
70da2f838dSThomas Chou	  be available until the real driver model serial is running.
71da2f838dSThomas Chou
7221d00436SSimon Glassconfig DEBUG_UART_NS16550
7321d00436SSimon Glass	bool "ns16550"
7421d00436SSimon Glass	help
7521d00436SSimon Glass	  Select this to enable a debug UART using the ns16550 driver. You
7621d00436SSimon Glass	  will need to provide parameters to make this work. The driver will
7721d00436SSimon Glass	  be available until the real driver model serial is running.
7821d00436SSimon Glass
79275854baSSimon Glassconfig DEBUG_EFI_CONSOLE
80275854baSSimon Glass	bool "EFI"
81275854baSSimon Glass	depends on EFI_APP
82275854baSSimon Glass	help
83275854baSSimon Glass	  Select this to enable a debug console which calls back to EFI to
84275854baSSimon Glass	  output to the console. This can be useful for early debugging of
85275854baSSimon Glass	  U-Boot when running on top of EFI (Extensive Firmware Interface).
86275854baSSimon Glass	  This is a type of BIOS used by PCs.
87275854baSSimon Glass
88bf6e7022SSimon Glassconfig DEBUG_UART_S5P
89bf6e7022SSimon Glass	bool "Samsung S5P"
90bf6e7022SSimon Glass	help
91bf6e7022SSimon Glass	  Select this to enable a debug UART using the serial_s5p driver. You
92bf6e7022SSimon Glass	  will need to provide parameters to make this work. The driver will
93bf6e7022SSimon Glass	  be available until the real driver-model serial is running.
94bf6e7022SSimon Glass
95c54c0a4cSSimon Glassconfig DEBUG_UART_ZYNQ
96c54c0a4cSSimon Glass	bool "Xilinx Zynq"
97c54c0a4cSSimon Glass	help
98*6bf87dacSMichal Simek	  Select this to enable a debug UART using the serial_zynq driver. You
99c54c0a4cSSimon Glass	  will need to provide parameters to make this work. The driver will
100c54c0a4cSSimon Glass	  be available until the real driver-model serial is running.
101c54c0a4cSSimon Glass
102e43ce3fcSFrancois Retiefconfig DEBUG_UART_APBUART
103e43ce3fcSFrancois Retief	depends on LEON3
104e43ce3fcSFrancois Retief	bool "Gaisler APBUART"
105e43ce3fcSFrancois Retief	help
106e43ce3fcSFrancois Retief	  Select this to enable a debug UART using the serial_leon3 driver. You
107e43ce3fcSFrancois Retief	  will need to provide parameters to make this work. The driver will
108e43ce3fcSFrancois Retief	  be available until the real driver model serial is running.
109e43ce3fcSFrancois Retief
11021d00436SSimon Glassendchoice
11121d00436SSimon Glass
1122f964aa7SSimon Glassconfig DEBUG_UART_BASE
1132f964aa7SSimon Glass	hex "Base address of UART"
1142f964aa7SSimon Glass	depends on DEBUG_UART
1152f964aa7SSimon Glass	help
1162f964aa7SSimon Glass	  This is the base address of your UART for memory-mapped UARTs.
1172f964aa7SSimon Glass
1182f964aa7SSimon Glass	  A default should be provided by your board, but if not you will need
1192f964aa7SSimon Glass	  to use the correct value here.
1202f964aa7SSimon Glass
1212f964aa7SSimon Glassconfig DEBUG_UART_CLOCK
1222f964aa7SSimon Glass	int "UART input clock"
1232f964aa7SSimon Glass	depends on DEBUG_UART
1242f964aa7SSimon Glass	help
1252f964aa7SSimon Glass	  The UART input clock determines the speed of the internal UART
1262f964aa7SSimon Glass	  circuitry. The baud rate is derived from this by dividing the input
1272f964aa7SSimon Glass	  clock down.
1282f964aa7SSimon Glass
1292f964aa7SSimon Glass	  A default should be provided by your board, but if not you will need
1302f964aa7SSimon Glass	  to use the correct value here.
1312f964aa7SSimon Glass
132dd0b0122SSimon Glassconfig DEBUG_UART_SHIFT
133dd0b0122SSimon Glass	int "UART register shift"
134dd0b0122SSimon Glass	depends on DEBUG_UART
135dd0b0122SSimon Glass	default 0 if DEBUG_UART
136dd0b0122SSimon Glass	help
137dd0b0122SSimon Glass	  Some UARTs (notably ns16550) support different register layouts
138dd0b0122SSimon Glass	  where the registers are spaced either as bytes, words or some other
139dd0b0122SSimon Glass	  value. Use this value to specify the shift to use, where 0=byte
140dd0b0122SSimon Glass	  registers, 2=32-bit word registers, etc.
141dd0b0122SSimon Glass
1420e977bc1SSimon Glassconfig DEBUG_UART_BOARD_INIT
1430e977bc1SSimon Glass	bool "Enable board-specific debug UART init"
1440e977bc1SSimon Glass	depends on DEBUG_UART
1450e977bc1SSimon Glass	help
1460e977bc1SSimon Glass	  Some boards need to set things up before the debug UART can be used.
1470e977bc1SSimon Glass	  On these boards a call to debug_uart_init() is insufficient. When
1480e977bc1SSimon Glass	  this option is enabled, the function board_debug_uart_init() will
1490e977bc1SSimon Glass	  be called when debug_uart_init() is called. You can put any code
1500e977bc1SSimon Glass	  here that is needed to set up the UART ready for use, such as set
1510e977bc1SSimon Glass	  pin multiplexing or enable clocks.
1520e977bc1SSimon Glass
153c7fefcb9SSimon Glassconfig DEBUG_UART_ANNOUNCE
154c7fefcb9SSimon Glass	bool "Show a message when the debug UART starts up"
155c7fefcb9SSimon Glass	depends on DEBUG_UART
156c7fefcb9SSimon Glass	help
157c7fefcb9SSimon Glass	  Enable this option to show a message when the debug UART is ready
158c7fefcb9SSimon Glass	  for use. You will see a message like "<debug_uart> " as soon as
159c7fefcb9SSimon Glass	  U-Boot has the UART ready for use (i.e. your code calls
160c7fefcb9SSimon Glass	  debug_uart_init()). This can be useful just as a check that
161c7fefcb9SSimon Glass	  everything is working.
162c7fefcb9SSimon Glass
163220e8021SThomas Chouconfig ALTERA_JTAG_UART
164220e8021SThomas Chou	bool "Altera JTAG UART support"
165220e8021SThomas Chou	depends on DM_SERIAL
166220e8021SThomas Chou	help
167220e8021SThomas Chou	  Select this to enable an JTAG UART for Altera devices.The JTAG UART
168220e8021SThomas Chou	  core implements a method to communicate serial character streams
169220e8021SThomas Chou	  between a host PC and a Qsys system on an Altera FPGA. Please find
170220e8021SThomas Chou	  details on the "Embedded Peripherals IP User Guide" of Altera.
171220e8021SThomas Chou
172220e8021SThomas Chouconfig ALTERA_JTAG_UART_BYPASS
173220e8021SThomas Chou	bool "Bypass output when no connection"
174220e8021SThomas Chou	depends on ALTERA_JTAG_UART
175220e8021SThomas Chou	help
176220e8021SThomas Chou	  Bypass console output and keep going even if there is no JTAG
177220e8021SThomas Chou	  terminal connection with the host. The console output will resume
178220e8021SThomas Chou	  once the JTAG terminal is connected. Without the bypass, the console
179220e8021SThomas Chou	  output will wait forever until a JTAG terminal is connected. If you
180220e8021SThomas Chou	  not are sure, say Y.
181220e8021SThomas Chou
182da2f838dSThomas Chouconfig ALTERA_UART
183da2f838dSThomas Chou	bool "Altera UART support"
184da2f838dSThomas Chou	depends on DM_SERIAL
185da2f838dSThomas Chou	help
186da2f838dSThomas Chou	  Select this to enable an UART for Altera devices. Please find
187da2f838dSThomas Chou	  details on the "Embedded Peripherals IP User Guide" of Altera.
188da2f838dSThomas Chou
1899e39003eSThomas Chouconfig SYS_NS16550
1909e39003eSThomas Chou	bool "NS16550 UART or compatible"
1919e39003eSThomas Chou	help
1929e39003eSThomas Chou	  Support NS16550 UART or compatible. This can be enabled in the
1939e39003eSThomas Chou	  device tree with the correct input clock frequency. If the input
1949e39003eSThomas Chou	  clock frequency is not defined in the device tree, the macro
1959e39003eSThomas Chou	  CONFIG_SYS_NS16550_CLK defined in a legacy board header file will
1969e39003eSThomas Chou	  be used. It can be a constant or a function to get clock, eg,
1979e39003eSThomas Chou	  get_serial_clock().
1989e39003eSThomas Chou
199af282245SSimon Glassconfig SANDBOX_SERIAL
200af282245SSimon Glass	bool "Sandbox UART support"
2012ea65f3eSMasahiro Yamada	depends on SANDBOX
202af282245SSimon Glass	help
203af282245SSimon Glass	  Select this to enable a seral UART for sandbox. This is required to
204af282245SSimon Glass	  operate correctly, otherwise you will see no serial output from
205af282245SSimon Glass	  sandbox. The emulated UART will display to the console and console
206af282245SSimon Glass	  input will be fed into the UART. This allows you to interact with
207af282245SSimon Glass	  U-Boot.
208af282245SSimon Glass
209af282245SSimon Glass	  The operation of the console is controlled by the -t command-line
210af282245SSimon Glass	  flag. In raw mode, U-Boot sees all characters from the terminal
211af282245SSimon Glass	  before they are processed, including Ctrl-C. In cooked mode, Ctrl-C
212af282245SSimon Glass	  is processed by the terminal, and terminates U-Boot. Valid options
213af282245SSimon Glass	  are:
214af282245SSimon Glass
215af282245SSimon Glass	     -t raw-with-sigs	Raw mode, Ctrl-C will terminate U-Boot
216af282245SSimon Glass	     -t raw		Raw mode, Ctrl-C is processed by U-Boot
217af282245SSimon Glass	     -t cooked		Cooked mode, Ctrl-C terminates
218af282245SSimon Glass
219ff247b7aSMasahiro Yamadaconfig UNIPHIER_SERIAL
220b6ef3a3fSMasahiro Yamada	bool "Support for UniPhier on-chip UART"
2212ea65f3eSMasahiro Yamada	depends on ARCH_UNIPHIER
222ff247b7aSMasahiro Yamada	help
223b6ef3a3fSMasahiro Yamada	  If you have a UniPhier based board and want to use the on-chip
224b6ef3a3fSMasahiro Yamada	  serial ports, say Y to this option. If unsure, say N.
225dcfe4a54SSimon Glass
2260b11dbf7SMasahiro Yamadaendmenu
227