Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /************************************************************************ |
2 | * | |
3 | * USBVEND.H Vendor-specific USB definitions | |
4 | * | |
5 | * NOTE: This must be kept in sync with the Edgeport firmware and | |
6 | * must be kept backward-compatible with older firmware. | |
7 | * | |
8 | ************************************************************************ | |
9 | * | |
10 | * Copyright (C) 1998 Inside Out Networks, Inc. | |
11 | * This program is free software; you can redistribute it and/or modify | |
12 | * it under the terms of the GNU General Public License as published by | |
13 | * the Free Software Foundation; either version 2 of the License, or | |
14 | * (at your option) any later version. | |
15 | * | |
16 | ************************************************************************/ | |
17 | ||
18 | #if !defined(_USBVEND_H) | |
19 | #define _USBVEND_H | |
20 | ||
21 | /************************************************************************ | |
22 | * | |
23 | * D e f i n e s / T y p e d e f s | |
24 | * | |
25 | ************************************************************************/ | |
26 | ||
27 | // | |
28 | // Definitions of USB product IDs | |
a3204711 | 29 | // |
1da177e4 LT |
30 | |
31 | #define USB_VENDOR_ID_ION 0x1608 // Our VID | |
32 | #define USB_VENDOR_ID_TI 0x0451 // TI VID | |
6e8cf775 | 33 | #define USB_VENDOR_ID_AXIOHM 0x05D9 /* Axiohm VID */ |
1da177e4 LT |
34 | |
35 | // | |
36 | // Definitions of USB product IDs (PID) | |
37 | // We break the USB-defined PID into an OEM Id field (upper 6 bits) | |
38 | // and a Device Id (bottom 10 bits). The Device Id defines what | |
39 | // device this actually is regardless of what the OEM wants to | |
40 | // call it. | |
41 | // | |
42 | ||
43 | // ION-device OEM IDs | |
44 | #define ION_OEM_ID_ION 0 // 00h Inside Out Networks | |
45 | #define ION_OEM_ID_NLYNX 1 // 01h NLynx Systems | |
46 | #define ION_OEM_ID_GENERIC 2 // 02h Generic OEM | |
47 | #define ION_OEM_ID_MAC 3 // 03h Mac Version | |
48 | #define ION_OEM_ID_MEGAWOLF 4 // 04h Lupusb OEM Mac version (MegaWolf) | |
49 | #define ION_OEM_ID_MULTITECH 5 // 05h Multitech Rapidports | |
50 | #define ION_OEM_ID_AGILENT 6 // 06h AGILENT board | |
51 | ||
52 | ||
53 | // ION-device Device IDs | |
54 | // Product IDs - assigned to match middle digit of serial number (No longer true) | |
55 | ||
56 | #define ION_DEVICE_ID_80251_NETCHIP 0x020 // This bit is set in the PID if this edgeport hardware$ | |
a3204711 | 57 | // is based on the 80251+Netchip. |
1da177e4 LT |
58 | |
59 | #define ION_DEVICE_ID_GENERATION_1 0x00 // Value for 930 based edgeports | |
60 | #define ION_DEVICE_ID_GENERATION_2 0x01 // Value for 80251+Netchip. | |
61 | #define ION_DEVICE_ID_GENERATION_3 0x02 // Value for Texas Instruments TUSB5052 chip | |
62 | #define ION_DEVICE_ID_GENERATION_4 0x03 // Watchport Family of products | |
63 | #define ION_GENERATION_MASK 0x03 | |
64 | ||
65 | #define ION_DEVICE_ID_HUB_MASK 0x0080 // This bit in the PID designates a HUB device | |
66 | // for example 8C would be a 421 4 port hub | |
67 | // and 8D would be a 2 port embedded hub | |
68 | ||
69 | #define EDGEPORT_DEVICE_ID_MASK 0x0ff // Not including OEM or GENERATION fields | |
70 | ||
71 | #define ION_DEVICE_ID_UNCONFIGURED_EDGE_DEVICE 0x000 // In manufacturing only | |
72 | #define ION_DEVICE_ID_EDGEPORT_4 0x001 // Edgeport/4 RS232 | |
73 | #define ION_DEVICE_ID_EDGEPORT_8R 0x002 // Edgeport with RJ45 no Ring | |
74 | #define ION_DEVICE_ID_RAPIDPORT_4 0x003 // Rapidport/4 | |
75 | #define ION_DEVICE_ID_EDGEPORT_4T 0x004 // Edgeport/4 RS232 for Telxon (aka "Fleetport") | |
76 | #define ION_DEVICE_ID_EDGEPORT_2 0x005 // Edgeport/2 RS232 | |
77 | #define ION_DEVICE_ID_EDGEPORT_4I 0x006 // Edgeport/4 RS422 | |
78 | #define ION_DEVICE_ID_EDGEPORT_2I 0x007 // Edgeport/2 RS422/RS485 | |
79 | #define ION_DEVICE_ID_EDGEPORT_8RR 0x008 // Edgeport with RJ45 with Data and RTS/CTS only | |
80 | // ION_DEVICE_ID_EDGEPORT_8_HANDBUILT 0x009 // Hand-built Edgeport/8 (Placeholder, used in middle digit of serial number only!) | |
81 | // ION_DEVICE_ID_MULTIMODEM_4X56 0x00A // MultiTech version of RP/4 (Placeholder, used in middle digit of serial number only!) | |
82 | #define ION_DEVICE_ID_EDGEPORT_PARALLEL_PORT 0x00B // Edgeport/(4)21 Parallel port (USS720) | |
83 | #define ION_DEVICE_ID_EDGEPORT_421 0x00C // Edgeport/421 Hub+RS232+Parallel | |
84 | #define ION_DEVICE_ID_EDGEPORT_21 0x00D // Edgeport/21 RS232+Parallel | |
85 | #define ION_DEVICE_ID_EDGEPORT_8_DUAL_CPU 0x00E // Half of an Edgeport/8 (the kind with 2 EP/4s on 1 PCB) | |
86 | #define ION_DEVICE_ID_EDGEPORT_8 0x00F // Edgeport/8 (single-CPU) | |
87 | #define ION_DEVICE_ID_EDGEPORT_2_DIN 0x010 // Edgeport/2 RS232 with Apple DIN connector | |
88 | #define ION_DEVICE_ID_EDGEPORT_4_DIN 0x011 // Edgeport/4 RS232 with Apple DIN connector | |
89 | #define ION_DEVICE_ID_EDGEPORT_16_DUAL_CPU 0x012 // Half of an Edgeport/16 (the kind with 2 EP/8s) | |
90 | #define ION_DEVICE_ID_EDGEPORT_COMPATIBLE 0x013 // Edgeport Compatible, for NCR, Axiohm etc. testing | |
91 | #define ION_DEVICE_ID_EDGEPORT_8I 0x014 // Edgeport/8 RS422 (single-CPU) | |
92 | #define ION_DEVICE_ID_EDGEPORT_1 0x015 // Edgeport/1 RS232 | |
93 | #define ION_DEVICE_ID_EPOS44 0x016 // Half of an EPOS/44 (TIUMP BASED) | |
94 | #define ION_DEVICE_ID_EDGEPORT_42 0x017 // Edgeport/42 | |
95 | #define ION_DEVICE_ID_EDGEPORT_412_8 0x018 // Edgeport/412 8 port part | |
96 | #define ION_DEVICE_ID_EDGEPORT_412_4 0x019 // Edgeport/412 4 port part | |
97 | #define ION_DEVICE_ID_EDGEPORT_22I 0x01A // Edgeport/22I is an Edgeport/4 with ports 1&2 RS422 and ports 3&4 RS232 | |
98 | ||
99 | // Compact Form factor TI based devices 2c, 21c, 22c, 221c | |
100 | #define ION_DEVICE_ID_EDGEPORT_2C 0x01B // Edgeport/2c is a TI based Edgeport/2 - Small I2c | |
101 | #define ION_DEVICE_ID_EDGEPORT_221C 0x01C // Edgeport/221c is a TI based Edgeport/2 with lucent chip and | |
102 | // 2 external hub ports - Large I2C | |
103 | #define ION_DEVICE_ID_EDGEPORT_22C 0x01D // Edgeport/22c is a TI based Edgeport/2 with | |
104 | // 2 external hub ports - Large I2C | |
105 | #define ION_DEVICE_ID_EDGEPORT_21C 0x01E // Edgeport/21c is a TI based Edgeport/2 with lucent chip | |
106 | // Small I2C | |
107 | ||
108 | ||
109 | /* | |
110 | * DANGER DANGER The 0x20 bit was used to indicate a 8251/netchip GEN 2 device. | |
111 | * Since the MAC, Linux, and Optimal drivers still used the old code | |
112 | * I suggest that you skip the 0x20 bit when creating new PIDs | |
113 | */ | |
114 | ||
115 | ||
116 | // Generation 3 devices -- 3410 based edgport/1 (256 byte I2C) | |
117 | #define ION_DEVICE_ID_TI3410_EDGEPORT_1 0x040 // Edgeport/1 RS232 | |
118 | #define ION_DEVICE_ID_TI3410_EDGEPORT_1I 0x041 // Edgeport/1i- RS422 model | |
119 | ||
120 | // Ti based software switchable RS232/RS422/RS485 devices | |
121 | #define ION_DEVICE_ID_EDGEPORT_4S 0x042 // Edgeport/4s - software switchable model | |
122 | #define ION_DEVICE_ID_EDGEPORT_8S 0x043 // Edgeport/8s - software switchable model | |
123 | ||
124 | // Usb to Ethernet dongle | |
125 | #define ION_DEVICE_ID_EDGEPORT_E 0x0E0 // Edgeport/E Usb to Ethernet | |
126 | ||
127 | // Edgeport TI based devices | |
128 | #define ION_DEVICE_ID_TI_EDGEPORT_4 0x0201 // Edgeport/4 RS232 | |
129 | #define ION_DEVICE_ID_TI_EDGEPORT_2 0x0205 // Edgeport/2 RS232 | |
130 | #define ION_DEVICE_ID_TI_EDGEPORT_4I 0x0206 // Edgeport/4i RS422 | |
131 | #define ION_DEVICE_ID_TI_EDGEPORT_2I 0x0207 // Edgeport/2i RS422/RS485 | |
132 | #define ION_DEVICE_ID_TI_EDGEPORT_421 0x020C // Edgeport/421 4 hub 2 RS232 + Parallel (lucent on a different hub port) | |
133 | #define ION_DEVICE_ID_TI_EDGEPORT_21 0x020D // Edgeport/21 2 RS232 + Parallel (lucent on a different hub port) | |
fc4cbd75 | 134 | #define ION_DEVICE_ID_TI_EDGEPORT_416 0x0212 // Edgeport/416 |
1da177e4 LT |
135 | #define ION_DEVICE_ID_TI_EDGEPORT_1 0x0215 // Edgeport/1 RS232 |
136 | #define ION_DEVICE_ID_TI_EDGEPORT_42 0x0217 // Edgeport/42 4 hub 2 RS232 | |
a3204711 | 137 | #define ION_DEVICE_ID_TI_EDGEPORT_22I 0x021A // Edgeport/22I is an Edgeport/4 with ports 1&2 RS422 and ports 3&4 RS232 |
1da177e4 LT |
138 | #define ION_DEVICE_ID_TI_EDGEPORT_2C 0x021B // Edgeport/2c RS232 |
139 | #define ION_DEVICE_ID_TI_EDGEPORT_221C 0x021C // Edgeport/221c is a TI based Edgeport/2 with lucent chip and | |
140 | // 2 external hub ports - Large I2C | |
141 | #define ION_DEVICE_ID_TI_EDGEPORT_22C 0x021D // Edgeport/22c is a TI based Edgeport/2 with | |
142 | // 2 external hub ports - Large I2C | |
143 | #define ION_DEVICE_ID_TI_EDGEPORT_21C 0x021E // Edgeport/21c is a TI based Edgeport/2 with lucent chip | |
144 | ||
a3204711 | 145 | // Generation 3 devices -- 3410 based edgport/1 (256 byte I2C) |
fc4cbd75 MP |
146 | #define ION_DEVICE_ID_TI_TI3410_EDGEPORT_1 0x0240 // Edgeport/1 RS232 |
147 | #define ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I 0x0241 // Edgeport/1i- RS422 model | |
1da177e4 LT |
148 | |
149 | // Ti based software switchable RS232/RS422/RS485 devices | |
fc4cbd75 MP |
150 | #define ION_DEVICE_ID_TI_EDGEPORT_4S 0x0242 // Edgeport/4s - software switchable model |
151 | #define ION_DEVICE_ID_TI_EDGEPORT_8S 0x0243 // Edgeport/8s - software switchable model | |
152 | #define ION_DEVICE_ID_TI_EDGEPORT_8 0x0244 // Edgeport/8 (single-CPU) | |
153 | #define ION_DEVICE_ID_TI_EDGEPORT_416B 0x0247 // Edgeport/416 | |
1da177e4 LT |
154 | |
155 | ||
156 | /************************************************************************ | |
157 | * | |
158 | * Generation 4 devices | |
159 | * | |
160 | ************************************************************************/ | |
161 | ||
162 | // Watchport based on 3410 both 1-wire and binary products (16K I2C) | |
163 | #define ION_DEVICE_ID_WP_UNSERIALIZED 0x300 // Watchport based on 3410 both 1-wire and binary products | |
164 | #define ION_DEVICE_ID_WP_PROXIMITY 0x301 // Watchport/P Discontinued | |
165 | #define ION_DEVICE_ID_WP_MOTION 0x302 // Watchport/M | |
166 | #define ION_DEVICE_ID_WP_MOISTURE 0x303 // Watchport/W | |
167 | #define ION_DEVICE_ID_WP_TEMPERATURE 0x304 // Watchport/T | |
168 | #define ION_DEVICE_ID_WP_HUMIDITY 0x305 // Watchport/H | |
169 | ||
170 | #define ION_DEVICE_ID_WP_POWER 0x306 // Watchport | |
171 | #define ION_DEVICE_ID_WP_LIGHT 0x307 // Watchport | |
172 | #define ION_DEVICE_ID_WP_RADIATION 0x308 // Watchport | |
173 | #define ION_DEVICE_ID_WP_ACCELERATION 0x309 // Watchport/A | |
174 | #define ION_DEVICE_ID_WP_DISTANCE 0x30A // Watchport/D Discontinued | |
175 | #define ION_DEVICE_ID_WP_PROX_DIST 0x30B // Watchport/D uses distance sensor | |
176 | // Default to /P function | |
177 | ||
178 | #define ION_DEVICE_ID_PLUS_PWR_HP4CD 0x30C // 5052 Plus Power HubPort/4CD+ (for Dell) | |
a3204711 | 179 | #define ION_DEVICE_ID_PLUS_PWR_HP4C 0x30D // 5052 Plus Power HubPort/4C+ |
1da177e4 LT |
180 | #define ION_DEVICE_ID_PLUS_PWR_PCI 0x30E // 3410 Plus Power PCI Host Controller 4 port |
181 | ||
182 | ||
183 | // | |
184 | // Definitions for AXIOHM USB product IDs | |
185 | // | |
186 | #define USB_VENDOR_ID_AXIOHM 0x05D9 // Axiohm VID | |
187 | ||
188 | #define AXIOHM_DEVICE_ID_MASK 0xffff | |
189 | #define AXIOHM_DEVICE_ID_EPIC_A758 0xA758 | |
190 | #define AXIOHM_DEVICE_ID_EPIC_A794 0xA794 | |
191 | #define AXIOHM_DEVICE_ID_EPIC_A225 0xA225 | |
192 | ||
193 | ||
194 | // | |
195 | // Definitions for NCR USB product IDs | |
196 | // | |
197 | #define USB_VENDOR_ID_NCR 0x0404 // NCR VID | |
198 | ||
199 | #define NCR_DEVICE_ID_MASK 0xffff | |
200 | #define NCR_DEVICE_ID_EPIC_0202 0x0202 | |
201 | #define NCR_DEVICE_ID_EPIC_0203 0x0203 | |
202 | #define NCR_DEVICE_ID_EPIC_0310 0x0310 | |
203 | #define NCR_DEVICE_ID_EPIC_0311 0x0311 | |
204 | #define NCR_DEVICE_ID_EPIC_0312 0x0312 | |
205 | ||
206 | ||
207 | // | |
208 | // Definitions for SYMBOL USB product IDs | |
209 | // | |
210 | #define USB_VENDOR_ID_SYMBOL 0x05E0 // Symbol VID | |
211 | #define SYMBOL_DEVICE_ID_MASK 0xffff | |
212 | #define SYMBOL_DEVICE_ID_KEYFOB 0x0700 | |
213 | ||
214 | ||
215 | // | |
216 | // Definitions for other product IDs | |
217 | #define ION_DEVICE_ID_MT4X56USB 0x1403 // OEM device | |
218 | ||
219 | ||
a3204711 GKH |
220 | #define GENERATION_ID_FROM_USB_PRODUCT_ID(ProductId) \ |
221 | ((__u16) ((ProductId >> 8) & (ION_GENERATION_MASK))) | |
1da177e4 | 222 | |
a3204711 GKH |
223 | #define MAKE_USB_PRODUCT_ID(OemId, DeviceId) \ |
224 | ((__u16) (((OemId) << 10) || (DeviceId))) | |
1da177e4 | 225 | |
a3204711 GKH |
226 | #define DEVICE_ID_FROM_USB_PRODUCT_ID(ProductId) \ |
227 | ((__u16) ((ProductId) & (EDGEPORT_DEVICE_ID_MASK))) | |
1da177e4 | 228 | |
a3204711 GKH |
229 | #define OEM_ID_FROM_USB_PRODUCT_ID(ProductId) \ |
230 | ((__u16) (((ProductId) >> 10) & 0x3F)) | |
1da177e4 LT |
231 | |
232 | // | |
233 | // Definitions of parameters for download code. Note that these are | |
234 | // specific to a given version of download code and must change if the | |
235 | // corresponding download code changes. | |
236 | // | |
237 | ||
238 | // TxCredits value below which driver won't bother sending (to prevent too many small writes). | |
239 | // Send only if above 25% | |
a3204711 | 240 | #define EDGE_FW_GET_TX_CREDITS_SEND_THRESHOLD(InitialCredit, MaxPacketSize) (max(((InitialCredit) / 4), (MaxPacketSize))) |
1da177e4 LT |
241 | |
242 | #define EDGE_FW_BULK_MAX_PACKET_SIZE 64 // Max Packet Size for Bulk In Endpoint (EP1) | |
243 | #define EDGE_FW_BULK_READ_BUFFER_SIZE 1024 // Size to use for Bulk reads | |
244 | ||
245 | #define EDGE_FW_INT_MAX_PACKET_SIZE 32 // Max Packet Size for Interrupt In Endpoint | |
246 | // Note that many units were shipped with MPS=16, we | |
247 | // force an upgrade to this value). | |
248 | #define EDGE_FW_INT_INTERVAL 2 // 2ms polling on IntPipe | |
249 | ||
250 | ||
251 | // | |
252 | // Definitions of I/O Networks vendor-specific requests | |
253 | // for default endpoint | |
254 | // | |
255 | // bmRequestType = 01000000 Set vendor-specific, to device | |
256 | // bmRequestType = 11000000 Get vendor-specific, to device | |
257 | // | |
258 | // These are the definitions for the bRequest field for the | |
259 | // above bmRequestTypes. | |
260 | // | |
261 | // For the read/write Edgeport memory commands, the parameters | |
262 | // are as follows: | |
263 | // wValue = 16-bit address | |
264 | // wIndex = unused (though we could put segment 00: or FF: here) | |
265 | // wLength = # bytes to read/write (max 64) | |
a3204711 | 266 | // |
1da177e4 LT |
267 | |
268 | #define USB_REQUEST_ION_RESET_DEVICE 0 // Warm reboot Edgeport, retaining USB address | |
269 | #define USB_REQUEST_ION_GET_EPIC_DESC 1 // Get Edgeport Compatibility Descriptor | |
270 | // unused 2 // Unused, available | |
271 | #define USB_REQUEST_ION_READ_RAM 3 // Read EdgePort RAM at specified addr | |
272 | #define USB_REQUEST_ION_WRITE_RAM 4 // Write EdgePort RAM at specified addr | |
273 | #define USB_REQUEST_ION_READ_ROM 5 // Read EdgePort ROM at specified addr | |
274 | #define USB_REQUEST_ION_WRITE_ROM 6 // Write EdgePort ROM at specified addr | |
275 | #define USB_REQUEST_ION_EXEC_DL_CODE 7 // Begin execution of RAM-based download | |
276 | // code by jumping to address in wIndex:wValue | |
277 | // 8 // Unused, available | |
278 | #define USB_REQUEST_ION_ENABLE_SUSPEND 9 // Enable/Disable suspend feature | |
279 | // (wValue != 0: Enable; wValue = 0: Disable) | |
280 | ||
a3204711 | 281 | #define USB_REQUEST_ION_SEND_IOSP 10 // Send an IOSP command to the edgeport over the control pipe |
1da177e4 LT |
282 | #define USB_REQUEST_ION_RECV_IOSP 11 // Receive an IOSP command from the edgeport over the control pipe |
283 | ||
284 | ||
285 | #define USB_REQUEST_ION_DIS_INT_TIMER 0x80 // Sent to Axiohm to enable/ disable | |
286 | // interrupt token timer | |
287 | // wValue = 1, enable (default) | |
288 | // wValue = 0, disable | |
289 | ||
290 | // | |
291 | // Define parameter values for our vendor-specific commands | |
292 | // | |
293 | ||
294 | // | |
093cf723 | 295 | // Edgeport Compatibility Descriptor |
1da177e4 LT |
296 | // |
297 | // This descriptor is only returned by Edgeport-compatible devices | |
298 | // supporting the EPiC spec. True ION devices do not return this | |
299 | // descriptor, but instead return STALL on receipt of the | |
300 | // GET_EPIC_DESC command. The driver interprets a STALL to mean that | |
301 | // this is a "real" Edgeport. | |
302 | // | |
303 | ||
a3204711 | 304 | struct edge_compatibility_bits { |
1da177e4 LT |
305 | // This __u32 defines which Vendor-specific commands/functionality |
306 | // the device supports on the default EP0 pipe. | |
307 | ||
308 | __u32 VendEnableSuspend : 1; // 0001 Set if device supports ION_ENABLE_SUSPEND | |
309 | __u32 VendUnused : 31; // Available for future expansion, must be 0 | |
310 | ||
311 | // This __u32 defines which IOSP commands are supported over the | |
312 | // bulk pipe EP1. | |
313 | ||
314 | // xxxx Set if device supports: | |
315 | __u32 IOSPOpen : 1; // 0001 OPEN / OPEN_RSP (Currently must be 1) | |
316 | __u32 IOSPClose : 1; // 0002 CLOSE | |
317 | __u32 IOSPChase : 1; // 0004 CHASE / CHASE_RSP | |
318 | __u32 IOSPSetRxFlow : 1; // 0008 SET_RX_FLOW | |
319 | __u32 IOSPSetTxFlow : 1; // 0010 SET_TX_FLOW | |
320 | __u32 IOSPSetXChar : 1; // 0020 SET_XON_CHAR/SET_XOFF_CHAR | |
321 | __u32 IOSPRxCheck : 1; // 0040 RX_CHECK_REQ/RX_CHECK_RSP | |
322 | __u32 IOSPSetClrBreak : 1; // 0080 SET_BREAK/CLEAR_BREAK | |
323 | __u32 IOSPWriteMCR : 1; // 0100 MCR register writes (set/clr DTR/RTS) | |
324 | __u32 IOSPWriteLCR : 1; // 0200 LCR register writes (wordlen/stop/parity) | |
325 | __u32 IOSPSetBaudRate : 1; // 0400 setting Baud rate (writes to LCR.80h and DLL/DLM register) | |
326 | __u32 IOSPDisableIntPipe : 1; // 0800 Do not use the interrupt pipe for TxCredits or RxButesAvailable | |
327 | __u32 IOSPRxDataAvail : 1; // 1000 Return status of RX Fifo (Data available in Fifo) | |
328 | __u32 IOSPTxPurge : 1; // 2000 Purge TXBuffer and/or Fifo in Edgeport hardware | |
329 | __u32 IOSPUnused : 18; // Available for future expansion, must be 0 | |
330 | ||
331 | // This __u32 defines which 'general' features are supported | |
332 | ||
333 | __u32 TrueEdgeport : 1; // 0001 Set if device is a 'real' Edgeport | |
334 | // (Used only by driver, NEVER set by an EPiC device) | |
335 | __u32 GenUnused : 31; // Available for future expansion, must be 0 | |
1da177e4 LT |
336 | }; |
337 | ||
6e8cf775 GKH |
338 | #define EDGE_COMPATIBILITY_MASK0 0x0001 |
339 | #define EDGE_COMPATIBILITY_MASK1 0x3FFF | |
340 | #define EDGE_COMPATIBILITY_MASK2 0x0001 | |
341 | ||
a3204711 | 342 | struct edge_compatibility_descriptor { |
1da177e4 LT |
343 | __u8 Length; // Descriptor Length (per USB spec) |
344 | __u8 DescType; // Descriptor Type (per USB spec, =DEVICE type) | |
345 | __u8 EpicVer; // Version of EPiC spec supported | |
a3204711 | 346 | // (Currently must be 1) |
1da177e4 LT |
347 | __u8 NumPorts; // Number of serial ports supported |
348 | __u8 iDownloadFile; // Index of string containing download code filename | |
a3204711 GKH |
349 | // 0=no download, FF=download compiled into driver. |
350 | __u8 Unused[3]; // Available for future expansion, must be 0 | |
351 | // (Currently must be 0). | |
1da177e4 LT |
352 | __u8 MajorVersion; // Firmware version: xx. |
353 | __u8 MinorVersion; // yy. | |
354 | __le16 BuildNumber; // zzzz (LE format) | |
355 | ||
356 | // The following structure contains __u32s, with each bit | |
357 | // specifying whether the EPiC device supports the given | |
358 | // command or functionality. | |
1da177e4 | 359 | struct edge_compatibility_bits Supports; |
1da177e4 LT |
360 | }; |
361 | ||
362 | // Values for iDownloadFile | |
363 | #define EDGE_DOWNLOAD_FILE_NONE 0 // No download requested | |
364 | #define EDGE_DOWNLOAD_FILE_INTERNAL 0xFF // Download the file compiled into driver (930 version) | |
365 | #define EDGE_DOWNLOAD_FILE_I930 0xFF // Download the file compiled into driver (930 version) | |
366 | #define EDGE_DOWNLOAD_FILE_80251 0xFE // Download the file compiled into driver (80251 version) | |
367 | ||
368 | ||
369 | ||
370 | /* | |
371 | * Special addresses for READ/WRITE_RAM/ROM | |
372 | */ | |
373 | ||
374 | // Version 1 (original) format of DeviceParams | |
375 | #define EDGE_MANUF_DESC_ADDR_V1 0x00FF7F00 | |
376 | #define EDGE_MANUF_DESC_LEN_V1 sizeof(EDGE_MANUF_DESCRIPTOR_V1) | |
377 | ||
378 | // Version 2 format of DeviceParams. This format is longer (3C0h) | |
379 | // and starts lower in memory, at the uppermost 1K in ROM. | |
380 | #define EDGE_MANUF_DESC_ADDR 0x00FF7C00 | |
381 | #define EDGE_MANUF_DESC_LEN sizeof(struct edge_manuf_descriptor) | |
382 | ||
383 | // Boot params descriptor | |
384 | #define EDGE_BOOT_DESC_ADDR 0x00FF7FC0 | |
385 | #define EDGE_BOOT_DESC_LEN sizeof(struct edge_boot_descriptor) | |
386 | ||
387 | // Define the max block size that may be read or written | |
388 | // in a read/write RAM/ROM command. | |
a3204711 GKH |
389 | #define MAX_SIZE_REQ_ION_READ_MEM ((__u16)64) |
390 | #define MAX_SIZE_REQ_ION_WRITE_MEM ((__u16)64) | |
1da177e4 LT |
391 | |
392 | ||
393 | // | |
394 | // Notes for the following two ION vendor-specific param descriptors: | |
395 | // | |
396 | // 1. These have a standard USB descriptor header so they look like a | |
397 | // normal descriptor. | |
398 | // 2. Any strings in the structures are in USB-defined string | |
399 | // descriptor format, so that they may be separately retrieved, | |
400 | // if necessary, with a minimum of work on the 930. This also | |
401 | // requires them to be in UNICODE format, which, for English at | |
402 | // least, simply means extending each __u8 into a __u16. | |
403 | // 3. For all fields, 00 means 'uninitialized'. | |
404 | // 4. All unused areas should be set to 00 for future expansion. | |
405 | // | |
406 | ||
407 | // This structure is ver 2 format. It contains ALL USB descriptors as | |
408 | // well as the configuration parameters that were in the original V1 | |
409 | // structure. It is NOT modified when new boot code is downloaded; rather, | |
410 | // these values are set or modified by manufacturing. It is located at | |
411 | // xC00-xFBF (length 3C0h) in the ROM. | |
412 | // This structure is a superset of the v1 structure and is arranged so | |
413 | // that all of the v1 fields remain at the same address. We are just | |
414 | // adding more room to the front of the structure to hold the descriptors. | |
415 | // | |
416 | // The actual contents of this structure are defined in a 930 assembly | |
417 | // file, converted to a binary image, and then written by the serialization | |
418 | // program. The C definition of this structure just defines a dummy | |
419 | // area for general USB descriptors and the descriptor tables (the root | |
420 | // descriptor starts at xC00). At the bottom of the structure are the | |
421 | // fields inherited from the v1 structure. | |
422 | ||
423 | #define MAX_SERIALNUMBER_LEN 12 | |
424 | #define MAX_ASSEMBLYNUMBER_LEN 14 | |
425 | ||
426 | struct edge_manuf_descriptor { | |
427 | ||
428 | __u16 RootDescTable[0x10]; // C00 Root of descriptor tables (just a placeholder) | |
429 | __u8 DescriptorArea[0x2E0]; // C20 Descriptors go here, up to 2E0h (just a placeholder) | |
430 | ||
431 | // Start of v1-compatible section | |
432 | __u8 Length; // F00 Desc length for what follows, per USB (= C0h ) | |
433 | __u8 DescType; // F01 Desc type, per USB (=DEVICE type) | |
434 | __u8 DescVer; // F02 Desc version/format (currently 2) | |
435 | __u8 NumRootDescEntries; // F03 # entries in RootDescTable | |
436 | ||
437 | __u8 RomSize; // F04 Size of ROM/E2PROM in K | |
438 | __u8 RamSize; // F05 Size of external RAM in K | |
439 | __u8 CpuRev; // F06 CPU revision level (chg only if s/w visible) | |
440 | __u8 BoardRev; // F07 PCB revision level (chg only if s/w visible) | |
441 | ||
442 | __u8 NumPorts; // F08 Number of ports | |
443 | __u8 DescDate[3]; // F09 MM/DD/YY when descriptor template was compiler, | |
444 | // so host can track changes to USB-only descriptors. | |
445 | ||
446 | __u8 SerNumLength; // F0C USB string descriptor len | |
447 | __u8 SerNumDescType; // F0D USB descriptor type (=STRING type) | |
448 | __le16 SerialNumber[MAX_SERIALNUMBER_LEN]; // F0E "01-01-000100" Unicode Serial Number | |
449 | ||
450 | __u8 AssemblyNumLength; // F26 USB string descriptor len | |
451 | __u8 AssemblyNumDescType; // F27 USB descriptor type (=STRING type) | |
452 | __le16 AssemblyNumber[MAX_ASSEMBLYNUMBER_LEN]; // F28 "350-1000-01-A " assembly number | |
453 | ||
454 | __u8 OemAssyNumLength; // F44 USB string descriptor len | |
455 | __u8 OemAssyNumDescType; // F45 USB descriptor type (=STRING type) | |
456 | __le16 OemAssyNumber[MAX_ASSEMBLYNUMBER_LEN]; // F46 "xxxxxxxxxxxxxx" OEM assembly number | |
457 | ||
458 | __u8 ManufDateLength; // F62 USB string descriptor len | |
459 | __u8 ManufDateDescType; // F63 USB descriptor type (=STRING type) | |
460 | __le16 ManufDate[6]; // F64 "MMDDYY" manufacturing date | |
461 | ||
462 | __u8 Reserved3[0x4D]; // F70 -- unused, set to 0 -- | |
463 | ||
464 | __u8 UartType; // FBD Uart Type | |
465 | __u8 IonPid; // FBE Product ID, == LSB of USB DevDesc.PID | |
466 | // (Note: Edgeport/4s before 11/98 will have | |
467 | // 00 here instead of 01) | |
468 | __u8 IonConfig; // FBF Config byte for ION manufacturing use | |
469 | // FBF end of structure, total len = 3C0h | |
470 | ||
471 | }; | |
472 | ||
473 | ||
474 | #define MANUF_DESC_VER_1 1 // Original definition of MANUF_DESC | |
475 | #define MANUF_DESC_VER_2 2 // Ver 2, starts at xC00h len 3C0h | |
476 | ||
477 | ||
478 | // Uart Types | |
479 | // Note: Since this field was added only recently, all Edgeport/4 units | |
480 | // shipped before 11/98 will have 00 in this field. Therefore, | |
481 | // both 00 and 01 values mean '654. | |
482 | #define MANUF_UART_EXAR_654_EARLY 0 // Exar 16C654 in Edgeport/4s before 11/98 | |
483 | #define MANUF_UART_EXAR_654 1 // Exar 16C654 | |
484 | #define MANUF_UART_EXAR_2852 2 // Exar 16C2852 | |
485 | ||
486 | // | |
487 | // Note: The CpuRev and BoardRev values do not conform to manufacturing | |
488 | // revisions; they are to be incremented only when the CPU or hardware | |
489 | // changes in a software-visible way, such that the 930 software or | |
490 | // the host driver needs to handle the hardware differently. | |
491 | // | |
492 | ||
493 | // Values of bottom 5 bits of CpuRev & BoardRev for | |
494 | // Implementation 0 (ie, 930-based) | |
495 | #define MANUF_CPU_REV_AD4 1 // 930 AD4, with EP1 Rx bug (needs RXSPM) | |
496 | #define MANUF_CPU_REV_AD5 2 // 930 AD5, with above bug (supposedly) fixed | |
497 | #define MANUF_CPU_80251 0x20 // Intel 80251 | |
498 | ||
499 | ||
500 | #define MANUF_BOARD_REV_A 1 // Original version, == Manuf Rev A | |
501 | #define MANUF_BOARD_REV_B 2 // Manuf Rev B, wakeup interrupt works | |
502 | #define MANUF_BOARD_REV_C 3 // Manuf Rev C, 2/4 ports, rs232/rs422 | |
503 | #define MANUF_BOARD_REV_GENERATION_2 0x20 // Second generaiton edgeport | |
504 | ||
505 | ||
506 | // Values of bottom 5 bits of CpuRev & BoardRev for | |
507 | // Implementation 1 (ie, 251+Netchip-based) | |
508 | #define MANUF_CPU_REV_1 1 // C251TB Rev 1 (Need actual Intel rev here) | |
509 | ||
510 | #define MANUF_BOARD_REV_A 1 // First rev of 251+Netchip design | |
511 | ||
512 | #define MANUF_SERNUM_LENGTH sizeof(((struct edge_manuf_descriptor *)0)->SerialNumber) | |
513 | #define MANUF_ASSYNUM_LENGTH sizeof(((struct edge_manuf_descriptor *)0)->AssemblyNumber) | |
514 | #define MANUF_OEMASSYNUM_LENGTH sizeof(((struct edge_manuf_descriptor *)0)->OemAssyNumber) | |
515 | #define MANUF_MANUFDATE_LENGTH sizeof(((struct edge_manuf_descriptor *)0)->ManufDate) | |
516 | ||
517 | #define MANUF_ION_CONFIG_DIAG_NO_LOOP 0x20 // As below but no ext loopback test | |
518 | #define MANUF_ION_CONFIG_DIAG 0x40 // 930 based device: 1=Run h/w diags, 0=norm | |
519 | // TIUMP Device : 1=IONSERIAL needs to run Final Test | |
520 | #define MANUF_ION_CONFIG_MASTER 0x80 // 930 based device: 1=Master mode, 0=Normal | |
521 | // TIUMP Device : 1=First device on a multi TIUMP Device | |
522 | ||
523 | // | |
524 | // This structure describes parameters for the boot code, and | |
525 | // is programmed along with new boot code. These are values | |
526 | // which are specific to a given build of the boot code. It | |
527 | // is exactly 64 bytes long and is fixed at address FF:xFC0 | |
528 | // - FF:xFFF. Note that the 930-mandated UCONFIG bytes are | |
529 | // included in this structure. | |
530 | // | |
531 | struct edge_boot_descriptor { | |
532 | __u8 Length; // C0 Desc length, per USB (= 40h) | |
533 | __u8 DescType; // C1 Desc type, per USB (= DEVICE type) | |
534 | __u8 DescVer; // C2 Desc version/format | |
535 | __u8 Reserved1; // C3 -- unused, set to 0 -- | |
536 | ||
537 | __le16 BootCodeLength; // C4 Boot code goes from FF:0000 to FF:(len-1) | |
538 | // (LE format) | |
539 | ||
540 | __u8 MajorVersion; // C6 Firmware version: xx. | |
541 | __u8 MinorVersion; // C7 yy. | |
542 | __le16 BuildNumber; // C8 zzzz (LE format) | |
a3204711 | 543 | |
1da177e4 LT |
544 | __u16 EnumRootDescTable; // CA Root of ROM-based descriptor table |
545 | __u8 NumDescTypes; // CC Number of supported descriptor types | |
546 | ||
547 | __u8 Reserved4; // CD Fix Compiler Packing | |
548 | ||
549 | __le16 Capabilities; // CE-CF Capabilities flags (LE format) | |
550 | __u8 Reserved2[0x28]; // D0 -- unused, set to 0 -- | |
551 | __u8 UConfig0; // F8 930-defined CPU configuration byte 0 | |
552 | __u8 UConfig1; // F9 930-defined CPU configuration byte 1 | |
553 | __u8 Reserved3[6]; // FA -- unused, set to 0 -- | |
554 | // FF end of structure, total len = 80 | |
555 | }; | |
556 | ||
557 | ||
558 | #define BOOT_DESC_VER_1 1 // Original definition of BOOT_PARAMS | |
559 | #define BOOT_DESC_VER_2 2 // 2nd definition, descriptors not included in boot | |
560 | ||
561 | ||
562 | // Capabilities flags | |
563 | ||
564 | #define BOOT_CAP_RESET_CMD 0x0001 // If set, boot correctly supports ION_RESET_DEVICE | |
565 | ||
566 | ||
567 | /************************************************************************ | |
568 | T I U M P D E F I N I T I O N S | |
569 | ***********************************************************************/ | |
570 | ||
571 | // Chip definitions in I2C | |
572 | #define UMP5152 0x52 | |
573 | #define UMP3410 0x10 | |
574 | ||
575 | ||
576 | //************************************************************************ | |
577 | // TI I2C Format Definitions | |
578 | //************************************************************************ | |
579 | #define I2C_DESC_TYPE_INFO_BASIC 0x01 | |
580 | #define I2C_DESC_TYPE_FIRMWARE_BASIC 0x02 | |
581 | #define I2C_DESC_TYPE_DEVICE 0x03 | |
582 | #define I2C_DESC_TYPE_CONFIG 0x04 | |
583 | #define I2C_DESC_TYPE_STRING 0x05 | |
584 | #define I2C_DESC_TYPE_FIRMWARE_AUTO 0x07 // for 3410 download | |
585 | #define I2C_DESC_TYPE_CONFIG_KLUDGE 0x14 // for 3410 | |
586 | #define I2C_DESC_TYPE_WATCHPORT_VERSION 0x15 // firmware version number for watchport | |
587 | #define I2C_DESC_TYPE_WATCHPORT_CALIBRATION_DATA 0x16 // Watchport Calibration Data | |
588 | ||
589 | #define I2C_DESC_TYPE_FIRMWARE_BLANK 0xf2 | |
590 | ||
591 | // Special section defined by ION | |
592 | #define I2C_DESC_TYPE_ION 0 // Not defined by TI | |
593 | ||
594 | ||
a3204711 | 595 | struct ti_i2c_desc { |
1da177e4 LT |
596 | __u8 Type; // Type of descriptor |
597 | __u16 Size; // Size of data only not including header | |
598 | __u8 CheckSum; // Checksum (8 bit sum of data only) | |
599 | __u8 Data[0]; // Data starts here | |
a3204711 | 600 | } __attribute__((packed)); |
1da177e4 LT |
601 | |
602 | // for 5152 devices only (type 2 record) | |
603 | // for 3410 the version is stored in the WATCHPORT_FIRMWARE_VERSION descriptor | |
a3204711 | 604 | struct ti_i2c_firmware_rec { |
1da177e4 LT |
605 | __u8 Ver_Major; // Firmware Major version number |
606 | __u8 Ver_Minor; // Firmware Minor version number | |
607 | __u8 Data[0]; // Download starts here | |
a3204711 | 608 | } __attribute__((packed)); |
1da177e4 LT |
609 | |
610 | ||
a3204711 | 611 | struct watchport_firmware_version { |
1da177e4 LT |
612 | // Added 2 bytes for version number |
613 | __u8 Version_Major; // Download Version (for Watchport) | |
614 | __u8 Version_Minor; | |
a3204711 | 615 | } __attribute__((packed)); |
1da177e4 LT |
616 | |
617 | ||
618 | // Structure of header of download image in fw_down.h | |
a3204711 | 619 | struct ti_i2c_image_header { |
1da177e4 LT |
620 | __le16 Length; |
621 | __u8 CheckSum; | |
a3204711 | 622 | } __attribute__((packed)); |
1da177e4 | 623 | |
a3204711 | 624 | struct ti_basic_descriptor { |
1da177e4 LT |
625 | __u8 Power; // Self powered |
626 | // bit 7: 1 - power switching supported | |
627 | // 0 - power switching not supported | |
628 | // | |
629 | // bit 0: 1 - self powered | |
630 | // 0 - bus powered | |
631 | // | |
632 | // | |
633 | __u16 HubVid; // VID HUB | |
634 | __u16 HubPid; // PID HUB | |
635 | __u16 DevPid; // PID Edgeport | |
636 | __u8 HubTime; // Time for power on to power good | |
637 | __u8 HubCurrent; // HUB Current = 100ma | |
638 | } __attribute__((packed)); | |
639 | ||
640 | ||
641 | // CPU / Board Rev Definitions | |
642 | #define TI_CPU_REV_5052 2 // 5052 based edgeports | |
643 | #define TI_CPU_REV_3410 3 // 3410 based edgeports | |
644 | ||
645 | #define TI_BOARD_REV_TI_EP 0 // Basic ti based edgeport | |
646 | #define TI_BOARD_REV_COMPACT 1 // Compact board | |
647 | #define TI_BOARD_REV_WATCHPORT 2 // Watchport | |
648 | ||
649 | ||
650 | #define TI_GET_CPU_REVISION(x) (__u8)((((x)>>4)&0x0f)) | |
651 | #define TI_GET_BOARD_REVISION(x) (__u8)(((x)&0x0f)) | |
652 | ||
653 | #define TI_I2C_SIZE_MASK 0x1f // 5 bits | |
654 | #define TI_GET_I2C_SIZE(x) ((((x) & TI_I2C_SIZE_MASK)+1)*256) | |
655 | ||
a3204711 | 656 | #define TI_MAX_I2C_SIZE (16 * 1024) |
1da177e4 | 657 | |
a3204711 | 658 | #define TI_MANUF_VERSION_0 0 |
1da177e4 LT |
659 | |
660 | // IonConig2 flags | |
661 | #define TI_CONFIG2_RS232 0x01 | |
662 | #define TI_CONFIG2_RS422 0x02 | |
663 | #define TI_CONFIG2_RS485 0x04 | |
664 | #define TI_CONFIG2_SWITCHABLE 0x08 | |
665 | ||
666 | #define TI_CONFIG2_WATCHPORT 0x10 | |
667 | ||
668 | ||
a3204711 | 669 | struct edge_ti_manuf_descriptor { |
1da177e4 LT |
670 | __u8 IonConfig; // Config byte for ION manufacturing use |
671 | __u8 IonConfig2; // Expansion | |
672 | __u8 Version; // Version | |
673 | __u8 CpuRev_BoardRev; // CPU revision level (0xF0) and Board Rev Level (0x0F) | |
674 | __u8 NumPorts; // Number of ports for this UMP | |
675 | __u8 NumVirtualPorts; // Number of Virtual ports | |
676 | __u8 HubConfig1; // Used to configure the Hub | |
677 | __u8 HubConfig2; // Used to configure the Hub | |
678 | __u8 TotalPorts; // Total Number of Com Ports for the entire device (All UMPs) | |
679 | __u8 Reserved; // Reserved | |
a3204711 | 680 | } __attribute__((packed)); |
1da177e4 LT |
681 | |
682 | ||
683 | #endif // if !defined(_USBVEND_H) |