ehci-q.c 41 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466
  1. /*
  2. * Copyright (C) 2001-2004 by David Brownell
  3. *
  4. * This program is free software; you can redistribute it and/or modify it
  5. * under the terms of the GNU General Public License as published by the
  6. * Free Software Foundation; either version 2 of the License, or (at your
  7. * option) any later version.
  8. *
  9. * This program is distributed in the hope that it will be useful, but
  10. * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  11. * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  12. * for more details.
  13. *
  14. * You should have received a copy of the GNU General Public License
  15. * along with this program; if not, write to the Free Software Foundation,
  16. * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17. */
  18. /* this file is part of ehci-hcd.c */
  19. /*-------------------------------------------------------------------------*/
  20. /*
  21. * EHCI hardware queue manipulation ... the core. QH/QTD manipulation.
  22. *
  23. * Control, bulk, and interrupt traffic all use "qh" lists. They list "qtd"
  24. * entries describing USB transactions, max 16-20kB/entry (with 4kB-aligned
  25. * buffers needed for the larger number). We use one QH per endpoint, queue
  26. * multiple urbs (all three types) per endpoint. URBs may need several qtds.
  27. *
  28. * ISO traffic uses "ISO TD" (itd, and sitd) records, and (along with
  29. * interrupts) needs careful scheduling. Performance improvements can be
  30. * an ongoing challenge. That's in "ehci-sched.c".
  31. *
  32. * USB 1.1 devices are handled (a) by "companion" OHCI or UHCI root hubs,
  33. * or otherwise through transaction translators (TTs) in USB 2.0 hubs using
  34. * (b) special fields in qh entries or (c) split iso entries. TTs will
  35. * buffer low/full speed data so the host collects it at high speed.
  36. */
  37. /*-------------------------------------------------------------------------*/
  38. /* fill a qtd, returning how much of the buffer we were able to queue up */
  39. static int
  40. qtd_fill(struct ehci_hcd *ehci, struct ehci_qtd *qtd, dma_addr_t buf,
  41. size_t len, int token, int maxpacket)
  42. {
  43. int i, count;
  44. u64 addr = buf;
  45. /* one buffer entry per 4K ... first might be short or unaligned */
  46. qtd->hw_buf[0] = cpu_to_hc32(ehci, (u32)addr);
  47. qtd->hw_buf_hi[0] = cpu_to_hc32(ehci, (u32)(addr >> 32));
  48. count = 0x1000 - (buf & 0x0fff); /* rest of that page */
  49. if (likely (len < count)) /* ... iff needed */
  50. count = len;
  51. else {
  52. buf += 0x1000;
  53. buf &= ~0x0fff;
  54. /* per-qtd limit: from 16K to 20K (best alignment) */
  55. for (i = 1; count < len && i < 5; i++) {
  56. addr = buf;
  57. qtd->hw_buf[i] = cpu_to_hc32(ehci, (u32)addr);
  58. qtd->hw_buf_hi[i] = cpu_to_hc32(ehci,
  59. (u32)(addr >> 32));
  60. buf += 0x1000;
  61. if ((count + 0x1000) < len)
  62. count += 0x1000;
  63. else
  64. count = len;
  65. }
  66. /* short packets may only terminate transfers */
  67. if (count != len)
  68. count -= (count % maxpacket);
  69. }
  70. qtd->hw_token = cpu_to_hc32(ehci, (count << 16) | token);
  71. qtd->length = count;
  72. return count;
  73. }
  74. /*-------------------------------------------------------------------------*/
  75. static inline void
  76. qh_update (struct ehci_hcd *ehci, struct ehci_qh *qh, struct ehci_qtd *qtd)
  77. {
  78. struct ehci_qh_hw *hw = qh->hw;
  79. /* writes to an active overlay are unsafe */
  80. WARN_ON(qh->qh_state != QH_STATE_IDLE);
  81. hw->hw_qtd_next = QTD_NEXT(ehci, qtd->qtd_dma);
  82. hw->hw_alt_next = EHCI_LIST_END(ehci);
  83. /* Except for control endpoints, we make hardware maintain data
  84. * toggle (like OHCI) ... here (re)initialize the toggle in the QH,
  85. * and set the pseudo-toggle in udev. Only usb_clear_halt() will
  86. * ever clear it.
  87. */
  88. if (!(hw->hw_info1 & cpu_to_hc32(ehci, QH_TOGGLE_CTL))) {
  89. unsigned is_out, epnum;
  90. is_out = qh->is_out;
  91. epnum = (hc32_to_cpup(ehci, &hw->hw_info1) >> 8) & 0x0f;
  92. if (unlikely (!usb_gettoggle (qh->dev, epnum, is_out))) {
  93. hw->hw_token &= ~cpu_to_hc32(ehci, QTD_TOGGLE);
  94. usb_settoggle (qh->dev, epnum, is_out, 1);
  95. }
  96. }
  97. hw->hw_token &= cpu_to_hc32(ehci, QTD_TOGGLE | QTD_STS_PING);
  98. }
  99. /* if it weren't for a common silicon quirk (writing the dummy into the qh
  100. * overlay, so qh->hw_token wrongly becomes inactive/halted), only fault
  101. * recovery (including urb dequeue) would need software changes to a QH...
  102. */
  103. static void
  104. qh_refresh (struct ehci_hcd *ehci, struct ehci_qh *qh)
  105. {
  106. struct ehci_qtd *qtd;
  107. qtd = list_entry(qh->qtd_list.next, struct ehci_qtd, qtd_list);
  108. /*
  109. * first qtd may already be partially processed.
  110. * If we come here during unlink, the QH overlay region
  111. * might have reference to the just unlinked qtd. The
  112. * qtd is updated in qh_completions(). Update the QH
  113. * overlay here.
  114. */
  115. if (qh->hw->hw_token & ACTIVE_BIT(ehci))
  116. qh->hw->hw_qtd_next = qtd->hw_next;
  117. else
  118. qh_update(ehci, qh, qtd);
  119. }
  120. /*-------------------------------------------------------------------------*/
  121. static void qh_link_async(struct ehci_hcd *ehci, struct ehci_qh *qh);
  122. static void ehci_clear_tt_buffer_complete(struct usb_hcd *hcd,
  123. struct usb_host_endpoint *ep)
  124. {
  125. struct ehci_hcd *ehci = hcd_to_ehci(hcd);
  126. struct ehci_qh *qh = ep->hcpriv;
  127. unsigned long flags;
  128. spin_lock_irqsave(&ehci->lock, flags);
  129. qh->clearing_tt = 0;
  130. if (qh->qh_state == QH_STATE_IDLE && !list_empty(&qh->qtd_list)
  131. && ehci->rh_state == EHCI_RH_RUNNING)
  132. qh_link_async(ehci, qh);
  133. spin_unlock_irqrestore(&ehci->lock, flags);
  134. }
  135. static void ehci_clear_tt_buffer(struct ehci_hcd *ehci, struct ehci_qh *qh,
  136. struct urb *urb, u32 token)
  137. {
  138. /* If an async split transaction gets an error or is unlinked,
  139. * the TT buffer may be left in an indeterminate state. We
  140. * have to clear the TT buffer.
  141. *
  142. * Note: this routine is never called for Isochronous transfers.
  143. */
  144. if (urb->dev->tt && !usb_pipeint(urb->pipe) && !qh->clearing_tt) {
  145. #ifdef DEBUG
  146. struct usb_device *tt = urb->dev->tt->hub;
  147. dev_dbg(&tt->dev,
  148. "clear tt buffer port %d, a%d ep%d t%08x\n",
  149. urb->dev->ttport, urb->dev->devnum,
  150. usb_pipeendpoint(urb->pipe), token);
  151. #endif /* DEBUG */
  152. if (!ehci_is_TDI(ehci)
  153. || urb->dev->tt->hub !=
  154. ehci_to_hcd(ehci)->self.root_hub) {
  155. if (usb_hub_clear_tt_buffer(urb) == 0)
  156. qh->clearing_tt = 1;
  157. } else {
  158. /* REVISIT ARC-derived cores don't clear the root
  159. * hub TT buffer in this way...
  160. */
  161. }
  162. }
  163. }
  164. static int qtd_copy_status (
  165. struct ehci_hcd *ehci,
  166. struct urb *urb,
  167. size_t length,
  168. u32 token
  169. )
  170. {
  171. int status = -EINPROGRESS;
  172. /* count IN/OUT bytes, not SETUP (even short packets) */
  173. if (likely (QTD_PID (token) != 2))
  174. urb->actual_length += length - QTD_LENGTH (token);
  175. /* don't modify error codes */
  176. if (unlikely(urb->unlinked))
  177. return status;
  178. /* force cleanup after short read; not always an error */
  179. if (unlikely (IS_SHORT_READ (token)))
  180. status = -EREMOTEIO;
  181. /* serious "can't proceed" faults reported by the hardware */
  182. if (token & QTD_STS_HALT) {
  183. if (token & QTD_STS_BABBLE) {
  184. /* FIXME "must" disable babbling device's port too */
  185. status = -EOVERFLOW;
  186. /* CERR nonzero + halt --> stall */
  187. } else if (QTD_CERR(token)) {
  188. status = -EPIPE;
  189. /* In theory, more than one of the following bits can be set
  190. * since they are sticky and the transaction is retried.
  191. * Which to test first is rather arbitrary.
  192. */
  193. } else if (token & QTD_STS_MMF) {
  194. /* fs/ls interrupt xfer missed the complete-split */
  195. status = -EPROTO;
  196. } else if (token & QTD_STS_DBE) {
  197. status = (QTD_PID (token) == 1) /* IN ? */
  198. ? -ENOSR /* hc couldn't read data */
  199. : -ECOMM; /* hc couldn't write data */
  200. } else if (token & QTD_STS_XACT) {
  201. /* timeout, bad CRC, wrong PID, etc */
  202. ehci_dbg(ehci, "devpath %s ep%d%s 3strikes\n",
  203. urb->dev->devpath,
  204. usb_pipeendpoint(urb->pipe),
  205. usb_pipein(urb->pipe) ? "in" : "out");
  206. status = -EPROTO;
  207. } else { /* unknown */
  208. status = -EPROTO;
  209. }
  210. ehci_vdbg (ehci,
  211. "dev%d ep%d%s qtd token %08x --> status %d\n",
  212. usb_pipedevice (urb->pipe),
  213. usb_pipeendpoint (urb->pipe),
  214. usb_pipein (urb->pipe) ? "in" : "out",
  215. token, status);
  216. }
  217. return status;
  218. }
  219. static void
  220. ehci_urb_done(struct ehci_hcd *ehci, struct urb *urb, int status)
  221. {
  222. if (usb_pipetype(urb->pipe) == PIPE_INTERRUPT) {
  223. /* ... update hc-wide periodic stats */
  224. ehci_to_hcd(ehci)->self.bandwidth_int_reqs--;
  225. }
  226. if (unlikely(urb->unlinked)) {
  227. COUNT(ehci->stats.unlink);
  228. } else {
  229. /* report non-error and short read status as zero */
  230. if (status == -EINPROGRESS || status == -EREMOTEIO)
  231. status = 0;
  232. COUNT(ehci->stats.complete);
  233. }
  234. #ifdef EHCI_URB_TRACE
  235. ehci_dbg (ehci,
  236. "%s %s urb %p ep%d%s status %d len %d/%d\n",
  237. __func__, urb->dev->devpath, urb,
  238. usb_pipeendpoint (urb->pipe),
  239. usb_pipein (urb->pipe) ? "in" : "out",
  240. status,
  241. urb->actual_length, urb->transfer_buffer_length);
  242. #endif
  243. usb_hcd_unlink_urb_from_ep(ehci_to_hcd(ehci), urb);
  244. usb_hcd_giveback_urb(ehci_to_hcd(ehci), urb, status);
  245. }
  246. static int qh_schedule (struct ehci_hcd *ehci, struct ehci_qh *qh);
  247. /*
  248. * Process and free completed qtds for a qh, returning URBs to drivers.
  249. * Chases up to qh->hw_current. Returns nonzero if the caller should
  250. * unlink qh.
  251. */
  252. static unsigned
  253. qh_completions (struct ehci_hcd *ehci, struct ehci_qh *qh)
  254. {
  255. struct ehci_qtd *last, *end = qh->dummy;
  256. struct list_head *entry, *tmp;
  257. int last_status;
  258. int stopped;
  259. u8 state;
  260. struct ehci_qh_hw *hw = qh->hw;
  261. /* completions (or tasks on other cpus) must never clobber HALT
  262. * till we've gone through and cleaned everything up, even when
  263. * they add urbs to this qh's queue or mark them for unlinking.
  264. *
  265. * NOTE: unlinking expects to be done in queue order.
  266. *
  267. * It's a bug for qh->qh_state to be anything other than
  268. * QH_STATE_IDLE, unless our caller is scan_async() or
  269. * scan_intr().
  270. */
  271. state = qh->qh_state;
  272. qh->qh_state = QH_STATE_COMPLETING;
  273. stopped = (state == QH_STATE_IDLE);
  274. rescan:
  275. last = NULL;
  276. last_status = -EINPROGRESS;
  277. qh->dequeue_during_giveback = 0;
  278. /* remove de-activated QTDs from front of queue.
  279. * after faults (including short reads), cleanup this urb
  280. * then let the queue advance.
  281. * if queue is stopped, handles unlinks.
  282. */
  283. list_for_each_safe (entry, tmp, &qh->qtd_list) {
  284. struct ehci_qtd *qtd;
  285. struct urb *urb;
  286. u32 token = 0;
  287. qtd = list_entry (entry, struct ehci_qtd, qtd_list);
  288. urb = qtd->urb;
  289. /* clean up any state from previous QTD ...*/
  290. if (last) {
  291. if (likely (last->urb != urb)) {
  292. ehci_urb_done(ehci, last->urb, last_status);
  293. last_status = -EINPROGRESS;
  294. }
  295. ehci_qtd_free (ehci, last);
  296. last = NULL;
  297. }
  298. /* ignore urbs submitted during completions we reported */
  299. if (qtd == end)
  300. break;
  301. /* hardware copies qtd out of qh overlay */
  302. rmb ();
  303. token = hc32_to_cpu(ehci, qtd->hw_token);
  304. /* always clean up qtds the hc de-activated */
  305. retry_xacterr:
  306. if ((token & QTD_STS_ACTIVE) == 0) {
  307. /* Report Data Buffer Error: non-fatal but useful */
  308. if (token & QTD_STS_DBE)
  309. ehci_dbg(ehci,
  310. "detected DataBufferErr for urb %p ep%d%s len %d, qtd %p [qh %p]\n",
  311. urb,
  312. usb_endpoint_num(&urb->ep->desc),
  313. usb_endpoint_dir_in(&urb->ep->desc) ? "in" : "out",
  314. urb->transfer_buffer_length,
  315. qtd,
  316. qh);
  317. /* on STALL, error, and short reads this urb must
  318. * complete and all its qtds must be recycled.
  319. */
  320. if ((token & QTD_STS_HALT) != 0) {
  321. /* retry transaction errors until we
  322. * reach the software xacterr limit
  323. */
  324. if ((token & QTD_STS_XACT) &&
  325. QTD_CERR(token) == 0 &&
  326. ++qh->xacterrs < QH_XACTERR_MAX &&
  327. !urb->unlinked) {
  328. ehci_dbg(ehci,
  329. "detected XactErr len %zu/%zu retry %d\n",
  330. qtd->length - QTD_LENGTH(token), qtd->length, qh->xacterrs);
  331. /* reset the token in the qtd and the
  332. * qh overlay (which still contains
  333. * the qtd) so that we pick up from
  334. * where we left off
  335. */
  336. token &= ~QTD_STS_HALT;
  337. token |= QTD_STS_ACTIVE |
  338. (EHCI_TUNE_CERR << 10);
  339. qtd->hw_token = cpu_to_hc32(ehci,
  340. token);
  341. wmb();
  342. hw->hw_token = cpu_to_hc32(ehci,
  343. token);
  344. goto retry_xacterr;
  345. }
  346. stopped = 1;
  347. /* magic dummy for some short reads; qh won't advance.
  348. * that silicon quirk can kick in with this dummy too.
  349. *
  350. * other short reads won't stop the queue, including
  351. * control transfers (status stage handles that) or
  352. * most other single-qtd reads ... the queue stops if
  353. * URB_SHORT_NOT_OK was set so the driver submitting
  354. * the urbs could clean it up.
  355. */
  356. } else if (IS_SHORT_READ (token)
  357. && !(qtd->hw_alt_next
  358. & EHCI_LIST_END(ehci))) {
  359. stopped = 1;
  360. }
  361. /* stop scanning when we reach qtds the hc is using */
  362. } else if (likely (!stopped
  363. && ehci->rh_state >= EHCI_RH_RUNNING)) {
  364. break;
  365. /* scan the whole queue for unlinks whenever it stops */
  366. } else {
  367. stopped = 1;
  368. /* cancel everything if we halt, suspend, etc */
  369. if (ehci->rh_state < EHCI_RH_RUNNING)
  370. last_status = -ESHUTDOWN;
  371. /* this qtd is active; skip it unless a previous qtd
  372. * for its urb faulted, or its urb was canceled.
  373. */
  374. else if (last_status == -EINPROGRESS && !urb->unlinked)
  375. continue;
  376. /*
  377. * If this was the active qtd when the qh was unlinked
  378. * and the overlay's token is active, then the overlay
  379. * hasn't been written back to the qtd yet so use its
  380. * token instead of the qtd's. After the qtd is
  381. * processed and removed, the overlay won't be valid
  382. * any more.
  383. */
  384. if (state == QH_STATE_IDLE &&
  385. qh->qtd_list.next == &qtd->qtd_list &&
  386. (hw->hw_token & ACTIVE_BIT(ehci))) {
  387. token = hc32_to_cpu(ehci, hw->hw_token);
  388. hw->hw_token &= ~ACTIVE_BIT(ehci);
  389. /* An unlink may leave an incomplete
  390. * async transaction in the TT buffer.
  391. * We have to clear it.
  392. */
  393. ehci_clear_tt_buffer(ehci, qh, urb, token);
  394. }
  395. }
  396. /* unless we already know the urb's status, collect qtd status
  397. * and update count of bytes transferred. in common short read
  398. * cases with only one data qtd (including control transfers),
  399. * queue processing won't halt. but with two or more qtds (for
  400. * example, with a 32 KB transfer), when the first qtd gets a
  401. * short read the second must be removed by hand.
  402. */
  403. if (last_status == -EINPROGRESS) {
  404. last_status = qtd_copy_status(ehci, urb,
  405. qtd->length, token);
  406. if (last_status == -EREMOTEIO
  407. && (qtd->hw_alt_next
  408. & EHCI_LIST_END(ehci)))
  409. last_status = -EINPROGRESS;
  410. /* As part of low/full-speed endpoint-halt processing
  411. * we must clear the TT buffer (11.17.5).
  412. */
  413. if (unlikely(last_status != -EINPROGRESS &&
  414. last_status != -EREMOTEIO)) {
  415. /* The TT's in some hubs malfunction when they
  416. * receive this request following a STALL (they
  417. * stop sending isochronous packets). Since a
  418. * STALL can't leave the TT buffer in a busy
  419. * state (if you believe Figures 11-48 - 11-51
  420. * in the USB 2.0 spec), we won't clear the TT
  421. * buffer in this case. Strictly speaking this
  422. * is a violation of the spec.
  423. */
  424. if (last_status != -EPIPE)
  425. ehci_clear_tt_buffer(ehci, qh, urb,
  426. token);
  427. }
  428. }
  429. /* if we're removing something not at the queue head,
  430. * patch the hardware queue pointer.
  431. */
  432. if (stopped && qtd->qtd_list.prev != &qh->qtd_list) {
  433. last = list_entry (qtd->qtd_list.prev,
  434. struct ehci_qtd, qtd_list);
  435. last->hw_next = qtd->hw_next;
  436. }
  437. /* remove qtd; it's recycled after possible urb completion */
  438. list_del (&qtd->qtd_list);
  439. last = qtd;
  440. /* reinit the xacterr counter for the next qtd */
  441. qh->xacterrs = 0;
  442. }
  443. /* last urb's completion might still need calling */
  444. if (likely (last != NULL)) {
  445. ehci_urb_done(ehci, last->urb, last_status);
  446. ehci_qtd_free (ehci, last);
  447. }
  448. /* Do we need to rescan for URBs dequeued during a giveback? */
  449. if (unlikely(qh->dequeue_during_giveback)) {
  450. /* If the QH is already unlinked, do the rescan now. */
  451. if (state == QH_STATE_IDLE)
  452. goto rescan;
  453. /* Otherwise the caller must unlink the QH. */
  454. }
  455. /* restore original state; caller must unlink or relink */
  456. qh->qh_state = state;
  457. /* be sure the hardware's done with the qh before refreshing
  458. * it after fault cleanup, or recovering from silicon wrongly
  459. * overlaying the dummy qtd (which reduces DMA chatter).
  460. *
  461. * We won't refresh a QH that's linked (after the HC
  462. * stopped the queue). That avoids a race:
  463. * - HC reads first part of QH;
  464. * - CPU updates that first part and the token;
  465. * - HC reads rest of that QH, including token
  466. * Result: HC gets an inconsistent image, and then
  467. * DMAs to/from the wrong memory (corrupting it).
  468. *
  469. * That should be rare for interrupt transfers,
  470. * except maybe high bandwidth ...
  471. */
  472. if (stopped != 0 || hw->hw_qtd_next == EHCI_LIST_END(ehci))
  473. qh->exception = 1;
  474. /* Let the caller know if the QH needs to be unlinked. */
  475. return qh->exception;
  476. }
  477. /*-------------------------------------------------------------------------*/
  478. // high bandwidth multiplier, as encoded in highspeed endpoint descriptors
  479. #define hb_mult(wMaxPacketSize) (1 + (((wMaxPacketSize) >> 11) & 0x03))
  480. // ... and packet size, for any kind of endpoint descriptor
  481. #define max_packet(wMaxPacketSize) ((wMaxPacketSize) & 0x07ff)
  482. /*
  483. * reverse of qh_urb_transaction: free a list of TDs.
  484. * used for cleanup after errors, before HC sees an URB's TDs.
  485. */
  486. static void qtd_list_free (
  487. struct ehci_hcd *ehci,
  488. struct urb *urb,
  489. struct list_head *qtd_list
  490. ) {
  491. struct list_head *entry, *temp;
  492. list_for_each_safe (entry, temp, qtd_list) {
  493. struct ehci_qtd *qtd;
  494. qtd = list_entry (entry, struct ehci_qtd, qtd_list);
  495. list_del (&qtd->qtd_list);
  496. ehci_qtd_free (ehci, qtd);
  497. }
  498. }
  499. /*
  500. * create a list of filled qtds for this URB; won't link into qh.
  501. */
  502. static struct list_head *
  503. qh_urb_transaction (
  504. struct ehci_hcd *ehci,
  505. struct urb *urb,
  506. struct list_head *head,
  507. gfp_t flags
  508. ) {
  509. struct ehci_qtd *qtd, *qtd_prev;
  510. dma_addr_t buf;
  511. int len, this_sg_len, maxpacket;
  512. int is_input;
  513. u32 token;
  514. int i;
  515. struct scatterlist *sg;
  516. /*
  517. * URBs map to sequences of QTDs: one logical transaction
  518. */
  519. qtd = ehci_qtd_alloc (ehci, flags);
  520. if (unlikely (!qtd))
  521. return NULL;
  522. list_add_tail (&qtd->qtd_list, head);
  523. qtd->urb = urb;
  524. token = QTD_STS_ACTIVE;
  525. token |= (EHCI_TUNE_CERR << 10);
  526. /* for split transactions, SplitXState initialized to zero */
  527. len = urb->transfer_buffer_length;
  528. is_input = usb_pipein (urb->pipe);
  529. if (usb_pipecontrol (urb->pipe)) {
  530. /* SETUP pid */
  531. qtd_fill(ehci, qtd, urb->setup_dma,
  532. sizeof (struct usb_ctrlrequest),
  533. token | (2 /* "setup" */ << 8), 8);
  534. /* ... and always at least one more pid */
  535. token ^= QTD_TOGGLE;
  536. qtd_prev = qtd;
  537. qtd = ehci_qtd_alloc (ehci, flags);
  538. if (unlikely (!qtd))
  539. goto cleanup;
  540. qtd->urb = urb;
  541. qtd_prev->hw_next = QTD_NEXT(ehci, qtd->qtd_dma);
  542. list_add_tail (&qtd->qtd_list, head);
  543. /* for zero length DATA stages, STATUS is always IN */
  544. if (len == 0)
  545. token |= (1 /* "in" */ << 8);
  546. }
  547. /*
  548. * data transfer stage: buffer setup
  549. */
  550. i = urb->num_mapped_sgs;
  551. if (len > 0 && i > 0) {
  552. sg = urb->sg;
  553. buf = sg_dma_address(sg);
  554. /* urb->transfer_buffer_length may be smaller than the
  555. * size of the scatterlist (or vice versa)
  556. */
  557. this_sg_len = min_t(int, sg_dma_len(sg), len);
  558. } else {
  559. sg = NULL;
  560. buf = urb->transfer_dma;
  561. this_sg_len = len;
  562. }
  563. if (is_input)
  564. token |= (1 /* "in" */ << 8);
  565. /* else it's already initted to "out" pid (0 << 8) */
  566. maxpacket = max_packet(usb_maxpacket(urb->dev, urb->pipe, !is_input));
  567. /*
  568. * buffer gets wrapped in one or more qtds;
  569. * last one may be "short" (including zero len)
  570. * and may serve as a control status ack
  571. */
  572. for (;;) {
  573. int this_qtd_len;
  574. this_qtd_len = qtd_fill(ehci, qtd, buf, this_sg_len, token,
  575. maxpacket);
  576. this_sg_len -= this_qtd_len;
  577. len -= this_qtd_len;
  578. buf += this_qtd_len;
  579. /*
  580. * short reads advance to a "magic" dummy instead of the next
  581. * qtd ... that forces the queue to stop, for manual cleanup.
  582. * (this will usually be overridden later.)
  583. */
  584. if (is_input)
  585. qtd->hw_alt_next = ehci->async->hw->hw_alt_next;
  586. /* qh makes control packets use qtd toggle; maybe switch it */
  587. if ((maxpacket & (this_qtd_len + (maxpacket - 1))) == 0)
  588. token ^= QTD_TOGGLE;
  589. if (likely(this_sg_len <= 0)) {
  590. if (--i <= 0 || len <= 0)
  591. break;
  592. sg = sg_next(sg);
  593. buf = sg_dma_address(sg);
  594. this_sg_len = min_t(int, sg_dma_len(sg), len);
  595. }
  596. qtd_prev = qtd;
  597. qtd = ehci_qtd_alloc (ehci, flags);
  598. if (unlikely (!qtd))
  599. goto cleanup;
  600. qtd->urb = urb;
  601. qtd_prev->hw_next = QTD_NEXT(ehci, qtd->qtd_dma);
  602. list_add_tail (&qtd->qtd_list, head);
  603. }
  604. /*
  605. * unless the caller requires manual cleanup after short reads,
  606. * have the alt_next mechanism keep the queue running after the
  607. * last data qtd (the only one, for control and most other cases).
  608. */
  609. if (likely ((urb->transfer_flags & URB_SHORT_NOT_OK) == 0
  610. || usb_pipecontrol (urb->pipe)))
  611. qtd->hw_alt_next = EHCI_LIST_END(ehci);
  612. /*
  613. * control requests may need a terminating data "status" ack;
  614. * other OUT ones may need a terminating short packet
  615. * (zero length).
  616. */
  617. if (likely (urb->transfer_buffer_length != 0)) {
  618. int one_more = 0;
  619. if (usb_pipecontrol (urb->pipe)) {
  620. one_more = 1;
  621. token ^= 0x0100; /* "in" <--> "out" */
  622. token |= QTD_TOGGLE; /* force DATA1 */
  623. } else if (usb_pipeout(urb->pipe)
  624. && (urb->transfer_flags & URB_ZERO_PACKET)
  625. && !(urb->transfer_buffer_length % maxpacket)) {
  626. one_more = 1;
  627. }
  628. if (one_more) {
  629. qtd_prev = qtd;
  630. qtd = ehci_qtd_alloc (ehci, flags);
  631. if (unlikely (!qtd))
  632. goto cleanup;
  633. qtd->urb = urb;
  634. qtd_prev->hw_next = QTD_NEXT(ehci, qtd->qtd_dma);
  635. list_add_tail (&qtd->qtd_list, head);
  636. /* never any data in such packets */
  637. qtd_fill(ehci, qtd, 0, 0, token, 0);
  638. }
  639. }
  640. /* by default, enable interrupt on urb completion */
  641. if (likely (!(urb->transfer_flags & URB_NO_INTERRUPT)))
  642. qtd->hw_token |= cpu_to_hc32(ehci, QTD_IOC);
  643. return head;
  644. cleanup:
  645. qtd_list_free (ehci, urb, head);
  646. return NULL;
  647. }
  648. /*-------------------------------------------------------------------------*/
  649. // Would be best to create all qh's from config descriptors,
  650. // when each interface/altsetting is established. Unlink
  651. // any previous qh and cancel its urbs first; endpoints are
  652. // implicitly reset then (data toggle too).
  653. // That'd mean updating how usbcore talks to HCDs. (2.7?)
  654. /*
  655. * Each QH holds a qtd list; a QH is used for everything except iso.
  656. *
  657. * For interrupt urbs, the scheduler must set the microframe scheduling
  658. * mask(s) each time the QH gets scheduled. For highspeed, that's
  659. * just one microframe in the s-mask. For split interrupt transactions
  660. * there are additional complications: c-mask, maybe FSTNs.
  661. */
  662. static struct ehci_qh *
  663. qh_make (
  664. struct ehci_hcd *ehci,
  665. struct urb *urb,
  666. gfp_t flags
  667. ) {
  668. struct ehci_qh *qh = ehci_qh_alloc (ehci, flags);
  669. u32 info1 = 0, info2 = 0;
  670. int is_input, type;
  671. int maxp = 0;
  672. struct usb_tt *tt = urb->dev->tt;
  673. struct ehci_qh_hw *hw;
  674. if (!qh)
  675. return qh;
  676. /*
  677. * init endpoint/device data for this QH
  678. */
  679. info1 |= usb_pipeendpoint (urb->pipe) << 8;
  680. info1 |= usb_pipedevice (urb->pipe) << 0;
  681. is_input = usb_pipein (urb->pipe);
  682. type = usb_pipetype (urb->pipe);
  683. maxp = usb_maxpacket (urb->dev, urb->pipe, !is_input);
  684. /* 1024 byte maxpacket is a hardware ceiling. High bandwidth
  685. * acts like up to 3KB, but is built from smaller packets.
  686. */
  687. if (max_packet(maxp) > 1024) {
  688. ehci_dbg(ehci, "bogus qh maxpacket %d\n", max_packet(maxp));
  689. goto done;
  690. }
  691. /* Compute interrupt scheduling parameters just once, and save.
  692. * - allowing for high bandwidth, how many nsec/uframe are used?
  693. * - split transactions need a second CSPLIT uframe; same question
  694. * - splits also need a schedule gap (for full/low speed I/O)
  695. * - qh has a polling interval
  696. *
  697. * For control/bulk requests, the HC or TT handles these.
  698. */
  699. if (type == PIPE_INTERRUPT) {
  700. qh->usecs = NS_TO_US(usb_calc_bus_time(USB_SPEED_HIGH,
  701. is_input, 0,
  702. hb_mult(maxp) * max_packet(maxp)));
  703. qh->start = NO_FRAME;
  704. if (urb->dev->speed == USB_SPEED_HIGH) {
  705. qh->c_usecs = 0;
  706. qh->gap_uf = 0;
  707. qh->period = urb->interval >> 3;
  708. if (qh->period == 0 && urb->interval != 1) {
  709. /* NOTE interval 2 or 4 uframes could work.
  710. * But interval 1 scheduling is simpler, and
  711. * includes high bandwidth.
  712. */
  713. urb->interval = 1;
  714. } else if (qh->period > ehci->periodic_size) {
  715. qh->period = ehci->periodic_size;
  716. urb->interval = qh->period << 3;
  717. }
  718. } else {
  719. int think_time;
  720. /* gap is f(FS/LS transfer times) */
  721. qh->gap_uf = 1 + usb_calc_bus_time (urb->dev->speed,
  722. is_input, 0, maxp) / (125 * 1000);
  723. /* FIXME this just approximates SPLIT/CSPLIT times */
  724. if (is_input) { // SPLIT, gap, CSPLIT+DATA
  725. qh->c_usecs = qh->usecs + HS_USECS (0);
  726. qh->usecs = HS_USECS (1);
  727. } else { // SPLIT+DATA, gap, CSPLIT
  728. qh->usecs += HS_USECS (1);
  729. qh->c_usecs = HS_USECS (0);
  730. }
  731. think_time = tt ? tt->think_time : 0;
  732. qh->tt_usecs = NS_TO_US (think_time +
  733. usb_calc_bus_time (urb->dev->speed,
  734. is_input, 0, max_packet (maxp)));
  735. qh->period = urb->interval;
  736. if (qh->period > ehci->periodic_size) {
  737. qh->period = ehci->periodic_size;
  738. urb->interval = qh->period;
  739. }
  740. }
  741. }
  742. /* support for tt scheduling, and access to toggles */
  743. qh->dev = urb->dev;
  744. /* using TT? */
  745. switch (urb->dev->speed) {
  746. case USB_SPEED_LOW:
  747. info1 |= QH_LOW_SPEED;
  748. /* FALL THROUGH */
  749. case USB_SPEED_FULL:
  750. /* EPS 0 means "full" */
  751. if (type != PIPE_INTERRUPT)
  752. info1 |= (EHCI_TUNE_RL_TT << 28);
  753. if (type == PIPE_CONTROL) {
  754. info1 |= QH_CONTROL_EP; /* for TT */
  755. info1 |= QH_TOGGLE_CTL; /* toggle from qtd */
  756. }
  757. info1 |= maxp << 16;
  758. info2 |= (EHCI_TUNE_MULT_TT << 30);
  759. /* Some Freescale processors have an erratum in which the
  760. * port number in the queue head was 0..N-1 instead of 1..N.
  761. */
  762. if (ehci_has_fsl_portno_bug(ehci))
  763. info2 |= (urb->dev->ttport-1) << 23;
  764. else
  765. info2 |= urb->dev->ttport << 23;
  766. /* set the address of the TT; for TDI's integrated
  767. * root hub tt, leave it zeroed.
  768. */
  769. if (tt && tt->hub != ehci_to_hcd(ehci)->self.root_hub)
  770. info2 |= tt->hub->devnum << 16;
  771. /* NOTE: if (PIPE_INTERRUPT) { scheduler sets c-mask } */
  772. break;
  773. case USB_SPEED_HIGH: /* no TT involved */
  774. info1 |= QH_HIGH_SPEED;
  775. if (type == PIPE_CONTROL) {
  776. info1 |= (EHCI_TUNE_RL_HS << 28);
  777. info1 |= 64 << 16; /* usb2 fixed maxpacket */
  778. info1 |= QH_TOGGLE_CTL; /* toggle from qtd */
  779. info2 |= (EHCI_TUNE_MULT_HS << 30);
  780. } else if (type == PIPE_BULK) {
  781. info1 |= (EHCI_TUNE_RL_HS << 28);
  782. /* The USB spec says that high speed bulk endpoints
  783. * always use 512 byte maxpacket. But some device
  784. * vendors decided to ignore that, and MSFT is happy
  785. * to help them do so. So now people expect to use
  786. * such nonconformant devices with Linux too; sigh.
  787. */
  788. info1 |= max_packet(maxp) << 16;
  789. info2 |= (EHCI_TUNE_MULT_HS << 30);
  790. } else { /* PIPE_INTERRUPT */
  791. info1 |= max_packet (maxp) << 16;
  792. info2 |= hb_mult (maxp) << 30;
  793. }
  794. break;
  795. default:
  796. ehci_dbg(ehci, "bogus dev %p speed %d\n", urb->dev,
  797. urb->dev->speed);
  798. done:
  799. qh_destroy(ehci, qh);
  800. return NULL;
  801. }
  802. /* NOTE: if (PIPE_INTERRUPT) { scheduler sets s-mask } */
  803. /* init as live, toggle clear */
  804. qh->qh_state = QH_STATE_IDLE;
  805. hw = qh->hw;
  806. hw->hw_info1 = cpu_to_hc32(ehci, info1);
  807. hw->hw_info2 = cpu_to_hc32(ehci, info2);
  808. qh->is_out = !is_input;
  809. usb_settoggle (urb->dev, usb_pipeendpoint (urb->pipe), !is_input, 1);
  810. return qh;
  811. }
  812. /*-------------------------------------------------------------------------*/
  813. static void enable_async(struct ehci_hcd *ehci)
  814. {
  815. if (ehci->async_count++)
  816. return;
  817. /* Stop waiting to turn off the async schedule */
  818. ehci->enabled_hrtimer_events &= ~BIT(EHCI_HRTIMER_DISABLE_ASYNC);
  819. /* Don't start the schedule until ASS is 0 */
  820. ehci_poll_ASS(ehci);
  821. turn_on_io_watchdog(ehci);
  822. }
  823. static void disable_async(struct ehci_hcd *ehci)
  824. {
  825. if (--ehci->async_count)
  826. return;
  827. /* The async schedule and unlink lists are supposed to be empty */
  828. WARN_ON(ehci->async->qh_next.qh || !list_empty(&ehci->async_unlink) ||
  829. !list_empty(&ehci->async_idle));
  830. /* Don't turn off the schedule until ASS is 1 */
  831. ehci_poll_ASS(ehci);
  832. }
  833. /* move qh (and its qtds) onto async queue; maybe enable queue. */
  834. static void qh_link_async (struct ehci_hcd *ehci, struct ehci_qh *qh)
  835. {
  836. __hc32 dma = QH_NEXT(ehci, qh->qh_dma);
  837. struct ehci_qh *head;
  838. /* Don't link a QH if there's a Clear-TT-Buffer pending */
  839. if (unlikely(qh->clearing_tt))
  840. return;
  841. WARN_ON(qh->qh_state != QH_STATE_IDLE);
  842. /* clear halt and/or toggle; and maybe recover from silicon quirk */
  843. qh_refresh(ehci, qh);
  844. /* splice right after start */
  845. head = ehci->async;
  846. qh->qh_next = head->qh_next;
  847. qh->hw->hw_next = head->hw->hw_next;
  848. wmb ();
  849. head->qh_next.qh = qh;
  850. head->hw->hw_next = dma;
  851. qh->qh_state = QH_STATE_LINKED;
  852. qh->xacterrs = 0;
  853. qh->exception = 0;
  854. /* qtd completions reported later by interrupt */
  855. enable_async(ehci);
  856. }
  857. /*-------------------------------------------------------------------------*/
  858. /*
  859. * For control/bulk/interrupt, return QH with these TDs appended.
  860. * Allocates and initializes the QH if necessary.
  861. * Returns null if it can't allocate a QH it needs to.
  862. * If the QH has TDs (urbs) already, that's great.
  863. */
  864. static struct ehci_qh *qh_append_tds (
  865. struct ehci_hcd *ehci,
  866. struct urb *urb,
  867. struct list_head *qtd_list,
  868. int epnum,
  869. void **ptr
  870. )
  871. {
  872. struct ehci_qh *qh = NULL;
  873. __hc32 qh_addr_mask = cpu_to_hc32(ehci, 0x7f);
  874. qh = (struct ehci_qh *) *ptr;
  875. if (unlikely (qh == NULL)) {
  876. /* can't sleep here, we have ehci->lock... */
  877. qh = qh_make (ehci, urb, GFP_ATOMIC);
  878. *ptr = qh;
  879. }
  880. if (likely (qh != NULL)) {
  881. struct ehci_qtd *qtd;
  882. if (unlikely (list_empty (qtd_list)))
  883. qtd = NULL;
  884. else
  885. qtd = list_entry (qtd_list->next, struct ehci_qtd,
  886. qtd_list);
  887. /* control qh may need patching ... */
  888. if (unlikely (epnum == 0)) {
  889. /* usb_reset_device() briefly reverts to address 0 */
  890. if (usb_pipedevice (urb->pipe) == 0)
  891. qh->hw->hw_info1 &= ~qh_addr_mask;
  892. }
  893. /* just one way to queue requests: swap with the dummy qtd.
  894. * only hc or qh_refresh() ever modify the overlay.
  895. */
  896. if (likely (qtd != NULL)) {
  897. struct ehci_qtd *dummy;
  898. dma_addr_t dma;
  899. __hc32 token;
  900. /* to avoid racing the HC, use the dummy td instead of
  901. * the first td of our list (becomes new dummy). both
  902. * tds stay deactivated until we're done, when the
  903. * HC is allowed to fetch the old dummy (4.10.2).
  904. */
  905. token = qtd->hw_token;
  906. qtd->hw_token = HALT_BIT(ehci);
  907. dummy = qh->dummy;
  908. dma = dummy->qtd_dma;
  909. *dummy = *qtd;
  910. dummy->qtd_dma = dma;
  911. list_del (&qtd->qtd_list);
  912. list_add (&dummy->qtd_list, qtd_list);
  913. list_splice_tail(qtd_list, &qh->qtd_list);
  914. ehci_qtd_init(ehci, qtd, qtd->qtd_dma);
  915. qh->dummy = qtd;
  916. /* hc must see the new dummy at list end */
  917. dma = qtd->qtd_dma;
  918. qtd = list_entry (qh->qtd_list.prev,
  919. struct ehci_qtd, qtd_list);
  920. qtd->hw_next = QTD_NEXT(ehci, dma);
  921. /* let the hc process these next qtds */
  922. wmb ();
  923. dummy->hw_token = token;
  924. urb->hcpriv = qh;
  925. }
  926. }
  927. return qh;
  928. }
  929. /*-------------------------------------------------------------------------*/
  930. static int
  931. submit_async (
  932. struct ehci_hcd *ehci,
  933. struct urb *urb,
  934. struct list_head *qtd_list,
  935. gfp_t mem_flags
  936. ) {
  937. int epnum;
  938. unsigned long flags;
  939. struct ehci_qh *qh = NULL;
  940. int rc;
  941. epnum = urb->ep->desc.bEndpointAddress;
  942. #ifdef EHCI_URB_TRACE
  943. {
  944. struct ehci_qtd *qtd;
  945. qtd = list_entry(qtd_list->next, struct ehci_qtd, qtd_list);
  946. ehci_dbg(ehci,
  947. "%s %s urb %p ep%d%s len %d, qtd %p [qh %p]\n",
  948. __func__, urb->dev->devpath, urb,
  949. epnum & 0x0f, (epnum & USB_DIR_IN) ? "in" : "out",
  950. urb->transfer_buffer_length,
  951. qtd, urb->ep->hcpriv);
  952. }
  953. #endif
  954. spin_lock_irqsave (&ehci->lock, flags);
  955. if (unlikely(!HCD_HW_ACCESSIBLE(ehci_to_hcd(ehci)))) {
  956. rc = -ESHUTDOWN;
  957. goto done;
  958. }
  959. rc = usb_hcd_link_urb_to_ep(ehci_to_hcd(ehci), urb);
  960. if (unlikely(rc))
  961. goto done;
  962. qh = qh_append_tds(ehci, urb, qtd_list, epnum, &urb->ep->hcpriv);
  963. if (unlikely(qh == NULL)) {
  964. usb_hcd_unlink_urb_from_ep(ehci_to_hcd(ehci), urb);
  965. rc = -ENOMEM;
  966. goto done;
  967. }
  968. /* Control/bulk operations through TTs don't need scheduling,
  969. * the HC and TT handle it when the TT has a buffer ready.
  970. */
  971. if (likely (qh->qh_state == QH_STATE_IDLE))
  972. qh_link_async(ehci, qh);
  973. done:
  974. spin_unlock_irqrestore (&ehci->lock, flags);
  975. if (unlikely (qh == NULL))
  976. qtd_list_free (ehci, urb, qtd_list);
  977. return rc;
  978. }
  979. /*-------------------------------------------------------------------------*/
  980. #ifdef CONFIG_USB_HCD_TEST_MODE
  981. /*
  982. * This function creates the qtds and submits them for the
  983. * SINGLE_STEP_SET_FEATURE Test.
  984. * This is done in two parts: first SETUP req for GetDesc is sent then
  985. * 15 seconds later, the IN stage for GetDesc starts to req data from dev
  986. *
  987. * is_setup : i/p arguement decides which of the two stage needs to be
  988. * performed; TRUE - SETUP and FALSE - IN+STATUS
  989. * Returns 0 if success
  990. */
  991. static int submit_single_step_set_feature(
  992. struct usb_hcd *hcd,
  993. struct urb *urb,
  994. int is_setup
  995. ) {
  996. struct ehci_hcd *ehci = hcd_to_ehci(hcd);
  997. struct list_head qtd_list;
  998. struct list_head *head;
  999. struct ehci_qtd *qtd, *qtd_prev;
  1000. dma_addr_t buf;
  1001. int len, maxpacket;
  1002. u32 token;
  1003. INIT_LIST_HEAD(&qtd_list);
  1004. head = &qtd_list;
  1005. /* URBs map to sequences of QTDs: one logical transaction */
  1006. qtd = ehci_qtd_alloc(ehci, GFP_KERNEL);
  1007. if (unlikely(!qtd))
  1008. return -1;
  1009. list_add_tail(&qtd->qtd_list, head);
  1010. qtd->urb = urb;
  1011. token = QTD_STS_ACTIVE;
  1012. token |= (EHCI_TUNE_CERR << 10);
  1013. len = urb->transfer_buffer_length;
  1014. /*
  1015. * Check if the request is to perform just the SETUP stage (getDesc)
  1016. * as in SINGLE_STEP_SET_FEATURE test, DATA stage (IN) happens
  1017. * 15 secs after the setup
  1018. */
  1019. if (is_setup) {
  1020. /* SETUP pid */
  1021. qtd_fill(ehci, qtd, urb->setup_dma,
  1022. sizeof(struct usb_ctrlrequest),
  1023. token | (2 /* "setup" */ << 8), 8);
  1024. submit_async(ehci, urb, &qtd_list, GFP_ATOMIC);
  1025. return 0; /*Return now; we shall come back after 15 seconds*/
  1026. }
  1027. /*
  1028. * IN: data transfer stage: buffer setup : start the IN txn phase for
  1029. * the get_Desc SETUP which was sent 15seconds back
  1030. */
  1031. token ^= QTD_TOGGLE; /*We need to start IN with DATA-1 Pid-sequence*/
  1032. buf = urb->transfer_dma;
  1033. token |= (1 /* "in" */ << 8); /*This is IN stage*/
  1034. maxpacket = max_packet(usb_maxpacket(urb->dev, urb->pipe, 0));
  1035. qtd_fill(ehci, qtd, buf, len, token, maxpacket);
  1036. /*
  1037. * Our IN phase shall always be a short read; so keep the queue running
  1038. * and let it advance to the next qtd which zero length OUT status
  1039. */
  1040. qtd->hw_alt_next = EHCI_LIST_END(ehci);
  1041. /* STATUS stage for GetDesc control request */
  1042. token ^= 0x0100; /* "in" <--> "out" */
  1043. token |= QTD_TOGGLE; /* force DATA1 */
  1044. qtd_prev = qtd;
  1045. qtd = ehci_qtd_alloc(ehci, GFP_ATOMIC);
  1046. if (unlikely(!qtd))
  1047. goto cleanup;
  1048. qtd->urb = urb;
  1049. qtd_prev->hw_next = QTD_NEXT(ehci, qtd->qtd_dma);
  1050. list_add_tail(&qtd->qtd_list, head);
  1051. /* dont fill any data in such packets */
  1052. qtd_fill(ehci, qtd, 0, 0, token, 0);
  1053. /* by default, enable interrupt on urb completion */
  1054. if (likely(!(urb->transfer_flags & URB_NO_INTERRUPT)))
  1055. qtd->hw_token |= cpu_to_hc32(ehci, QTD_IOC);
  1056. submit_async(ehci, urb, &qtd_list, GFP_KERNEL);
  1057. return 0;
  1058. cleanup:
  1059. qtd_list_free(ehci, urb, head);
  1060. return -1;
  1061. }
  1062. #endif /* CONFIG_USB_HCD_TEST_MODE */
  1063. /*-------------------------------------------------------------------------*/
  1064. static void single_unlink_async(struct ehci_hcd *ehci, struct ehci_qh *qh)
  1065. {
  1066. struct ehci_qh *prev;
  1067. /* Add to the end of the list of QHs waiting for the next IAAD */
  1068. qh->qh_state = QH_STATE_UNLINK_WAIT;
  1069. list_add_tail(&qh->unlink_node, &ehci->async_unlink);
  1070. /* Unlink it from the schedule */
  1071. prev = ehci->async;
  1072. while (prev->qh_next.qh != qh)
  1073. prev = prev->qh_next.qh;
  1074. prev->hw->hw_next = qh->hw->hw_next;
  1075. prev->qh_next = qh->qh_next;
  1076. if (ehci->qh_scan_next == qh)
  1077. ehci->qh_scan_next = qh->qh_next.qh;
  1078. }
  1079. static void start_iaa_cycle(struct ehci_hcd *ehci)
  1080. {
  1081. /* Do nothing if an IAA cycle is already running */
  1082. if (ehci->iaa_in_progress)
  1083. return;
  1084. ehci->iaa_in_progress = true;
  1085. /* If the controller isn't running, we don't have to wait for it */
  1086. if (unlikely(ehci->rh_state < EHCI_RH_RUNNING)) {
  1087. end_unlink_async(ehci);
  1088. /* Otherwise start a new IAA cycle */
  1089. } else if (likely(ehci->rh_state == EHCI_RH_RUNNING)) {
  1090. /* Make sure the unlinks are all visible to the hardware */
  1091. wmb();
  1092. ehci_writel(ehci, ehci->command | CMD_IAAD,
  1093. &ehci->regs->command);
  1094. ehci_readl(ehci, &ehci->regs->command);
  1095. ehci_enable_event(ehci, EHCI_HRTIMER_IAA_WATCHDOG, true);
  1096. }
  1097. }
  1098. /* the async qh for the qtds being unlinked are now gone from the HC */
  1099. static void end_unlink_async(struct ehci_hcd *ehci)
  1100. {
  1101. struct ehci_qh *qh;
  1102. bool early_exit;
  1103. if (ehci->has_synopsys_hc_bug)
  1104. ehci_writel(ehci, (u32) ehci->async->qh_dma,
  1105. &ehci->regs->async_next);
  1106. /* The current IAA cycle has ended */
  1107. ehci->iaa_in_progress = false;
  1108. if (list_empty(&ehci->async_unlink))
  1109. return;
  1110. qh = list_first_entry(&ehci->async_unlink, struct ehci_qh,
  1111. unlink_node); /* QH whose IAA cycle just ended */
  1112. /*
  1113. * If async_unlinking is set then this routine is already running,
  1114. * either on the stack or on another CPU.
  1115. */
  1116. early_exit = ehci->async_unlinking;
  1117. /* If the controller isn't running, process all the waiting QHs */
  1118. if (ehci->rh_state < EHCI_RH_RUNNING)
  1119. list_splice_tail_init(&ehci->async_unlink, &ehci->async_idle);
  1120. /*
  1121. * Intel (?) bug: The HC can write back the overlay region even
  1122. * after the IAA interrupt occurs. In self-defense, always go
  1123. * through two IAA cycles for each QH.
  1124. */
  1125. else if (qh->qh_state == QH_STATE_UNLINK_WAIT) {
  1126. qh->qh_state = QH_STATE_UNLINK;
  1127. early_exit = true;
  1128. }
  1129. /* Otherwise process only the first waiting QH (NVIDIA bug?) */
  1130. else
  1131. list_move_tail(&qh->unlink_node, &ehci->async_idle);
  1132. /* Start a new IAA cycle if any QHs are waiting for it */
  1133. if (!list_empty(&ehci->async_unlink))
  1134. start_iaa_cycle(ehci);
  1135. /*
  1136. * Don't allow nesting or concurrent calls,
  1137. * or wait for the second IAA cycle for the next QH.
  1138. */
  1139. if (early_exit)
  1140. return;
  1141. /* Process the idle QHs */
  1142. ehci->async_unlinking = true;
  1143. while (!list_empty(&ehci->async_idle)) {
  1144. qh = list_first_entry(&ehci->async_idle, struct ehci_qh,
  1145. unlink_node);
  1146. list_del(&qh->unlink_node);
  1147. qh->qh_state = QH_STATE_IDLE;
  1148. qh->qh_next.qh = NULL;
  1149. if (!list_empty(&qh->qtd_list))
  1150. qh_completions(ehci, qh);
  1151. if (!list_empty(&qh->qtd_list) &&
  1152. ehci->rh_state == EHCI_RH_RUNNING)
  1153. qh_link_async(ehci, qh);
  1154. disable_async(ehci);
  1155. }
  1156. ehci->async_unlinking = false;
  1157. }
  1158. static void start_unlink_async(struct ehci_hcd *ehci, struct ehci_qh *qh);
  1159. static void unlink_empty_async(struct ehci_hcd *ehci)
  1160. {
  1161. struct ehci_qh *qh;
  1162. struct ehci_qh *qh_to_unlink = NULL;
  1163. int count = 0;
  1164. /* Find the last async QH which has been empty for a timer cycle */
  1165. for (qh = ehci->async->qh_next.qh; qh; qh = qh->qh_next.qh) {
  1166. if (list_empty(&qh->qtd_list) &&
  1167. qh->qh_state == QH_STATE_LINKED) {
  1168. ++count;
  1169. if (qh->unlink_cycle != ehci->async_unlink_cycle)
  1170. qh_to_unlink = qh;
  1171. }
  1172. }
  1173. /* If nothing else is being unlinked, unlink the last empty QH */
  1174. if (list_empty(&ehci->async_unlink) && qh_to_unlink) {
  1175. start_unlink_async(ehci, qh_to_unlink);
  1176. --count;
  1177. }
  1178. /* Other QHs will be handled later */
  1179. if (count > 0) {
  1180. ehci_enable_event(ehci, EHCI_HRTIMER_ASYNC_UNLINKS, true);
  1181. ++ehci->async_unlink_cycle;
  1182. }
  1183. }
  1184. /* The root hub is suspended; unlink all the async QHs */
  1185. static void __maybe_unused unlink_empty_async_suspended(struct ehci_hcd *ehci)
  1186. {
  1187. struct ehci_qh *qh;
  1188. while (ehci->async->qh_next.qh) {
  1189. qh = ehci->async->qh_next.qh;
  1190. WARN_ON(!list_empty(&qh->qtd_list));
  1191. single_unlink_async(ehci, qh);
  1192. }
  1193. start_iaa_cycle(ehci);
  1194. }
  1195. /* makes sure the async qh will become idle */
  1196. /* caller must own ehci->lock */
  1197. static void start_unlink_async(struct ehci_hcd *ehci, struct ehci_qh *qh)
  1198. {
  1199. /* If the QH isn't linked then there's nothing we can do. */
  1200. if (qh->qh_state != QH_STATE_LINKED)
  1201. return;
  1202. single_unlink_async(ehci, qh);
  1203. start_iaa_cycle(ehci);
  1204. }
  1205. /*-------------------------------------------------------------------------*/
  1206. static void scan_async (struct ehci_hcd *ehci)
  1207. {
  1208. struct ehci_qh *qh;
  1209. bool check_unlinks_later = false;
  1210. ehci->qh_scan_next = ehci->async->qh_next.qh;
  1211. while (ehci->qh_scan_next) {
  1212. qh = ehci->qh_scan_next;
  1213. ehci->qh_scan_next = qh->qh_next.qh;
  1214. /* clean any finished work for this qh */
  1215. if (!list_empty(&qh->qtd_list)) {
  1216. int temp;
  1217. /*
  1218. * Unlinks could happen here; completion reporting
  1219. * drops the lock. That's why ehci->qh_scan_next
  1220. * always holds the next qh to scan; if the next qh
  1221. * gets unlinked then ehci->qh_scan_next is adjusted
  1222. * in single_unlink_async().
  1223. */
  1224. temp = qh_completions(ehci, qh);
  1225. if (unlikely(temp)) {
  1226. start_unlink_async(ehci, qh);
  1227. } else if (list_empty(&qh->qtd_list)
  1228. && qh->qh_state == QH_STATE_LINKED) {
  1229. qh->unlink_cycle = ehci->async_unlink_cycle;
  1230. check_unlinks_later = true;
  1231. }
  1232. }
  1233. }
  1234. /*
  1235. * Unlink empty entries, reducing DMA usage as well
  1236. * as HCD schedule-scanning costs. Delay for any qh
  1237. * we just scanned, there's a not-unusual case that it
  1238. * doesn't stay idle for long.
  1239. */
  1240. if (check_unlinks_later && ehci->rh_state == EHCI_RH_RUNNING &&
  1241. !(ehci->enabled_hrtimer_events &
  1242. BIT(EHCI_HRTIMER_ASYNC_UNLINKS))) {
  1243. ehci_enable_event(ehci, EHCI_HRTIMER_ASYNC_UNLINKS, true);
  1244. ++ehci->async_unlink_cycle;
  1245. }
  1246. }