xref: /openbmc/u-boot/drivers/serial/Kconfig (revision 2399e401)
1#
2# Serial device configuration
3#
4
5menu "Serial drivers"
6
7config BAUDRATE
8	int "Default baudrate"
9	default 115200
10	help
11	  Select a default baudrate, where "default" has a driver-specific
12	  meaning of either setting the baudrate for the early debug UART
13	  in the SPL stage (most drivers) or for choosing a default baudrate
14	  in the absence of an environment setting (serial_mxc.c).
15
16config REQUIRE_SERIAL_CONSOLE
17	bool "Require a serial port for console"
18	# Running without a serial console is not supported by the
19	# non-dm serial code
20	depends on DM_SERIAL
21	default y
22	help
23	  Require a serial port for the console, and panic if none is found
24	  during serial port initialization (default y). Set this to n on
25	  boards which have no debug serial port whatsoever.
26
27config SERIAL_PRESENT
28	bool "Provide a serial driver"
29	depends on DM_SERIAL
30	default y
31	help
32	  In very space-constrained devices even the full UART driver is too
33	  large. In this case the debug UART can still be used in some cases.
34	  This option enables the full UART in U-Boot, so if is it disabled,
35	  the full UART driver will be omitted, thus saving space.
36
37config SPL_SERIAL_PRESENT
38	bool "Provide a serial driver in SPL"
39	depends on DM_SERIAL
40	default y
41	help
42	  In very space-constrained devices even the full UART driver is too
43	  large. In this case the debug UART can still be used in some cases.
44	  This option enables the full UART in SPL, so if is it disabled,
45	  the full UART driver will be omitted, thus saving space.
46
47config DM_SERIAL
48	bool "Enable Driver Model for serial drivers"
49	depends on DM
50	help
51	  Enable driver model for serial. This replaces
52	  drivers/serial/serial.c with the serial uclass, which
53	  implements serial_putc() etc. The uclass interface is
54	  defined in include/serial.h.
55
56config DEBUG_UART
57	bool "Enable an early debug UART for debugging"
58	help
59	  The debug UART is intended for use very early in U-Boot to debug
60	  problems when an ICE or other debug mechanism is not available.
61
62	  To use it you should:
63	  - Make sure your UART supports this interface
64	  - Enable CONFIG_DEBUG_UART
65	  - Enable the CONFIG for your UART to tell it to provide this interface
66	        (e.g. CONFIG_DEBUG_UART_NS16550)
67	  - Define the required settings as needed (see below)
68	  - Call debug_uart_init() before use
69	  - Call debug_uart_putc() to output a character
70
71	  Depending on your platform it may be possible to use this UART before
72	  a stack is available.
73
74	  If your UART does not support this interface you can probably add
75	  support quite easily. Remember that you cannot use driver model and
76	  it is preferred to use no stack.
77
78	  You must not use this UART once driver model is working and the
79	  serial drivers are up and running (done in serial_init()). Otherwise
80	  the drivers may conflict and you will get strange output.
81
82choice
83	prompt "Select which UART will provide the debug UART"
84	depends on DEBUG_UART
85	default DEBUG_UART_NS16550
86
87config DEBUG_UART_ALTERA_JTAGUART
88	bool "Altera JTAG UART"
89	help
90	  Select this to enable a debug UART using the altera_jtag_uart driver.
91	  You will need to provide parameters to make this work. The driver will
92	  be available until the real driver model serial is running.
93
94config DEBUG_UART_ALTERA_UART
95	bool "Altera UART"
96	help
97	  Select this to enable a debug UART using the altera_uart driver.
98	  You will need to provide parameters to make this work. The driver will
99	  be available until the real driver model serial is running.
100
101config DEBUG_UART_AR933X
102	bool "QCA/Atheros ar933x"
103	depends on AR933X_UART
104	help
105	  Select this to enable a debug UART using the ar933x uart driver.
106	  You will need to provide parameters to make this work. The
107	  driver will be available until the real driver model serial is
108	  running.
109
110config DEBUG_UART_ATMEL
111	bool "Atmel USART"
112	help
113	  Select this to enable a debug UART using the atmel usart driver. You
114	  will need to provide parameters to make this work. The driver will
115	  be available until the real driver-model serial is running.
116
117config DEBUG_UART_NS16550
118	bool "ns16550"
119	help
120	  Select this to enable a debug UART using the ns16550 driver. You
121	  will need to provide parameters to make this work. The driver will
122	  be available until the real driver model serial is running.
123
124config DEBUG_EFI_CONSOLE
125	bool "EFI"
126	depends on EFI_APP
127	help
128	  Select this to enable a debug console which calls back to EFI to
129	  output to the console. This can be useful for early debugging of
130	  U-Boot when running on top of EFI (Extensive Firmware Interface).
131	  This is a type of BIOS used by PCs.
132
133config DEBUG_UART_S5P
134	bool "Samsung S5P"
135	help
136	  Select this to enable a debug UART using the serial_s5p driver. You
137	  will need to provide parameters to make this work. The driver will
138	  be available until the real driver-model serial is running.
139
140config DEBUG_UART_MESON
141	bool "Amlogic Meson"
142	depends on MESON_SERIAL
143	help
144	  Select this to enable a debug UART using the serial_meson driver. You
145	  will need to provide parameters to make this work. The driver will
146	  be available until the real driver-model serial is running.
147
148config DEBUG_UART_UARTLITE
149	bool "Xilinx Uartlite"
150	help
151	  Select this to enable a debug UART using the serial_uartlite driver.
152	  You will need to provide parameters to make this work. The driver will
153	  be available until the real driver-model serial is running.
154
155config DEBUG_UART_ARM_DCC
156	bool "ARM DCC"
157	help
158	  Select this to enable a debug UART using the ARM JTAG DCC port.
159	  The DCC port can be used for very early debugging and doesn't require
160	  any additional setting like address/baudrate/clock. On systems without
161	  any serial interface this is the easiest way how to get console.
162	  Every ARM core has own DCC port which is the part of debug interface.
163	  This port is available at least on ARMv6, ARMv7, ARMv8 and XScale
164	  architectures.
165
166config DEBUG_MVEBU_A3700_UART
167	bool "Marvell Armada 3700"
168	help
169	  Select this to enable a debug UART using the serial_mvebu driver. You
170	  will need to provide parameters to make this work. The driver will
171	  be available until the real driver-model serial is running.
172
173config DEBUG_UART_ZYNQ
174	bool "Xilinx Zynq"
175	help
176	  Select this to enable a debug UART using the serial_zynq driver. You
177	  will need to provide parameters to make this work. The driver will
178	  be available until the real driver-model serial is running.
179
180config DEBUG_UART_APBUART
181	depends on LEON3
182	bool "Gaisler APBUART"
183	help
184	  Select this to enable a debug UART using the serial_leon3 driver. You
185	  will need to provide parameters to make this work. The driver will
186	  be available until the real driver model serial is running.
187
188config DEBUG_UART_PL010
189	bool "pl010"
190	help
191	  Select this to enable a debug UART using the pl01x driver with the
192	  PL010 UART type. You will need to provide parameters to make this
193	  work. The driver will be available until the real driver model
194	  serial is running.
195
196config DEBUG_UART_PL011
197	bool "pl011"
198	help
199	  Select this to enable a debug UART using the pl01x driver with the
200	  PL011 UART type. You will need to provide parameters to make this
201	  work. The driver will be available until the real driver model
202	  serial is running.
203
204config DEBUG_UART_PIC32
205	bool "Microchip PIC32"
206	depends on PIC32_SERIAL
207	help
208	  Select this to enable a debug UART using the serial_pic32 driver. You
209	  will need to provide parameters to make this work. The driver will
210	  be available until the real driver model serial is running.
211
212config DEBUG_UART_UNIPHIER
213	bool "UniPhier on-chip UART"
214	depends on ARCH_UNIPHIER
215	help
216	  Select this to enable a debug UART using the UniPhier on-chip UART.
217	  You will need to provide DEBUG_UART_BASE to make this work.  The
218	  driver will be available until the real driver-model serial is
219	  running.
220
221endchoice
222
223config DEBUG_UART_BASE
224	hex "Base address of UART"
225	depends on DEBUG_UART
226	help
227	  This is the base address of your UART for memory-mapped UARTs.
228
229	  A default should be provided by your board, but if not you will need
230	  to use the correct value here.
231
232config DEBUG_UART_CLOCK
233	int "UART input clock"
234	depends on DEBUG_UART
235	help
236	  The UART input clock determines the speed of the internal UART
237	  circuitry. The baud rate is derived from this by dividing the input
238	  clock down.
239
240	  A default should be provided by your board, but if not you will need
241	  to use the correct value here.
242
243config DEBUG_UART_SHIFT
244	int "UART register shift"
245	depends on DEBUG_UART
246	default 0 if DEBUG_UART
247	help
248	  Some UARTs (notably ns16550) support different register layouts
249	  where the registers are spaced either as bytes, words or some other
250	  value. Use this value to specify the shift to use, where 0=byte
251	  registers, 2=32-bit word registers, etc.
252
253config DEBUG_UART_BOARD_INIT
254	bool "Enable board-specific debug UART init"
255	depends on DEBUG_UART
256	help
257	  Some boards need to set things up before the debug UART can be used.
258	  On these boards a call to debug_uart_init() is insufficient. When
259	  this option is enabled, the function board_debug_uart_init() will
260	  be called when debug_uart_init() is called. You can put any code
261	  here that is needed to set up the UART ready for use, such as set
262	  pin multiplexing or enable clocks.
263
264config DEBUG_UART_ANNOUNCE
265	bool "Show a message when the debug UART starts up"
266	depends on DEBUG_UART
267	help
268	  Enable this option to show a message when the debug UART is ready
269	  for use. You will see a message like "<debug_uart> " as soon as
270	  U-Boot has the UART ready for use (i.e. your code calls
271	  debug_uart_init()). This can be useful just as a check that
272	  everything is working.
273
274config DEBUG_UART_SKIP_INIT
275	bool "Skip UART initialization"
276	help
277	  Select this if the UART you want to use for debug output is already
278	  initialized by the time U-Boot starts its execution.
279
280config ALTERA_JTAG_UART
281	bool "Altera JTAG UART support"
282	depends on DM_SERIAL
283	help
284	  Select this to enable an JTAG UART for Altera devices.The JTAG UART
285	  core implements a method to communicate serial character streams
286	  between a host PC and a Qsys system on an Altera FPGA. Please find
287	  details on the "Embedded Peripherals IP User Guide" of Altera.
288
289config ALTERA_JTAG_UART_BYPASS
290	bool "Bypass output when no connection"
291	depends on ALTERA_JTAG_UART
292	help
293	  Bypass console output and keep going even if there is no JTAG
294	  terminal connection with the host. The console output will resume
295	  once the JTAG terminal is connected. Without the bypass, the console
296	  output will wait forever until a JTAG terminal is connected. If you
297	  not are sure, say Y.
298
299config ALTERA_UART
300	bool "Altera UART support"
301	depends on DM_SERIAL
302	help
303	  Select this to enable an UART for Altera devices. Please find
304	  details on the "Embedded Peripherals IP User Guide" of Altera.
305
306config AR933X_UART
307	bool "QCA/Atheros ar933x UART support"
308	depends on DM_SERIAL && SOC_AR933X
309	help
310	  Select this to enable UART support for QCA/Atheros ar933x
311	  devices. This driver uses driver model and requires a device
312	  tree binding to operate, please refer to the document at
313	  doc/device-tree-bindings/serial/qca,ar9330-uart.txt.
314
315config ATMEL_USART
316	bool "Atmel USART support"
317	help
318	  Select this to enable USART support for Atmel SoCs. It can be
319	  configured in the device tree, and input clock frequency can
320	  be got from the clk node.
321
322config FSL_LPUART
323	bool "Freescale LPUART support"
324	help
325	  Select this to enable a Low Power UART for Freescale VF610 and
326	  QorIQ Layerscape devices.
327
328config MVEBU_A3700_UART
329	bool "UART support for Armada 3700"
330	default n
331	help
332	  Choose this option to add support for UART driver on the Marvell
333	  Armada 3700 SoC. The base address is configured via DT.
334
335config MXC_UART
336	bool "IMX serial port support"
337	depends on MX5 || MX6
338	help
339	  If you have a machine based on a Motorola IMX CPU you
340	  can enable its onboard serial port by enabling this option.
341
342config PIC32_SERIAL
343	bool "Support for Microchip PIC32 on-chip UART"
344	depends on DM_SERIAL && MACH_PIC32
345	default y
346	help
347	  Support for the UART found on Microchip PIC32 SoC's.
348
349config SYS_NS16550
350	bool "NS16550 UART or compatible"
351	help
352	  Support NS16550 UART or compatible. This can be enabled in the
353	  device tree with the correct input clock frequency. If the input
354	  clock frequency is not defined in the device tree, the macro
355	  CONFIG_SYS_NS16550_CLK defined in a legacy board header file will
356	  be used. It can be a constant or a function to get clock, eg,
357	  get_serial_clock().
358
359config ROCKCHIP_SERIAL
360	bool "Rockchip on-chip UART support"
361	depends on DM_SERIAL && SPL_OF_PLATDATA
362	help
363	  Select this to enable a debug UART for Rockchip devices when using
364	  CONFIG_SPL_OF_PLATDATA (i.e. a compiled-in device tree replacemenmt).
365	  This uses the ns16550 driver, converting the platdata from of-platdata
366	  to the ns16550 format.
367
368config SANDBOX_SERIAL
369	bool "Sandbox UART support"
370	depends on SANDBOX
371	help
372	  Select this to enable a seral UART for sandbox. This is required to
373	  operate correctly, otherwise you will see no serial output from
374	  sandbox. The emulated UART will display to the console and console
375	  input will be fed into the UART. This allows you to interact with
376	  U-Boot.
377
378	  The operation of the console is controlled by the -t command-line
379	  flag. In raw mode, U-Boot sees all characters from the terminal
380	  before they are processed, including Ctrl-C. In cooked mode, Ctrl-C
381	  is processed by the terminal, and terminates U-Boot. Valid options
382	  are:
383
384	     -t raw-with-sigs	Raw mode, Ctrl-C will terminate U-Boot
385	     -t raw		Raw mode, Ctrl-C is processed by U-Boot
386	     -t cooked		Cooked mode, Ctrl-C terminates
387
388config UNIPHIER_SERIAL
389	bool "Support for UniPhier on-chip UART"
390	depends on ARCH_UNIPHIER
391	default y
392	help
393	  If you have a UniPhier based board and want to use the on-chip
394	  serial ports, say Y to this option. If unsure, say N.
395
396config XILINX_UARTLITE
397	bool "Xilinx Uarlite support"
398	depends on DM_SERIAL && (MICROBLAZE || ARCH_ZYNQ || ARCH_ZYNQMP || 4xx)
399	help
400	  If you have a Xilinx based board and want to use the uartlite
401	  serial ports, say Y to this option. If unsure, say N.
402
403config MESON_SERIAL
404	bool "Support for Amlogic Meson UART"
405	depends on DM_SERIAL && ARCH_MESON
406	help
407	  If you have an Amlogic Meson based board and want to use the on-chip
408	  serial ports, say Y to this option. If unsure, say N.
409
410config MSM_SERIAL
411	bool "Qualcomm on-chip UART"
412	depends on DM_SERIAL
413	help
414	  Support Data Mover UART used on Qualcomm Snapdragon SoCs.
415	  It should support all Qualcomm devices with UARTDM version 1.4,
416	  for example APQ8016 and MSM8916.
417	  Single baudrate is supported in current implementation (115200).
418
419config PXA_SERIAL
420	bool "PXA serial port support"
421	help
422	  If you have a machine based on a Marvell XScale PXA2xx CPU you
423	  can enable its onboard serial ports by enabling this option.
424
425config STI_ASC_SERIAL
426	bool "STMicroelectronics on-chip UART"
427	depends on DM_SERIAL && ARCH_STI
428	help
429	  Select this to enable Asynchronous Serial Controller available
430	  on STiH410 SoC. This is a basic implementation,  it supports
431	  following baudrate 9600, 19200, 38400, 57600 and 115200.
432
433endmenu
434