Automatically calculate make dependencies
[rapper.git] / src / usb / hw.h
1 /*----------------------------------------------------------------------------
2  *      U S B  -  K e r n e l
3  *----------------------------------------------------------------------------
4  * Name:    usbhw.h
5  * Purpose: USB Hardware Layer Definitions
6  * Version: V1.20
7  *----------------------------------------------------------------------------
8  *      This software is supplied "AS IS" without any warranties, express,
9  *      implied or statutory, including but not limited to the implied
10  *      warranties of fitness for purpose, satisfactory quality and
11  *      noninfringement. Keil extends you a royalty-free right to reproduce
12  *      and distribute executable files created using this software for use
13  *      on NXP Semiconductors LPC family microcontroller devices only. Nothing
14  *      else gives you the right to use this software.
15  *
16  * Copyright (c) 2009 Keil - An ARM Company. All rights reserved.
17  *----------------------------------------------------------------------------
18  * History:
19  *          V1.20 Added USB_ClearEPBuf
20  *          V1.00 Initial Version
21  *----------------------------------------------------------------------------*/
22
23 #ifndef __USBHW_H__
24 #define __USBHW_H__
25 #include "lpc_types.h"
26
27 /* USB RAM Definitions */
28 #define USB_RAM_ADR     0x20080000  /* USB RAM Start Address */
29 #define USB_RAM_SZ      0x00004000  /* USB RAM Size (4kB) */
30
31 /* DMA Endpoint Descriptors */
32 #define DD_NISO_CNT             16  /* Non-Iso EP DMA Descr. Count (max. 32) */
33 #define DD_ISO_CNT               8  /* Iso EP DMA Descriptor Count (max. 32) */
34 #define DD_NISO_SZ    (DD_NISO_CNT * 16)    /* Non-Iso DMA Descr. Size */
35 #define DD_ISO_SZ     (DD_ISO_CNT  * 20)    /* Iso DMA Descriptor Size */
36 #define DD_NISO_ADR   (USB_RAM_ADR + 128)   /* Non-Iso DMA Descr. Address */
37 #define DD_ISO_ADR    (DD_NISO_ADR + DD_NISO_SZ) /* Iso DMA Descr. Address */
38 #define DD_SZ                 (128 + DD_NISO_SZ + DD_ISO_SZ) /* Descr. Size */
39
40 /* DMA Buffer Memory Definitions */
41 #define DMA_BUF_ADR   (USB_RAM_ADR + DD_SZ) /* DMA Buffer Start Address */
42 #define DMA_BUF_SZ    (USB_RAM_SZ  - DD_SZ) /* DMA Buffer Size */
43
44 /* USB Error Codes */
45 #define USB_ERR_PID         0x0001  /* PID Error */
46 #define USB_ERR_UEPKT       0x0002  /* Unexpected Packet */
47 #define USB_ERR_DCRC        0x0004  /* Data CRC Error */
48 #define USB_ERR_TIMOUT      0x0008  /* Bus Time-out Error */
49 #define USB_ERR_EOP         0x0010  /* End of Packet Error */
50 #define USB_ERR_B_OVRN      0x0020  /* Buffer Overrun */
51 #define USB_ERR_BTSTF       0x0040  /* Bit Stuff Error */
52 #define USB_ERR_TGL         0x0080  /* Toggle Bit Error */
53
54 /* USB DMA Status Codes */
55 #define USB_DMA_INVALID     0x0000  /* DMA Invalid - Not Configured */
56 #define USB_DMA_IDLE        0x0001  /* DMA Idle - Waiting for Trigger */
57 #define USB_DMA_BUSY        0x0002  /* DMA Busy - Transfer in progress */
58 #define USB_DMA_DONE        0x0003  /* DMA Transfer Done (no Errors)*/
59 #define USB_DMA_OVER_RUN    0x0004  /* Data Over Run */
60 #define USB_DMA_UNDER_RUN   0x0005  /* Data Under Run (Short Packet) */
61 #define USB_DMA_ERROR       0x0006  /* Error */
62 #define USB_DMA_UNKNOWN     0xFFFF  /* Unknown State */
63
64 /* USB DMA Descriptor */
65 typedef struct _USB_DMA_DESCRIPTOR {
66   uint32_t BufAdr;                     /* DMA Buffer Address */
67   uint16_t  BufLen;                     /* DMA Buffer Length */
68   uint16_t  MaxSize;                    /* Maximum Packet Size */
69   uint32_t InfoAdr;                    /* Packet Info Memory Address */
70   union {                           /* DMA Configuration */
71     struct {
72       uint32_t Link   : 1;             /* Link to existing Descriptors */
73       uint32_t IsoEP  : 1;             /* Isonchronous Endpoint */
74       uint32_t ATLE   : 1;             /* ATLE (Auto Transfer Length Extract) */
75       uint32_t Rsrvd  : 5;             /* Reserved */
76       uint32_t LenPos : 8;             /* Length Position (ATLE) */
77     } Type;
78     uint32_t Val;
79   } Cfg;
80 } USB_DMA_DESCRIPTOR;
81
82 /* USB Hardware Functions */
83 extern void  USB_Init       (void);
84 extern void  USB_Connect    (uint32_t  con);
85 extern void  USB_Reset      (void);
86 extern void  USB_Suspend    (void);
87 extern void  USB_Resume     (void);
88 extern void  USB_WakeUp     (void);
89 extern void  USB_WakeUpCfg  (uint32_t  cfg);
90 extern void  USB_SetAddress (uint32_t adr);
91 extern void  USB_Configure  (uint32_t  cfg);
92 extern void  USB_ConfigEP   (USB_ENDPOINT_DESCRIPTOR *pEPD);
93 extern void  USB_DirCtrlEP  (uint32_t dir);
94 extern void  USB_EnableEP   (uint32_t EPNum);
95 extern void  USB_DisableEP  (uint32_t EPNum);
96 extern void  USB_ResetEP    (uint32_t EPNum);
97 extern void  USB_SetStallEP (uint32_t EPNum);
98 extern void  USB_ClrStallEP (uint32_t EPNum);
99 extern void USB_ClearEPBuf  (uint32_t  EPNum);
100 extern uint32_t USB_ReadEP     (uint32_t EPNum, uint8_t *pData);
101 extern uint32_t USB_WriteEP    (uint32_t EPNum, uint8_t *pData, uint32_t cnt);
102 extern uint32_t  USB_DMA_Setup  (uint32_t EPNum, USB_DMA_DESCRIPTOR *pDD);
103 extern void  USB_DMA_Enable (uint32_t EPNum);
104 extern void  USB_DMA_Disable(uint32_t EPNum);
105 extern uint32_t USB_DMA_Status (uint32_t EPNum);
106 extern uint32_t USB_DMA_BufAdr (uint32_t EPNum);
107 extern uint32_t USB_DMA_BufCnt (uint32_t EPNum);
108 extern uint32_t USB_GetFrame   (void);
109 extern void  USB_IRQHandler (void);
110
111
112 #endif  /* __USBHW_H__ */