xref: /openbmc/u-boot/drivers/serial/Kconfig (revision 220e8021)
1#
2# Serial device configuration
3#
4
5menu "Serial drivers"
6
7config REQUIRE_SERIAL_CONSOLE
8	bool "Require a serial port for console"
9	# Running without a serial console is not supported by the
10	# non-dm serial code
11	depends on DM_SERIAL
12	default y
13	help
14	  Require a serial port for the console, and panic if none is found
15	  during serial port initialization (default y). Set this to n on
16	  boards which have no debug serial port whatsoever.
17
18config DM_SERIAL
19	bool "Enable Driver Model for serial drivers"
20	depends on DM
21	help
22	  Enable driver model for serial. This replaces
23	  drivers/serial/serial.c with the serial uclass, which
24	  implements serial_putc() etc. The uclass interface is
25	  defined in include/serial.h.
26
27config DEBUG_UART
28	bool "Enable an early debug UART for debugging"
29	help
30	  The debug UART is intended for use very early in U-Boot to debug
31	  problems when an ICE or other debug mechanism is not available.
32
33	  To use it you should:
34	  - Make sure your UART supports this interface
35	  - Enable CONFIG_DEBUG_UART
36	  - Enable the CONFIG for your UART to tell it to provide this interface
37	        (e.g. CONFIG_DEBUG_UART_NS16550)
38	  - Define the required settings as needed (see below)
39	  - Call debug_uart_init() before use
40	  - Call debug_uart_putc() to output a character
41
42	  Depending on your platform it may be possible to use this UART before
43	  a stack is available.
44
45	  If your UART does not support this interface you can probably add
46	  support quite easily. Remember that you cannot use driver model and
47	  it is preferred to use no stack.
48
49	  You must not use this UART once driver model is working and the
50	  serial drivers are up and running (done in serial_init()). Otherwise
51	  the drivers may conflict and you will get strange output.
52
53choice
54	prompt "Select which UART will provide the debug UART"
55	depends on DEBUG_UART
56
57config DEBUG_UART_ALTERA_JTAGUART
58	bool "Altera JTAG UART"
59	help
60	  Select this to enable a debug UART using the altera_jtag_uart driver.
61	  You will need to provide parameters to make this work. The driver will
62	  be available until the real driver model serial is running.
63
64config DEBUG_UART_NS16550
65	bool "ns16550"
66	help
67	  Select this to enable a debug UART using the ns16550 driver. You
68	  will need to provide parameters to make this work. The driver will
69	  be available until the real driver model serial is running.
70
71config DEBUG_EFI_CONSOLE
72	bool "EFI"
73	depends on EFI_APP
74	help
75	  Select this to enable a debug console which calls back to EFI to
76	  output to the console. This can be useful for early debugging of
77	  U-Boot when running on top of EFI (Extensive Firmware Interface).
78	  This is a type of BIOS used by PCs.
79
80config DEBUG_UART_S5P
81	bool "Samsung S5P"
82	help
83	  Select this to enable a debug UART using the serial_s5p driver. You
84	  will need to provide parameters to make this work. The driver will
85	  be available until the real driver-model serial is running.
86
87endchoice
88
89config DEBUG_UART_BASE
90	hex "Base address of UART"
91	depends on DEBUG_UART
92	help
93	  This is the base address of your UART for memory-mapped UARTs.
94
95	  A default should be provided by your board, but if not you will need
96	  to use the correct value here.
97
98config DEBUG_UART_CLOCK
99	int "UART input clock"
100	depends on DEBUG_UART
101	help
102	  The UART input clock determines the speed of the internal UART
103	  circuitry. The baud rate is derived from this by dividing the input
104	  clock down.
105
106	  A default should be provided by your board, but if not you will need
107	  to use the correct value here.
108
109config DEBUG_UART_SHIFT
110	int "UART register shift"
111	depends on DEBUG_UART
112	default 0 if DEBUG_UART
113	help
114	  Some UARTs (notably ns16550) support different register layouts
115	  where the registers are spaced either as bytes, words or some other
116	  value. Use this value to specify the shift to use, where 0=byte
117	  registers, 2=32-bit word registers, etc.
118
119config DEBUG_UART_BOARD_INIT
120	bool "Enable board-specific debug UART init"
121	depends on DEBUG_UART
122	help
123	  Some boards need to set things up before the debug UART can be used.
124	  On these boards a call to debug_uart_init() is insufficient. When
125	  this option is enabled, the function board_debug_uart_init() will
126	  be called when debug_uart_init() is called. You can put any code
127	  here that is needed to set up the UART ready for use, such as set
128	  pin multiplexing or enable clocks.
129
130config DEBUG_UART_ANNOUNCE
131	bool "Show a message when the debug UART starts up"
132	depends on DEBUG_UART
133	help
134	  Enable this option to show a message when the debug UART is ready
135	  for use. You will see a message like "<debug_uart> " as soon as
136	  U-Boot has the UART ready for use (i.e. your code calls
137	  debug_uart_init()). This can be useful just as a check that
138	  everything is working.
139
140config ALTERA_JTAG_UART
141	bool "Altera JTAG UART support"
142	depends on DM_SERIAL
143	help
144	  Select this to enable an JTAG UART for Altera devices.The JTAG UART
145	  core implements a method to communicate serial character streams
146	  between a host PC and a Qsys system on an Altera FPGA. Please find
147	  details on the "Embedded Peripherals IP User Guide" of Altera.
148
149config ALTERA_JTAG_UART_BYPASS
150	bool "Bypass output when no connection"
151	depends on ALTERA_JTAG_UART
152	help
153	  Bypass console output and keep going even if there is no JTAG
154	  terminal connection with the host. The console output will resume
155	  once the JTAG terminal is connected. Without the bypass, the console
156	  output will wait forever until a JTAG terminal is connected. If you
157	  not are sure, say Y.
158
159config ROCKCHIP_SERIAL
160	bool "Rockchip on-chip UART support"
161	depends on ARCH_ROCKCHIP && DM_SERIAL
162	help
163	  Select this to enable a debug UART for Rockchip devices. This uses
164	  the ns16550 driver. You will need to #define CONFIG_SYS_NS16550 in
165	  your board config header. The clock input is automatically set to
166	  use the oscillator (24MHz).
167
168config SANDBOX_SERIAL
169	bool "Sandbox UART support"
170	depends on SANDBOX
171	help
172	  Select this to enable a seral UART for sandbox. This is required to
173	  operate correctly, otherwise you will see no serial output from
174	  sandbox. The emulated UART will display to the console and console
175	  input will be fed into the UART. This allows you to interact with
176	  U-Boot.
177
178	  The operation of the console is controlled by the -t command-line
179	  flag. In raw mode, U-Boot sees all characters from the terminal
180	  before they are processed, including Ctrl-C. In cooked mode, Ctrl-C
181	  is processed by the terminal, and terminates U-Boot. Valid options
182	  are:
183
184	     -t raw-with-sigs	Raw mode, Ctrl-C will terminate U-Boot
185	     -t raw		Raw mode, Ctrl-C is processed by U-Boot
186	     -t cooked		Cooked mode, Ctrl-C terminates
187
188config UNIPHIER_SERIAL
189	bool "Support for UniPhier on-chip UART"
190	depends on ARCH_UNIPHIER
191	help
192	  If you have a UniPhier based board and want to use the on-chip
193	  serial ports, say Y to this option. If unsure, say N.
194
195config X86_SERIAL
196	bool "Support for 16550 serial port on x86 machines"
197	depends on X86
198	default y
199	help
200	  Most x86 machines have a ns16550 UART or compatible. This can be
201	  enabled in the device tree with the correct input clock frequency
202	  provided (default 1843200). Enable this to obtain serial console
203	  output.
204
205endmenu
206