sys/mips/adm5120/uart_dev_adm5120.c

   1 /* $NetBSD: uart.c,v 1.2 2007/03/23 20:05:47 dogcow Exp $ */
   2
   3 /*-
   4  * Copyright (c) 2007 Ruslan Ermilov and Vsevolod Lobko.
   5  * Copyright (c) 2007 Oleksandr Tymoshenko.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or
   9  * without modification, are permitted provided that the following
  10  * conditions are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above
  14  *    copyright notice, this list of conditions and the following
  15  *    disclaimer in the documentation and/or other materials provided
  16  *    with the distribution.
  17  * 3. The names of the authors may not be used to endorse or promote
  18  *    products derived from this software without specific prior
  19  *    written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY
  22  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  23  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  24  * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS
  25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  26  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  27  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
  28  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  30  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  32  * OF SUCH DAMAGE.
  33  */
  34
  35 #include <sys/cdefs.h>
  36 __FBSDID("$FreeBSD$");
  37
  38 #include <sys/param.h>
  39 #include <sys/systm.h>
  40 #include <sys/bus.h>
  41 #include <sys/conf.h>
  42 #include <machine/bus.h>
  43
  44 #include <dev/uart/uart.h>
  45 #include <dev/uart/uart_cpu.h>
  46 #include <dev/uart/uart_bus.h>
  47
  48 #include <mips/adm5120/uart_dev_adm5120.h>
  49
  50 #include "uart_if.h"
  51
  52 /*
  53  * Low-level UART interface.
  54  */
  55 static int adm5120_uart_probe(struct uart_bas *bas);
  56 static void adm5120_uart_init(struct uart_bas *bas, int, int, int, int);
  57 static void adm5120_uart_term(struct uart_bas *bas);
  58 static void adm5120_uart_putc(struct uart_bas *bas, int);
  59 static int adm5120_uart_rxready(struct uart_bas *bas);
  60 static int adm5120_uart_getc(struct uart_bas *bas, struct mtx *);
  61
  62 static struct uart_ops uart_adm5120_uart_ops = {
  63         .probe = adm5120_uart_probe,
  64         .init = adm5120_uart_init,
  65         .term = adm5120_uart_term,
  66         .putc = adm5120_uart_putc,
  67         .rxready = adm5120_uart_rxready,
  68         .getc = adm5120_uart_getc,
  69 };
  70
  71 static int
  72 adm5120_uart_probe(struct uart_bas *bas)
  73 {
  74
  75         return (0);
  76 }
  77
  78 static void
  79 adm5120_uart_init(struct uart_bas *bas, int baudrate, int databits,
  80     int stopbits, int parity)
  81 {
  82
  83         /* TODO: Set parameters for uart, meanwhile stick with 115200N1 */
  84 }
  85
  86 static void
  87 adm5120_uart_term(struct uart_bas *bas)
  88 {
  89
  90 }
  91
  92 static void
  93 adm5120_uart_putc(struct uart_bas *bas, int c)
  94 {
  95         char chr;
  96         chr = c;
  97         while (uart_getreg(bas, UART_FR_REG) & UART_FR_TX_FIFO_FULL)
  98                 ;
  99         uart_setreg(bas, UART_DR_REG, c);
 100         while (uart_getreg(bas, UART_FR_REG) & UART_FR_BUSY)
 101                 ;
 102         uart_barrier(bas);
 103 }
 104
 105 static int
 106 adm5120_uart_rxready(struct uart_bas *bas)
 107 {
 108         if (uart_getreg(bas, UART_FR_REG) & UART_FR_RX_FIFO_EMPTY)
 109                 return (0);
 110
 111         return (1);
 112 }
 113
 114 static int
 115 adm5120_uart_getc(struct uart_bas *bas, struct mtx *hwmtx)
 116 {
 117         int c;
 118
 119         uart_lock(hwmtx);
 120
 121         while (uart_getreg(bas, UART_FR_REG) & UART_FR_RX_FIFO_EMPTY) {
 122                 uart_unlock(hwmtx);
 123                 DELAY(10);
 124                 uart_lock(hwmtx);
 125         }
 126
 127         c = uart_getreg(bas, UART_DR_REG);
 128
 129         uart_unlock(hwmtx);
 130
 131         return (c);
 132 }
 133
 134 /*
 135  * High-level UART interface.
 136  */
 137 struct adm5120_uart_softc {
 138         struct uart_softc base;
 139 };
 140
 141 static int adm5120_uart_bus_attach(struct uart_softc *);
 142 static int adm5120_uart_bus_detach(struct uart_softc *);
 143 static int adm5120_uart_bus_flush(struct uart_softc *, int);
 144 static int adm5120_uart_bus_getsig(struct uart_softc *);
 145 static int adm5120_uart_bus_ioctl(struct uart_softc *, int, intptr_t);
 146 static int adm5120_uart_bus_ipend(struct uart_softc *);
 147 static int adm5120_uart_bus_param(struct uart_softc *, int, int, int, int);
 148 static int adm5120_uart_bus_probe(struct uart_softc *);
 149 static int adm5120_uart_bus_receive(struct uart_softc *);
 150 static int adm5120_uart_bus_setsig(struct uart_softc *, int);
 151 static int adm5120_uart_bus_transmit(struct uart_softc *);
 152
 153 static kobj_method_t adm5120_uart_methods[] = {
 154         KOBJMETHOD(uart_attach,         adm5120_uart_bus_attach),
 155         KOBJMETHOD(uart_detach,         adm5120_uart_bus_detach),
 156         KOBJMETHOD(uart_flush,          adm5120_uart_bus_flush),
 157         KOBJMETHOD(uart_getsig,         adm5120_uart_bus_getsig),
 158         KOBJMETHOD(uart_ioctl,          adm5120_uart_bus_ioctl),
 159         KOBJMETHOD(uart_ipend,          adm5120_uart_bus_ipend),
 160         KOBJMETHOD(uart_param,          adm5120_uart_bus_param),
 161         KOBJMETHOD(uart_probe,          adm5120_uart_bus_probe),
 162         KOBJMETHOD(uart_receive,        adm5120_uart_bus_receive),
 163         KOBJMETHOD(uart_setsig,         adm5120_uart_bus_setsig),
 164         KOBJMETHOD(uart_transmit,       adm5120_uart_bus_transmit),
 165         { 0, 0 }
 166 };
 167
 168 struct uart_class uart_adm5120_uart_class = {
 169         "adm5120",
 170         adm5120_uart_methods,
 171         sizeof(struct adm5120_uart_softc),
 172         .uc_ops = &uart_adm5120_uart_ops,
 173         .uc_range = 1, /* use hinted range */
 174         .uc_rclk = 62500000
 175 };
 176
 177 #define SIGCHG(c, i, s, d)                              \
 178         if (c) {                                        \
 179                 i |= (i & s) ? s : s | d;               \
 180         } else {                                        \
 181                 i = (i & s) ? (i & ~s) | d : i;         \
 182         }
 183
 184 /*
 185  * Disable TX interrupt. uart should be locked
 186  */
 187 static __inline void
 188 adm5120_uart_disable_txintr(struct uart_softc *sc)
 189 {
 190         uint8_t cr;
 191
 192         cr = uart_getreg(&sc->sc_bas, UART_CR_REG);
 193         cr &= ~UART_CR_TX_INT_EN;
 194         uart_setreg(&sc->sc_bas, UART_CR_REG, cr);
 195 }
 196
 197 /*
 198  * Enable TX interrupt. uart should be locked
 199  */
 200 static __inline void
 201 adm5120_uart_enable_txintr(struct uart_softc *sc)
 202 {
 203         uint8_t cr;
 204
 205         cr = uart_getreg(&sc->sc_bas, UART_CR_REG);
 206         cr |= UART_CR_TX_INT_EN;
 207         uart_setreg(&sc->sc_bas, UART_CR_REG, cr);
 208 }
 209
 210 static int
 211 adm5120_uart_bus_attach(struct uart_softc *sc)
 212 {
 213         struct uart_bas *bas;
 214         struct uart_devinfo *di;
 215
 216         bas = &sc->sc_bas;
 217         if (sc->sc_sysdev != NULL) {
 218                 di = sc->sc_sysdev;
 219                 /* TODO: set parameters from di */
 220         } else {
 221                 /* TODO: set parameters 115200, 8N1 */
 222         }
 223
 224         (void)adm5120_uart_bus_getsig(sc);
 225
 226 #if 1
 227         /* Enable FIFO */
 228         uart_setreg(bas, UART_LCR_H_REG,
 229             uart_getreg(bas, UART_LCR_H_REG) | UART_LCR_H_FEN);
 230 #endif
 231         /* Enable interrupts */
 232         uart_setreg(bas, UART_CR_REG,
 233             UART_CR_PORT_EN|UART_CR_RX_INT_EN|UART_CR_RX_TIMEOUT_INT_EN|
 234             UART_CR_MODEM_STATUS_INT_EN);
 235
 236         return (0);
 237 }
 238
 239 static int
 240 adm5120_uart_bus_detach(struct uart_softc *sc)
 241 {
 242
 243         return (0);
 244 }
 245
 246 static int
 247 adm5120_uart_bus_flush(struct uart_softc *sc, int what)
 248 {
 249
 250         return (0);
 251 }
 252
 253 static int
 254 adm5120_uart_bus_getsig(struct uart_softc *sc)
 255 {
 256         uint32_t new, old, sig;
 257         uint8_t bes;
 258
 259         do {
 260                 old = sc->sc_hwsig;
 261                 sig = old;
 262                 uart_lock(sc->sc_hwmtx);
 263                 bes = uart_getreg(&sc->sc_bas, UART_FR_REG);
 264                 uart_unlock(sc->sc_hwmtx);
 265                 SIGCHG(bes & UART_FR_CTS, sig, SER_CTS, SER_DCTS);
 266                 SIGCHG(bes & UART_FR_DCD, sig, SER_DCD, SER_DDCD);
 267                 SIGCHG(bes & UART_FR_DSR, sig, SER_DSR, SER_DDSR);
 268                 new = sig & ~SER_MASK_DELTA;
 269         } while (!atomic_cmpset_32(&sc->sc_hwsig, old, new));
 270
 271         return (sig);
 272 }
 273
 274 static int
 275 adm5120_uart_bus_ioctl(struct uart_softc *sc, int request, intptr_t data)
 276 {
 277         struct uart_bas *bas;
 278         int baudrate, divisor, error;
 279
 280         bas = &sc->sc_bas;
 281         error = 0;
 282         uart_lock(sc->sc_hwmtx);
 283         switch (request) {
 284         case UART_IOCTL_BREAK:
 285                 /* TODO: Send BREAK */
 286                 break;
 287         case UART_IOCTL_BAUD:
 288                 divisor = uart_getreg(bas, UART_LCR_M_REG);
 289                 divisor = (divisor << 8) |
 290                     uart_getreg(bas, UART_LCR_L_REG);
 291                 baudrate = bas->rclk / 2 / (divisor + 2);
 292                 *(int*)data = baudrate;
 293                 break;
 294         default:
 295                 error = EINVAL;
 296                 break;
 297         }
 298         uart_unlock(sc->sc_hwmtx);
 299         return (error);
 300 }
 301
 302 static int
 303 adm5120_uart_bus_ipend(struct uart_softc *sc)
 304 {
 305         struct uart_bas *bas;
 306         int ipend;
 307         uint8_t ir, fr, rsr;
 308
 309         bas = &sc->sc_bas;
 310         ipend = 0;
 311
 312         uart_lock(sc->sc_hwmtx);
 313         ir = uart_getreg(&sc->sc_bas, UART_IR_REG);
 314         fr = uart_getreg(&sc->sc_bas, UART_FR_REG);
 315         rsr = uart_getreg(&sc->sc_bas, UART_RSR_REG);
 316
 317         if (ir & UART_IR_RX_INT)
 318                 ipend |= SER_INT_RXREADY;
 319
 320         if (ir & UART_IR_RX_TIMEOUT_INT)
 321                 ipend |= SER_INT_RXREADY;
 322
 323         if (ir & UART_IR_MODEM_STATUS_INT)
 324                 ipend |= SER_INT_SIGCHG;
 325
 326         if (rsr & UART_RSR_BE)
 327                 ipend |= SER_INT_BREAK;
 328
 329         if (rsr & UART_RSR_OE)
 330                 ipend |= SER_INT_OVERRUN;
 331
 332         if (fr & UART_FR_TX_FIFO_EMPTY) {
 333                 if (ir & UART_IR_TX_INT) {
 334                         adm5120_uart_disable_txintr(sc);
 335                         ipend |= SER_INT_TXIDLE;
 336                 }
 337         }
 338
 339         if (ipend)
 340                 uart_setreg(bas, UART_IR_REG, ir | UART_IR_UICR);
 341
 342         uart_unlock(sc->sc_hwmtx);
 343
 344         return (ipend);
 345 }
 346
 347 static int
 348 adm5120_uart_bus_param(struct uart_softc *sc, int baudrate, int databits,
 349     int stopbits, int parity)
 350 {
 351
 352         /* TODO: Set parameters for uart, meanwhile stick with 115200 8N1 */
 353         return (0);
 354 }
 355
 356 static int
 357 adm5120_uart_bus_probe(struct uart_softc *sc)
 358 {
 359         char buf[80];
 360         int error;
 361         char ch;
 362
 363         error = adm5120_uart_probe(&sc->sc_bas);
 364         if (error)
 365                 return (error);
 366
 367         sc->sc_rxfifosz = 16;
 368         sc->sc_txfifosz = 16;
 369
 370         ch = sc->sc_bas.chan + 'A';
 371
 372         snprintf(buf, sizeof(buf), "adm5120_uart, channel %c", ch);
 373         device_set_desc_copy(sc->sc_dev, buf);
 374
 375         return (0);
 376 }
 377
 378 static int
 379 adm5120_uart_bus_receive(struct uart_softc *sc)
 380 {
 381         struct uart_bas *bas;
 382         int xc;
 383         uint8_t fr, rsr;
 384
 385         bas = &sc->sc_bas;
 386         uart_lock(sc->sc_hwmtx);
 387         fr = uart_getreg(bas, UART_FR_REG);
 388         while (!(fr & UART_FR_RX_FIFO_EMPTY)) {
 389                 if (uart_rx_full(sc)) {
 390                         sc->sc_rxbuf[sc->sc_rxput] = UART_STAT_OVERRUN;
 391                         break;
 392                 }
 393                 xc = 0;
 394                 rsr = uart_getreg(bas, UART_RSR_REG);
 395                 if (rsr & UART_RSR_FE)
 396                         xc |= UART_STAT_FRAMERR;
 397                 if (rsr & UART_RSR_PE)
 398                         xc |= UART_STAT_PARERR;
 399                 if (rsr & UART_RSR_OE)
 400                         xc |= UART_STAT_OVERRUN;
 401                 xc |= uart_getreg(bas, UART_DR_REG);
 402                 uart_barrier(bas);
 403                 uart_rx_put(sc, xc);
 404                 if (rsr & (UART_RSR_FE | UART_RSR_PE | UART_RSR_OE)) {
 405                         uart_setreg(bas, UART_ECR_REG, UART_ECR_RSR);
 406                         uart_barrier(bas);
 407                 }
 408                 fr = uart_getreg(bas, UART_FR_REG);
 409         }
 410
 411         /* Discard everything left in the Rx FIFO. */
 412         while (!(fr & UART_FR_RX_FIFO_EMPTY)) {
 413                 ( void)uart_getreg(bas, UART_DR_REG);
 414                 uart_barrier(bas);
 415                 rsr = uart_getreg(bas, UART_RSR_REG);
 416                 if (rsr & (UART_RSR_FE | UART_RSR_PE | UART_RSR_OE)) {
 417                         uart_setreg(bas, UART_ECR_REG, UART_ECR_RSR);
 418                         uart_barrier(bas);
 419                 }
 420                 fr = uart_getreg(bas, UART_FR_REG);
 421         }
 422         uart_unlock(sc->sc_hwmtx);
 423         return (0);
 424 }
 425
 426 static int
 427 adm5120_uart_bus_setsig(struct uart_softc *sc, int sig)
 428 {
 429
 430         /* TODO: implement (?) */
 431         return (0);
 432 }
 433
 434 static int
 435 adm5120_uart_bus_transmit(struct uart_softc *sc)
 436 {
 437         struct uart_bas *bas;
 438
 439         bas = &sc->sc_bas;
 440         uart_lock(sc->sc_hwmtx);
 441         sc->sc_txbusy = 1;
 442         for (int i = 0; i < sc->sc_txdatasz; i++) {
 443                 if (uart_getreg(bas, UART_FR_REG) & UART_FR_TX_FIFO_FULL)
 444                         break;
 445                 uart_setreg(bas, UART_DR_REG, sc->sc_txbuf[i]);
 446         }
 447
 448         /* Enable TX interrupt */
 449         adm5120_uart_enable_txintr(sc);
 450         uart_unlock(sc->sc_hwmtx);
 451         return (0);
 452 }