usb.inc

Cypress USB HID code

;**********************************************************
; USB Descriptor and Request constants
;	source p172,,175 USB specification
;**********************************************************


;	Characterists of bmRequest Value
;
; D7	Data xfer direction
;	0 = Host to device
;	1 = Device to host
;
; D6..5	Type
;	0 = Standard
;	1 = Class
;	2 = Vendor
;	3 = Reserved
;
; D4..0	Recipient
;	0 = Device
;	1 = Interface
;	2 = Endpoint
;	3 = Other
;	4..31 = Reserved


;**************************************
; bmRequestType
HOSTTODEVICE:			equ	00h
DEVICETOHOST:			equ	80h

STANDARD_TYPE:			equ	00h
CLASS_TYPE:				equ	20h
VENDOR_TYPE:			equ	40h
RESERVED_TYPE:			equ	60h

DEVICE_RECIPIENT:		equ	00h
INTERFACE_RECIPIENT:	equ	01h
ENDPOINT_RECIPIENT:		equ	02h
OTHER_RECIPIENT:		equ	03h

;**************************************
; bRequest
GET_STATUS:				equ	00h
CLEAR_FEATURE:			equ	01h
SET_FEATURE:			equ	03h
SET_ADDRESS:			equ	05h
GET_DESCRIPTOR:			equ	06h
SET_DESCRIPTOR:			equ	07h
GET_CONFIGURATION:		equ	08h
SET_CONFIGURATION:		equ	09h
GET_INTERFACE:			equ	0Ah
SET_INTERFACE:			equ	0Bh
SYNCH_FRAME:			equ	0Ch


;**************************************
; Descriptor Types
DEVICE:					equ	01h
CONFIGURATION:			equ	02h
STRING:					equ	03h
INTERFACE:				equ	04h
ENDPOINT:				equ	05h
HID:					equ	21h
HID_REPORT:				equ	22h

;**************************************
; Feature Selectors
DEVICE_REMOTE_WAKEUP:	equ	01h
ENDPOINT_STALL:			equ	00h

;**************************************
; HID Class Request Types
GET_REPORT:				equ	01h
GET_IDLE:				equ	02h
GET_PROTOCOL:			equ	03h
SET_REPORT:				equ	09h
SET_IDLE:				equ	0Ah
SET_PROTOCOL:			equ	0Bh

;**************************************
; HID report formats
HID_BOOT_FMT:				equ	00h
HID_REPORT_FMT:				equ	01h

;**************************************
; ENDPOINT 0 SETUP REQUEST FIELDS
BMREQUESTTYPE:			equ	00h
BREQUEST:				equ	01h
WVALUELO:				equ	02h
WVALUEHI:				equ	03h
WINDEXLO:				equ	04h
WINDEXHI:				equ	05h
WLENGTHLO:				equ	06h
WLENGTHHI:				equ	07h

;**************************************
; Standard Descriptor sizes
DEVICE_DESC_SIZE:		equ	12h
CONFIG_DESC_SIZE:		equ	09h
INTERFACE_DESC_SIZE:	equ	09h
HID_DESC_SIZE:			equ 09h
ENDPOINT_DESC_SIZE:		equ	07h

;**************************************
; configuration Descriptor Bit Fields
BUS_POWERED:			equ	80h
SELF_POWERED:			equ	40h
REMOTE_WAKEUP:			equ	20h

;**************************************
; endpoint descriptor bit fields
EP_OUT:					equ	00h
EP_IN:					equ	80h
EP_CONTROL:				equ	00h
EP_ISO:					equ	01h
EP_BULK:				equ	02h
EP_INT:					equ	03h







;**************************************
; Device Class Codes
HID_CLASS:				equ	03h





;**************************************
; HID report types
hrINPUT:				equ 81h
hrOUTPUT:				equ	91h
hrFEATURE:				equ	B1h
	hrDATA:			equ	00h
	hrCONSTANT:		equ	01h
	hrARRAY:		equ	00h
	hrVARIABLE:		equ	02h
	hrABSOLUTE:		equ	00h
	hrRELATIVE:		equ	04h
	hrLINEAR:		equ	00h
	hrNONLINEAR:	equ	08h
	hrPRESTATE:		equ	00h
	hrNPRESTATE:	equ	10h
	hrNONULL:		equ	00h
	hrNULL:			equ	20h
	hrNVOLATILE:	equ	00h
	hrVOLATILE:		equ	40h
	hrBITFIELD:		equ	00h
	hrBUFFERED:		equ	80h
hrCOLLECTION:			equ	A1h
	hrcPHYSICAL:			equ	00h
	hrcAPPLICATION:			equ	01h
	hrcLOGICAL:				equ	02h
	hrcREPORT:				equ	03h
	hrcNARRAY:				equ	04h
	hrcUSWITCH:				equ	05h
	hrcUMODIFIER:			equ	06h
	hrcVENDOR:				equ 80h
hrENDCOLLECT:			equ	C0h

hrUPAGE:				equ	05h
hrVUPAGE:				equ	06h
	hruGDESKTOP:		equ	01h
	hruSIMCONTROL:		equ 02h
	hruVRCONTROL:		equ	03h
	hruSPORTCONTROL:	equ 04h
	hruGAMECONTROL:		equ	05h
	hruGENCONTROL:		equ 06h
	hruKEYBOARD:		equ	07h
	hruLED:				equ	08h
	hruBUTTON:			equ	09h
	hruORDINAL:			equ	0Ah
	hruTELEPHONY:		equ	0Bh
	hruCONSUMER:		equ	0Ch
	hruDIGITIZER:		equ	0Dh
	hruPIDPAGE:			equ 0Fh
	hruUNICODE:			equ	10h
	hruALPHANUM:		equ	14h
	hruMEDICAL:			equ	40h
	hruMONITOR:			equ	80h
	hruPOWER:			equ	84h
	hruBARCODE:			equ	8Ch
	hruSCALE:			equ	8Dh
	hruMAGNETIC:		equ 8Eh
	hruPOS:				equ	8Fh
	hruCAMERA:			equ	90h
hrUMIN:					equ	19h
hrUMAX:					equ	29h
hrLMIN:					equ	15h
hrLMINex:				equ	16h
hrLMAX:					equ	25h
hrLMAXex:				equ	26h
hrRCOUNT:				equ	95h
hrRSIZE:				equ	75h
hrUNITS:				equ	67h
; see table in 6.2.2.7 of the HUT spec for information
; on how to assign units 
hrUEXPS:				equ	55h
	; NOTE that this section does not cover
	; all usage page IDs!!!
hrUSAGE:				equ	09h
	; generic desktop usage ID's
	hrgdPOINTER:		equ 01h
	hrgdMOUSE:			equ 02h
	hrgdJOYSTICK:		equ	04h
	hrgdGAMEPAD:		equ 05h
	hrgdKEYBOARD:		equ	06h
	hrgdKEYPAD:			equ 07h
	hrgdMAXISCONTROL:	equ 08h
	hrgdX:				equ 30h
	hrgdY:				equ 31h
	hrgdZ:				equ	32h
	hrgdRX:				equ 33h
	hrgdRY:				equ	34h
	hrgdRZ:				equ	35h
	hrgdSLIDER:			equ	36h
	hrgdDIAL:			equ	37h
	hrgdWHEEL:			equ	38h
	hrgdHATSWITCH:		equ	39h
	hrgdCOUNTBUFF:		equ 3Ah
	hrgdBYTECOUNT:		equ 3Bh
	hrgdMOTIONWAKE:		equ	3Ch
	hrgdSTART:			equ	3Dh
	hrgdSELECT:			equ	3Eh
	hrgdVX:				equ	40h
	hrgdVY:				equ	41h
	hrgdVZ:				equ	42h
	hrgdVBRX:			equ	43h
	hrgdVBRY:			equ	44h
	hrgdVBRZ:			equ	45h
	hrgdVNO:			equ	46h
	hrgdFEATURENOTE:	equ	47h
	hrgdSYSCONTROL:		equ	80h
	hrgdSYSPOWERD:		equ 81h
	hrgdSYSSLEEP:		equ 82h
	hrgdSYSWAKE:		equ	83h
	hrgdSYSCONTEXT:		equ	84h
	hrgdSYSMAIN:		equ	85h
	hrgdSYSAPP:			equ	86h
	hrgdSYSHELP:		equ	87h
	hrgdSYSEXIT:		equ	88h
	hrgdSYSSELECT:		equ	89h
	hrgdSYSRIGHT:		equ	8Ah
	hrgdSYSLEFT:		equ	8Bh
	hrgdSYSUP:			equ	8Ch
	hrgdSYSDOWN:		equ	8Dh
	hrgdSYSCRESTART:	equ	8Eh
	hrgdSYSWRESTART:	equ	8Fh
	hrgdDPADUP:			equ	90h
	hrgdDPADDOWN:		equ	91h	
	hrgdDPADRIGHT:		equ	92h	
	hrgdDPADLEFT:		equ	93h
	hrgdSYSDOCK:		equ A0h		
	hrgdSYSUNDOCK:		equ A1h
	hrgdSYSSETUP:		equ	A2h
	hrgdSYSBREAK:		equ	A3h
	hrgdSYSDEBUG:		equ	A4h
	hrgdAPPBREAK:		equ	A5h
	hrgdAPPDEBUG:		equ	A6h
	hrgdSYSMUTE:		equ	A7h
	hrgdSYSHIBERNATE:	equ	A8h
	hrgdSYSDINVERT:		equ B0h
	hrgdSYSDINTERNAL:	equ	B1h
	hrgdSYSDEXTERNAL:	equ	B2h
	hrgdSYSDBOTH:		equ	B3h
	hrgdSYSDDUAL:		equ	B4h
	hrgdSYSDTOGGLE:		equ	B5h
	hrgdSYSDSWAP:		equ	B6h
	hrgdSYSDAUTOSCL:	equ	B7h

	; LED usage IDs
	hrlNUMLOCK:			equ	01h
	hrlCAPSLOCK:		equ	02h
	hrlSCROLLLOCK:		equ	03h
	hrlCOMPOSE:			equ	04h
	hrlKANA:			equ	05h
	hrlPOWER:			equ	06h
	hrlSHIFT:			equ	07h
	hrlDNDISTURB:		equ	08h
	hrlMUTE:			equ	09h
	hrlTONEENA:			equ 0Ah
	hrlHIFILT:			equ	0Bh
	hrlLOFILT:			equ	0Ch
	hrlEQENA:			equ	0Dh
	hrlSOUNDFIELD:		equ	0Eh
	hrlSURROUND:		equ 0Fh
	hrlREPEAT:			equ 10h
	hrlSTEREO:			equ	11h
	hrlSRDETECT:		equ 12h
	hrlSPINNING:		equ	13h
	hrlCAV:				equ 14h
	hrlCLV:				equ	15h
	hrlFORMATDETECT:	equ	16h
	hrlOFFHOOK:			equ	17h
	hrlRING:			equ	18h
	hrlMESSAGE:			equ	19h
	hrlDATAMODE:		equ	1Ah
	hrlBATTERYOP:		equ	1Bh
	hrlBATTOK:			equ 1Ch
	hrlBATTLOW:			equ 1Dh
	hrlSPEAKER:			equ	1Eh
	hrlHEADSET:			equ	1Fh
	hrlHOLD:			equ 20h
	hrlMICROPHONE:		equ	21h
	hrlCOVERAGE:		equ	22h
	hrlNIGHTMODE:		equ	23h
	hrlSENDCALLS:		equ	24h
	hrlCALLPICKUP:		equ	25h
	hrlCONFERENCE:		equ 26h
	hrlSTANDBY:			equ	27h
	hrlCAMERAON:		equ	28h
	hrlCAMERAOFF:		equ	29h
	hrlONLINE:			equ	2Ah
	hrlOFFLINE:			equ	2Bh
	hrlBUSY:			equ	2Ch
	hrlREADY:			equ	2Dh
	hrlPAPEROUT:		equ	2Eh
	hrlPAPERJAM:		equ	2Fh
	hrlREMOTE:			equ	30h
	hrlFORWARD:			equ	31h
	hrlREVERSE:			equ	32h
	hrlSTOP:			equ	33h
	hrlREWIND:			equ	34h
	hrlFASTFORARD:		equ	35h
	hrlPLAY:			equ	36h
	hrlPAUSE:			equ	37h
	hrlRECORD:			equ	38h
	hrlERROR:			equ	39h
	hrlSELINDICATOR:	equ	3Ah
	hrlINUSE:			equ	3Bh
	hrlMULTIMODE:		equ	3Ch
	hrlINDON:			equ	3Dh
	hrlINDFLASH:		equ	3Eh
	hrlINDSLOWBLINK:	equ	3Fh
	hrlINDFASTBLINK:	equ	40h
	hrlINDOFFSEL:		equ	41h
	hrlFLASHON:			equ	42h
	hrlSLOWBLINKON:		equ	43h
	hrlSLOWBLINKOFF:	equ	44h
	hrlFASTBLINKON:		equ	45h
	hrlFASTBLINKOFF:	equ	46h
	hrlINDCOLOR:		equ	47h
	hrlINDRED:			equ	48h
	hrlINDGREEN:		equ	49h
	hrlINDAMBER:		equ	4Ah
	hrlINDGENERIC:		equ	4Bh
	hrlSYSSUSPEND:		equ	4Ch
	hrlEXTPOWER:		equ	4Dh

	; button usage IDs
	; These are just numbered starting at #1 and working
	; up from there.

	; ordinal usage IDs
	; These are just numbered starting at #1 and working
	; up from there.