xref: /netbsd/sys/dev/sbus/dbrireg.h (revision 042c09ad)
1 /*	$NetBSD: dbrireg.h,v 1.6 2008/05/09 03:12:49 macallan Exp $	*/
2 
3 /*
4  * Copyright (C) 1997 Rudolf Koenig (rfkoenig@immd4.informatik.uni-erlangen.de)
5  * Copyright (c) 1998, 1999 Brent Baccala (baccala@freesoft.org)
6  * Copyright (c) 2001, 2002 Jared D. McNeill <jmcneill@netbsd.org>
7  * Copyright (c) 2005 Michael Lorenz <macallan@netbsd.org>
8  * All rights reserved.
9  *
10  * This driver is losely based on a Linux driver written by Rudolf Koenig and
11  * Brent Baccala who kindly gave their permission to use their code in a
12  * BSD-licensed driver.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions
16  * are met:
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  * 2. Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the
21  *    documentation and/or other materials provided with the distribution.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
24  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
28  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
29  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  */
35 
36 #ifndef DBRI_REG_H
37 #define DBRI_REG_H
38 
39 #define DBRI_REG0		0x00L	/* status and control */
40 #define	  DBRI_COMMAND_VALID	(1<<15)
41 #define   DBRI_BURST_4		(1<<14)	/* allow 4-word sbus bursts */
42 #define   DBRI_BURST_16		(1<<13)	/* allow 16-word sbus bursts */
43 #define   DBRI_BURST_8		(1<<12)	/* allow 8-word sbus bursts */
44 #define	  DBRI_CHI_ACTIVATE	(1<<4)	/* allow activation of CHI interface */
45 #define	  DBRI_DISABLE_MASTER	(1<<2)	/* disable master mode */
46 #define   DBRI_SOFT_RESET	(1<<0)	/* soft reset */
47 #define	DBRI_REG1		0x04UL	/* mode and interrupt */
48 #define	  DBRI_MRR		(1<<4)	/* multiple error ack on sbus */
49 #define	  DBRI_MLE		(1<<3)	/* multiple late error on sbus */
50 #define	  DBRI_LBG		(1<<2)	/* lost bus grant on sbus */
51 #define	  DBRI_MBE		(1<<1)	/* burst error on sbus */
52 #define DBRI_REG2		0x08UL	/* parallel I/O */
53 #define	  DBRI_PIO2_ENABLE	(1<<6)	/* enable pin 2 */
54 #define	  DBRI_PIO_ENABLE_ALL	(0xf0)	/* enable all the pins */
55 #define	  DBRI_PIO3		(1<<3)	/* pin 3: 1: data mode, 0: ctrl mode */
56 #define	  DBRI_PIO2		(1<<2)	/* pin 2: 1: onboard PDN */	/* XXX according to SPARCbook manual this is RESET */
57 #define	  DBRI_PIO1		(1<<1)	/* pin 1: 0: reset */ 	/* XXX according to SPARCbook manual  this is PDN */
58 #define	  DBRI_PIO0		(1<<0)	/* pin 0: 1: speakerbox PDN */
59 #define DBRI_REG8		0x20UL	/* command queue pointer */
60 #define	  DBRI_COMMAND_WAIT	0x0
61 #define	  DBRI_COMMAND_PAUSE	0x1
62 #define	  DBRI_COMMAND_IIQ	0x3
63 #define	  DBRI_COMMAND_SDP	0x5
64 #define	  DBRI_COMMAND_CDP	0x6
65 #define	  DBRI_COMMAND_DTS	0x7
66 #define	  DBRI_COMMAND_SSP	0x8
67 #define	  DBRI_COMMAND_CHI	0x9
68 #define	  DBRI_COMMAND_CDM	0xe	/* CHI data mode */
69 
70 /* interrupts */
71 #define DBRI_INTR_BRDY		1	/* buffer ready for processing */
72 #define DBRI_INTR_CMDI		6	/* command has been read */
73 #define DBRI_INTR_XCMP		8	/* transmission of frame complete */
74 #define DBRI_INTR_SBRI		9	/* BRI status change info */
75 #define DBRI_INTR_FXDT		10	/* fixed data change */
76 #define DBRI_INTR_UNDR		15	/* DMA underrun */
77 
78 #define	DBRI_INTR_CMD		38
79 
80 /* setup data pipe */
81 /* IRM */
82 #define	DBRI_SDP_2SAME		(1<<18)	/* report 2nd time in a row recv val */
83 #define	DBRI_SDP_CHANGE		(2<<18)	/* report any changes */
84 #define	DBRI_SDP_EVERY		(3<<18) /* report any changes */
85 /* pipe data mode */
86 #define	DBRI_SDP_FIXED		(6<<13)	/* short only */
87 #define	DBRI_SDP_TO_SER		(1<<12)	/* direction */
88 #define DBRI_SDP_FROM_SER	(0<<12)	/* direction */
89 #define DBRI_SDP_CLEAR		(1<<7)	/* clear */
90 #define DBRI_SDP_VALID_POINTER	(1<<10)	/* pointer valid */
91 #define DBRI_SDP_MEM		(0<<13)	/* to/from memory */
92 #define DBRI_SDP_MSB		(1<<11)	/* bit order */
93 #define DBRI_SDP_LSB		(0<<11)	/* bit order */
94 
95 /* define time slot */
96 #define	DBRI_DTS_VI		(1<<17)	/* valid input time-slot descriptor */
97 #define	DBRI_DTS_VO		(1<<16)	/* valid output time-slot descriptor */
98 #define	DBRI_DTS_INS		(1<<15)	/* insert time-slot */
99 #define	DBRI_DTS_DEL		(0<<15)	/* delete time-slot */
100 #define	DBRI_DTS_PRVIN(v)	((v)<<10)	/* previous in-pipe */
101 #define	DBRI_DTS_PRVOUT(v)	((v)<<5)	/* previous out-pipe */
102 
103 /* time slot defines */
104 #define	DBRI_TS_ANCHOR		(7<<10)	/* starting short pipes */
105 #define	DBRI_TS_NEXT(v)		((v)<<0) /* pipe #: 0-15 long, 16-21 short */
106 #define	DBRI_TS_LEN(v)		((v)<<24) /* # of bits in this timeslot */
107 #define	DBRI_TS_CYCLE(v)	((v)<<14) /* bit count at start of cycle */
108 
109 /* concentration highway interface (CHI) modes */
110 #define	DBRI_CHI_CHICM(v)	((v)<<16)	/* clock mode */
111 #define	DBRI_CHI_BPF(v)		((v)<<0)	/* bits per frame */
112 #define	DBRI_CHI_FD		(1<<11)	/* frame drive */
113 
114 /* CHI data mode */
115 #define	DBRI_CDM_XCE		(1<<2)	/* transmit on rising edge of CHICK */
116 #define	DBRI_CDM_XEN		(1<<1)	/* transmit highway enable */
117 #define	DBRI_CDM_REN		(1<<0)	/* receive highway enable */
118 
119 /* transmit descriptor defines */
120 #define	DBRI_TD_CNT(v)		((v)<<16) /* # valid bytes in buffer */
121 #define	DBRI_TD_STATUS(v)	((v)&0xff) /* transmit status */
122 #define	DBRI_TD_EOF		(1<<31)	/* end of frame */
123 #define	DBRI_TD_FINAL		(1<<15)	/* final interrupt */
124 #define	DBRI_TD_IDLE		(1<<13)	/* transmit idle characters */
125 #define	DBRI_TD_TBC		(1<<0)	/* transmit buffer complete */
126 
127 #endif /* DBRI_REG_H */
128