xref: /openbmc/u-boot/drivers/serial/Kconfig (revision ade766ac)
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 DM_SERIAL
19	bool "Enable Driver Model for serial drivers"
20	depends on DM
21	help
22	  Enable driver model for serial. This replaces
23	  drivers/serial/serial.c with the serial uclass, which
24	  implements serial_putc() etc. The uclass interface is
25	  defined in include/serial.h.
26
27config DEBUG_UART
28	bool "Enable an early debug UART for debugging"
29	help
30	  The debug UART is intended for use very early in U-Boot to debug
31	  problems when an ICE or other debug mechanism is not available.
32
33	  To use it you should:
34	  - Make sure your UART supports this interface
35	  - Enable CONFIG_DEBUG_UART
36	  - Enable the CONFIG for your UART to tell it to provide this interface
37	        (e.g. CONFIG_DEBUG_UART_NS16550)
38	  - Define the required settings as needed (see below)
39	  - Call debug_uart_init() before use
40	  - Call debug_uart_putc() to output a character
41
42	  Depending on your platform it may be possible to use this UART before
43	  a stack is available.
44
45	  If your UART does not support this interface you can probably add
46	  support quite easily. Remember that you cannot use driver model and
47	  it is preferred to use no stack.
48
49	  You must not use this UART once driver model is working and the
50	  serial drivers are up and running (done in serial_init()). Otherwise
51	  the drivers may conflict and you will get strange output.
52
53choice
54	prompt "Select which UART will provide the debug UART"
55	depends on DEBUG_UART
56
57config DEBUG_UART_ALTERA_JTAGUART
58	bool "Altera JTAG UART"
59	help
60	  Select this to enable a debug UART using the altera_jtag_uart driver.
61	  You will need to provide parameters to make this work. The driver will
62	  be available until the real driver model serial is running.
63
64config DEBUG_UART_ALTERA_UART
65	bool "Altera UART"
66	help
67	  Select this to enable a debug UART using the altera_uart driver.
68	  You will need to provide parameters to make this work. The driver will
69	  be available until the real driver model serial is running.
70
71config DEBUG_UART_NS16550
72	bool "ns16550"
73	help
74	  Select this to enable a debug UART using the ns16550 driver. You
75	  will need to provide parameters to make this work. The driver will
76	  be available until the real driver model serial is running.
77
78config DEBUG_EFI_CONSOLE
79	bool "EFI"
80	depends on EFI_APP
81	help
82	  Select this to enable a debug console which calls back to EFI to
83	  output to the console. This can be useful for early debugging of
84	  U-Boot when running on top of EFI (Extensive Firmware Interface).
85	  This is a type of BIOS used by PCs.
86
87config DEBUG_UART_S5P
88	bool "Samsung S5P"
89	help
90	  Select this to enable a debug UART using the serial_s5p driver. You
91	  will need to provide parameters to make this work. The driver will
92	  be available until the real driver-model serial is running.
93
94config DEBUG_UART_ZYNQ
95	bool "Xilinx Zynq"
96	help
97	  Select this to enable a debug UART using the serial_s5p driver. You
98	  will need to provide parameters to make this work. The driver will
99	  be available until the real driver-model serial is running.
100
101endchoice
102
103config DEBUG_UART_BASE
104	hex "Base address of UART"
105	depends on DEBUG_UART
106	help
107	  This is the base address of your UART for memory-mapped UARTs.
108
109	  A default should be provided by your board, but if not you will need
110	  to use the correct value here.
111
112config DEBUG_UART_CLOCK
113	int "UART input clock"
114	depends on DEBUG_UART
115	help
116	  The UART input clock determines the speed of the internal UART
117	  circuitry. The baud rate is derived from this by dividing the input
118	  clock down.
119
120	  A default should be provided by your board, but if not you will need
121	  to use the correct value here.
122
123config DEBUG_UART_SHIFT
124	int "UART register shift"
125	depends on DEBUG_UART
126	default 0 if DEBUG_UART
127	help
128	  Some UARTs (notably ns16550) support different register layouts
129	  where the registers are spaced either as bytes, words or some other
130	  value. Use this value to specify the shift to use, where 0=byte
131	  registers, 2=32-bit word registers, etc.
132
133config DEBUG_UART_BOARD_INIT
134	bool "Enable board-specific debug UART init"
135	depends on DEBUG_UART
136	help
137	  Some boards need to set things up before the debug UART can be used.
138	  On these boards a call to debug_uart_init() is insufficient. When
139	  this option is enabled, the function board_debug_uart_init() will
140	  be called when debug_uart_init() is called. You can put any code
141	  here that is needed to set up the UART ready for use, such as set
142	  pin multiplexing or enable clocks.
143
144config DEBUG_UART_ANNOUNCE
145	bool "Show a message when the debug UART starts up"
146	depends on DEBUG_UART
147	help
148	  Enable this option to show a message when the debug UART is ready
149	  for use. You will see a message like "<debug_uart> " as soon as
150	  U-Boot has the UART ready for use (i.e. your code calls
151	  debug_uart_init()). This can be useful just as a check that
152	  everything is working.
153
154config ALTERA_JTAG_UART
155	bool "Altera JTAG UART support"
156	depends on DM_SERIAL
157	help
158	  Select this to enable an JTAG UART for Altera devices.The JTAG UART
159	  core implements a method to communicate serial character streams
160	  between a host PC and a Qsys system on an Altera FPGA. Please find
161	  details on the "Embedded Peripherals IP User Guide" of Altera.
162
163config ALTERA_JTAG_UART_BYPASS
164	bool "Bypass output when no connection"
165	depends on ALTERA_JTAG_UART
166	help
167	  Bypass console output and keep going even if there is no JTAG
168	  terminal connection with the host. The console output will resume
169	  once the JTAG terminal is connected. Without the bypass, the console
170	  output will wait forever until a JTAG terminal is connected. If you
171	  not are sure, say Y.
172
173config ALTERA_UART
174	bool "Altera UART support"
175	depends on DM_SERIAL
176	help
177	  Select this to enable an UART for Altera devices. Please find
178	  details on the "Embedded Peripherals IP User Guide" of Altera.
179
180config ROCKCHIP_SERIAL
181	bool "Rockchip on-chip UART support"
182	depends on ARCH_ROCKCHIP && DM_SERIAL
183	help
184	  Select this to enable a debug UART for Rockchip devices. This uses
185	  the ns16550 driver. You will need to #define CONFIG_SYS_NS16550 in
186	  your board config header. The clock input is automatically set to
187	  use the oscillator (24MHz).
188
189config SANDBOX_SERIAL
190	bool "Sandbox UART support"
191	depends on SANDBOX
192	help
193	  Select this to enable a seral UART for sandbox. This is required to
194	  operate correctly, otherwise you will see no serial output from
195	  sandbox. The emulated UART will display to the console and console
196	  input will be fed into the UART. This allows you to interact with
197	  U-Boot.
198
199	  The operation of the console is controlled by the -t command-line
200	  flag. In raw mode, U-Boot sees all characters from the terminal
201	  before they are processed, including Ctrl-C. In cooked mode, Ctrl-C
202	  is processed by the terminal, and terminates U-Boot. Valid options
203	  are:
204
205	     -t raw-with-sigs	Raw mode, Ctrl-C will terminate U-Boot
206	     -t raw		Raw mode, Ctrl-C is processed by U-Boot
207	     -t cooked		Cooked mode, Ctrl-C terminates
208
209config UNIPHIER_SERIAL
210	bool "Support for UniPhier on-chip UART"
211	depends on ARCH_UNIPHIER
212	help
213	  If you have a UniPhier based board and want to use the on-chip
214	  serial ports, say Y to this option. If unsure, say N.
215
216config X86_SERIAL
217	bool "Support for 16550 serial port on x86 machines"
218	depends on X86
219	default y
220	help
221	  Most x86 machines have a ns16550 UART or compatible. This can be
222	  enabled in the device tree with the correct input clock frequency
223	  provided (default 1843200). Enable this to obtain serial console
224	  output.
225
226endmenu
227