Expand PMF_FN_* macros.
[netbsd-mini2440.git] / sys / dev / sbus / spifreg.h
blob59e9bc7d80daebcda61c30f59a55fa1f5489b5c9
1 /* $NetBSD: spifreg.h,v 1.3 2009/05/12 13:20:06 cegger Exp $ */
2 /* $OpenBSD: spifreg.h,v 1.5 2003/06/02 18:32:41 jason Exp $ */
4 /*
5 * Copyright (c) 1999-2002 Jason L. Wright (jason@thought.net)
6 * All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
21 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
29 * Effort sponsored in part by the Defense Advanced Research Projects
30 * Agency (DARPA) and Air Force Research Laboratory, Air Force
31 * Materiel Command, USAF, under agreement number F30602-01-2-0537.
35 #define PPC_IN_PDATA 0x000 /* input data */
36 #define PPC_IN_PSTAT 0x001 /* input status */
37 #define PPC_IN_CTRL 0x002 /* input control */
38 #define PPC_IN_PWEIRD 0x003 /* input weird */
39 #define PPC_OUT_PDATA 0x000 /* output data */
40 #define PPC_OUT_PSTAT 0x001 /* output status */
41 #define PPC_OUT_PCTRL 0x002 /* output control */
42 #define PPC_OUT_PWEIRD 0x003 /* output weird */
43 #define PPC_IACK_PDATA 0x1fc /* iack data */
44 #define PPC_IACK_PSTAT 0x1fd /* iack status */
45 #define PPC_IACK_PCTRL 0x1fe /* iack control */
46 #define PPC_IACK_PWEIRD 0x1ff /* iack weird */
48 /* Parallel Status: read only */
49 #define PPC_PSTAT_ERROR 0x08 /* error */
50 #define PPC_PSTAT_SELECT 0x10 /* select */
51 #define PPC_PSTAT_PAPER 0x20 /* paper out */
52 #define PPC_PSTAT_ACK 0x40 /* ack */
53 #define PPC_PSTAT_BUSY 0x80 /* busy */
55 /* Parallel Control: read/write */
56 #define PPC_CTRL_STROBE 0x01 /* strobe, 1=drop strobe */
57 #define PPC_CTRL_AFX 0x02 /* auto form-feed */
58 #define PPC_CTRL_INIT 0x04 /* init, 1=enable printer */
59 #define PPC_CTRL_SLCT 0x08 /* SLC, 1=select printer */
60 #define PPC_CTRL_IRQE 0x10 /* IRQ, 1=enable intrs */
61 #define PPC_CTRL_OUTPUT 0x20 /* direction: 1=ppc out */
64 * The 'stc' is a Cirrus Logic CL-CD180 (either revision B or revision C)
66 #define STC_CCR 0x01 /* channel command */
67 #define STC_SRER 0x02 /* service request enable */
68 #define STC_COR1 0x03 /* channel option 1 */
69 #define STC_COR2 0x04 /* channel option 2 */
70 #define STC_COR3 0x05 /* channel option 3 */
71 #define STC_CCSR 0x06 /* channel control status */
72 #define STC_RDCR 0x07 /* rx data count */
73 #define STC_SCHR1 0x09 /* special character 1 */
74 #define STC_SCHR2 0x0a /* special character 2 */
75 #define STC_SCHR3 0x0b /* special character 3 */
76 #define STC_SCHR4 0x0c /* special character 4 */
77 #define STC_MCOR1 0x10 /* modem change option 1 */
78 #define STC_MCOR2 0x11 /* modem change option 2 */
79 #define STC_MCR 0x12 /* modem change */
80 #define STC_RTPR 0x18 /* rx timeout period */
81 #define STC_MSVR 0x28 /* modem signal value */
82 #define STC_MSVRTS 0x29 /* modem signal value rts */
83 #define STC_MSVDTR 0x2a /* modem signal value dtr */
84 #define STC_RBPRH 0x31 /* rx bit rate period high */
85 #define STC_RBPRL 0x32 /* rx bit rate period low */
86 #define STC_RBR 0x33 /* rx bit */
87 #define STC_TBPRH 0x39 /* tx bit rate period high */
88 #define STC_TBPRL 0x3a /* tx bit rate period low */
89 #define STC_GSVR 0x40 /* global service vector */
90 #define STC_GSCR1 0x41 /* global service channel 1 */
91 #define STC_GSCR2 0x42 /* global service channel 2 */
92 #define STC_GSCR3 0x43 /* global service channel 3 */
93 #define STC_MSMR 0x61 /* modem service match */
94 #define STC_TSMR 0x62 /* tx service match */
95 #define STC_RSMR 0x63 /* rx service match */
96 #define STC_CAR 0x64 /* channel access */
97 #define STC_SRSR 0x65 /* service request status */
98 #define STC_SRCR 0x66 /* service request config */
99 #define STC_GFRCR 0x6b /* global firmware rev code */
100 #define STC_PPRH 0x70 /* prescalar period high */
101 #define STC_PPRL 0x71 /* prescalar period low */
102 #define STC_MRAR 0x75 /* modem request ack */
103 #define STC_TRAR 0x76 /* tx request ack */
104 #define STC_RRAR 0x77 /* rx request ack */
105 #define STC_RDR 0x78 /* rx data */
106 #define STC_RCSR 0x7a /* rx character status */
107 #define STC_TDR 0x7b /* tx data */
108 #define STC_EOSRR 0x7f /* end of service */
110 #define STC_REGMAPSIZE 0x80
112 /* Global Firmware Revision Code Register (rw) */
113 #define CD180_GFRCR_REV_B 0x81 /* CL-CD180B */
114 #define CD180_GFRCR_REV_C 0x82 /* CL-CD180C */
116 /* Service Request Configuration Register (rw) (CD180C or higher) */
117 #define CD180_SRCR_PKGTYP 0x80 /* pkg type,0=PLCC,1=PQFP */
118 #define CD180_SRCR_REGACKEN 0x40 /* register ack enable */
119 #define CD180_SRCR_DAISYEN 0x20 /* daisy chain enable */
120 #define CD180_SRCR_GLOBPRI 0x10 /* global priority */
121 #define CD180_SRCR_UNFAIR 0x08 /* use unfair interrupts */
122 #define CD180_SRCR_AUTOPRI 0x02 /* automatic priority */
123 #define CD180_SRCR_PRISEL 0x01 /* select rx/tx as high pri */
125 /* Prescalar Period Register High (rw) */
126 #define CD180_PPRH 0xf0 /* high byte */
127 #define CD180_PPRL 0x00 /* low byte */
129 /* Global Service Vector Register (rw) */
130 /* Modem Request Acknowledgement Register (ro) (and IACK equivalent) */
131 /* Receive Request Acknowledgement Register (ro) (and IACK equivalent) */
132 /* Transmit Request Acknowledgement Register (ro) (and IACK equivalent) */
133 #define CD180_GSVR_USERMASK 0xf8 /* user defined bits */
134 #define CD180_GSVR_IMASK 0x07 /* interrupt type mask */
135 #define CD180_GSVR_NOREQUEST 0x00 /* no request pending */
136 #define CD180_GSVR_STATCHG 0x01 /* modem signal change */
137 #define CD180_GSVR_TXDATA 0x02 /* tx service request */
138 #define CD180_GSVR_RXGOOD 0x03 /* rx service request */
139 #define CD180_GSVR_reserved1 0x04 /* reserved */
140 #define CD180_GSVR_reserved2 0x05 /* reserved */
141 #define CD180_GSVR_reserved3 0x06 /* reserved */
142 #define CD180_GSVR_RXEXCEPTION 0x07 /* rx exception request */
144 /* Service Request Status Register (ro) (CD180C and higher) */
145 #define CD180_SRSR_MREQINT 0x01 /* modem request internal */
146 #define CD180_SRSR_MREQEXT 0x02 /* modem request external */
147 #define CD180_SRSR_TREQINT 0x04 /* tx request internal */
148 #define CD180_SRSR_TREQEXT 0x08 /* tx request external */
149 #define CD180_SRSR_RREQINT 0x10 /* rx request internal */
150 #define CD180_SRSR_RREQEXT 0x20 /* rx request external */
151 #define CD180_SRSR_ILV_MASK 0xc0 /* internal service context */
152 #define CD180_SRSR_ILV_NONE 0x00 /* not in service context */
153 #define CD180_SRSR_ILV_RX 0xc0 /* in rx service context */
154 #define CD180_SRSR_ILV_TX 0x80 /* in tx service context */
155 #define CD180_SRSR_ILV_MODEM 0x40 /* in modem service context */
157 /* Global Service Channel Register 1,2,3 (rw) */
158 #define CD180_GSCR_CHANNEL(gscr) (((gscr) >> 2) & 7)
160 /* Receive Data Count Register (ro) */
161 #define CD180_RDCR_MASK 0x0f /* mask for fifo length */
163 /* Receive Character Status Register (ro) */
164 #define CD180_RCSR_TO 0x80 /* time out */
165 #define CD180_RCSR_SCD2 0x40 /* special char detect 2 */
166 #define CD180_RCSR_SCD1 0x20 /* special char detect 1 */
167 #define CD180_RCSR_SCD0 0x10 /* special char detect 0 */
168 #define CD180_RCSR_BE 0x08 /* break exception */
169 #define CD180_RCSR_PE 0x04 /* parity exception */
170 #define CD180_RCSR_FE 0x02 /* framing exception */
171 #define CD180_RCSR_OE 0x01 /* overrun exception */
173 /* Service Request Enable Register (rw) */
174 #define CD180_SRER_DSR 0x80 /* DSR service request */
175 #define CD180_SRER_CD 0x40 /* CD service request */
176 #define CD180_SRER_CTS 0x20 /* CTS service request */
177 #define CD180_SRER_RXD 0x10 /* RXD service request */
178 #define CD180_SRER_RXSCD 0x08 /* RX special char request */
179 #define CD180_SRER_TXD 0x04 /* TX ready service request */
180 #define CD180_SRER_TXE 0x02 /* TX empty service request */
181 #define CD180_SRER_NNDT 0x01 /* No new data timeout req */
183 /* Channel Command Register (rw) */
184 /* Reset Channel Command */
185 #define CD180_CCR_CMD_RESET 0x80 /* chip/channel reset */
186 #define CD180_CCR_RESETALL 0x01 /* global reset */
187 #define CD180_CCR_RESETCHAN 0x00 /* current channel reset */
188 /* Channel Option Register Command */
189 #define CD180_CCR_CMD_COR 0x40 /* channel opt reg changed */
190 #define CD180_CCR_CORCHG1 0x02 /* cor1 has changed */
191 #define CD180_CCR_CORCHG2 0x04 /* cor2 has changed */
192 #define CD180_CCR_CORCHG3 0x08 /* cor3 has changed */
193 /* Send Special Character Command */
194 #define CD180_CCR_CMD_SPC 0x20 /* send special chars changed */
195 #define CD180_CCR_SSPC0 0x01 /* send special char 0 change */
196 #define CD180_CCR_SSPC1 0x02 /* send special char 1 change */
197 #define CD180_CCR_SSPC2 0x04 /* send special char 2 change */
198 /* Channel Control Command */
199 #define CD180_CCR_CMD_CHAN 0x10 /* channel control command */
200 #define CD180_CCR_CHAN_TXEN 0x08 /* enable channel tx */
201 #define CD180_CCR_CHAN_TXDIS 0x04 /* disable channel tx */
202 #define CD180_CCR_CHAN_RXEN 0x02 /* enable channel rx */
203 #define CD180_CCR_CHAN_RXDIS 0x01 /* disable channel rx */
205 /* Channel Option Register 1 (rw) */
206 #define CD180_COR1_EVENPAR 0x00 /* even parity */
207 #define CD180_COR1_ODDPAR 0x80 /* odd parity */
208 #define CD180_COR1_PARMODE_NO 0x00 /* no parity */
209 #define CD180_COR1_PARMODE_FORCE 0x20 /* force (odd=1, even=0) */
210 #define CD180_COR1_PARMODE_NORMAL 0x40 /* normal parity mode */
211 #define CD180_COR1_PARMODE_NA 0x60 /* notused */
212 #define CD180_COR1_IGNPAR 0x10 /* ignore parity */
213 #define CD180_COR1_STOP1 0x00 /* 1 stop bit */
214 #define CD180_COR1_STOP15 0x04 /* 1.5 stop bits */
215 #define CD180_COR1_STOP2 0x08 /* 2 stop bits */
216 #define CD180_COR1_STOP25 0x0c /* 2.5 stop bits */
217 #define CD180_COR1_CS5 0x00 /* 5 bit characters */
218 #define CD180_COR1_CS6 0x01 /* 6 bit characters */
219 #define CD180_COR1_CS7 0x02 /* 7 bit characters */
220 #define CD180_COR1_CS8 0x03 /* 8 bit characters */
222 /* Channel Option Register 2 (rw) */
223 #define CD180_COR2_IXM 0x80 /* implied xon mode */
224 #define CD180_COR2_TXIBE 0x40 /* tx in-band flow control */
225 #define CD180_COR2_ETC 0x20 /* embedded tx command enbl */
226 #define CD180_COR2_LLM 0x10 /* local loopback mode */
227 #define CD180_COR2_RLM 0x08 /* remote loopback mode */
228 #define CD180_COR2_RTSAO 0x04 /* RTS automatic output enbl */
229 #define CD180_COR2_CTSAE 0x02 /* CTS automatic enable */
230 #define CD180_COR2_DSRAE 0x01 /* DSR automatic enable */
232 /* Channel Option Register 3 (rw) */
233 #define CD180_COR3_XON2 0x80 /* XON char in spc1&3 */
234 #define CD180_COR3_XON1 0x00 /* XON char in spc1 */
235 #define CD180_COR3_XOFF2 0x40 /* XOFF char in spc2&4 */
236 #define CD180_COR3_XOFF1 0x00 /* XOFF char in spc2 */
237 #define CD180_COR3_FCT 0x20 /* flow control transparency */
238 #define CD180_COR3_SCDE 0x10 /* special char recognition */
239 #define CD180_COR3_RXFIFO_MASK 0x0f /* rx fifo threshold */
241 /* Channel Control Status Register (ro) */
242 #define CD180_CCSR_RXEN 0x80 /* rx is enabled */
243 #define CD180_CCSR_RXFLOFF 0x40 /* rx flow-off */
244 #define CD180_CCSR_RXFLON 0x20 /* rx flow-on */
245 #define CD180_CCSR_TXEN 0x08 /* tx is enabled */
246 #define CD180_CCSR_TXFLOFF 0x04 /* tx flow-off */
247 #define CD180_CCSR_TXFLON 0x02 /* tx flow-on */
249 /* Receiver Bit Register (ro) */
250 #define CD180_RBR_RXD 0x40 /* state of RxD pin */
251 #define CD180_RBR_STARTHUNT 0x20 /* looking for start bit */
253 /* Modem Change Register (rw) */
254 #define CD180_MCR_DSR 0x80 /* DSR changed */
255 #define CD180_MCR_CD 0x40 /* CD changed */
256 #define CD180_MCR_CTS 0x20 /* CTS changed */
258 /* Modem Change Option Register 1 (rw) */
259 #define CD180_MCOR1_DSRZD 0x80 /* catch 0->1 DSR changes */
260 #define CD180_MCOR1_CDZD 0x40 /* catch 0->1 CD changes */
261 #define CD180_MCOR1_CTSZD 0x40 /* catch 0->1 CTS changes */
262 #define CD180_MCOR1_DTRTHRESH 0x0f /* DTR threshold mask */
264 /* Modem Change Option Register 2 (rw) */
265 #define CD180_MCOR2_DSROD 0x80 /* catch 1->0 DSR changes */
266 #define CD180_MCOR2_CDOD 0x40 /* catch 1->0 CD changes */
267 #define CD180_MCOR2_CTSOD 0x20 /* catch 1->0 CTS changes */
269 /* Modem Signal Value Register (rw) */
270 #define CD180_MSVR_DSR 0x80 /* DSR input state */
271 #define CD180_MSVR_CD 0x40 /* CD input state */
272 #define CD180_MSVR_CTS 0x20 /* CTS input state */
273 #define CD180_MSVR_DTR 0x02 /* DTR output state */
274 #define CD180_MSVR_RTS 0x01 /* RTS output state */
276 /* Modem Signal Value Register - Request To Send (w) (CD180C and higher) */
277 #define CD180_MSVRTS_RTS 0x01 /* RTS signal value */
279 /* Modem Signal Value Register - Data Terminal Ready (w) (CD180C and higher) */
280 #define CD180_MSVDTR_DTR 0x02 /* DTR signal value */
283 * The register map for the SUNW,spif looks something like:
284 * Offset: Function:
285 * 0000 - 03ff Boot ROM
286 * 0400 - 0407 dtr latches (one per port)
287 * 0409 - 07ff unused
288 * 0800 - 087f CD180 registers (normal mapping)
289 * 0880 - 0bff unused
290 * 0c00 - 0c7f CD180 registers (*iack mapping)
291 * 0c80 - 0dff unused
292 * 0e00 - 1fff PPC registers
294 * One note about the DTR latches: The values stored there are reversed.
295 * By writing a 1 to the latch, DTR is lowered, and by writing a 0, DTR
296 * is raised. The latches cannot be read, and no other value can be written
297 * there or the system will crash due to "excessive bus loading (see
298 * SBus loading and capacitance spec)"
300 * The *iack registers are read/written with the IACK bit set. When
301 * the interrupt routine starts, it reads the MRAR, TRAR, and RRAR registers
302 * from this mapping. This signals an interrupt acknowledgement cycle.
303 * (NOTE: these are not really the MRAR, TRAR, and RRAR... They are copies
304 * of the GSVR, I just mapped them to the same location as the mrar, trar,
305 * and rrar because it seemed appropriate).
307 #define DTR_REG_OFFSET 0x400 /* DTR latches */
308 #define DTR_REG_LEN 0x8
309 #define STC_REG_OFFSET 0x800 /* normal cd180 access */
310 #define STC_REG_LEN 0x80
311 #define ISTC_REG_OFFSET 0xc00 /* IACK cd180 access */
312 #define ISTC_REG_LEN STC_REG_LEN
313 #define PPC_REG_OFFSET 0xe00 /* PPC registers */
314 #define PPC_REG_LEN 0x200
317 * The mapping of minor device number -> card and port is done as
318 * follows by default:
320 * +---+---+---+---+---+---+---+---+
321 * | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
322 * +---+---+---+---+---+---+---+---+
323 * | | | | | | | |
324 * | | | | | +---+---+---> port number
325 * | | | | |
326 * | | | | +---------------> unused
327 * | | | |
328 * | | | +-------------------> dialout (on tty ports)
329 * | | |
330 * | | +-----------------------> unused
331 * | |
332 * +---+---------------------------> card number
335 #define SPIF_MAX_CARDS 4
336 #define SPIF_MAX_TTY 8
337 #define SPIF_MAX_BPP 1
340 * device selectors
342 #define SPIF_CARD(x) ((minor(x) >> 6) & 0x03)
343 #define SPIF_PORT(x) (minor(x) & 0x07)
344 #define STTY_DIALOUT(x) (minor(x) & 0x10)
346 #define STTY_RX_FIFO_THRESHOLD 4
347 #define STTY_RX_DTR_THRESHOLD 7
348 #define CD180_TX_FIFO_SIZE 8 /* 8 chars of fifo */
351 * These are the offsets of the MRAR, TRAR, and RRAR in *IACK space.
352 * The high bit must be set as per specs for the MSMR, TSMR, and RSMR.
354 #define SPIF_MSMR (0x80 | STC_MRAR) /* offset of MRAR | 0x80 */
355 #define SPIF_TSMR (0x80 | STC_TRAR) /* offset of TRAR | 0x80 */
356 #define SPIF_RSMR (0x80 | STC_RRAR) /* offset of RRAR | 0x80 */
359 * "verosc" node tells which oscillator we have.
361 #define SPIF_OSC9 1 /* 9.8304 MHz */
362 #define SPIF_OSC10 2 /* 10MHz */
365 * There are two interrupts, serial gets interrupt[0], and parallel
366 * gets interrupt[1]
368 #define SERIAL_INTR 0
369 #define PARALLEL_INTR 1
372 * spif tty flags
374 #define STTYF_CDCHG 0x01 /* carrier changed */
375 #define STTYF_RING_OVERFLOW 0x02 /* ring buffer overflowed */
376 #define STTYF_DONE 0x04 /* done... flush buffers */
377 #define STTYF_SET_BREAK 0x08 /* set break signal */
378 #define STTYF_CLR_BREAK 0x10 /* clear break signal */
379 #define STTYF_STOP 0x20 /* stopped */
381 #define STTY_RBUF_SIZE (2 * 512)
384 * useful macros
386 #define SET(t, f) ((t) |= (f))
387 #define CLR(t, f) ((t) &= ~(f))
388 #define ISSET(t, f) ((t) & (f))
391 * internal function prototypes
393 int spif_match(device_t, cfdata_t, void *);
394 void spif_attach(device_t, device_t, void *);
396 int stty_match(device_t, cfdata_t, void *);
397 void stty_attach(device_t, device_t, void *);
399 int spif_stcintr(void *);
400 int spif_stcintr_mx(struct spif_softc *, int *);
401 int spif_stcintr_tx(struct spif_softc *, int *);
402 int spif_stcintr_rx(struct spif_softc *, int *);
403 int spif_stcintr_rxexception(struct spif_softc *, int *);
404 void spif_softintr(void *);
406 int stty_param(struct tty *, struct termios *);
407 int stty_modem_control(struct stty_port *, int, int);
408 void stty_write_ccr(struct spif_softc *, u_int8_t);
409 int stty_compute_baud(speed_t, int, u_int8_t *, u_int8_t *);
410 void stty_start(struct tty *);
412 int sbpp_match(device_t, cfdata_t, void *);
413 void sbpp_attach(device_t, device_t, void *);
415 int sbpp_rw(dev_t, struct uio *);
416 int spif_ppcintr(void *);