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