xref: /openbmc/u-boot/drivers/serial/Kconfig (revision 19a5ef60)
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 SERIAL_PRESENT
19	bool "Provide a serial driver"
20	depends on DM_SERIAL
21	default y
22	help
23	  In very space-constrained devices even the full UART driver is too
24	  large. In this case the debug UART can still be used in some cases.
25	  This option enables the full UART in U-Boot, so if is it disabled,
26	  the full UART driver will be omitted, thus saving space.
27
28config SPL_SERIAL_PRESENT
29	bool "Provide a serial driver in SPL"
30	depends on DM_SERIAL
31	default y
32	help
33	  In very space-constrained devices even the full UART driver is too
34	  large. In this case the debug UART can still be used in some cases.
35	  This option enables the full UART in SPL, so if is it disabled,
36	  the full UART driver will be omitted, thus saving space.
37
38config DM_SERIAL
39	bool "Enable Driver Model for serial drivers"
40	depends on DM
41	help
42	  Enable driver model for serial. This replaces
43	  drivers/serial/serial.c with the serial uclass, which
44	  implements serial_putc() etc. The uclass interface is
45	  defined in include/serial.h.
46
47config DEBUG_UART
48	bool "Enable an early debug UART for debugging"
49	help
50	  The debug UART is intended for use very early in U-Boot to debug
51	  problems when an ICE or other debug mechanism is not available.
52
53	  To use it you should:
54	  - Make sure your UART supports this interface
55	  - Enable CONFIG_DEBUG_UART
56	  - Enable the CONFIG for your UART to tell it to provide this interface
57	        (e.g. CONFIG_DEBUG_UART_NS16550)
58	  - Define the required settings as needed (see below)
59	  - Call debug_uart_init() before use
60	  - Call debug_uart_putc() to output a character
61
62	  Depending on your platform it may be possible to use this UART before
63	  a stack is available.
64
65	  If your UART does not support this interface you can probably add
66	  support quite easily. Remember that you cannot use driver model and
67	  it is preferred to use no stack.
68
69	  You must not use this UART once driver model is working and the
70	  serial drivers are up and running (done in serial_init()). Otherwise
71	  the drivers may conflict and you will get strange output.
72
73choice
74	prompt "Select which UART will provide the debug UART"
75	depends on DEBUG_UART
76	default DEBUG_UART_NS16550
77
78config DEBUG_UART_ALTERA_JTAGUART
79	bool "Altera JTAG UART"
80	help
81	  Select this to enable a debug UART using the altera_jtag_uart driver.
82	  You will need to provide parameters to make this work. The driver will
83	  be available until the real driver model serial is running.
84
85config DEBUG_UART_ALTERA_UART
86	bool "Altera UART"
87	help
88	  Select this to enable a debug UART using the altera_uart driver.
89	  You will need to provide parameters to make this work. The driver will
90	  be available until the real driver model serial is running.
91
92config DEBUG_UART_NS16550
93	bool "ns16550"
94	help
95	  Select this to enable a debug UART using the ns16550 driver. You
96	  will need to provide parameters to make this work. The driver will
97	  be available until the real driver model serial is running.
98
99config DEBUG_EFI_CONSOLE
100	bool "EFI"
101	depends on EFI_APP
102	help
103	  Select this to enable a debug console which calls back to EFI to
104	  output to the console. This can be useful for early debugging of
105	  U-Boot when running on top of EFI (Extensive Firmware Interface).
106	  This is a type of BIOS used by PCs.
107
108config DEBUG_UART_S5P
109	bool "Samsung S5P"
110	help
111	  Select this to enable a debug UART using the serial_s5p driver. You
112	  will need to provide parameters to make this work. The driver will
113	  be available until the real driver-model serial is running.
114
115config DEBUG_UART_UARTLITE
116	bool "Xilinx Uartlite"
117	help
118	  Select this to enable a debug UART using the serial_uartlite driver.
119	  You will need to provide parameters to make this work. The driver will
120	  be available until the real driver-model serial is running.
121
122config DEBUG_UART_ZYNQ
123	bool "Xilinx Zynq"
124	help
125	  Select this to enable a debug UART using the serial_zynq driver. You
126	  will need to provide parameters to make this work. The driver will
127	  be available until the real driver-model serial is running.
128
129config DEBUG_UART_APBUART
130	depends on LEON3
131	bool "Gaisler APBUART"
132	help
133	  Select this to enable a debug UART using the serial_leon3 driver. You
134	  will need to provide parameters to make this work. The driver will
135	  be available until the real driver model serial is running.
136
137config DEBUG_UART_PL010
138	bool "pl010"
139	help
140	  Select this to enable a debug UART using the pl01x driver with the
141	  PL010 UART type. You will need to provide parameters to make this
142	  work. The driver will be available until the real driver model
143	  serial is running.
144
145config DEBUG_UART_PL011
146	bool "pl011"
147	help
148	  Select this to enable a debug UART using the pl01x driver with the
149	  PL011 UART type. You will need to provide parameters to make this
150	  work. The driver will be available until the real driver model
151	  serial is running.
152
153endchoice
154
155config DEBUG_UART_BASE
156	hex "Base address of UART"
157	depends on DEBUG_UART
158	help
159	  This is the base address of your UART for memory-mapped UARTs.
160
161	  A default should be provided by your board, but if not you will need
162	  to use the correct value here.
163
164config DEBUG_UART_CLOCK
165	int "UART input clock"
166	depends on DEBUG_UART
167	help
168	  The UART input clock determines the speed of the internal UART
169	  circuitry. The baud rate is derived from this by dividing the input
170	  clock down.
171
172	  A default should be provided by your board, but if not you will need
173	  to use the correct value here.
174
175config DEBUG_UART_SHIFT
176	int "UART register shift"
177	depends on DEBUG_UART
178	default 0 if DEBUG_UART
179	help
180	  Some UARTs (notably ns16550) support different register layouts
181	  where the registers are spaced either as bytes, words or some other
182	  value. Use this value to specify the shift to use, where 0=byte
183	  registers, 2=32-bit word registers, etc.
184
185config DEBUG_UART_BOARD_INIT
186	bool "Enable board-specific debug UART init"
187	depends on DEBUG_UART
188	help
189	  Some boards need to set things up before the debug UART can be used.
190	  On these boards a call to debug_uart_init() is insufficient. When
191	  this option is enabled, the function board_debug_uart_init() will
192	  be called when debug_uart_init() is called. You can put any code
193	  here that is needed to set up the UART ready for use, such as set
194	  pin multiplexing or enable clocks.
195
196config DEBUG_UART_ANNOUNCE
197	bool "Show a message when the debug UART starts up"
198	depends on DEBUG_UART
199	help
200	  Enable this option to show a message when the debug UART is ready
201	  for use. You will see a message like "<debug_uart> " as soon as
202	  U-Boot has the UART ready for use (i.e. your code calls
203	  debug_uart_init()). This can be useful just as a check that
204	  everything is working.
205
206config DEBUG_UART_SKIP_INIT
207	bool "Skip UART initialization"
208	help
209	  Select this if the UART you want to use for debug output is already
210	  initialized by the time U-Boot starts its execution.
211
212config ALTERA_JTAG_UART
213	bool "Altera JTAG UART support"
214	depends on DM_SERIAL
215	help
216	  Select this to enable an JTAG UART for Altera devices.The JTAG UART
217	  core implements a method to communicate serial character streams
218	  between a host PC and a Qsys system on an Altera FPGA. Please find
219	  details on the "Embedded Peripherals IP User Guide" of Altera.
220
221config ALTERA_JTAG_UART_BYPASS
222	bool "Bypass output when no connection"
223	depends on ALTERA_JTAG_UART
224	help
225	  Bypass console output and keep going even if there is no JTAG
226	  terminal connection with the host. The console output will resume
227	  once the JTAG terminal is connected. Without the bypass, the console
228	  output will wait forever until a JTAG terminal is connected. If you
229	  not are sure, say Y.
230
231config ALTERA_UART
232	bool "Altera UART support"
233	depends on DM_SERIAL
234	help
235	  Select this to enable an UART for Altera devices. Please find
236	  details on the "Embedded Peripherals IP User Guide" of Altera.
237
238config FSL_LPUART
239	bool "Freescale LPUART support"
240	help
241	  Select this to enable a Low Power UART for Freescale VF610 and
242	  QorIQ Layerscape devices.
243
244config SYS_NS16550
245	bool "NS16550 UART or compatible"
246	help
247	  Support NS16550 UART or compatible. This can be enabled in the
248	  device tree with the correct input clock frequency. If the input
249	  clock frequency is not defined in the device tree, the macro
250	  CONFIG_SYS_NS16550_CLK defined in a legacy board header file will
251	  be used. It can be a constant or a function to get clock, eg,
252	  get_serial_clock().
253
254config SANDBOX_SERIAL
255	bool "Sandbox UART support"
256	depends on SANDBOX
257	help
258	  Select this to enable a seral UART for sandbox. This is required to
259	  operate correctly, otherwise you will see no serial output from
260	  sandbox. The emulated UART will display to the console and console
261	  input will be fed into the UART. This allows you to interact with
262	  U-Boot.
263
264	  The operation of the console is controlled by the -t command-line
265	  flag. In raw mode, U-Boot sees all characters from the terminal
266	  before they are processed, including Ctrl-C. In cooked mode, Ctrl-C
267	  is processed by the terminal, and terminates U-Boot. Valid options
268	  are:
269
270	     -t raw-with-sigs	Raw mode, Ctrl-C will terminate U-Boot
271	     -t raw		Raw mode, Ctrl-C is processed by U-Boot
272	     -t cooked		Cooked mode, Ctrl-C terminates
273
274config UNIPHIER_SERIAL
275	bool "Support for UniPhier on-chip UART"
276	depends on ARCH_UNIPHIER
277	help
278	  If you have a UniPhier based board and want to use the on-chip
279	  serial ports, say Y to this option. If unsure, say N.
280
281config XILINX_UARTLITE
282	bool "Xilinx Uarlite support"
283	depends on DM_SERIAL && (MICROBLAZE || ARCH_ZYNQ || ARCH_ZYNQMP || 4xx)
284	help
285	  If you have a Xilinx based board and want to use the uartlite
286	  serial ports, say Y to this option. If unsure, say N.
287
288endmenu
289