usb.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264
  1. /*
  2. * USB Masks
  3. */
  4. #ifndef __BFIN_PERIPHERAL_USB__
  5. #define __BFIN_PERIPHERAL_USB__
  6. /* Bit masks for USB_FADDR */
  7. #define FUNCTION_ADDRESS 0x7f /* Function address */
  8. /* Bit masks for USB_POWER */
  9. #define ENABLE_SUSPENDM 0x1 /* enable SuspendM output */
  10. #define SUSPEND_MODE 0x2 /* Suspend Mode indicator */
  11. #define RESUME_MODE 0x4 /* DMA Mode */
  12. #define RESET 0x8 /* Reset indicator */
  13. #define HS_MODE 0x10 /* High Speed mode indicator */
  14. #define HS_ENABLE 0x20 /* high Speed Enable */
  15. #define SOFT_CONN 0x40 /* Soft connect */
  16. #define ISO_UPDATE 0x80 /* Isochronous update */
  17. /* Bit masks for USB_INTRTX */
  18. #define EP0_TX 0x1 /* Tx Endpoint 0 interrupt */
  19. #define EP1_TX 0x2 /* Tx Endpoint 1 interrupt */
  20. #define EP2_TX 0x4 /* Tx Endpoint 2 interrupt */
  21. #define EP3_TX 0x8 /* Tx Endpoint 3 interrupt */
  22. #define EP4_TX 0x10 /* Tx Endpoint 4 interrupt */
  23. #define EP5_TX 0x20 /* Tx Endpoint 5 interrupt */
  24. #define EP6_TX 0x40 /* Tx Endpoint 6 interrupt */
  25. #define EP7_TX 0x80 /* Tx Endpoint 7 interrupt */
  26. /* Bit masks for USB_INTRRX */
  27. #define EP1_RX 0x2 /* Rx Endpoint 1 interrupt */
  28. #define EP2_RX 0x4 /* Rx Endpoint 2 interrupt */
  29. #define EP3_RX 0x8 /* Rx Endpoint 3 interrupt */
  30. #define EP4_RX 0x10 /* Rx Endpoint 4 interrupt */
  31. #define EP5_RX 0x20 /* Rx Endpoint 5 interrupt */
  32. #define EP6_RX 0x40 /* Rx Endpoint 6 interrupt */
  33. #define EP7_RX 0x80 /* Rx Endpoint 7 interrupt */
  34. /* Bit masks for USB_INTRTXE */
  35. #define EP0_TX_E 0x1 /* Endpoint 0 interrupt Enable */
  36. #define EP1_TX_E 0x2 /* Tx Endpoint 1 interrupt enable */
  37. #define EP2_TX_E 0x4 /* Tx Endpoint 2 interrupt enable */
  38. #define EP3_TX_E 0x8 /* Tx Endpoint 3 interrupt enable */
  39. #define EP4_TX_E 0x10 /* Tx Endpoint 4 interrupt enable */
  40. #define EP5_TX_E 0x20 /* Tx Endpoint 5 interrupt enable */
  41. #define EP6_TX_E 0x40 /* Tx Endpoint 6 interrupt enable */
  42. #define EP7_TX_E 0x80 /* Tx Endpoint 7 interrupt enable */
  43. /* Bit masks for USB_INTRRXE */
  44. #define EP1_RX_E 0x02 /* Rx Endpoint 1 interrupt enable */
  45. #define EP2_RX_E 0x04 /* Rx Endpoint 2 interrupt enable */
  46. #define EP3_RX_E 0x08 /* Rx Endpoint 3 interrupt enable */
  47. #define EP4_RX_E 0x10 /* Rx Endpoint 4 interrupt enable */
  48. #define EP5_RX_E 0x20 /* Rx Endpoint 5 interrupt enable */
  49. #define EP6_RX_E 0x40 /* Rx Endpoint 6 interrupt enable */
  50. #define EP7_RX_E 0x80 /* Rx Endpoint 7 interrupt enable */
  51. /* Bit masks for USB_INTRUSB */
  52. #define SUSPEND_B 0x01 /* Suspend indicator */
  53. #define RESUME_B 0x02 /* Resume indicator */
  54. #define RESET_OR_BABLE_B 0x04 /* Reset/babble indicator */
  55. #define SOF_B 0x08 /* Start of frame */
  56. #define CONN_B 0x10 /* Connection indicator */
  57. #define DISCON_B 0x20 /* Disconnect indicator */
  58. #define SESSION_REQ_B 0x40 /* Session Request */
  59. #define VBUS_ERROR_B 0x80 /* Vbus threshold indicator */
  60. /* Bit masks for USB_INTRUSBE */
  61. #define SUSPEND_BE 0x01 /* Suspend indicator int enable */
  62. #define RESUME_BE 0x02 /* Resume indicator int enable */
  63. #define RESET_OR_BABLE_BE 0x04 /* Reset/babble indicator int enable */
  64. #define SOF_BE 0x08 /* Start of frame int enable */
  65. #define CONN_BE 0x10 /* Connection indicator int enable */
  66. #define DISCON_BE 0x20 /* Disconnect indicator int enable */
  67. #define SESSION_REQ_BE 0x40 /* Session Request int enable */
  68. #define VBUS_ERROR_BE 0x80 /* Vbus threshold indicator int enable */
  69. /* Bit masks for USB_FRAME */
  70. #define FRAME_NUMBER 0x7ff /* Frame number */
  71. /* Bit masks for USB_INDEX */
  72. #define SELECTED_ENDPOINT 0xf /* selected endpoint */
  73. /* Bit masks for USB_GLOBAL_CTL */
  74. #define GLOBAL_ENA 0x0001 /* enables USB module */
  75. #define EP1_TX_ENA 0x0002 /* Transmit endpoint 1 enable */
  76. #define EP2_TX_ENA 0x0004 /* Transmit endpoint 2 enable */
  77. #define EP3_TX_ENA 0x0008 /* Transmit endpoint 3 enable */
  78. #define EP4_TX_ENA 0x0010 /* Transmit endpoint 4 enable */
  79. #define EP5_TX_ENA 0x0020 /* Transmit endpoint 5 enable */
  80. #define EP6_TX_ENA 0x0040 /* Transmit endpoint 6 enable */
  81. #define EP7_TX_ENA 0x0080 /* Transmit endpoint 7 enable */
  82. #define EP1_RX_ENA 0x0100 /* Receive endpoint 1 enable */
  83. #define EP2_RX_ENA 0x0200 /* Receive endpoint 2 enable */
  84. #define EP3_RX_ENA 0x0400 /* Receive endpoint 3 enable */
  85. #define EP4_RX_ENA 0x0800 /* Receive endpoint 4 enable */
  86. #define EP5_RX_ENA 0x1000 /* Receive endpoint 5 enable */
  87. #define EP6_RX_ENA 0x2000 /* Receive endpoint 6 enable */
  88. #define EP7_RX_ENA 0x4000 /* Receive endpoint 7 enable */
  89. /* Bit masks for USB_OTG_DEV_CTL */
  90. #define SESSION 0x1 /* session indicator */
  91. #define HOST_REQ 0x2 /* Host negotiation request */
  92. #define HOST_MODE 0x4 /* indicates USBDRC is a host */
  93. #define VBUS0 0x8 /* Vbus level indicator[0] */
  94. #define VBUS1 0x10 /* Vbus level indicator[1] */
  95. #define LSDEV 0x20 /* Low-speed indicator */
  96. #define FSDEV 0x40 /* Full or High-speed indicator */
  97. #define B_DEVICE 0x80 /* A' or 'B' device indicator */
  98. /* Bit masks for USB_OTG_VBUS_IRQ */
  99. #define DRIVE_VBUS_ON 0x1 /* indicator to drive VBUS control circuit */
  100. #define DRIVE_VBUS_OFF 0x2 /* indicator to shut off charge pump */
  101. #define CHRG_VBUS_START 0x4 /* indicator for external circuit to start charging VBUS */
  102. #define CHRG_VBUS_END 0x8 /* indicator for external circuit to end charging VBUS */
  103. #define DISCHRG_VBUS_START 0x10 /* indicator to start discharging VBUS */
  104. #define DISCHRG_VBUS_END 0x20 /* indicator to stop discharging VBUS */
  105. /* Bit masks for USB_OTG_VBUS_MASK */
  106. #define DRIVE_VBUS_ON_ENA 0x01 /* enable DRIVE_VBUS_ON interrupt */
  107. #define DRIVE_VBUS_OFF_ENA 0x02 /* enable DRIVE_VBUS_OFF interrupt */
  108. #define CHRG_VBUS_START_ENA 0x04 /* enable CHRG_VBUS_START interrupt */
  109. #define CHRG_VBUS_END_ENA 0x08 /* enable CHRG_VBUS_END interrupt */
  110. #define DISCHRG_VBUS_START_ENA 0x10 /* enable DISCHRG_VBUS_START interrupt */
  111. #define DISCHRG_VBUS_END_ENA 0x20 /* enable DISCHRG_VBUS_END interrupt */
  112. /* Bit masks for USB_CSR0 */
  113. #define RXPKTRDY 0x1 /* data packet receive indicator */
  114. #define TXPKTRDY 0x2 /* data packet in FIFO indicator */
  115. #define STALL_SENT 0x4 /* STALL handshake sent */
  116. #define DATAEND 0x8 /* Data end indicator */
  117. #define SETUPEND 0x10 /* Setup end */
  118. #define SENDSTALL 0x20 /* Send STALL handshake */
  119. #define SERVICED_RXPKTRDY 0x40 /* used to clear the RxPktRdy bit */
  120. #define SERVICED_SETUPEND 0x80 /* used to clear the SetupEnd bit */
  121. #define FLUSHFIFO 0x100 /* flush endpoint FIFO */
  122. #define STALL_RECEIVED_H 0x4 /* STALL handshake received host mode */
  123. #define SETUPPKT_H 0x8 /* send Setup token host mode */
  124. #define ERROR_H 0x10 /* timeout error indicator host mode */
  125. #define REQPKT_H 0x20 /* Request an IN transaction host mode */
  126. #define STATUSPKT_H 0x40 /* Status stage transaction host mode */
  127. #define NAK_TIMEOUT_H 0x80 /* EP0 halted after a NAK host mode */
  128. /* Bit masks for USB_COUNT0 */
  129. #define EP0_RX_COUNT 0x7f /* number of received bytes in EP0 FIFO */
  130. /* Bit masks for USB_NAKLIMIT0 */
  131. #define EP0_NAK_LIMIT 0x1f /* frames/micro frames count after which EP0 timeouts */
  132. /* Bit masks for USB_TX_MAX_PACKET */
  133. #define MAX_PACKET_SIZE_T 0x7ff /* maximum data pay load in a frame */
  134. /* Bit masks for USB_RX_MAX_PACKET */
  135. #define MAX_PACKET_SIZE_R 0x7ff /* maximum data pay load in a frame */
  136. /* Bit masks for USB_TXCSR */
  137. #define TXPKTRDY_T 0x1 /* data packet in FIFO indicator */
  138. #define FIFO_NOT_EMPTY_T 0x2 /* FIFO not empty */
  139. #define UNDERRUN_T 0x4 /* TxPktRdy not set for an IN token */
  140. #define FLUSHFIFO_T 0x8 /* flush endpoint FIFO */
  141. #define STALL_SEND_T 0x10 /* issue a Stall handshake */
  142. #define STALL_SENT_T 0x20 /* Stall handshake transmitted */
  143. #define CLEAR_DATATOGGLE_T 0x40 /* clear endpoint data toggle */
  144. #define INCOMPTX_T 0x80 /* indicates that a large packet is split */
  145. #define DMAREQMODE_T 0x400 /* DMA mode (0 or 1) selection */
  146. #define FORCE_DATATOGGLE_T 0x800 /* Force data toggle */
  147. #define DMAREQ_ENA_T 0x1000 /* Enable DMA request for Tx EP */
  148. #define ISO_T 0x4000 /* enable Isochronous transfers */
  149. #define AUTOSET_T 0x8000 /* allows TxPktRdy to be set automatically */
  150. #define ERROR_TH 0x4 /* error condition host mode */
  151. #define STALL_RECEIVED_TH 0x20 /* Stall handshake received host mode */
  152. #define NAK_TIMEOUT_TH 0x80 /* NAK timeout host mode */
  153. /* Bit masks for USB_TXCOUNT */
  154. #define TX_COUNT 0x1fff /* Byte len for the selected endpoint Tx FIFO */
  155. /* Bit masks for USB_RXCSR */
  156. #define RXPKTRDY_R 0x1 /* data packet in FIFO indicator */
  157. #define FIFO_FULL_R 0x2 /* FIFO not empty */
  158. #define OVERRUN_R 0x4 /* TxPktRdy not set for an IN token */
  159. #define DATAERROR_R 0x8 /* Out packet cannot be loaded into Rx FIFO */
  160. #define FLUSHFIFO_R 0x10 /* flush endpoint FIFO */
  161. #define STALL_SEND_R 0x20 /* issue a Stall handshake */
  162. #define STALL_SENT_R 0x40 /* Stall handshake transmitted */
  163. #define CLEAR_DATATOGGLE_R 0x80 /* clear endpoint data toggle */
  164. #define INCOMPRX_R 0x100 /* indicates that a large packet is split */
  165. #define DMAREQMODE_R 0x800 /* DMA mode (0 or 1) selection */
  166. #define DISNYET_R 0x1000 /* disable Nyet handshakes */
  167. #define DMAREQ_ENA_R 0x2000 /* Enable DMA request for Tx EP */
  168. #define ISO_R 0x4000 /* enable Isochronous transfers */
  169. #define AUTOCLEAR_R 0x8000 /* allows TxPktRdy to be set automatically */
  170. #define ERROR_RH 0x4 /* TxPktRdy not set for an IN token host mode */
  171. #define REQPKT_RH 0x20 /* request an IN transaction host mode */
  172. #define STALL_RECEIVED_RH 0x40 /* Stall handshake received host mode */
  173. #define INCOMPRX_RH 0x100 /* large packet is split host mode */
  174. #define DMAREQMODE_RH 0x800 /* DMA mode (0 or 1) selection host mode */
  175. #define AUTOREQ_RH 0x4000 /* sets ReqPkt automatically host mode */
  176. /* Bit masks for USB_RXCOUNT */
  177. #define RX_COUNT 0x1fff /* Packet byte len in the Rx FIFO */
  178. /* Bit masks for USB_TXTYPE */
  179. #define TARGET_EP_NO_T 0xf /* EP number */
  180. #define PROTOCOL_T 0xc /* transfer type */
  181. /* Bit masks for USB_TXINTERVAL */
  182. #define TX_POLL_INTERVAL 0xff /* polling interval for selected Tx EP */
  183. /* Bit masks for USB_RXTYPE */
  184. #define TARGET_EP_NO_R 0xf /* EP number */
  185. #define PROTOCOL_R 0xc /* transfer type */
  186. /* Bit masks for USB_RXINTERVAL */
  187. #define RX_POLL_INTERVAL 0xff /* polling interval for selected Rx EP */
  188. /* Bit masks for USB_DMA_INTERRUPT */
  189. #define DMA0_INT 0x1 /* DMA0 pending interrupt */
  190. #define DMA1_INT 0x2 /* DMA1 pending interrupt */
  191. #define DMA2_INT 0x4 /* DMA2 pending interrupt */
  192. #define DMA3_INT 0x8 /* DMA3 pending interrupt */
  193. #define DMA4_INT 0x10 /* DMA4 pending interrupt */
  194. #define DMA5_INT 0x20 /* DMA5 pending interrupt */
  195. #define DMA6_INT 0x40 /* DMA6 pending interrupt */
  196. #define DMA7_INT 0x80 /* DMA7 pending interrupt */
  197. /* Bit masks for USB_DMAxCONTROL */
  198. #define DMA_ENA 0x1 /* DMA enable */
  199. #define DIRECTION 0x2 /* direction of DMA transfer */
  200. #define MODE 0x4 /* DMA Bus error */
  201. #define INT_ENA 0x8 /* Interrupt enable */
  202. #define EPNUM 0xf0 /* EP number */
  203. #define BUSERROR 0x100 /* DMA Bus error */
  204. #endif