drivers/serial/Kconfig

   1 #
   2 # Serial device configuration
   3 #
   4
   5 menu "Serial drivers"
   6
   7 config 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
  18 config 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
  28 config 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
  38 config 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
  47 config 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
  73 choice
  74         prompt "Select which UART will provide the debug UART"
  75         depends on DEBUG_UART
  76         default DEBUG_UART_NS16550
  77
  78 config 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
  85 config 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
  92 config DEBUG_UART_AR933X
  93         bool "QCA/Atheros ar933x"
  94         depends on AR933X_UART
  95         help
  96           Select this to enable a debug UART using the ar933x uart driver.
  97           You will need to provide parameters to make this work. The
  98           driver will be available until the real driver model serial is
  99           running.
 100
 101 config DEBUG_UART_NS16550
 102         bool "ns16550"
 103         help
 104           Select this to enable a debug UART using the ns16550 driver. You
 105           will need to provide parameters to make this work. The driver will
 106           be available until the real driver model serial is running.
 107
 108 config DEBUG_EFI_CONSOLE
 109         bool "EFI"
 110         depends on EFI_APP
 111         help
 112           Select this to enable a debug console which calls back to EFI to
 113           output to the console. This can be useful for early debugging of
 114           U-Boot when running on top of EFI (Extensive Firmware Interface).
 115           This is a type of BIOS used by PCs.
 116
 117 config DEBUG_UART_S5P
 118         bool "Samsung S5P"
 119         help
 120           Select this to enable a debug UART using the serial_s5p driver. You
 121           will need to provide parameters to make this work. The driver will
 122           be available until the real driver-model serial is running.
 123
 124 config DEBUG_UART_MESON
 125         bool "Amlogic Meson"
 126         depends on MESON_SERIAL
 127         help
 128           Select this to enable a debug UART using the serial_meson driver. You
 129           will need to provide parameters to make this work. The driver will
 130           be available until the real driver-model serial is running.
 131
 132 config DEBUG_UART_UARTLITE
 133         bool "Xilinx Uartlite"
 134         help
 135           Select this to enable a debug UART using the serial_uartlite driver.
 136           You will need to provide parameters to make this work. The driver will
 137           be available until the real driver-model serial is running.
 138
 139 config DEBUG_UART_ARM_DCC
 140         bool "ARM DCC"
 141         help
 142           Select this to enable a debug UART using the ARM JTAG DCC port.
 143           The DCC port can be used for very early debugging and doesn't require
 144           any additional setting like address/baudrate/clock. On systems without
 145           any serial interface this is the easiest way how to get console.
 146           Every ARM core has own DCC port which is the part of debug interface.
 147           This port is available at least on ARMv6, ARMv7, ARMv8 and XScale
 148           architectures.
 149
 150 config DEBUG_UART_ZYNQ
 151         bool "Xilinx Zynq"
 152         help
 153           Select this to enable a debug UART using the serial_zynq driver. You
 154           will need to provide parameters to make this work. The driver will
 155           be available until the real driver-model serial is running.
 156
 157 config DEBUG_UART_APBUART
 158         depends on LEON3
 159         bool "Gaisler APBUART"
 160         help
 161           Select this to enable a debug UART using the serial_leon3 driver. You
 162           will need to provide parameters to make this work. The driver will
 163           be available until the real driver model serial is running.
 164
 165 config DEBUG_UART_PL010
 166         bool "pl010"
 167         help
 168           Select this to enable a debug UART using the pl01x driver with the
 169           PL010 UART type. You will need to provide parameters to make this
 170           work. The driver will be available until the real driver model
 171           serial is running.
 172
 173 config DEBUG_UART_PL011
 174         bool "pl011"
 175         help
 176           Select this to enable a debug UART using the pl01x driver with the
 177           PL011 UART type. You will need to provide parameters to make this
 178           work. The driver will be available until the real driver model
 179           serial is running.
 180
 181 config DEBUG_UART_PIC32
 182         bool "Microchip PIC32"
 183         depends on PIC32_SERIAL
 184         help
 185           Select this to enable a debug UART using the serial_pic32 driver. You
 186           will need to provide parameters to make this work. The driver will
 187           be available until the real driver model serial is running.
 188
 189 config DEBUG_UART_UNIPHIER
 190         bool "UniPhier on-chip UART"
 191         depends on ARCH_UNIPHIER
 192         help
 193           Select this to enable a debug UART using the UniPhier on-chip UART.
 194           You will need to provide DEBUG_UART_BASE to make this work.  The
 195           driver will be available until the real driver-model serial is
 196           running.
 197
 198 endchoice
 199
 200 config DEBUG_UART_BASE
 201         hex "Base address of UART"
 202         depends on DEBUG_UART
 203         help
 204           This is the base address of your UART for memory-mapped UARTs.
 205
 206           A default should be provided by your board, but if not you will need
 207           to use the correct value here.
 208
 209 config DEBUG_UART_CLOCK
 210         int "UART input clock"
 211         depends on DEBUG_UART
 212         help
 213           The UART input clock determines the speed of the internal UART
 214           circuitry. The baud rate is derived from this by dividing the input
 215           clock down.
 216
 217           A default should be provided by your board, but if not you will need
 218           to use the correct value here.
 219
 220 config DEBUG_UART_SHIFT
 221         int "UART register shift"
 222         depends on DEBUG_UART
 223         default 0 if DEBUG_UART
 224         help
 225           Some UARTs (notably ns16550) support different register layouts
 226           where the registers are spaced either as bytes, words or some other
 227           value. Use this value to specify the shift to use, where 0=byte
 228           registers, 2=32-bit word registers, etc.
 229
 230 config DEBUG_UART_BOARD_INIT
 231         bool "Enable board-specific debug UART init"
 232         depends on DEBUG_UART
 233         help
 234           Some boards need to set things up before the debug UART can be used.
 235           On these boards a call to debug_uart_init() is insufficient. When
 236           this option is enabled, the function board_debug_uart_init() will
 237           be called when debug_uart_init() is called. You can put any code
 238           here that is needed to set up the UART ready for use, such as set
 239           pin multiplexing or enable clocks.
 240
 241 config DEBUG_UART_ANNOUNCE
 242         bool "Show a message when the debug UART starts up"
 243         depends on DEBUG_UART
 244         help
 245           Enable this option to show a message when the debug UART is ready
 246           for use. You will see a message like "<debug_uart> " as soon as
 247           U-Boot has the UART ready for use (i.e. your code calls
 248           debug_uart_init()). This can be useful just as a check that
 249           everything is working.
 250
 251 config DEBUG_UART_SKIP_INIT
 252         bool "Skip UART initialization"
 253         help
 254           Select this if the UART you want to use for debug output is already
 255           initialized by the time U-Boot starts its execution.
 256
 257 config ALTERA_JTAG_UART
 258         bool "Altera JTAG UART support"
 259         depends on DM_SERIAL
 260         help
 261           Select this to enable an JTAG UART for Altera devices.The JTAG UART
 262           core implements a method to communicate serial character streams
 263           between a host PC and a Qsys system on an Altera FPGA. Please find
 264           details on the "Embedded Peripherals IP User Guide" of Altera.
 265
 266 config ALTERA_JTAG_UART_BYPASS
 267         bool "Bypass output when no connection"
 268         depends on ALTERA_JTAG_UART
 269         help
 270           Bypass console output and keep going even if there is no JTAG
 271           terminal connection with the host. The console output will resume
 272           once the JTAG terminal is connected. Without the bypass, the console
 273           output will wait forever until a JTAG terminal is connected. If you
 274           not are sure, say Y.
 275
 276 config ALTERA_UART
 277         bool "Altera UART support"
 278         depends on DM_SERIAL
 279         help
 280           Select this to enable an UART for Altera devices. Please find
 281           details on the "Embedded Peripherals IP User Guide" of Altera.
 282
 283 config AR933X_UART
 284         bool "QCA/Atheros ar933x UART support"
 285         depends on DM_SERIAL && SOC_AR933X
 286         help
 287           Select this to enable UART support for QCA/Atheros ar933x
 288           devices. This driver uses driver model and requires a device
 289           tree binding to operate, please refer to the document at
 290           doc/device-tree-bindings/serial/qca,ar9330-uart.txt.
 291
 292 config FSL_LPUART
 293         bool "Freescale LPUART support"
 294         help
 295           Select this to enable a Low Power UART for Freescale VF610 and
 296           QorIQ Layerscape devices.
 297
 298 config PIC32_SERIAL
 299         bool "Support for Microchip PIC32 on-chip UART"
 300         depends on DM_SERIAL && MACH_PIC32
 301         default y
 302         help
 303           Support for the UART found on Microchip PIC32 SoC's.
 304
 305 config SYS_NS16550
 306         bool "NS16550 UART or compatible"
 307         help
 308           Support NS16550 UART or compatible. This can be enabled in the
 309           device tree with the correct input clock frequency. If the input
 310           clock frequency is not defined in the device tree, the macro
 311           CONFIG_SYS_NS16550_CLK defined in a legacy board header file will
 312           be used. It can be a constant or a function to get clock, eg,
 313           get_serial_clock().
 314
 315 config ROCKCHIP_SERIAL
 316         bool "Rockchip on-chip UART support"
 317         depends on DM_SERIAL && SPL_OF_PLATDATA
 318         help
 319           Select this to enable a debug UART for Rockchip devices when using
 320           CONFIG_OF_PLATDATA (i.e. a compiled-in device tree replacemenmt).
 321           This uses the ns16550 driver, converting the platdata from of-platdata
 322           to the ns16550 format.
 323
 324 config SANDBOX_SERIAL
 325         bool "Sandbox UART support"
 326         depends on SANDBOX
 327         help
 328           Select this to enable a seral UART for sandbox. This is required to
 329           operate correctly, otherwise you will see no serial output from
 330           sandbox. The emulated UART will display to the console and console
 331           input will be fed into the UART. This allows you to interact with
 332           U-Boot.
 333
 334           The operation of the console is controlled by the -t command-line
 335           flag. In raw mode, U-Boot sees all characters from the terminal
 336           before they are processed, including Ctrl-C. In cooked mode, Ctrl-C
 337           is processed by the terminal, and terminates U-Boot. Valid options
 338           are:
 339
 340              -t raw-with-sigs   Raw mode, Ctrl-C will terminate U-Boot
 341              -t raw             Raw mode, Ctrl-C is processed by U-Boot
 342              -t cooked          Cooked mode, Ctrl-C terminates
 343
 344 config UNIPHIER_SERIAL
 345         bool "Support for UniPhier on-chip UART"
 346         depends on ARCH_UNIPHIER
 347         help
 348           If you have a UniPhier based board and want to use the on-chip
 349           serial ports, say Y to this option. If unsure, say N.
 350
 351 config XILINX_UARTLITE
 352         bool "Xilinx Uarlite support"
 353         depends on DM_SERIAL && (MICROBLAZE || ARCH_ZYNQ || ARCH_ZYNQMP || 4xx)
 354         help
 355           If you have a Xilinx based board and want to use the uartlite
 356           serial ports, say Y to this option. If unsure, say N.
 357
 358 config MESON_SERIAL
 359         bool "Support for Amlogic Meson UART"
 360         depends on DM_SERIAL && ARCH_MESON
 361         help
 362           If you have an Amlogic Meson based board and want to use the on-chip
 363           serial ports, say Y to this option. If unsure, say N.
 364
 365 config MSM_SERIAL
 366         bool "Qualcomm on-chip UART"
 367         depends on DM_SERIAL
 368         help
 369           Support Data Mover UART used on Qualcomm Snapdragon SoCs.
 370           It should support all Qualcomm devices with UARTDM version 1.4,
 371           for example APQ8016 and MSM8916.
 372           Single baudrate is supported in current implementation (115200).
 373 endmenu