AndroidAccessory - Library to allow your mbed device to communicate …

Users » richbayliss » Code » AndroidAccessory

Library to allow your mbed device to communicate with the Android ADK.

USBHost.h@3:ca0516beb781, 2011-07-12 (annotated)

Committer:: richbayliss
Date:: Tue Jul 12 17:36:58 2011 +0000
Revision:: 3:ca0516beb781
Parent:: 0:8a0d4584ca86

Who changed what in which revision?

User	Revision	Line number	New contents of line
richbayliss	0:8a0d4584ca86	1
richbayliss	0:8a0d4584ca86	2	/*
richbayliss	0:8a0d4584ca86	3	Copyright (c) 2010 Peter Barrett
richbayliss	0:8a0d4584ca86	4
richbayliss	0:8a0d4584ca86	5	Permission is hereby granted, free of charge, to any person obtaining a copy
richbayliss	0:8a0d4584ca86	6	of this software and associated documentation files (the "Software"), to deal
richbayliss	0:8a0d4584ca86	7	in the Software without restriction, including without limitation the rights
richbayliss	0:8a0d4584ca86	8	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
richbayliss	0:8a0d4584ca86	9	copies of the Software, and to permit persons to whom the Software is
richbayliss	0:8a0d4584ca86	10	furnished to do so, subject to the following conditions:
richbayliss	0:8a0d4584ca86	11
richbayliss	0:8a0d4584ca86	12	The above copyright notice and this permission notice shall be included in
richbayliss	0:8a0d4584ca86	13	all copies or substantial portions of the Software.
richbayliss	0:8a0d4584ca86	14
richbayliss	0:8a0d4584ca86	15	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
richbayliss	0:8a0d4584ca86	16	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
richbayliss	0:8a0d4584ca86	17	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
richbayliss	0:8a0d4584ca86	18	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
richbayliss	0:8a0d4584ca86	19	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
richbayliss	0:8a0d4584ca86	20	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
richbayliss	0:8a0d4584ca86	21	THE SOFTWARE.
richbayliss	0:8a0d4584ca86	22	*/
richbayliss	0:8a0d4584ca86	23
richbayliss	0:8a0d4584ca86	24	#ifndef USBHOST_H
richbayliss	0:8a0d4584ca86	25	#define USBHOST_H
richbayliss	0:8a0d4584ca86	26
richbayliss	0:8a0d4584ca86	27	//log mode on off
richbayliss	0:8a0d4584ca86	28	//#define USBHOST_LOG
richbayliss	0:8a0d4584ca86	29
richbayliss	0:8a0d4584ca86	30
richbayliss	0:8a0d4584ca86	31	#ifndef u8
richbayliss	0:8a0d4584ca86	32	typedef unsigned char u8;
richbayliss	0:8a0d4584ca86	33	typedef unsigned short u16;
richbayliss	0:8a0d4584ca86	34	typedef unsigned long u32;
richbayliss	0:8a0d4584ca86	35
richbayliss	0:8a0d4584ca86	36	typedef char s8;
richbayliss	0:8a0d4584ca86	37	typedef short s16;
richbayliss	0:8a0d4584ca86	38	typedef char s32;
richbayliss	0:8a0d4584ca86	39	#endif
richbayliss	0:8a0d4584ca86	40
richbayliss	0:8a0d4584ca86	41	#define ENDPOINT_CONTROL 0
richbayliss	0:8a0d4584ca86	42	#define ENDPOINT_ISOCRONOUS 1
richbayliss	0:8a0d4584ca86	43	#define ENDPOINT_BULK 2
richbayliss	0:8a0d4584ca86	44	#define ENDPOINT_INTERRUPT 3
richbayliss	0:8a0d4584ca86	45
richbayliss	0:8a0d4584ca86	46	#define DESCRIPTOR_TYPE_DEVICE 1
richbayliss	0:8a0d4584ca86	47	#define DESCRIPTOR_TYPE_CONFIGURATION 2
richbayliss	0:8a0d4584ca86	48	#define DESCRIPTOR_TYPE_STRING 3
richbayliss	0:8a0d4584ca86	49	#define DESCRIPTOR_TYPE_INTERFACE 4
richbayliss	0:8a0d4584ca86	50	#define DESCRIPTOR_TYPE_ENDPOINT 5
richbayliss	0:8a0d4584ca86	51
richbayliss	0:8a0d4584ca86	52	#define DESCRIPTOR_TYPE_HID 0x21
richbayliss	0:8a0d4584ca86	53	#define DESCRIPTOR_TYPE_REPORT 0x22
richbayliss	0:8a0d4584ca86	54	#define DESCRIPTOR_TYPE_PHYSICAL 0x23
richbayliss	0:8a0d4584ca86	55	#define DESCRIPTOR_TYPE_HUB 0x29
richbayliss	0:8a0d4584ca86	56
richbayliss	0:8a0d4584ca86	57	enum USB_CLASS_CODE
richbayliss	0:8a0d4584ca86	58	{
richbayliss	0:8a0d4584ca86	59	CLASS_DEVICE,
richbayliss	0:8a0d4584ca86	60	CLASS_AUDIO,
richbayliss	0:8a0d4584ca86	61	CLASS_COMM_AND_CDC_CONTROL,
richbayliss	0:8a0d4584ca86	62	CLASS_HID,
richbayliss	0:8a0d4584ca86	63	CLASS_PHYSICAL = 0x05,
richbayliss	0:8a0d4584ca86	64	CLASS_STILL_IMAGING,
richbayliss	0:8a0d4584ca86	65	CLASS_PRINTER,
richbayliss	0:8a0d4584ca86	66	CLASS_MASS_STORAGE,
richbayliss	0:8a0d4584ca86	67	CLASS_HUB,
richbayliss	0:8a0d4584ca86	68	CLASS_CDC_DATA,
richbayliss	0:8a0d4584ca86	69	CLASS_SMART_CARD,
richbayliss	0:8a0d4584ca86	70	CLASS_CONTENT_SECURITY = 0x0D,
richbayliss	0:8a0d4584ca86	71	CLASS_VIDEO = 0x0E,
richbayliss	0:8a0d4584ca86	72	CLASS_DIAGNOSTIC_DEVICE = 0xDC,
richbayliss	0:8a0d4584ca86	73	CLASS_WIRELESS_CONTROLLER = 0xE0,
richbayliss	0:8a0d4584ca86	74	CLASS_MISCELLANEOUS = 0xEF,
richbayliss	0:8a0d4584ca86	75	CLASS_APP_SPECIFIC = 0xFE,
richbayliss	0:8a0d4584ca86	76	CLASS_VENDOR_SPECIFIC = 0xFF
richbayliss	0:8a0d4584ca86	77	};
richbayliss	0:8a0d4584ca86	78
richbayliss	0:8a0d4584ca86	79	#define DEVICE_TO_HOST 0x80
richbayliss	0:8a0d4584ca86	80	#define HOST_TO_DEVICE 0x00
richbayliss	0:8a0d4584ca86	81	#define REQUEST_TYPE_STANDARD 0x00
richbayliss	0:8a0d4584ca86	82	#define REQUEST_TYPE_CLASS 0x20
richbayliss	0:8a0d4584ca86	83	#define REQUEST_TYPE_VENDOR 0x40
richbayliss	0:8a0d4584ca86	84	#define RECIPIENT_DEVICE 0x00
richbayliss	0:8a0d4584ca86	85	#define RECIPIENT_INTERFACE 0x01
richbayliss	0:8a0d4584ca86	86	#define RECIPIENT_ENDPOINT 0x02
richbayliss	0:8a0d4584ca86	87	#define RECIPIENT_OTHER 0x03
richbayliss	0:8a0d4584ca86	88
richbayliss	0:8a0d4584ca86	89	#define GET_STATUS 0
richbayliss	0:8a0d4584ca86	90	#define CLEAR_FEATURE 1
richbayliss	0:8a0d4584ca86	91	#define SET_FEATURE 3
richbayliss	0:8a0d4584ca86	92	#define SET_ADDRESS 5
richbayliss	0:8a0d4584ca86	93	#define GET_DESCRIPTOR 6
richbayliss	0:8a0d4584ca86	94	#define SET_DESCRIPTOR 7
richbayliss	0:8a0d4584ca86	95	#define GET_CONFIGURATION 8
richbayliss	0:8a0d4584ca86	96	#define SET_CONFIGURATION 9
richbayliss	0:8a0d4584ca86	97	#define GET_INTERFACE 10
richbayliss	0:8a0d4584ca86	98	#define SET_INTERFACE 11
richbayliss	0:8a0d4584ca86	99	#define SYNCH_FRAME 11
richbayliss	0:8a0d4584ca86	100
richbayliss	0:8a0d4584ca86	101	/* HID Request Codes */
richbayliss	0:8a0d4584ca86	102	#define HID_REQUEST_GET_REPORT 0x01
richbayliss	0:8a0d4584ca86	103	#define HID_REQUEST_GET_IDLE 0x02
richbayliss	0:8a0d4584ca86	104	#define HID_REQUEST_GET_PROTOCOL 0x03
richbayliss	0:8a0d4584ca86	105	#define HID_REQUEST_SET_REPORT 0x09
richbayliss	0:8a0d4584ca86	106	#define HID_REQUEST_SET_IDLE 0x0A
richbayliss	0:8a0d4584ca86	107	#define HID_REQUEST_SET_PROTOCOL 0x0B
richbayliss	0:8a0d4584ca86	108
richbayliss	0:8a0d4584ca86	109	/* HID Report Types */
richbayliss	0:8a0d4584ca86	110	#define HID_REPORT_INPUT 0x01
richbayliss	0:8a0d4584ca86	111	#define HID_REPORT_OUTPUT 0x02
richbayliss	0:8a0d4584ca86	112	#define HID_REPORT_FEATURE 0x03
richbayliss	0:8a0d4584ca86	113
richbayliss	0:8a0d4584ca86	114
richbayliss	0:8a0d4584ca86	115	// -5 is nak
richbayliss	0:8a0d4584ca86	116	/*
richbayliss	0:8a0d4584ca86	117	0010 ACK Handshake
richbayliss	0:8a0d4584ca86	118	1010 NAK Handshake
richbayliss	0:8a0d4584ca86	119	1110 STALL Handshake
richbayliss	0:8a0d4584ca86	120	0110 NYET (No Response Yet)
richbayliss	0:8a0d4584ca86	121	*/
richbayliss	0:8a0d4584ca86	122
richbayliss	0:8a0d4584ca86	123	#define IO_PENDING -100
richbayliss	0:8a0d4584ca86	124	#define ERR_ENDPOINT_NONE_LEFT -101
richbayliss	0:8a0d4584ca86	125	#define ERR_ENDPOINT_NOT_FOUND -102
richbayliss	0:8a0d4584ca86	126	#define ERR_DEVICE_NOT_FOUND -103
richbayliss	0:8a0d4584ca86	127	#define ERR_DEVICE_NONE_LEFT -104
richbayliss	0:8a0d4584ca86	128	#define ERR_HUB_INIT_FAILED -105
richbayliss	0:8a0d4584ca86	129	#define ERR_INTERFACE_NOT_FOUND -106
richbayliss	0:8a0d4584ca86	130
richbayliss	0:8a0d4584ca86	131	typedef struct
richbayliss	0:8a0d4584ca86	132	{
richbayliss	0:8a0d4584ca86	133	u8 bLength;
richbayliss	0:8a0d4584ca86	134	u8 bDescriptorType;
richbayliss	0:8a0d4584ca86	135	u16 bcdUSB;
richbayliss	0:8a0d4584ca86	136	u8 bDeviceClass;
richbayliss	0:8a0d4584ca86	137	u8 bDeviceSubClass;
richbayliss	0:8a0d4584ca86	138	u8 bDeviceProtocol;
richbayliss	0:8a0d4584ca86	139	u8 bMaxPacketSize;
richbayliss	0:8a0d4584ca86	140	u16 idVendor;
richbayliss	0:8a0d4584ca86	141	u16 idProduct;
richbayliss	0:8a0d4584ca86	142	u16 bcdDevice; // version
richbayliss	0:8a0d4584ca86	143	u8 iManufacturer;
richbayliss	0:8a0d4584ca86	144	u8 iProduct;
richbayliss	0:8a0d4584ca86	145	u8 iSerialNumber;
richbayliss	0:8a0d4584ca86	146	u8 bNumConfigurations;
richbayliss	0:8a0d4584ca86	147	} DeviceDescriptor; // 16 bytes
richbayliss	0:8a0d4584ca86	148
richbayliss	0:8a0d4584ca86	149	typedef struct
richbayliss	0:8a0d4584ca86	150	{
richbayliss	0:8a0d4584ca86	151	u8 bLength;
richbayliss	0:8a0d4584ca86	152	u8 bDescriptorType;
richbayliss	0:8a0d4584ca86	153	u16 wTotalLength;
richbayliss	0:8a0d4584ca86	154	u8 bNumInterfaces;
richbayliss	0:8a0d4584ca86	155	u8 bConfigurationValue; // Value to use as an argument to select this configuration
richbayliss	0:8a0d4584ca86	156	u8 iConfiguration; // Index of String Descriptor describing this configuration
richbayliss	0:8a0d4584ca86	157	u8 bmAttributes; // Bitmap D7 Reserved, set to 1. (USB 1.0 Bus Powered),D6 Self Powered,D5 Remote Wakeup,D4..0 = 0
richbayliss	0:8a0d4584ca86	158	u8 bMaxPower; // Maximum Power Consumption in 2mA units
richbayliss	0:8a0d4584ca86	159	} ConfigurationDescriptor;
richbayliss	0:8a0d4584ca86	160
richbayliss	0:8a0d4584ca86	161	typedef struct
richbayliss	0:8a0d4584ca86	162	{
richbayliss	0:8a0d4584ca86	163	u8 bLength;
richbayliss	0:8a0d4584ca86	164	u8 bDescriptorType;
richbayliss	0:8a0d4584ca86	165	u8 bInterfaceNumber;
richbayliss	0:8a0d4584ca86	166	u8 bAlternateSetting;
richbayliss	0:8a0d4584ca86	167	u8 bNumEndpoints;
richbayliss	0:8a0d4584ca86	168	u8 bInterfaceClass;
richbayliss	0:8a0d4584ca86	169	u8 bInterfaceSubClass;
richbayliss	0:8a0d4584ca86	170	u8 bInterfaceProtocol;
richbayliss	0:8a0d4584ca86	171	u8 iInterface; // Index of String Descriptor Describing this interface
richbayliss	0:8a0d4584ca86	172	} InterfaceDescriptor;
richbayliss	0:8a0d4584ca86	173
richbayliss	0:8a0d4584ca86	174	typedef struct
richbayliss	0:8a0d4584ca86	175	{
richbayliss	0:8a0d4584ca86	176	u8 bLength;
richbayliss	0:8a0d4584ca86	177	u8 bDescriptorType;
richbayliss	0:8a0d4584ca86	178	u8 bEndpointAddress; // Bits 0:3 endpoint, Bits 7 Direction 0 = Out, 1 = In (Ignored for Control Endpoints)
richbayliss	0:8a0d4584ca86	179	u8 bmAttributes; // Bits 0:1 00 = Control, 01 = Isochronous, 10 = Bulk, 11 = Interrupt
richbayliss	0:8a0d4584ca86	180	u16 wMaxPacketSize;
richbayliss	0:8a0d4584ca86	181	u8 bInterval; // Interval for polling endpoint data transfers.
richbayliss	0:8a0d4584ca86	182	} EndpointDescriptor;
richbayliss	0:8a0d4584ca86	183
richbayliss	0:8a0d4584ca86	184	typedef struct {
richbayliss	0:8a0d4584ca86	185	u8 bLength;
richbayliss	0:8a0d4584ca86	186	u8 bDescriptorType;
richbayliss	0:8a0d4584ca86	187	u16 bcdHID;
richbayliss	0:8a0d4584ca86	188	u8 bCountryCode;
richbayliss	0:8a0d4584ca86	189	u8 bNumDescriptors;
richbayliss	0:8a0d4584ca86	190	u8 bDescriptorType2;
richbayliss	0:8a0d4584ca86	191	u16 wDescriptorLength;
richbayliss	0:8a0d4584ca86	192	} HIDDescriptor;
richbayliss	0:8a0d4584ca86	193
richbayliss	0:8a0d4584ca86	194	//============================================================================
richbayliss	0:8a0d4584ca86	195	//============================================================================
richbayliss	0:8a0d4584ca86	196
richbayliss	0:8a0d4584ca86	197
richbayliss	0:8a0d4584ca86	198	void USBInit();
richbayliss	0:8a0d4584ca86	199	void USBLoop();
richbayliss	0:8a0d4584ca86	200	u8* USBGetBuffer(u32* len);
richbayliss	0:8a0d4584ca86	201
richbayliss	0:8a0d4584ca86	202	// Optional callback for transfers, called at interrupt time
richbayliss	0:8a0d4584ca86	203	typedef void (USBCallback)(int device, int endpoint, int status, u8 data, int len, void* userData);
richbayliss	0:8a0d4584ca86	204
richbayliss	0:8a0d4584ca86	205	// Transfers
richbayliss	0:8a0d4584ca86	206	int USBControlTransfer(int device, int request_type, int request, int value, int index, u8* data, int length, USBCallback callback = 0, void* userData = 0);
richbayliss	0:8a0d4584ca86	207	int USBInterruptTransfer(int device, int ep, u8* data, int length, USBCallback callback = 0, void* userData = 0);
richbayliss	0:8a0d4584ca86	208	int USBBulkTransfer(int device, int ep, u8* data, int length, USBCallback callback = 0, void* userData = 0);
richbayliss	0:8a0d4584ca86	209
richbayliss	0:8a0d4584ca86	210	// Standard Device methods
richbayliss	0:8a0d4584ca86	211	int GetDescriptor(int device, int descType, int descIndex, u8* data, int length);
richbayliss	0:8a0d4584ca86	212	int GetString(int device, int index, char* dst, int length);
richbayliss	0:8a0d4584ca86	213	int SetAddress(int device, int new_addr);
richbayliss	0:8a0d4584ca86	214	int SetConfiguration(int device, int configNum);
richbayliss	0:8a0d4584ca86	215	int SetInterface(int device, int ifNum, int altNum);
richbayliss	0:8a0d4584ca86	216
richbayliss	0:8a0d4584ca86	217	// Implemented to notify app of the arrival of a device
richbayliss	0:8a0d4584ca86	218	void OnLoadDevice(int device, DeviceDescriptor* deviceDesc, InterfaceDescriptor* interfaceDesc);
richbayliss	0:8a0d4584ca86	219
richbayliss	0:8a0d4584ca86	220	#endif

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	11 Jul 2011
Imports:	57
Forks:	0
Commits:	4
Dependents:	0
Dependencies:	0
Followers:	6

USBHost.h@3:ca0516beb781, 2011-07-12 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning