blob: 1b7cd8d1a71b0e107651a1dce30ec303d3b0ae7b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * SyncLink Multiprotocol Serial Adapter Driver
3 *
Paul Fulghum705b6c72006-01-08 01:02:06 -08004 * $Id: synclink.h,v 3.10 2005/11/08 19:50:54 paulkf Exp $
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 *
6 * Copyright (C) 1998-2000 by Microgate Corporation
7 *
8 * Redistribution of this file is permitted under
9 * the terms of the GNU Public License (GPL)
10 */
11
12#ifndef _SYNCLINK_H_
13#define _SYNCLINK_H_
14#define SYNCLINK_H_VERSION 3.6
15
16#define BOOLEAN int
17#define TRUE 1
18#define FALSE 0
19
20#define BIT0 0x0001
21#define BIT1 0x0002
22#define BIT2 0x0004
23#define BIT3 0x0008
24#define BIT4 0x0010
25#define BIT5 0x0020
26#define BIT6 0x0040
27#define BIT7 0x0080
28#define BIT8 0x0100
29#define BIT9 0x0200
30#define BIT10 0x0400
31#define BIT11 0x0800
32#define BIT12 0x1000
33#define BIT13 0x2000
34#define BIT14 0x4000
35#define BIT15 0x8000
36#define BIT16 0x00010000
37#define BIT17 0x00020000
38#define BIT18 0x00040000
39#define BIT19 0x00080000
40#define BIT20 0x00100000
41#define BIT21 0x00200000
42#define BIT22 0x00400000
43#define BIT23 0x00800000
44#define BIT24 0x01000000
45#define BIT25 0x02000000
46#define BIT26 0x04000000
47#define BIT27 0x08000000
48#define BIT28 0x10000000
49#define BIT29 0x20000000
50#define BIT30 0x40000000
51#define BIT31 0x80000000
52
53
54#define HDLC_MAX_FRAME_SIZE 65535
55#define MAX_ASYNC_TRANSMIT 4096
56#define MAX_ASYNC_BUFFER_SIZE 4096
57
58#define ASYNC_PARITY_NONE 0
59#define ASYNC_PARITY_EVEN 1
60#define ASYNC_PARITY_ODD 2
61#define ASYNC_PARITY_SPACE 3
62
63#define HDLC_FLAG_UNDERRUN_ABORT7 0x0000
64#define HDLC_FLAG_UNDERRUN_ABORT15 0x0001
65#define HDLC_FLAG_UNDERRUN_FLAG 0x0002
66#define HDLC_FLAG_UNDERRUN_CRC 0x0004
67#define HDLC_FLAG_SHARE_ZERO 0x0010
68#define HDLC_FLAG_AUTO_CTS 0x0020
69#define HDLC_FLAG_AUTO_DCD 0x0040
70#define HDLC_FLAG_AUTO_RTS 0x0080
71#define HDLC_FLAG_RXC_DPLL 0x0100
72#define HDLC_FLAG_RXC_BRG 0x0200
73#define HDLC_FLAG_RXC_TXCPIN 0x8000
74#define HDLC_FLAG_RXC_RXCPIN 0x0000
75#define HDLC_FLAG_TXC_DPLL 0x0400
76#define HDLC_FLAG_TXC_BRG 0x0800
77#define HDLC_FLAG_TXC_TXCPIN 0x0000
78#define HDLC_FLAG_TXC_RXCPIN 0x0008
79#define HDLC_FLAG_DPLL_DIV8 0x1000
80#define HDLC_FLAG_DPLL_DIV16 0x2000
81#define HDLC_FLAG_DPLL_DIV32 0x0000
82#define HDLC_FLAG_HDLC_LOOPMODE 0x4000
83
84#define HDLC_CRC_NONE 0
85#define HDLC_CRC_16_CCITT 1
86#define HDLC_CRC_32_CCITT 2
87#define HDLC_CRC_MASK 0x00ff
88#define HDLC_CRC_RETURN_EX 0x8000
89
90#define RX_OK 0
91#define RX_CRC_ERROR 1
92
93#define HDLC_TXIDLE_FLAGS 0
94#define HDLC_TXIDLE_ALT_ZEROS_ONES 1
95#define HDLC_TXIDLE_ZEROS 2
96#define HDLC_TXIDLE_ONES 3
97#define HDLC_TXIDLE_ALT_MARK_SPACE 4
98#define HDLC_TXIDLE_SPACE 5
99#define HDLC_TXIDLE_MARK 6
100
101#define HDLC_ENCODING_NRZ 0
102#define HDLC_ENCODING_NRZB 1
103#define HDLC_ENCODING_NRZI_MARK 2
104#define HDLC_ENCODING_NRZI_SPACE 3
105#define HDLC_ENCODING_NRZI HDLC_ENCODING_NRZI_SPACE
106#define HDLC_ENCODING_BIPHASE_MARK 4
107#define HDLC_ENCODING_BIPHASE_SPACE 5
108#define HDLC_ENCODING_BIPHASE_LEVEL 6
109#define HDLC_ENCODING_DIFF_BIPHASE_LEVEL 7
110
111#define HDLC_PREAMBLE_LENGTH_8BITS 0
112#define HDLC_PREAMBLE_LENGTH_16BITS 1
113#define HDLC_PREAMBLE_LENGTH_32BITS 2
114#define HDLC_PREAMBLE_LENGTH_64BITS 3
115
116#define HDLC_PREAMBLE_PATTERN_NONE 0
117#define HDLC_PREAMBLE_PATTERN_ZEROS 1
118#define HDLC_PREAMBLE_PATTERN_FLAGS 2
119#define HDLC_PREAMBLE_PATTERN_10 3
120#define HDLC_PREAMBLE_PATTERN_01 4
121#define HDLC_PREAMBLE_PATTERN_ONES 5
122
123#define MGSL_MODE_ASYNC 1
124#define MGSL_MODE_HDLC 2
125#define MGSL_MODE_RAW 6
126
127#define MGSL_BUS_TYPE_ISA 1
128#define MGSL_BUS_TYPE_EISA 2
129#define MGSL_BUS_TYPE_PCI 5
130
Paul Fulghum705b6c72006-01-08 01:02:06 -0800131#define MGSL_INTERFACE_MASK 0xf
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132#define MGSL_INTERFACE_DISABLE 0
133#define MGSL_INTERFACE_RS232 1
134#define MGSL_INTERFACE_V35 2
135#define MGSL_INTERFACE_RS422 3
Paul Fulghum705b6c72006-01-08 01:02:06 -0800136#define MGSL_INTERFACE_RTS_EN 0x10
137#define MGSL_INTERFACE_LL 0x20
138#define MGSL_INTERFACE_RL 0x40
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
140typedef struct _MGSL_PARAMS
141{
142 /* Common */
143
144 unsigned long mode; /* Asynchronous or HDLC */
145 unsigned char loopback; /* internal loopback mode */
146
147 /* HDLC Only */
148
149 unsigned short flags;
150 unsigned char encoding; /* NRZ, NRZI, etc. */
151 unsigned long clock_speed; /* external clock speed in bits per second */
152 unsigned char addr_filter; /* receive HDLC address filter, 0xFF = disable */
153 unsigned short crc_type; /* None, CRC16-CCITT, or CRC32-CCITT */
154 unsigned char preamble_length;
155 unsigned char preamble;
156
157 /* Async Only */
158
159 unsigned long data_rate; /* bits per second */
160 unsigned char data_bits; /* 7 or 8 data bits */
161 unsigned char stop_bits; /* 1 or 2 stop bits */
162 unsigned char parity; /* none, even, or odd */
163
164} MGSL_PARAMS, *PMGSL_PARAMS;
165
166#define MICROGATE_VENDOR_ID 0x13c0
167#define SYNCLINK_DEVICE_ID 0x0010
168#define MGSCC_DEVICE_ID 0x0020
169#define SYNCLINK_SCA_DEVICE_ID 0x0030
Paul Fulghum705b6c72006-01-08 01:02:06 -0800170#define SYNCLINK_GT_DEVICE_ID 0x0070
171#define SYNCLINK_GT4_DEVICE_ID 0x0080
172#define SYNCLINK_AC_DEVICE_ID 0x0090
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173#define MGSL_MAX_SERIAL_NUMBER 30
174
175/*
176** device diagnostics status
177*/
178
179#define DiagStatus_OK 0
180#define DiagStatus_AddressFailure 1
181#define DiagStatus_AddressConflict 2
182#define DiagStatus_IrqFailure 3
183#define DiagStatus_IrqConflict 4
184#define DiagStatus_DmaFailure 5
185#define DiagStatus_DmaConflict 6
186#define DiagStatus_PciAdapterNotFound 7
187#define DiagStatus_CantAssignPciResources 8
188#define DiagStatus_CantAssignPciMemAddr 9
189#define DiagStatus_CantAssignPciIoAddr 10
190#define DiagStatus_CantAssignPciIrq 11
191#define DiagStatus_MemoryError 12
192
193#define SerialSignal_DCD 0x01 /* Data Carrier Detect */
194#define SerialSignal_TXD 0x02 /* Transmit Data */
195#define SerialSignal_RI 0x04 /* Ring Indicator */
196#define SerialSignal_RXD 0x08 /* Receive Data */
197#define SerialSignal_CTS 0x10 /* Clear to Send */
198#define SerialSignal_RTS 0x20 /* Request to Send */
199#define SerialSignal_DSR 0x40 /* Data Set Ready */
200#define SerialSignal_DTR 0x80 /* Data Terminal Ready */
201
202
203/*
204 * Counters of the input lines (CTS, DSR, RI, CD) interrupts
205 */
206struct mgsl_icount {
207 __u32 cts, dsr, rng, dcd, tx, rx;
208 __u32 frame, parity, overrun, brk;
209 __u32 buf_overrun;
210 __u32 txok;
211 __u32 txunder;
212 __u32 txabort;
213 __u32 txtimeout;
214 __u32 rxshort;
215 __u32 rxlong;
216 __u32 rxabort;
217 __u32 rxover;
218 __u32 rxcrc;
219 __u32 rxok;
220 __u32 exithunt;
221 __u32 rxidle;
222};
223
224
225#define DEBUG_LEVEL_DATA 1
226#define DEBUG_LEVEL_ERROR 2
227#define DEBUG_LEVEL_INFO 3
228#define DEBUG_LEVEL_BH 4
229#define DEBUG_LEVEL_ISR 5
230
231/*
232** Event bit flags for use with MgslWaitEvent
233*/
234
235#define MgslEvent_DsrActive 0x0001
236#define MgslEvent_DsrInactive 0x0002
237#define MgslEvent_Dsr 0x0003
238#define MgslEvent_CtsActive 0x0004
239#define MgslEvent_CtsInactive 0x0008
240#define MgslEvent_Cts 0x000c
241#define MgslEvent_DcdActive 0x0010
242#define MgslEvent_DcdInactive 0x0020
243#define MgslEvent_Dcd 0x0030
244#define MgslEvent_RiActive 0x0040
245#define MgslEvent_RiInactive 0x0080
246#define MgslEvent_Ri 0x00c0
247#define MgslEvent_ExitHuntMode 0x0100
248#define MgslEvent_IdleReceived 0x0200
249
250/* Private IOCTL codes:
251 *
252 * MGSL_IOCSPARAMS set MGSL_PARAMS structure values
253 * MGSL_IOCGPARAMS get current MGSL_PARAMS structure values
254 * MGSL_IOCSTXIDLE set current transmit idle mode
255 * MGSL_IOCGTXIDLE get current transmit idle mode
256 * MGSL_IOCTXENABLE enable or disable transmitter
257 * MGSL_IOCRXENABLE enable or disable receiver
258 * MGSL_IOCTXABORT abort transmitting frame (HDLC)
259 * MGSL_IOCGSTATS return current statistics
260 * MGSL_IOCWAITEVENT wait for specified event to occur
261 * MGSL_LOOPTXDONE transmit in HDLC LoopMode done
262 * MGSL_IOCSIF set the serial interface type
263 * MGSL_IOCGIF get the serial interface type
264 */
265#define MGSL_MAGIC_IOC 'm'
266#define MGSL_IOCSPARAMS _IOW(MGSL_MAGIC_IOC,0,struct _MGSL_PARAMS)
267#define MGSL_IOCGPARAMS _IOR(MGSL_MAGIC_IOC,1,struct _MGSL_PARAMS)
268#define MGSL_IOCSTXIDLE _IO(MGSL_MAGIC_IOC,2)
269#define MGSL_IOCGTXIDLE _IO(MGSL_MAGIC_IOC,3)
270#define MGSL_IOCTXENABLE _IO(MGSL_MAGIC_IOC,4)
271#define MGSL_IOCRXENABLE _IO(MGSL_MAGIC_IOC,5)
272#define MGSL_IOCTXABORT _IO(MGSL_MAGIC_IOC,6)
273#define MGSL_IOCGSTATS _IO(MGSL_MAGIC_IOC,7)
274#define MGSL_IOCWAITEVENT _IOWR(MGSL_MAGIC_IOC,8,int)
275#define MGSL_IOCCLRMODCOUNT _IO(MGSL_MAGIC_IOC,15)
276#define MGSL_IOCLOOPTXDONE _IO(MGSL_MAGIC_IOC,9)
277#define MGSL_IOCSIF _IO(MGSL_MAGIC_IOC,10)
278#define MGSL_IOCGIF _IO(MGSL_MAGIC_IOC,11)
279
280#endif /* _SYNCLINK_H_ */