sys/dev/uart/uart_cpu.h

   1 /*-
   2  * Copyright (c) 2003, 2004 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_CPU_H_
  30 #define _DEV_UART_CPU_H_
  31
  32 #include <sys/kdb.h>
  33 #include <sys/lock.h>
  34 #include <sys/mutex.h>
  35
  36 struct uart_softc;
  37
  38 /*
  39  * Low-level operations for use by console and/or debug port support.
  40  */
  41 struct uart_ops {
  42         int (*probe)(struct uart_bas *);
  43         void (*init)(struct uart_bas *, int, int, int, int);
  44         void (*term)(struct uart_bas *);
  45         void (*putc)(struct uart_bas *, int);
  46         int (*rxready)(struct uart_bas *);
  47         int (*getc)(struct uart_bas *, struct mtx *);
  48 };
  49
  50 extern bus_space_tag_t uart_bus_space_io;
  51 extern bus_space_tag_t uart_bus_space_mem;
  52
  53 /*
  54  * Console and debug port device info.
  55  */
  56 struct uart_devinfo {
  57         SLIST_ENTRY(uart_devinfo) next;
  58         struct uart_ops *ops;
  59         struct uart_bas bas;
  60         int     baudrate;
  61         int     databits;
  62         int     stopbits;
  63         int     parity;
  64         int     type;
  65 #define UART_DEV_CONSOLE        0
  66 #define UART_DEV_DBGPORT        1
  67 #define UART_DEV_KEYBOARD       2
  68         int     (*attach)(struct uart_softc*);
  69         int     (*detach)(struct uart_softc*);
  70         void    *cookie;                /* Type dependent use. */
  71         struct mtx *hwmtx;
  72         struct uart_softc *sc;          /* valid only from start of attach */
  73 };
  74
  75 int uart_cpu_eqres(struct uart_bas *, struct uart_bas *);
  76 int uart_cpu_getdev(int, struct uart_devinfo *);
  77
  78 int uart_getenv(int, struct uart_devinfo *, struct uart_class *);
  79 const char *uart_getname(struct uart_class *);
  80 struct uart_ops *uart_getops(struct uart_class *);
  81 int uart_getrange(struct uart_class *);
  82
  83 void uart_add_sysdev(struct uart_devinfo *);
  84
  85 /*
  86  * Operations for low-level access to the UART. Primarily for use
  87  * by console and debug port logic.
  88  */
  89
  90 static __inline void
  91 uart_lock(struct mtx *hwmtx)
  92 {
  93         if (!kdb_active && hwmtx != NULL)
  94                 mtx_lock_spin(hwmtx);
  95 }
  96
  97 static __inline void
  98 uart_unlock(struct mtx *hwmtx)
  99 {
 100         if (!kdb_active && hwmtx != NULL)
 101                 mtx_unlock_spin(hwmtx);
 102 }
 103
 104 static __inline int
 105 uart_probe(struct uart_devinfo *di)
 106 {
 107         int res;
 108
 109         uart_lock(di->hwmtx);
 110         res = di->ops->probe(&di->bas);
 111         uart_unlock(di->hwmtx);
 112         return (res);
 113 }
 114
 115 static __inline void
 116 uart_init(struct uart_devinfo *di)
 117 {
 118         uart_lock(di->hwmtx);
 119         di->ops->init(&di->bas, di->baudrate, di->databits, di->stopbits,
 120             di->parity);
 121         uart_unlock(di->hwmtx);
 122 }
 123
 124 static __inline void
 125 uart_term(struct uart_devinfo *di)
 126 {
 127         uart_lock(di->hwmtx);
 128         di->ops->term(&di->bas);
 129         uart_unlock(di->hwmtx);
 130 }
 131
 132 static __inline void
 133 uart_putc(struct uart_devinfo *di, int c)
 134 {
 135         uart_lock(di->hwmtx);
 136         di->ops->putc(&di->bas, c);
 137         uart_unlock(di->hwmtx);
 138 }
 139
 140 static __inline int
 141 uart_rxready(struct uart_devinfo *di)
 142 {
 143         int res;
 144
 145         uart_lock(di->hwmtx);
 146         res = di->ops->rxready(&di->bas);
 147         uart_unlock(di->hwmtx);
 148         return (res);
 149 }
 150
 151 static __inline int
 152 uart_poll(struct uart_devinfo *di)
 153 {
 154         int res;
 155
 156         uart_lock(di->hwmtx);
 157         if (di->ops->rxready(&di->bas))
 158                 res = di->ops->getc(&di->bas, NULL);
 159         else
 160                 res = -1;
 161         uart_unlock(di->hwmtx);
 162         return (res);
 163 }
 164
 165 static __inline int
 166 uart_getc(struct uart_devinfo *di)
 167 {
 168
 169         return (di->ops->getc(&di->bas, di->hwmtx));
 170 }
 171
 172 void uart_grab(struct uart_devinfo *di);
 173 void uart_ungrab(struct uart_devinfo *di);
 174
 175 #endif /* _DEV_UART_CPU_H_ */