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

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