]> git.sur5r.net Git - u-boot/blob - drivers/serial/Kconfig
pl01x: Convert to dev_read
[u-boot] / drivers / serial / Kconfig
1 #
2 # Serial device configuration
3 #
4
5 menu "Serial drivers"
6
7 config 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
16 config 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
27 config 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
37 config 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
47 config CONS_INDEX
48         int "UART used for console"
49         depends on ARCH_SUNXI
50         default 2 if MACH_SUN5I
51         default 5 if MACH_SUN8I_A23 || MACH_SUN8I_A33
52         default 1
53         help
54           Configures the console index.
55           For Allwinner SoC., default values are 2 for SUN5I and 5 for A23/A33.
56           Otherwise, the index equals 1.
57
58 config DM_SERIAL
59         bool "Enable Driver Model for serial drivers"
60         depends on DM
61         help
62           Enable driver model for serial. This replaces
63           drivers/serial/serial.c with the serial uclass, which
64           implements serial_putc() etc. The uclass interface is
65           defined in include/serial.h.
66
67 config SERIAL_RX_BUFFER
68         bool "Enable RX buffer for serial input"
69         depends on DM_SERIAL
70         help
71           Enable RX buffer support for the serial driver. This enables
72           pasting longer strings, even when the RX FIFO of the UART is
73           not big enough (e.g. 16 bytes on the normal NS16550).
74
75 config SERIAL_RX_BUFFER_SIZE
76         int "RX buffer size"
77         depends on SERIAL_RX_BUFFER
78         default 256
79         help
80           The size of the RX buffer (needs to be power of 2)
81
82 config SPL_DM_SERIAL
83         bool "Enable Driver Model for serial drivers in SPL"
84         depends on DM_SERIAL
85         default y if SPL && DM_SERIAL
86         help
87           Enable driver model for serial in SPL. This replaces
88           drivers/serial/serial.c with the serial uclass, which
89           implements serial_putc() etc. The uclass interface is
90           defined in include/serial.h.
91
92 config TPL_DM_SERIAL
93         bool "Enable Driver Model for serial drivers in TPL"
94         depends on DM_SERIAL
95         default y if TPL && DM_SERIAL
96         help
97           Enable driver model for serial in TPL. This replaces
98           drivers/serial/serial.c with the serial uclass, which
99           implements serial_putc() etc. The uclass interface is
100           defined in include/serial.h.
101
102 config DEBUG_UART
103         bool "Enable an early debug UART for debugging"
104         help
105           The debug UART is intended for use very early in U-Boot to debug
106           problems when an ICE or other debug mechanism is not available.
107
108           To use it you should:
109           - Make sure your UART supports this interface
110           - Enable CONFIG_DEBUG_UART
111           - Enable the CONFIG for your UART to tell it to provide this interface
112                 (e.g. CONFIG_DEBUG_UART_NS16550)
113           - Define the required settings as needed (see below)
114           - Call debug_uart_init() before use
115           - Call debug_uart_putc() to output a character
116
117           Depending on your platform it may be possible to use this UART before
118           a stack is available.
119
120           If your UART does not support this interface you can probably add
121           support quite easily. Remember that you cannot use driver model and
122           it is preferred to use no stack.
123
124           You must not use this UART once driver model is working and the
125           serial drivers are up and running (done in serial_init()). Otherwise
126           the drivers may conflict and you will get strange output.
127
128 choice
129         prompt "Select which UART will provide the debug UART"
130         depends on DEBUG_UART
131         default DEBUG_UART_NS16550
132
133 config DEBUG_UART_ALTERA_JTAGUART
134         bool "Altera JTAG UART"
135         help
136           Select this to enable a debug UART using the altera_jtag_uart driver.
137           You will need to provide parameters to make this work. The driver will
138           be available until the real driver model serial is running.
139
140 config DEBUG_UART_ALTERA_UART
141         bool "Altera UART"
142         help
143           Select this to enable a debug UART using the altera_uart driver.
144           You will need to provide parameters to make this work. The driver will
145           be available until the real driver model serial is running.
146
147 config DEBUG_UART_AR933X
148         bool "QCA/Atheros ar933x"
149         depends on AR933X_UART
150         help
151           Select this to enable a debug UART using the ar933x uart driver.
152           You will need to provide parameters to make this work. The
153           driver will be available until the real driver model serial is
154           running.
155
156 config DEBUG_UART_ATMEL
157         bool "Atmel USART"
158         help
159           Select this to enable a debug UART using the atmel usart driver. You
160           will need to provide parameters to make this work. The driver will
161           be available until the real driver-model serial is running.
162
163 config DEBUG_UART_BCM6345
164         bool "BCM6345 UART"
165         depends on BCM6345_SERIAL
166         help
167           Select this to enable a debug UART on BCM6345 SoCs. You
168           will need to provide parameters to make this work. The driver will
169           be available until the real driver model serial is running.
170
171 config DEBUG_UART_NS16550
172         bool "ns16550"
173         help
174           Select this to enable a debug UART using the ns16550 driver. You
175           will need to provide parameters to make this work. The driver will
176           be available until the real driver model serial is running.
177
178 config DEBUG_EFI_CONSOLE
179         bool "EFI"
180         depends on EFI_APP
181         help
182           Select this to enable a debug console which calls back to EFI to
183           output to the console. This can be useful for early debugging of
184           U-Boot when running on top of EFI (Extensive Firmware Interface).
185           This is a type of BIOS used by PCs.
186
187 config DEBUG_UART_S5P
188         bool "Samsung S5P"
189         help
190           Select this to enable a debug UART using the serial_s5p driver. You
191           will need to provide parameters to make this work. The driver will
192           be available until the real driver-model serial is running.
193
194 config DEBUG_UART_MESON
195         bool "Amlogic Meson"
196         depends on MESON_SERIAL
197         help
198           Select this to enable a debug UART using the serial_meson driver. You
199           will need to provide parameters to make this work. The driver will
200           be available until the real driver-model serial is running.
201
202 config DEBUG_UART_UARTLITE
203         bool "Xilinx Uartlite"
204         help
205           Select this to enable a debug UART using the serial_uartlite driver.
206           You will need to provide parameters to make this work. The driver will
207           be available until the real driver-model serial is running.
208
209 config DEBUG_UART_ARM_DCC
210         bool "ARM DCC"
211         help
212           Select this to enable a debug UART using the ARM JTAG DCC port.
213           The DCC port can be used for very early debugging and doesn't require
214           any additional setting like address/baudrate/clock. On systems without
215           any serial interface this is the easiest way how to get console.
216           Every ARM core has own DCC port which is the part of debug interface.
217           This port is available at least on ARMv6, ARMv7, ARMv8 and XScale
218           architectures.
219
220 config DEBUG_MVEBU_A3700_UART
221         bool "Marvell Armada 3700"
222         help
223           Select this to enable a debug UART using the serial_mvebu driver. You
224           will need to provide parameters to make this work. The driver will
225           be available until the real driver-model serial is running.
226
227 config DEBUG_UART_ZYNQ
228         bool "Xilinx Zynq"
229         help
230           Select this to enable a debug UART using the serial_zynq driver. You
231           will need to provide parameters to make this work. The driver will
232           be available until the real driver-model serial is running.
233
234 config DEBUG_UART_APBUART
235         depends on LEON3
236         bool "Gaisler APBUART"
237         help
238           Select this to enable a debug UART using the serial_leon3 driver. You
239           will need to provide parameters to make this work. The driver will
240           be available until the real driver model serial is running.
241
242 config DEBUG_UART_PL010
243         bool "pl010"
244         help
245           Select this to enable a debug UART using the pl01x driver with the
246           PL010 UART type. You will need to provide parameters to make this
247           work. The driver will be available until the real driver model
248           serial is running.
249
250 config DEBUG_UART_PL011
251         bool "pl011"
252         help
253           Select this to enable a debug UART using the pl01x driver with the
254           PL011 UART type. You will need to provide parameters to make this
255           work. The driver will be available until the real driver model
256           serial is running.
257
258 config DEBUG_UART_PIC32
259         bool "Microchip PIC32"
260         depends on PIC32_SERIAL
261         help
262           Select this to enable a debug UART using the serial_pic32 driver. You
263           will need to provide parameters to make this work. The driver will
264           be available until the real driver model serial is running.
265
266 config DEBUG_UART_MXC
267         bool "IMX Serial port"
268         depends on MXC_UART
269         help
270           Select this to enable a debug UART using the serial_mxc driver. You
271           will need to provide parameters to make this work. The driver will
272           be available until the real driver model serial is running.
273
274 config DEBUG_UART_UNIPHIER
275         bool "UniPhier on-chip UART"
276         depends on ARCH_UNIPHIER
277         help
278           Select this to enable a debug UART using the UniPhier on-chip UART.
279           You will need to provide DEBUG_UART_BASE to make this work.  The
280           driver will be available until the real driver-model serial is
281           running.
282
283 config DEBUG_UART_OMAP
284         bool "OMAP uart"
285         help
286           Select this to enable a debug UART using the omap ns16550 driver.
287           You will need to provide parameters to make this work. The driver
288           will be available until the real driver model serial is running.
289
290 endchoice
291
292 config DEBUG_UART_BASE
293         hex "Base address of UART"
294         depends on DEBUG_UART
295         help
296           This is the base address of your UART for memory-mapped UARTs.
297
298           A default should be provided by your board, but if not you will need
299           to use the correct value here.
300
301 config DEBUG_UART_CLOCK
302         int "UART input clock"
303         depends on DEBUG_UART
304         help
305           The UART input clock determines the speed of the internal UART
306           circuitry. The baud rate is derived from this by dividing the input
307           clock down.
308
309           A default should be provided by your board, but if not you will need
310           to use the correct value here.
311
312 config DEBUG_UART_SHIFT
313         int "UART register shift"
314         depends on DEBUG_UART
315         default 0 if DEBUG_UART
316         help
317           Some UARTs (notably ns16550) support different register layouts
318           where the registers are spaced either as bytes, words or some other
319           value. Use this value to specify the shift to use, where 0=byte
320           registers, 2=32-bit word registers, etc.
321
322 config DEBUG_UART_BOARD_INIT
323         bool "Enable board-specific debug UART init"
324         depends on DEBUG_UART
325         help
326           Some boards need to set things up before the debug UART can be used.
327           On these boards a call to debug_uart_init() is insufficient. When
328           this option is enabled, the function board_debug_uart_init() will
329           be called when debug_uart_init() is called. You can put any code
330           here that is needed to set up the UART ready for use, such as set
331           pin multiplexing or enable clocks.
332
333 config DEBUG_UART_ANNOUNCE
334         bool "Show a message when the debug UART starts up"
335         depends on DEBUG_UART
336         help
337           Enable this option to show a message when the debug UART is ready
338           for use. You will see a message like "<debug_uart> " as soon as
339           U-Boot has the UART ready for use (i.e. your code calls
340           debug_uart_init()). This can be useful just as a check that
341           everything is working.
342
343 config DEBUG_UART_SKIP_INIT
344         bool "Skip UART initialization"
345         help
346           Select this if the UART you want to use for debug output is already
347           initialized by the time U-Boot starts its execution.
348
349 config ALTERA_JTAG_UART
350         bool "Altera JTAG UART support"
351         depends on DM_SERIAL
352         help
353           Select this to enable an JTAG UART for Altera devices.The JTAG UART
354           core implements a method to communicate serial character streams
355           between a host PC and a Qsys system on an Altera FPGA. Please find
356           details on the "Embedded Peripherals IP User Guide" of Altera.
357
358 config ALTERA_JTAG_UART_BYPASS
359         bool "Bypass output when no connection"
360         depends on ALTERA_JTAG_UART
361         help
362           Bypass console output and keep going even if there is no JTAG
363           terminal connection with the host. The console output will resume
364           once the JTAG terminal is connected. Without the bypass, the console
365           output will wait forever until a JTAG terminal is connected. If you
366           not are sure, say Y.
367
368 config ALTERA_UART
369         bool "Altera UART support"
370         depends on DM_SERIAL
371         help
372           Select this to enable an UART for Altera devices. Please find
373           details on the "Embedded Peripherals IP User Guide" of Altera.
374
375 config AR933X_UART
376         bool "QCA/Atheros ar933x UART support"
377         depends on DM_SERIAL && SOC_AR933X
378         help
379           Select this to enable UART support for QCA/Atheros ar933x
380           devices. This driver uses driver model and requires a device
381           tree binding to operate, please refer to the document at
382           doc/device-tree-bindings/serial/qca,ar9330-uart.txt.
383
384 config ATMEL_USART
385         bool "Atmel USART support"
386         help
387           Select this to enable USART support for Atmel SoCs. It can be
388           configured in the device tree, and input clock frequency can
389           be got from the clk node.
390
391 config BCM6345_SERIAL
392         bool "Support for BCM6345 UART"
393         depends on DM_SERIAL && ARCH_BMIPS
394         help
395           Select this to enable UART on BCM6345 SoCs.
396
397 config FSL_LPUART
398         bool "Freescale LPUART support"
399         help
400           Select this to enable a Low Power UART for Freescale VF610 and
401           QorIQ Layerscape devices.
402
403 config MVEBU_A3700_UART
404         bool "UART support for Armada 3700"
405         default n
406         help
407           Choose this option to add support for UART driver on the Marvell
408           Armada 3700 SoC. The base address is configured via DT.
409
410 config MXC_UART
411         bool "IMX serial port support"
412         depends on MX5 || MX6
413         help
414           If you have a machine based on a Motorola IMX CPU you
415           can enable its onboard serial port by enabling this option.
416
417 config NULLDEV_SERIAL
418         bool "Null serial device"
419         help
420           Select this to enable null serial device support. A null serial
421           device merely acts as a placeholder for a serial device and does
422           nothing for all it's operation.
423
424 config PIC32_SERIAL
425         bool "Support for Microchip PIC32 on-chip UART"
426         depends on DM_SERIAL && MACH_PIC32
427         default y
428         help
429           Support for the UART found on Microchip PIC32 SoC's.
430
431 config SYS_NS16550
432         bool "NS16550 UART or compatible"
433         help
434           Support NS16550 UART or compatible. This can be enabled in the
435           device tree with the correct input clock frequency. If the input
436           clock frequency is not defined in the device tree, the macro
437           CONFIG_SYS_NS16550_CLK defined in a legacy board header file will
438           be used. It can be a constant or a function to get clock, eg,
439           get_serial_clock().
440
441 config INTEL_MID_SERIAL
442         bool "Intel MID platform UART support"
443         depends on DM_SERIAL && OF_CONTROL
444         depends on INTEL_MID
445         select SYS_NS16550
446         help
447           Select this to enable a UART for Intel MID platforms.
448           This uses the ns16550 driver as a library.
449
450 config ROCKCHIP_SERIAL
451         bool "Rockchip on-chip UART support"
452         depends on DM_SERIAL && SPL_OF_PLATDATA
453         help
454           Select this to enable a debug UART for Rockchip devices when using
455           CONFIG_SPL_OF_PLATDATA (i.e. a compiled-in device tree replacemenmt).
456           This uses the ns16550 driver, converting the platdata from of-platdata
457           to the ns16550 format.
458
459 config SANDBOX_SERIAL
460         bool "Sandbox UART support"
461         depends on SANDBOX
462         help
463           Select this to enable a seral UART for sandbox. This is required to
464           operate correctly, otherwise you will see no serial output from
465           sandbox. The emulated UART will display to the console and console
466           input will be fed into the UART. This allows you to interact with
467           U-Boot.
468
469           The operation of the console is controlled by the -t command-line
470           flag. In raw mode, U-Boot sees all characters from the terminal
471           before they are processed, including Ctrl-C. In cooked mode, Ctrl-C
472           is processed by the terminal, and terminates U-Boot. Valid options
473           are:
474
475              -t raw-with-sigs   Raw mode, Ctrl-C will terminate U-Boot
476              -t raw             Raw mode, Ctrl-C is processed by U-Boot
477              -t cooked          Cooked mode, Ctrl-C terminates
478
479 config SCIF_CONSOLE
480         bool "Renesas SCIF UART support"
481         depends on SH || ARCH_RMOBILE
482         help
483           Select this to enable Renesas SCIF UART. To operate serial ports
484           on systems with RCar or SH SoCs, say Y to this option. If unsure,
485           say N.
486
487 config UNIPHIER_SERIAL
488         bool "Support for UniPhier on-chip UART"
489         depends on ARCH_UNIPHIER
490         default y
491         help
492           If you have a UniPhier based board and want to use the on-chip
493           serial ports, say Y to this option. If unsure, say N.
494
495 config XILINX_UARTLITE
496         bool "Xilinx Uarlite support"
497         depends on DM_SERIAL && (MICROBLAZE || ARCH_ZYNQ || ARCH_ZYNQMP || 4xx)
498         help
499           If you have a Xilinx based board and want to use the uartlite
500           serial ports, say Y to this option. If unsure, say N.
501
502 config MESON_SERIAL
503         bool "Support for Amlogic Meson UART"
504         depends on DM_SERIAL && ARCH_MESON
505         help
506           If you have an Amlogic Meson based board and want to use the on-chip
507           serial ports, say Y to this option. If unsure, say N.
508
509 config MSM_SERIAL
510         bool "Qualcomm on-chip UART"
511         depends on DM_SERIAL
512         help
513           Support Data Mover UART used on Qualcomm Snapdragon SoCs.
514           It should support all Qualcomm devices with UARTDM version 1.4,
515           for example APQ8016 and MSM8916.
516           Single baudrate is supported in current implementation (115200).
517
518 config PXA_SERIAL
519         bool "PXA serial port support"
520         help
521           If you have a machine based on a Marvell XScale PXA2xx CPU you
522           can enable its onboard serial ports by enabling this option.
523
524 config STI_ASC_SERIAL
525         bool "STMicroelectronics on-chip UART"
526         depends on DM_SERIAL && ARCH_STI
527         help
528           Select this to enable Asynchronous Serial Controller available
529           on STiH410 SoC. This is a basic implementation,  it supports
530           following baudrate 9600, 19200, 38400, 57600 and 115200.
531
532 config STM32_SERIAL
533         bool "STMicroelectronics STM32 SoCs on-chip UART"
534         depends on DM_SERIAL && (STM32F4 || STM32F7 || STM32H7)
535         help
536           If you have a machine based on a STM32 F4, F7 or H7 SoC you can
537           enable its onboard serial ports, say Y to this option.
538           If unsure, say N.
539
540 config ZYNQ_SERIAL
541         bool "Cadence (Xilinx Zynq) UART support"
542         depends on DM_SERIAL && (MICROBLAZE || ARCH_ZYNQ || ARCH_ZYNQMP)
543         help
544           This driver supports the Cadence UART. It is found e.g. in Xilinx
545           Zynq/ZynqMP.
546
547 config MPC8XX_CONS
548         bool "Console driver for MPC8XX"
549         depends on 8xx
550         default y
551
552 choice
553         prompt "Console port"
554         default 8xx_CONS_SMC1
555         depends on MPC8XX_CONS
556         help
557           Depending on board, select one serial port
558           (CONFIG_8xx_CONS_SMC1 or CONFIG_8xx_CONS_SMC2)
559
560 config 8xx_CONS_SMC1
561         bool "SMC1"
562
563 config 8xx_CONS_SMC2
564         bool "SMC2"
565
566 endchoice
567
568 config SYS_SMC_RXBUFLEN
569         int "Console Rx buffer length"
570         depends on MPC8XX_CONS
571         default 1
572         help
573           With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
574           the maximum receive buffer length for the SMC.
575           This option is actual only for 8xx possible.
576           If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
577           must be defined, to setup the maximum idle timeout for
578           the SMC.
579
580 config SYS_MAXIDLE
581         int "maximum idle timeout"
582         depends on MPC8XX_CONS
583         default 0
584
585 config SYS_BRGCLK_PRESCALE
586         int "BRG Clock Prescale"
587         depends on MPC8XX_CONS
588         default 1
589
590 config SYS_SDSR
591         hex "SDSR Value"
592         depends on MPC8XX_CONS
593         default 0x83
594
595 config SYS_SDMR
596         hex "SDMR Value"
597         depends on MPC8XX_CONS
598         default 0
599
600 endmenu