drivers/serial/serial_ns16550.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2000
   4  * Rob Taylor, Flying Pig Systems. robt@flyingpig.com.
   5  */
   6
   7 #include <common.h>
   8 #include <clock_legacy.h>
   9 #include <ns16550.h>
  10 #include <serial.h>
  11 #include <linux/compiler.h>
  12
  13 #ifndef CONFIG_NS16550_MIN_FUNCTIONS
  14
  15 DECLARE_GLOBAL_DATA_PTR;
  16
  17 #if !defined(CONFIG_CONS_INDEX)
  18 #elif (CONFIG_CONS_INDEX < 1) || (CONFIG_CONS_INDEX > 6)
  19 #error  "Invalid console index value."
  20 #endif
  21
  22 #if CONFIG_CONS_INDEX == 1 && !defined(CONFIG_SYS_NS16550_COM1)
  23 #error  "Console port 1 defined but not configured."
  24 #elif CONFIG_CONS_INDEX == 2 && !defined(CONFIG_SYS_NS16550_COM2)
  25 #error  "Console port 2 defined but not configured."
  26 #elif CONFIG_CONS_INDEX == 3 && !defined(CONFIG_SYS_NS16550_COM3)
  27 #error  "Console port 3 defined but not configured."
  28 #elif CONFIG_CONS_INDEX == 4 && !defined(CONFIG_SYS_NS16550_COM4)
  29 #error  "Console port 4 defined but not configured."
  30 #elif CONFIG_CONS_INDEX == 5 && !defined(CONFIG_SYS_NS16550_COM5)
  31 #error  "Console port 5 defined but not configured."
  32 #elif CONFIG_CONS_INDEX == 6 && !defined(CONFIG_SYS_NS16550_COM6)
  33 #error  "Console port 6 defined but not configured."
  34 #endif
  35
  36 /* Note: The port number specified in the functions is 1 based.
  37  *       the array is 0 based.
  38  */
  39 static struct ns16550 *serial_ports[6] = {
  40 #ifdef CONFIG_SYS_NS16550_COM1
  41         (struct ns16550 *)CONFIG_SYS_NS16550_COM1,
  42 #else
  43         NULL,
  44 #endif
  45 #ifdef CONFIG_SYS_NS16550_COM2
  46         (struct ns16550 *)CONFIG_SYS_NS16550_COM2,
  47 #else
  48         NULL,
  49 #endif
  50 #ifdef CONFIG_SYS_NS16550_COM3
  51         (struct ns16550 *)CONFIG_SYS_NS16550_COM3,
  52 #else
  53         NULL,
  54 #endif
  55 #ifdef CONFIG_SYS_NS16550_COM4
  56         (struct ns16550 *)CONFIG_SYS_NS16550_COM4,
  57 #else
  58         NULL,
  59 #endif
  60 #ifdef CONFIG_SYS_NS16550_COM5
  61         (struct ns16550 *)CONFIG_SYS_NS16550_COM5,
  62 #else
  63         NULL,
  64 #endif
  65 #ifdef CONFIG_SYS_NS16550_COM6
  66         (struct ns16550 *)CONFIG_SYS_NS16550_COM6
  67 #else
  68         NULL
  69 #endif
  70 };
  71
  72 #define PORT    serial_ports[port-1]
  73
  74 /* Multi serial device functions */
  75 #define DECLARE_ESERIAL_FUNCTIONS(port) \
  76         static int  eserial##port##_init(void) \
  77         { \
  78                 int clock_divisor; \
  79                 clock_divisor = ns16550_calc_divisor(serial_ports[port-1], \
  80                                 CONFIG_SYS_NS16550_CLK, gd->baudrate); \
  81                 ns16550_init(serial_ports[port - 1], clock_divisor); \
  82                 return 0 ; \
  83         } \
  84         static void eserial##port##_setbrg(void) \
  85         { \
  86                 serial_setbrg_dev(port); \
  87         } \
  88         static int  eserial##port##_getc(void) \
  89         { \
  90                 return serial_getc_dev(port); \
  91         } \
  92         static int  eserial##port##_tstc(void) \
  93         { \
  94                 return serial_tstc_dev(port); \
  95         } \
  96         static void eserial##port##_putc(const char c) \
  97         { \
  98                 serial_putc_dev(port, c); \
  99         } \
 100         static void eserial##port##_puts(const char *s) \
 101         { \
 102                 serial_puts_dev(port, s); \
 103         }
 104
 105 /* Serial device descriptor */
 106 #define INIT_ESERIAL_STRUCTURE(port, __name) {  \
 107         .name   = __name,                       \
 108         .start  = eserial##port##_init,         \
 109         .stop   = NULL,                         \
 110         .setbrg = eserial##port##_setbrg,       \
 111         .getc   = eserial##port##_getc,         \
 112         .tstc   = eserial##port##_tstc,         \
 113         .putc   = eserial##port##_putc,         \
 114         .puts   = eserial##port##_puts,         \
 115 }
 116
 117 static void _serial_putc(const char c, const int port)
 118 {
 119         if (c == '\n')
 120                 ns16550_putc(PORT, '\r');
 121
 122         ns16550_putc(PORT, c);
 123 }
 124
 125 static void _serial_puts(const char *s, const int port)
 126 {
 127         while (*s) {
 128                 _serial_putc(*s++, port);
 129         }
 130 }
 131
 132 static int _serial_getc(const int port)
 133 {
 134         return ns16550_getc(PORT);
 135 }
 136
 137 static int _serial_tstc(const int port)
 138 {
 139         return ns16550_tstc(PORT);
 140 }
 141
 142 static void _serial_setbrg(const int port)
 143 {
 144         int clock_divisor;
 145
 146         clock_divisor = ns16550_calc_divisor(PORT, CONFIG_SYS_NS16550_CLK,
 147                                              gd->baudrate);
 148         ns16550_reinit(PORT, clock_divisor);
 149 }
 150
 151 static inline void
 152 serial_putc_dev(unsigned int dev_index,const char c)
 153 {
 154         _serial_putc(c,dev_index);
 155 }
 156
 157 static inline void
 158 serial_puts_dev(unsigned int dev_index,const char *s)
 159 {
 160         _serial_puts(s,dev_index);
 161 }
 162
 163 static inline int
 164 serial_getc_dev(unsigned int dev_index)
 165 {
 166         return _serial_getc(dev_index);
 167 }
 168
 169 static inline int
 170 serial_tstc_dev(unsigned int dev_index)
 171 {
 172         return _serial_tstc(dev_index);
 173 }
 174
 175 static inline void
 176 serial_setbrg_dev(unsigned int dev_index)
 177 {
 178         _serial_setbrg(dev_index);
 179 }
 180
 181 #if defined(CONFIG_SYS_NS16550_COM1)
 182 DECLARE_ESERIAL_FUNCTIONS(1);
 183 struct serial_device eserial1_device =
 184         INIT_ESERIAL_STRUCTURE(1, "eserial0");
 185 #endif
 186 #if defined(CONFIG_SYS_NS16550_COM2)
 187 DECLARE_ESERIAL_FUNCTIONS(2);
 188 struct serial_device eserial2_device =
 189         INIT_ESERIAL_STRUCTURE(2, "eserial1");
 190 #endif
 191 #if defined(CONFIG_SYS_NS16550_COM3)
 192 DECLARE_ESERIAL_FUNCTIONS(3);
 193 struct serial_device eserial3_device =
 194         INIT_ESERIAL_STRUCTURE(3, "eserial2");
 195 #endif
 196 #if defined(CONFIG_SYS_NS16550_COM4)
 197 DECLARE_ESERIAL_FUNCTIONS(4);
 198 struct serial_device eserial4_device =
 199         INIT_ESERIAL_STRUCTURE(4, "eserial3");
 200 #endif
 201 #if defined(CONFIG_SYS_NS16550_COM5)
 202 DECLARE_ESERIAL_FUNCTIONS(5);
 203 struct serial_device eserial5_device =
 204         INIT_ESERIAL_STRUCTURE(5, "eserial4");
 205 #endif
 206 #if defined(CONFIG_SYS_NS16550_COM6)
 207 DECLARE_ESERIAL_FUNCTIONS(6);
 208 struct serial_device eserial6_device =
 209         INIT_ESERIAL_STRUCTURE(6, "eserial5");
 210 #endif
 211
 212 __weak struct serial_device *default_serial_console(void)
 213 {
 214 #if CONFIG_CONS_INDEX == 1
 215         return &eserial1_device;
 216 #elif CONFIG_CONS_INDEX == 2
 217         return &eserial2_device;
 218 #elif CONFIG_CONS_INDEX == 3
 219         return &eserial3_device;
 220 #elif CONFIG_CONS_INDEX == 4
 221         return &eserial4_device;
 222 #elif CONFIG_CONS_INDEX == 5
 223         return &eserial5_device;
 224 #elif CONFIG_CONS_INDEX == 6
 225         return &eserial6_device;
 226 #else
 227 #error "Bad CONFIG_CONS_INDEX."
 228 #endif
 229 }
 230
 231 void ns16550_serial_initialize(void)
 232 {
 233 #if defined(CONFIG_SYS_NS16550_COM1)
 234         serial_register(&eserial1_device);
 235 #endif
 236 #if defined(CONFIG_SYS_NS16550_COM2)
 237         serial_register(&eserial2_device);
 238 #endif
 239 #if defined(CONFIG_SYS_NS16550_COM3)
 240         serial_register(&eserial3_device);
 241 #endif
 242 #if defined(CONFIG_SYS_NS16550_COM4)
 243         serial_register(&eserial4_device);
 244 #endif
 245 #if defined(CONFIG_SYS_NS16550_COM5)
 246         serial_register(&eserial5_device);
 247 #endif
 248 #if defined(CONFIG_SYS_NS16550_COM6)
 249         serial_register(&eserial6_device);
 250 #endif
 251 }
 252
 253 #endif /* !CONFIG_NS16550_MIN_FUNCTIONS */