NetServicesSource - NetServices Stack source

Users » donatien » Code » NetServicesSource

NetServices Stack source

Dependents: HelloWorld ServoInterfaceBoardExample1 4180_Lab4

drv/usb/USBHostLite/usbhost_lpc17xx.h@0:632c9925f013, 2010-06-11 (annotated)

Committer:: donatien
Date:: Fri Jun 11 16:05:15 2010 +0000
Revision:: 0:632c9925f013

Who changed what in which revision?

User	Revision	Line number	New contents of line
donatien	0:632c9925f013	1
donatien	0:632c9925f013	2	/*
donatien	0:632c9925f013	3	Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
donatien	0:632c9925f013	4
donatien	0:632c9925f013	5	Permission is hereby granted, free of charge, to any person obtaining a copy
donatien	0:632c9925f013	6	of this software and associated documentation files (the "Software"), to deal
donatien	0:632c9925f013	7	in the Software without restriction, including without limitation the rights
donatien	0:632c9925f013	8	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
donatien	0:632c9925f013	9	copies of the Software, and to permit persons to whom the Software is
donatien	0:632c9925f013	10	furnished to do so, subject to the following conditions:
donatien	0:632c9925f013	11
donatien	0:632c9925f013	12	The above copyright notice and this permission notice shall be included in
donatien	0:632c9925f013	13	all copies or substantial portions of the Software.
donatien	0:632c9925f013	14
donatien	0:632c9925f013	15	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
donatien	0:632c9925f013	16	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
donatien	0:632c9925f013	17	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
donatien	0:632c9925f013	18	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
donatien	0:632c9925f013	19	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien	0:632c9925f013	20	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
donatien	0:632c9925f013	21	THE SOFTWARE.
donatien	0:632c9925f013	22	*/
donatien	0:632c9925f013	23
donatien	0:632c9925f013	24	/*
donatien	0:632c9925f013	25	**************************************************************************************************************
donatien	0:632c9925f013	26	* NXP USB Host Stack
donatien	0:632c9925f013	27	*
donatien	0:632c9925f013	28	* (c) Copyright 2008, NXP SemiConductors
donatien	0:632c9925f013	29	* (c) Copyright 2008, OnChip Technologies LLC
donatien	0:632c9925f013	30	* All Rights Reserved
donatien	0:632c9925f013	31	*
donatien	0:632c9925f013	32	* www.nxp.com
donatien	0:632c9925f013	33	* www.onchiptech.com
donatien	0:632c9925f013	34	*
donatien	0:632c9925f013	35	* File : usbhost_lpc17xx.h
donatien	0:632c9925f013	36	* Programmer(s) : Ravikanth.P
donatien	0:632c9925f013	37	* Version :
donatien	0:632c9925f013	38	*
donatien	0:632c9925f013	39	**************************************************************************************************************
donatien	0:632c9925f013	40	*/
donatien	0:632c9925f013	41
donatien	0:632c9925f013	42	#ifndef USBHOST_LPC17xx_H
donatien	0:632c9925f013	43	#define USBHOST_LPC17xx_H
donatien	0:632c9925f013	44
donatien	0:632c9925f013	45	/*
donatien	0:632c9925f013	46	**************************************************************************************************************
donatien	0:632c9925f013	47	* INCLUDE HEADER FILES
donatien	0:632c9925f013	48	**************************************************************************************************************
donatien	0:632c9925f013	49	*/
donatien	0:632c9925f013	50
donatien	0:632c9925f013	51	#include "usbhost_inc.h"
donatien	0:632c9925f013	52
donatien	0:632c9925f013	53	/*
donatien	0:632c9925f013	54	**************************************************************************************************************
donatien	0:632c9925f013	55	* PRINT CONFIGURATION
donatien	0:632c9925f013	56	**************************************************************************************************************
donatien	0:632c9925f013	57	*/
donatien	0:632c9925f013	58
donatien	0:632c9925f013	59	#define PRINT_ENABLE 1
donatien	0:632c9925f013	60
donatien	0:632c9925f013	61	#if PRINT_ENABLE
donatien	0:632c9925f013	62	#define PRINT_Log(...) printf(__VA_ARGS__)
donatien	0:632c9925f013	63	#define PRINT_Err(rc) printf("ERROR: In %s at Line %u - rc = %d\n", __FUNCTION__, __LINE__, rc)
donatien	0:632c9925f013	64
donatien	0:632c9925f013	65	#else
donatien	0:632c9925f013	66	#define PRINT_Log(...) do {} while(0)
donatien	0:632c9925f013	67	#define PRINT_Err(rc) do {} while(0)
donatien	0:632c9925f013	68
donatien	0:632c9925f013	69	#endif
donatien	0:632c9925f013	70
donatien	0:632c9925f013	71	/*
donatien	0:632c9925f013	72	**************************************************************************************************************
donatien	0:632c9925f013	73	* GENERAL DEFINITIONS
donatien	0:632c9925f013	74	**************************************************************************************************************
donatien	0:632c9925f013	75	*/
donatien	0:632c9925f013	76
donatien	0:632c9925f013	77	#define DESC_LENGTH(x) x[0]
donatien	0:632c9925f013	78	#define DESC_TYPE(x) x[1]
donatien	0:632c9925f013	79
donatien	0:632c9925f013	80
donatien	0:632c9925f013	81	#define HOST_GET_DESCRIPTOR(descType, descIndex, data, length) \
donatien	0:632c9925f013	82	Host_CtrlRecv(USB_DEVICE_TO_HOST \| USB_RECIPIENT_DEVICE, GET_DESCRIPTOR, \
donatien	0:632c9925f013	83	(descType << 8)\|(descIndex), 0, length, data)
donatien	0:632c9925f013	84
donatien	0:632c9925f013	85	#define HOST_SET_ADDRESS(new_addr) \
donatien	0:632c9925f013	86	Host_CtrlSend(USB_HOST_TO_DEVICE \| USB_RECIPIENT_DEVICE, SET_ADDRESS, \
donatien	0:632c9925f013	87	new_addr, 0, 0, NULL)
donatien	0:632c9925f013	88
donatien	0:632c9925f013	89	#define USBH_SET_CONFIGURATION(configNum) \
donatien	0:632c9925f013	90	Host_CtrlSend(USB_HOST_TO_DEVICE \| USB_RECIPIENT_DEVICE, SET_CONFIGURATION, \
donatien	0:632c9925f013	91	configNum, 0, 0, NULL)
donatien	0:632c9925f013	92
donatien	0:632c9925f013	93	#define USBH_SET_INTERFACE(ifNum, altNum) \
donatien	0:632c9925f013	94	Host_CtrlSend(USB_HOST_TO_DEVICE \| USB_RECIPIENT_INTERFACE, SET_INTERFACE, \
donatien	0:632c9925f013	95	altNum, ifNum, 0, NULL)
donatien	0:632c9925f013	96
donatien	0:632c9925f013	97	/*
donatien	0:632c9925f013	98	**************************************************************************************************************
donatien	0:632c9925f013	99	* OHCI OPERATIONAL REGISTER FIELD DEFINITIONS
donatien	0:632c9925f013	100	**************************************************************************************************************
donatien	0:632c9925f013	101	*/
donatien	0:632c9925f013	102
donatien	0:632c9925f013	103	/* ------------------ HcControl Register --------------------- */
donatien	0:632c9925f013	104	#define OR_CONTROL_CLE 0x00000010
donatien	0:632c9925f013	105	#define OR_CONTROL_BLE 0x00000020
donatien	0:632c9925f013	106	#define OR_CONTROL_HCFS 0x000000C0
donatien	0:632c9925f013	107	#define OR_CONTROL_HC_OPER 0x00000080
donatien	0:632c9925f013	108	/* ----------------- HcCommandStatus Register ----------------- */
donatien	0:632c9925f013	109	#define OR_CMD_STATUS_HCR 0x00000001
donatien	0:632c9925f013	110	#define OR_CMD_STATUS_CLF 0x00000002
donatien	0:632c9925f013	111	#define OR_CMD_STATUS_BLF 0x00000004
donatien	0:632c9925f013	112	/* --------------- HcInterruptStatus Register ----------------- */
donatien	0:632c9925f013	113	#define OR_INTR_STATUS_WDH 0x00000002
donatien	0:632c9925f013	114	#define OR_INTR_STATUS_RHSC 0x00000040
donatien	0:632c9925f013	115	/* --------------- HcInterruptEnable Register ----------------- */
donatien	0:632c9925f013	116	#define OR_INTR_ENABLE_WDH 0x00000002
donatien	0:632c9925f013	117	#define OR_INTR_ENABLE_RHSC 0x00000040
donatien	0:632c9925f013	118	#define OR_INTR_ENABLE_MIE 0x80000000
donatien	0:632c9925f013	119	/* ---------------- HcRhDescriptorA Register ------------------ */
donatien	0:632c9925f013	120	#define OR_RH_STATUS_LPSC 0x00010000
donatien	0:632c9925f013	121	#define OR_RH_STATUS_DRWE 0x00008000
donatien	0:632c9925f013	122	/* -------------- HcRhPortStatus[1:NDP] Register -------------- */
donatien	0:632c9925f013	123	#define OR_RH_PORT_CCS 0x00000001
donatien	0:632c9925f013	124	#define OR_RH_PORT_PRS 0x00000010
donatien	0:632c9925f013	125	#define OR_RH_PORT_CSC 0x00010000
donatien	0:632c9925f013	126	#define OR_RH_PORT_PRSC 0x00100000
donatien	0:632c9925f013	127
donatien	0:632c9925f013	128
donatien	0:632c9925f013	129	/*
donatien	0:632c9925f013	130	**************************************************************************************************************
donatien	0:632c9925f013	131	* FRAME INTERVAL
donatien	0:632c9925f013	132	**************************************************************************************************************
donatien	0:632c9925f013	133	*/
donatien	0:632c9925f013	134
donatien	0:632c9925f013	135	#define FI 0x2EDF /* 12000 bits per frame (-1) */
donatien	0:632c9925f013	136	#define DEFAULT_FMINTERVAL ((((6 * (FI - 210)) / 7) << 16) \| FI)
donatien	0:632c9925f013	137
donatien	0:632c9925f013	138	/*
donatien	0:632c9925f013	139	**************************************************************************************************************
donatien	0:632c9925f013	140	* ENDPOINT DESCRIPTOR CONTROL FIELDS
donatien	0:632c9925f013	141	**************************************************************************************************************
donatien	0:632c9925f013	142	*/
donatien	0:632c9925f013	143
donatien	0:632c9925f013	144	#define ED_SKIP (USB_INT32U) (0x00001000) /* Skip this ep in queue */
donatien	0:632c9925f013	145
donatien	0:632c9925f013	146	/*
donatien	0:632c9925f013	147	**************************************************************************************************************
donatien	0:632c9925f013	148	* TRANSFER DESCRIPTOR CONTROL FIELDS
donatien	0:632c9925f013	149	**************************************************************************************************************
donatien	0:632c9925f013	150	*/
donatien	0:632c9925f013	151
donatien	0:632c9925f013	152	#define TD_ROUNDING (USB_INT32U) (0x00040000) /* Buffer Rounding */
donatien	0:632c9925f013	153	#define TD_SETUP (USB_INT32U)(0) /* Direction of Setup Packet */
donatien	0:632c9925f013	154	#define TD_IN (USB_INT32U)(0x00100000) /* Direction In */
donatien	0:632c9925f013	155	#define TD_OUT (USB_INT32U)(0x00080000) /* Direction Out */
donatien	0:632c9925f013	156	#define TD_DELAY_INT(x) (USB_INT32U)((x) << 21) /* Delay Interrupt */
donatien	0:632c9925f013	157	#define TD_TOGGLE_0 (USB_INT32U)(0x02000000) /* Toggle 0 */
donatien	0:632c9925f013	158	#define TD_TOGGLE_1 (USB_INT32U)(0x03000000) /* Toggle 1 */
donatien	0:632c9925f013	159	#define TD_CC (USB_INT32U)(0xF0000000) /* Completion Code */
donatien	0:632c9925f013	160
donatien	0:632c9925f013	161	/*
donatien	0:632c9925f013	162	**************************************************************************************************************
donatien	0:632c9925f013	163	* USB STANDARD REQUEST DEFINITIONS
donatien	0:632c9925f013	164	**************************************************************************************************************
donatien	0:632c9925f013	165	*/
donatien	0:632c9925f013	166
donatien	0:632c9925f013	167	#define USB_DESCRIPTOR_TYPE_DEVICE 1
donatien	0:632c9925f013	168	#define USB_DESCRIPTOR_TYPE_CONFIGURATION 2
donatien	0:632c9925f013	169	#define USB_DESCRIPTOR_TYPE_INTERFACE 4
donatien	0:632c9925f013	170	#define USB_DESCRIPTOR_TYPE_ENDPOINT 5
donatien	0:632c9925f013	171	/* ----------- Control RequestType Fields ----------- */
donatien	0:632c9925f013	172	#define USB_DEVICE_TO_HOST 0x80
donatien	0:632c9925f013	173	#define USB_HOST_TO_DEVICE 0x00
donatien	0:632c9925f013	174	#define USB_REQUEST_TYPE_CLASS 0x20
donatien	0:632c9925f013	175	#define USB_RECIPIENT_DEVICE 0x00
donatien	0:632c9925f013	176	#define USB_RECIPIENT_INTERFACE 0x01
donatien	0:632c9925f013	177	/* -------------- USB Standard Requests -------------- */
donatien	0:632c9925f013	178	#define SET_ADDRESS 5
donatien	0:632c9925f013	179	#define GET_DESCRIPTOR 6
donatien	0:632c9925f013	180	#define SET_CONFIGURATION 9
donatien	0:632c9925f013	181	#define SET_INTERFACE 11
donatien	0:632c9925f013	182
donatien	0:632c9925f013	183	/*
donatien	0:632c9925f013	184	**************************************************************************************************************
donatien	0:632c9925f013	185	* TYPE DEFINITIONS
donatien	0:632c9925f013	186	**************************************************************************************************************
donatien	0:632c9925f013	187	*/
donatien	0:632c9925f013	188
donatien	0:632c9925f013	189	typedef struct hcEd { /* ----------- HostController EndPoint Descriptor ------------- */
donatien	0:632c9925f013	190	volatile USB_INT32U Control; /* Endpoint descriptor control */
donatien	0:632c9925f013	191	volatile USB_INT32U TailTd; /* Physical address of tail in Transfer descriptor list */
donatien	0:632c9925f013	192	volatile USB_INT32U HeadTd; /* Physcial address of head in Transfer descriptor list */
donatien	0:632c9925f013	193	volatile USB_INT32U Next; /* Physical address of next Endpoint descriptor */
donatien	0:632c9925f013	194	} HCED;
donatien	0:632c9925f013	195
donatien	0:632c9925f013	196	typedef struct hcTd { /* ------------ HostController Transfer Descriptor ------------ */
donatien	0:632c9925f013	197	volatile USB_INT32U Control; /* Transfer descriptor control */
donatien	0:632c9925f013	198	volatile USB_INT32U CurrBufPtr; /* Physical address of current buffer pointer */
donatien	0:632c9925f013	199	volatile USB_INT32U Next; /* Physical pointer to next Transfer Descriptor */
donatien	0:632c9925f013	200	volatile USB_INT32U BufEnd; /* Physical address of end of buffer */
donatien	0:632c9925f013	201	} HCTD;
donatien	0:632c9925f013	202
donatien	0:632c9925f013	203	typedef struct hcca { /* ----------- Host Controller Communication Area ------------ */
donatien	0:632c9925f013	204	volatile USB_INT32U IntTable[32]; /* Interrupt Table */
donatien	0:632c9925f013	205	volatile USB_INT32U FrameNumber; /* Frame Number */
donatien	0:632c9925f013	206	volatile USB_INT32U DoneHead; /* Done Head */
donatien	0:632c9925f013	207	volatile USB_INT08U Reserved[116]; /* Reserved for future use */
donatien	0:632c9925f013	208	volatile USB_INT08U Unknown[4]; /* Unused */
donatien	0:632c9925f013	209	} HCCA;
donatien	0:632c9925f013	210
donatien	0:632c9925f013	211	/*
donatien	0:632c9925f013	212	**************************************************************************************************************
donatien	0:632c9925f013	213	* EXTERN DECLARATIONS
donatien	0:632c9925f013	214	**************************************************************************************************************
donatien	0:632c9925f013	215	*/
donatien	0:632c9925f013	216	#if 0
donatien	0:632c9925f013	217	extern volatile HCED EDBulkIn; / BulkIn endpoint descriptor structure */
donatien	0:632c9925f013	218	extern volatile HCED EDBulkOut; / BulkOut endpoint descriptor structure */
donatien	0:632c9925f013	219	extern volatile HCED *EDBulkHead;
donatien	0:632c9925f013	220	extern volatile HCTD TDHead; / Head transfer descriptor structure */
donatien	0:632c9925f013	221	extern volatile HCTD TDTail; / Tail transfer descriptor structure */
donatien	0:632c9925f013	222	#endif
donatien	0:632c9925f013	223	extern volatile USB_INT08U TDBuffer; / Current Buffer Pointer of transfer descriptor */
donatien	0:632c9925f013	224
donatien	0:632c9925f013	225	/*
donatien	0:632c9925f013	226	**************************************************************************************************************
donatien	0:632c9925f013	227	* FUNCTION PROTOTYPES
donatien	0:632c9925f013	228	**************************************************************************************************************
donatien	0:632c9925f013	229	*/
donatien	0:632c9925f013	230
donatien	0:632c9925f013	231	void Host_Init (void);
donatien	0:632c9925f013	232
donatien	0:632c9925f013	233	extern "C" void USB_IRQHandler(void) __irq;
donatien	0:632c9925f013	234
donatien	0:632c9925f013	235	USB_INT32S Host_EnumDev (void);
donatien	0:632c9925f013	236
donatien	0:632c9925f013	237	USB_INT32S Host_TDresult(volatile HCED *ed,
donatien	0:632c9925f013	238	volatile USB_INT32U token);
donatien	0:632c9925f013	239
donatien	0:632c9925f013	240	USB_INT32S Host_ProcessTD(volatile HCED *ed,
donatien	0:632c9925f013	241	volatile USB_INT32U token,
donatien	0:632c9925f013	242	volatile USB_INT08U *buffer,
donatien	0:632c9925f013	243	USB_INT32U buffer_len,
donatien	0:632c9925f013	244	bool block = true);
donatien	0:632c9925f013	245
donatien	0:632c9925f013	246
donatien	0:632c9925f013	247	void Host_DelayUS ( USB_INT32U delay);
donatien	0:632c9925f013	248	void Host_DelayMS ( USB_INT32U delay);
donatien	0:632c9925f013	249
donatien	0:632c9925f013	250
donatien	0:632c9925f013	251	void Host_TDInit (volatile HCTD *td);
donatien	0:632c9925f013	252	void Host_EDInit (volatile HCED *ed);
donatien	0:632c9925f013	253	void Host_HCCAInit (volatile HCCA *hcca);
donatien	0:632c9925f013	254
donatien	0:632c9925f013	255	USB_INT32S Host_CtrlRecv ( USB_INT08U bm_request_type,
donatien	0:632c9925f013	256	USB_INT08U b_request,
donatien	0:632c9925f013	257	USB_INT16U w_value,
donatien	0:632c9925f013	258	USB_INT16U w_index,
donatien	0:632c9925f013	259	USB_INT16U w_length,
donatien	0:632c9925f013	260	volatile USB_INT08U *buffer);
donatien	0:632c9925f013	261
donatien	0:632c9925f013	262	USB_INT32S Host_CtrlSend ( USB_INT08U bm_request_type,
donatien	0:632c9925f013	263	USB_INT08U b_request,
donatien	0:632c9925f013	264	USB_INT16U w_value,
donatien	0:632c9925f013	265	USB_INT16U w_index,
donatien	0:632c9925f013	266	USB_INT16U w_length,
donatien	0:632c9925f013	267	volatile USB_INT08U *buffer);
donatien	0:632c9925f013	268
donatien	0:632c9925f013	269	void Host_FillSetup( USB_INT08U bm_request_type,
donatien	0:632c9925f013	270	USB_INT08U b_request,
donatien	0:632c9925f013	271	USB_INT16U w_value,
donatien	0:632c9925f013	272	USB_INT16U w_index,
donatien	0:632c9925f013	273	USB_INT16U w_length);
donatien	0:632c9925f013	274
donatien	0:632c9925f013	275
donatien	0:632c9925f013	276	void Host_WDHWait (void);
donatien	0:632c9925f013	277
donatien	0:632c9925f013	278
donatien	0:632c9925f013	279	USB_INT32U ReadLE32U (volatile USB_INT08U *pmem);
donatien	0:632c9925f013	280	void WriteLE32U (volatile USB_INT08U *pmem,
donatien	0:632c9925f013	281	USB_INT32U val);
donatien	0:632c9925f013	282	USB_INT16U ReadLE16U (volatile USB_INT08U *pmem);
donatien	0:632c9925f013	283	void WriteLE16U (volatile USB_INT08U *pmem,
donatien	0:632c9925f013	284	USB_INT16U val);
donatien	0:632c9925f013	285	USB_INT32U ReadBE32U (volatile USB_INT08U *pmem);
donatien	0:632c9925f013	286	void WriteBE32U (volatile USB_INT08U *pmem,
donatien	0:632c9925f013	287	USB_INT32U val);
donatien	0:632c9925f013	288	USB_INT16U ReadBE16U (volatile USB_INT08U *pmem);
donatien	0:632c9925f013	289	void WriteBE16U (volatile USB_INT08U *pmem,
donatien	0:632c9925f013	290	USB_INT16U val);
donatien	0:632c9925f013	291
donatien	0:632c9925f013	292	#endif

Repository toolbox

Export to desktop IDE

Build repository

Repository details

Type:	Program
Created:	11 Jun 2010
Imports:	2654
Forks:	0
Commits:	12
Dependents:	3
Dependencies:	0
Followers:	13

This repository is Public (Unlisted).

drv/usb/USBHostLite/usbhost_lpc17xx.h@0:632c9925f013, 2010-06-11 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning