Dependencies:   mbed

Committer:
Markus_Paar
Date:
Mon Sep 19 10:25:22 2011 +0000
Revision:
0:48870d877970

        

Who changed what in which revision?

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