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