xref: /openbmc/u-boot/drivers/serial/Kconfig (revision 2ea65f3e)
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
5621d00436SSimon Glass
5721d00436SSimon Glassconfig DEBUG_UART_NS16550
5821d00436SSimon Glass	bool "ns16550"
5921d00436SSimon Glass	help
6021d00436SSimon Glass	  Select this to enable a debug UART using the ns16550 driver. You
6121d00436SSimon Glass	  will need to provide parameters to make this work. The driver will
6221d00436SSimon Glass	  be available until the real driver model serial is running.
6321d00436SSimon Glass
64275854baSSimon Glassconfig DEBUG_EFI_CONSOLE
65275854baSSimon Glass	bool "EFI"
66275854baSSimon Glass	depends on EFI_APP
67275854baSSimon Glass	help
68275854baSSimon Glass	  Select this to enable a debug console which calls back to EFI to
69275854baSSimon Glass	  output to the console. This can be useful for early debugging of
70275854baSSimon Glass	  U-Boot when running on top of EFI (Extensive Firmware Interface).
71275854baSSimon Glass	  This is a type of BIOS used by PCs.
72275854baSSimon Glass
73bf6e7022SSimon Glassconfig DEBUG_UART_S5P
74bf6e7022SSimon Glass	bool "Samsung S5P"
75bf6e7022SSimon Glass	help
76bf6e7022SSimon Glass	  Select this to enable a debug UART using the serial_s5p driver. You
77bf6e7022SSimon Glass	  will need to provide parameters to make this work. The driver will
78bf6e7022SSimon Glass	  be available until the real driver-model serial is running.
79bf6e7022SSimon Glass
8021d00436SSimon Glassendchoice
8121d00436SSimon Glass
822f964aa7SSimon Glassconfig DEBUG_UART_BASE
832f964aa7SSimon Glass	hex "Base address of UART"
842f964aa7SSimon Glass	depends on DEBUG_UART
852f964aa7SSimon Glass	help
862f964aa7SSimon Glass	  This is the base address of your UART for memory-mapped UARTs.
872f964aa7SSimon Glass
882f964aa7SSimon Glass	  A default should be provided by your board, but if not you will need
892f964aa7SSimon Glass	  to use the correct value here.
902f964aa7SSimon Glass
912f964aa7SSimon Glassconfig DEBUG_UART_CLOCK
922f964aa7SSimon Glass	int "UART input clock"
932f964aa7SSimon Glass	depends on DEBUG_UART
942f964aa7SSimon Glass	help
952f964aa7SSimon Glass	  The UART input clock determines the speed of the internal UART
962f964aa7SSimon Glass	  circuitry. The baud rate is derived from this by dividing the input
972f964aa7SSimon Glass	  clock down.
982f964aa7SSimon Glass
992f964aa7SSimon Glass	  A default should be provided by your board, but if not you will need
1002f964aa7SSimon Glass	  to use the correct value here.
1012f964aa7SSimon Glass
102dd0b0122SSimon Glassconfig DEBUG_UART_SHIFT
103dd0b0122SSimon Glass	int "UART register shift"
104dd0b0122SSimon Glass	depends on DEBUG_UART
105dd0b0122SSimon Glass	default 0 if DEBUG_UART
106dd0b0122SSimon Glass	help
107dd0b0122SSimon Glass	  Some UARTs (notably ns16550) support different register layouts
108dd0b0122SSimon Glass	  where the registers are spaced either as bytes, words or some other
109dd0b0122SSimon Glass	  value. Use this value to specify the shift to use, where 0=byte
110dd0b0122SSimon Glass	  registers, 2=32-bit word registers, etc.
111dd0b0122SSimon Glass
112af282245SSimon Glassconfig SANDBOX_SERIAL
113af282245SSimon Glass	bool "Sandbox UART support"
114*2ea65f3eSMasahiro Yamada	depends on SANDBOX
115af282245SSimon Glass	help
116af282245SSimon Glass	  Select this to enable a seral UART for sandbox. This is required to
117af282245SSimon Glass	  operate correctly, otherwise you will see no serial output from
118af282245SSimon Glass	  sandbox. The emulated UART will display to the console and console
119af282245SSimon Glass	  input will be fed into the UART. This allows you to interact with
120af282245SSimon Glass	  U-Boot.
121af282245SSimon Glass
122af282245SSimon Glass	  The operation of the console is controlled by the -t command-line
123af282245SSimon Glass	  flag. In raw mode, U-Boot sees all characters from the terminal
124af282245SSimon Glass	  before they are processed, including Ctrl-C. In cooked mode, Ctrl-C
125af282245SSimon Glass	  is processed by the terminal, and terminates U-Boot. Valid options
126af282245SSimon Glass	  are:
127af282245SSimon Glass
128af282245SSimon Glass	     -t raw-with-sigs	Raw mode, Ctrl-C will terminate U-Boot
129af282245SSimon Glass	     -t raw		Raw mode, Ctrl-C is processed by U-Boot
130af282245SSimon Glass	     -t cooked		Cooked mode, Ctrl-C terminates
131af282245SSimon Glass
132ff247b7aSMasahiro Yamadaconfig UNIPHIER_SERIAL
133b6ef3a3fSMasahiro Yamada	bool "Support for UniPhier on-chip UART"
134*2ea65f3eSMasahiro Yamada	depends on ARCH_UNIPHIER
135ff247b7aSMasahiro Yamada	help
136b6ef3a3fSMasahiro Yamada	  If you have a UniPhier based board and want to use the on-chip
137b6ef3a3fSMasahiro Yamada	  serial ports, say Y to this option. If unsure, say N.
138dcfe4a54SSimon Glass
139dcfe4a54SSimon Glassconfig X86_SERIAL
140dcfe4a54SSimon Glass	bool "Support for 16550 serial port on x86 machines"
141dcfe4a54SSimon Glass	depends on X86
142dcfe4a54SSimon Glass	default y
143dcfe4a54SSimon Glass	help
144dcfe4a54SSimon Glass	  Most x86 machines have a ns16550 UART or compatible. This can be
145dcfe4a54SSimon Glass	  enabled in the device tree with the correct input clock frequency
146dcfe4a54SSimon Glass	  provided (default 1843200). Enable this to obtain serial console
147dcfe4a54SSimon Glass	  output.
1480b11dbf7SMasahiro Yamada
1490b11dbf7SMasahiro Yamadaendmenu
150