usb/serial/io_usbvend.h

1 /* SPDX-License-Identifier: GPL-2.0+ */
4  *	USBVEND.H		Vendor-specific USB definitions
7  *	must be kept backward-compatible with older firmware.
25 // Definitions of USB product IDs
33 // Definitions of USB product IDs (PID)
34 // We break the USB-defined PID into an OEM Id field (upper 6 bits)
40 // ION-device OEM IDs
44 #define	ION_OEM_ID_MAC		3		// 03h Mac Version
45 #define	ION_OEM_ID_MEGAWOLF	4		// 04h Lupusb OEM Mac version (MegaWolf)
50 // ION-device Device IDs
51 // Product IDs - assigned to match middle digit of serial number (No longer true)
77 //	ION_DEVICE_ID_EDGEPORT_8_HANDBUILT	0x009	// Hand-built Edgeport/8 (Placeholder, used in middle d…
78 //	ION_DEVICE_ID_MULTIMODEM_4X56		0x00A	// MultiTech version of RP/4 (Placeholder, used in middle d…
83 #define ION_DEVICE_ID_EDGEPORT_8		0x00F	// Edgeport/8 (single-CPU)
88 #define ION_DEVICE_ID_EDGEPORT_8I		0x014	// Edgeport/8 RS422 (single-CPU)
97 #define ION_DEVICE_ID_EDGEPORT_2C		0x01B	// Edgeport/2c is a TI based Edgeport/2 - Small I2c
99 							// 2 external hub ports - Large I2C
101 							// 2 external hub ports - Large I2C
113 // Generation 3 devices -- 3410 based edgport/1 (256 byte I2C)
115 #define ION_DEVICE_ID_TI3410_EDGEPORT_1I	0x041	// Edgeport/1i- RS422 model
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
121 // Usb to Ethernet dongle
122 #define ION_DEVICE_ID_EDGEPORT_E		0x0E0	// Edgeport/E Usb to Ethernet
137 							// 2 external hub ports - Large I2C
139 							// 2 external hub ports - Large I2C
142 // Generation 3 devices -- 3410 based edgport/1 (256 byte I2C)
144 #define ION_DEVICE_ID_TI_TI3410_EDGEPORT_1I	0x0241	// Edgeport/1i- RS422 model
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)
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 prod…
181 // Definitions for AXIOHM USB product IDs
192 // Definitions for NCR USB product IDs
205 // Definitions for SYMBOL USB product IDs
232 // specific to a given version of download code and must change if the
250 // Definitions of I/O Networks vendor-specific requests
253 //	bmRequestType = 01000000	Set vendor-specific, to device
254 //	bmRequestType = 11000000	Get vendor-specific, to device
261 //		wValue = 16-bit address
266 #define USB_REQUEST_ION_RESET_DEVICE	0	// Warm reboot Edgeport, retaining USB address
273 #define USB_REQUEST_ION_EXEC_DL_CODE	7	// Begin execution of RAM-based download
289 // Define parameter values for our vendor-specific commands
295 // This descriptor is only returned by Edgeport-compatible devices
303 	// This __u32 defines which Vendor-specific commands/functionality
341 	__u8	Length;				// Descriptor Length (per USB spec)
342 	__u8	DescType;			// Descriptor Type (per USB spec, =DEVICE type)
343 	__u8	EpicVer;			// Version of EPiC spec supported
350 	__u8	MajorVersion;			// Firmware version: xx.
362 #define	EDGE_DOWNLOAD_FILE_INTERNAL	0xFF	// Download the file compiled into driver (930 version)
363 #define	EDGE_DOWNLOAD_FILE_I930		0xFF	// Download the file compiled into driver (930 version)
364 #define	EDGE_DOWNLOAD_FILE_80251	0xFE	// Download the file compiled into driver (80251 version)
372 // Version 1 (original) format of DeviceParams
376 // Version 2 format of DeviceParams. This format is longer (3C0h)
392 // Notes for the following two ION vendor-specific param descriptors:
394 //	1.	These have a standard USB descriptor header so they look like a
396 //	2.	Any strings in the structures are in USB-defined string
405 // This structure is ver 2 format. It contains ALL USB descriptors as
409 // xC00-xFBF (length 3C0h) in the ROM.
417 // area for general USB descriptors and the descriptor tables (the root
429 							//     Start of v1-compatible section
430 	__u8	Length;					// F00 Desc length for what follows, per USB (= C0h )
431 	__u8	DescType;				// F01 Desc type, per USB (=DEVICE type)
432 	__u8	DescVer;				// F02 Desc version/format (currently 2)
442 							//     so host can track changes to USB-only descriptors.
444 	__u8	SerNumLength;				// F0C USB string descriptor len
445 	__u8	SerNumDescType;				// F0D USB descriptor type (=STRING type)
446 	__le16	SerialNumber[MAX_SERIALNUMBER_LEN];	// F0E "01-01-000100" Unicode Serial Number
448 	__u8	AssemblyNumLength;			// F26 USB string descriptor len
449 	__u8	AssemblyNumDescType;			// F27 USB descriptor type (=STRING type)
450 	__le16	AssemblyNumber[MAX_ASSEMBLYNUMBER_LEN];	// F28 "350-1000-01-A " assembly number
452 	__u8	OemAssyNumLength;			// F44 USB string descriptor len
453 	__u8	OemAssyNumDescType;			// F45 USB descriptor type (=STRING type)
456 	__u8	ManufDateLength;			// F62 USB string descriptor len
457 	__u8	ManufDateDescType;			// F63 USB descriptor type (=STRING type)
460 	__u8	Reserved3[0x4D];			// F70 -- unused, set to 0 --
463 	__u8	IonPid;					// FBE Product ID, == LSB of USB DevDesc.PID
487 // changes in a software-visible way, such that the 930 software or
492 // Implementation 0 (ie, 930-based)
498 #define MANUF_BOARD_REV_A		1	// Original version, == Manuf Rev A
505 // Implementation 1 (ie, 251+Netchip-based)
510 #define	MANUF_SERNUM_LENGTH		sizeof(((struct edge_manuf_descriptor *)0)->SerialNumber)
511 #define	MANUF_ASSYNUM_LENGTH		sizeof(((struct edge_manuf_descriptor *)0)->AssemblyNumber)
512 #define	MANUF_OEMASSYNUM_LENGTH		sizeof(((struct edge_manuf_descriptor *)0)->OemAssyNumber)
513 #define	MANUF_MANUFDATE_LENGTH		sizeof(((struct edge_manuf_descriptor *)0)->ManufDate)
526 // - FF:xFFF. Note that the 930-mandated UCONFIG bytes are
530 	__u8		Length;			// C0 Desc length, per USB (= 40h)
531 	__u8		DescType;		// C1 Desc type, per USB (= DEVICE type)
532 	__u8		DescVer;		// C2 Desc version/format
533 	__u8		Reserved1;		// C3 -- unused, set to 0 --
535 	__le16		BootCodeLength;		// C4 Boot code goes from FF:0000 to FF:(len-1)
538 	__u8		MajorVersion;		// C6 Firmware version: xx.
542 	__u16		EnumRootDescTable;	// CA Root of ROM-based descriptor table
547 	__le16		Capabilities;		// CE-CF Capabilities flags (LE format)
548 	__u8		Reserved2[0x28];	// D0 -- unused, set to 0 --
549 	__u8		UConfig0;		// F8 930-defined CPU configuration byte 0
550 	__u8		UConfig1;		// F9 930-defined CPU configuration byte 1
551 	__u8		Reserved3[6];		// FA -- unused, set to 0 --
584 #define I2C_DESC_TYPE_WATCHPORT_VERSION	0x15	// firmware version number for watchport
601 // for 3410 the version is stored in the WATCHPORT_FIRMWARE_VERSION descriptor
603 	__u8	Ver_Major;		// Firmware Major version number
604 	__u8	Ver_Minor;		// Firmware Minor version number
610 // Added 2 bytes for version number
611 	__u8	Version_Major;		//  Download Version (for Watchport)
624 				// bit 7: 1 - power switching supported
625 				//        0 - power switching not supported
627 				// bit 0: 1 - self powered
628 				//        0 - bus powered
670 	__u8 Version;		//  Version  member