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