开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > Windows编程 > DNA > 查看源码
lpc_usb.h
资源名称：LPC2148_IAR_LPC2148.zip　[点击查看]
上传用户：sourcesun
上传日期：2013-09-23
资源大小：362k
文件大小：16k
源码类别：

DNA

开发平台：

Asm

lpc_usb.h：源码内容
  1. /*************************************************************************
  2.  *
  3.  *    Used with ICCARM and AARM.
  4.  *
  5.  *    (c) Copyright IAR Systems 2005
  6.  *
  7.  *    File name   : lpc_usb.h
  8.  *    Description : Define usb module
  9.  *
  10.  *    History :
  11.  *    1. Data        : June 13, 2005
  12.  *       Author      : Stanimir Bonev
  13.  *       Description : Create
  14.  *    2. Data        : August 4, 2005
  15.  *       Author      : Stanimir Bonev
  16.  *       Description : Modify
  17.  *        Modify some functions
  18.  *    3. Data        : November 18, 2005
  19.  *       Author      : Stanimir Bonev
  20.  *       Description : Modify
  21.  *        Add DMA support
  22.  *
  23.  *    $Revision: 1.2.4.1 $
  24. **************************************************************************/
  26. #include <includes.h>
  28. #ifndef __LPC_USB_H
  29. #define __LPC_USB_H
  31. #ifdef LPC_USB_GLOBAL
  32. #define LPC_USB_EXTERN
  33. #else
  34. #define LPC_USB_EXTERN  extern
  35. #endif
  37. typedef enum
  38. {
  39.   USB_OK = 0,USB_PLL_ERROR,USB_INTR_ERROR,
  40. } USB_ErrorCodes_t;
  42. typedef enum
  43. {
  44.   CTRL_ENP_OUT=0, CTRL_ENP_IN,
  45.   ENP1_OUT      , ENP1_IN    ,
  46.   ENP2_OUT      , ENP2_IN    ,
  47.   ENP3_OUT      , ENP3_IN    ,
  48.   ENP4_OUT      , ENP4_IN    ,
  49.   ENP5_OUT      , ENP5_IN    ,
  50.   ENP6_OUT      , ENP6_IN    ,
  51.   ENP7_OUT      , ENP7_IN    ,
  52.   ENP8_OUT      , ENP8_IN    ,
  53.   ENP9_OUT      , ENP9_IN    ,
  54.   ENP10_OUT     , ENP10_IN   ,
  55.   ENP11_OUT     , ENP11_IN   ,
  56.   ENP12_OUT     , ENP12_IN   ,
  57.   ENP13_OUT     , ENP13_IN   ,
  58.   ENP14_OUT     , ENP14_IN   ,
  59.   ENP15_OUT     , ENP15_IN   ,
  60.   ENP_MAX_NUMB
  61. } USB_Endpoint_t;
  63. typedef enum
  64. {
  65.   USB_LowPrior = 0,
  66.   USB_HighPrior,
  67. } USB_IntrPriority_t;
  69. typedef enum
  70. {
  71.   USB_NotFast = 0,
  72.   USB_EP_Fast,
  73.   USB_FrameFast,
  74. } USB_DevIntrPriority_t;
  76. typedef union
  77. {
  78.   Int32U Data;
  79.   struct
  80.   {
  81.     Int32U Frame      : 1;
  82.     Int32U Fast       : 1;
  83.     Int32U Slow       : 1;
  84.     Int32U Status     : 1;
  85.     Int32U CcEmpty    : 1;
  86.     Int32U CdFull     : 1;
  87.     Int32U EpRx       : 1;
  88.     Int32U EpTx       : 1;
  89.     Int32U EpRealize  : 1;
  90.     Int32U Error      : 1;
  91.     Int32U            :22;
  92.   };
  93. }UsbDevIntrStat_t;
  95. typedef union
  96. {
  97.   Int8U Data;
  98.   struct
  99.   {
  100.     Int8U  Connect        : 1;
  101.     Int8U  ConnectChange  : 1;
  102.     Int8U  Suspend        : 1;
  103.     Int8U  SuspendChange  : 1;
  104.     Int8U  Reset          : 1;
  105.     Int8U                 : 3;
  106.   };
  107. }UsbDevStat_t;
  109. typedef enum
  110. {
  111.   UsbEp0Out = 0, UsbEp0In,
  112.   UsbEp1Out,  UsbEp1In,
  113.   UsbEp2Out,  UsbEp2In,
  114.   UsbEp3Out,  UsbEp3In,
  115.   UsbEp4Out,  UsbEp4In,
  116.   UsbEp5Out,  UsbEp5In,
  117.   UsbEp6Out,  UsbEp6In,
  118.   UsbEp7Out,  UsbEp7In,
  119.   UsbEp8Out,  UsbEp8In,
  120.   UsbEp9Out,  UsbEp9In,
  121.   UsbEp10Out, UsbEp10In,
  122.   UsbEp11Out, UsbEp11In,
  123.   UsbEp12Out, UsbEp12In,
  124.   UsbEp13Out, UsbEp13In,
  125.   UsbEp14Out, UsbEp14In,
  126.   UsbEp15Out, UsbEp15In,
  127.   UsbResetEvent,UsbConnectEvent,UsbSuspendEvent,
  128.   UsbErrorEvent,UsbSofEvent,UsbHighPrioIntrEvent,
  129.   UsbLastEvent
  130. }UsbUserEvent_t;
  132. typedef enum
  133. {
  134.   USB_DevConnectStatus = 0, USB_SuspendStatus, USB_ResetStatus
  135. } USB_DevStatusReqType_t;
  137. typedef Int32U UsbDefStatus_t;
  139. typedef void (* UserFunc_t)(void * Arg);
  141. #define CMD_USB_SEL_EP              0x00
  142. #define CMD_USB_SEL_CLR_INT_EP      0x40
  143. #define CMD_USB_SET_EP_STAT         0x140
  144. #define CMD_USB_SET_ADDRESS         0xD0
  145. #define CMD_USB_CFG_DEV             0xD8
  146. #define CMD_USB_CLR_BUF             0xF2
  147. #define CMD_USB_SET_MODE            0xF3
  148. #define CMD_USB_RD_FRAME_NUMB       0xF5
  149. #define CMD_USB_VAL_BUF             0xFA
  150. #define CMD_USB_RD_ERROR_STAT       0xFB
  151. #define CMD_USB_RD_TEST_REG         0xFD
  152. #define CMD_USB_SET_DEV_STAT        0x1FE
  153. #define CMD_USB_GET_DEV_STAT        0xFE
  154. #define CMD_USB_GET_ERROR           0xFF
  156. #define USB_CMD_WR                  0x00000500
  157. #define USB_DATA_WR                 0x00000100
  158. #define USB_DATA_RD                 0x00000200
  160. #define bmUSB_FrameInterrupt        0x00000001
  161. #define bmUSB_FastInterrupt         0x00000002
  162. #define bmUSB_SlowInterrupt         0x00000004
  163. #define bmUSB_DevStatusInterrupt    0x00000008
  164. #define bmUSB_CommRegEmptyInterrupt 0x00000010
  165. #define bmUSB_CommDataFullInterrupt 0x00000020
  166. #define bmUSB_RxPacketInterrupt     0x00000040
  167. #define bmUSB_TxPacketInterrupt     0x00000080
  168. #define bmUSB_EPRealizeInterrupt    0x00000100
  169. #define bmUSB_ErrorInterrupt        0x00000200
  171. #define bmUSB_Connect               0x00000001
  172. #define bmUSB_ConnectChange         0x00000002
  173. #define bmUSB_Suspend               0x00000004
  174. #define bmUSB_SuspendChange         0x00000008
  175. #define bmUSB_BusReset              0x00000010
  177. #define bmUSB_EpStall               0x00000001
  178. #define bmUSB_EpStallStatus         0x00000002
  179. #define bmUSB_EpSetupPacket         0x00000004
  180. #define bmUSB_EpPOStatus            0x00000010
  181. #define bmUSB_EpCondStall           0x00000080
  183. #define bmUSB_CtrlRdEna             0x00000001
  184. #define bmUSB_CtrlWrEna             0x00000002
  186. #define bmUSB_PacketOverWritten     0x00000001
  188. LPC_USB_EXTERN volatile Int32U USB_EpSoftPrio;
  189. extern UserFunc_t UsbUserFun[];
  191. #if USB_SOF_EVENT > 0
  192. LPC_USB_EXTERN volatile Int32U USB_SofNumbHold;
  193. #endif
  195. /*************************************************************************
  196.  * Function Name: USB_Cmd
  197.  * Parameters:  Int16U Command, Int8U Data
  198.  *
  199.  * Return: Int32U - command result
  200.  *
  201.  * Description: Implement commands transmit to USB Engine
  202.  *
  203.  *************************************************************************/
  204. Int32U USB_Cmd (Int16U Command, Int8U Data);
  206. /*************************************************************************
  207.  * Function Name: USB_UserFuncRegistered
  208.  * Parameters: UserFunc_t UserFunc, UsbUserEvent_t UserFuncInd
  209.  *
  210.  * Return: UserFunc_t
  211.  *
  212.  * Description: Registered User callback function
  213.  *
  214.  *************************************************************************/
  215. UserFunc_t USB_UserFuncRegistered (UserFunc_t UserFunc, UsbUserEvent_t UserFuncInd);
  217. /*************************************************************************
  218.  * Function Name: USB_EpIntrClr
  219.  * Parameters: USB_Endpoint_t EndPoint
  220.  *
  221.  * Return: Int8U
  222.  *
  223.  * Description: Clear the EP interrupt flag and return the current EP status
  224.  *
  225.  *************************************************************************/
  226. Int8U USB_EpIntrClr(USB_Endpoint_t EndPoint);
  228. /*************************************************************************
  229.  * Function Name: USB_HwInit
  230.  * Parameters: LPC_VicIrqSlots_t IntrSlot
  231.  *
  232.  * Return: none
  233.  *
  234.  * Description: Init USB
  235.  *
  236.  *************************************************************************/
  237. void USB_HwInit(LPC_VicIrqSlots_t IntrSlot);
  239. /*************************************************************************
  240.  * Function Name: USB_HwReset
  241.  * Parameters: none
  242.  *
  243.  * Return: none
  244.  *
  245.  * Description: Reset Usb engine
  246.  *
  247.  *************************************************************************/
  248. void USB_HwReset (void);
  250. /*************************************************************************
  251.  * Function Name: USB_SetEpPrio
  252.  * Parameters: USB_Endpoint_t EndPoint,Boolean EpPrio
  253.  *
  254.  * Return: none
  255.  *
  256.  * Description: Set Endpoint priority
  257.  *
  258.  *************************************************************************/
  259. inline void USB_SetEpPrio (USB_Endpoint_t EndPoint,Boolean EpPrio);
  261. /*************************************************************************
  262.  * Function Name: USB_RealizeEndPoint
  263.  * Parameters: USB_Endpoint_t EndPoint, Boolean EpPrio,
  264.  *                Int32U MaxPacketSize, Boolean IntrEna
  265.  *
  266.  * Return: none
  267.  *
  268.  * Description: Enable or disable endpoint
  269.  *
  270.  *************************************************************************/
  271. void USB_RealizeEndPoint( USB_Endpoint_t EndPoint, Boolean EpPrio,
  272.                              Int32U MaxPacketSize, Boolean IntrEna);
  274. /*************************************************************************
  275.  * Function Name: USB_ClearBuffer
  276.  * Parameters: USB_Endpoint_t EndPoint - endpoiunt index
  277.  *
  278.  * Return: Int32U Packet overwrite statrus
  279.  *
  280.  * Description: Clear buffer of the corresponding endpoint
  281.  *
  282.  *************************************************************************/
  283. Int32U USB_ClearBuffer(USB_Endpoint_t EndPoint);
  285. /*************************************************************************
  286.  * Function Name: USB_ValidateBuffer
  287.  * Parameters: USB_Endpoint_t EndPoint - endpoiunt index
  288.  *
  289.  * Return: none
  290.  *
  291.  * Description: Validate buffer(only for IN Endpoints)
  292.  *
  293.  *************************************************************************/
  294. void USB_ValidateBuffer(USB_Endpoint_t EndPoint);
  296. /*************************************************************************
  297.  * Function Name: USB_SetAdd
  298.  * Parameters: Int32U DevAdd - device address between 0 - 127
  299.  *
  300.  * Return: none
  301.  *
  302.  * Description: Set device address
  303.  *
  304.  *************************************************************************/
  305. void USB_SetAdd(Int32U DevAdd);
  306. #define USB_SetDefAdd() USB_SetAdd(0)
  308. /*************************************************************************
  309.  * Function Name: USB_Connect
  310.  * Parameters: Boolean Conn
  311.  *
  312.  * Return: none
  313.  *
  314.  * Description: Connect Usb
  315.  *
  316.  *************************************************************************/
  317. void USB_Connect (Boolean Conn);
  319. /*************************************************************************
  320.  * Function Name: USB_Configure
  321.  * Parameters: Boolean Configure
  322.  *
  323.  * Return: none
  324.  *
  325.  * Description: Configure device
  326.  *  When Configure != 0 enable all Realize Ep
  327.  *
  328.  *************************************************************************/
  329. void USB_Configure (Boolean Configure);
  331. /*************************************************************************
  332.  * Function Name: USB_WakeUp
  333.  * Parameters: none
  334.  *
  335.  * Return: none
  336.  *
  337.  * Description: Wake up Usb
  338.  *
  339.  *************************************************************************/
  340. void USB_WakeUp (void);
  342. /*************************************************************************
  343.  * Function Name: USB_GetDevStatus
  344.  * Parameters: USB_DevStatusReqType_t Type
  345.  *
  346.  * Return: Boolean
  347.  *
  348.  * Description: Return USB device status
  349.  *
  350.  *************************************************************************/
  351. Boolean USB_GetDevStatus (USB_DevStatusReqType_t Type);
  353. /*************************************************************************
  354.  * Function Name: USB_SetStallEP
  355.  * Parameters: USB_Endpoint_t EndPoint, Boolean Stall
  356.  *
  357.  * Return: none
  358.  *
  359.  * Description: The endpoint stall/unstall
  360.  *
  361.  *************************************************************************/
  362. void USB_SetStallEP (USB_Endpoint_t EndPoint, Boolean Stall);
  364. /*************************************************************************
  365.  * Function Name: USB_GetStallEP
  366.  * Parameters: USB_Endpoint_t EndPoint
  367.  *
  368.  * Return: Boolean
  369.  *
  370.  * Description: Get stall state of the endpoint
  371.  *
  372.  *************************************************************************/
  373. Boolean USB_GetStallEP (USB_Endpoint_t EndPoint);
  375. /*************************************************************************
  376.  * Function Name: USB_EpWrite
  377.  * Parameters: USB_Endpoint_t EndPoint, Int32U * pData, Int32U Count
  378.  *
  379.  * Return: none
  380.  *
  381.  * Description: Endpoint Write (IN)
  382.  *
  383.  *************************************************************************/
  384. void USB_EpWrite (USB_Endpoint_t EndPoint, Int32U * pData, Int32U Count);
  386. /*************************************************************************
  387.  * Function Name: USB_EpRead
  388.  * Parameters: USB_Endpoint_t EndPoint, Int32U * pData, Int32U Count
  389.  *
  390.  * Return: Int32
  391.  *
  392.  * Description: Endpoint Read (OUT)
  393.  *
  394.  *************************************************************************/
  395. Int32U USB_EpRead (USB_Endpoint_t EndPoint, Int32U * pData, Int32U Count);
  397. /*************************************************************************
  398.  * Function Name: USB_ISR
  399.  * Parameters: none
  400.  *
  401.  * Return: none
  402.  *
  403.  * Description: USB interrupt subroutine
  404.  *
  405.  *************************************************************************/
  406. void USB_ISR (void);
  408. /*************************************************************************
  409.  * Function Name: USB_EpLogToPhysAdd
  410.  * Parameters: Int8U EpLogAdd
  411.  *
  412.  * Return: USB_Endpoint_t
  413.  *
  414.  * Description: Convert the logical to physical address
  415.  *
  416.  *************************************************************************/
  417. USB_Endpoint_t USB_EpLogToPhysAdd (Int8U EpLogAdd);
  419. /*************************************************************************
  420.  * Function Name: USB_GetFrameNumb
  421.  * Parameters: none
  422.  *
  423.  * Return: Int32U
  424.  *
  425.  * Description: Retunr curent value of SOF number
  426.  *
  427.  *************************************************************************/
  428. #if USB_SOF_EVENT > 0
  429. Int32U USB_GetFrameNumb (void);
  430. #endif
  432. #if USB_DMA > 0
  433. typedef enum
  434. {
  435.   UsbDmaNoServiced = 0,UsbDmaBeingServiced,
  436.   UsbDmaNormalCompletion, UsbDmaDataUnderrun,
  437.   UsbDmaDataOverrun = 8, UsbDmaSystemError,
  438.   UsbDmaParametersError,
  439. } UsbDmaStateCode_t;
  441. typedef enum
  442. {
  443.   UsbDmaNormalMode = 0, UsbDmaAtleMode,
  444. } UsbDmaMode_t;
  446. #pragma pack(1)
  447. typedef struct
  448. {
  449. Int32U PacketLength  :16;
  450. Int32U PacketValid   : 1;
  451. Int32U FrameNumb  :15;
  452. } DmaIsoPacket_t, *pDmaIsoPacket_t;
  454. typedef struct
  455. {
  456. void * pNextDD;
  457. union
  458. {
  459. Int32U Ctrl;
  460. struct
  461. {
  462. Int32U DmaMode      : 2;
  463. Int32U NextDDValid    : 1;
  464. Int32U        : 1;
  465. Int32U Isochronous    : 1;
  466. Int32U MaxPacketSize  :11;
  467. Int32U DmaBufferLegtn :16;
  468. };
  469. };
  470. pInt32U pDmaBuffer;
  471. union
  472. {
  473. Int32U Status;
  474. struct
  475. {
  476. Int32U DdRetired : 1;
  477. Int32U DdState  : 4;
  478. Int32U PacketValid : 1;
  479. Int32U LsByteExtr : 1;
  480. Int32U MsByteExtr : 1;
  481. Int32U MessLenPos : 6;
  482. Int32U   : 2;
  483. Int32U PresentCnt :16;
  484. };
  485. };
  486. pDmaIsoPacket_t pDmaIsoPacket;
  487. } USB_DmaDesc_t, *pUSB_DmaDesc_t;
  488. #pragma pack()
  490. /*************************************************************************
  491.  * Function Name: USB_DmaReset
  492.  * Parameters:  Int32U IntrEna
  493.  *
  494.  * Return: none
  495.  *
  496.  * Description: Reset USB DMA
  497.  *
  498.  *************************************************************************/
  499. void USB_DmaReset (Int32U IntrEna);
  501. /*************************************************************************
  502.  * Function Name: USB_DmaInitTransfer
  503.  * Parameters: USB_Endpoint_t EndPoint, Int32U DmaDescInd,
  504.  *             pInt32U pData, Int32U EpMaxSize, Int32U Size
  505.  *             pDmaIsoPacket_t pDmaIsoPacket,  Boolean EpTransferType
  506.  *
  507.  * Return: UsbDmaStateCode_t
  508.  *
  509.  * Description: Init Transfer by DMA
  510.  *
  511.  *************************************************************************/
  512. UsbDmaStateCode_t USB_DmaInitTransfer (USB_Endpoint_t EndPoint,
  513.           Int32U DmaDescInd, pInt32U pData, Int32U EpMaxSize, Int32U Size,
  514.           pDmaIsoPacket_t pDmaIsoPacket, Boolean EpTransferType);
  516. /*************************************************************************
  517.  * Function Name: USB_DmaRestattTransfer
  518.  * Parameters: USB_Endpoint_t EndPoint, Int32U DmaDescInd,
  519.  *             pInt32U pData, Int32U EpMaxSize, Int32U Size
  520.  *             pDmaIsoPacket_t pDmaIsoPacket,  Boolean EpTransferType
  521.  *
  522.  * Return: none
  523.  *
  524.  * Description: Restart DMA Transfer
  525.  *
  526.  *************************************************************************/
  527. void USB_DmaRestattTransfer (USB_Endpoint_t EndPoint,Int32U DmaDescInd);
  530. /*************************************************************************
  531.  * Function Name: USB_DmaGetDesc
  532.  * Parameters: Int32U DmaDescInd
  533.  *
  534.  * Return: pUSB_DmaDesc_t
  535.  *
  536.  * Description: Retur pointer to DMA deskriptor
  537.  *
  538.  *************************************************************************/
  539. pUSB_DmaDesc_t USB_DmaGetDesc (Int32U DmaDescInd);
  541. /*************************************************************************
  542.  * Function Name: USB_DmaDisable
  543.  * Parameters: USB_Endpoint_t EndPoint
  544.  *
  545.  * Return: none
  546.  *
  547.  * Description: Disable DMA transfer for the EP
  548.  *
  549.  *************************************************************************/
  550. void USB_DmaDisable (USB_Endpoint_t EndPoint);
  552. #endif  // USB_DMA
  553. #endif //__LPC_USB_H