Usb - | Mbed

Users » slowness » Code » Usb

USBHostLite/usbhost_lpc17xx.h@0:2063c10a1022, 2011-08-28 (annotated)

Committer:: slowness
Date:: Sun Aug 28 16:16:43 2011 +0000
Revision:: 0:2063c10a1022

Who changed what in which revision?

User	Revision	Line number	New contents of line
slowness	0:2063c10a1022	1	/*
slowness	0:2063c10a1022	2	**************************************************************************************************************
slowness	0:2063c10a1022	3	* NXP USB Host Stack
slowness	0:2063c10a1022	4	*
slowness	0:2063c10a1022	5	* (c) Copyright 2008, NXP SemiConductors
slowness	0:2063c10a1022	6	* (c) Copyright 2008, OnChip Technologies LLC
slowness	0:2063c10a1022	7	* All Rights Reserved
slowness	0:2063c10a1022	8	*
slowness	0:2063c10a1022	9	* www.nxp.com
slowness	0:2063c10a1022	10	* www.onchiptech.com
slowness	0:2063c10a1022	11	*
slowness	0:2063c10a1022	12	* File : usbhost_lpc17xx.h
slowness	0:2063c10a1022	13	* Programmer(s) : Ravikanth.P
slowness	0:2063c10a1022	14	* Version :
slowness	0:2063c10a1022	15	*
slowness	0:2063c10a1022	16	**************************************************************************************************************
slowness	0:2063c10a1022	17	*/
slowness	0:2063c10a1022	18
slowness	0:2063c10a1022	19	#ifndef USBHOST_LPC17xx_H
slowness	0:2063c10a1022	20	#define USBHOST_LPC17xx_H
slowness	0:2063c10a1022	21
slowness	0:2063c10a1022	22	/*
slowness	0:2063c10a1022	23	**************************************************************************************************************
slowness	0:2063c10a1022	24	* INCLUDE HEADER FILES
slowness	0:2063c10a1022	25	**************************************************************************************************************
slowness	0:2063c10a1022	26	*/
slowness	0:2063c10a1022	27
slowness	0:2063c10a1022	28	#include "usbhost_inc.h"
slowness	0:2063c10a1022	29
slowness	0:2063c10a1022	30	/*
slowness	0:2063c10a1022	31	**************************************************************************************************************
slowness	0:2063c10a1022	32	* PRINT CONFIGURATION
slowness	0:2063c10a1022	33	**************************************************************************************************************
slowness	0:2063c10a1022	34	*/
slowness	0:2063c10a1022	35
slowness	0:2063c10a1022	36	#define PRINT_ENABLE 1
slowness	0:2063c10a1022	37
slowness	0:2063c10a1022	38	#if PRINT_ENABLE
slowness	0:2063c10a1022	39	#define PRINT_Log(...) printf(__VA_ARGS__)
slowness	0:2063c10a1022	40	#define PRINT_Err(rc) printf("ERROR: In %s at Line %u - rc = %d\n", __FUNCTION__, __LINE__, rc)
slowness	0:2063c10a1022	41
slowness	0:2063c10a1022	42	#else
slowness	0:2063c10a1022	43	#define PRINT_Log(...) do {} while(0)
slowness	0:2063c10a1022	44	#define PRINT_Err(rc) do {} while(0)
slowness	0:2063c10a1022	45
slowness	0:2063c10a1022	46	#endif
slowness	0:2063c10a1022	47
slowness	0:2063c10a1022	48	/*
slowness	0:2063c10a1022	49	**************************************************************************************************************
slowness	0:2063c10a1022	50	* GENERAL DEFINITIONS
slowness	0:2063c10a1022	51	**************************************************************************************************************
slowness	0:2063c10a1022	52	*/
slowness	0:2063c10a1022	53
slowness	0:2063c10a1022	54	#define DESC_LENGTH(x) x[0]
slowness	0:2063c10a1022	55	#define DESC_TYPE(x) x[1]
slowness	0:2063c10a1022	56
slowness	0:2063c10a1022	57
slowness	0:2063c10a1022	58	#define HOST_GET_DESCRIPTOR(descType, descIndex, data, length) \
slowness	0:2063c10a1022	59	Host_CtrlRecv(USB_DEVICE_TO_HOST \| USB_RECIPIENT_DEVICE, GET_DESCRIPTOR, \
slowness	0:2063c10a1022	60	(descType << 8)\|(descIndex), 0, length, data)
slowness	0:2063c10a1022	61
slowness	0:2063c10a1022	62	#define HOST_SET_ADDRESS(new_addr) \
slowness	0:2063c10a1022	63	Host_CtrlSend(USB_HOST_TO_DEVICE \| USB_RECIPIENT_DEVICE, SET_ADDRESS, \
slowness	0:2063c10a1022	64	new_addr, 0, 0, NULL)
slowness	0:2063c10a1022	65
slowness	0:2063c10a1022	66	#define USBH_SET_CONFIGURATION(configNum) \
slowness	0:2063c10a1022	67	Host_CtrlSend(USB_HOST_TO_DEVICE \| USB_RECIPIENT_DEVICE, SET_CONFIGURATION, \
slowness	0:2063c10a1022	68	configNum, 0, 0, NULL)
slowness	0:2063c10a1022	69
slowness	0:2063c10a1022	70	#define USBH_SET_INTERFACE(ifNum, altNum) \
slowness	0:2063c10a1022	71	Host_CtrlSend(USB_HOST_TO_DEVICE \| USB_RECIPIENT_INTERFACE, SET_INTERFACE, \
slowness	0:2063c10a1022	72	altNum, ifNum, 0, NULL)
slowness	0:2063c10a1022	73
slowness	0:2063c10a1022	74	/*
slowness	0:2063c10a1022	75	**************************************************************************************************************
slowness	0:2063c10a1022	76	* OHCI OPERATIONAL REGISTER FIELD DEFINITIONS
slowness	0:2063c10a1022	77	**************************************************************************************************************
slowness	0:2063c10a1022	78	*/
slowness	0:2063c10a1022	79
slowness	0:2063c10a1022	80	/* ------------------ HcControl Register --------------------- */
slowness	0:2063c10a1022	81	#define OR_CONTROL_CLE 0x00000010
slowness	0:2063c10a1022	82	#define OR_CONTROL_BLE 0x00000020
slowness	0:2063c10a1022	83	#define OR_CONTROL_HCFS 0x000000C0
slowness	0:2063c10a1022	84	#define OR_CONTROL_HC_OPER 0x00000080
slowness	0:2063c10a1022	85	/* ----------------- HcCommandStatus Register ----------------- */
slowness	0:2063c10a1022	86	#define OR_CMD_STATUS_HCR 0x00000001
slowness	0:2063c10a1022	87	#define OR_CMD_STATUS_CLF 0x00000002
slowness	0:2063c10a1022	88	#define OR_CMD_STATUS_BLF 0x00000004
slowness	0:2063c10a1022	89	/* --------------- HcInterruptStatus Register ----------------- */
slowness	0:2063c10a1022	90	#define OR_INTR_STATUS_WDH 0x00000002
slowness	0:2063c10a1022	91	#define OR_INTR_STATUS_RHSC 0x00000040
slowness	0:2063c10a1022	92	/* --------------- HcInterruptEnable Register ----------------- */
slowness	0:2063c10a1022	93	#define OR_INTR_ENABLE_WDH 0x00000002
slowness	0:2063c10a1022	94	#define OR_INTR_ENABLE_RHSC 0x00000040
slowness	0:2063c10a1022	95	#define OR_INTR_ENABLE_MIE 0x80000000
slowness	0:2063c10a1022	96	/* ---------------- HcRhDescriptorA Register ------------------ */
slowness	0:2063c10a1022	97	#define OR_RH_STATUS_LPSC 0x00010000
slowness	0:2063c10a1022	98	#define OR_RH_STATUS_DRWE 0x00008000
slowness	0:2063c10a1022	99	/* -------------- HcRhPortStatus[1:NDP] Register -------------- */
slowness	0:2063c10a1022	100	#define OR_RH_PORT_CCS 0x00000001
slowness	0:2063c10a1022	101	#define OR_RH_PORT_PRS 0x00000010
slowness	0:2063c10a1022	102	#define OR_RH_PORT_CSC 0x00010000
slowness	0:2063c10a1022	103	#define OR_RH_PORT_PRSC 0x00100000
slowness	0:2063c10a1022	104
slowness	0:2063c10a1022	105
slowness	0:2063c10a1022	106	/*
slowness	0:2063c10a1022	107	**************************************************************************************************************
slowness	0:2063c10a1022	108	* FRAME INTERVAL
slowness	0:2063c10a1022	109	**************************************************************************************************************
slowness	0:2063c10a1022	110	*/
slowness	0:2063c10a1022	111
slowness	0:2063c10a1022	112	#define FI 0x2EDF /* 12000 bits per frame (-1) */
slowness	0:2063c10a1022	113	#define DEFAULT_FMINTERVAL ((((6 * (FI - 210)) / 7) << 16) \| FI)
slowness	0:2063c10a1022	114
slowness	0:2063c10a1022	115	/*
slowness	0:2063c10a1022	116	**************************************************************************************************************
slowness	0:2063c10a1022	117	* TRANSFER DESCRIPTOR CONTROL FIELDS
slowness	0:2063c10a1022	118	**************************************************************************************************************
slowness	0:2063c10a1022	119	*/
slowness	0:2063c10a1022	120
slowness	0:2063c10a1022	121	#define TD_ROUNDING (USB_INT32U) (0x00040000) /* Buffer Rounding */
slowness	0:2063c10a1022	122	#define TD_SETUP (USB_INT32U)(0) /* Direction of Setup Packet */
slowness	0:2063c10a1022	123	#define TD_IN (USB_INT32U)(0x00100000) /* Direction In */
slowness	0:2063c10a1022	124	#define TD_OUT (USB_INT32U)(0x00080000) /* Direction Out */
slowness	0:2063c10a1022	125	#define TD_DELAY_INT(x) (USB_INT32U)((x) << 21) /* Delay Interrupt */
slowness	0:2063c10a1022	126	#define TD_TOGGLE_0 (USB_INT32U)(0x02000000) /* Toggle 0 */
slowness	0:2063c10a1022	127	#define TD_TOGGLE_1 (USB_INT32U)(0x03000000) /* Toggle 1 */
slowness	0:2063c10a1022	128	#define TD_CC (USB_INT32U)(0xF0000000) /* Completion Code */
slowness	0:2063c10a1022	129
slowness	0:2063c10a1022	130	/*
slowness	0:2063c10a1022	131	**************************************************************************************************************
slowness	0:2063c10a1022	132	* USB STANDARD REQUEST DEFINITIONS
slowness	0:2063c10a1022	133	**************************************************************************************************************
slowness	0:2063c10a1022	134	*/
slowness	0:2063c10a1022	135
slowness	0:2063c10a1022	136	#define USB_DESCRIPTOR_TYPE_DEVICE 1
slowness	0:2063c10a1022	137	#define USB_DESCRIPTOR_TYPE_CONFIGURATION 2
slowness	0:2063c10a1022	138	#define USB_DESCRIPTOR_TYPE_INTERFACE 4
slowness	0:2063c10a1022	139	#define USB_DESCRIPTOR_TYPE_ENDPOINT 5
slowness	0:2063c10a1022	140	/* ----------- Control RequestType Fields ----------- */
slowness	0:2063c10a1022	141	#define USB_DEVICE_TO_HOST 0x80
slowness	0:2063c10a1022	142	#define USB_HOST_TO_DEVICE 0x00
slowness	0:2063c10a1022	143	#define USB_REQUEST_TYPE_CLASS 0x20
slowness	0:2063c10a1022	144	#define USB_RECIPIENT_DEVICE 0x00
slowness	0:2063c10a1022	145	#define USB_RECIPIENT_INTERFACE 0x01
slowness	0:2063c10a1022	146	/* -------------- USB Standard Requests -------------- */
slowness	0:2063c10a1022	147	#define SET_ADDRESS 5
slowness	0:2063c10a1022	148	#define GET_DESCRIPTOR 6
slowness	0:2063c10a1022	149	#define SET_CONFIGURATION 9
slowness	0:2063c10a1022	150	#define SET_INTERFACE 11
slowness	0:2063c10a1022	151
slowness	0:2063c10a1022	152	/*
slowness	0:2063c10a1022	153	**************************************************************************************************************
slowness	0:2063c10a1022	154	* TYPE DEFINITIONS
slowness	0:2063c10a1022	155	**************************************************************************************************************
slowness	0:2063c10a1022	156	*/
slowness	0:2063c10a1022	157
slowness	0:2063c10a1022	158	typedef struct hcEd { /* ----------- HostController EndPoint Descriptor ------------- */
slowness	0:2063c10a1022	159	volatile USB_INT32U Control; /* Endpoint descriptor control */
slowness	0:2063c10a1022	160	volatile USB_INT32U TailTd; /* Physical address of tail in Transfer descriptor list */
slowness	0:2063c10a1022	161	volatile USB_INT32U HeadTd; /* Physcial address of head in Transfer descriptor list */
slowness	0:2063c10a1022	162	volatile USB_INT32U Next; /* Physical address of next Endpoint descriptor */
slowness	0:2063c10a1022	163	} HCED;
slowness	0:2063c10a1022	164
slowness	0:2063c10a1022	165	typedef struct hcTd { /* ------------ HostController Transfer Descriptor ------------ */
slowness	0:2063c10a1022	166	volatile USB_INT32U Control; /* Transfer descriptor control */
slowness	0:2063c10a1022	167	volatile USB_INT32U CurrBufPtr; /* Physical address of current buffer pointer */
slowness	0:2063c10a1022	168	volatile USB_INT32U Next; /* Physical pointer to next Transfer Descriptor */
slowness	0:2063c10a1022	169	volatile USB_INT32U BufEnd; /* Physical address of end of buffer */
slowness	0:2063c10a1022	170	} HCTD;
slowness	0:2063c10a1022	171
slowness	0:2063c10a1022	172	typedef struct hcca { /* ----------- Host Controller Communication Area ------------ */
slowness	0:2063c10a1022	173	volatile USB_INT32U IntTable[32]; /* Interrupt Table */
slowness	0:2063c10a1022	174	volatile USB_INT32U FrameNumber; /* Frame Number */
slowness	0:2063c10a1022	175	volatile USB_INT32U DoneHead; /* Done Head */
slowness	0:2063c10a1022	176	volatile USB_INT08U Reserved[116]; /* Reserved for future use */
slowness	0:2063c10a1022	177	volatile USB_INT08U Unknown[4]; /* Unused */
slowness	0:2063c10a1022	178	} HCCA;
slowness	0:2063c10a1022	179
slowness	0:2063c10a1022	180	/*
slowness	0:2063c10a1022	181	**************************************************************************************************************
slowness	0:2063c10a1022	182	* EXTERN DECLARATIONS
slowness	0:2063c10a1022	183	**************************************************************************************************************
slowness	0:2063c10a1022	184	*/
slowness	0:2063c10a1022	185
slowness	0:2063c10a1022	186	extern volatile HCED EDBulkIn; / BulkIn endpoint descriptor structure */
slowness	0:2063c10a1022	187	extern volatile HCED EDBulkOut; / BulkOut endpoint descriptor structure */
slowness	0:2063c10a1022	188	extern volatile HCTD TDHead; / Head transfer descriptor structure */
slowness	0:2063c10a1022	189	extern volatile HCTD TDTail; / Tail transfer descriptor structure */
slowness	0:2063c10a1022	190	extern volatile USB_INT08U TDBuffer; / Current Buffer Pointer of transfer descriptor */
slowness	0:2063c10a1022	191
slowness	0:2063c10a1022	192	/*
slowness	0:2063c10a1022	193	**************************************************************************************************************
slowness	0:2063c10a1022	194	* FUNCTION PROTOTYPES
slowness	0:2063c10a1022	195	**************************************************************************************************************
slowness	0:2063c10a1022	196	*/
slowness	0:2063c10a1022	197
slowness	0:2063c10a1022	198	void Host_Init (void);
slowness	0:2063c10a1022	199
slowness	0:2063c10a1022	200	extern "C" void USB_IRQHandler(void) __irq;
slowness	0:2063c10a1022	201
slowness	0:2063c10a1022	202	USB_INT32S Host_EnumDev (void);
slowness	0:2063c10a1022	203
slowness	0:2063c10a1022	204	USB_INT32S Host_ProcessTD(volatile HCED *ed,
slowness	0:2063c10a1022	205	volatile USB_INT32U token,
slowness	0:2063c10a1022	206	volatile USB_INT08U *buffer,
slowness	0:2063c10a1022	207	USB_INT32U buffer_len);
slowness	0:2063c10a1022	208
slowness	0:2063c10a1022	209	void Host_DelayUS ( USB_INT32U delay);
slowness	0:2063c10a1022	210	void Host_DelayMS ( USB_INT32U delay);
slowness	0:2063c10a1022	211
slowness	0:2063c10a1022	212
slowness	0:2063c10a1022	213	void Host_TDInit (volatile HCTD *td);
slowness	0:2063c10a1022	214	void Host_EDInit (volatile HCED *ed);
slowness	0:2063c10a1022	215	void Host_HCCAInit (volatile HCCA *hcca);
slowness	0:2063c10a1022	216
slowness	0:2063c10a1022	217	USB_INT32S Host_CtrlRecv ( USB_INT08U bm_request_type,
slowness	0:2063c10a1022	218	USB_INT08U b_request,
slowness	0:2063c10a1022	219	USB_INT16U w_value,
slowness	0:2063c10a1022	220	USB_INT16U w_index,
slowness	0:2063c10a1022	221	USB_INT16U w_length,
slowness	0:2063c10a1022	222	volatile USB_INT08U *buffer);
slowness	0:2063c10a1022	223
slowness	0:2063c10a1022	224	USB_INT32S Host_CtrlSend ( USB_INT08U bm_request_type,
slowness	0:2063c10a1022	225	USB_INT08U b_request,
slowness	0:2063c10a1022	226	USB_INT16U w_value,
slowness	0:2063c10a1022	227	USB_INT16U w_index,
slowness	0:2063c10a1022	228	USB_INT16U w_length,
slowness	0:2063c10a1022	229	volatile USB_INT08U *buffer);
slowness	0:2063c10a1022	230
slowness	0:2063c10a1022	231	void Host_FillSetup( USB_INT08U bm_request_type,
slowness	0:2063c10a1022	232	USB_INT08U b_request,
slowness	0:2063c10a1022	233	USB_INT16U w_value,
slowness	0:2063c10a1022	234	USB_INT16U w_index,
slowness	0:2063c10a1022	235	USB_INT16U w_length);
slowness	0:2063c10a1022	236
slowness	0:2063c10a1022	237
slowness	0:2063c10a1022	238	void Host_WDHWait (void);
slowness	0:2063c10a1022	239
slowness	0:2063c10a1022	240
slowness	0:2063c10a1022	241	USB_INT32U ReadLE32U (volatile USB_INT08U *pmem);
slowness	0:2063c10a1022	242	void WriteLE32U (volatile USB_INT08U *pmem,
slowness	0:2063c10a1022	243	USB_INT32U val);
slowness	0:2063c10a1022	244	USB_INT16U ReadLE16U (volatile USB_INT08U *pmem);
slowness	0:2063c10a1022	245	void WriteLE16U (volatile USB_INT08U *pmem,
slowness	0:2063c10a1022	246	USB_INT16U val);
slowness	0:2063c10a1022	247	USB_INT32U ReadBE32U (volatile USB_INT08U *pmem);
slowness	0:2063c10a1022	248	void WriteBE32U (volatile USB_INT08U *pmem,
slowness	0:2063c10a1022	249	USB_INT32U val);
slowness	0:2063c10a1022	250	USB_INT16U ReadBE16U (volatile USB_INT08U *pmem);
slowness	0:2063c10a1022	251	void WriteBE16U (volatile USB_INT08U *pmem,
slowness	0:2063c10a1022	252	USB_INT16U val);
slowness	0:2063c10a1022	253
slowness	0:2063c10a1022	254	#endif

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Mbed OS support:	Mbed 2 deprecated
Created:	28 Aug 2011
Imports:	12
Forks:	0
Commits:	1
Dependents:	0
Dependencies:	1
Followers:	1

USBHostLite/usbhost_lpc17xx.h@0:2063c10a1022, 2011-08-28 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning