uart_bus.h

Version: - FREEBSD - FREEBSD-13-STABLE - FREEBSD-13-0 - FREEBSD-12-STABLE - FREEBSD-12-0 - FREEBSD-11-STABLE - FREEBSD-11-0 - FREEBSD-10-STABLE - FREEBSD-10-0 - FREEBSD-9-STABLE - FREEBSD-9-0 - FREEBSD-8-STABLE - FREEBSD-8-0 - FREEBSD-7-STABLE - FREEBSD-7-0 - FREEBSD-6-STABLE - FREEBSD-6-0 - FREEBSD-5-STABLE - FREEBSD-5-0 - FREEBSD-4-STABLE - FREEBSD-3-STABLE - FREEBSD22 - l41 - OPENBSD - linux-2.6 - MK84 - PLAN9 - xnu-8792
SearchContext: - none - 3 - 10

    1 /*-
    2  * Copyright (c) 2003 Marcel Moolenaar
    3  * All rights reserved.
    4  *
    5  * Redistribution and use in source and binary forms, with or without
    6  * modification, are permitted provided that the following conditions
    7  * are met:
    8  *
    9  * 1. Redistributions of source code must retain the above copyright
   10  *    notice, this list of conditions and the following disclaimer.
   11  * 2. Redistributions in binary form must reproduce the above copyright
   12  *    notice, this list of conditions and the following disclaimer in the
   13  *    documentation and/or other materials provided with the distribution.
   14  *
   15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
   16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
   18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
   19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
   20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
   24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   25  *
   26  * $FreeBSD$
   27  */
   28 
   29 #ifndef _DEV_UART_BUS_H_
   30 #define _DEV_UART_BUS_H_
   31 
   32 #ifndef KLD_MODULE
   33 #include "opt_uart.h"
   34 #endif
   35 
   36 #include <sys/serial.h>
   37 #include <sys/timepps.h>
   38 
   39 /* Drain and flush targets. */
   40 #define UART_DRAIN_RECEIVER     0x0001
   41 #define UART_DRAIN_TRANSMITTER  0x0002
   42 #define UART_FLUSH_RECEIVER     UART_DRAIN_RECEIVER
   43 #define UART_FLUSH_TRANSMITTER  UART_DRAIN_TRANSMITTER
   44 
   45 /* Received character status bits. */
   46 #define UART_STAT_BREAK         0x0100
   47 #define UART_STAT_FRAMERR       0x0200
   48 #define UART_STAT_OVERRUN       0x0400
   49 #define UART_STAT_PARERR        0x0800
   50 
   51 #ifdef UART_PPS_ON_CTS
   52 #define UART_SIG_DPPS           SER_DCTS
   53 #define UART_SIG_PPS            SER_CTS
   54 #else
   55 #define UART_SIG_DPPS           SER_DDCD
   56 #define UART_SIG_PPS            SER_DCD
   57 #endif
   58 
   59 /* UART_IOCTL() requests */
   60 #define UART_IOCTL_BREAK        1
   61 #define UART_IOCTL_IFLOW        2
   62 #define UART_IOCTL_OFLOW        3
   63 #define UART_IOCTL_BAUD         4
   64 
   65 /*
   66  * UART class & instance (=softc)
   67  */
   68 struct uart_class {
   69         KOBJ_CLASS_FIELDS;
   70         struct uart_ops *uc_ops;        /* Low-level console operations. */
   71         u_int   uc_range;               /* Bus space address range. */
   72         u_int   uc_rclk;                /* Default rclk for this device. */
   73 };
   74 
   75 struct uart_softc {
   76         KOBJ_FIELDS;
   77         struct uart_class *sc_class;
   78         struct uart_bas sc_bas;
   79         device_t        sc_dev;
   80 
   81         struct mtx      sc_hwmtx_s;     /* Spinlock protecting hardware. */
   82         struct mtx      *sc_hwmtx;
   83 
   84         struct resource *sc_rres;       /* Register resource. */
   85         int             sc_rrid;
   86         int             sc_rtype;       /* SYS_RES_{IOPORT|MEMORY}. */
   87         struct resource *sc_ires;       /* Interrupt resource. */
   88         void            *sc_icookie;
   89         int             sc_irid;
   90 
   91         int             sc_callout:1;   /* This UART is opened for callout. */
   92         int             sc_fastintr:1;  /* This UART uses fast interrupts. */
   93         int             sc_hwiflow:1;   /* This UART has HW input flow ctl. */
   94         int             sc_hwoflow:1;   /* This UART has HW output flow ctl. */
   95         int             sc_leaving:1;   /* This UART is going away. */
   96         int             sc_opened:1;    /* This UART is open for business. */
   97         int             sc_polled:1;    /* This UART has no interrupts. */
   98         int             sc_txbusy:1;    /* This UART is transmitting. */
   99         int             sc_isquelch:1;  /* This UART has input squelched. */
  100 
  101         struct uart_devinfo *sc_sysdev; /* System device (or NULL). */
  102 
  103         int             sc_altbrk;      /* State for alt break sequence. */
  104         uint32_t        sc_hwsig;       /* Signal state. Used by HW driver. */
  105 
  106         /* Receiver data. */
  107         uint16_t        *sc_rxbuf;
  108         int             sc_rxbufsz;
  109         int             sc_rxput;
  110         int             sc_rxget;
  111         int             sc_rxfifosz;    /* Size of RX FIFO. */
  112 
  113         /* Transmitter data. */
  114         uint8_t         *sc_txbuf;
  115         int             sc_txdatasz;
  116         int             sc_txfifosz;    /* Size of TX FIFO and buffer. */
  117 
  118         /* Pulse capturing support (PPS). */
  119         struct pps_state sc_pps;
  120 
  121         /* Upper layer data. */
  122         void            *sc_softih;
  123         uint32_t        sc_ttypend;
  124         union {
  125                 /* TTY specific data. */
  126                 struct {
  127                         struct tty *tp;
  128                 } u_tty;
  129                 /* Keyboard specific data. */
  130                 struct {
  131                 } u_kbd;
  132         } sc_u;
  133 };
  134 
  135 extern devclass_t uart_devclass;
  136 extern char uart_driver_name[];
  137 
  138 int uart_bus_attach(device_t dev);
  139 int uart_bus_detach(device_t dev);
  140 int uart_bus_resume(device_t dev);
  141 serdev_intr_t *uart_bus_ihand(device_t dev, int ipend);
  142 int uart_bus_ipend(device_t dev);
  143 int uart_bus_probe(device_t dev, int regshft, int rclk, int rid, int chan);
  144 int uart_bus_sysdev(device_t dev);
  145 
  146 void uart_sched_softih(struct uart_softc *, uint32_t);
  147 
  148 int uart_tty_attach(struct uart_softc *);
  149 int uart_tty_detach(struct uart_softc *);
  150 void uart_tty_intr(void *arg);
  151 
  152 /*
  153  * Receive buffer operations.
  154  */
  155 static __inline int
  156 uart_rx_empty(struct uart_softc *sc)
  157 {
  158         return ((sc->sc_rxget == sc->sc_rxput) ? 1 : 0);
  159 }
  160 
  161 static __inline int
  162 uart_rx_full(struct uart_softc *sc)
  163 {
  164         return ((sc->sc_rxput + 1 < sc->sc_rxbufsz)
  165             ? (sc->sc_rxput + 1 == sc->sc_rxget) : (sc->sc_rxget == 0));
  166 }
  167 
  168 static __inline int
  169 uart_rx_get(struct uart_softc *sc)
  170 {
  171         int ptr, xc;
  172 
  173         ptr = sc->sc_rxget;
  174         if (ptr == sc->sc_rxput)
  175                 return (-1);
  176         xc = sc->sc_rxbuf[ptr++];
  177         sc->sc_rxget = (ptr < sc->sc_rxbufsz) ? ptr : 0;
  178         return (xc);
  179 }
  180 
  181 static __inline int
  182 uart_rx_next(struct uart_softc *sc)
  183 {
  184         int ptr;
  185 
  186         ptr = sc->sc_rxget;
  187         if (ptr == sc->sc_rxput)
  188                 return (-1);
  189         ptr += 1;
  190         sc->sc_rxget = (ptr < sc->sc_rxbufsz) ? ptr : 0;
  191         return (0);
  192 }
  193 
  194 static __inline int
  195 uart_rx_peek(struct uart_softc *sc)
  196 {
  197         int ptr;
  198 
  199         ptr = sc->sc_rxget;
  200         return ((ptr == sc->sc_rxput) ? -1 : sc->sc_rxbuf[ptr]);
  201 }
  202 
  203 static __inline int
  204 uart_rx_put(struct uart_softc *sc, int xc)
  205 {
  206         int ptr;
  207 
  208         ptr = (sc->sc_rxput + 1 < sc->sc_rxbufsz) ? sc->sc_rxput + 1 : 0;
  209         if (ptr == sc->sc_rxget)
  210                 return (ENOSPC);
  211         sc->sc_rxbuf[sc->sc_rxput] = xc;
  212         sc->sc_rxput = ptr;
  213         return (0);
  214 }
  215 
  216 #endif /* _DEV_UART_BUS_H_ */

Cache object: d78240cab7ed65620b76fb4a2513c342

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.

FreeBSD/Linux Kernel Cross Reference sys/dev/uart/uart_bus.h

FreeBSD/Linux Kernel Cross Reference
sys/dev/uart/uart_bus.h