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

源码开发语言/平台
当前位置：首页 > 源码/资料 > 嵌入式/单片机编程 > VxWorks > 查看源码
usbOhci.h
资源名称：ixp425BSP.rar　[点击查看]
上传用户：luoyougen
上传日期：2008-05-12
资源大小：23136k
文件大小：19k
源码类别：

VxWorks

开发平台：

C/C++

usbOhci.h：源码内容
  1. /* usbOhci.h - USB OHCI controller definitions */
  3. /* Copyright 2000 Wind River Systems, Inc. */
  5. /*
  6. Modification history
  7. --------------------
  8. 01b,28jan00,rcb  Redefine page masks for isochronous TDs.
  9. 01a,04oct99,rcb  First.
  10. */
  11. /*
  12. DESCRIPTION
  14. Defines the USB OHCI (Open Host Controller Interface) register file
  15. interface and memory structures shared between USB software and the OHCI
  16. hardware.  
  18. Please refer to the OpenHCI Specification, Release 1.0a or later, for more 
  19. information.
  20. */
  22. #ifndef __INCusbOhcih
  23. #define __INCusbOhcih
  25. #ifdef __cplusplus
  26. extern "C" {
  27. #endif
  30. /* defines */
  32. /* OpenHCI PCI class defintion */
  34. #define OHCI_CLASS 0x0c     /* BASEC value for serial bus */
  35. #define OHCI_SUBCLASS 0x03     /* SCC value for USB */
  36. #define OHCI_PGMIF 0x10     /* OpenHCI */
  39. /* completion codes */
  41. #define OHCI_CC_NO_ERROR 0x0     /* no errors detected */
  42. #define OHCI_CC_CRC 0x1     /* CRC error */
  43. #define OHCI_CC_BITSTUFF 0x2     /* bit stuffing error */
  44. #define OHCI_CC_DATA_TOGGLE 0x3     /* data toggle mismatch */
  45. #define OHCI_CC_STALL 0x4     /* endpoint stall */
  46. #define OHCI_CC_NO_RESPONSE 0x5     /* device not responding */
  47. #define OHCI_CC_PID_CHECK 0x6     /* check bits on PID failed */
  48. #define OHCI_CC_UNEXPECTED_PID 0x7     /* unexpected PID */
  49. #define OHCI_CC_DATA_OVERRUN 0x8     /* packet exceeded MPS */
  50. #define OHCI_CC_DATA_UNDERRUN 0x9     /* packet less than MPS */
  51. #define OHCI_CC_BFR_OVERRUN 0xc     /* host bus couldn't keep up */
  52. #define OHCI_CC_BFR_UNDERRUN 0xd     /* host bus couldn't keep up */
  53. #define OHCI_CC_NOT_ACCESSED 0xe     /* set by software */
  56. /* typedefs */
  58. /* Host Controller Operational Registers
  59.  *
  60.  * NOTE: The following values are offsets relative to the base of the memory
  61.  * window allocated for the OHCI controller.
  62.  */
  64. #define OHCI_HC_REVISION 0x0
  65. #define OHCI_HC_CONTROL  0x4
  66. #define OHCI_HC_COMMAND_STATUS 0x8
  67. #define OHCI_HC_INT_STATUS 0xc
  68. #define OHCI_HC_INT_ENABLE 0x10
  69. #define OHCI_HC_INT_DISABLE 0x14
  70. #define OHCI_HC_HCCA 0x18
  71. #define OHCI_HC_PERIOD_CUR_ED 0x1c
  72. #define OHCI_HC_CONTROL_HEAD_ED 0x20
  73. #define OHCI_HC_CONTROL_CUR_ED 0x24
  74. #define OHCI_HC_BULK_HEAD_ED 0x28
  75. #define OHCI_HC_BULK_CUR_ED 0x2c
  76. #define OHCI_HC_DONE_HEAD 0x30
  77. #define OHCI_HC_FM_INTERVAL 0x34
  78. #define OHCI_HC_FM_REMAINING 0x38
  79. #define OHCI_HC_FM_NUMBER 0x3c
  80. #define OHCI_HC_PERIODIC_START 0x40
  81. #define OHCI_HC_LS_THRESHOLD 0x44
  82. #define OHCI_HC_RH_DESCR_A 0x48
  83. #define OHCI_HC_RH_DESCR_B 0x4c
  84. #define OHCI_HC_RH_STATUS 0x50
  85. #define OHCI_HC_RH_PORT_STATUS 0x54     /* array of port regs */
  88. /* OHCI_HC_REVISION register */
  90. #define OHCI_RREV_REV_MASK 0x000000ff  /* BCD OpenHCI revision */
  93. /* OHCI_HC_CONTROL register */
  95. #define OHCI_CTL_CBSR_MASK 0x00000003  /* contro/bulk srvc ratio */
  96. #define OHCI_CTL_CBSR_ROT 0
  97. #define OHCI_CTL_CBSR_1TO1 0x00000000
  98. #define OHCI_CTL_CBSR_2TO1 0x00000001
  99. #define OHCI_CTL_CBSR_3TO1 0x00000002
  100. #define OHCI_CTL_CBSR_4TO1 0x00000003
  102. #define OHCI_CTL_PLE 0x00000004  /* periodic list enable */
  103. #define OHCI_CTL_IE 0x00000008  /* isochronous list enable */
  104. #define OHCI_CTL_CLE 0x00000010  /* control list enable */
  105. #define OHCI_CTL_BLE 0x00000020  /* bulk list enable */
  107. #define OHCI_CTL_HCFS_MASK 0x000000c0  /* host controller func state */
  108. #define OHCI_CTL_HCFS_RESET 0x00000000  /* UsbReset */
  109. #define OHCI_CTL_HCFS_RESUME 0x00000040  /* UsbResume */
  110. #define OHCI_CTL_HCFS_OP 0x00000080  /* UsbOperational */
  111. #define OHCI_CTL_HCFS_SUSPEND 0x000000c0  /* UsbSuspend */
  113. #define OHCI_CTL_IR 0x00000100  /* interrupt routing */
  114. #define OHCI_CTL_RWC 0x00000200  /* remote wakeup connected */
  115. #define OHCI_CTL_RWE 0x00000400  /* remote wakeup enable */
  117. /* macros to format/retrieve OHCI_TCL_CBSR (control/bulk ratio) field */
  119. #define OHCI_CTL_CBSR(x)     (((x) & OHCI_CTL_CBSR_MASK) >> OHCI_CTL_CBSR_ROT)
  120. #define OHCI_CTL_CBSR_FMT(x) (((x) << OHCI_CTL_CBSR_ROT) & OHCI_CTL_CBSR_MASK)
  123. /* OHCI_HC_COMMAND_STATUS register */
  125. #define OHCI_CS_HCR 0x00000001  /* host controller reset */
  126. #define OHCI_CS_CLF 0x00000002  /* control list filled */
  127. #define OHCI_CS_BLF 0x00000004  /* bulk list filled */
  128. #define OHCI_CS_OCR 0x00000008  /* ownership change request */
  130. #define OHCI_CS_SOC_MASK 0x00030000  /* scheduling overrun count */
  131. #define OHCI_CS_SOC_ROT  16
  133. /* macro to retrieve OHCI_CS_SOC (control/bulk ratio) field */
  135. #define OHCI_CS_SOC(x) (((x) & OHCI_CS_SOC_MASK) >> OHCI_CS_SOC_ROT)
  138. /* OHCI_HC_INT_STATUS, OHCI_HC_INT_ENABLE, and OHCI_HC_INT_DISABLE registers */
  140. #define OHCI_INT_SO 0x00000001  /* scheduling overrun */
  141. #define OHCI_INT_WDH 0x00000002  /* writeback done head */
  142. #define OHCI_INT_SF 0x00000004  /* start of frame */
  143. #define OHCI_INT_RD 0x00000008  /* resume detected */
  144. #define OHCI_INT_UE 0x00000010  /* unrecoverable error */
  145. #define OHCI_INT_FNO 0x00000020  /* frame number overflow */
  146. #define OHCI_INT_RHSC 0x00000040  /* root hub status change */
  147. #define OHCI_INT_OC 0x40000000  /* ownership change */
  148. #define OHCI_INT_MIE 0x80000000  /* master interrupt enable */
  151. /* OHCI_HC_FM_INTERVAL register */
  153. #define OHCI_FMI_FI_MASK 0x00003fff  /* frame interval */
  154. #define OHCI_FMI_FI_ROT  0
  155. #define OHCI_FMI_FI_DEFAULT 11999
  157. #define OHCI_FMI_FSMPS_MASK 0x7fff0000  /* FS largest data packet */
  158. #define OHCI_FMI_FSMPS_ROT 16
  160. #define OHCI_FMI_FIT 0x80000000  /* frame interval toggle */
  162. /* macros to format/retrieve OHCI_FMI_FI (frame interval) field */
  164. #define OHCI_FMI_FI(x)     (((x) & OHCI_FMI_FI_MASK) >> OHCI_FMI_FI_ROT)
  165. #define OHCI_FMI_FI_FMT(x)  (((x) << OHCI_FMI_FI_ROT) & OHCI_FMI_FI_MASK)
  167. /* macros to format/retrieve OHCI_FMI_FSMPS (FS largest data packet) field */
  169. #define OHCI_FMI_FSMPS(x)     (((x) & OHCI_FMI_FSMPS_MASK) >> OHCI_FMI_FSMPS_ROT)
  170. #define OHCI_FMI_FSMPS_FMT(x) (((x) << OHCI_FMI_FSMPS_ROT) & OHCI_FMI_FSMPS_MASK)
  173. /* OHCI_HC_FM_REMAINING register */
  175. #define OHCI_FMR_FR_MASK 0x00003fff  /* frame remaining */
  176. #define OHCI_FMR_FR_ROT  0
  178. #define OHCI_FMR_FRT 0x80000000  /* frame remaining toggle */
  180. /* macro to retrieve OHCI_FMI_FR (frame remaining) field */
  182. #define OHCI_FMI_FR(x) (((x) & OHCI_FMI_FR_MASK) >> OHCI_FMI_FR_ROT)
  185. /* OHCI_HC_FM_NUMBER register */
  187. #define OHCI_FMN_FN_MASK 0x0000ffff  /* frame number */
  188. #define OHCI_FMN_FN_ROT  0
  190. /* macro to retrieve OHCI_FMN_FN (frame number) field */
  192. #define OHCI_FMN_FN(x) (((x) & OHCI_FMN_FN_MASK) >> OHCI_FMN_FN_ROT)
  194. /* OHCI_FRAME_WINDOW defines the frame number range supported by OHCI. */
  196. #define OHCI_FRAME_WINDOW 0x10000
  199. /* OHCI_HC_PERIODIC_START register */
  201. #define OHCI_PS_PS_MASK  0x00003fff  /* periodic start */
  202. #define OHCI_PS_PS_ROT 0
  204. /* macros to format/retrieve OHCI_PS_PS (perodic start) field */
  206. #define OHCI_PS_PS(x)   (((x) & OHCI_PS_PS_MASK) >> OHCI_PS_PS_ROT)
  207. #define OHCI_PS_PS_FMT(x) (((x) << OHCI_PS_PS_ROT) & OHCI_PS_PS_MASK)
  210. /* OHCI_LS_THRESHOLD resgister */
  212. #define OHCI_LS_LST_MASK 0x000003ff  /* lowspeed threshold */
  213. #define OHCI_LS_LST_ROT  0
  215. /* macros to format/retrieve OHCI_LS_LST (low speed threshold) field */
  217. #define OHCI_LS_LST(x)    (((x) & OHCI_LS_LST_MASK) >> OHCI_LS_LST_ROT)
  218. #define OHCI_LS_LST_FMT(x) (((x) << OHCI_LS_LST_ROT) & OHCI_LS_LST_MASK)
  221. /* OHCI_RH_DESCR_A register */
  223. #define OHCI_RHDA_NDP_MASK 0x000000ff  /* number of downstream ports */
  224. #define OHCI_RHDA_NDP_ROT 0
  226. #define OHCI_RHDA_PSM 0x00000100  /* power swithcing mode */
  227. #define OHCI_RHDA_NPS 0x00000200  /* no power switching */
  228. #define OHCI_RHDA_DT 0x00000400  /* device type */
  229. #define OHCI_RHDA_OCPM 0x00000800  /* overcurrent protection mode */
  230. #define OHCI_RHDA_NOCP 0x00001000  /* no overcurrent protection */
  232. #define OHCI_RHDA_POTPGT_MASK 0xff000000  /* power on to pwr good time */
  233. #define OHCI_RHDA_POTPGT_ROT 24
  235. /* macro to retrieve OHCI_RHDA_NDP (nbr of downstream ports) field */
  237. #define OHCI_RHDA_NDP(x)    (((x) & OHCI_RHDA_NDP_MASK) >> OHCI_RHDA_NDP_ROT)
  239. /* macro to retrieve OHCI_RHDA_POTPGT (pwr on to pwr good time) field */
  241. #define OHCI_RHDA_POTPGT(x) (((x) & OHCI_RHDA_POTPGT_MASK) >> OHCI_RHDA_POTPGT_ROT)
  244. /* OHCI_RH_DESCR_B register */
  246. #define OHCI_RHDB_DR_MASK 0x0000ffff  /* device removable */
  247. #define OHCI_RHDB_DR_ROT 0
  249. #define OHCI_RHDB_PPCM_MASK 0xffff0000  /* port power control mask */
  250. #define OHCI_RHDB_PPCM_ROT 0
  252. /* macros to format/retrieve OHCI_RHDB_DR (device removable) field */
  254. #define OHCI_RHDB_DR(x)     (((x) & OHCI_RHDB_DR_MASK) >> OHCI_RHDB_DR_ROT)
  255. #define OHCI_RHDB_DR_FMT(x) (((x) << OHCI_RHDB_DR_ROT) & OHCI_RHDB_DR_MASK)
  257. /* macros to format/retrieve OHCI_RHDB_PPCM (port pwr control mask) field */
  259. #define OHCI_RHDB_PPCM(x)     (((x) & OHCI_RHDB_PPCM_MASK) >> OHCI_RHDB_PPCM_ROT)
  260. #define OHCI_RHDB_PPCM_FMT(x) (((x) << OHCI_RHDB_PPCM_ROT) & OHCI_RHDB_PPCM_MASK)
  263. /* OHCI_RH_STATUS register */
  265. #define OHCI_RHS_LPS 0x00000001  /* local power status */
  266. #define OHCI_RHS_CLR_GPWR 0x00000001  /* write '1' to clear global pwr */
  267. #define OHCI_RHS_OCI 0x00000002  /* over current indicator */
  268. #define OHCI_RHS_DRWE 0x00008000  /* device remote wakeup enable */
  269. #define OHCI_RHS_SET_RWE 0x00008000  /* write '1' to set remote wakeup */
  270. #define OHCI_RHS_LPSC 0x00010000  /* local power status change */
  271. #define OHCI_RHS_SET_GPWR 0x00010000  /* write '1' to set global pwr */
  272. #define OHCI_RHS_OCIC 0x00020000  /* over current indicator change */
  273. #define OHCI_RHS_CRWE 0x80000000  /* clear remote wakeup enable */
  274. #define OHCI_RHS_CLR_RWE 0x80000000  /* write '1' to clear wakeup enable */
  277. /* OHCI_RH_PORT_STATUS register(s) */
  279. #define OHCI_RHPS_CCS 0x00000001  /* current connect status */
  280. #define OHCI_RHPS_CLR_PE 0x00000001  /* write '1' to clear port enable */
  281. #define OHCI_RHPS_PES 0x00000002  /* port enable status */
  282. #define OHCI_RHPS_SET_PE 0x00000002  /* write '1' to set port enable */
  283. #define OHCI_RHPS_PSS 0x00000004  /* port suspend status */
  284. #define OHCI_RHPS_SET_PS 0x00000004  /* write '1' to set port suspend */
  285. #define OHCI_RHPS_POCI 0x00000008  /* port over current indicator */
  286. #define OHCI_RHPS_CLR_PS 0x00000008  /* write '1' to clear port suspend */
  287. #define OHCI_RHPS_PRS 0x00000010  /* port reset status */
  288. #define OHCI_RHPS_PPS 0x00000100  /* port power status */
  289. #define OHCI_RHPS_SET_PWR 0x00000100  /* write '1' to set port power */
  290. #define OHCI_RHPS_LSDA 0x00000200  /* low speed device attached */
  291. #define OHCI_RHPS_CLR_PWR 0x00000200  /* write '1' to clear port power */
  292. #define OHCI_RHPS_CSC 0x00010000  /* connect status change */
  293. #define OHCI_RHPS_PESC 0x00020000  /* port enable status change */
  294. #define OHCI_RHPS_PSSC 0x00040000  /* port suspend status change */
  295. #define OHCI_RHPS_OCIC 0x00080000  /* port over current indicator chg */
  296. #define OHCI_RHPS_PRSC 0x00100000  /* port reset status change */
  299. /* OHCI_ED - OHCI Endpoint Descriptor
  300.  *
  301.  * NOTE: OHCI_ED must be aligned to a 16-byte boundary,
  302.  */
  304. #define OHCI_ED_ALIGNMENT 16     /* alignment */
  306. typedef struct ohci_ed
  307.     {
  308.     UINT32 control;     /* control word */
  309.     UINT32 tdTail;     /* TD queue tail pointer */
  310.     UINT32 tdHead;     /* TD queue head pointer */
  311.     UINT32 nextEd;     /* next OHCI_ED */
  312.     } OHCI_ED, *pOHCI_ED;   
  314. #define OHCI_ED_LEN 16  /* expected size of OHCI_ED */
  315. #define OHCI_ED_ACTLEN sizeof (OHCI_ED)    /* actual */
  318. /* OHCI_ED.control definitions */
  320. #define OHCI_EDCTL_FA_MASK 0x0000007f  /* function address */
  321. #define OHCI_EDCTL_FA_ROT 0
  323. #define OHCI_EDCTL_EN_MASK 0x00000780  /* endpoint number */
  324. #define OHCI_EDCTL_EN_ROT 7
  326. #define OHCI_EDCTL_DIR_MASK 0x00001800  /* direction */
  327. #define OHCI_EDCTL_DIR_TD 0x00000000  /* get direction from TD */
  328. #define OHCI_EDCTL_DIR_OUT 0x00000800  /* OUT */
  329. #define OHCI_EDCTL_DIR_IN 0x00001000  /* get direction from TD */
  331. #define OHCI_EDCTL_SPD_MASK 0x00002000  /* speed */
  332. #define OHCI_EDCTL_SPD_FULL 0x00000000  /* full speed (12mbit) device */
  333. #define OHCI_EDCTL_SPD_LOW 0x00002000  /* low speed device */
  335. #define OHCI_EDCTL_SKIP  0x00004000  /* skip ED */
  337. #define OHCI_EDCTL_FMT_MASK 0x00008000  /* TD format */
  338. #define OHCI_EDCTL_FMT_GEN 0x00000000  /* general: ctl/bulk/int */
  339. #define OHCI_EDCTL_FMT_ISO 0x00008000  /* isochronous TDs */
  341. #define OHCI_EDCTL_MPS_MASK 0x07ff0000  /* maximum packet size */
  342. #define OHCI_EDCTL_MPS_ROT 16
  344. /* macros to format/retrieve control.FA (function address) field */
  346. #define OHCI_EDCTL_FA(x)     (((x) & OHCI_EDCTL_FA_MASK) >> OHCI_EDCTL_FA_ROT)
  347. #define OHCI_EDCTL_FA_FMT(x) (((x) << OHCI_EDCTL_FA_ROT) & OHCI_EDCTL_FA_MASK)
  349. /* macros to format/retrieve control.EN (endpoint number) field */
  351. #define OHCI_EDCTL_EN(x)     (((x) & OHCI_EDCTL_EN_MASK) >> OHCI_EDCTL_EN_ROT)
  352. #define OHCI_EDCTL_EN_FMT(x) (((x) << OHCI_EDCTL_EN_ROT) & OHCI_EDCTL_EN_MASK)
  354. /* macros to format/retrieve control.MPS (max packet size) field */
  356. #define OHCI_EDCTL_MPS(x)     (((x) & OHCI_EDCTL_MPS_MASK) >> OHCI_EDCTL_MPS_ROT)
  357. #define OHCI_EDCTL_MPS_FMT(x) (((x) << OHCI_EDCTL_MPS_ROT) & OHCI_EDCTL_MPS_MASK)
  360. /* Memory pointer definitions.
  361.  *
  362.  * NOTE: Some/all of these definitions apply to the OHCI_ED.tdTail, tdHead, and 
  363.  * nextEd fields.
  364.  */
  366. #define OHCI_PTR_MEM_MASK 0xfffffff0  /* mask for memory pointer */
  367. #define OHCI_PTR_HALTED  0x00000001  /* indicates TD queue is halted */
  368. #define OHCI_PTR_TGL_CARRY 0x00000002  /* toggle carry */
  370. #define OHCI_PAGE_SIZE 0x00001000  /* 4k pages */
  371. #define OHCI_PAGE_MASK 0xfffff000  /* page # mask */
  373. #define OHCI_ISO_OFFSET_MASK 0x00000fff  /* mask for 4k page */
  374. #define OHCI_ISO_OFFSET_BP0 0x00000000  /* offset within BufferPage0 page */
  375. #define OHCI_ISO_OFFSET_BE 0x00001000  /* offset within BufferEnd page */
  378. /* OHCI_TD_GEN - OHCI Transfer Descriptor - General: Ctl/Bulk/Int 
  379.  *
  380.  * NOTE: Must be aligned to 16 byte boundary.
  381.  */
  383. #define OHCI_TD_GEN_ALIGNMENT 16     /* alignment */
  385. typedef struct ohci_td_gen
  386.     {
  387.     UINT32 control;     /* control word */
  388.     UINT32 cbp;      /* current buffer pointer */
  389.     UINT32 nextTd;     /* next TD */
  390.     UINT32 be;     /* buffer end */
  391.     } OHCI_TD_GEN, *pOHCI_TD_GEN;
  393. #define OHCI_TD_GEN_LEN      16 /* expected size of OHCI_TD_ISO */
  394. #define OHCI_TD_GEN_ACTLEN     sizeof (OHCI_TD_GEN)    /* actual */
  397. /* OHCI_TD_GEN.control definitions */
  399. #define OHCI_TGCTL_BFR_RND 0x00040000  /* buffer rounding */
  401. #define OHCI_TGCTL_PID_MASK 0x00180000  /* direction/PID */
  402. #define OHCI_TGCTL_PID_SETUP 0x00000000  /* SETUP */
  403. #define OHCI_TGCTL_PID_OUT 0x00080000  /* OUT */
  404. #define OHCI_TGCTL_PID_IN 0x00100000  /* IN */
  406. #define OHCI_TGCTL_DI_MASK 0x00e00000  /* delay interrupt */
  407. #define OHCI_TGCTL_DI_ROT 21
  408. #define OHCI_TGCTL_DI_NONE 7
  410. #define OHCI_TGCTL_TOGGLE_DATA0 0x00000000  /* indicates DATA0 */
  411. #define OHCI_TGCTL_TOGGLE_DATA1 0x01000000  /* indicates DATA1 */
  412. #define OHCI_TGCTL_TOGGLE_USEED 0x00000000  /* use toggle from ED */
  413. #define OHCI_TGCTL_TOGGLE_USETD 0x02000000  /* use toggle from TD */
  415. #define OHCI_TGCTL_ERRCNT_MASK 0x0c000000  /* error count */
  417. #define OHCI_TGCTL_CC_MASK 0xf0000000  /* condition code */
  418. #define OHCI_TGCTL_CC_ROT 28
  420. /* macros to format/retrieve control.DI (delay interrupt) field */
  422. #define OHCI_TGCTL_DI(x)     (((x) & OHCI_TGCTL_DI_MASK) >> OHCI_TGCTL_DI_ROT)
  423. #define OHCI_TGCTL_DI_FMT(x) (((x) << OHCI_TGCTL_DI_ROT) & OHCI_TGCTL_DI_MASK)
  425. /* macro to retrieve control.CC (completion code) field */
  427. #define OHCI_TGCTL_CC(x)    (((x) & OHCI_TGCTL_CC_MASK) >> OHCI_TGCTL_CC_ROT)
  430. /* OHCI_TD_ISO - OHCI Transfer Descriptor - Isochronous 
  431.  *
  432.  * NOTE: Must be aligned to 32 byte boundary.
  433.  */
  435. #define OHCI_TD_ISO_ALIGNMENT 32     /* alignment */
  436. #define OHCI_ISO_PSW_CNT 8     /* count of pkt status words */
  438. typedef struct ohci_td_iso
  439.     {
  440.     UINT32 control;     /* control word */
  441.     UINT32 bp0;      /* buffer page 0 */
  442.     UINT32 nextTd;     /* next TD */
  443.     UINT32 be;     /* buffer end */
  444.     UINT16 psw [OHCI_ISO_PSW_CNT];  /* array of packet status words */
  445.     } OHCI_TD_ISO, *pOHCI_TD_ISO;
  447. #define OHCI_TD_ISO_LEN  32  /* expected size of OHCI_TD_ISO */
  448. #define OHCI_TD_ISO_ACTLEN sizeof (OHCI_TD_ISO) /* actual */
  451. /* OHCI_TD_ISO.control definitions */
  453. #define OHCI_TICTL_SF_MASK 0x0000ffff  /* starting frame */
  454. #define OHCI_TICTL_SF_ROT 0
  456. #define OHCI_TICTL_DI_MASK 0x00e00000  /* delay interrupt */
  457. #define OHCI_TICTL_DI_ROT 21
  458. #define OHCI_TICTL_DI_NONE 7
  460. #define OHCI_TICTL_FC_MASK 0x07000000  /* frame count */
  461. #define OHCI_TICTL_FC_ROT 24
  462. #define OHCI_FC_SIZE_MASK 0x7     /* mask for 3-bit count */
  464. #define OHCI_TICTL_CC_MASK 0xf0000000  /* condition code */
  465. #define OHCI_TICTL_CC_ROT 28
  467. /* macros to format/retrieve control.SF (starting frame) field */
  469. #define OHCI_TICTL_SF(x)     (((x) & OHCI_TICTL_SF_MASK) >> OHCI_TICTL_SF_ROT)
  470. #define OHCI_TICTL_SF_FMT(x) (((x) << OHCI_TICTL_SF_ROT) & OHCI_TICTL_SF_MASK)
  472. /* Macros to retrieve/format control.FC (frame count) field
  473.  *
  474.  * NOTE: OHCI frame count is one less than the real frame count. The macros 
  475.  * compensate automatically.
  476.  */
  478. #define OHCI_TICTL_FC(x)     ((((x) & OHCI_TICTL_FC_MASK) >> OHCI_TICTL_FC_ROT) + 1)
  479. #define OHCI_TICTL_FC_FMT(x) ((((x) - 1) & OHCI_FC_SIZE_MASK) << OHCI_TICTL_FC_ROT)
  481. /* macro to retrieve control.CC (completion code) field */
  483. #define OHCI_TICTL_CC(x)    (((x) & OHCI_TICTL_CC_MASK) >> OHCI_TICTL_CC_ROT)
  486. /* OHCI_TD_ISO.psw definitions */
  488. #define OHCI_TIPSW_SIZE_MASK 0x07ff     /* size of packet */
  489. #define OHCI_TIPSW_SIZE_ROT 0
  491. #define OHCI_TIPSW_CC_MASK 0xf000     /* completion code */
  492. #define OHCI_TIPSW_CC_ROT 12
  494. /* macro to retrieve psw.size field */
  496. #define OHCI_TIPSW_SIZE(x)  (((x) & OHCI_TIPSW_SIZE_MASK) >> OHCI_TIPSW_SIZE_ROT)
  498. /* macro to retrieve psw.CC (completion code) field */
  500. #define OHCI_TIPSW_CC(x)     (((x) & OHCI_TIPSW_CC_MASK) >> OHCI_TIPSW_CC_ROT)
  501. #define OHCI_TIPSW_CC_FMT(x) (((x) << OHCI_TIPSW_CC_ROT) & OHCI_TIPSW_CC_MASK)
  504. /* OHCI_HCCA - Host Controller Communications Area
  505.  *
  506.  * NOTE: This structure must be aligned to a 256 byte boundary.
  507.  */
  509. #define OHCI_HCCA_ALIGNMENT 256     /* HCCA alignment requirement */
  510. #define OHCI_INT_ED_COUNT 32     /* count of interrupt ED heads */
  511. #define OHCI_HCCA_HC_RESERVED 120     /* count of reserved bytes */
  512. #define OHCI_HCCA_LEN 256     /* expected size of structure */
  514. typedef struct ohci_hcca
  515.     {
  516.     UINT32 intEdTable [OHCI_INT_ED_COUNT];  /* ptrs to interrupt EDs */
  517.     UINT16 frameNo;     /* frame no in low 16-bits */
  518.     UINT16 pad1;     /* set to 0 when updating frameNo */
  519.     UINT32 doneHead;     /* ptr to first completed TD */
  520.     UINT8 hcReserved [OHCI_HCCA_HC_RESERVED]; /* reserved by HC */
  521.     } OHCI_HCCA, *pOHCI_HCCA;
  523. #define OHCI_HCCA_LEN 256     /* expected size of structure */
  524. #define OHCI_HCCA_ACTLEN sizeof (OHCI_HCCA)  /* actual size */
  527. /* If the low bit of the doneHead field is written as '1' by the HC, then
  528.  * an additional interrupt condition is present and the host controller driver
  529.  * should interrogate the HcInterruptStatus register to determine the cause.
  530.  */
  532. #define OHCI_DONE_HEAD_OTHER_INT    0x00000001
  535. #ifdef __cplusplus
  536. }
  537. #endif
  539. #endif /* __INCusbOhcih */
  542. /* End of file. */