1/*********************************************************************
2 *
3 * Description:   Definitions for the SMC IrCC chipset
4 * Status:        Experimental.
5 * Author:        Daniele Peri (peri@csai.unipa.it)
6 *
7 *     Copyright (c) 2002      Daniele Peri
8 *     All Rights Reserved.
9 *
10 * Based on smc-ircc.h:
11 *
12 *     Copyright (c) 1999-2000, Dag Brattli <dagb@cs.uit.no>
13 *     Copyright (c) 1998-1999, Thomas Davis (tadavis@jps.net>
14 *     All Rights Reserved
15 *
16 *
17 *     This program is free software; you can redistribute it and/or
18 *     modify it under the terms of the GNU General Public License as
19 *     published by the Free Software Foundation; either version 2 of
20 *     the License, or (at your option) any later version.
21 *
22 *     This program is distributed in the hope that it will be useful,
23 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
24 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 *     GNU General Public License for more details.
26 *
27 *     You should have received a copy of the GNU General Public License
28 *     along with this program; if not, see <http://www.gnu.org/licenses/>.
29 *
30 ********************************************************************/
31
32#ifndef SMSC_IRCC2_H
33#define SMSC_IRCC2_H
34
35/* DMA modes needed */
36#define DMA_TX_MODE                0x08    /* Mem to I/O, ++, demand. */
37#define DMA_RX_MODE                0x04    /* I/O to mem, ++, demand. */
38
39/* Master Control Register */
40#define IRCC_MASTER                0x07
41#define   IRCC_MASTER_POWERDOWN	   0x80
42#define   IRCC_MASTER_RESET        0x40
43#define   IRCC_MASTER_INT_EN       0x20
44#define   IRCC_MASTER_ERROR_RESET  0x10
45
46/* Register block 0 */
47
48/* Interrupt Identification */
49#define IRCC_IIR					0x01
50#define   IRCC_IIR_ACTIVE_FRAME		0x80
51#define   IRCC_IIR_EOM				0x40
52#define   IRCC_IIR_RAW_MODE			0x20
53#define   IRCC_IIR_FIFO				0x10
54
55/* Interrupt Enable */
56#define IRCC_IER					0x02
57#define   IRCC_IER_ACTIVE_FRAME		0x80
58#define   IRCC_IER_EOM				0x40
59#define   IRCC_IER_RAW_MODE			0x20
60#define   IRCC_IER_FIFO				0x10
61
62/* Line Status Register */
63#define IRCC_LSR					0x03
64#define   IRCC_LSR_UNDERRUN			0x80
65#define   IRCC_LSR_OVERRUN			0x40
66#define   IRCC_LSR_FRAME_ERROR		0x20
67#define   IRCC_LSR_SIZE_ERROR		0x10
68#define   IRCC_LSR_CRC_ERROR		0x80
69#define   IRCC_LSR_FRAME_ABORT		0x40
70
71/* Line Status Address Register */
72#define IRCC_LSAR					0x03
73#define IRCC_LSAR_ADDRESS_MASK		0x07
74
75/* Line Control Register A */
76#define IRCC_LCR_A                 0x04
77#define   IRCC_LCR_A_FIFO_RESET    0x80
78#define   IRCC_LCR_A_FAST          0x40
79#define   IRCC_LCR_A_GP_DATA       0x20
80#define   IRCC_LCR_A_RAW_TX        0x10
81#define   IRCC_LCR_A_RAW_RX        0x08
82#define   IRCC_LCR_A_ABORT         0x04
83#define   IRCC_LCR_A_DATA_DONE     0x02
84
85/* Line Control Register B */
86#define IRCC_LCR_B                 0x05
87#define   IRCC_LCR_B_SCE_DISABLED  0x00
88#define   IRCC_LCR_B_SCE_TRANSMIT  0x40
89#define   IRCC_LCR_B_SCE_RECEIVE   0x80
90#define   IRCC_LCR_B_SCE_UNDEFINED 0xc0
91#define   IRCC_LCR_B_SIP_ENABLE	   0x20
92#define   IRCC_LCR_B_BRICK_WALL    0x10
93
94/* Bus Status Register */
95#define IRCC_BSR                   0x06
96#define   IRCC_BSR_NOT_EMPTY	   0x80
97#define   IRCC_BSR_FIFO_FULL	   0x40
98#define   IRCC_BSR_TIMEOUT	   0x20
99
100/* Register block 1 */
101
102#define IRCC_FIFO_THRESHOLD			0x02
103
104#define IRCC_SCE_CFGA				0x00
105#define   IRCC_CFGA_AUX_IR			0x80
106#define   IRCC_CFGA_HALF_DUPLEX		0x04
107#define   IRCC_CFGA_TX_POLARITY		0x02
108#define   IRCC_CFGA_RX_POLARITY		0x01
109
110#define   IRCC_CFGA_COM				0x00
111#define		IRCC_SCE_CFGA_BLOCK_CTRL_BITS_MASK	0x87
112#define		IRCC_CFGA_IRDA_SIR_A	0x08
113#define		IRCC_CFGA_ASK_SIR		0x10
114#define		IRCC_CFGA_IRDA_SIR_B	0x18
115#define		IRCC_CFGA_IRDA_HDLC		0x20
116#define		IRCC_CFGA_IRDA_4PPM		0x28
117#define		IRCC_CFGA_CONSUMER		0x30
118#define		IRCC_CFGA_RAW_IR		0x38
119#define     IRCC_CFGA_OTHER			0x40
120
121#define IRCC_IR_HDLC               0x04
122#define IRCC_IR_4PPM               0x01
123#define IRCC_IR_CONSUMER           0x02
124
125#define IRCC_SCE_CFGB	           0x01
126#define IRCC_CFGB_LOOPBACK         0x20
127#define IRCC_CFGB_LPBCK_TX_CRC	   0x10
128#define IRCC_CFGB_NOWAIT	   0x08
129#define IRCC_CFGB_STRING_MOVE	   0x04
130#define IRCC_CFGB_DMA_BURST	   0x02
131#define IRCC_CFGB_DMA_ENABLE	   0x01
132
133#define IRCC_CFGB_MUX_COM          0x00
134#define IRCC_CFGB_MUX_IR           0x40
135#define IRCC_CFGB_MUX_AUX          0x80
136#define IRCC_CFGB_MUX_INACTIVE	   0xc0
137
138/* Register block 3 - Identification Registers! */
139#define IRCC_ID_HIGH	           0x00   /* 0x10 */
140#define IRCC_ID_LOW	           0x01   /* 0xB8 */
141#define IRCC_CHIP_ID	           0x02   /* 0xF1 */
142#define IRCC_VERSION	           0x03   /* 0x01 */
143#define IRCC_INTERFACE	           0x04   /* low 4 = DMA, high 4 = IRQ */
144#define		IRCC_INTERFACE_DMA_MASK	0x0F   /* low 4 = DMA, high 4 = IRQ */
145#define		IRCC_INTERFACE_IRQ_MASK	0xF0   /* low 4 = DMA, high 4 = IRQ */
146
147/* Register block 4 - IrDA */
148#define IRCC_CONTROL               0x00
149#define IRCC_BOF_COUNT_LO          0x01 /* Low byte */
150#define IRCC_BOF_COUNT_HI          0x00 /* High nibble (bit 0-3) */
151#define IRCC_BRICKWALL_CNT_LO      0x02 /* Low byte */
152#define IRCC_BRICKWALL_CNT_HI      0x03 /* High nibble (bit 4-7) */
153#define IRCC_TX_SIZE_LO            0x04 /* Low byte */
154#define IRCC_TX_SIZE_HI            0x03 /* High nibble (bit 0-3) */
155#define IRCC_RX_SIZE_HI            0x05 /* High nibble (bit 0-3) */
156#define IRCC_RX_SIZE_LO            0x06 /* Low byte */
157
158#define IRCC_1152                  0x80
159#define IRCC_CRC                   0x40
160
161/* Register block 5 - IrDA */
162#define IRCC_ATC					0x00
163#define		IRCC_ATC_nPROGREADY		0x80
164#define		IRCC_ATC_SPEED			0x40
165#define		IRCC_ATC_ENABLE			0x20
166#define		IRCC_ATC_MASK			0xE0
167
168
169#define IRCC_IRHALFDUPLEX_TIMEOUT	0x01
170
171#define IRCC_SCE_TX_DELAY_TIMER		0x02
172
173/*
174 * Other definitions
175 */
176
177#define SMSC_IRCC2_MAX_SIR_SPEED		115200
178#define SMSC_IRCC2_FIR_CHIP_IO_EXTENT	8
179#define SMSC_IRCC2_SIR_CHIP_IO_EXTENT	8
180#define SMSC_IRCC2_FIFO_SIZE			16
181#define SMSC_IRCC2_FIFO_THRESHOLD		64
182/* Max DMA buffer size needed = (data_size + 6) * (window_size) + 6; */
183#define SMSC_IRCC2_RX_BUFF_TRUESIZE		14384
184#define SMSC_IRCC2_TX_BUFF_TRUESIZE		14384
185#define SMSC_IRCC2_MIN_TURN_TIME		0x07
186#define SMSC_IRCC2_WINDOW_SIZE			0x07
187/* Maximum wait for hw transmitter to finish */
188#define SMSC_IRCC2_HW_TRANSMITTER_TIMEOUT_US	1000	/* 1 ms */
189/* Maximum wait for ATC transceiver programming to finish */
190#define SMSC_IRCC2_ATC_PROGRAMMING_TIMEOUT_JIFFIES 1
191#endif /* SMSC_IRCC2_H */
192