uhci-hcd.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665
  1. #ifndef __LINUX_UHCI_HCD_H
  2. #define __LINUX_UHCI_HCD_H
  3. #include <linux/list.h>
  4. #include <linux/usb.h>
  5. #define usb_packetid(pipe) (usb_pipein(pipe) ? USB_PID_IN : USB_PID_OUT)
  6. #define PIPE_DEVEP_MASK 0x0007ff00
  7. /*
  8. * Universal Host Controller Interface data structures and defines
  9. */
  10. /* Command register */
  11. #define USBCMD 0
  12. #define USBCMD_RS 0x0001 /* Run/Stop */
  13. #define USBCMD_HCRESET 0x0002 /* Host reset */
  14. #define USBCMD_GRESET 0x0004 /* Global reset */
  15. #define USBCMD_EGSM 0x0008 /* Global Suspend Mode */
  16. #define USBCMD_FGR 0x0010 /* Force Global Resume */
  17. #define USBCMD_SWDBG 0x0020 /* SW Debug mode */
  18. #define USBCMD_CF 0x0040 /* Config Flag (sw only) */
  19. #define USBCMD_MAXP 0x0080 /* Max Packet (0 = 32, 1 = 64) */
  20. /* Status register */
  21. #define USBSTS 2
  22. #define USBSTS_USBINT 0x0001 /* Interrupt due to IOC */
  23. #define USBSTS_ERROR 0x0002 /* Interrupt due to error */
  24. #define USBSTS_RD 0x0004 /* Resume Detect */
  25. #define USBSTS_HSE 0x0008 /* Host System Error: PCI problems */
  26. #define USBSTS_HCPE 0x0010 /* Host Controller Process Error:
  27. * the schedule is buggy */
  28. #define USBSTS_HCH 0x0020 /* HC Halted */
  29. /* Interrupt enable register */
  30. #define USBINTR 4
  31. #define USBINTR_TIMEOUT 0x0001 /* Timeout/CRC error enable */
  32. #define USBINTR_RESUME 0x0002 /* Resume interrupt enable */
  33. #define USBINTR_IOC 0x0004 /* Interrupt On Complete enable */
  34. #define USBINTR_SP 0x0008 /* Short packet interrupt enable */
  35. #define USBFRNUM 6
  36. #define USBFLBASEADD 8
  37. #define USBSOF 12
  38. #define USBSOF_DEFAULT 64 /* Frame length is exactly 1 ms */
  39. /* USB port status and control registers */
  40. #define USBPORTSC1 16
  41. #define USBPORTSC2 18
  42. #define USBPORTSC_CCS 0x0001 /* Current Connect Status
  43. * ("device present") */
  44. #define USBPORTSC_CSC 0x0002 /* Connect Status Change */
  45. #define USBPORTSC_PE 0x0004 /* Port Enable */
  46. #define USBPORTSC_PEC 0x0008 /* Port Enable Change */
  47. #define USBPORTSC_DPLUS 0x0010 /* D+ high (line status) */
  48. #define USBPORTSC_DMINUS 0x0020 /* D- high (line status) */
  49. #define USBPORTSC_RD 0x0040 /* Resume Detect */
  50. #define USBPORTSC_RES1 0x0080 /* reserved, always 1 */
  51. #define USBPORTSC_LSDA 0x0100 /* Low Speed Device Attached */
  52. #define USBPORTSC_PR 0x0200 /* Port Reset */
  53. /* OC and OCC from Intel 430TX and later (not UHCI 1.1d spec) */
  54. #define USBPORTSC_OC 0x0400 /* Over Current condition */
  55. #define USBPORTSC_OCC 0x0800 /* Over Current Change R/WC */
  56. #define USBPORTSC_SUSP 0x1000 /* Suspend */
  57. #define USBPORTSC_RES2 0x2000 /* reserved, write zeroes */
  58. #define USBPORTSC_RES3 0x4000 /* reserved, write zeroes */
  59. #define USBPORTSC_RES4 0x8000 /* reserved, write zeroes */
  60. /* PCI legacy support register */
  61. #define USBLEGSUP 0xc0
  62. #define USBLEGSUP_DEFAULT 0x2000 /* only PIRQ enable set */
  63. #define USBLEGSUP_RWC 0x8f00 /* the R/WC bits */
  64. #define USBLEGSUP_RO 0x5040 /* R/O and reserved bits */
  65. /* PCI Intel-specific resume-enable register */
  66. #define USBRES_INTEL 0xc4
  67. #define USBPORT1EN 0x01
  68. #define USBPORT2EN 0x02
  69. #define UHCI_PTR_BITS(uhci) cpu_to_hc32((uhci), 0x000F)
  70. #define UHCI_PTR_TERM(uhci) cpu_to_hc32((uhci), 0x0001)
  71. #define UHCI_PTR_QH(uhci) cpu_to_hc32((uhci), 0x0002)
  72. #define UHCI_PTR_DEPTH(uhci) cpu_to_hc32((uhci), 0x0004)
  73. #define UHCI_PTR_BREADTH(uhci) cpu_to_hc32((uhci), 0x0000)
  74. #define UHCI_NUMFRAMES 1024 /* in the frame list [array] */
  75. #define UHCI_MAX_SOF_NUMBER 2047 /* in an SOF packet */
  76. #define CAN_SCHEDULE_FRAMES 1000 /* how far in the future frames
  77. * can be scheduled */
  78. #define MAX_PHASE 32 /* Periodic scheduling length */
  79. /* When no queues need Full-Speed Bandwidth Reclamation,
  80. * delay this long before turning FSBR off */
  81. #define FSBR_OFF_DELAY msecs_to_jiffies(10)
  82. /* If a queue hasn't advanced after this much time, assume it is stuck */
  83. #define QH_WAIT_TIMEOUT msecs_to_jiffies(200)
  84. /*
  85. * __hc32 and __hc16 are "Host Controller" types, they may be equivalent to
  86. * __leXX (normally) or __beXX (given UHCI_BIG_ENDIAN_DESC), depending on
  87. * the host controller implementation.
  88. *
  89. * To facilitate the strongest possible byte-order checking from "sparse"
  90. * and so on, we use __leXX unless that's not practical.
  91. */
  92. #ifdef CONFIG_USB_UHCI_BIG_ENDIAN_DESC
  93. typedef __u32 __bitwise __hc32;
  94. typedef __u16 __bitwise __hc16;
  95. #else
  96. #define __hc32 __le32
  97. #define __hc16 __le16
  98. #endif
  99. /*
  100. * Queue Headers
  101. */
  102. /*
  103. * One role of a QH is to hold a queue of TDs for some endpoint. One QH goes
  104. * with each endpoint, and qh->element (updated by the HC) is either:
  105. * - the next unprocessed TD in the endpoint's queue, or
  106. * - UHCI_PTR_TERM (when there's no more traffic for this endpoint).
  107. *
  108. * The other role of a QH is to serve as a "skeleton" framelist entry, so we
  109. * can easily splice a QH for some endpoint into the schedule at the right
  110. * place. Then qh->element is UHCI_PTR_TERM.
  111. *
  112. * In the schedule, qh->link maintains a list of QHs seen by the HC:
  113. * skel1 --> ep1-qh --> ep2-qh --> ... --> skel2 --> ...
  114. *
  115. * qh->node is the software equivalent of qh->link. The differences
  116. * are that the software list is doubly-linked and QHs in the UNLINKING
  117. * state are on the software list but not the hardware schedule.
  118. *
  119. * For bookkeeping purposes we maintain QHs even for Isochronous endpoints,
  120. * but they never get added to the hardware schedule.
  121. */
  122. #define QH_STATE_IDLE 1 /* QH is not being used */
  123. #define QH_STATE_UNLINKING 2 /* QH has been removed from the
  124. * schedule but the hardware may
  125. * still be using it */
  126. #define QH_STATE_ACTIVE 3 /* QH is on the schedule */
  127. struct uhci_qh {
  128. /* Hardware fields */
  129. __hc32 link; /* Next QH in the schedule */
  130. __hc32 element; /* Queue element (TD) pointer */
  131. /* Software fields */
  132. dma_addr_t dma_handle;
  133. struct list_head node; /* Node in the list of QHs */
  134. struct usb_host_endpoint *hep; /* Endpoint information */
  135. struct usb_device *udev;
  136. struct list_head queue; /* Queue of urbps for this QH */
  137. struct uhci_td *dummy_td; /* Dummy TD to end the queue */
  138. struct uhci_td *post_td; /* Last TD completed */
  139. struct usb_iso_packet_descriptor *iso_packet_desc;
  140. /* Next urb->iso_frame_desc entry */
  141. unsigned long advance_jiffies; /* Time of last queue advance */
  142. unsigned int unlink_frame; /* When the QH was unlinked */
  143. unsigned int period; /* For Interrupt and Isochronous QHs */
  144. short phase; /* Between 0 and period-1 */
  145. short load; /* Periodic time requirement, in us */
  146. unsigned int iso_frame; /* Frame # for iso_packet_desc */
  147. int state; /* QH_STATE_xxx; see above */
  148. int type; /* Queue type (control, bulk, etc) */
  149. int skel; /* Skeleton queue number */
  150. unsigned int initial_toggle:1; /* Endpoint's current toggle value */
  151. unsigned int needs_fixup:1; /* Must fix the TD toggle values */
  152. unsigned int is_stopped:1; /* Queue was stopped by error/unlink */
  153. unsigned int wait_expired:1; /* QH_WAIT_TIMEOUT has expired */
  154. unsigned int bandwidth_reserved:1; /* Periodic bandwidth has
  155. * been allocated */
  156. } __attribute__((aligned(16)));
  157. /*
  158. * We need a special accessor for the element pointer because it is
  159. * subject to asynchronous updates by the controller.
  160. */
  161. #define qh_element(qh) ACCESS_ONCE((qh)->element)
  162. #define LINK_TO_QH(uhci, qh) (UHCI_PTR_QH((uhci)) | \
  163. cpu_to_hc32((uhci), (qh)->dma_handle))
  164. /*
  165. * Transfer Descriptors
  166. */
  167. /*
  168. * for TD <status>:
  169. */
  170. #define TD_CTRL_SPD (1 << 29) /* Short Packet Detect */
  171. #define TD_CTRL_C_ERR_MASK (3 << 27) /* Error Counter bits */
  172. #define TD_CTRL_C_ERR_SHIFT 27
  173. #define TD_CTRL_LS (1 << 26) /* Low Speed Device */
  174. #define TD_CTRL_IOS (1 << 25) /* Isochronous Select */
  175. #define TD_CTRL_IOC (1 << 24) /* Interrupt on Complete */
  176. #define TD_CTRL_ACTIVE (1 << 23) /* TD Active */
  177. #define TD_CTRL_STALLED (1 << 22) /* TD Stalled */
  178. #define TD_CTRL_DBUFERR (1 << 21) /* Data Buffer Error */
  179. #define TD_CTRL_BABBLE (1 << 20) /* Babble Detected */
  180. #define TD_CTRL_NAK (1 << 19) /* NAK Received */
  181. #define TD_CTRL_CRCTIMEO (1 << 18) /* CRC/Time Out Error */
  182. #define TD_CTRL_BITSTUFF (1 << 17) /* Bit Stuff Error */
  183. #define TD_CTRL_ACTLEN_MASK 0x7FF /* actual length, encoded as n - 1 */
  184. #define TD_CTRL_ANY_ERROR (TD_CTRL_STALLED | TD_CTRL_DBUFERR | \
  185. TD_CTRL_BABBLE | TD_CTRL_CRCTIME | \
  186. TD_CTRL_BITSTUFF)
  187. #define uhci_maxerr(err) ((err) << TD_CTRL_C_ERR_SHIFT)
  188. #define uhci_status_bits(ctrl_sts) ((ctrl_sts) & 0xF60000)
  189. #define uhci_actual_length(ctrl_sts) (((ctrl_sts) + 1) & \
  190. TD_CTRL_ACTLEN_MASK) /* 1-based */
  191. /*
  192. * for TD <info>: (a.k.a. Token)
  193. */
  194. #define td_token(uhci, td) hc32_to_cpu((uhci), (td)->token)
  195. #define TD_TOKEN_DEVADDR_SHIFT 8
  196. #define TD_TOKEN_TOGGLE_SHIFT 19
  197. #define TD_TOKEN_TOGGLE (1 << 19)
  198. #define TD_TOKEN_EXPLEN_SHIFT 21
  199. #define TD_TOKEN_EXPLEN_MASK 0x7FF /* expected length, encoded as n-1 */
  200. #define TD_TOKEN_PID_MASK 0xFF
  201. #define uhci_explen(len) ((((len) - 1) & TD_TOKEN_EXPLEN_MASK) << \
  202. TD_TOKEN_EXPLEN_SHIFT)
  203. #define uhci_expected_length(token) ((((token) >> TD_TOKEN_EXPLEN_SHIFT) + \
  204. 1) & TD_TOKEN_EXPLEN_MASK)
  205. #define uhci_toggle(token) (((token) >> TD_TOKEN_TOGGLE_SHIFT) & 1)
  206. #define uhci_endpoint(token) (((token) >> 15) & 0xf)
  207. #define uhci_devaddr(token) (((token) >> TD_TOKEN_DEVADDR_SHIFT) & 0x7f)
  208. #define uhci_devep(token) (((token) >> TD_TOKEN_DEVADDR_SHIFT) & 0x7ff)
  209. #define uhci_packetid(token) ((token) & TD_TOKEN_PID_MASK)
  210. #define uhci_packetout(token) (uhci_packetid(token) != USB_PID_IN)
  211. #define uhci_packetin(token) (uhci_packetid(token) == USB_PID_IN)
  212. /*
  213. * The documentation says "4 words for hardware, 4 words for software".
  214. *
  215. * That's silly, the hardware doesn't care. The hardware only cares that
  216. * the hardware words are 16-byte aligned, and we can have any amount of
  217. * sw space after the TD entry.
  218. *
  219. * td->link points to either another TD (not necessarily for the same urb or
  220. * even the same endpoint), or nothing (PTR_TERM), or a QH.
  221. */
  222. struct uhci_td {
  223. /* Hardware fields */
  224. __hc32 link;
  225. __hc32 status;
  226. __hc32 token;
  227. __hc32 buffer;
  228. /* Software fields */
  229. dma_addr_t dma_handle;
  230. struct list_head list;
  231. int frame; /* for iso: what frame? */
  232. struct list_head fl_list;
  233. } __attribute__((aligned(16)));
  234. /*
  235. * We need a special accessor for the control/status word because it is
  236. * subject to asynchronous updates by the controller.
  237. */
  238. #define td_status(uhci, td) hc32_to_cpu((uhci), \
  239. ACCESS_ONCE((td)->status))
  240. #define LINK_TO_TD(uhci, td) (cpu_to_hc32((uhci), (td)->dma_handle))
  241. /*
  242. * Skeleton Queue Headers
  243. */
  244. /*
  245. * The UHCI driver uses QHs with Interrupt, Control and Bulk URBs for
  246. * automatic queuing. To make it easy to insert entries into the schedule,
  247. * we have a skeleton of QHs for each predefined Interrupt latency.
  248. * Asynchronous QHs (low-speed control, full-speed control, and bulk)
  249. * go onto the period-1 interrupt list, since they all get accessed on
  250. * every frame.
  251. *
  252. * When we want to add a new QH, we add it to the list starting from the
  253. * appropriate skeleton QH. For instance, the schedule can look like this:
  254. *
  255. * skel int128 QH
  256. * dev 1 interrupt QH
  257. * dev 5 interrupt QH
  258. * skel int64 QH
  259. * skel int32 QH
  260. * ...
  261. * skel int1 + async QH
  262. * dev 5 low-speed control QH
  263. * dev 1 bulk QH
  264. * dev 2 bulk QH
  265. *
  266. * There is a special terminating QH used to keep full-speed bandwidth
  267. * reclamation active when no full-speed control or bulk QHs are linked
  268. * into the schedule. It has an inactive TD (to work around a PIIX bug,
  269. * see the Intel errata) and it points back to itself.
  270. *
  271. * There's a special skeleton QH for Isochronous QHs which never appears
  272. * on the schedule. Isochronous TDs go on the schedule before the
  273. * the skeleton QHs. The hardware accesses them directly rather than
  274. * through their QH, which is used only for bookkeeping purposes.
  275. * While the UHCI spec doesn't forbid the use of QHs for Isochronous,
  276. * it doesn't use them either. And the spec says that queues never
  277. * advance on an error completion status, which makes them totally
  278. * unsuitable for Isochronous transfers.
  279. *
  280. * There's also a special skeleton QH used for QHs which are in the process
  281. * of unlinking and so may still be in use by the hardware. It too never
  282. * appears on the schedule.
  283. */
  284. #define UHCI_NUM_SKELQH 11
  285. #define SKEL_UNLINK 0
  286. #define skel_unlink_qh skelqh[SKEL_UNLINK]
  287. #define SKEL_ISO 1
  288. #define skel_iso_qh skelqh[SKEL_ISO]
  289. /* int128, int64, ..., int1 = 2, 3, ..., 9 */
  290. #define SKEL_INDEX(exponent) (9 - exponent)
  291. #define SKEL_ASYNC 9
  292. #define skel_async_qh skelqh[SKEL_ASYNC]
  293. #define SKEL_TERM 10
  294. #define skel_term_qh skelqh[SKEL_TERM]
  295. /* The following entries refer to sublists of skel_async_qh */
  296. #define SKEL_LS_CONTROL 20
  297. #define SKEL_FS_CONTROL 21
  298. #define SKEL_FSBR SKEL_FS_CONTROL
  299. #define SKEL_BULK 22
  300. /*
  301. * The UHCI controller and root hub
  302. */
  303. /*
  304. * States for the root hub:
  305. *
  306. * To prevent "bouncing" in the presence of electrical noise,
  307. * when there are no devices attached we delay for 1 second in the
  308. * RUNNING_NODEVS state before switching to the AUTO_STOPPED state.
  309. *
  310. * (Note that the AUTO_STOPPED state won't be necessary once the hub
  311. * driver learns to autosuspend.)
  312. */
  313. enum uhci_rh_state {
  314. /* In the following states the HC must be halted.
  315. * These two must come first. */
  316. UHCI_RH_RESET,
  317. UHCI_RH_SUSPENDED,
  318. UHCI_RH_AUTO_STOPPED,
  319. UHCI_RH_RESUMING,
  320. /* In this state the HC changes from running to halted,
  321. * so it can legally appear either way. */
  322. UHCI_RH_SUSPENDING,
  323. /* In the following states it's an error if the HC is halted.
  324. * These two must come last. */
  325. UHCI_RH_RUNNING, /* The normal state */
  326. UHCI_RH_RUNNING_NODEVS, /* Running with no devices attached */
  327. };
  328. /*
  329. * The full UHCI controller information:
  330. */
  331. struct uhci_hcd {
  332. /* debugfs */
  333. struct dentry *dentry;
  334. /* Grabbed from PCI */
  335. unsigned long io_addr;
  336. /* Used when registers are memory mapped */
  337. void __iomem *regs;
  338. struct dma_pool *qh_pool;
  339. struct dma_pool *td_pool;
  340. struct uhci_td *term_td; /* Terminating TD, see UHCI bug */
  341. struct uhci_qh *skelqh[UHCI_NUM_SKELQH]; /* Skeleton QHs */
  342. struct uhci_qh *next_qh; /* Next QH to scan */
  343. spinlock_t lock;
  344. dma_addr_t frame_dma_handle; /* Hardware frame list */
  345. __hc32 *frame;
  346. void **frame_cpu; /* CPU's frame list */
  347. enum uhci_rh_state rh_state;
  348. unsigned long auto_stop_time; /* When to AUTO_STOP */
  349. unsigned int frame_number; /* As of last check */
  350. unsigned int is_stopped;
  351. #define UHCI_IS_STOPPED 9999 /* Larger than a frame # */
  352. unsigned int last_iso_frame; /* Frame of last scan */
  353. unsigned int cur_iso_frame; /* Frame for current scan */
  354. unsigned int scan_in_progress:1; /* Schedule scan is running */
  355. unsigned int need_rescan:1; /* Redo the schedule scan */
  356. unsigned int dead:1; /* Controller has died */
  357. unsigned int RD_enable:1; /* Suspended root hub with
  358. Resume-Detect interrupts
  359. enabled */
  360. unsigned int is_initialized:1; /* Data structure is usable */
  361. unsigned int fsbr_is_on:1; /* FSBR is turned on */
  362. unsigned int fsbr_is_wanted:1; /* Does any URB want FSBR? */
  363. unsigned int fsbr_expiring:1; /* FSBR is timing out */
  364. struct timer_list fsbr_timer; /* For turning off FBSR */
  365. /* Silicon quirks */
  366. unsigned int oc_low:1; /* OverCurrent bit active low */
  367. unsigned int wait_for_hp:1; /* Wait for HP port reset */
  368. unsigned int big_endian_mmio:1; /* Big endian registers */
  369. unsigned int big_endian_desc:1; /* Big endian descriptors */
  370. /* Support for port suspend/resume/reset */
  371. unsigned long port_c_suspend; /* Bit-arrays of ports */
  372. unsigned long resuming_ports;
  373. unsigned long ports_timeout; /* Time to stop signalling */
  374. struct list_head idle_qh_list; /* Where the idle QHs live */
  375. int rh_numports; /* Number of root-hub ports */
  376. wait_queue_head_t waitqh; /* endpoint_disable waiters */
  377. int num_waiting; /* Number of waiters */
  378. int total_load; /* Sum of array values */
  379. short load[MAX_PHASE]; /* Periodic allocations */
  380. /* Reset host controller */
  381. void (*reset_hc) (struct uhci_hcd *uhci);
  382. int (*check_and_reset_hc) (struct uhci_hcd *uhci);
  383. /* configure_hc should perform arch specific settings, if needed */
  384. void (*configure_hc) (struct uhci_hcd *uhci);
  385. /* Check for broken resume detect interrupts */
  386. int (*resume_detect_interrupts_are_broken) (struct uhci_hcd *uhci);
  387. /* Check for broken global suspend */
  388. int (*global_suspend_mode_is_broken) (struct uhci_hcd *uhci);
  389. };
  390. /* Convert between a usb_hcd pointer and the corresponding uhci_hcd */
  391. static inline struct uhci_hcd *hcd_to_uhci(struct usb_hcd *hcd)
  392. {
  393. return (struct uhci_hcd *) (hcd->hcd_priv);
  394. }
  395. static inline struct usb_hcd *uhci_to_hcd(struct uhci_hcd *uhci)
  396. {
  397. return container_of((void *) uhci, struct usb_hcd, hcd_priv);
  398. }
  399. #define uhci_dev(u) (uhci_to_hcd(u)->self.controller)
  400. /* Utility macro for comparing frame numbers */
  401. #define uhci_frame_before_eq(f1, f2) (0 <= (int) ((f2) - (f1)))
  402. /*
  403. * Private per-URB data
  404. */
  405. struct urb_priv {
  406. struct list_head node; /* Node in the QH's urbp list */
  407. struct urb *urb;
  408. struct uhci_qh *qh; /* QH for this URB */
  409. struct list_head td_list;
  410. unsigned fsbr:1; /* URB wants FSBR */
  411. };
  412. /* Some special IDs */
  413. #define PCI_VENDOR_ID_GENESYS 0x17a0
  414. #define PCI_DEVICE_ID_GL880S_UHCI 0x8083
  415. /*
  416. * Functions used to access controller registers. The UCHI spec says that host
  417. * controller I/O registers are mapped into PCI I/O space. For non-PCI hosts
  418. * we use memory mapped registers.
  419. */
  420. #ifndef CONFIG_USB_UHCI_SUPPORT_NON_PCI_HC
  421. /* Support PCI only */
  422. static inline u32 uhci_readl(const struct uhci_hcd *uhci, int reg)
  423. {
  424. return inl(uhci->io_addr + reg);
  425. }
  426. static inline void uhci_writel(const struct uhci_hcd *uhci, u32 val, int reg)
  427. {
  428. outl(val, uhci->io_addr + reg);
  429. }
  430. static inline u16 uhci_readw(const struct uhci_hcd *uhci, int reg)
  431. {
  432. return inw(uhci->io_addr + reg);
  433. }
  434. static inline void uhci_writew(const struct uhci_hcd *uhci, u16 val, int reg)
  435. {
  436. outw(val, uhci->io_addr + reg);
  437. }
  438. static inline u8 uhci_readb(const struct uhci_hcd *uhci, int reg)
  439. {
  440. return inb(uhci->io_addr + reg);
  441. }
  442. static inline void uhci_writeb(const struct uhci_hcd *uhci, u8 val, int reg)
  443. {
  444. outb(val, uhci->io_addr + reg);
  445. }
  446. #else
  447. /* Support non-PCI host controllers */
  448. #ifdef CONFIG_PCI
  449. /* Support PCI and non-PCI host controllers */
  450. #define uhci_has_pci_registers(u) ((u)->io_addr != 0)
  451. #else
  452. /* Support non-PCI host controllers only */
  453. #define uhci_has_pci_registers(u) 0
  454. #endif
  455. #ifdef CONFIG_USB_UHCI_BIG_ENDIAN_MMIO
  456. /* Support (non-PCI) big endian host controllers */
  457. #define uhci_big_endian_mmio(u) ((u)->big_endian_mmio)
  458. #else
  459. #define uhci_big_endian_mmio(u) 0
  460. #endif
  461. static inline u32 uhci_readl(const struct uhci_hcd *uhci, int reg)
  462. {
  463. if (uhci_has_pci_registers(uhci))
  464. return inl(uhci->io_addr + reg);
  465. #ifdef CONFIG_USB_UHCI_BIG_ENDIAN_MMIO
  466. else if (uhci_big_endian_mmio(uhci))
  467. return readl_be(uhci->regs + reg);
  468. #endif
  469. else
  470. return readl(uhci->regs + reg);
  471. }
  472. static inline void uhci_writel(const struct uhci_hcd *uhci, u32 val, int reg)
  473. {
  474. if (uhci_has_pci_registers(uhci))
  475. outl(val, uhci->io_addr + reg);
  476. #ifdef CONFIG_USB_UHCI_BIG_ENDIAN_MMIO
  477. else if (uhci_big_endian_mmio(uhci))
  478. writel_be(val, uhci->regs + reg);
  479. #endif
  480. else
  481. writel(val, uhci->regs + reg);
  482. }
  483. static inline u16 uhci_readw(const struct uhci_hcd *uhci, int reg)
  484. {
  485. if (uhci_has_pci_registers(uhci))
  486. return inw(uhci->io_addr + reg);
  487. #ifdef CONFIG_USB_UHCI_BIG_ENDIAN_MMIO
  488. else if (uhci_big_endian_mmio(uhci))
  489. return readw_be(uhci->regs + reg);
  490. #endif
  491. else
  492. return readw(uhci->regs + reg);
  493. }
  494. static inline void uhci_writew(const struct uhci_hcd *uhci, u16 val, int reg)
  495. {
  496. if (uhci_has_pci_registers(uhci))
  497. outw(val, uhci->io_addr + reg);
  498. #ifdef CONFIG_USB_UHCI_BIG_ENDIAN_MMIO
  499. else if (uhci_big_endian_mmio(uhci))
  500. writew_be(val, uhci->regs + reg);
  501. #endif
  502. else
  503. writew(val, uhci->regs + reg);
  504. }
  505. static inline u8 uhci_readb(const struct uhci_hcd *uhci, int reg)
  506. {
  507. if (uhci_has_pci_registers(uhci))
  508. return inb(uhci->io_addr + reg);
  509. #ifdef CONFIG_USB_UHCI_BIG_ENDIAN_MMIO
  510. else if (uhci_big_endian_mmio(uhci))
  511. return readb_be(uhci->regs + reg);
  512. #endif
  513. else
  514. return readb(uhci->regs + reg);
  515. }
  516. static inline void uhci_writeb(const struct uhci_hcd *uhci, u8 val, int reg)
  517. {
  518. if (uhci_has_pci_registers(uhci))
  519. outb(val, uhci->io_addr + reg);
  520. #ifdef CONFIG_USB_UHCI_BIG_ENDIAN_MMIO
  521. else if (uhci_big_endian_mmio(uhci))
  522. writeb_be(val, uhci->regs + reg);
  523. #endif
  524. else
  525. writeb(val, uhci->regs + reg);
  526. }
  527. #endif /* CONFIG_USB_UHCI_SUPPORT_NON_PCI_HC */
  528. /*
  529. * The GRLIB GRUSBHC controller can use big endian format for its descriptors.
  530. *
  531. * UHCI controllers accessed through PCI work normally (little-endian
  532. * everywhere), so we don't bother supporting a BE-only mode.
  533. */
  534. #ifdef CONFIG_USB_UHCI_BIG_ENDIAN_DESC
  535. #define uhci_big_endian_desc(u) ((u)->big_endian_desc)
  536. /* cpu to uhci */
  537. static inline __hc32 cpu_to_hc32(const struct uhci_hcd *uhci, const u32 x)
  538. {
  539. return uhci_big_endian_desc(uhci)
  540. ? (__force __hc32)cpu_to_be32(x)
  541. : (__force __hc32)cpu_to_le32(x);
  542. }
  543. /* uhci to cpu */
  544. static inline u32 hc32_to_cpu(const struct uhci_hcd *uhci, const __hc32 x)
  545. {
  546. return uhci_big_endian_desc(uhci)
  547. ? be32_to_cpu((__force __be32)x)
  548. : le32_to_cpu((__force __le32)x);
  549. }
  550. #else
  551. /* cpu to uhci */
  552. static inline __hc32 cpu_to_hc32(const struct uhci_hcd *uhci, const u32 x)
  553. {
  554. return cpu_to_le32(x);
  555. }
  556. /* uhci to cpu */
  557. static inline u32 hc32_to_cpu(const struct uhci_hcd *uhci, const __hc32 x)
  558. {
  559. return le32_to_cpu(x);
  560. }
  561. #endif
  562. #endif