← Back to branch summary

~ubuntu-branches/ubuntu/precise/linux-ti-omap4/precise

« back to all changes in this revision

Viewing changes to drivers/staging/generic_serial/rio/cirrus.h

  • Committer: Bazaar Package Importer
  • Author(s): Paolo Pisati
  • Date: 2011-06-29 15:23:51 UTC
  • mfrom: (26.1.1 natty-proposed)
  • Revision ID: james.westby@ubuntu.com-20110629152351-xs96tm303d95rpbk
Tags: 3.0.0-1200.2
* Rebased against 3.0.0-6.7
* BSP from TI based on 3.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
drivers/staging/generic_serial/rio/cirrus.h
 
1
/****************************************************************************
 
2
 *******                                                              *******
 
3
 *******                CIRRUS.H                                      *******
 
4
 *******                                                              *******
 
5
 ****************************************************************************
 
6
 
 
7
 Author  : Jeremy Rolls
 
8
 Date    : 3 Aug 1990
 
9
 
 
10
 *
 
11
 *  (C) 1990 - 2000 Specialix International Ltd., Byfleet, Surrey, UK.
 
12
 *
 
13
 *      This program is free software; you can redistribute it and/or modify
 
14
 *      it under the terms of the GNU General Public License as published by
 
15
 *      the Free Software Foundation; either version 2 of the License, or
 
16
 *      (at your option) any later version.
 
17
 *
 
18
 *      This program is distributed in the hope that it will be useful,
 
19
 *      but WITHOUT ANY WARRANTY; without even the implied warranty of
 
20
 *      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
21
 *      GNU General Public License for more details.
 
22
 *
 
23
 *      You should have received a copy of the GNU General Public License
 
24
 *      along with this program; if not, write to the Free Software
 
25
 *      Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
26
 
 
27
 Version : 0.01
 
28
 
 
29
 
 
30
                            Mods
 
31
 ----------------------------------------------------------------------------
 
32
  Date     By                Description
 
33
 ----------------------------------------------------------------------------
 
34
 
 
35
 ***************************************************************************/
 
36
 
 
37
#ifndef _cirrus_h
 
38
#define _cirrus_h 1
 
39
 
 
40
/* Bit fields for particular registers shared with driver */
 
41
 
 
42
/* COR1 - driver and RTA */
 
43
#define RIOC_COR1_ODD           0x80    /* Odd parity */
 
44
#define RIOC_COR1_EVEN          0x00    /* Even parity */
 
45
#define RIOC_COR1_NOP           0x00    /* No parity */
 
46
#define RIOC_COR1_FORCE         0x20    /* Force parity */
 
47
#define RIOC_COR1_NORMAL        0x40    /* With parity */
 
48
#define RIOC_COR1_1STOP         0x00    /* 1 stop bit */
 
49
#define RIOC_COR1_15STOP        0x04    /* 1.5 stop bits */
 
50
#define RIOC_COR1_2STOP         0x08    /* 2 stop bits */
 
51
#define RIOC_COR1_5BITS         0x00    /* 5 data bits */
 
52
#define RIOC_COR1_6BITS         0x01    /* 6 data bits */
 
53
#define RIOC_COR1_7BITS         0x02    /* 7 data bits */
 
54
#define RIOC_COR1_8BITS         0x03    /* 8 data bits */
 
55
 
 
56
#define RIOC_COR1_HOST          0xef    /* Safe host bits */
 
57
 
 
58
/* RTA only */
 
59
#define RIOC_COR1_CINPCK        0x00    /* Check parity of received characters */
 
60
#define RIOC_COR1_CNINPCK       0x10    /* Don't check parity */
 
61
 
 
62
/* COR2 bits for both RTA and driver use */
 
63
#define RIOC_COR2_IXANY         0x80    /* IXANY - any character is XON */
 
64
#define RIOC_COR2_IXON          0x40    /* IXON - enable tx soft flowcontrol */
 
65
#define RIOC_COR2_RTSFLOW       0x02    /* Enable tx hardware flow control */
 
66
 
 
67
/* Additional driver bits */
 
68
#define RIOC_COR2_HUPCL         0x20    /* Hang up on close */
 
69
#define RIOC_COR2_CTSFLOW       0x04    /* Enable rx hardware flow control */
 
70
#define RIOC_COR2_IXOFF         0x01    /* Enable rx software flow control */
 
71
#define RIOC_COR2_DTRFLOW       0x08    /* Enable tx hardware flow control */
 
72
 
 
73
/* RTA use only */
 
74
#define RIOC_COR2_ETC           0x20    /* Embedded transmit options */
 
75
#define RIOC_COR2_LOCAL         0x10    /* Local loopback mode */
 
76
#define RIOC_COR2_REMOTE        0x08    /* Remote loopback mode */
 
77
#define RIOC_COR2_HOST          0xc2    /* Safe host bits */
 
78
 
 
79
/* COR3 - RTA use only */
 
80
#define RIOC_COR3_SCDRNG        0x80    /* Enable special char detect for range */
 
81
#define RIOC_COR3_SCD34         0x40    /* Special character detect for SCHR's 3 + 4 */
 
82
#define RIOC_COR3_FCT           0x20    /* Flow control transparency */
 
83
#define RIOC_COR3_SCD12         0x10    /* Special character detect for SCHR's 1 + 2 */
 
84
#define RIOC_COR3_FIFO12        0x0c    /* 12 chars for receive FIFO threshold */
 
85
#define RIOC_COR3_FIFO10        0x0a    /* 10 chars for receive FIFO threshold */
 
86
#define RIOC_COR3_FIFO8         0x08    /* 8 chars for receive FIFO threshold */
 
87
#define RIOC_COR3_FIFO6         0x06    /* 6 chars for receive FIFO threshold */
 
88
 
 
89
#define RIOC_COR3_THRESHOLD     RIOC_COR3_FIFO8 /* MUST BE LESS THAN MCOR_THRESHOLD */
 
90
 
 
91
#define RIOC_COR3_DEFAULT       (RIOC_COR3_FCT | RIOC_COR3_THRESHOLD)
 
92
                                /* Default bits for COR3 */
 
93
 
 
94
/* COR4 driver and RTA use */
 
95
#define RIOC_COR4_IGNCR         0x80    /* Throw away CR's on input */
 
96
#define RIOC_COR4_ICRNL         0x40    /* Map CR -> NL on input */
 
97
#define RIOC_COR4_INLCR         0x20    /* Map NL -> CR on input */
 
98
#define RIOC_COR4_IGNBRK        0x10    /* Ignore Break */
 
99
#define RIOC_COR4_NBRKINT       0x08    /* No interrupt on break (-BRKINT) */
 
100
#define RIOC_COR4_RAISEMOD      0x01    /* Raise modem output lines on non-zero baud */
 
101
 
 
102
 
 
103
/* COR4 driver only */
 
104
#define RIOC_COR4_IGNPAR        0x04    /* IGNPAR (ignore characters with errors) */
 
105
#define RIOC_COR4_PARMRK        0x02    /* PARMRK */
 
106
 
 
107
#define RIOC_COR4_HOST          0xf8    /* Safe host bits */
 
108
 
 
109
/* COR4 RTA only */
 
110
#define RIOC_COR4_CIGNPAR       0x02    /* Thrown away bad characters */
 
111
#define RIOC_COR4_CPARMRK       0x04    /* PARMRK characters */
 
112
#define RIOC_COR4_CNPARMRK      0x03    /* Don't PARMRK */
 
113
 
 
114
/* COR5 driver and RTA use */
 
115
#define RIOC_COR5_ISTRIP        0x80    /* Strip input chars to 7 bits */
 
116
#define RIOC_COR5_LNE           0x40    /* Enable LNEXT processing */
 
117
#define RIOC_COR5_CMOE          0x20    /* Match good and errored characters */
 
118
#define RIOC_COR5_ONLCR         0x02    /* NL -> CR NL on output */
 
119
#define RIOC_COR5_OCRNL         0x01    /* CR -> NL on output */
 
120
 
 
121
/*
 
122
** Spare bits - these are not used in the CIRRUS registers, so we use
 
123
** them to set various other features.
 
124
*/
 
125
/*
 
126
** tstop and tbusy indication
 
127
*/
 
128
#define RIOC_COR5_TSTATE_ON     0x08    /* Turn on monitoring of tbusy and tstop */
 
129
#define RIOC_COR5_TSTATE_OFF    0x04    /* Turn off monitoring of tbusy and tstop */
 
130
/*
 
131
** TAB3
 
132
*/
 
133
#define RIOC_COR5_TAB3          0x10    /* TAB3 mode */
 
134
 
 
135
#define RIOC_COR5_HOST          0xc3    /* Safe host bits */
 
136
 
 
137
/* CCSR */
 
138
#define RIOC_CCSR_TXFLOFF       0x04    /* Tx is xoffed */
 
139
 
 
140
/* MSVR1 */
 
141
/* NB. DTR / CD swapped from Cirrus spec as the pins are also reversed on the
 
142
   RTA. This is because otherwise DCD would get lost on the 1 parallel / 3
 
143
   serial option.
 
144
*/
 
145
#define RIOC_MSVR1_CD           0x80    /* CD (DSR on Cirrus) */
 
146
#define RIOC_MSVR1_RTS          0x40    /* RTS (CTS on Cirrus) */
 
147
#define RIOC_MSVR1_RI           0x20    /* RI */
 
148
#define RIOC_MSVR1_DTR          0x10    /* DTR (CD on Cirrus) */
 
149
#define RIOC_MSVR1_CTS          0x01    /* CTS output pin (RTS on Cirrus) */
 
150
/* Next two used to indicate state of tbusy and tstop to driver */
 
151
#define RIOC_MSVR1_TSTOP        0x08    /* Set if port flow controlled */
 
152
#define RIOC_MSVR1_TEMPTY       0x04    /* Set if port tx buffer empty */
 
153
 
 
154
#define RIOC_MSVR1_HOST         0xf3    /* The bits the host wants */
 
155
 
 
156
/* Defines for the subscripts of a CONFIG packet */
 
157
#define RIOC_CONFIG_COR1        1       /* Option register 1 */
 
158
#define RIOC_CONFIG_COR2        2       /* Option register 2 */
 
159
#define RIOC_CONFIG_COR4        3       /* Option register 4 */
 
160
#define RIOC_CONFIG_COR5        4       /* Option register 5 */
 
161
#define RIOC_CONFIG_TXXON       5       /* Tx XON character */
 
162
#define RIOC_CONFIG_TXXOFF      6       /* Tx XOFF character */
 
163
#define RIOC_CONFIG_RXXON       7       /* Rx XON character */
 
164
#define RIOC_CONFIG_RXXOFF      8       /* Rx XOFF character */
 
165
#define RIOC_CONFIG_LNEXT       9       /* LNEXT character */
 
166
#define RIOC_CONFIG_TXBAUD      10      /* Tx baud rate */
 
167
#define RIOC_CONFIG_RXBAUD      11      /* Rx baud rate */
 
168
 
 
169
#define RIOC_PRE_EMPTIVE        0x80    /* Pre-emptive bit in command field */
 
170
 
 
171
/* Packet types going from Host to remote - with the exception of OPEN, MOPEN,
 
172
   CONFIG, SBREAK and MEMDUMP the remaining bytes of the data array will not
 
173
   be used 
 
174
*/
 
175
#define RIOC_OPEN               0x00    /* Open a port */
 
176
#define RIOC_CONFIG             0x01    /* Configure a port */
 
177
#define RIOC_MOPEN              0x02    /* Modem open (block for DCD) */
 
178
#define RIOC_CLOSE              0x03    /* Close a port */
 
179
#define RIOC_WFLUSH             (0x04 | RIOC_PRE_EMPTIVE)       /* Write flush */
 
180
#define RIOC_RFLUSH             (0x05 | RIOC_PRE_EMPTIVE)       /* Read flush */
 
181
#define RIOC_RESUME             (0x06 | RIOC_PRE_EMPTIVE)       /* Resume if xoffed */
 
182
#define RIOC_SBREAK             0x07    /* Start break */
 
183
#define RIOC_EBREAK             0x08    /* End break */
 
184
#define RIOC_SUSPEND            (0x09 | RIOC_PRE_EMPTIVE)       /* Susp op (behave as tho xoffed) */
 
185
#define RIOC_FCLOSE             (0x0a | RIOC_PRE_EMPTIVE)       /* Force close */
 
186
#define RIOC_XPRINT             0x0b    /* Xprint packet */
 
187
#define RIOC_MBIS               (0x0c | RIOC_PRE_EMPTIVE)       /* Set modem lines */
 
188
#define RIOC_MBIC               (0x0d | RIOC_PRE_EMPTIVE)       /* Clear modem lines */
 
189
#define RIOC_MSET               (0x0e | RIOC_PRE_EMPTIVE)       /* Set modem lines */
 
190
#define RIOC_PCLOSE             0x0f    /* Pseudo close - Leaves rx/tx enabled */
 
191
#define RIOC_MGET               (0x10 | RIOC_PRE_EMPTIVE)       /* Force update of modem status */
 
192
#define RIOC_MEMDUMP            (0x11 | RIOC_PRE_EMPTIVE)       /* Send back mem from addr supplied */
 
193
#define RIOC_READ_REGISTER      (0x12 | RIOC_PRE_EMPTIVE)       /* Read CD1400 register (debug) */
 
194
 
 
195
/* "Command" packets going from remote to host COMPLETE and MODEM_STATUS
 
196
   use data[4] / data[3] to indicate current state and modem status respectively
 
197
*/
 
198
 
 
199
#define RIOC_COMPLETE           (0x20 | RIOC_PRE_EMPTIVE)
 
200
                                /* Command complete */
 
201
#define RIOC_BREAK_RECEIVED     (0x21 | RIOC_PRE_EMPTIVE)
 
202
                                /* Break received */
 
203
#define RIOC_MODEM_STATUS       (0x22 | RIOC_PRE_EMPTIVE)
 
204
                                /* Change in modem status */
 
205
 
 
206
/* "Command" packet that could go either way - handshake wake-up */
 
207
#define RIOC_HANDSHAKE          (0x23 | RIOC_PRE_EMPTIVE)
 
208
                                /* Wake-up to HOST / RTA */
 
209
 
 
210
#endif