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