include/linux/serial_sci.h

   1 #ifndef __LINUX_SERIAL_SCI_H
   2 #define __LINUX_SERIAL_SCI_H
   3
   4 #include <linux/serial_core.h>
   5 #include <linux/sh_dma.h>
   6
   7 /*
   8  * Generic header for SuperH (H)SCI(F) (used by sh/sh64 and related parts)
   9  */
  10
  11 #define SCIx_NOT_SUPPORTED      (-1)
  12
  13 enum {
  14         SCBRR_ALGO_INVALID,
  15
  16         SCBRR_ALGO_1,           /* ((clk + 16 * bps) / (16 * bps) - 1) */
  17         SCBRR_ALGO_2,           /* ((clk + 16 * bps) / (32 * bps) - 1) */
  18         SCBRR_ALGO_3,           /* (((clk * 2) + 16 * bps) / (16 * bps) - 1) */
  19         SCBRR_ALGO_4,           /* (((clk * 2) + 16 * bps) / (32 * bps) - 1) */
  20         SCBRR_ALGO_5,           /* (((clk * 1000 / 32) / bps) - 1) */
  21         SCBRR_ALGO_6,           /* HSCIF variable sample rate algorithm */
  22
  23         SCBRR_NR_ALGOS,
  24 };
  25
  26 #define SCSCR_TIE       (1 << 7)
  27 #define SCSCR_RIE       (1 << 6)
  28 #define SCSCR_TE        (1 << 5)
  29 #define SCSCR_RE        (1 << 4)
  30 #define SCSCR_REIE      (1 << 3)        /* not supported by all parts */
  31 #define SCSCR_TOIE      (1 << 2)        /* not supported by all parts */
  32 #define SCSCR_CKE1      (1 << 1)
  33 #define SCSCR_CKE0      (1 << 0)
  34
  35 /* SCxSR SCI */
  36 #define SCI_TDRE  0x80
  37 #define SCI_RDRF  0x40
  38 #define SCI_ORER  0x20
  39 #define SCI_FER   0x10
  40 #define SCI_PER   0x08
  41 #define SCI_TEND  0x04
  42
  43 #define SCI_DEFAULT_ERROR_MASK (SCI_PER | SCI_FER)
  44
  45 /* SCxSR SCIF, HSCIF */
  46 #define SCIF_ER    0x0080
  47 #define SCIF_TEND  0x0040
  48 #define SCIF_TDFE  0x0020
  49 #define SCIF_BRK   0x0010
  50 #define SCIF_FER   0x0008
  51 #define SCIF_PER   0x0004
  52 #define SCIF_RDF   0x0002
  53 #define SCIF_DR    0x0001
  54
  55 #define SCIF_DEFAULT_ERROR_MASK (SCIF_PER | SCIF_FER | SCIF_ER | SCIF_BRK)
  56
  57 /* SCSPTR, optional */
  58 #define SCSPTR_RTSIO    (1 << 7)
  59 #define SCSPTR_CTSIO    (1 << 5)
  60 #define SCSPTR_SPB2IO   (1 << 1)
  61 #define SCSPTR_SPB2DT   (1 << 0)
  62
  63 /* HSSRR HSCIF */
  64 #define HSCIF_SRE       0x8000
  65
  66 /* Offsets into the sci_port->irqs array */
  67 enum {
  68         SCIx_ERI_IRQ,
  69         SCIx_RXI_IRQ,
  70         SCIx_TXI_IRQ,
  71         SCIx_BRI_IRQ,
  72         SCIx_NR_IRQS,
  73
  74         SCIx_MUX_IRQ = SCIx_NR_IRQS,    /* special case */
  75 };
  76
  77 /* Offsets into the sci_port->gpios array */
  78 enum {
  79         SCIx_SCK,
  80         SCIx_RXD,
  81         SCIx_TXD,
  82         SCIx_CTS,
  83         SCIx_RTS,
  84
  85         SCIx_NR_FNS,
  86 };
  87
  88 enum {
  89         SCIx_PROBE_REGTYPE,
  90
  91         SCIx_SCI_REGTYPE,
  92         SCIx_IRDA_REGTYPE,
  93         SCIx_SCIFA_REGTYPE,
  94         SCIx_SCIFB_REGTYPE,
  95         SCIx_SH2_SCIF_FIFODATA_REGTYPE,
  96         SCIx_SH3_SCIF_REGTYPE,
  97         SCIx_SH4_SCIF_REGTYPE,
  98         SCIx_SH4_SCIF_NO_SCSPTR_REGTYPE,
  99         SCIx_SH4_SCIF_FIFODATA_REGTYPE,
 100         SCIx_SH7705_SCIF_REGTYPE,
 101         SCIx_HSCIF_REGTYPE,
 102
 103         SCIx_NR_REGTYPES,
 104 };
 105
 106 #define SCIx_IRQ_MUXED(irq)             \
 107 {                                       \
 108         [SCIx_ERI_IRQ]  = (irq),        \
 109         [SCIx_RXI_IRQ]  = (irq),        \
 110         [SCIx_TXI_IRQ]  = (irq),        \
 111         [SCIx_BRI_IRQ]  = (irq),        \
 112 }
 113
 114 #define SCIx_IRQ_IS_MUXED(port)                 \
 115         ((port)->cfg->irqs[SCIx_ERI_IRQ] ==     \
 116          (port)->cfg->irqs[SCIx_RXI_IRQ]) ||    \
 117         ((port)->cfg->irqs[SCIx_ERI_IRQ] &&     \
 118          !(port)->cfg->irqs[SCIx_RXI_IRQ])
 119 /*
 120  * SCI register subset common for all port types.
 121  * Not all registers will exist on all parts.
 122  */
 123 enum {
 124         SCSMR, SCBRR, SCSCR, SCxSR,
 125         SCFCR, SCFDR, SCxTDR, SCxRDR,
 126         SCLSR, SCTFDR, SCRFDR, SCSPTR,
 127         HSSRR,
 128
 129         SCIx_NR_REGS,
 130 };
 131
 132 struct device;
 133
 134 struct plat_sci_port_ops {
 135         void (*init_pins)(struct uart_port *, unsigned int cflag);
 136 };
 137
 138 /*
 139  * Port-specific capabilities
 140  */
 141 #define SCIx_HAVE_RTSCTS        (1 << 0)
 142
 143 /*
 144  * Platform device specific platform_data struct
 145  */
 146 struct plat_sci_port {
 147         unsigned long   mapbase;                /* resource base */
 148         unsigned int    irqs[SCIx_NR_IRQS];     /* ERI, RXI, TXI, BRI */
 149         unsigned int    gpios[SCIx_NR_FNS];     /* SCK, RXD, TXD, CTS, RTS */
 150         unsigned int    type;                   /* SCI / SCIF / IRDA / HSCIF */
 151         upf_t           flags;                  /* UPF_* flags */
 152         unsigned long   capabilities;           /* Port features/capabilities */
 153
 154         unsigned int    scbrr_algo_id;          /* SCBRR calculation algo */
 155         unsigned int    scscr;                  /* SCSCR initialization */
 156
 157         /*
 158          * Platform overrides if necessary, defaults otherwise.
 159          */
 160         int             overrun_bit;
 161         unsigned int    error_mask;
 162
 163         int             port_reg;
 164         unsigned char   regshift;
 165         unsigned char   regtype;
 166
 167         struct plat_sci_port_ops        *ops;
 168
 169         unsigned int    dma_slave_tx;
 170         unsigned int    dma_slave_rx;
 171 };
 172
 173 #endif /* __LINUX_SERIAL_SCI_H */