2  *      linux/drivers/char/cd1865.h -- Definitions relating to the CD1865
 
   3  *                          for the Specialix IO8+ multiport serial driver.
 
   5  *      Copyright (C) 1997 Roger Wolff (R.E.Wolff@BitWizard.nl)
 
   6  *      Copyright (C) 1994-1996  Dmitry Gorodchanin (pgmdsg@ibi.com)
 
   8  *      Specialix pays for the development and support of this driver.
 
   9  *      Please DO contact io8-linux@specialix.co.uk if you require
 
  12  *      This driver was developped in the BitWizard linux device
 
  13  *      driver service. If you require a linux device driver for your
 
  14  *      product, please contact devices@BitWizard.nl for a quote.
 
  19  * Definitions for Driving CD180/CD1864/CD1865 based eightport serial cards.
 
  23 /* Values of choice for Interrupt ACKs */
 
  24 /* These values are "obligatory" if you use the register based
 
  25  * interrupt acknowledgements. See page 99-101 of V2.0 of the CD1865
 
  27 #define SX_ACK_MINT     0x75    /* goes to PILR1                           */
 
  28 #define SX_ACK_TINT     0x76    /* goes to PILR2                           */
 
  29 #define SX_ACK_RINT     0x77    /* goes to PILR3                           */
 
  31 /* Chip ID (is used when chips ar daisy chained.) */
 
  34 /* Definitions for Cirrus Logic CL-CD186x 8-port async mux chip */
 
  36 #define CD186x_NCH       8       /* Total number of channels                */
 
  37 #define CD186x_TPC       16      /* Ticks per character                     */
 
  38 #define CD186x_NFIFO     8       /* TX FIFO size                            */
 
  41 /* Global registers */
 
  43 #define CD186x_GIVR      0x40    /* Global Interrupt Vector Register        */
 
  44 #define CD186x_GICR      0x41    /* Global Interrupting Channel Register    */
 
  45 #define CD186x_PILR1     0x61    /* Priority Interrupt Level Register 1     */
 
  46 #define CD186x_PILR2     0x62    /* Priority Interrupt Level Register 2     */
 
  47 #define CD186x_PILR3     0x63    /* Priority Interrupt Level Register 3     */
 
  48 #define CD186x_CAR       0x64    /* Channel Access Register                 */
 
  49 #define CD186x_SRSR      0x65    /* Channel Access Register                 */
 
  50 #define CD186x_GFRCR     0x6b    /* Global Firmware Revision Code Register  */
 
  51 #define CD186x_PPRH      0x70    /* Prescaler Period Register High          */
 
  52 #define CD186x_PPRL      0x71    /* Prescaler Period Register Low           */
 
  53 #define CD186x_RDR       0x78    /* Receiver Data Register                  */
 
  54 #define CD186x_RCSR      0x7a    /* Receiver Character Status Register      */
 
  55 #define CD186x_TDR       0x7b    /* Transmit Data Register                  */
 
  56 #define CD186x_EOIR      0x7f    /* End of Interrupt Register               */
 
  57 #define CD186x_MRAR      0x75    /* Modem Request Acknowledge register       */
 
  58 #define CD186x_TRAR      0x76    /* Transmit Request Acknowledge register    */
 
  59 #define CD186x_RRAR      0x77    /* Receive Request Acknowledge register     */
 
  60 #define CD186x_SRCR      0x66    /* Service Request Configuration register  */
 
  62 /* Channel Registers */
 
  64 #define CD186x_CCR       0x01    /* Channel Command Register                */
 
  65 #define CD186x_IER       0x02    /* Interrupt Enable Register               */
 
  66 #define CD186x_COR1      0x03    /* Channel Option Register 1               */
 
  67 #define CD186x_COR2      0x04    /* Channel Option Register 2               */
 
  68 #define CD186x_COR3      0x05    /* Channel Option Register 3               */
 
  69 #define CD186x_CCSR      0x06    /* Channel Control Status Register         */
 
  70 #define CD186x_RDCR      0x07    /* Receive Data Count Register             */
 
  71 #define CD186x_SCHR1     0x09    /* Special Character Register 1            */
 
  72 #define CD186x_SCHR2     0x0a    /* Special Character Register 2            */
 
  73 #define CD186x_SCHR3     0x0b    /* Special Character Register 3            */
 
  74 #define CD186x_SCHR4     0x0c    /* Special Character Register 4            */
 
  75 #define CD186x_MCOR1     0x10    /* Modem Change Option 1 Register          */
 
  76 #define CD186x_MCOR2     0x11    /* Modem Change Option 2 Register          */
 
  77 #define CD186x_MCR       0x12    /* Modem Change Register                   */
 
  78 #define CD186x_RTPR      0x18    /* Receive Timeout Period Register         */
 
  79 #define CD186x_MSVR      0x28    /* Modem Signal Value Register             */
 
  80 #define CD186x_MSVRTS    0x29    /* Modem Signal Value Register             */
 
  81 #define CD186x_MSVDTR    0x2a    /* Modem Signal Value Register             */
 
  82 #define CD186x_RBPRH     0x31    /* Receive Baud Rate Period Register High  */
 
  83 #define CD186x_RBPRL     0x32    /* Receive Baud Rate Period Register Low   */
 
  84 #define CD186x_TBPRH     0x39    /* Transmit Baud Rate Period Register High */
 
  85 #define CD186x_TBPRL     0x3a    /* Transmit Baud Rate Period Register Low  */
 
  88 /* Global Interrupt Vector Register (R/W) */
 
  90 #define GIVR_ITMASK     0x07     /* Interrupt type mask                     */
 
  91 #define  GIVR_IT_MODEM   0x01    /* Modem Signal Change Interrupt           */
 
  92 #define  GIVR_IT_TX      0x02    /* Transmit Data Interrupt                 */
 
  93 #define  GIVR_IT_RCV     0x03    /* Receive Good Data Interrupt             */
 
  94 #define  GIVR_IT_REXC    0x07    /* Receive Exception Interrupt             */
 
  97 /* Global Interrupt Channel Register (R/W) */
 
  99 #define GICR_CHAN       0x1c    /* Channel Number Mask                     */
 
 100 #define GICR_CHAN_OFF   2       /* Channel Number shift                    */
 
 103 /* Channel Address Register (R/W) */
 
 105 #define CAR_CHAN        0x07    /* Channel Number Mask                     */
 
 106 #define CAR_A7          0x08    /* A7 Address Extension (unused)           */
 
 109 /* Receive Character Status Register (R/O) */
 
 111 #define RCSR_TOUT       0x80    /* Rx Timeout                              */
 
 112 #define RCSR_SCDET      0x70    /* Special Character Detected Mask         */
 
 113 #define  RCSR_NO_SC      0x00   /* No Special Characters Detected          */
 
 114 #define  RCSR_SC_1       0x10   /* Special Char 1 (or 1 & 3) Detected      */
 
 115 #define  RCSR_SC_2       0x20   /* Special Char 2 (or 2 & 4) Detected      */
 
 116 #define  RCSR_SC_3       0x30   /* Special Char 3 Detected                 */
 
 117 #define  RCSR_SC_4       0x40   /* Special Char 4 Detected                 */
 
 118 #define RCSR_BREAK      0x08    /* Break has been detected                 */
 
 119 #define RCSR_PE         0x04    /* Parity Error                            */
 
 120 #define RCSR_FE         0x02    /* Frame Error                             */
 
 121 #define RCSR_OE         0x01    /* Overrun Error                           */
 
 124 /* Channel Command Register (R/W) (commands in groups can be OR-ed) */
 
 126 #define CCR_HARDRESET   0x81    /* Reset the chip                          */
 
 128 #define CCR_SOFTRESET   0x80    /* Soft Channel Reset                      */
 
 130 #define CCR_CORCHG1     0x42    /* Channel Option Register 1 Changed       */
 
 131 #define CCR_CORCHG2     0x44    /* Channel Option Register 2 Changed       */
 
 132 #define CCR_CORCHG3     0x48    /* Channel Option Register 3 Changed       */
 
 134 #define CCR_SSCH1       0x21    /* Send Special Character 1                */
 
 136 #define CCR_SSCH2       0x22    /* Send Special Character 2                */
 
 138 #define CCR_SSCH3       0x23    /* Send Special Character 3                */
 
 140 #define CCR_SSCH4       0x24    /* Send Special Character 4                */
 
 142 #define CCR_TXEN        0x18    /* Enable Transmitter                      */
 
 143 #define CCR_RXEN        0x12    /* Enable Receiver                         */
 
 145 #define CCR_TXDIS       0x14    /* Disable Transmitter                     */
 
 146 #define CCR_RXDIS       0x11    /* Disable Receiver                        */
 
 149 /* Interrupt Enable Register (R/W) */
 
 151 #define IER_DSR         0x80    /* Enable interrupt on DSR change          */
 
 152 #define IER_CD          0x40    /* Enable interrupt on CD change           */
 
 153 #define IER_CTS         0x20    /* Enable interrupt on CTS change          */
 
 154 #define IER_RXD         0x10    /* Enable interrupt on Receive Data        */
 
 155 #define IER_RXSC        0x08    /* Enable interrupt on Receive Spec. Char  */
 
 156 #define IER_TXRDY       0x04    /* Enable interrupt on TX FIFO empty       */
 
 157 #define IER_TXEMPTY     0x02    /* Enable interrupt on TX completely empty */
 
 158 #define IER_RET         0x01    /* Enable interrupt on RX Exc. Timeout     */
 
 161 /* Channel Option Register 1 (R/W) */
 
 163 #define COR1_ODDP       0x80    /* Odd Parity                              */
 
 164 #define COR1_PARMODE    0x60    /* Parity Mode mask                        */
 
 165 #define  COR1_NOPAR      0x00   /* No Parity                               */
 
 166 #define  COR1_FORCEPAR   0x20   /* Force Parity                            */
 
 167 #define  COR1_NORMPAR    0x40   /* Normal Parity                           */
 
 168 #define COR1_IGNORE     0x10    /* Ignore Parity on RX                     */
 
 169 #define COR1_STOPBITS   0x0c    /* Number of Stop Bits                     */
 
 170 #define  COR1_1SB        0x00   /* 1 Stop Bit                              */
 
 171 #define  COR1_15SB       0x04   /* 1.5 Stop Bits                           */
 
 172 #define  COR1_2SB        0x08   /* 2 Stop Bits                             */
 
 173 #define COR1_CHARLEN    0x03    /* Character Length                        */
 
 174 #define  COR1_5BITS      0x00   /* 5 bits                                  */
 
 175 #define  COR1_6BITS      0x01   /* 6 bits                                  */
 
 176 #define  COR1_7BITS      0x02   /* 7 bits                                  */
 
 177 #define  COR1_8BITS      0x03   /* 8 bits                                  */
 
 180 /* Channel Option Register 2 (R/W) */
 
 182 #define COR2_IXM        0x80    /* Implied XON mode                        */
 
 183 #define COR2_TXIBE      0x40    /* Enable In-Band (XON/XOFF) Flow Control  */
 
 184 #define COR2_ETC        0x20    /* Embedded Tx Commands Enable             */
 
 185 #define COR2_LLM        0x10    /* Local Loopback Mode                     */
 
 186 #define COR2_RLM        0x08    /* Remote Loopback Mode                    */
 
 187 #define COR2_RTSAO      0x04    /* RTS Automatic Output Enable             */
 
 188 #define COR2_CTSAE      0x02    /* CTS Automatic Enable                    */
 
 189 #define COR2_DSRAE      0x01    /* DSR Automatic Enable                    */
 
 192 /* Channel Option Register 3 (R/W) */
 
 194 #define COR3_XONCH      0x80    /* XON is a pair of characters (1 & 3)     */
 
 195 #define COR3_XOFFCH     0x40    /* XOFF is a pair of characters (2 & 4)    */
 
 196 #define COR3_FCT        0x20    /* Flow-Control Transparency Mode          */
 
 197 #define COR3_SCDE       0x10    /* Special Character Detection Enable      */
 
 198 #define COR3_RXTH       0x0f    /* RX FIFO Threshold value (1-8)           */
 
 201 /* Channel Control Status Register (R/O) */
 
 203 #define CCSR_RXEN       0x80    /* Receiver Enabled                        */
 
 204 #define CCSR_RXFLOFF    0x40    /* Receive Flow Off (XOFF was sent)        */
 
 205 #define CCSR_RXFLON     0x20    /* Receive Flow On (XON was sent)          */
 
 206 #define CCSR_TXEN       0x08    /* Transmitter Enabled                     */
 
 207 #define CCSR_TXFLOFF    0x04    /* Transmit Flow Off (got XOFF)            */
 
 208 #define CCSR_TXFLON     0x02    /* Transmit Flow On (got XON)              */
 
 211 /* Modem Change Option Register 1 (R/W) */
 
 213 #define MCOR1_DSRZD     0x80    /* Detect 0->1 transition of DSR           */
 
 214 #define MCOR1_CDZD      0x40    /* Detect 0->1 transition of CD            */
 
 215 #define MCOR1_CTSZD     0x20    /* Detect 0->1 transition of CTS           */
 
 216 #define MCOR1_DTRTH     0x0f    /* Auto DTR flow control Threshold (1-8)   */
 
 217 #define  MCOR1_NODTRFC   0x0     /* Automatic DTR flow control disabled     */
 
 220 /* Modem Change Option Register 2 (R/W) */
 
 222 #define MCOR2_DSROD     0x80    /* Detect 1->0 transition of DSR           */
 
 223 #define MCOR2_CDOD      0x40    /* Detect 1->0 transition of CD            */
 
 224 #define MCOR2_CTSOD     0x20    /* Detect 1->0 transition of CTS           */
 
 226 /* Modem Change Register (R/W) */
 
 228 #define MCR_DSRCHG      0x80    /* DSR Changed                             */
 
 229 #define MCR_CDCHG       0x40    /* CD Changed                              */
 
 230 #define MCR_CTSCHG      0x20    /* CTS Changed                             */
 
 233 /* Modem Signal Value Register (R/W) */
 
 235 #define MSVR_DSR        0x80    /* Current state of DSR input              */
 
 236 #define MSVR_CD         0x40    /* Current state of CD input               */
 
 237 #define MSVR_CTS        0x20    /* Current state of CTS input              */
 
 238 #define MSVR_DTR        0x02    /* Current state of DTR output             */
 
 239 #define MSVR_RTS        0x01    /* Current state of RTS output             */
 
 242 /* Escape characters */
 
 244 #define CD186x_C_ESC     0x00    /* Escape character                        */
 
 245 #define CD186x_C_SBRK    0x81    /* Start sending BREAK                     */
 
 246 #define CD186x_C_DELAY   0x82    /* Delay output                            */
 
 247 #define CD186x_C_EBRK    0x83    /* Stop sending BREAK                      */
 
 249 #define SRSR_RREQint     0x10    /* This chip wants "rec" serviced          */
 
 250 #define SRSR_TREQint     0x04    /* This chip wants "transmit" serviced     */
 
 251 #define SRSR_MREQint     0x01    /* This chip wants "mdm change" serviced   */
 
 255 #define SRCR_PKGTYPE    0x80
 
 256 #define SRCR_REGACKEN   0x40
 
 257 #define SRCR_DAISYEN    0x20
 
 258 #define SRCR_GLOBPRI    0x10
 
 259 #define SRCR_UNFAIR     0x08
 
 260 #define SRCR_AUTOPRI    0x02
 
 261 #define SRCR_PRISEL     0x01