xref: /openbmc/u-boot/drivers/serial/Kconfig (revision 21ff7344)
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
94endchoice
95
96config DEBUG_UART_BASE
97	hex "Base address of UART"
98	depends on DEBUG_UART
99	help
100	  This is the base address of your UART for memory-mapped UARTs.
101
102	  A default should be provided by your board, but if not you will need
103	  to use the correct value here.
104
105config DEBUG_UART_CLOCK
106	int "UART input clock"
107	depends on DEBUG_UART
108	help
109	  The UART input clock determines the speed of the internal UART
110	  circuitry. The baud rate is derived from this by dividing the input
111	  clock down.
112
113	  A default should be provided by your board, but if not you will need
114	  to use the correct value here.
115
116config DEBUG_UART_SHIFT
117	int "UART register shift"
118	depends on DEBUG_UART
119	default 0 if DEBUG_UART
120	help
121	  Some UARTs (notably ns16550) support different register layouts
122	  where the registers are spaced either as bytes, words or some other
123	  value. Use this value to specify the shift to use, where 0=byte
124	  registers, 2=32-bit word registers, etc.
125
126config DEBUG_UART_BOARD_INIT
127	bool "Enable board-specific debug UART init"
128	depends on DEBUG_UART
129	help
130	  Some boards need to set things up before the debug UART can be used.
131	  On these boards a call to debug_uart_init() is insufficient. When
132	  this option is enabled, the function board_debug_uart_init() will
133	  be called when debug_uart_init() is called. You can put any code
134	  here that is needed to set up the UART ready for use, such as set
135	  pin multiplexing or enable clocks.
136
137config DEBUG_UART_ANNOUNCE
138	bool "Show a message when the debug UART starts up"
139	depends on DEBUG_UART
140	help
141	  Enable this option to show a message when the debug UART is ready
142	  for use. You will see a message like "<debug_uart> " as soon as
143	  U-Boot has the UART ready for use (i.e. your code calls
144	  debug_uart_init()). This can be useful just as a check that
145	  everything is working.
146
147config ALTERA_JTAG_UART
148	bool "Altera JTAG UART support"
149	depends on DM_SERIAL
150	help
151	  Select this to enable an JTAG UART for Altera devices.The JTAG UART
152	  core implements a method to communicate serial character streams
153	  between a host PC and a Qsys system on an Altera FPGA. Please find
154	  details on the "Embedded Peripherals IP User Guide" of Altera.
155
156config ALTERA_JTAG_UART_BYPASS
157	bool "Bypass output when no connection"
158	depends on ALTERA_JTAG_UART
159	help
160	  Bypass console output and keep going even if there is no JTAG
161	  terminal connection with the host. The console output will resume
162	  once the JTAG terminal is connected. Without the bypass, the console
163	  output will wait forever until a JTAG terminal is connected. If you
164	  not are sure, say Y.
165
166config ALTERA_UART
167	bool "Altera UART support"
168	depends on DM_SERIAL
169	help
170	  Select this to enable an UART for Altera devices. Please find
171	  details on the "Embedded Peripherals IP User Guide" of Altera.
172
173config ROCKCHIP_SERIAL
174	bool "Rockchip on-chip UART support"
175	depends on ARCH_ROCKCHIP && DM_SERIAL
176	help
177	  Select this to enable a debug UART for Rockchip devices. This uses
178	  the ns16550 driver. You will need to #define CONFIG_SYS_NS16550 in
179	  your board config header. The clock input is automatically set to
180	  use the oscillator (24MHz).
181
182config SANDBOX_SERIAL
183	bool "Sandbox UART support"
184	depends on SANDBOX
185	help
186	  Select this to enable a seral UART for sandbox. This is required to
187	  operate correctly, otherwise you will see no serial output from
188	  sandbox. The emulated UART will display to the console and console
189	  input will be fed into the UART. This allows you to interact with
190	  U-Boot.
191
192	  The operation of the console is controlled by the -t command-line
193	  flag. In raw mode, U-Boot sees all characters from the terminal
194	  before they are processed, including Ctrl-C. In cooked mode, Ctrl-C
195	  is processed by the terminal, and terminates U-Boot. Valid options
196	  are:
197
198	     -t raw-with-sigs	Raw mode, Ctrl-C will terminate U-Boot
199	     -t raw		Raw mode, Ctrl-C is processed by U-Boot
200	     -t cooked		Cooked mode, Ctrl-C terminates
201
202config UNIPHIER_SERIAL
203	bool "Support for UniPhier on-chip UART"
204	depends on ARCH_UNIPHIER
205	help
206	  If you have a UniPhier based board and want to use the on-chip
207	  serial ports, say Y to this option. If unsure, say N.
208
209config X86_SERIAL
210	bool "Support for 16550 serial port on x86 machines"
211	depends on X86
212	default y
213	help
214	  Most x86 machines have a ns16550 UART or compatible. This can be
215	  enabled in the device tree with the correct input clock frequency
216	  provided (default 1843200). Enable this to obtain serial console
217	  output.
218
219endmenu
220