hub.c 89 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191
  1. /*
  2. * USB hub driver.
  3. *
  4. * (C) Copyright 1999 Linus Torvalds
  5. * (C) Copyright 1999 Johannes Erdfelt
  6. * (C) Copyright 1999 Gregory P. Smith
  7. * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
  8. *
  9. */
  10. #include <linux/kernel.h>
  11. #include <linux/errno.h>
  12. #include <linux/module.h>
  13. #include <linux/moduleparam.h>
  14. #include <linux/completion.h>
  15. #include <linux/sched.h>
  16. #include <linux/list.h>
  17. #include <linux/slab.h>
  18. #include <linux/ioctl.h>
  19. #include <linux/usb.h>
  20. #include <linux/usbdevice_fs.h>
  21. #include <linux/kthread.h>
  22. #include <linux/mutex.h>
  23. #include <linux/freezer.h>
  24. #include <asm/semaphore.h>
  25. #include <asm/uaccess.h>
  26. #include <asm/byteorder.h>
  27. #include "usb.h"
  28. #include "hcd.h"
  29. #include "hub.h"
  30. #ifdef CONFIG_USB_PERSIST
  31. #define USB_PERSIST 1
  32. #else
  33. #define USB_PERSIST 0
  34. #endif
  35. /* if we are in debug mode, always announce new devices */
  36. #ifdef DEBUG
  37. #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
  38. #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
  39. #endif
  40. #endif
  41. struct usb_hub {
  42. struct device *intfdev; /* the "interface" device */
  43. struct usb_device *hdev;
  44. struct kref kref;
  45. struct urb *urb; /* for interrupt polling pipe */
  46. /* buffer for urb ... with extra space in case of babble */
  47. char (*buffer)[8];
  48. dma_addr_t buffer_dma; /* DMA address for buffer */
  49. union {
  50. struct usb_hub_status hub;
  51. struct usb_port_status port;
  52. } *status; /* buffer for status reports */
  53. struct mutex status_mutex; /* for the status buffer */
  54. int error; /* last reported error */
  55. int nerrors; /* track consecutive errors */
  56. struct list_head event_list; /* hubs w/data or errs ready */
  57. unsigned long event_bits[1]; /* status change bitmask */
  58. unsigned long change_bits[1]; /* ports with logical connect
  59. status change */
  60. unsigned long busy_bits[1]; /* ports being reset or
  61. resumed */
  62. #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
  63. #error event_bits[] is too short!
  64. #endif
  65. struct usb_hub_descriptor *descriptor; /* class descriptor */
  66. struct usb_tt tt; /* Transaction Translator */
  67. unsigned mA_per_port; /* current for each child */
  68. unsigned limited_power:1;
  69. unsigned quiescing:1;
  70. unsigned activating:1;
  71. unsigned disconnected:1;
  72. unsigned has_indicators:1;
  73. u8 indicator[USB_MAXCHILDREN];
  74. struct delayed_work leds;
  75. };
  76. /* Protect struct usb_device->state and ->children members
  77. * Note: Both are also protected by ->dev.sem, except that ->state can
  78. * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
  79. static DEFINE_SPINLOCK(device_state_lock);
  80. /* khubd's worklist and its lock */
  81. static DEFINE_SPINLOCK(hub_event_lock);
  82. static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
  83. /* Wakes up khubd */
  84. static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
  85. static struct task_struct *khubd_task;
  86. /* cycle leds on hubs that aren't blinking for attention */
  87. static int blinkenlights = 0;
  88. module_param (blinkenlights, bool, S_IRUGO);
  89. MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
  90. /*
  91. * As of 2.6.10 we introduce a new USB device initialization scheme which
  92. * closely resembles the way Windows works. Hopefully it will be compatible
  93. * with a wider range of devices than the old scheme. However some previously
  94. * working devices may start giving rise to "device not accepting address"
  95. * errors; if that happens the user can try the old scheme by adjusting the
  96. * following module parameters.
  97. *
  98. * For maximum flexibility there are two boolean parameters to control the
  99. * hub driver's behavior. On the first initialization attempt, if the
  100. * "old_scheme_first" parameter is set then the old scheme will be used,
  101. * otherwise the new scheme is used. If that fails and "use_both_schemes"
  102. * is set, then the driver will make another attempt, using the other scheme.
  103. */
  104. static int old_scheme_first = 0;
  105. module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
  106. MODULE_PARM_DESC(old_scheme_first,
  107. "start with the old device initialization scheme");
  108. static int use_both_schemes = 1;
  109. module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
  110. MODULE_PARM_DESC(use_both_schemes,
  111. "try the other device initialization scheme if the "
  112. "first one fails");
  113. /* Mutual exclusion for EHCI CF initialization. This interferes with
  114. * port reset on some companion controllers.
  115. */
  116. DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
  117. EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
  118. static inline char *portspeed(int portstatus)
  119. {
  120. if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
  121. return "480 Mb/s";
  122. else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
  123. return "1.5 Mb/s";
  124. else
  125. return "12 Mb/s";
  126. }
  127. /* Note that hdev or one of its children must be locked! */
  128. static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
  129. {
  130. return usb_get_intfdata(hdev->actconfig->interface[0]);
  131. }
  132. /* USB 2.0 spec Section 11.24.4.5 */
  133. static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
  134. {
  135. int i, ret;
  136. for (i = 0; i < 3; i++) {
  137. ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
  138. USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
  139. USB_DT_HUB << 8, 0, data, size,
  140. USB_CTRL_GET_TIMEOUT);
  141. if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
  142. return ret;
  143. }
  144. return -EINVAL;
  145. }
  146. /*
  147. * USB 2.0 spec Section 11.24.2.1
  148. */
  149. static int clear_hub_feature(struct usb_device *hdev, int feature)
  150. {
  151. return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
  152. USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
  153. }
  154. /*
  155. * USB 2.0 spec Section 11.24.2.2
  156. */
  157. static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
  158. {
  159. return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
  160. USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
  161. NULL, 0, 1000);
  162. }
  163. /*
  164. * USB 2.0 spec Section 11.24.2.13
  165. */
  166. static int set_port_feature(struct usb_device *hdev, int port1, int feature)
  167. {
  168. return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
  169. USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
  170. NULL, 0, 1000);
  171. }
  172. /*
  173. * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
  174. * for info about using port indicators
  175. */
  176. static void set_port_led(
  177. struct usb_hub *hub,
  178. int port1,
  179. int selector
  180. )
  181. {
  182. int status = set_port_feature(hub->hdev, (selector << 8) | port1,
  183. USB_PORT_FEAT_INDICATOR);
  184. if (status < 0)
  185. dev_dbg (hub->intfdev,
  186. "port %d indicator %s status %d\n",
  187. port1,
  188. ({ char *s; switch (selector) {
  189. case HUB_LED_AMBER: s = "amber"; break;
  190. case HUB_LED_GREEN: s = "green"; break;
  191. case HUB_LED_OFF: s = "off"; break;
  192. case HUB_LED_AUTO: s = "auto"; break;
  193. default: s = "??"; break;
  194. }; s; }),
  195. status);
  196. }
  197. #define LED_CYCLE_PERIOD ((2*HZ)/3)
  198. static void led_work (struct work_struct *work)
  199. {
  200. struct usb_hub *hub =
  201. container_of(work, struct usb_hub, leds.work);
  202. struct usb_device *hdev = hub->hdev;
  203. unsigned i;
  204. unsigned changed = 0;
  205. int cursor = -1;
  206. if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
  207. return;
  208. for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
  209. unsigned selector, mode;
  210. /* 30%-50% duty cycle */
  211. switch (hub->indicator[i]) {
  212. /* cycle marker */
  213. case INDICATOR_CYCLE:
  214. cursor = i;
  215. selector = HUB_LED_AUTO;
  216. mode = INDICATOR_AUTO;
  217. break;
  218. /* blinking green = sw attention */
  219. case INDICATOR_GREEN_BLINK:
  220. selector = HUB_LED_GREEN;
  221. mode = INDICATOR_GREEN_BLINK_OFF;
  222. break;
  223. case INDICATOR_GREEN_BLINK_OFF:
  224. selector = HUB_LED_OFF;
  225. mode = INDICATOR_GREEN_BLINK;
  226. break;
  227. /* blinking amber = hw attention */
  228. case INDICATOR_AMBER_BLINK:
  229. selector = HUB_LED_AMBER;
  230. mode = INDICATOR_AMBER_BLINK_OFF;
  231. break;
  232. case INDICATOR_AMBER_BLINK_OFF:
  233. selector = HUB_LED_OFF;
  234. mode = INDICATOR_AMBER_BLINK;
  235. break;
  236. /* blink green/amber = reserved */
  237. case INDICATOR_ALT_BLINK:
  238. selector = HUB_LED_GREEN;
  239. mode = INDICATOR_ALT_BLINK_OFF;
  240. break;
  241. case INDICATOR_ALT_BLINK_OFF:
  242. selector = HUB_LED_AMBER;
  243. mode = INDICATOR_ALT_BLINK;
  244. break;
  245. default:
  246. continue;
  247. }
  248. if (selector != HUB_LED_AUTO)
  249. changed = 1;
  250. set_port_led(hub, i + 1, selector);
  251. hub->indicator[i] = mode;
  252. }
  253. if (!changed && blinkenlights) {
  254. cursor++;
  255. cursor %= hub->descriptor->bNbrPorts;
  256. set_port_led(hub, cursor + 1, HUB_LED_GREEN);
  257. hub->indicator[cursor] = INDICATOR_CYCLE;
  258. changed++;
  259. }
  260. if (changed)
  261. schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
  262. }
  263. /* use a short timeout for hub/port status fetches */
  264. #define USB_STS_TIMEOUT 1000
  265. #define USB_STS_RETRIES 5
  266. /*
  267. * USB 2.0 spec Section 11.24.2.6
  268. */
  269. static int get_hub_status(struct usb_device *hdev,
  270. struct usb_hub_status *data)
  271. {
  272. int i, status = -ETIMEDOUT;
  273. for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
  274. status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
  275. USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
  276. data, sizeof(*data), USB_STS_TIMEOUT);
  277. }
  278. return status;
  279. }
  280. /*
  281. * USB 2.0 spec Section 11.24.2.7
  282. */
  283. static int get_port_status(struct usb_device *hdev, int port1,
  284. struct usb_port_status *data)
  285. {
  286. int i, status = -ETIMEDOUT;
  287. for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
  288. status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
  289. USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
  290. data, sizeof(*data), USB_STS_TIMEOUT);
  291. }
  292. return status;
  293. }
  294. static void kick_khubd(struct usb_hub *hub)
  295. {
  296. unsigned long flags;
  297. /* Suppress autosuspend until khubd runs */
  298. to_usb_interface(hub->intfdev)->pm_usage_cnt = 1;
  299. spin_lock_irqsave(&hub_event_lock, flags);
  300. if (!hub->disconnected && list_empty(&hub->event_list)) {
  301. list_add_tail(&hub->event_list, &hub_event_list);
  302. wake_up(&khubd_wait);
  303. }
  304. spin_unlock_irqrestore(&hub_event_lock, flags);
  305. }
  306. void usb_kick_khubd(struct usb_device *hdev)
  307. {
  308. /* FIXME: What if hdev isn't bound to the hub driver? */
  309. kick_khubd(hdev_to_hub(hdev));
  310. }
  311. /* completion function, fires on port status changes and various faults */
  312. static void hub_irq(struct urb *urb)
  313. {
  314. struct usb_hub *hub = urb->context;
  315. int status = urb->status;
  316. int i;
  317. unsigned long bits;
  318. switch (status) {
  319. case -ENOENT: /* synchronous unlink */
  320. case -ECONNRESET: /* async unlink */
  321. case -ESHUTDOWN: /* hardware going away */
  322. return;
  323. default: /* presumably an error */
  324. /* Cause a hub reset after 10 consecutive errors */
  325. dev_dbg (hub->intfdev, "transfer --> %d\n", status);
  326. if ((++hub->nerrors < 10) || hub->error)
  327. goto resubmit;
  328. hub->error = status;
  329. /* FALL THROUGH */
  330. /* let khubd handle things */
  331. case 0: /* we got data: port status changed */
  332. bits = 0;
  333. for (i = 0; i < urb->actual_length; ++i)
  334. bits |= ((unsigned long) ((*hub->buffer)[i]))
  335. << (i*8);
  336. hub->event_bits[0] = bits;
  337. break;
  338. }
  339. hub->nerrors = 0;
  340. /* Something happened, let khubd figure it out */
  341. kick_khubd(hub);
  342. resubmit:
  343. if (hub->quiescing)
  344. return;
  345. if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
  346. && status != -ENODEV && status != -EPERM)
  347. dev_err (hub->intfdev, "resubmit --> %d\n", status);
  348. }
  349. /* USB 2.0 spec Section 11.24.2.3 */
  350. static inline int
  351. hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
  352. {
  353. return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
  354. HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
  355. tt, NULL, 0, 1000);
  356. }
  357. /*
  358. * enumeration blocks khubd for a long time. we use keventd instead, since
  359. * long blocking there is the exception, not the rule. accordingly, HCDs
  360. * talking to TTs must queue control transfers (not just bulk and iso), so
  361. * both can talk to the same hub concurrently.
  362. */
  363. static void hub_tt_kevent (struct work_struct *work)
  364. {
  365. struct usb_hub *hub =
  366. container_of(work, struct usb_hub, tt.kevent);
  367. unsigned long flags;
  368. int limit = 100;
  369. spin_lock_irqsave (&hub->tt.lock, flags);
  370. while (--limit && !list_empty (&hub->tt.clear_list)) {
  371. struct list_head *temp;
  372. struct usb_tt_clear *clear;
  373. struct usb_device *hdev = hub->hdev;
  374. int status;
  375. temp = hub->tt.clear_list.next;
  376. clear = list_entry (temp, struct usb_tt_clear, clear_list);
  377. list_del (&clear->clear_list);
  378. /* drop lock so HCD can concurrently report other TT errors */
  379. spin_unlock_irqrestore (&hub->tt.lock, flags);
  380. status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
  381. spin_lock_irqsave (&hub->tt.lock, flags);
  382. if (status)
  383. dev_err (&hdev->dev,
  384. "clear tt %d (%04x) error %d\n",
  385. clear->tt, clear->devinfo, status);
  386. kfree(clear);
  387. }
  388. spin_unlock_irqrestore (&hub->tt.lock, flags);
  389. }
  390. /**
  391. * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
  392. * @udev: the device whose split transaction failed
  393. * @pipe: identifies the endpoint of the failed transaction
  394. *
  395. * High speed HCDs use this to tell the hub driver that some split control or
  396. * bulk transaction failed in a way that requires clearing internal state of
  397. * a transaction translator. This is normally detected (and reported) from
  398. * interrupt context.
  399. *
  400. * It may not be possible for that hub to handle additional full (or low)
  401. * speed transactions until that state is fully cleared out.
  402. */
  403. void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
  404. {
  405. struct usb_tt *tt = udev->tt;
  406. unsigned long flags;
  407. struct usb_tt_clear *clear;
  408. /* we've got to cope with an arbitrary number of pending TT clears,
  409. * since each TT has "at least two" buffers that can need it (and
  410. * there can be many TTs per hub). even if they're uncommon.
  411. */
  412. if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
  413. dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
  414. /* FIXME recover somehow ... RESET_TT? */
  415. return;
  416. }
  417. /* info that CLEAR_TT_BUFFER needs */
  418. clear->tt = tt->multi ? udev->ttport : 1;
  419. clear->devinfo = usb_pipeendpoint (pipe);
  420. clear->devinfo |= udev->devnum << 4;
  421. clear->devinfo |= usb_pipecontrol (pipe)
  422. ? (USB_ENDPOINT_XFER_CONTROL << 11)
  423. : (USB_ENDPOINT_XFER_BULK << 11);
  424. if (usb_pipein (pipe))
  425. clear->devinfo |= 1 << 15;
  426. /* tell keventd to clear state for this TT */
  427. spin_lock_irqsave (&tt->lock, flags);
  428. list_add_tail (&clear->clear_list, &tt->clear_list);
  429. schedule_work (&tt->kevent);
  430. spin_unlock_irqrestore (&tt->lock, flags);
  431. }
  432. EXPORT_SYMBOL_GPL(usb_hub_tt_clear_buffer);
  433. static void hub_power_on(struct usb_hub *hub)
  434. {
  435. int port1;
  436. unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
  437. u16 wHubCharacteristics =
  438. le16_to_cpu(hub->descriptor->wHubCharacteristics);
  439. /* Enable power on each port. Some hubs have reserved values
  440. * of LPSM (> 2) in their descriptors, even though they are
  441. * USB 2.0 hubs. Some hubs do not implement port-power switching
  442. * but only emulate it. In all cases, the ports won't work
  443. * unless we send these messages to the hub.
  444. */
  445. if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
  446. dev_dbg(hub->intfdev, "enabling power on all ports\n");
  447. else
  448. dev_dbg(hub->intfdev, "trying to enable port power on "
  449. "non-switchable hub\n");
  450. for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
  451. set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
  452. /* Wait at least 100 msec for power to become stable */
  453. msleep(max(pgood_delay, (unsigned) 100));
  454. }
  455. static void hub_quiesce(struct usb_hub *hub)
  456. {
  457. /* (nonblocking) khubd and related activity won't re-trigger */
  458. hub->quiescing = 1;
  459. hub->activating = 0;
  460. /* (blocking) stop khubd and related activity */
  461. usb_kill_urb(hub->urb);
  462. if (hub->has_indicators)
  463. cancel_delayed_work_sync(&hub->leds);
  464. if (hub->tt.hub)
  465. cancel_work_sync(&hub->tt.kevent);
  466. }
  467. static void hub_activate(struct usb_hub *hub)
  468. {
  469. int status;
  470. hub->quiescing = 0;
  471. hub->activating = 1;
  472. status = usb_submit_urb(hub->urb, GFP_NOIO);
  473. if (status < 0)
  474. dev_err(hub->intfdev, "activate --> %d\n", status);
  475. if (hub->has_indicators && blinkenlights)
  476. schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
  477. /* scan all ports ASAP */
  478. kick_khubd(hub);
  479. }
  480. static int hub_hub_status(struct usb_hub *hub,
  481. u16 *status, u16 *change)
  482. {
  483. int ret;
  484. mutex_lock(&hub->status_mutex);
  485. ret = get_hub_status(hub->hdev, &hub->status->hub);
  486. if (ret < 0)
  487. dev_err (hub->intfdev,
  488. "%s failed (err = %d)\n", __FUNCTION__, ret);
  489. else {
  490. *status = le16_to_cpu(hub->status->hub.wHubStatus);
  491. *change = le16_to_cpu(hub->status->hub.wHubChange);
  492. ret = 0;
  493. }
  494. mutex_unlock(&hub->status_mutex);
  495. return ret;
  496. }
  497. static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
  498. {
  499. struct usb_device *hdev = hub->hdev;
  500. int ret = 0;
  501. if (hdev->children[port1-1] && set_state)
  502. usb_set_device_state(hdev->children[port1-1],
  503. USB_STATE_NOTATTACHED);
  504. if (!hub->error)
  505. ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
  506. if (ret)
  507. dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
  508. port1, ret);
  509. return ret;
  510. }
  511. /*
  512. * Disable a port and mark a logical connnect-change event, so that some
  513. * time later khubd will disconnect() any existing usb_device on the port
  514. * and will re-enumerate if there actually is a device attached.
  515. */
  516. static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
  517. {
  518. dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
  519. hub_port_disable(hub, port1, 1);
  520. /* FIXME let caller ask to power down the port:
  521. * - some devices won't enumerate without a VBUS power cycle
  522. * - SRP saves power that way
  523. * - ... new call, TBD ...
  524. * That's easy if this hub can switch power per-port, and
  525. * khubd reactivates the port later (timer, SRP, etc).
  526. * Powerdown must be optional, because of reset/DFU.
  527. */
  528. set_bit(port1, hub->change_bits);
  529. kick_khubd(hub);
  530. }
  531. /* caller has locked the hub device */
  532. static int hub_pre_reset(struct usb_interface *intf)
  533. {
  534. struct usb_hub *hub = usb_get_intfdata(intf);
  535. struct usb_device *hdev = hub->hdev;
  536. int i;
  537. /* Disconnect all the children */
  538. for (i = 0; i < hdev->maxchild; ++i) {
  539. if (hdev->children[i])
  540. usb_disconnect(&hdev->children[i]);
  541. }
  542. hub_quiesce(hub);
  543. return 0;
  544. }
  545. /* caller has locked the hub device */
  546. static int hub_post_reset(struct usb_interface *intf)
  547. {
  548. struct usb_hub *hub = usb_get_intfdata(intf);
  549. hub_power_on(hub);
  550. hub_activate(hub);
  551. return 0;
  552. }
  553. static int hub_configure(struct usb_hub *hub,
  554. struct usb_endpoint_descriptor *endpoint)
  555. {
  556. struct usb_device *hdev = hub->hdev;
  557. struct device *hub_dev = hub->intfdev;
  558. u16 hubstatus, hubchange;
  559. u16 wHubCharacteristics;
  560. unsigned int pipe;
  561. int maxp, ret;
  562. char *message;
  563. hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
  564. &hub->buffer_dma);
  565. if (!hub->buffer) {
  566. message = "can't allocate hub irq buffer";
  567. ret = -ENOMEM;
  568. goto fail;
  569. }
  570. hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
  571. if (!hub->status) {
  572. message = "can't kmalloc hub status buffer";
  573. ret = -ENOMEM;
  574. goto fail;
  575. }
  576. mutex_init(&hub->status_mutex);
  577. hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
  578. if (!hub->descriptor) {
  579. message = "can't kmalloc hub descriptor";
  580. ret = -ENOMEM;
  581. goto fail;
  582. }
  583. /* Request the entire hub descriptor.
  584. * hub->descriptor can handle USB_MAXCHILDREN ports,
  585. * but the hub can/will return fewer bytes here.
  586. */
  587. ret = get_hub_descriptor(hdev, hub->descriptor,
  588. sizeof(*hub->descriptor));
  589. if (ret < 0) {
  590. message = "can't read hub descriptor";
  591. goto fail;
  592. } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
  593. message = "hub has too many ports!";
  594. ret = -ENODEV;
  595. goto fail;
  596. }
  597. hdev->maxchild = hub->descriptor->bNbrPorts;
  598. dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
  599. (hdev->maxchild == 1) ? "" : "s");
  600. wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
  601. if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
  602. int i;
  603. char portstr [USB_MAXCHILDREN + 1];
  604. for (i = 0; i < hdev->maxchild; i++)
  605. portstr[i] = hub->descriptor->DeviceRemovable
  606. [((i + 1) / 8)] & (1 << ((i + 1) % 8))
  607. ? 'F' : 'R';
  608. portstr[hdev->maxchild] = 0;
  609. dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
  610. } else
  611. dev_dbg(hub_dev, "standalone hub\n");
  612. switch (wHubCharacteristics & HUB_CHAR_LPSM) {
  613. case 0x00:
  614. dev_dbg(hub_dev, "ganged power switching\n");
  615. break;
  616. case 0x01:
  617. dev_dbg(hub_dev, "individual port power switching\n");
  618. break;
  619. case 0x02:
  620. case 0x03:
  621. dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
  622. break;
  623. }
  624. switch (wHubCharacteristics & HUB_CHAR_OCPM) {
  625. case 0x00:
  626. dev_dbg(hub_dev, "global over-current protection\n");
  627. break;
  628. case 0x08:
  629. dev_dbg(hub_dev, "individual port over-current protection\n");
  630. break;
  631. case 0x10:
  632. case 0x18:
  633. dev_dbg(hub_dev, "no over-current protection\n");
  634. break;
  635. }
  636. spin_lock_init (&hub->tt.lock);
  637. INIT_LIST_HEAD (&hub->tt.clear_list);
  638. INIT_WORK (&hub->tt.kevent, hub_tt_kevent);
  639. switch (hdev->descriptor.bDeviceProtocol) {
  640. case 0:
  641. break;
  642. case 1:
  643. dev_dbg(hub_dev, "Single TT\n");
  644. hub->tt.hub = hdev;
  645. break;
  646. case 2:
  647. ret = usb_set_interface(hdev, 0, 1);
  648. if (ret == 0) {
  649. dev_dbg(hub_dev, "TT per port\n");
  650. hub->tt.multi = 1;
  651. } else
  652. dev_err(hub_dev, "Using single TT (err %d)\n",
  653. ret);
  654. hub->tt.hub = hdev;
  655. break;
  656. default:
  657. dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
  658. hdev->descriptor.bDeviceProtocol);
  659. break;
  660. }
  661. /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
  662. switch (wHubCharacteristics & HUB_CHAR_TTTT) {
  663. case HUB_TTTT_8_BITS:
  664. if (hdev->descriptor.bDeviceProtocol != 0) {
  665. hub->tt.think_time = 666;
  666. dev_dbg(hub_dev, "TT requires at most %d "
  667. "FS bit times (%d ns)\n",
  668. 8, hub->tt.think_time);
  669. }
  670. break;
  671. case HUB_TTTT_16_BITS:
  672. hub->tt.think_time = 666 * 2;
  673. dev_dbg(hub_dev, "TT requires at most %d "
  674. "FS bit times (%d ns)\n",
  675. 16, hub->tt.think_time);
  676. break;
  677. case HUB_TTTT_24_BITS:
  678. hub->tt.think_time = 666 * 3;
  679. dev_dbg(hub_dev, "TT requires at most %d "
  680. "FS bit times (%d ns)\n",
  681. 24, hub->tt.think_time);
  682. break;
  683. case HUB_TTTT_32_BITS:
  684. hub->tt.think_time = 666 * 4;
  685. dev_dbg(hub_dev, "TT requires at most %d "
  686. "FS bit times (%d ns)\n",
  687. 32, hub->tt.think_time);
  688. break;
  689. }
  690. /* probe() zeroes hub->indicator[] */
  691. if (wHubCharacteristics & HUB_CHAR_PORTIND) {
  692. hub->has_indicators = 1;
  693. dev_dbg(hub_dev, "Port indicators are supported\n");
  694. }
  695. dev_dbg(hub_dev, "power on to power good time: %dms\n",
  696. hub->descriptor->bPwrOn2PwrGood * 2);
  697. /* power budgeting mostly matters with bus-powered hubs,
  698. * and battery-powered root hubs (may provide just 8 mA).
  699. */
  700. ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
  701. if (ret < 2) {
  702. message = "can't get hub status";
  703. goto fail;
  704. }
  705. le16_to_cpus(&hubstatus);
  706. if (hdev == hdev->bus->root_hub) {
  707. if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
  708. hub->mA_per_port = 500;
  709. else {
  710. hub->mA_per_port = hdev->bus_mA;
  711. hub->limited_power = 1;
  712. }
  713. } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
  714. dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
  715. hub->descriptor->bHubContrCurrent);
  716. hub->limited_power = 1;
  717. if (hdev->maxchild > 0) {
  718. int remaining = hdev->bus_mA -
  719. hub->descriptor->bHubContrCurrent;
  720. if (remaining < hdev->maxchild * 100)
  721. dev_warn(hub_dev,
  722. "insufficient power available "
  723. "to use all downstream ports\n");
  724. hub->mA_per_port = 100; /* 7.2.1.1 */
  725. }
  726. } else { /* Self-powered external hub */
  727. /* FIXME: What about battery-powered external hubs that
  728. * provide less current per port? */
  729. hub->mA_per_port = 500;
  730. }
  731. if (hub->mA_per_port < 500)
  732. dev_dbg(hub_dev, "%umA bus power budget for each child\n",
  733. hub->mA_per_port);
  734. ret = hub_hub_status(hub, &hubstatus, &hubchange);
  735. if (ret < 0) {
  736. message = "can't get hub status";
  737. goto fail;
  738. }
  739. /* local power status reports aren't always correct */
  740. if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
  741. dev_dbg(hub_dev, "local power source is %s\n",
  742. (hubstatus & HUB_STATUS_LOCAL_POWER)
  743. ? "lost (inactive)" : "good");
  744. if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
  745. dev_dbg(hub_dev, "%sover-current condition exists\n",
  746. (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
  747. /* set up the interrupt endpoint
  748. * We use the EP's maxpacket size instead of (PORTS+1+7)/8
  749. * bytes as USB2.0[11.12.3] says because some hubs are known
  750. * to send more data (and thus cause overflow). For root hubs,
  751. * maxpktsize is defined in hcd.c's fake endpoint descriptors
  752. * to be big enough for at least USB_MAXCHILDREN ports. */
  753. pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
  754. maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
  755. if (maxp > sizeof(*hub->buffer))
  756. maxp = sizeof(*hub->buffer);
  757. hub->urb = usb_alloc_urb(0, GFP_KERNEL);
  758. if (!hub->urb) {
  759. message = "couldn't allocate interrupt urb";
  760. ret = -ENOMEM;
  761. goto fail;
  762. }
  763. usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
  764. hub, endpoint->bInterval);
  765. hub->urb->transfer_dma = hub->buffer_dma;
  766. hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
  767. /* maybe cycle the hub leds */
  768. if (hub->has_indicators && blinkenlights)
  769. hub->indicator [0] = INDICATOR_CYCLE;
  770. hub_power_on(hub);
  771. hub_activate(hub);
  772. return 0;
  773. fail:
  774. dev_err (hub_dev, "config failed, %s (err %d)\n",
  775. message, ret);
  776. /* hub_disconnect() frees urb and descriptor */
  777. return ret;
  778. }
  779. static void hub_release(struct kref *kref)
  780. {
  781. struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
  782. usb_put_intf(to_usb_interface(hub->intfdev));
  783. kfree(hub);
  784. }
  785. static unsigned highspeed_hubs;
  786. static void hub_disconnect(struct usb_interface *intf)
  787. {
  788. struct usb_hub *hub = usb_get_intfdata (intf);
  789. /* Take the hub off the event list and don't let it be added again */
  790. spin_lock_irq(&hub_event_lock);
  791. list_del_init(&hub->event_list);
  792. hub->disconnected = 1;
  793. spin_unlock_irq(&hub_event_lock);
  794. /* Disconnect all children and quiesce the hub */
  795. hub->error = 0;
  796. hub_pre_reset(intf);
  797. usb_set_intfdata (intf, NULL);
  798. if (hub->hdev->speed == USB_SPEED_HIGH)
  799. highspeed_hubs--;
  800. usb_free_urb(hub->urb);
  801. kfree(hub->descriptor);
  802. kfree(hub->status);
  803. usb_buffer_free(hub->hdev, sizeof(*hub->buffer), hub->buffer,
  804. hub->buffer_dma);
  805. kref_put(&hub->kref, hub_release);
  806. }
  807. static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
  808. {
  809. struct usb_host_interface *desc;
  810. struct usb_endpoint_descriptor *endpoint;
  811. struct usb_device *hdev;
  812. struct usb_hub *hub;
  813. desc = intf->cur_altsetting;
  814. hdev = interface_to_usbdev(intf);
  815. #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
  816. if (hdev->parent) {
  817. dev_warn(&intf->dev, "ignoring external hub\n");
  818. return -ENODEV;
  819. }
  820. #endif
  821. /* Some hubs have a subclass of 1, which AFAICT according to the */
  822. /* specs is not defined, but it works */
  823. if ((desc->desc.bInterfaceSubClass != 0) &&
  824. (desc->desc.bInterfaceSubClass != 1)) {
  825. descriptor_error:
  826. dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
  827. return -EIO;
  828. }
  829. /* Multiple endpoints? What kind of mutant ninja-hub is this? */
  830. if (desc->desc.bNumEndpoints != 1)
  831. goto descriptor_error;
  832. endpoint = &desc->endpoint[0].desc;
  833. /* If it's not an interrupt in endpoint, we'd better punt! */
  834. if (!usb_endpoint_is_int_in(endpoint))
  835. goto descriptor_error;
  836. /* We found a hub */
  837. dev_info (&intf->dev, "USB hub found\n");
  838. hub = kzalloc(sizeof(*hub), GFP_KERNEL);
  839. if (!hub) {
  840. dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
  841. return -ENOMEM;
  842. }
  843. kref_init(&hub->kref);
  844. INIT_LIST_HEAD(&hub->event_list);
  845. hub->intfdev = &intf->dev;
  846. hub->hdev = hdev;
  847. INIT_DELAYED_WORK(&hub->leds, led_work);
  848. usb_get_intf(intf);
  849. usb_set_intfdata (intf, hub);
  850. intf->needs_remote_wakeup = 1;
  851. if (hdev->speed == USB_SPEED_HIGH)
  852. highspeed_hubs++;
  853. if (hub_configure(hub, endpoint) >= 0)
  854. return 0;
  855. hub_disconnect (intf);
  856. return -ENODEV;
  857. }
  858. static int
  859. hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
  860. {
  861. struct usb_device *hdev = interface_to_usbdev (intf);
  862. /* assert ifno == 0 (part of hub spec) */
  863. switch (code) {
  864. case USBDEVFS_HUB_PORTINFO: {
  865. struct usbdevfs_hub_portinfo *info = user_data;
  866. int i;
  867. spin_lock_irq(&device_state_lock);
  868. if (hdev->devnum <= 0)
  869. info->nports = 0;
  870. else {
  871. info->nports = hdev->maxchild;
  872. for (i = 0; i < info->nports; i++) {
  873. if (hdev->children[i] == NULL)
  874. info->port[i] = 0;
  875. else
  876. info->port[i] =
  877. hdev->children[i]->devnum;
  878. }
  879. }
  880. spin_unlock_irq(&device_state_lock);
  881. return info->nports + 1;
  882. }
  883. default:
  884. return -ENOSYS;
  885. }
  886. }
  887. static void recursively_mark_NOTATTACHED(struct usb_device *udev)
  888. {
  889. int i;
  890. for (i = 0; i < udev->maxchild; ++i) {
  891. if (udev->children[i])
  892. recursively_mark_NOTATTACHED(udev->children[i]);
  893. }
  894. if (udev->state == USB_STATE_SUSPENDED) {
  895. udev->discon_suspended = 1;
  896. udev->active_duration -= jiffies;
  897. }
  898. udev->state = USB_STATE_NOTATTACHED;
  899. }
  900. /**
  901. * usb_set_device_state - change a device's current state (usbcore, hcds)
  902. * @udev: pointer to device whose state should be changed
  903. * @new_state: new state value to be stored
  904. *
  905. * udev->state is _not_ fully protected by the device lock. Although
  906. * most transitions are made only while holding the lock, the state can
  907. * can change to USB_STATE_NOTATTACHED at almost any time. This
  908. * is so that devices can be marked as disconnected as soon as possible,
  909. * without having to wait for any semaphores to be released. As a result,
  910. * all changes to any device's state must be protected by the
  911. * device_state_lock spinlock.
  912. *
  913. * Once a device has been added to the device tree, all changes to its state
  914. * should be made using this routine. The state should _not_ be set directly.
  915. *
  916. * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
  917. * Otherwise udev->state is set to new_state, and if new_state is
  918. * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
  919. * to USB_STATE_NOTATTACHED.
  920. */
  921. void usb_set_device_state(struct usb_device *udev,
  922. enum usb_device_state new_state)
  923. {
  924. unsigned long flags;
  925. spin_lock_irqsave(&device_state_lock, flags);
  926. if (udev->state == USB_STATE_NOTATTACHED)
  927. ; /* do nothing */
  928. else if (new_state != USB_STATE_NOTATTACHED) {
  929. /* root hub wakeup capabilities are managed out-of-band
  930. * and may involve silicon errata ... ignore them here.
  931. */
  932. if (udev->parent) {
  933. if (udev->state == USB_STATE_SUSPENDED
  934. || new_state == USB_STATE_SUSPENDED)
  935. ; /* No change to wakeup settings */
  936. else if (new_state == USB_STATE_CONFIGURED)
  937. device_init_wakeup(&udev->dev,
  938. (udev->actconfig->desc.bmAttributes
  939. & USB_CONFIG_ATT_WAKEUP));
  940. else
  941. device_init_wakeup(&udev->dev, 0);
  942. }
  943. if (udev->state == USB_STATE_SUSPENDED &&
  944. new_state != USB_STATE_SUSPENDED)
  945. udev->active_duration -= jiffies;
  946. else if (new_state == USB_STATE_SUSPENDED &&
  947. udev->state != USB_STATE_SUSPENDED)
  948. udev->active_duration += jiffies;
  949. udev->state = new_state;
  950. } else
  951. recursively_mark_NOTATTACHED(udev);
  952. spin_unlock_irqrestore(&device_state_lock, flags);
  953. }
  954. static void choose_address(struct usb_device *udev)
  955. {
  956. int devnum;
  957. struct usb_bus *bus = udev->bus;
  958. /* If khubd ever becomes multithreaded, this will need a lock */
  959. /* Try to allocate the next devnum beginning at bus->devnum_next. */
  960. devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
  961. bus->devnum_next);
  962. if (devnum >= 128)
  963. devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
  964. bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
  965. if (devnum < 128) {
  966. set_bit(devnum, bus->devmap.devicemap);
  967. udev->devnum = devnum;
  968. }
  969. }
  970. static void release_address(struct usb_device *udev)
  971. {
  972. if (udev->devnum > 0) {
  973. clear_bit(udev->devnum, udev->bus->devmap.devicemap);
  974. udev->devnum = -1;
  975. }
  976. }
  977. #ifdef CONFIG_USB_SUSPEND
  978. static void usb_stop_pm(struct usb_device *udev)
  979. {
  980. /* Synchronize with the ksuspend thread to prevent any more
  981. * autosuspend requests from being submitted, and decrement
  982. * the parent's count of unsuspended children.
  983. */
  984. usb_pm_lock(udev);
  985. if (udev->parent && !udev->discon_suspended)
  986. usb_autosuspend_device(udev->parent);
  987. usb_pm_unlock(udev);
  988. /* Stop any autosuspend requests already submitted */
  989. cancel_rearming_delayed_work(&udev->autosuspend);
  990. }
  991. #else
  992. static inline void usb_stop_pm(struct usb_device *udev)
  993. { }
  994. #endif
  995. /**
  996. * usb_disconnect - disconnect a device (usbcore-internal)
  997. * @pdev: pointer to device being disconnected
  998. * Context: !in_interrupt ()
  999. *
  1000. * Something got disconnected. Get rid of it and all of its children.
  1001. *
  1002. * If *pdev is a normal device then the parent hub must already be locked.
  1003. * If *pdev is a root hub then this routine will acquire the
  1004. * usb_bus_list_lock on behalf of the caller.
  1005. *
  1006. * Only hub drivers (including virtual root hub drivers for host
  1007. * controllers) should ever call this.
  1008. *
  1009. * This call is synchronous, and may not be used in an interrupt context.
  1010. */
  1011. void usb_disconnect(struct usb_device **pdev)
  1012. {
  1013. struct usb_device *udev = *pdev;
  1014. int i;
  1015. if (!udev) {
  1016. pr_debug ("%s nodev\n", __FUNCTION__);
  1017. return;
  1018. }
  1019. /* mark the device as inactive, so any further urb submissions for
  1020. * this device (and any of its children) will fail immediately.
  1021. * this quiesces everyting except pending urbs.
  1022. */
  1023. usb_set_device_state(udev, USB_STATE_NOTATTACHED);
  1024. dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
  1025. usb_lock_device(udev);
  1026. /* Free up all the children before we remove this device */
  1027. for (i = 0; i < USB_MAXCHILDREN; i++) {
  1028. if (udev->children[i])
  1029. usb_disconnect(&udev->children[i]);
  1030. }
  1031. /* deallocate hcd/hardware state ... nuking all pending urbs and
  1032. * cleaning up all state associated with the current configuration
  1033. * so that the hardware is now fully quiesced.
  1034. */
  1035. dev_dbg (&udev->dev, "unregistering device\n");
  1036. usb_disable_device(udev, 0);
  1037. usb_unlock_device(udev);
  1038. /* Unregister the device. The device driver is responsible
  1039. * for removing the device files from usbfs and sysfs and for
  1040. * de-configuring the device.
  1041. */
  1042. device_del(&udev->dev);
  1043. /* Free the device number and delete the parent's children[]
  1044. * (or root_hub) pointer.
  1045. */
  1046. release_address(udev);
  1047. /* Avoid races with recursively_mark_NOTATTACHED() */
  1048. spin_lock_irq(&device_state_lock);
  1049. *pdev = NULL;
  1050. spin_unlock_irq(&device_state_lock);
  1051. usb_stop_pm(udev);
  1052. put_device(&udev->dev);
  1053. }
  1054. #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
  1055. static void show_string(struct usb_device *udev, char *id, char *string)
  1056. {
  1057. if (!string)
  1058. return;
  1059. dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
  1060. }
  1061. static void announce_device(struct usb_device *udev)
  1062. {
  1063. dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
  1064. le16_to_cpu(udev->descriptor.idVendor),
  1065. le16_to_cpu(udev->descriptor.idProduct));
  1066. dev_info(&udev->dev, "New USB device strings: Mfr=%d, Product=%d, "
  1067. "SerialNumber=%d\n",
  1068. udev->descriptor.iManufacturer,
  1069. udev->descriptor.iProduct,
  1070. udev->descriptor.iSerialNumber);
  1071. show_string(udev, "Product", udev->product);
  1072. show_string(udev, "Manufacturer", udev->manufacturer);
  1073. show_string(udev, "SerialNumber", udev->serial);
  1074. }
  1075. #else
  1076. static inline void announce_device(struct usb_device *udev) { }
  1077. #endif
  1078. #ifdef CONFIG_USB_OTG
  1079. #include "otg_whitelist.h"
  1080. #endif
  1081. /**
  1082. * usb_configure_device_otg - FIXME (usbcore-internal)
  1083. * @udev: newly addressed device (in ADDRESS state)
  1084. *
  1085. * Do configuration for On-The-Go devices
  1086. */
  1087. static int usb_configure_device_otg(struct usb_device *udev)
  1088. {
  1089. int err = 0;
  1090. #ifdef CONFIG_USB_OTG
  1091. /*
  1092. * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
  1093. * to wake us after we've powered off VBUS; and HNP, switching roles
  1094. * "host" to "peripheral". The OTG descriptor helps figure this out.
  1095. */
  1096. if (!udev->bus->is_b_host
  1097. && udev->config
  1098. && udev->parent == udev->bus->root_hub) {
  1099. struct usb_otg_descriptor *desc = 0;
  1100. struct usb_bus *bus = udev->bus;
  1101. /* descriptor may appear anywhere in config */
  1102. if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
  1103. le16_to_cpu(udev->config[0].desc.wTotalLength),
  1104. USB_DT_OTG, (void **) &desc) == 0) {
  1105. if (desc->bmAttributes & USB_OTG_HNP) {
  1106. unsigned port1 = udev->portnum;
  1107. dev_info(&udev->dev,
  1108. "Dual-Role OTG device on %sHNP port\n",
  1109. (port1 == bus->otg_port)
  1110. ? "" : "non-");
  1111. /* enable HNP before suspend, it's simpler */
  1112. if (port1 == bus->otg_port)
  1113. bus->b_hnp_enable = 1;
  1114. err = usb_control_msg(udev,
  1115. usb_sndctrlpipe(udev, 0),
  1116. USB_REQ_SET_FEATURE, 0,
  1117. bus->b_hnp_enable
  1118. ? USB_DEVICE_B_HNP_ENABLE
  1119. : USB_DEVICE_A_ALT_HNP_SUPPORT,
  1120. 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
  1121. if (err < 0) {
  1122. /* OTG MESSAGE: report errors here,
  1123. * customize to match your product.
  1124. */
  1125. dev_info(&udev->dev,
  1126. "can't set HNP mode; %d\n",
  1127. err);
  1128. bus->b_hnp_enable = 0;
  1129. }
  1130. }
  1131. }
  1132. }
  1133. if (!is_targeted(udev)) {
  1134. /* Maybe it can talk to us, though we can't talk to it.
  1135. * (Includes HNP test device.)
  1136. */
  1137. if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
  1138. err = usb_port_suspend(udev);
  1139. if (err < 0)
  1140. dev_dbg(&udev->dev, "HNP fail, %d\n", err);
  1141. }
  1142. err = -ENOTSUPP;
  1143. goto fail;
  1144. }
  1145. fail:
  1146. #endif
  1147. return err;
  1148. }
  1149. /**
  1150. * usb_configure_device - Detect and probe device intfs/otg (usbcore-internal)
  1151. * @udev: newly addressed device (in ADDRESS state)
  1152. *
  1153. * This is only called by usb_new_device() and usb_authorize_device()
  1154. * and FIXME -- all comments that apply to them apply here wrt to
  1155. * environment.
  1156. *
  1157. * If the device is WUSB and not authorized, we don't attempt to read
  1158. * the string descriptors, as they will be errored out by the device
  1159. * until it has been authorized.
  1160. */
  1161. static int usb_configure_device(struct usb_device *udev)
  1162. {
  1163. int err;
  1164. if (udev->config == NULL) {
  1165. err = usb_get_configuration(udev);
  1166. if (err < 0) {
  1167. dev_err(&udev->dev, "can't read configurations, error %d\n",
  1168. err);
  1169. goto fail;
  1170. }
  1171. }
  1172. if (udev->wusb == 1 && udev->authorized == 0) {
  1173. udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
  1174. udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
  1175. udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
  1176. }
  1177. else {
  1178. /* read the standard strings and cache them if present */
  1179. udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
  1180. udev->manufacturer = usb_cache_string(udev,
  1181. udev->descriptor.iManufacturer);
  1182. udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
  1183. }
  1184. err = usb_configure_device_otg(udev);
  1185. fail:
  1186. return err;
  1187. }
  1188. /**
  1189. * usb_new_device - perform initial device setup (usbcore-internal)
  1190. * @udev: newly addressed device (in ADDRESS state)
  1191. *
  1192. * This is called with devices which have been enumerated, but not yet
  1193. * configured. The device descriptor is available, but not descriptors
  1194. * for any device configuration. The caller must have locked either
  1195. * the parent hub (if udev is a normal device) or else the
  1196. * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
  1197. * udev has already been installed, but udev is not yet visible through
  1198. * sysfs or other filesystem code.
  1199. *
  1200. * It will return if the device is configured properly or not. Zero if
  1201. * the interface was registered with the driver core; else a negative
  1202. * errno value.
  1203. *
  1204. * This call is synchronous, and may not be used in an interrupt context.
  1205. *
  1206. * Only the hub driver or root-hub registrar should ever call this.
  1207. */
  1208. int usb_new_device(struct usb_device *udev)
  1209. {
  1210. int err;
  1211. usb_detect_quirks(udev); /* Determine quirks */
  1212. err = usb_configure_device(udev); /* detect & probe dev/intfs */
  1213. if (err < 0)
  1214. goto fail;
  1215. /* export the usbdev device-node for libusb */
  1216. udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
  1217. (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
  1218. /* Increment the parent's count of unsuspended children */
  1219. if (udev->parent)
  1220. usb_autoresume_device(udev->parent);
  1221. /* Register the device. The device driver is responsible
  1222. * for adding the device files to sysfs and for configuring
  1223. * the device.
  1224. */
  1225. err = device_add(&udev->dev);
  1226. if (err) {
  1227. dev_err(&udev->dev, "can't device_add, error %d\n", err);
  1228. goto fail;
  1229. }
  1230. /* Tell the world! */
  1231. announce_device(udev);
  1232. return err;
  1233. fail:
  1234. usb_set_device_state(udev, USB_STATE_NOTATTACHED);
  1235. return err;
  1236. }
  1237. /**
  1238. * usb_deauthorize_device - deauthorize a device (usbcore-internal)
  1239. * @usb_dev: USB device
  1240. *
  1241. * Move the USB device to a very basic state where interfaces are disabled
  1242. * and the device is in fact unconfigured and unusable.
  1243. *
  1244. * We share a lock (that we have) with device_del(), so we need to
  1245. * defer its call.
  1246. */
  1247. int usb_deauthorize_device(struct usb_device *usb_dev)
  1248. {
  1249. unsigned cnt;
  1250. usb_lock_device(usb_dev);
  1251. if (usb_dev->authorized == 0)
  1252. goto out_unauthorized;
  1253. usb_dev->authorized = 0;
  1254. usb_set_configuration(usb_dev, -1);
  1255. usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
  1256. usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
  1257. usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
  1258. kfree(usb_dev->config);
  1259. usb_dev->config = NULL;
  1260. for (cnt = 0; cnt < usb_dev->descriptor.bNumConfigurations; cnt++)
  1261. kfree(usb_dev->rawdescriptors[cnt]);
  1262. usb_dev->descriptor.bNumConfigurations = 0;
  1263. kfree(usb_dev->rawdescriptors);
  1264. out_unauthorized:
  1265. usb_unlock_device(usb_dev);
  1266. return 0;
  1267. }
  1268. int usb_authorize_device(struct usb_device *usb_dev)
  1269. {
  1270. int result = 0, c;
  1271. usb_lock_device(usb_dev);
  1272. if (usb_dev->authorized == 1)
  1273. goto out_authorized;
  1274. kfree(usb_dev->product);
  1275. usb_dev->product = NULL;
  1276. kfree(usb_dev->manufacturer);
  1277. usb_dev->manufacturer = NULL;
  1278. kfree(usb_dev->serial);
  1279. usb_dev->serial = NULL;
  1280. result = usb_autoresume_device(usb_dev);
  1281. if (result < 0) {
  1282. dev_err(&usb_dev->dev,
  1283. "can't autoresume for authorization: %d\n", result);
  1284. goto error_autoresume;
  1285. }
  1286. result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
  1287. if (result < 0) {
  1288. dev_err(&usb_dev->dev, "can't re-read device descriptor for "
  1289. "authorization: %d\n", result);
  1290. goto error_device_descriptor;
  1291. }
  1292. usb_dev->authorized = 1;
  1293. result = usb_configure_device(usb_dev);
  1294. if (result < 0)
  1295. goto error_configure;
  1296. /* Choose and set the configuration. This registers the interfaces
  1297. * with the driver core and lets interface drivers bind to them.
  1298. */
  1299. c = usb_choose_configuration(usb_dev);
  1300. if (c >= 0) {
  1301. result = usb_set_configuration(usb_dev, c);
  1302. if (result) {
  1303. dev_err(&usb_dev->dev,
  1304. "can't set config #%d, error %d\n", c, result);
  1305. /* This need not be fatal. The user can try to
  1306. * set other configurations. */
  1307. }
  1308. }
  1309. dev_info(&usb_dev->dev, "authorized to connect\n");
  1310. error_configure:
  1311. error_device_descriptor:
  1312. error_autoresume:
  1313. out_authorized:
  1314. usb_unlock_device(usb_dev); // complements locktree
  1315. return result;
  1316. }
  1317. static int hub_port_status(struct usb_hub *hub, int port1,
  1318. u16 *status, u16 *change)
  1319. {
  1320. int ret;
  1321. mutex_lock(&hub->status_mutex);
  1322. ret = get_port_status(hub->hdev, port1, &hub->status->port);
  1323. if (ret < 4) {
  1324. dev_err (hub->intfdev,
  1325. "%s failed (err = %d)\n", __FUNCTION__, ret);
  1326. if (ret >= 0)
  1327. ret = -EIO;
  1328. } else {
  1329. *status = le16_to_cpu(hub->status->port.wPortStatus);
  1330. *change = le16_to_cpu(hub->status->port.wPortChange);
  1331. ret = 0;
  1332. }
  1333. mutex_unlock(&hub->status_mutex);
  1334. return ret;
  1335. }
  1336. /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
  1337. static unsigned hub_is_wusb(struct usb_hub *hub)
  1338. {
  1339. struct usb_hcd *hcd;
  1340. if (hub->hdev->parent != NULL) /* not a root hub? */
  1341. return 0;
  1342. hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
  1343. return hcd->wireless;
  1344. }
  1345. #define PORT_RESET_TRIES 5
  1346. #define SET_ADDRESS_TRIES 2
  1347. #define GET_DESCRIPTOR_TRIES 2
  1348. #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
  1349. #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
  1350. #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
  1351. #define HUB_SHORT_RESET_TIME 10
  1352. #define HUB_LONG_RESET_TIME 200
  1353. #define HUB_RESET_TIMEOUT 500
  1354. static int hub_port_wait_reset(struct usb_hub *hub, int port1,
  1355. struct usb_device *udev, unsigned int delay)
  1356. {
  1357. int delay_time, ret;
  1358. u16 portstatus;
  1359. u16 portchange;
  1360. for (delay_time = 0;
  1361. delay_time < HUB_RESET_TIMEOUT;
  1362. delay_time += delay) {
  1363. /* wait to give the device a chance to reset */
  1364. msleep(delay);
  1365. /* read and decode port status */
  1366. ret = hub_port_status(hub, port1, &portstatus, &portchange);
  1367. if (ret < 0)
  1368. return ret;
  1369. /* Device went away? */
  1370. if (!(portstatus & USB_PORT_STAT_CONNECTION))
  1371. return -ENOTCONN;
  1372. /* bomb out completely if the connection bounced */
  1373. if ((portchange & USB_PORT_STAT_C_CONNECTION))
  1374. return -ENOTCONN;
  1375. /* if we`ve finished resetting, then break out of the loop */
  1376. if (!(portstatus & USB_PORT_STAT_RESET) &&
  1377. (portstatus & USB_PORT_STAT_ENABLE)) {
  1378. if (hub_is_wusb(hub))
  1379. udev->speed = USB_SPEED_VARIABLE;
  1380. else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
  1381. udev->speed = USB_SPEED_HIGH;
  1382. else if (portstatus & USB_PORT_STAT_LOW_SPEED)
  1383. udev->speed = USB_SPEED_LOW;
  1384. else
  1385. udev->speed = USB_SPEED_FULL;
  1386. return 0;
  1387. }
  1388. /* switch to the long delay after two short delay failures */
  1389. if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
  1390. delay = HUB_LONG_RESET_TIME;
  1391. dev_dbg (hub->intfdev,
  1392. "port %d not reset yet, waiting %dms\n",
  1393. port1, delay);
  1394. }
  1395. return -EBUSY;
  1396. }
  1397. static int hub_port_reset(struct usb_hub *hub, int port1,
  1398. struct usb_device *udev, unsigned int delay)
  1399. {
  1400. int i, status;
  1401. /* Block EHCI CF initialization during the port reset.
  1402. * Some companion controllers don't like it when they mix.
  1403. */
  1404. down_read(&ehci_cf_port_reset_rwsem);
  1405. /* Reset the port */
  1406. for (i = 0; i < PORT_RESET_TRIES; i++) {
  1407. status = set_port_feature(hub->hdev,
  1408. port1, USB_PORT_FEAT_RESET);
  1409. if (status)
  1410. dev_err(hub->intfdev,
  1411. "cannot reset port %d (err = %d)\n",
  1412. port1, status);
  1413. else {
  1414. status = hub_port_wait_reset(hub, port1, udev, delay);
  1415. if (status && status != -ENOTCONN)
  1416. dev_dbg(hub->intfdev,
  1417. "port_wait_reset: err = %d\n",
  1418. status);
  1419. }
  1420. /* return on disconnect or reset */
  1421. switch (status) {
  1422. case 0:
  1423. /* TRSTRCY = 10 ms; plus some extra */
  1424. msleep(10 + 40);
  1425. udev->devnum = 0; /* Device now at address 0 */
  1426. /* FALL THROUGH */
  1427. case -ENOTCONN:
  1428. case -ENODEV:
  1429. clear_port_feature(hub->hdev,
  1430. port1, USB_PORT_FEAT_C_RESET);
  1431. /* FIXME need disconnect() for NOTATTACHED device */
  1432. usb_set_device_state(udev, status
  1433. ? USB_STATE_NOTATTACHED
  1434. : USB_STATE_DEFAULT);
  1435. goto done;
  1436. }
  1437. dev_dbg (hub->intfdev,
  1438. "port %d not enabled, trying reset again...\n",
  1439. port1);
  1440. delay = HUB_LONG_RESET_TIME;
  1441. }
  1442. dev_err (hub->intfdev,
  1443. "Cannot enable port %i. Maybe the USB cable is bad?\n",
  1444. port1);
  1445. done:
  1446. up_read(&ehci_cf_port_reset_rwsem);
  1447. return status;
  1448. }
  1449. #ifdef CONFIG_PM
  1450. #ifdef CONFIG_USB_SUSPEND
  1451. /*
  1452. * usb_port_suspend - suspend a usb device's upstream port
  1453. * @udev: device that's no longer in active use, not a root hub
  1454. * Context: must be able to sleep; device not locked; pm locks held
  1455. *
  1456. * Suspends a USB device that isn't in active use, conserving power.
  1457. * Devices may wake out of a suspend, if anything important happens,
  1458. * using the remote wakeup mechanism. They may also be taken out of
  1459. * suspend by the host, using usb_port_resume(). It's also routine
  1460. * to disconnect devices while they are suspended.
  1461. *
  1462. * This only affects the USB hardware for a device; its interfaces
  1463. * (and, for hubs, child devices) must already have been suspended.
  1464. *
  1465. * Selective port suspend reduces power; most suspended devices draw
  1466. * less than 500 uA. It's also used in OTG, along with remote wakeup.
  1467. * All devices below the suspended port are also suspended.
  1468. *
  1469. * Devices leave suspend state when the host wakes them up. Some devices
  1470. * also support "remote wakeup", where the device can activate the USB
  1471. * tree above them to deliver data, such as a keypress or packet. In
  1472. * some cases, this wakes the USB host.
  1473. *
  1474. * Suspending OTG devices may trigger HNP, if that's been enabled
  1475. * between a pair of dual-role devices. That will change roles, such
  1476. * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
  1477. *
  1478. * Devices on USB hub ports have only one "suspend" state, corresponding
  1479. * to ACPI D2, "may cause the device to lose some context".
  1480. * State transitions include:
  1481. *
  1482. * - suspend, resume ... when the VBUS power link stays live
  1483. * - suspend, disconnect ... VBUS lost
  1484. *
  1485. * Once VBUS drop breaks the circuit, the port it's using has to go through
  1486. * normal re-enumeration procedures, starting with enabling VBUS power.
  1487. * Other than re-initializing the hub (plug/unplug, except for root hubs),
  1488. * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
  1489. * timer, no SRP, no requests through sysfs.
  1490. *
  1491. * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
  1492. * the root hub for their bus goes into global suspend ... so we don't
  1493. * (falsely) update the device power state to say it suspended.
  1494. *
  1495. * Returns 0 on success, else negative errno.
  1496. */
  1497. int usb_port_suspend(struct usb_device *udev)
  1498. {
  1499. struct usb_hub *hub = hdev_to_hub(udev->parent);
  1500. int port1 = udev->portnum;
  1501. int status;
  1502. // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
  1503. /* enable remote wakeup when appropriate; this lets the device
  1504. * wake up the upstream hub (including maybe the root hub).
  1505. *
  1506. * NOTE: OTG devices may issue remote wakeup (or SRP) even when
  1507. * we don't explicitly enable it here.
  1508. */
  1509. if (udev->do_remote_wakeup) {
  1510. status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  1511. USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
  1512. USB_DEVICE_REMOTE_WAKEUP, 0,
  1513. NULL, 0,
  1514. USB_CTRL_SET_TIMEOUT);
  1515. if (status)
  1516. dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
  1517. status);
  1518. }
  1519. /* see 7.1.7.6 */
  1520. status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
  1521. if (status) {
  1522. dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
  1523. port1, status);
  1524. /* paranoia: "should not happen" */
  1525. (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  1526. USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
  1527. USB_DEVICE_REMOTE_WAKEUP, 0,
  1528. NULL, 0,
  1529. USB_CTRL_SET_TIMEOUT);
  1530. } else {
  1531. /* device has up to 10 msec to fully suspend */
  1532. dev_dbg(&udev->dev, "usb %ssuspend\n",
  1533. udev->auto_pm ? "auto-" : "");
  1534. usb_set_device_state(udev, USB_STATE_SUSPENDED);
  1535. msleep(10);
  1536. }
  1537. return status;
  1538. }
  1539. /*
  1540. * If the USB "suspend" state is in use (rather than "global suspend"),
  1541. * many devices will be individually taken out of suspend state using
  1542. * special "resume" signaling. This routine kicks in shortly after
  1543. * hardware resume signaling is finished, either because of selective
  1544. * resume (by host) or remote wakeup (by device) ... now see what changed
  1545. * in the tree that's rooted at this device.
  1546. *
  1547. * If @udev->reset_resume is set then the device is reset before the
  1548. * status check is done.
  1549. */
  1550. static int finish_port_resume(struct usb_device *udev)
  1551. {
  1552. int status = 0;
  1553. u16 devstatus;
  1554. /* caller owns the udev device lock */
  1555. dev_dbg(&udev->dev, "finish %sresume\n",
  1556. udev->reset_resume ? "reset-" : "");
  1557. /* usb ch9 identifies four variants of SUSPENDED, based on what
  1558. * state the device resumes to. Linux currently won't see the
  1559. * first two on the host side; they'd be inside hub_port_init()
  1560. * during many timeouts, but khubd can't suspend until later.
  1561. */
  1562. usb_set_device_state(udev, udev->actconfig
  1563. ? USB_STATE_CONFIGURED
  1564. : USB_STATE_ADDRESS);
  1565. /* 10.5.4.5 says not to reset a suspended port if the attached
  1566. * device is enabled for remote wakeup. Hence the reset
  1567. * operation is carried out here, after the port has been
  1568. * resumed.
  1569. */
  1570. if (udev->reset_resume)
  1571. status = usb_reset_device(udev);
  1572. /* 10.5.4.5 says be sure devices in the tree are still there.
  1573. * For now let's assume the device didn't go crazy on resume,
  1574. * and device drivers will know about any resume quirks.
  1575. */
  1576. if (status == 0) {
  1577. devstatus = 0;
  1578. status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
  1579. if (status >= 0)
  1580. status = (status > 0 ? 0 : -ENODEV);
  1581. }
  1582. if (status) {
  1583. dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
  1584. status);
  1585. } else if (udev->actconfig) {
  1586. le16_to_cpus(&devstatus);
  1587. if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
  1588. status = usb_control_msg(udev,
  1589. usb_sndctrlpipe(udev, 0),
  1590. USB_REQ_CLEAR_FEATURE,
  1591. USB_RECIP_DEVICE,
  1592. USB_DEVICE_REMOTE_WAKEUP, 0,
  1593. NULL, 0,
  1594. USB_CTRL_SET_TIMEOUT);
  1595. if (status)
  1596. dev_dbg(&udev->dev, "disable remote "
  1597. "wakeup, status %d\n", status);
  1598. }
  1599. status = 0;
  1600. }
  1601. return status;
  1602. }
  1603. /*
  1604. * usb_port_resume - re-activate a suspended usb device's upstream port
  1605. * @udev: device to re-activate, not a root hub
  1606. * Context: must be able to sleep; device not locked; pm locks held
  1607. *
  1608. * This will re-activate the suspended device, increasing power usage
  1609. * while letting drivers communicate again with its endpoints.
  1610. * USB resume explicitly guarantees that the power session between
  1611. * the host and the device is the same as it was when the device
  1612. * suspended.
  1613. *
  1614. * If CONFIG_USB_PERSIST and @udev->reset_resume are both set then this
  1615. * routine won't check that the port is still enabled. Furthermore,
  1616. * if @udev->reset_resume is set then finish_port_resume() above will
  1617. * reset @udev. The end result is that a broken power session can be
  1618. * recovered and @udev will appear to persist across a loss of VBUS power.
  1619. *
  1620. * For example, if a host controller doesn't maintain VBUS suspend current
  1621. * during a system sleep or is reset when the system wakes up, all the USB
  1622. * power sessions below it will be broken. This is especially troublesome
  1623. * for mass-storage devices containing mounted filesystems, since the
  1624. * device will appear to have disconnected and all the memory mappings
  1625. * to it will be lost. Using the USB_PERSIST facility, the device can be
  1626. * made to appear as if it had not disconnected.
  1627. *
  1628. * This facility is inherently dangerous. Although usb_reset_device()
  1629. * makes every effort to insure that the same device is present after the
  1630. * reset as before, it cannot provide a 100% guarantee. Furthermore it's
  1631. * quite possible for a device to remain unaltered but its media to be
  1632. * changed. If the user replaces a flash memory card while the system is
  1633. * asleep, he will have only himself to blame when the filesystem on the
  1634. * new card is corrupted and the system crashes.
  1635. *
  1636. * Returns 0 on success, else negative errno.
  1637. */
  1638. int usb_port_resume(struct usb_device *udev)
  1639. {
  1640. struct usb_hub *hub = hdev_to_hub(udev->parent);
  1641. int port1 = udev->portnum;
  1642. int status;
  1643. u16 portchange, portstatus;
  1644. unsigned mask_flags, want_flags;
  1645. /* Skip the initial Clear-Suspend step for a remote wakeup */
  1646. status = hub_port_status(hub, port1, &portstatus, &portchange);
  1647. if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
  1648. goto SuspendCleared;
  1649. // dev_dbg(hub->intfdev, "resume port %d\n", port1);
  1650. set_bit(port1, hub->busy_bits);
  1651. /* see 7.1.7.7; affects power usage, but not budgeting */
  1652. status = clear_port_feature(hub->hdev,
  1653. port1, USB_PORT_FEAT_SUSPEND);
  1654. if (status) {
  1655. dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
  1656. port1, status);
  1657. } else {
  1658. /* drive resume for at least 20 msec */
  1659. dev_dbg(&udev->dev, "usb %sresume\n",
  1660. udev->auto_pm ? "auto-" : "");
  1661. msleep(25);
  1662. /* Virtual root hubs can trigger on GET_PORT_STATUS to
  1663. * stop resume signaling. Then finish the resume
  1664. * sequence.
  1665. */
  1666. status = hub_port_status(hub, port1, &portstatus, &portchange);
  1667. SuspendCleared:
  1668. if (USB_PERSIST && udev->reset_resume)
  1669. want_flags = USB_PORT_STAT_POWER
  1670. | USB_PORT_STAT_CONNECTION;
  1671. else
  1672. want_flags = USB_PORT_STAT_POWER
  1673. | USB_PORT_STAT_CONNECTION
  1674. | USB_PORT_STAT_ENABLE;
  1675. mask_flags = want_flags | USB_PORT_STAT_SUSPEND;
  1676. if (status < 0 || (portstatus & mask_flags) != want_flags) {
  1677. dev_dbg(hub->intfdev,
  1678. "port %d status %04x.%04x after resume, %d\n",
  1679. port1, portchange, portstatus, status);
  1680. if (status >= 0)
  1681. status = -ENODEV;
  1682. } else {
  1683. if (portchange & USB_PORT_STAT_C_SUSPEND)
  1684. clear_port_feature(hub->hdev, port1,
  1685. USB_PORT_FEAT_C_SUSPEND);
  1686. /* TRSMRCY = 10 msec */
  1687. msleep(10);
  1688. }
  1689. }
  1690. clear_bit(port1, hub->busy_bits);
  1691. if (!hub->hdev->parent && !hub->busy_bits[0])
  1692. usb_enable_root_hub_irq(hub->hdev->bus);
  1693. if (status == 0)
  1694. status = finish_port_resume(udev);
  1695. if (status < 0) {
  1696. dev_dbg(&udev->dev, "can't resume, status %d\n", status);
  1697. hub_port_logical_disconnect(hub, port1);
  1698. }
  1699. return status;
  1700. }
  1701. static int remote_wakeup(struct usb_device *udev)
  1702. {
  1703. int status = 0;
  1704. usb_lock_device(udev);
  1705. if (udev->state == USB_STATE_SUSPENDED) {
  1706. dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
  1707. usb_mark_last_busy(udev);
  1708. status = usb_external_resume_device(udev);
  1709. }
  1710. usb_unlock_device(udev);
  1711. return status;
  1712. }
  1713. #else /* CONFIG_USB_SUSPEND */
  1714. /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
  1715. int usb_port_suspend(struct usb_device *udev)
  1716. {
  1717. return 0;
  1718. }
  1719. int usb_port_resume(struct usb_device *udev)
  1720. {
  1721. int status = 0;
  1722. /* However we may need to do a reset-resume */
  1723. if (udev->reset_resume) {
  1724. dev_dbg(&udev->dev, "reset-resume\n");
  1725. status = usb_reset_device(udev);
  1726. }
  1727. return status;
  1728. }
  1729. static inline int remote_wakeup(struct usb_device *udev)
  1730. {
  1731. return 0;
  1732. }
  1733. #endif
  1734. static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
  1735. {
  1736. struct usb_hub *hub = usb_get_intfdata (intf);
  1737. struct usb_device *hdev = hub->hdev;
  1738. unsigned port1;
  1739. /* fail if children aren't already suspended */
  1740. for (port1 = 1; port1 <= hdev->maxchild; port1++) {
  1741. struct usb_device *udev;
  1742. udev = hdev->children [port1-1];
  1743. if (udev && udev->can_submit) {
  1744. if (!hdev->auto_pm)
  1745. dev_dbg(&intf->dev, "port %d nyet suspended\n",
  1746. port1);
  1747. return -EBUSY;
  1748. }
  1749. }
  1750. dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
  1751. /* stop khubd and related activity */
  1752. hub_quiesce(hub);
  1753. return 0;
  1754. }
  1755. static int hub_resume(struct usb_interface *intf)
  1756. {
  1757. struct usb_hub *hub = usb_get_intfdata (intf);
  1758. dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
  1759. /* tell khubd to look for changes on this hub */
  1760. hub_activate(hub);
  1761. return 0;
  1762. }
  1763. static int hub_reset_resume(struct usb_interface *intf)
  1764. {
  1765. struct usb_hub *hub = usb_get_intfdata(intf);
  1766. struct usb_device *hdev = hub->hdev;
  1767. int port1;
  1768. hub_power_on(hub);
  1769. for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
  1770. struct usb_device *child = hdev->children[port1-1];
  1771. if (child) {
  1772. /* For "USB_PERSIST"-enabled children we must
  1773. * mark the child device for reset-resume and
  1774. * turn off the connect-change status to prevent
  1775. * khubd from disconnecting it later.
  1776. */
  1777. if (USB_PERSIST && child->persist_enabled) {
  1778. child->reset_resume = 1;
  1779. clear_port_feature(hdev, port1,
  1780. USB_PORT_FEAT_C_CONNECTION);
  1781. /* Otherwise we must disconnect the child,
  1782. * but as we may not lock the child device here
  1783. * we have to do a "logical" disconnect.
  1784. */
  1785. } else {
  1786. hub_port_logical_disconnect(hub, port1);
  1787. }
  1788. }
  1789. }
  1790. hub_activate(hub);
  1791. return 0;
  1792. }
  1793. /**
  1794. * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
  1795. * @rhdev: struct usb_device for the root hub
  1796. *
  1797. * The USB host controller driver calls this function when its root hub
  1798. * is resumed and Vbus power has been interrupted or the controller
  1799. * has been reset. The routine marks @rhdev as having lost power. When
  1800. * the hub driver is resumed it will take notice; if CONFIG_USB_PERSIST
  1801. * is enabled then it will carry out power-session recovery, otherwise
  1802. * it will disconnect all the child devices.
  1803. */
  1804. void usb_root_hub_lost_power(struct usb_device *rhdev)
  1805. {
  1806. dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
  1807. rhdev->reset_resume = 1;
  1808. }
  1809. EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
  1810. #else /* CONFIG_PM */
  1811. static inline int remote_wakeup(struct usb_device *udev)
  1812. {
  1813. return 0;
  1814. }
  1815. #define hub_suspend NULL
  1816. #define hub_resume NULL
  1817. #define hub_reset_resume NULL
  1818. #endif
  1819. /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
  1820. *
  1821. * Between connect detection and reset signaling there must be a delay
  1822. * of 100ms at least for debounce and power-settling. The corresponding
  1823. * timer shall restart whenever the downstream port detects a disconnect.
  1824. *
  1825. * Apparently there are some bluetooth and irda-dongles and a number of
  1826. * low-speed devices for which this debounce period may last over a second.
  1827. * Not covered by the spec - but easy to deal with.
  1828. *
  1829. * This implementation uses a 1500ms total debounce timeout; if the
  1830. * connection isn't stable by then it returns -ETIMEDOUT. It checks
  1831. * every 25ms for transient disconnects. When the port status has been
  1832. * unchanged for 100ms it returns the port status.
  1833. */
  1834. #define HUB_DEBOUNCE_TIMEOUT 1500
  1835. #define HUB_DEBOUNCE_STEP 25
  1836. #define HUB_DEBOUNCE_STABLE 100
  1837. static int hub_port_debounce(struct usb_hub *hub, int port1)
  1838. {
  1839. int ret;
  1840. int total_time, stable_time = 0;
  1841. u16 portchange, portstatus;
  1842. unsigned connection = 0xffff;
  1843. for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
  1844. ret = hub_port_status(hub, port1, &portstatus, &portchange);
  1845. if (ret < 0)
  1846. return ret;
  1847. if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
  1848. (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
  1849. stable_time += HUB_DEBOUNCE_STEP;
  1850. if (stable_time >= HUB_DEBOUNCE_STABLE)
  1851. break;
  1852. } else {
  1853. stable_time = 0;
  1854. connection = portstatus & USB_PORT_STAT_CONNECTION;
  1855. }
  1856. if (portchange & USB_PORT_STAT_C_CONNECTION) {
  1857. clear_port_feature(hub->hdev, port1,
  1858. USB_PORT_FEAT_C_CONNECTION);
  1859. }
  1860. if (total_time >= HUB_DEBOUNCE_TIMEOUT)
  1861. break;
  1862. msleep(HUB_DEBOUNCE_STEP);
  1863. }
  1864. dev_dbg (hub->intfdev,
  1865. "debounce: port %d: total %dms stable %dms status 0x%x\n",
  1866. port1, total_time, stable_time, portstatus);
  1867. if (stable_time < HUB_DEBOUNCE_STABLE)
  1868. return -ETIMEDOUT;
  1869. return portstatus;
  1870. }
  1871. static void ep0_reinit(struct usb_device *udev)
  1872. {
  1873. usb_disable_endpoint(udev, 0 + USB_DIR_IN);
  1874. usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
  1875. usb_enable_endpoint(udev, &udev->ep0);
  1876. }
  1877. #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
  1878. #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
  1879. static int hub_set_address(struct usb_device *udev, int devnum)
  1880. {
  1881. int retval;
  1882. if (devnum <= 1)
  1883. return -EINVAL;
  1884. if (udev->state == USB_STATE_ADDRESS)
  1885. return 0;
  1886. if (udev->state != USB_STATE_DEFAULT)
  1887. return -EINVAL;
  1888. retval = usb_control_msg(udev, usb_sndaddr0pipe(),
  1889. USB_REQ_SET_ADDRESS, 0, devnum, 0,
  1890. NULL, 0, USB_CTRL_SET_TIMEOUT);
  1891. if (retval == 0) {
  1892. udev->devnum = devnum; /* Device now using proper address */
  1893. usb_set_device_state(udev, USB_STATE_ADDRESS);
  1894. ep0_reinit(udev);
  1895. }
  1896. return retval;
  1897. }
  1898. /* Reset device, (re)assign address, get device descriptor.
  1899. * Device connection must be stable, no more debouncing needed.
  1900. * Returns device in USB_STATE_ADDRESS, except on error.
  1901. *
  1902. * If this is called for an already-existing device (as part of
  1903. * usb_reset_device), the caller must own the device lock. For a
  1904. * newly detected device that is not accessible through any global
  1905. * pointers, it's not necessary to lock the device.
  1906. */
  1907. static int
  1908. hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
  1909. int retry_counter)
  1910. {
  1911. static DEFINE_MUTEX(usb_address0_mutex);
  1912. struct usb_device *hdev = hub->hdev;
  1913. int i, j, retval;
  1914. unsigned delay = HUB_SHORT_RESET_TIME;
  1915. enum usb_device_speed oldspeed = udev->speed;
  1916. char *speed, *type;
  1917. int devnum = udev->devnum;
  1918. /* root hub ports have a slightly longer reset period
  1919. * (from USB 2.0 spec, section 7.1.7.5)
  1920. */
  1921. if (!hdev->parent) {
  1922. delay = HUB_ROOT_RESET_TIME;
  1923. if (port1 == hdev->bus->otg_port)
  1924. hdev->bus->b_hnp_enable = 0;
  1925. }
  1926. /* Some low speed devices have problems with the quick delay, so */
  1927. /* be a bit pessimistic with those devices. RHbug #23670 */
  1928. if (oldspeed == USB_SPEED_LOW)
  1929. delay = HUB_LONG_RESET_TIME;
  1930. mutex_lock(&usb_address0_mutex);
  1931. /* Reset the device; full speed may morph to high speed */
  1932. retval = hub_port_reset(hub, port1, udev, delay);
  1933. if (retval < 0) /* error or disconnect */
  1934. goto fail;
  1935. /* success, speed is known */
  1936. retval = -ENODEV;
  1937. if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
  1938. dev_dbg(&udev->dev, "device reset changed speed!\n");
  1939. goto fail;
  1940. }
  1941. oldspeed = udev->speed;
  1942. /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
  1943. * it's fixed size except for full speed devices.
  1944. * For Wireless USB devices, ep0 max packet is always 512 (tho
  1945. * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
  1946. */
  1947. switch (udev->speed) {
  1948. case USB_SPEED_VARIABLE: /* fixed at 512 */
  1949. udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
  1950. break;
  1951. case USB_SPEED_HIGH: /* fixed at 64 */
  1952. udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
  1953. break;
  1954. case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
  1955. /* to determine the ep0 maxpacket size, try to read
  1956. * the device descriptor to get bMaxPacketSize0 and
  1957. * then correct our initial guess.
  1958. */
  1959. udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
  1960. break;
  1961. case USB_SPEED_LOW: /* fixed at 8 */
  1962. udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
  1963. break;
  1964. default:
  1965. goto fail;
  1966. }
  1967. type = "";
  1968. switch (udev->speed) {
  1969. case USB_SPEED_LOW: speed = "low"; break;
  1970. case USB_SPEED_FULL: speed = "full"; break;
  1971. case USB_SPEED_HIGH: speed = "high"; break;
  1972. case USB_SPEED_VARIABLE:
  1973. speed = "variable";
  1974. type = "Wireless ";
  1975. break;
  1976. default: speed = "?"; break;
  1977. }
  1978. dev_info (&udev->dev,
  1979. "%s %s speed %sUSB device using %s and address %d\n",
  1980. (udev->config) ? "reset" : "new", speed, type,
  1981. udev->bus->controller->driver->name, devnum);
  1982. /* Set up TT records, if needed */
  1983. if (hdev->tt) {
  1984. udev->tt = hdev->tt;
  1985. udev->ttport = hdev->ttport;
  1986. } else if (udev->speed != USB_SPEED_HIGH
  1987. && hdev->speed == USB_SPEED_HIGH) {
  1988. udev->tt = &hub->tt;
  1989. udev->ttport = port1;
  1990. }
  1991. /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
  1992. * Because device hardware and firmware is sometimes buggy in
  1993. * this area, and this is how Linux has done it for ages.
  1994. * Change it cautiously.
  1995. *
  1996. * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
  1997. * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
  1998. * so it may help with some non-standards-compliant devices.
  1999. * Otherwise we start with SET_ADDRESS and then try to read the
  2000. * first 8 bytes of the device descriptor to get the ep0 maxpacket
  2001. * value.
  2002. */
  2003. for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
  2004. if (USE_NEW_SCHEME(retry_counter)) {
  2005. struct usb_device_descriptor *buf;
  2006. int r = 0;
  2007. #define GET_DESCRIPTOR_BUFSIZE 64
  2008. buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
  2009. if (!buf) {
  2010. retval = -ENOMEM;
  2011. continue;
  2012. }
  2013. /* Retry on all errors; some devices are flakey.
  2014. * 255 is for WUSB devices, we actually need to use
  2015. * 512 (WUSB1.0[4.8.1]).
  2016. */
  2017. for (j = 0; j < 3; ++j) {
  2018. buf->bMaxPacketSize0 = 0;
  2019. r = usb_control_msg(udev, usb_rcvaddr0pipe(),
  2020. USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
  2021. USB_DT_DEVICE << 8, 0,
  2022. buf, GET_DESCRIPTOR_BUFSIZE,
  2023. USB_CTRL_GET_TIMEOUT);
  2024. switch (buf->bMaxPacketSize0) {
  2025. case 8: case 16: case 32: case 64: case 255:
  2026. if (buf->bDescriptorType ==
  2027. USB_DT_DEVICE) {
  2028. r = 0;
  2029. break;
  2030. }
  2031. /* FALL THROUGH */
  2032. default:
  2033. if (r == 0)
  2034. r = -EPROTO;
  2035. break;
  2036. }
  2037. if (r == 0)
  2038. break;
  2039. }
  2040. udev->descriptor.bMaxPacketSize0 =
  2041. buf->bMaxPacketSize0;
  2042. kfree(buf);
  2043. retval = hub_port_reset(hub, port1, udev, delay);
  2044. if (retval < 0) /* error or disconnect */
  2045. goto fail;
  2046. if (oldspeed != udev->speed) {
  2047. dev_dbg(&udev->dev,
  2048. "device reset changed speed!\n");
  2049. retval = -ENODEV;
  2050. goto fail;
  2051. }
  2052. if (r) {
  2053. dev_err(&udev->dev, "device descriptor "
  2054. "read/%s, error %d\n",
  2055. "64", r);
  2056. retval = -EMSGSIZE;
  2057. continue;
  2058. }
  2059. #undef GET_DESCRIPTOR_BUFSIZE
  2060. }
  2061. for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
  2062. retval = hub_set_address(udev, devnum);
  2063. if (retval >= 0)
  2064. break;
  2065. msleep(200);
  2066. }
  2067. if (retval < 0) {
  2068. dev_err(&udev->dev,
  2069. "device not accepting address %d, error %d\n",
  2070. devnum, retval);
  2071. goto fail;
  2072. }
  2073. /* cope with hardware quirkiness:
  2074. * - let SET_ADDRESS settle, some device hardware wants it
  2075. * - read ep0 maxpacket even for high and low speed,
  2076. */
  2077. msleep(10);
  2078. if (USE_NEW_SCHEME(retry_counter))
  2079. break;
  2080. retval = usb_get_device_descriptor(udev, 8);
  2081. if (retval < 8) {
  2082. dev_err(&udev->dev, "device descriptor "
  2083. "read/%s, error %d\n",
  2084. "8", retval);
  2085. if (retval >= 0)
  2086. retval = -EMSGSIZE;
  2087. } else {
  2088. retval = 0;
  2089. break;
  2090. }
  2091. }
  2092. if (retval)
  2093. goto fail;
  2094. i = udev->descriptor.bMaxPacketSize0 == 0xff?
  2095. 512 : udev->descriptor.bMaxPacketSize0;
  2096. if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
  2097. if (udev->speed != USB_SPEED_FULL ||
  2098. !(i == 8 || i == 16 || i == 32 || i == 64)) {
  2099. dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
  2100. retval = -EMSGSIZE;
  2101. goto fail;
  2102. }
  2103. dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
  2104. udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
  2105. ep0_reinit(udev);
  2106. }
  2107. retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
  2108. if (retval < (signed)sizeof(udev->descriptor)) {
  2109. dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
  2110. "all", retval);
  2111. if (retval >= 0)
  2112. retval = -ENOMSG;
  2113. goto fail;
  2114. }
  2115. retval = 0;
  2116. fail:
  2117. if (retval) {
  2118. hub_port_disable(hub, port1, 0);
  2119. udev->devnum = devnum; /* for disconnect processing */
  2120. }
  2121. mutex_unlock(&usb_address0_mutex);
  2122. return retval;
  2123. }
  2124. static void
  2125. check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
  2126. {
  2127. struct usb_qualifier_descriptor *qual;
  2128. int status;
  2129. qual = kmalloc (sizeof *qual, GFP_KERNEL);
  2130. if (qual == NULL)
  2131. return;
  2132. status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
  2133. qual, sizeof *qual);
  2134. if (status == sizeof *qual) {
  2135. dev_info(&udev->dev, "not running at top speed; "
  2136. "connect to a high speed hub\n");
  2137. /* hub LEDs are probably harder to miss than syslog */
  2138. if (hub->has_indicators) {
  2139. hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
  2140. schedule_delayed_work (&hub->leds, 0);
  2141. }
  2142. }
  2143. kfree(qual);
  2144. }
  2145. static unsigned
  2146. hub_power_remaining (struct usb_hub *hub)
  2147. {
  2148. struct usb_device *hdev = hub->hdev;
  2149. int remaining;
  2150. int port1;
  2151. if (!hub->limited_power)
  2152. return 0;
  2153. remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
  2154. for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
  2155. struct usb_device *udev = hdev->children[port1 - 1];
  2156. int delta;
  2157. if (!udev)
  2158. continue;
  2159. /* Unconfigured devices may not use more than 100mA,
  2160. * or 8mA for OTG ports */
  2161. if (udev->actconfig)
  2162. delta = udev->actconfig->desc.bMaxPower * 2;
  2163. else if (port1 != udev->bus->otg_port || hdev->parent)
  2164. delta = 100;
  2165. else
  2166. delta = 8;
  2167. if (delta > hub->mA_per_port)
  2168. dev_warn(&udev->dev, "%dmA is over %umA budget "
  2169. "for port %d!\n",
  2170. delta, hub->mA_per_port, port1);
  2171. remaining -= delta;
  2172. }
  2173. if (remaining < 0) {
  2174. dev_warn(hub->intfdev, "%dmA over power budget!\n",
  2175. - remaining);
  2176. remaining = 0;
  2177. }
  2178. return remaining;
  2179. }
  2180. /* Handle physical or logical connection change events.
  2181. * This routine is called when:
  2182. * a port connection-change occurs;
  2183. * a port enable-change occurs (often caused by EMI);
  2184. * usb_reset_device() encounters changed descriptors (as from
  2185. * a firmware download)
  2186. * caller already locked the hub
  2187. */
  2188. static void hub_port_connect_change(struct usb_hub *hub, int port1,
  2189. u16 portstatus, u16 portchange)
  2190. {
  2191. struct usb_device *hdev = hub->hdev;
  2192. struct device *hub_dev = hub->intfdev;
  2193. struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
  2194. u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
  2195. int status, i;
  2196. dev_dbg (hub_dev,
  2197. "port %d, status %04x, change %04x, %s\n",
  2198. port1, portstatus, portchange, portspeed (portstatus));
  2199. if (hub->has_indicators) {
  2200. set_port_led(hub, port1, HUB_LED_AUTO);
  2201. hub->indicator[port1-1] = INDICATOR_AUTO;
  2202. }
  2203. /* Disconnect any existing devices under this port */
  2204. if (hdev->children[port1-1])
  2205. usb_disconnect(&hdev->children[port1-1]);
  2206. clear_bit(port1, hub->change_bits);
  2207. #ifdef CONFIG_USB_OTG
  2208. /* during HNP, don't repeat the debounce */
  2209. if (hdev->bus->is_b_host)
  2210. portchange &= ~USB_PORT_STAT_C_CONNECTION;
  2211. #endif
  2212. if (portchange & USB_PORT_STAT_C_CONNECTION) {
  2213. status = hub_port_debounce(hub, port1);
  2214. if (status < 0) {
  2215. if (printk_ratelimit())
  2216. dev_err (hub_dev, "connect-debounce failed, "
  2217. "port %d disabled\n", port1);
  2218. goto done;
  2219. }
  2220. portstatus = status;
  2221. }
  2222. /* Return now if nothing is connected */
  2223. if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
  2224. /* maybe switch power back on (e.g. root hub was reset) */
  2225. if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
  2226. && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
  2227. set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
  2228. if (portstatus & USB_PORT_STAT_ENABLE)
  2229. goto done;
  2230. return;
  2231. }
  2232. for (i = 0; i < SET_CONFIG_TRIES; i++) {
  2233. struct usb_device *udev;
  2234. /* reallocate for each attempt, since references
  2235. * to the previous one can escape in various ways
  2236. */
  2237. udev = usb_alloc_dev(hdev, hdev->bus, port1);
  2238. if (!udev) {
  2239. dev_err (hub_dev,
  2240. "couldn't allocate port %d usb_device\n",
  2241. port1);
  2242. goto done;
  2243. }
  2244. usb_set_device_state(udev, USB_STATE_POWERED);
  2245. udev->speed = USB_SPEED_UNKNOWN;
  2246. udev->bus_mA = hub->mA_per_port;
  2247. udev->level = hdev->level + 1;
  2248. /* set the address */
  2249. choose_address(udev);
  2250. if (udev->devnum <= 0) {
  2251. status = -ENOTCONN; /* Don't retry */
  2252. goto loop;
  2253. }
  2254. /* reset and get descriptor */
  2255. status = hub_port_init(hub, udev, port1, i);
  2256. if (status < 0)
  2257. goto loop;
  2258. /* consecutive bus-powered hubs aren't reliable; they can
  2259. * violate the voltage drop budget. if the new child has
  2260. * a "powered" LED, users should notice we didn't enable it
  2261. * (without reading syslog), even without per-port LEDs
  2262. * on the parent.
  2263. */
  2264. if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
  2265. && udev->bus_mA <= 100) {
  2266. u16 devstat;
  2267. status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
  2268. &devstat);
  2269. if (status < 2) {
  2270. dev_dbg(&udev->dev, "get status %d ?\n", status);
  2271. goto loop_disable;
  2272. }
  2273. le16_to_cpus(&devstat);
  2274. if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
  2275. dev_err(&udev->dev,
  2276. "can't connect bus-powered hub "
  2277. "to this port\n");
  2278. if (hub->has_indicators) {
  2279. hub->indicator[port1-1] =
  2280. INDICATOR_AMBER_BLINK;
  2281. schedule_delayed_work (&hub->leds, 0);
  2282. }
  2283. status = -ENOTCONN; /* Don't retry */
  2284. goto loop_disable;
  2285. }
  2286. }
  2287. /* check for devices running slower than they could */
  2288. if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
  2289. && udev->speed == USB_SPEED_FULL
  2290. && highspeed_hubs != 0)
  2291. check_highspeed (hub, udev, port1);
  2292. /* Store the parent's children[] pointer. At this point
  2293. * udev becomes globally accessible, although presumably
  2294. * no one will look at it until hdev is unlocked.
  2295. */
  2296. status = 0;
  2297. /* We mustn't add new devices if the parent hub has
  2298. * been disconnected; we would race with the
  2299. * recursively_mark_NOTATTACHED() routine.
  2300. */
  2301. spin_lock_irq(&device_state_lock);
  2302. if (hdev->state == USB_STATE_NOTATTACHED)
  2303. status = -ENOTCONN;
  2304. else
  2305. hdev->children[port1-1] = udev;
  2306. spin_unlock_irq(&device_state_lock);
  2307. /* Run it through the hoops (find a driver, etc) */
  2308. if (!status) {
  2309. status = usb_new_device(udev);
  2310. if (status) {
  2311. spin_lock_irq(&device_state_lock);
  2312. hdev->children[port1-1] = NULL;
  2313. spin_unlock_irq(&device_state_lock);
  2314. }
  2315. }
  2316. if (status)
  2317. goto loop_disable;
  2318. status = hub_power_remaining(hub);
  2319. if (status)
  2320. dev_dbg(hub_dev, "%dmA power budget left\n", status);
  2321. return;
  2322. loop_disable:
  2323. hub_port_disable(hub, port1, 1);
  2324. loop:
  2325. ep0_reinit(udev);
  2326. release_address(udev);
  2327. usb_put_dev(udev);
  2328. if ((status == -ENOTCONN) || (status == -ENOTSUPP))
  2329. break;
  2330. }
  2331. done:
  2332. hub_port_disable(hub, port1, 1);
  2333. if (hcd->driver->relinquish_port && !hub->hdev->parent)
  2334. hcd->driver->relinquish_port(hcd, port1);
  2335. }
  2336. static void hub_events(void)
  2337. {
  2338. struct list_head *tmp;
  2339. struct usb_device *hdev;
  2340. struct usb_interface *intf;
  2341. struct usb_hub *hub;
  2342. struct device *hub_dev;
  2343. u16 hubstatus;
  2344. u16 hubchange;
  2345. u16 portstatus;
  2346. u16 portchange;
  2347. int i, ret;
  2348. int connect_change;
  2349. /*
  2350. * We restart the list every time to avoid a deadlock with
  2351. * deleting hubs downstream from this one. This should be
  2352. * safe since we delete the hub from the event list.
  2353. * Not the most efficient, but avoids deadlocks.
  2354. */
  2355. while (1) {
  2356. /* Grab the first entry at the beginning of the list */
  2357. spin_lock_irq(&hub_event_lock);
  2358. if (list_empty(&hub_event_list)) {
  2359. spin_unlock_irq(&hub_event_lock);
  2360. break;
  2361. }
  2362. tmp = hub_event_list.next;
  2363. list_del_init(tmp);
  2364. hub = list_entry(tmp, struct usb_hub, event_list);
  2365. kref_get(&hub->kref);
  2366. spin_unlock_irq(&hub_event_lock);
  2367. hdev = hub->hdev;
  2368. hub_dev = hub->intfdev;
  2369. intf = to_usb_interface(hub_dev);
  2370. dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
  2371. hdev->state, hub->descriptor
  2372. ? hub->descriptor->bNbrPorts
  2373. : 0,
  2374. /* NOTE: expects max 15 ports... */
  2375. (u16) hub->change_bits[0],
  2376. (u16) hub->event_bits[0]);
  2377. /* Lock the device, then check to see if we were
  2378. * disconnected while waiting for the lock to succeed. */
  2379. usb_lock_device(hdev);
  2380. if (unlikely(hub->disconnected))
  2381. goto loop;
  2382. /* If the hub has died, clean up after it */
  2383. if (hdev->state == USB_STATE_NOTATTACHED) {
  2384. hub->error = -ENODEV;
  2385. hub_pre_reset(intf);
  2386. goto loop;
  2387. }
  2388. /* Autoresume */
  2389. ret = usb_autopm_get_interface(intf);
  2390. if (ret) {
  2391. dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
  2392. goto loop;
  2393. }
  2394. /* If this is an inactive hub, do nothing */
  2395. if (hub->quiescing)
  2396. goto loop_autopm;
  2397. if (hub->error) {
  2398. dev_dbg (hub_dev, "resetting for error %d\n",
  2399. hub->error);
  2400. ret = usb_reset_composite_device(hdev, intf);
  2401. if (ret) {
  2402. dev_dbg (hub_dev,
  2403. "error resetting hub: %d\n", ret);
  2404. goto loop_autopm;
  2405. }
  2406. hub->nerrors = 0;
  2407. hub->error = 0;
  2408. }
  2409. /* deal with port status changes */
  2410. for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
  2411. if (test_bit(i, hub->busy_bits))
  2412. continue;
  2413. connect_change = test_bit(i, hub->change_bits);
  2414. if (!test_and_clear_bit(i, hub->event_bits) &&
  2415. !connect_change && !hub->activating)
  2416. continue;
  2417. ret = hub_port_status(hub, i,
  2418. &portstatus, &portchange);
  2419. if (ret < 0)
  2420. continue;
  2421. if (hub->activating && !hdev->children[i-1] &&
  2422. (portstatus &
  2423. USB_PORT_STAT_CONNECTION))
  2424. connect_change = 1;
  2425. if (portchange & USB_PORT_STAT_C_CONNECTION) {
  2426. clear_port_feature(hdev, i,
  2427. USB_PORT_FEAT_C_CONNECTION);
  2428. connect_change = 1;
  2429. }
  2430. if (portchange & USB_PORT_STAT_C_ENABLE) {
  2431. if (!connect_change)
  2432. dev_dbg (hub_dev,
  2433. "port %d enable change, "
  2434. "status %08x\n",
  2435. i, portstatus);
  2436. clear_port_feature(hdev, i,
  2437. USB_PORT_FEAT_C_ENABLE);
  2438. /*
  2439. * EM interference sometimes causes badly
  2440. * shielded USB devices to be shutdown by
  2441. * the hub, this hack enables them again.
  2442. * Works at least with mouse driver.
  2443. */
  2444. if (!(portstatus & USB_PORT_STAT_ENABLE)
  2445. && !connect_change
  2446. && hdev->children[i-1]) {
  2447. dev_err (hub_dev,
  2448. "port %i "
  2449. "disabled by hub (EMI?), "
  2450. "re-enabling...\n",
  2451. i);
  2452. connect_change = 1;
  2453. }
  2454. }
  2455. if (portchange & USB_PORT_STAT_C_SUSPEND) {
  2456. clear_port_feature(hdev, i,
  2457. USB_PORT_FEAT_C_SUSPEND);
  2458. if (hdev->children[i-1]) {
  2459. ret = remote_wakeup(hdev->
  2460. children[i-1]);
  2461. if (ret < 0)
  2462. connect_change = 1;
  2463. } else {
  2464. ret = -ENODEV;
  2465. hub_port_disable(hub, i, 1);
  2466. }
  2467. dev_dbg (hub_dev,
  2468. "resume on port %d, status %d\n",
  2469. i, ret);
  2470. }
  2471. if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
  2472. dev_err (hub_dev,
  2473. "over-current change on port %d\n",
  2474. i);
  2475. clear_port_feature(hdev, i,
  2476. USB_PORT_FEAT_C_OVER_CURRENT);
  2477. hub_power_on(hub);
  2478. }
  2479. if (portchange & USB_PORT_STAT_C_RESET) {
  2480. dev_dbg (hub_dev,
  2481. "reset change on port %d\n",
  2482. i);
  2483. clear_port_feature(hdev, i,
  2484. USB_PORT_FEAT_C_RESET);
  2485. }
  2486. if (connect_change)
  2487. hub_port_connect_change(hub, i,
  2488. portstatus, portchange);
  2489. } /* end for i */
  2490. /* deal with hub status changes */
  2491. if (test_and_clear_bit(0, hub->event_bits) == 0)
  2492. ; /* do nothing */
  2493. else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
  2494. dev_err (hub_dev, "get_hub_status failed\n");
  2495. else {
  2496. if (hubchange & HUB_CHANGE_LOCAL_POWER) {
  2497. dev_dbg (hub_dev, "power change\n");
  2498. clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
  2499. if (hubstatus & HUB_STATUS_LOCAL_POWER)
  2500. /* FIXME: Is this always true? */
  2501. hub->limited_power = 1;
  2502. else
  2503. hub->limited_power = 0;
  2504. }
  2505. if (hubchange & HUB_CHANGE_OVERCURRENT) {
  2506. dev_dbg (hub_dev, "overcurrent change\n");
  2507. msleep(500); /* Cool down */
  2508. clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
  2509. hub_power_on(hub);
  2510. }
  2511. }
  2512. hub->activating = 0;
  2513. /* If this is a root hub, tell the HCD it's okay to
  2514. * re-enable port-change interrupts now. */
  2515. if (!hdev->parent && !hub->busy_bits[0])
  2516. usb_enable_root_hub_irq(hdev->bus);
  2517. loop_autopm:
  2518. /* Allow autosuspend if we're not going to run again */
  2519. if (list_empty(&hub->event_list))
  2520. usb_autopm_enable(intf);
  2521. loop:
  2522. usb_unlock_device(hdev);
  2523. kref_put(&hub->kref, hub_release);
  2524. } /* end while (1) */
  2525. }
  2526. static int hub_thread(void *__unused)
  2527. {
  2528. set_freezable();
  2529. do {
  2530. hub_events();
  2531. wait_event_freezable(khubd_wait,
  2532. !list_empty(&hub_event_list) ||
  2533. kthread_should_stop());
  2534. } while (!kthread_should_stop() || !list_empty(&hub_event_list));
  2535. pr_debug("%s: khubd exiting\n", usbcore_name);
  2536. return 0;
  2537. }
  2538. static struct usb_device_id hub_id_table [] = {
  2539. { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
  2540. .bDeviceClass = USB_CLASS_HUB},
  2541. { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
  2542. .bInterfaceClass = USB_CLASS_HUB},
  2543. { } /* Terminating entry */
  2544. };
  2545. MODULE_DEVICE_TABLE (usb, hub_id_table);
  2546. static struct usb_driver hub_driver = {
  2547. .name = "hub",
  2548. .probe = hub_probe,
  2549. .disconnect = hub_disconnect,
  2550. .suspend = hub_suspend,
  2551. .resume = hub_resume,
  2552. .reset_resume = hub_reset_resume,
  2553. .pre_reset = hub_pre_reset,
  2554. .post_reset = hub_post_reset,
  2555. .ioctl = hub_ioctl,
  2556. .id_table = hub_id_table,
  2557. .supports_autosuspend = 1,
  2558. };
  2559. int usb_hub_init(void)
  2560. {
  2561. if (usb_register(&hub_driver) < 0) {
  2562. printk(KERN_ERR "%s: can't register hub driver\n",
  2563. usbcore_name);
  2564. return -1;
  2565. }
  2566. khubd_task = kthread_run(hub_thread, NULL, "khubd");
  2567. if (!IS_ERR(khubd_task))
  2568. return 0;
  2569. /* Fall through if kernel_thread failed */
  2570. usb_deregister(&hub_driver);
  2571. printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
  2572. return -1;
  2573. }
  2574. void usb_hub_cleanup(void)
  2575. {
  2576. kthread_stop(khubd_task);
  2577. /*
  2578. * Hub resources are freed for us by usb_deregister. It calls
  2579. * usb_driver_purge on every device which in turn calls that
  2580. * devices disconnect function if it is using this driver.
  2581. * The hub_disconnect function takes care of releasing the
  2582. * individual hub resources. -greg
  2583. */
  2584. usb_deregister(&hub_driver);
  2585. } /* usb_hub_cleanup() */
  2586. static int config_descriptors_changed(struct usb_device *udev)
  2587. {
  2588. unsigned index;
  2589. unsigned len = 0;
  2590. struct usb_config_descriptor *buf;
  2591. for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
  2592. if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
  2593. len = le16_to_cpu(udev->config[index].desc.wTotalLength);
  2594. }
  2595. buf = kmalloc(len, GFP_NOIO);
  2596. if (buf == NULL) {
  2597. dev_err(&udev->dev, "no mem to re-read configs after reset\n");
  2598. /* assume the worst */
  2599. return 1;
  2600. }
  2601. for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
  2602. int length;
  2603. int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
  2604. length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
  2605. old_length);
  2606. if (length < old_length) {
  2607. dev_dbg(&udev->dev, "config index %d, error %d\n",
  2608. index, length);
  2609. break;
  2610. }
  2611. if (memcmp (buf, udev->rawdescriptors[index], old_length)
  2612. != 0) {
  2613. dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
  2614. index, buf->bConfigurationValue);
  2615. break;
  2616. }
  2617. }
  2618. kfree(buf);
  2619. return index != udev->descriptor.bNumConfigurations;
  2620. }
  2621. /**
  2622. * usb_reset_device - perform a USB port reset to reinitialize a device
  2623. * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
  2624. *
  2625. * WARNING - don't use this routine to reset a composite device
  2626. * (one with multiple interfaces owned by separate drivers)!
  2627. * Use usb_reset_composite_device() instead.
  2628. *
  2629. * Do a port reset, reassign the device's address, and establish its
  2630. * former operating configuration. If the reset fails, or the device's
  2631. * descriptors change from their values before the reset, or the original
  2632. * configuration and altsettings cannot be restored, a flag will be set
  2633. * telling khubd to pretend the device has been disconnected and then
  2634. * re-connected. All drivers will be unbound, and the device will be
  2635. * re-enumerated and probed all over again.
  2636. *
  2637. * Returns 0 if the reset succeeded, -ENODEV if the device has been
  2638. * flagged for logical disconnection, or some other negative error code
  2639. * if the reset wasn't even attempted.
  2640. *
  2641. * The caller must own the device lock. For example, it's safe to use
  2642. * this from a driver probe() routine after downloading new firmware.
  2643. * For calls that might not occur during probe(), drivers should lock
  2644. * the device using usb_lock_device_for_reset().
  2645. *
  2646. * Locking exception: This routine may also be called from within an
  2647. * autoresume handler. Such usage won't conflict with other tasks
  2648. * holding the device lock because these tasks should always call
  2649. * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
  2650. */
  2651. int usb_reset_device(struct usb_device *udev)
  2652. {
  2653. struct usb_device *parent_hdev = udev->parent;
  2654. struct usb_hub *parent_hub;
  2655. struct usb_device_descriptor descriptor = udev->descriptor;
  2656. int i, ret = 0;
  2657. int port1 = udev->portnum;
  2658. if (udev->state == USB_STATE_NOTATTACHED ||
  2659. udev->state == USB_STATE_SUSPENDED) {
  2660. dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
  2661. udev->state);
  2662. return -EINVAL;
  2663. }
  2664. if (!parent_hdev) {
  2665. /* this requires hcd-specific logic; see OHCI hc_restart() */
  2666. dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
  2667. return -EISDIR;
  2668. }
  2669. parent_hub = hdev_to_hub(parent_hdev);
  2670. set_bit(port1, parent_hub->busy_bits);
  2671. for (i = 0; i < SET_CONFIG_TRIES; ++i) {
  2672. /* ep0 maxpacket size may change; let the HCD know about it.
  2673. * Other endpoints will be handled by re-enumeration. */
  2674. ep0_reinit(udev);
  2675. ret = hub_port_init(parent_hub, udev, port1, i);
  2676. if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
  2677. break;
  2678. }
  2679. clear_bit(port1, parent_hub->busy_bits);
  2680. if (!parent_hdev->parent && !parent_hub->busy_bits[0])
  2681. usb_enable_root_hub_irq(parent_hdev->bus);
  2682. if (ret < 0)
  2683. goto re_enumerate;
  2684. /* Device might have changed firmware (DFU or similar) */
  2685. if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
  2686. || config_descriptors_changed (udev)) {
  2687. dev_info(&udev->dev, "device firmware changed\n");
  2688. udev->descriptor = descriptor; /* for disconnect() calls */
  2689. goto re_enumerate;
  2690. }
  2691. if (!udev->actconfig)
  2692. goto done;
  2693. ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  2694. USB_REQ_SET_CONFIGURATION, 0,
  2695. udev->actconfig->desc.bConfigurationValue, 0,
  2696. NULL, 0, USB_CTRL_SET_TIMEOUT);
  2697. if (ret < 0) {
  2698. dev_err(&udev->dev,
  2699. "can't restore configuration #%d (error=%d)\n",
  2700. udev->actconfig->desc.bConfigurationValue, ret);
  2701. goto re_enumerate;
  2702. }
  2703. usb_set_device_state(udev, USB_STATE_CONFIGURED);
  2704. for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
  2705. struct usb_interface *intf = udev->actconfig->interface[i];
  2706. struct usb_interface_descriptor *desc;
  2707. /* set_interface resets host side toggle even
  2708. * for altsetting zero. the interface may have no driver.
  2709. */
  2710. desc = &intf->cur_altsetting->desc;
  2711. ret = usb_set_interface(udev, desc->bInterfaceNumber,
  2712. desc->bAlternateSetting);
  2713. if (ret < 0) {
  2714. dev_err(&udev->dev, "failed to restore interface %d "
  2715. "altsetting %d (error=%d)\n",
  2716. desc->bInterfaceNumber,
  2717. desc->bAlternateSetting,
  2718. ret);
  2719. goto re_enumerate;
  2720. }
  2721. }
  2722. done:
  2723. return 0;
  2724. re_enumerate:
  2725. hub_port_logical_disconnect(parent_hub, port1);
  2726. return -ENODEV;
  2727. }
  2728. EXPORT_SYMBOL_GPL(usb_reset_device);
  2729. /**
  2730. * usb_reset_composite_device - warn interface drivers and perform a USB port reset
  2731. * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
  2732. * @iface: interface bound to the driver making the request (optional)
  2733. *
  2734. * Warns all drivers bound to registered interfaces (using their pre_reset
  2735. * method), performs the port reset, and then lets the drivers know that
  2736. * the reset is over (using their post_reset method).
  2737. *
  2738. * Return value is the same as for usb_reset_device().
  2739. *
  2740. * The caller must own the device lock. For example, it's safe to use
  2741. * this from a driver probe() routine after downloading new firmware.
  2742. * For calls that might not occur during probe(), drivers should lock
  2743. * the device using usb_lock_device_for_reset().
  2744. */
  2745. int usb_reset_composite_device(struct usb_device *udev,
  2746. struct usb_interface *iface)
  2747. {
  2748. int ret;
  2749. int i;
  2750. struct usb_host_config *config = udev->actconfig;
  2751. if (udev->state == USB_STATE_NOTATTACHED ||
  2752. udev->state == USB_STATE_SUSPENDED) {
  2753. dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
  2754. udev->state);
  2755. return -EINVAL;
  2756. }
  2757. /* Prevent autosuspend during the reset */
  2758. usb_autoresume_device(udev);
  2759. if (iface && iface->condition != USB_INTERFACE_BINDING)
  2760. iface = NULL;
  2761. if (config) {
  2762. for (i = 0; i < config->desc.bNumInterfaces; ++i) {
  2763. struct usb_interface *cintf = config->interface[i];
  2764. struct usb_driver *drv;
  2765. if (cintf->dev.driver) {
  2766. drv = to_usb_driver(cintf->dev.driver);
  2767. if (drv->pre_reset)
  2768. (drv->pre_reset)(cintf);
  2769. /* FIXME: Unbind if pre_reset returns an error or isn't defined */
  2770. }
  2771. }
  2772. }
  2773. ret = usb_reset_device(udev);
  2774. if (config) {
  2775. for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
  2776. struct usb_interface *cintf = config->interface[i];
  2777. struct usb_driver *drv;
  2778. if (cintf->dev.driver) {
  2779. drv = to_usb_driver(cintf->dev.driver);
  2780. if (drv->post_reset)
  2781. (drv->post_reset)(cintf);
  2782. /* FIXME: Unbind if post_reset returns an error or isn't defined */
  2783. }
  2784. }
  2785. }
  2786. usb_autosuspend_device(udev);
  2787. return ret;
  2788. }
  2789. EXPORT_SYMBOL_GPL(usb_reset_composite_device);