usb-uhci.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:9k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. #ifndef __LINUX_UHCI_H
  2. #define __LINUX_UHCI_H
  3. /*
  4.    $Id: usb-uhci.h,v 1.58 2001/08/28 16:45:00 acher Exp $
  5.  */
  6. #define MODNAME "usb-uhci"
  7. #define UHCI_LATENCY_TIMER 0
  8. static __inline__ void uhci_wait_ms(unsigned int ms)
  9. {
  10. if(!in_interrupt())
  11. {
  12. current->state = TASK_UNINTERRUPTIBLE;
  13. schedule_timeout(1 + ms * HZ / 1000);
  14. }
  15. else
  16. mdelay(ms);
  17. }
  18. /* Command register */
  19. #define USBCMD 0
  20. #define   USBCMD_RS 0x0001 /* Run/Stop */
  21. #define   USBCMD_HCRESET 0x0002 /* Host reset */
  22. #define   USBCMD_GRESET 0x0004 /* Global reset */
  23. #define   USBCMD_EGSM 0x0008 /* Global Suspend Mode */
  24. #define   USBCMD_FGR 0x0010 /* Force Global Resume */
  25. #define   USBCMD_SWDBG 0x0020 /* SW Debug mode */
  26. #define   USBCMD_CF 0x0040 /* Config Flag (sw only) */
  27. #define   USBCMD_MAXP 0x0080 /* Max Packet (0 = 32, 1 = 64) */
  28. /* Status register */
  29. #define USBSTS 2
  30. #define   USBSTS_USBINT 0x0001 /* Interrupt due to IOC */
  31. #define   USBSTS_ERROR 0x0002 /* Interrupt due to error */
  32. #define   USBSTS_RD 0x0004 /* Resume Detect */
  33. #define   USBSTS_HSE 0x0008 /* Host System Error - basically PCI problems */
  34. #define   USBSTS_HCPE 0x0010 /* Host Controller Process Error - the scripts were buggy */
  35. #define   USBSTS_HCH 0x0020 /* HC Halted */
  36. /* Interrupt enable register */
  37. #define USBINTR 4
  38. #define   USBINTR_TIMEOUT 0x0001 /* Timeout/CRC error enable */
  39. #define   USBINTR_RESUME 0x0002 /* Resume interrupt enable */
  40. #define   USBINTR_IOC 0x0004 /* Interrupt On Complete enable */
  41. #define   USBINTR_SP 0x0008 /* Short packet interrupt enable */
  42. #define USBFRNUM 6
  43. #define USBFLBASEADD 8
  44. #define USBSOF 12
  45. /* USB port status and control registers */
  46. #define USBPORTSC1 16
  47. #define USBPORTSC2 18
  48. #define   USBPORTSC_CCS 0x0001 /* Current Connect Status ("device present") */
  49. #define   USBPORTSC_CSC 0x0002 /* Connect Status Change */
  50. #define   USBPORTSC_PE 0x0004 /* Port Enable */
  51. #define   USBPORTSC_PEC 0x0008 /* Port Enable Change */
  52. #define   USBPORTSC_LS 0x0030 /* Line Status */
  53. #define   USBPORTSC_RD 0x0040 /* Resume Detect */
  54. #define   USBPORTSC_LSDA 0x0100 /* Low Speed Device Attached */
  55. #define   USBPORTSC_PR 0x0200 /* Port Reset */
  56. #define   USBPORTSC_SUSP 0x1000 /* Suspend */
  57. /* Legacy support register */
  58. #define USBLEGSUP 0xc0
  59. #define USBLEGSUP_DEFAULT 0x2000 /* only PIRQ enable set */
  60. #define UHCI_NULL_DATA_SIZE 0x7ff /* for UHCI controller TD */
  61. #define UHCI_PID  0xff /* PID MASK */
  62. #define UHCI_PTR_BITS 0x000F
  63. #define UHCI_PTR_TERM 0x0001
  64. #define UHCI_PTR_QH 0x0002
  65. #define UHCI_PTR_DEPTH 0x0004
  66. #define UHCI_NUMFRAMES 1024 /* in the frame list [array] */
  67. #define UHCI_MAX_SOF_NUMBER 2047 /* in an SOF packet */
  68. #define CAN_SCHEDULE_FRAMES 1000 /* how far future frames can be scheduled */
  69. /*
  70.  * for TD <status>:
  71.  */
  72. #define TD_CTRL_SPD (1 << 29) /* Short Packet Detect */
  73. #define TD_CTRL_C_ERR_MASK (3 << 27) /* Error Counter bits */
  74. #define TD_CTRL_LS (1 << 26) /* Low Speed Device */
  75. #define TD_CTRL_IOS (1 << 25) /* Isochronous Select */
  76. #define TD_CTRL_IOC (1 << 24) /* Interrupt on Complete */
  77. #define TD_CTRL_ACTIVE (1 << 23) /* TD Active */
  78. #define TD_CTRL_STALLED (1 << 22) /* TD Stalled */
  79. #define TD_CTRL_DBUFERR (1 << 21) /* Data Buffer Error */
  80. #define TD_CTRL_BABBLE (1 << 20) /* Babble Detected */
  81. #define TD_CTRL_NAK (1 << 19) /* NAK Received */
  82. #define TD_CTRL_CRCTIMEO (1 << 18) /* CRC/Time Out Error */
  83. #define TD_CTRL_BITSTUFF (1 << 17) /* Bit Stuff Error */
  84. #define TD_CTRL_ACTLEN_MASK 0x7ff /* actual length, encoded as n - 1 */
  85. #define TD_CTRL_ANY_ERROR (TD_CTRL_STALLED | TD_CTRL_DBUFERR | 
  86.  TD_CTRL_BABBLE | TD_CTRL_CRCTIME | TD_CTRL_BITSTUFF)
  87. #define uhci_status_bits(ctrl_sts) (ctrl_sts & 0xFE0000)
  88. #define uhci_actual_length(ctrl_sts) ((ctrl_sts + 1) & TD_CTRL_ACTLEN_MASK) /* 1-based */
  89. #define uhci_ptr_to_virt(x) bus_to_virt(x & ~UHCI_PTR_BITS)
  90. /*
  91.  * for TD <flags>:
  92.  */
  93. #define UHCI_TD_REMOVE 0x0001 /* Remove when done */
  94. /*
  95.  * for TD <info>: (a.k.a. Token)
  96.  */
  97. #define TD_TOKEN_TOGGLE 19
  98. #define uhci_maxlen(token) ((token) >> 21)
  99. #define uhci_toggle(token) (((token) >> TD_TOKEN_TOGGLE) & 1)
  100. #define uhci_endpoint(token) (((token) >> 15) & 0xf)
  101. #define uhci_devaddr(token) (((token) >> 8) & 0x7f)
  102. #define uhci_devep(token) (((token) >> 8) & 0x7ff)
  103. #define uhci_packetid(token) ((token) & 0xff)
  104. #define uhci_packetout(token) (uhci_packetid(token) != USB_PID_IN)
  105. #define uhci_packetin(token) (uhci_packetid(token) == USB_PID_IN)
  106. /* ------------------------------------------------------------------------------------
  107.    New TD/QH-structures
  108.    ------------------------------------------------------------------------------------ */
  109. typedef enum {
  110. TD_TYPE, QH_TYPE
  111. } uhci_desc_type_t;
  112. typedef struct {
  113. __u32 link;
  114. __u32 status;
  115. __u32 info;
  116. __u32 buffer;
  117. } uhci_td_t, *puhci_td_t;
  118. typedef struct {
  119. __u32 head;
  120. __u32 element; /* Queue element pointer */
  121. } uhci_qh_t, *puhci_qh_t;
  122. typedef struct {
  123. union {
  124. uhci_td_t td;
  125. uhci_qh_t qh;
  126. } hw;
  127. uhci_desc_type_t type;
  128. dma_addr_t dma_addr;
  129. struct list_head horizontal;
  130. struct list_head vertical;
  131. struct list_head desc_list;
  132. int last_used;
  133. } uhci_desc_t, *puhci_desc_t;
  134. typedef struct {
  135. struct list_head desc_list; // list pointer to all corresponding TDs/QHs associated with this request
  136. dma_addr_t setup_packet_dma;
  137. dma_addr_t transfer_buffer_dma;
  138. unsigned long started;
  139. urb_t *next_queued_urb;         // next queued urb for this EP
  140. urb_t *prev_queued_urb;
  141. uhci_desc_t *bottom_qh;
  142. uhci_desc_t *next_qh;        // next helper QH
  143. char use_loop;
  144. char flags;
  145. } urb_priv_t, *purb_priv_t;
  146. struct virt_root_hub {
  147. int devnum; /* Address of Root Hub endpoint */
  148. void *urb;
  149. void *int_addr;
  150. int send;
  151. int interval;
  152. int numports;
  153. int c_p_r[8];
  154. struct timer_list rh_int_timer;
  155. };
  156. typedef struct uhci {
  157. int irq;
  158. unsigned int io_addr;
  159. unsigned int io_size;
  160. unsigned int maxports;
  161. int running;
  162. int apm_state;
  163. struct uhci *next; // chain of uhci device contexts
  164. struct list_head urb_list; // list of all pending urbs
  165. spinlock_t urb_list_lock; // lock to keep consistency 
  166. int unlink_urb_done;
  167. atomic_t avoid_bulk;
  168. struct usb_bus *bus; // our bus
  169. __u32 *framelist;
  170. dma_addr_t framelist_dma;
  171. uhci_desc_t **iso_td;
  172. uhci_desc_t *int_chain[8];
  173. uhci_desc_t *ls_control_chain;
  174. uhci_desc_t *control_chain;
  175. uhci_desc_t *bulk_chain;
  176. uhci_desc_t *chain_end;
  177. uhci_desc_t *td1ms;
  178. uhci_desc_t *td32ms;
  179. struct list_head free_desc;
  180. spinlock_t qh_lock;
  181. spinlock_t td_lock;
  182. struct virt_root_hub rh; //private data of the virtual root hub
  183. int loop_usage;            // URBs using bandwidth reclamation
  184. struct list_head urb_unlinked; // list of all unlinked  urbs
  185. long timeout_check;
  186. int timeout_urbs;
  187. struct pci_dev *uhci_pci;
  188. struct pci_pool *desc_pool;
  189. long last_error_time;          // last error output in uhci_interrupt()
  190. } uhci_t, *puhci_t;
  191. #define MAKE_TD_ADDR(a) ((a)->dma_addr&~UHCI_PTR_QH)
  192. #define MAKE_QH_ADDR(a) ((a)->dma_addr|UHCI_PTR_QH)
  193. #define UHCI_GET_CURRENT_FRAME(uhci) (inw ((uhci)->io_addr + USBFRNUM))
  194. #define CLEAN_TRANSFER_NO_DELETION 0
  195. #define CLEAN_TRANSFER_REGULAR 1
  196. #define CLEAN_TRANSFER_DELETION_MARK 2
  197. #define CLEAN_NOT_FORCED 0
  198. #define CLEAN_FORCED 1
  199. #define PROCESS_ISO_REGULAR 0
  200. #define PROCESS_ISO_FORCE 1
  201. #define UNLINK_ASYNC_STORE_URB 0
  202. #define UNLINK_ASYNC_DONT_STORE 1
  203. #define is_td_active(desc) (desc->hw.td.status & cpu_to_le32(TD_CTRL_ACTIVE))
  204. #define set_qh_head(desc,val) (desc)->hw.qh.head=cpu_to_le32(val)
  205. #define set_qh_element(desc,val) (desc)->hw.qh.element=cpu_to_le32(val)
  206. #define set_td_link(desc,val) (desc)->hw.td.link=cpu_to_le32(val)
  207. #define set_td_ioc(desc) (desc)->hw.td.status |= cpu_to_le32(TD_CTRL_IOC)
  208. #define clr_td_ioc(desc) (desc)->hw.td.status &= cpu_to_le32(~TD_CTRL_IOC)
  209. /* ------------------------------------------------------------------------------------ 
  210.    Virtual Root HUB 
  211.    ------------------------------------------------------------------------------------ */
  212. /* destination of request */
  213. #define RH_INTERFACE               0x01
  214. #define RH_ENDPOINT                0x02
  215. #define RH_OTHER                   0x03
  216. #define RH_CLASS                   0x20
  217. #define RH_VENDOR                  0x40
  218. /* Requests: bRequest << 8 | bmRequestType */
  219. #define RH_GET_STATUS           0x0080
  220. #define RH_CLEAR_FEATURE        0x0100
  221. #define RH_SET_FEATURE          0x0300
  222. #define RH_SET_ADDRESS 0x0500
  223. #define RH_GET_DESCRIPTOR 0x0680
  224. #define RH_SET_DESCRIPTOR       0x0700
  225. #define RH_GET_CONFIGURATION 0x0880
  226. #define RH_SET_CONFIGURATION 0x0900
  227. #define RH_GET_STATE            0x0280
  228. #define RH_GET_INTERFACE        0x0A80
  229. #define RH_SET_INTERFACE        0x0B00
  230. #define RH_SYNC_FRAME           0x0C80
  231. /* Our Vendor Specific Request */
  232. #define RH_SET_EP               0x2000
  233. /* Hub port features */
  234. #define RH_PORT_CONNECTION         0x00
  235. #define RH_PORT_ENABLE             0x01
  236. #define RH_PORT_SUSPEND            0x02
  237. #define RH_PORT_OVER_CURRENT       0x03
  238. #define RH_PORT_RESET              0x04
  239. #define RH_PORT_POWER              0x08
  240. #define RH_PORT_LOW_SPEED          0x09
  241. #define RH_C_PORT_CONNECTION       0x10
  242. #define RH_C_PORT_ENABLE           0x11
  243. #define RH_C_PORT_SUSPEND          0x12
  244. #define RH_C_PORT_OVER_CURRENT     0x13
  245. #define RH_C_PORT_RESET            0x14
  246. /* Hub features */
  247. #define RH_C_HUB_LOCAL_POWER       0x00
  248. #define RH_C_HUB_OVER_CURRENT      0x01
  249. #define RH_DEVICE_REMOTE_WAKEUP    0x00
  250. #define RH_ENDPOINT_STALL          0x01
  251. /* Our Vendor Specific feature */
  252. #define RH_REMOVE_EP               0x00
  253. #define RH_ACK                     0x01
  254. #define RH_REQ_ERR                 -1
  255. #define RH_NACK                    0x00
  256. #endif