xref: /openbmc/u-boot/drivers/serial/Kconfig (revision be3fcd0f)
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_AR933X
93	bool "QCA/Atheros ar933x"
94	depends on AR933X_UART
95	help
96	  Select this to enable a debug UART using the ar933x uart driver.
97	  You will need to provide parameters to make this work. The
98	  driver will be available until the real driver model serial is
99	  running.
100
101config DEBUG_UART_NS16550
102	bool "ns16550"
103	help
104	  Select this to enable a debug UART using the ns16550 driver. You
105	  will need to provide parameters to make this work. The driver will
106	  be available until the real driver model serial is running.
107
108config DEBUG_EFI_CONSOLE
109	bool "EFI"
110	depends on EFI_APP
111	help
112	  Select this to enable a debug console which calls back to EFI to
113	  output to the console. This can be useful for early debugging of
114	  U-Boot when running on top of EFI (Extensive Firmware Interface).
115	  This is a type of BIOS used by PCs.
116
117config DEBUG_UART_S5P
118	bool "Samsung S5P"
119	help
120	  Select this to enable a debug UART using the serial_s5p 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_UART_MESON
125	bool "Amlogic Meson"
126	depends on MESON_SERIAL
127	help
128	  Select this to enable a debug UART using the serial_meson driver. You
129	  will need to provide parameters to make this work. The driver will
130	  be available until the real driver-model serial is running.
131
132config DEBUG_UART_UARTLITE
133	bool "Xilinx Uartlite"
134	help
135	  Select this to enable a debug UART using the serial_uartlite driver.
136	  You will need to provide parameters to make this work. The driver will
137	  be available until the real driver-model serial is running.
138
139config DEBUG_UART_ARM_DCC
140	bool "ARM DCC"
141	help
142	  Select this to enable a debug UART using the ARM JTAG DCC port.
143	  The DCC port can be used for very early debugging and doesn't require
144	  any additional setting like address/baudrate/clock. On systems without
145	  any serial interface this is the easiest way how to get console.
146	  Every ARM core has own DCC port which is the part of debug interface.
147	  This port is available at least on ARMv6, ARMv7, ARMv8 and XScale
148	  architectures.
149
150config DEBUG_MVEBU_A3700_UART
151	bool "Marvell Armada 3700"
152	help
153	  Select this to enable a debug UART using the serial_mvebu driver. You
154	  will need to provide parameters to make this work. The driver will
155	  be available until the real driver-model serial is running.
156
157config DEBUG_UART_ZYNQ
158	bool "Xilinx Zynq"
159	help
160	  Select this to enable a debug UART using the serial_zynq driver. You
161	  will need to provide parameters to make this work. The driver will
162	  be available until the real driver-model serial is running.
163
164config DEBUG_UART_APBUART
165	depends on LEON3
166	bool "Gaisler APBUART"
167	help
168	  Select this to enable a debug UART using the serial_leon3 driver. You
169	  will need to provide parameters to make this work. The driver will
170	  be available until the real driver model serial is running.
171
172config DEBUG_UART_PL010
173	bool "pl010"
174	help
175	  Select this to enable a debug UART using the pl01x driver with the
176	  PL010 UART type. You will need to provide parameters to make this
177	  work. The driver will be available until the real driver model
178	  serial is running.
179
180config DEBUG_UART_PL011
181	bool "pl011"
182	help
183	  Select this to enable a debug UART using the pl01x driver with the
184	  PL011 UART type. You will need to provide parameters to make this
185	  work. The driver will be available until the real driver model
186	  serial is running.
187
188config DEBUG_UART_PIC32
189	bool "Microchip PIC32"
190	depends on PIC32_SERIAL
191	help
192	  Select this to enable a debug UART using the serial_pic32 driver. You
193	  will need to provide parameters to make this work. The driver will
194	  be available until the real driver model serial is running.
195
196config DEBUG_UART_UNIPHIER
197	bool "UniPhier on-chip UART"
198	depends on ARCH_UNIPHIER
199	help
200	  Select this to enable a debug UART using the UniPhier on-chip UART.
201	  You will need to provide DEBUG_UART_BASE to make this work.  The
202	  driver will be available until the real driver-model serial is
203	  running.
204
205endchoice
206
207config DEBUG_UART_BASE
208	hex "Base address of UART"
209	depends on DEBUG_UART
210	help
211	  This is the base address of your UART for memory-mapped UARTs.
212
213	  A default should be provided by your board, but if not you will need
214	  to use the correct value here.
215
216config DEBUG_UART_CLOCK
217	int "UART input clock"
218	depends on DEBUG_UART
219	help
220	  The UART input clock determines the speed of the internal UART
221	  circuitry. The baud rate is derived from this by dividing the input
222	  clock down.
223
224	  A default should be provided by your board, but if not you will need
225	  to use the correct value here.
226
227config DEBUG_UART_SHIFT
228	int "UART register shift"
229	depends on DEBUG_UART
230	default 0 if DEBUG_UART
231	help
232	  Some UARTs (notably ns16550) support different register layouts
233	  where the registers are spaced either as bytes, words or some other
234	  value. Use this value to specify the shift to use, where 0=byte
235	  registers, 2=32-bit word registers, etc.
236
237config DEBUG_UART_BOARD_INIT
238	bool "Enable board-specific debug UART init"
239	depends on DEBUG_UART
240	help
241	  Some boards need to set things up before the debug UART can be used.
242	  On these boards a call to debug_uart_init() is insufficient. When
243	  this option is enabled, the function board_debug_uart_init() will
244	  be called when debug_uart_init() is called. You can put any code
245	  here that is needed to set up the UART ready for use, such as set
246	  pin multiplexing or enable clocks.
247
248config DEBUG_UART_ANNOUNCE
249	bool "Show a message when the debug UART starts up"
250	depends on DEBUG_UART
251	help
252	  Enable this option to show a message when the debug UART is ready
253	  for use. You will see a message like "<debug_uart> " as soon as
254	  U-Boot has the UART ready for use (i.e. your code calls
255	  debug_uart_init()). This can be useful just as a check that
256	  everything is working.
257
258config DEBUG_UART_SKIP_INIT
259	bool "Skip UART initialization"
260	help
261	  Select this if the UART you want to use for debug output is already
262	  initialized by the time U-Boot starts its execution.
263
264config ALTERA_JTAG_UART
265	bool "Altera JTAG UART support"
266	depends on DM_SERIAL
267	help
268	  Select this to enable an JTAG UART for Altera devices.The JTAG UART
269	  core implements a method to communicate serial character streams
270	  between a host PC and a Qsys system on an Altera FPGA. Please find
271	  details on the "Embedded Peripherals IP User Guide" of Altera.
272
273config ALTERA_JTAG_UART_BYPASS
274	bool "Bypass output when no connection"
275	depends on ALTERA_JTAG_UART
276	help
277	  Bypass console output and keep going even if there is no JTAG
278	  terminal connection with the host. The console output will resume
279	  once the JTAG terminal is connected. Without the bypass, the console
280	  output will wait forever until a JTAG terminal is connected. If you
281	  not are sure, say Y.
282
283config ALTERA_UART
284	bool "Altera UART support"
285	depends on DM_SERIAL
286	help
287	  Select this to enable an UART for Altera devices. Please find
288	  details on the "Embedded Peripherals IP User Guide" of Altera.
289
290config AR933X_UART
291	bool "QCA/Atheros ar933x UART support"
292	depends on DM_SERIAL && SOC_AR933X
293	help
294	  Select this to enable UART support for QCA/Atheros ar933x
295	  devices. This driver uses driver model and requires a device
296	  tree binding to operate, please refer to the document at
297	  doc/device-tree-bindings/serial/qca,ar9330-uart.txt.
298
299config FSL_LPUART
300	bool "Freescale LPUART support"
301	help
302	  Select this to enable a Low Power UART for Freescale VF610 and
303	  QorIQ Layerscape devices.
304
305config MVEBU_A3700_UART
306	bool "UART support for Armada 3700"
307	default n
308	help
309	  Choose this option to add support for UART driver on the Marvell
310	  Armada 3700 SoC. The base address is configured via DT.
311
312config PIC32_SERIAL
313	bool "Support for Microchip PIC32 on-chip UART"
314	depends on DM_SERIAL && MACH_PIC32
315	default y
316	help
317	  Support for the UART found on Microchip PIC32 SoC's.
318
319config SYS_NS16550
320	bool "NS16550 UART or compatible"
321	help
322	  Support NS16550 UART or compatible. This can be enabled in the
323	  device tree with the correct input clock frequency. If the input
324	  clock frequency is not defined in the device tree, the macro
325	  CONFIG_SYS_NS16550_CLK defined in a legacy board header file will
326	  be used. It can be a constant or a function to get clock, eg,
327	  get_serial_clock().
328
329config ROCKCHIP_SERIAL
330	bool "Rockchip on-chip UART support"
331	depends on DM_SERIAL && SPL_OF_PLATDATA
332	help
333	  Select this to enable a debug UART for Rockchip devices when using
334	  CONFIG_OF_PLATDATA (i.e. a compiled-in device tree replacemenmt).
335	  This uses the ns16550 driver, converting the platdata from of-platdata
336	  to the ns16550 format.
337
338config SANDBOX_SERIAL
339	bool "Sandbox UART support"
340	depends on SANDBOX
341	help
342	  Select this to enable a seral UART for sandbox. This is required to
343	  operate correctly, otherwise you will see no serial output from
344	  sandbox. The emulated UART will display to the console and console
345	  input will be fed into the UART. This allows you to interact with
346	  U-Boot.
347
348	  The operation of the console is controlled by the -t command-line
349	  flag. In raw mode, U-Boot sees all characters from the terminal
350	  before they are processed, including Ctrl-C. In cooked mode, Ctrl-C
351	  is processed by the terminal, and terminates U-Boot. Valid options
352	  are:
353
354	     -t raw-with-sigs	Raw mode, Ctrl-C will terminate U-Boot
355	     -t raw		Raw mode, Ctrl-C is processed by U-Boot
356	     -t cooked		Cooked mode, Ctrl-C terminates
357
358config UNIPHIER_SERIAL
359	bool "Support for UniPhier on-chip UART"
360	depends on ARCH_UNIPHIER
361	default y
362	help
363	  If you have a UniPhier based board and want to use the on-chip
364	  serial ports, say Y to this option. If unsure, say N.
365
366config XILINX_UARTLITE
367	bool "Xilinx Uarlite support"
368	depends on DM_SERIAL && (MICROBLAZE || ARCH_ZYNQ || ARCH_ZYNQMP || 4xx)
369	help
370	  If you have a Xilinx based board and want to use the uartlite
371	  serial ports, say Y to this option. If unsure, say N.
372
373config MESON_SERIAL
374	bool "Support for Amlogic Meson UART"
375	depends on DM_SERIAL && ARCH_MESON
376	help
377	  If you have an Amlogic Meson based board and want to use the on-chip
378	  serial ports, say Y to this option. If unsure, say N.
379
380config MSM_SERIAL
381	bool "Qualcomm on-chip UART"
382	depends on DM_SERIAL
383	help
384	  Support Data Mover UART used on Qualcomm Snapdragon SoCs.
385	  It should support all Qualcomm devices with UARTDM version 1.4,
386	  for example APQ8016 and MSM8916.
387	  Single baudrate is supported in current implementation (115200).
388
389endmenu
390