hub.c 111 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948
  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/usb/hcd.h>
  22. #include <linux/usb/quirks.h>
  23. #include <linux/kthread.h>
  24. #include <linux/mutex.h>
  25. #include <linux/freezer.h>
  26. #include <asm/uaccess.h>
  27. #include <asm/byteorder.h>
  28. #include "usb.h"
  29. /* if we are in debug mode, always announce new devices */
  30. #ifdef DEBUG
  31. #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
  32. #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
  33. #endif
  34. #endif
  35. struct usb_hub {
  36. struct device *intfdev; /* the "interface" device */
  37. struct usb_device *hdev;
  38. struct kref kref;
  39. struct urb *urb; /* for interrupt polling pipe */
  40. /* buffer for urb ... with extra space in case of babble */
  41. char (*buffer)[8];
  42. union {
  43. struct usb_hub_status hub;
  44. struct usb_port_status port;
  45. } *status; /* buffer for status reports */
  46. struct mutex status_mutex; /* for the status buffer */
  47. int error; /* last reported error */
  48. int nerrors; /* track consecutive errors */
  49. struct list_head event_list; /* hubs w/data or errs ready */
  50. unsigned long event_bits[1]; /* status change bitmask */
  51. unsigned long change_bits[1]; /* ports with logical connect
  52. status change */
  53. unsigned long busy_bits[1]; /* ports being reset or
  54. resumed */
  55. unsigned long removed_bits[1]; /* ports with a "removed"
  56. device present */
  57. #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
  58. #error event_bits[] is too short!
  59. #endif
  60. struct usb_hub_descriptor *descriptor; /* class descriptor */
  61. struct usb_tt tt; /* Transaction Translator */
  62. unsigned mA_per_port; /* current for each child */
  63. unsigned limited_power:1;
  64. unsigned quiescing:1;
  65. unsigned disconnected:1;
  66. unsigned has_indicators:1;
  67. u8 indicator[USB_MAXCHILDREN];
  68. struct delayed_work leds;
  69. struct delayed_work init_work;
  70. void **port_owners;
  71. };
  72. static inline int hub_is_superspeed(struct usb_device *hdev)
  73. {
  74. return (hdev->descriptor.bDeviceProtocol == 3);
  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. * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
  92. * 10 seconds to send reply for the initial 64-byte descriptor request.
  93. */
  94. /* define initial 64-byte descriptor request timeout in milliseconds */
  95. static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
  96. module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
  97. MODULE_PARM_DESC(initial_descriptor_timeout,
  98. "initial 64-byte descriptor request timeout in milliseconds "
  99. "(default 5000 - 5.0 seconds)");
  100. /*
  101. * As of 2.6.10 we introduce a new USB device initialization scheme which
  102. * closely resembles the way Windows works. Hopefully it will be compatible
  103. * with a wider range of devices than the old scheme. However some previously
  104. * working devices may start giving rise to "device not accepting address"
  105. * errors; if that happens the user can try the old scheme by adjusting the
  106. * following module parameters.
  107. *
  108. * For maximum flexibility there are two boolean parameters to control the
  109. * hub driver's behavior. On the first initialization attempt, if the
  110. * "old_scheme_first" parameter is set then the old scheme will be used,
  111. * otherwise the new scheme is used. If that fails and "use_both_schemes"
  112. * is set, then the driver will make another attempt, using the other scheme.
  113. */
  114. static int old_scheme_first = 0;
  115. module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
  116. MODULE_PARM_DESC(old_scheme_first,
  117. "start with the old device initialization scheme");
  118. static int use_both_schemes = 1;
  119. module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
  120. MODULE_PARM_DESC(use_both_schemes,
  121. "try the other device initialization scheme if the "
  122. "first one fails");
  123. /* Mutual exclusion for EHCI CF initialization. This interferes with
  124. * port reset on some companion controllers.
  125. */
  126. DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
  127. EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
  128. #define HUB_DEBOUNCE_TIMEOUT 1500
  129. #define HUB_DEBOUNCE_STEP 25
  130. #define HUB_DEBOUNCE_STABLE 100
  131. static int usb_reset_and_verify_device(struct usb_device *udev);
  132. static inline char *portspeed(struct usb_hub *hub, int portstatus)
  133. {
  134. if (hub_is_superspeed(hub->hdev))
  135. return "5.0 Gb/s";
  136. if (portstatus & USB_PORT_STAT_HIGH_SPEED)
  137. return "480 Mb/s";
  138. else if (portstatus & USB_PORT_STAT_LOW_SPEED)
  139. return "1.5 Mb/s";
  140. else
  141. return "12 Mb/s";
  142. }
  143. /* Note that hdev or one of its children must be locked! */
  144. static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
  145. {
  146. if (!hdev || !hdev->actconfig)
  147. return NULL;
  148. return usb_get_intfdata(hdev->actconfig->interface[0]);
  149. }
  150. /* USB 2.0 spec Section 11.24.4.5 */
  151. static int get_hub_descriptor(struct usb_device *hdev, void *data)
  152. {
  153. int i, ret, size;
  154. unsigned dtype;
  155. if (hub_is_superspeed(hdev)) {
  156. dtype = USB_DT_SS_HUB;
  157. size = USB_DT_SS_HUB_SIZE;
  158. } else {
  159. dtype = USB_DT_HUB;
  160. size = sizeof(struct usb_hub_descriptor);
  161. }
  162. for (i = 0; i < 3; i++) {
  163. ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
  164. USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
  165. dtype << 8, 0, data, size,
  166. USB_CTRL_GET_TIMEOUT);
  167. if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
  168. return ret;
  169. }
  170. return -EINVAL;
  171. }
  172. /*
  173. * USB 2.0 spec Section 11.24.2.1
  174. */
  175. static int clear_hub_feature(struct usb_device *hdev, int feature)
  176. {
  177. return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
  178. USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
  179. }
  180. /*
  181. * USB 2.0 spec Section 11.24.2.2
  182. */
  183. static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
  184. {
  185. return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
  186. USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
  187. NULL, 0, 1000);
  188. }
  189. /*
  190. * USB 2.0 spec Section 11.24.2.13
  191. */
  192. static int set_port_feature(struct usb_device *hdev, int port1, int feature)
  193. {
  194. return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
  195. USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
  196. NULL, 0, 1000);
  197. }
  198. /*
  199. * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
  200. * for info about using port indicators
  201. */
  202. static void set_port_led(
  203. struct usb_hub *hub,
  204. int port1,
  205. int selector
  206. )
  207. {
  208. int status = set_port_feature(hub->hdev, (selector << 8) | port1,
  209. USB_PORT_FEAT_INDICATOR);
  210. if (status < 0)
  211. dev_dbg (hub->intfdev,
  212. "port %d indicator %s status %d\n",
  213. port1,
  214. ({ char *s; switch (selector) {
  215. case HUB_LED_AMBER: s = "amber"; break;
  216. case HUB_LED_GREEN: s = "green"; break;
  217. case HUB_LED_OFF: s = "off"; break;
  218. case HUB_LED_AUTO: s = "auto"; break;
  219. default: s = "??"; break;
  220. }; s; }),
  221. status);
  222. }
  223. #define LED_CYCLE_PERIOD ((2*HZ)/3)
  224. static void led_work (struct work_struct *work)
  225. {
  226. struct usb_hub *hub =
  227. container_of(work, struct usb_hub, leds.work);
  228. struct usb_device *hdev = hub->hdev;
  229. unsigned i;
  230. unsigned changed = 0;
  231. int cursor = -1;
  232. if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
  233. return;
  234. for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
  235. unsigned selector, mode;
  236. /* 30%-50% duty cycle */
  237. switch (hub->indicator[i]) {
  238. /* cycle marker */
  239. case INDICATOR_CYCLE:
  240. cursor = i;
  241. selector = HUB_LED_AUTO;
  242. mode = INDICATOR_AUTO;
  243. break;
  244. /* blinking green = sw attention */
  245. case INDICATOR_GREEN_BLINK:
  246. selector = HUB_LED_GREEN;
  247. mode = INDICATOR_GREEN_BLINK_OFF;
  248. break;
  249. case INDICATOR_GREEN_BLINK_OFF:
  250. selector = HUB_LED_OFF;
  251. mode = INDICATOR_GREEN_BLINK;
  252. break;
  253. /* blinking amber = hw attention */
  254. case INDICATOR_AMBER_BLINK:
  255. selector = HUB_LED_AMBER;
  256. mode = INDICATOR_AMBER_BLINK_OFF;
  257. break;
  258. case INDICATOR_AMBER_BLINK_OFF:
  259. selector = HUB_LED_OFF;
  260. mode = INDICATOR_AMBER_BLINK;
  261. break;
  262. /* blink green/amber = reserved */
  263. case INDICATOR_ALT_BLINK:
  264. selector = HUB_LED_GREEN;
  265. mode = INDICATOR_ALT_BLINK_OFF;
  266. break;
  267. case INDICATOR_ALT_BLINK_OFF:
  268. selector = HUB_LED_AMBER;
  269. mode = INDICATOR_ALT_BLINK;
  270. break;
  271. default:
  272. continue;
  273. }
  274. if (selector != HUB_LED_AUTO)
  275. changed = 1;
  276. set_port_led(hub, i + 1, selector);
  277. hub->indicator[i] = mode;
  278. }
  279. if (!changed && blinkenlights) {
  280. cursor++;
  281. cursor %= hub->descriptor->bNbrPorts;
  282. set_port_led(hub, cursor + 1, HUB_LED_GREEN);
  283. hub->indicator[cursor] = INDICATOR_CYCLE;
  284. changed++;
  285. }
  286. if (changed)
  287. schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
  288. }
  289. /* use a short timeout for hub/port status fetches */
  290. #define USB_STS_TIMEOUT 1000
  291. #define USB_STS_RETRIES 5
  292. /*
  293. * USB 2.0 spec Section 11.24.2.6
  294. */
  295. static int get_hub_status(struct usb_device *hdev,
  296. struct usb_hub_status *data)
  297. {
  298. int i, status = -ETIMEDOUT;
  299. for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
  300. status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
  301. USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
  302. data, sizeof(*data), USB_STS_TIMEOUT);
  303. }
  304. return status;
  305. }
  306. /*
  307. * USB 2.0 spec Section 11.24.2.7
  308. */
  309. static int get_port_status(struct usb_device *hdev, int port1,
  310. struct usb_port_status *data)
  311. {
  312. int i, status = -ETIMEDOUT;
  313. for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
  314. status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
  315. USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
  316. data, sizeof(*data), USB_STS_TIMEOUT);
  317. }
  318. return status;
  319. }
  320. static int hub_port_status(struct usb_hub *hub, int port1,
  321. u16 *status, u16 *change)
  322. {
  323. int ret;
  324. mutex_lock(&hub->status_mutex);
  325. ret = get_port_status(hub->hdev, port1, &hub->status->port);
  326. if (ret < 4) {
  327. dev_err(hub->intfdev,
  328. "%s failed (err = %d)\n", __func__, ret);
  329. if (ret >= 0)
  330. ret = -EIO;
  331. } else {
  332. *status = le16_to_cpu(hub->status->port.wPortStatus);
  333. *change = le16_to_cpu(hub->status->port.wPortChange);
  334. if ((hub->hdev->parent != NULL) &&
  335. hub_is_superspeed(hub->hdev)) {
  336. /* Translate the USB 3 port status */
  337. u16 tmp = *status & USB_SS_PORT_STAT_MASK;
  338. if (*status & USB_SS_PORT_STAT_POWER)
  339. tmp |= USB_PORT_STAT_POWER;
  340. *status = tmp;
  341. }
  342. ret = 0;
  343. }
  344. mutex_unlock(&hub->status_mutex);
  345. return ret;
  346. }
  347. static void kick_khubd(struct usb_hub *hub)
  348. {
  349. unsigned long flags;
  350. spin_lock_irqsave(&hub_event_lock, flags);
  351. if (!hub->disconnected && list_empty(&hub->event_list)) {
  352. list_add_tail(&hub->event_list, &hub_event_list);
  353. /* Suppress autosuspend until khubd runs */
  354. usb_autopm_get_interface_no_resume(
  355. to_usb_interface(hub->intfdev));
  356. wake_up(&khubd_wait);
  357. }
  358. spin_unlock_irqrestore(&hub_event_lock, flags);
  359. }
  360. void usb_kick_khubd(struct usb_device *hdev)
  361. {
  362. struct usb_hub *hub = hdev_to_hub(hdev);
  363. if (hub)
  364. kick_khubd(hub);
  365. }
  366. /* completion function, fires on port status changes and various faults */
  367. static void hub_irq(struct urb *urb)
  368. {
  369. struct usb_hub *hub = urb->context;
  370. int status = urb->status;
  371. unsigned i;
  372. unsigned long bits;
  373. switch (status) {
  374. case -ENOENT: /* synchronous unlink */
  375. case -ECONNRESET: /* async unlink */
  376. case -ESHUTDOWN: /* hardware going away */
  377. return;
  378. default: /* presumably an error */
  379. /* Cause a hub reset after 10 consecutive errors */
  380. dev_dbg (hub->intfdev, "transfer --> %d\n", status);
  381. if ((++hub->nerrors < 10) || hub->error)
  382. goto resubmit;
  383. hub->error = status;
  384. /* FALL THROUGH */
  385. /* let khubd handle things */
  386. case 0: /* we got data: port status changed */
  387. bits = 0;
  388. for (i = 0; i < urb->actual_length; ++i)
  389. bits |= ((unsigned long) ((*hub->buffer)[i]))
  390. << (i*8);
  391. hub->event_bits[0] = bits;
  392. break;
  393. }
  394. hub->nerrors = 0;
  395. /* Something happened, let khubd figure it out */
  396. kick_khubd(hub);
  397. resubmit:
  398. if (hub->quiescing)
  399. return;
  400. if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
  401. && status != -ENODEV && status != -EPERM)
  402. dev_err (hub->intfdev, "resubmit --> %d\n", status);
  403. }
  404. /* USB 2.0 spec Section 11.24.2.3 */
  405. static inline int
  406. hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
  407. {
  408. return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
  409. HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
  410. tt, NULL, 0, 1000);
  411. }
  412. /*
  413. * enumeration blocks khubd for a long time. we use keventd instead, since
  414. * long blocking there is the exception, not the rule. accordingly, HCDs
  415. * talking to TTs must queue control transfers (not just bulk and iso), so
  416. * both can talk to the same hub concurrently.
  417. */
  418. static void hub_tt_work(struct work_struct *work)
  419. {
  420. struct usb_hub *hub =
  421. container_of(work, struct usb_hub, tt.clear_work);
  422. unsigned long flags;
  423. int limit = 100;
  424. spin_lock_irqsave (&hub->tt.lock, flags);
  425. while (--limit && !list_empty (&hub->tt.clear_list)) {
  426. struct list_head *next;
  427. struct usb_tt_clear *clear;
  428. struct usb_device *hdev = hub->hdev;
  429. const struct hc_driver *drv;
  430. int status;
  431. next = hub->tt.clear_list.next;
  432. clear = list_entry (next, struct usb_tt_clear, clear_list);
  433. list_del (&clear->clear_list);
  434. /* drop lock so HCD can concurrently report other TT errors */
  435. spin_unlock_irqrestore (&hub->tt.lock, flags);
  436. status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
  437. if (status)
  438. dev_err (&hdev->dev,
  439. "clear tt %d (%04x) error %d\n",
  440. clear->tt, clear->devinfo, status);
  441. /* Tell the HCD, even if the operation failed */
  442. drv = clear->hcd->driver;
  443. if (drv->clear_tt_buffer_complete)
  444. (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
  445. kfree(clear);
  446. spin_lock_irqsave(&hub->tt.lock, flags);
  447. }
  448. spin_unlock_irqrestore (&hub->tt.lock, flags);
  449. }
  450. /**
  451. * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
  452. * @urb: an URB associated with the failed or incomplete split transaction
  453. *
  454. * High speed HCDs use this to tell the hub driver that some split control or
  455. * bulk transaction failed in a way that requires clearing internal state of
  456. * a transaction translator. This is normally detected (and reported) from
  457. * interrupt context.
  458. *
  459. * It may not be possible for that hub to handle additional full (or low)
  460. * speed transactions until that state is fully cleared out.
  461. */
  462. int usb_hub_clear_tt_buffer(struct urb *urb)
  463. {
  464. struct usb_device *udev = urb->dev;
  465. int pipe = urb->pipe;
  466. struct usb_tt *tt = udev->tt;
  467. unsigned long flags;
  468. struct usb_tt_clear *clear;
  469. /* we've got to cope with an arbitrary number of pending TT clears,
  470. * since each TT has "at least two" buffers that can need it (and
  471. * there can be many TTs per hub). even if they're uncommon.
  472. */
  473. if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
  474. dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
  475. /* FIXME recover somehow ... RESET_TT? */
  476. return -ENOMEM;
  477. }
  478. /* info that CLEAR_TT_BUFFER needs */
  479. clear->tt = tt->multi ? udev->ttport : 1;
  480. clear->devinfo = usb_pipeendpoint (pipe);
  481. clear->devinfo |= udev->devnum << 4;
  482. clear->devinfo |= usb_pipecontrol (pipe)
  483. ? (USB_ENDPOINT_XFER_CONTROL << 11)
  484. : (USB_ENDPOINT_XFER_BULK << 11);
  485. if (usb_pipein (pipe))
  486. clear->devinfo |= 1 << 15;
  487. /* info for completion callback */
  488. clear->hcd = bus_to_hcd(udev->bus);
  489. clear->ep = urb->ep;
  490. /* tell keventd to clear state for this TT */
  491. spin_lock_irqsave (&tt->lock, flags);
  492. list_add_tail (&clear->clear_list, &tt->clear_list);
  493. schedule_work(&tt->clear_work);
  494. spin_unlock_irqrestore (&tt->lock, flags);
  495. return 0;
  496. }
  497. EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
  498. /* If do_delay is false, return the number of milliseconds the caller
  499. * needs to delay.
  500. */
  501. static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
  502. {
  503. int port1;
  504. unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
  505. unsigned delay;
  506. u16 wHubCharacteristics =
  507. le16_to_cpu(hub->descriptor->wHubCharacteristics);
  508. /* Enable power on each port. Some hubs have reserved values
  509. * of LPSM (> 2) in their descriptors, even though they are
  510. * USB 2.0 hubs. Some hubs do not implement port-power switching
  511. * but only emulate it. In all cases, the ports won't work
  512. * unless we send these messages to the hub.
  513. */
  514. if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
  515. dev_dbg(hub->intfdev, "enabling power on all ports\n");
  516. else
  517. dev_dbg(hub->intfdev, "trying to enable port power on "
  518. "non-switchable hub\n");
  519. for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
  520. set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
  521. /* Wait at least 100 msec for power to become stable */
  522. delay = max(pgood_delay, (unsigned) 100);
  523. if (do_delay)
  524. msleep(delay);
  525. return delay;
  526. }
  527. static int hub_hub_status(struct usb_hub *hub,
  528. u16 *status, u16 *change)
  529. {
  530. int ret;
  531. mutex_lock(&hub->status_mutex);
  532. ret = get_hub_status(hub->hdev, &hub->status->hub);
  533. if (ret < 0)
  534. dev_err (hub->intfdev,
  535. "%s failed (err = %d)\n", __func__, ret);
  536. else {
  537. *status = le16_to_cpu(hub->status->hub.wHubStatus);
  538. *change = le16_to_cpu(hub->status->hub.wHubChange);
  539. ret = 0;
  540. }
  541. mutex_unlock(&hub->status_mutex);
  542. return ret;
  543. }
  544. static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
  545. {
  546. struct usb_device *hdev = hub->hdev;
  547. int ret = 0;
  548. if (hdev->children[port1-1] && set_state)
  549. usb_set_device_state(hdev->children[port1-1],
  550. USB_STATE_NOTATTACHED);
  551. if (!hub->error && !hub_is_superspeed(hub->hdev))
  552. ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
  553. if (ret)
  554. dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
  555. port1, ret);
  556. return ret;
  557. }
  558. /*
  559. * Disable a port and mark a logical connect-change event, so that some
  560. * time later khubd will disconnect() any existing usb_device on the port
  561. * and will re-enumerate if there actually is a device attached.
  562. */
  563. static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
  564. {
  565. dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
  566. hub_port_disable(hub, port1, 1);
  567. /* FIXME let caller ask to power down the port:
  568. * - some devices won't enumerate without a VBUS power cycle
  569. * - SRP saves power that way
  570. * - ... new call, TBD ...
  571. * That's easy if this hub can switch power per-port, and
  572. * khubd reactivates the port later (timer, SRP, etc).
  573. * Powerdown must be optional, because of reset/DFU.
  574. */
  575. set_bit(port1, hub->change_bits);
  576. kick_khubd(hub);
  577. }
  578. /**
  579. * usb_remove_device - disable a device's port on its parent hub
  580. * @udev: device to be disabled and removed
  581. * Context: @udev locked, must be able to sleep.
  582. *
  583. * After @udev's port has been disabled, khubd is notified and it will
  584. * see that the device has been disconnected. When the device is
  585. * physically unplugged and something is plugged in, the events will
  586. * be received and processed normally.
  587. */
  588. int usb_remove_device(struct usb_device *udev)
  589. {
  590. struct usb_hub *hub;
  591. struct usb_interface *intf;
  592. if (!udev->parent) /* Can't remove a root hub */
  593. return -EINVAL;
  594. hub = hdev_to_hub(udev->parent);
  595. intf = to_usb_interface(hub->intfdev);
  596. usb_autopm_get_interface(intf);
  597. set_bit(udev->portnum, hub->removed_bits);
  598. hub_port_logical_disconnect(hub, udev->portnum);
  599. usb_autopm_put_interface(intf);
  600. return 0;
  601. }
  602. enum hub_activation_type {
  603. HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
  604. HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
  605. };
  606. static void hub_init_func2(struct work_struct *ws);
  607. static void hub_init_func3(struct work_struct *ws);
  608. static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
  609. {
  610. struct usb_device *hdev = hub->hdev;
  611. struct usb_hcd *hcd;
  612. int ret;
  613. int port1;
  614. int status;
  615. bool need_debounce_delay = false;
  616. unsigned delay;
  617. /* Continue a partial initialization */
  618. if (type == HUB_INIT2)
  619. goto init2;
  620. if (type == HUB_INIT3)
  621. goto init3;
  622. /* After a resume, port power should still be on.
  623. * For any other type of activation, turn it on.
  624. */
  625. if (type != HUB_RESUME) {
  626. /* Speed up system boot by using a delayed_work for the
  627. * hub's initial power-up delays. This is pretty awkward
  628. * and the implementation looks like a home-brewed sort of
  629. * setjmp/longjmp, but it saves at least 100 ms for each
  630. * root hub (assuming usbcore is compiled into the kernel
  631. * rather than as a module). It adds up.
  632. *
  633. * This can't be done for HUB_RESUME or HUB_RESET_RESUME
  634. * because for those activation types the ports have to be
  635. * operational when we return. In theory this could be done
  636. * for HUB_POST_RESET, but it's easier not to.
  637. */
  638. if (type == HUB_INIT) {
  639. delay = hub_power_on(hub, false);
  640. PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
  641. schedule_delayed_work(&hub->init_work,
  642. msecs_to_jiffies(delay));
  643. /* Suppress autosuspend until init is done */
  644. usb_autopm_get_interface_no_resume(
  645. to_usb_interface(hub->intfdev));
  646. return; /* Continues at init2: below */
  647. } else if (type == HUB_RESET_RESUME) {
  648. /* The internal host controller state for the hub device
  649. * may be gone after a host power loss on system resume.
  650. * Update the device's info so the HW knows it's a hub.
  651. */
  652. hcd = bus_to_hcd(hdev->bus);
  653. if (hcd->driver->update_hub_device) {
  654. ret = hcd->driver->update_hub_device(hcd, hdev,
  655. &hub->tt, GFP_NOIO);
  656. if (ret < 0) {
  657. dev_err(hub->intfdev, "Host not "
  658. "accepting hub info "
  659. "update.\n");
  660. dev_err(hub->intfdev, "LS/FS devices "
  661. "and hubs may not work "
  662. "under this hub\n.");
  663. }
  664. }
  665. hub_power_on(hub, true);
  666. } else {
  667. hub_power_on(hub, true);
  668. }
  669. }
  670. init2:
  671. /* Check each port and set hub->change_bits to let khubd know
  672. * which ports need attention.
  673. */
  674. for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
  675. struct usb_device *udev = hdev->children[port1-1];
  676. u16 portstatus, portchange;
  677. portstatus = portchange = 0;
  678. status = hub_port_status(hub, port1, &portstatus, &portchange);
  679. if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
  680. dev_dbg(hub->intfdev,
  681. "port %d: status %04x change %04x\n",
  682. port1, portstatus, portchange);
  683. /* After anything other than HUB_RESUME (i.e., initialization
  684. * or any sort of reset), every port should be disabled.
  685. * Unconnected ports should likewise be disabled (paranoia),
  686. * and so should ports for which we have no usb_device.
  687. */
  688. if ((portstatus & USB_PORT_STAT_ENABLE) && (
  689. type != HUB_RESUME ||
  690. !(portstatus & USB_PORT_STAT_CONNECTION) ||
  691. !udev ||
  692. udev->state == USB_STATE_NOTATTACHED)) {
  693. /*
  694. * USB3 protocol ports will automatically transition
  695. * to Enabled state when detect an USB3.0 device attach.
  696. * Do not disable USB3 protocol ports.
  697. */
  698. if (!hub_is_superspeed(hdev)) {
  699. clear_port_feature(hdev, port1,
  700. USB_PORT_FEAT_ENABLE);
  701. portstatus &= ~USB_PORT_STAT_ENABLE;
  702. } else {
  703. /* Pretend that power was lost for USB3 devs */
  704. portstatus &= ~USB_PORT_STAT_ENABLE;
  705. }
  706. }
  707. /* Clear status-change flags; we'll debounce later */
  708. if (portchange & USB_PORT_STAT_C_CONNECTION) {
  709. need_debounce_delay = true;
  710. clear_port_feature(hub->hdev, port1,
  711. USB_PORT_FEAT_C_CONNECTION);
  712. }
  713. if (portchange & USB_PORT_STAT_C_ENABLE) {
  714. need_debounce_delay = true;
  715. clear_port_feature(hub->hdev, port1,
  716. USB_PORT_FEAT_C_ENABLE);
  717. }
  718. if (portchange & USB_PORT_STAT_C_LINK_STATE) {
  719. need_debounce_delay = true;
  720. clear_port_feature(hub->hdev, port1,
  721. USB_PORT_FEAT_C_PORT_LINK_STATE);
  722. }
  723. /* We can forget about a "removed" device when there's a
  724. * physical disconnect or the connect status changes.
  725. */
  726. if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
  727. (portchange & USB_PORT_STAT_C_CONNECTION))
  728. clear_bit(port1, hub->removed_bits);
  729. if (!udev || udev->state == USB_STATE_NOTATTACHED) {
  730. /* Tell khubd to disconnect the device or
  731. * check for a new connection
  732. */
  733. if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
  734. set_bit(port1, hub->change_bits);
  735. } else if (portstatus & USB_PORT_STAT_ENABLE) {
  736. /* The power session apparently survived the resume.
  737. * If there was an overcurrent or suspend change
  738. * (i.e., remote wakeup request), have khubd
  739. * take care of it.
  740. */
  741. if (portchange)
  742. set_bit(port1, hub->change_bits);
  743. } else if (udev->persist_enabled) {
  744. #ifdef CONFIG_PM
  745. udev->reset_resume = 1;
  746. #endif
  747. set_bit(port1, hub->change_bits);
  748. } else {
  749. /* The power session is gone; tell khubd */
  750. usb_set_device_state(udev, USB_STATE_NOTATTACHED);
  751. set_bit(port1, hub->change_bits);
  752. }
  753. }
  754. /* If no port-status-change flags were set, we don't need any
  755. * debouncing. If flags were set we can try to debounce the
  756. * ports all at once right now, instead of letting khubd do them
  757. * one at a time later on.
  758. *
  759. * If any port-status changes do occur during this delay, khubd
  760. * will see them later and handle them normally.
  761. */
  762. if (need_debounce_delay) {
  763. delay = HUB_DEBOUNCE_STABLE;
  764. /* Don't do a long sleep inside a workqueue routine */
  765. if (type == HUB_INIT2) {
  766. PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
  767. schedule_delayed_work(&hub->init_work,
  768. msecs_to_jiffies(delay));
  769. return; /* Continues at init3: below */
  770. } else {
  771. msleep(delay);
  772. }
  773. }
  774. init3:
  775. hub->quiescing = 0;
  776. status = usb_submit_urb(hub->urb, GFP_NOIO);
  777. if (status < 0)
  778. dev_err(hub->intfdev, "activate --> %d\n", status);
  779. if (hub->has_indicators && blinkenlights)
  780. schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
  781. /* Scan all ports that need attention */
  782. kick_khubd(hub);
  783. /* Allow autosuspend if it was suppressed */
  784. if (type <= HUB_INIT3)
  785. usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
  786. }
  787. /* Implement the continuations for the delays above */
  788. static void hub_init_func2(struct work_struct *ws)
  789. {
  790. struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
  791. hub_activate(hub, HUB_INIT2);
  792. }
  793. static void hub_init_func3(struct work_struct *ws)
  794. {
  795. struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
  796. hub_activate(hub, HUB_INIT3);
  797. }
  798. enum hub_quiescing_type {
  799. HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
  800. };
  801. static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
  802. {
  803. struct usb_device *hdev = hub->hdev;
  804. int i;
  805. cancel_delayed_work_sync(&hub->init_work);
  806. /* khubd and related activity won't re-trigger */
  807. hub->quiescing = 1;
  808. if (type != HUB_SUSPEND) {
  809. /* Disconnect all the children */
  810. for (i = 0; i < hdev->maxchild; ++i) {
  811. if (hdev->children[i])
  812. usb_disconnect(&hdev->children[i]);
  813. }
  814. }
  815. /* Stop khubd and related activity */
  816. usb_kill_urb(hub->urb);
  817. if (hub->has_indicators)
  818. cancel_delayed_work_sync(&hub->leds);
  819. if (hub->tt.hub)
  820. cancel_work_sync(&hub->tt.clear_work);
  821. }
  822. /* caller has locked the hub device */
  823. static int hub_pre_reset(struct usb_interface *intf)
  824. {
  825. struct usb_hub *hub = usb_get_intfdata(intf);
  826. hub_quiesce(hub, HUB_PRE_RESET);
  827. return 0;
  828. }
  829. /* caller has locked the hub device */
  830. static int hub_post_reset(struct usb_interface *intf)
  831. {
  832. struct usb_hub *hub = usb_get_intfdata(intf);
  833. hub_activate(hub, HUB_POST_RESET);
  834. return 0;
  835. }
  836. static int hub_configure(struct usb_hub *hub,
  837. struct usb_endpoint_descriptor *endpoint)
  838. {
  839. struct usb_hcd *hcd;
  840. struct usb_device *hdev = hub->hdev;
  841. struct device *hub_dev = hub->intfdev;
  842. u16 hubstatus, hubchange;
  843. u16 wHubCharacteristics;
  844. unsigned int pipe;
  845. int maxp, ret;
  846. char *message = "out of memory";
  847. hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
  848. if (!hub->buffer) {
  849. ret = -ENOMEM;
  850. goto fail;
  851. }
  852. hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
  853. if (!hub->status) {
  854. ret = -ENOMEM;
  855. goto fail;
  856. }
  857. mutex_init(&hub->status_mutex);
  858. hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
  859. if (!hub->descriptor) {
  860. ret = -ENOMEM;
  861. goto fail;
  862. }
  863. if (hub_is_superspeed(hdev) && (hdev->parent != NULL)) {
  864. ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
  865. HUB_SET_DEPTH, USB_RT_HUB,
  866. hdev->level - 1, 0, NULL, 0,
  867. USB_CTRL_SET_TIMEOUT);
  868. if (ret < 0) {
  869. message = "can't set hub depth";
  870. goto fail;
  871. }
  872. }
  873. /* Request the entire hub descriptor.
  874. * hub->descriptor can handle USB_MAXCHILDREN ports,
  875. * but the hub can/will return fewer bytes here.
  876. */
  877. ret = get_hub_descriptor(hdev, hub->descriptor);
  878. if (ret < 0) {
  879. message = "can't read hub descriptor";
  880. goto fail;
  881. } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
  882. message = "hub has too many ports!";
  883. ret = -ENODEV;
  884. goto fail;
  885. }
  886. hdev->maxchild = hub->descriptor->bNbrPorts;
  887. dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
  888. (hdev->maxchild == 1) ? "" : "s");
  889. hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
  890. if (!hub->port_owners) {
  891. ret = -ENOMEM;
  892. goto fail;
  893. }
  894. wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
  895. /* FIXME for USB 3.0, skip for now */
  896. if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
  897. !(hub_is_superspeed(hdev))) {
  898. int i;
  899. char portstr [USB_MAXCHILDREN + 1];
  900. for (i = 0; i < hdev->maxchild; i++)
  901. portstr[i] = hub->descriptor->u.hs.DeviceRemovable
  902. [((i + 1) / 8)] & (1 << ((i + 1) % 8))
  903. ? 'F' : 'R';
  904. portstr[hdev->maxchild] = 0;
  905. dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
  906. } else
  907. dev_dbg(hub_dev, "standalone hub\n");
  908. switch (wHubCharacteristics & HUB_CHAR_LPSM) {
  909. case 0x00:
  910. dev_dbg(hub_dev, "ganged power switching\n");
  911. break;
  912. case 0x01:
  913. dev_dbg(hub_dev, "individual port power switching\n");
  914. break;
  915. case 0x02:
  916. case 0x03:
  917. dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
  918. break;
  919. }
  920. switch (wHubCharacteristics & HUB_CHAR_OCPM) {
  921. case 0x00:
  922. dev_dbg(hub_dev, "global over-current protection\n");
  923. break;
  924. case 0x08:
  925. dev_dbg(hub_dev, "individual port over-current protection\n");
  926. break;
  927. case 0x10:
  928. case 0x18:
  929. dev_dbg(hub_dev, "no over-current protection\n");
  930. break;
  931. }
  932. spin_lock_init (&hub->tt.lock);
  933. INIT_LIST_HEAD (&hub->tt.clear_list);
  934. INIT_WORK(&hub->tt.clear_work, hub_tt_work);
  935. switch (hdev->descriptor.bDeviceProtocol) {
  936. case 0:
  937. break;
  938. case 1:
  939. dev_dbg(hub_dev, "Single TT\n");
  940. hub->tt.hub = hdev;
  941. break;
  942. case 2:
  943. ret = usb_set_interface(hdev, 0, 1);
  944. if (ret == 0) {
  945. dev_dbg(hub_dev, "TT per port\n");
  946. hub->tt.multi = 1;
  947. } else
  948. dev_err(hub_dev, "Using single TT (err %d)\n",
  949. ret);
  950. hub->tt.hub = hdev;
  951. break;
  952. case 3:
  953. /* USB 3.0 hubs don't have a TT */
  954. break;
  955. default:
  956. dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
  957. hdev->descriptor.bDeviceProtocol);
  958. break;
  959. }
  960. /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
  961. switch (wHubCharacteristics & HUB_CHAR_TTTT) {
  962. case HUB_TTTT_8_BITS:
  963. if (hdev->descriptor.bDeviceProtocol != 0) {
  964. hub->tt.think_time = 666;
  965. dev_dbg(hub_dev, "TT requires at most %d "
  966. "FS bit times (%d ns)\n",
  967. 8, hub->tt.think_time);
  968. }
  969. break;
  970. case HUB_TTTT_16_BITS:
  971. hub->tt.think_time = 666 * 2;
  972. dev_dbg(hub_dev, "TT requires at most %d "
  973. "FS bit times (%d ns)\n",
  974. 16, hub->tt.think_time);
  975. break;
  976. case HUB_TTTT_24_BITS:
  977. hub->tt.think_time = 666 * 3;
  978. dev_dbg(hub_dev, "TT requires at most %d "
  979. "FS bit times (%d ns)\n",
  980. 24, hub->tt.think_time);
  981. break;
  982. case HUB_TTTT_32_BITS:
  983. hub->tt.think_time = 666 * 4;
  984. dev_dbg(hub_dev, "TT requires at most %d "
  985. "FS bit times (%d ns)\n",
  986. 32, hub->tt.think_time);
  987. break;
  988. }
  989. /* probe() zeroes hub->indicator[] */
  990. if (wHubCharacteristics & HUB_CHAR_PORTIND) {
  991. hub->has_indicators = 1;
  992. dev_dbg(hub_dev, "Port indicators are supported\n");
  993. }
  994. dev_dbg(hub_dev, "power on to power good time: %dms\n",
  995. hub->descriptor->bPwrOn2PwrGood * 2);
  996. /* power budgeting mostly matters with bus-powered hubs,
  997. * and battery-powered root hubs (may provide just 8 mA).
  998. */
  999. ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
  1000. if (ret < 2) {
  1001. message = "can't get hub status";
  1002. goto fail;
  1003. }
  1004. le16_to_cpus(&hubstatus);
  1005. if (hdev == hdev->bus->root_hub) {
  1006. if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
  1007. hub->mA_per_port = 500;
  1008. else {
  1009. hub->mA_per_port = hdev->bus_mA;
  1010. hub->limited_power = 1;
  1011. }
  1012. } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
  1013. dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
  1014. hub->descriptor->bHubContrCurrent);
  1015. hub->limited_power = 1;
  1016. if (hdev->maxchild > 0) {
  1017. int remaining = hdev->bus_mA -
  1018. hub->descriptor->bHubContrCurrent;
  1019. if (remaining < hdev->maxchild * 100)
  1020. dev_warn(hub_dev,
  1021. "insufficient power available "
  1022. "to use all downstream ports\n");
  1023. hub->mA_per_port = 100; /* 7.2.1.1 */
  1024. }
  1025. } else { /* Self-powered external hub */
  1026. /* FIXME: What about battery-powered external hubs that
  1027. * provide less current per port? */
  1028. hub->mA_per_port = 500;
  1029. }
  1030. if (hub->mA_per_port < 500)
  1031. dev_dbg(hub_dev, "%umA bus power budget for each child\n",
  1032. hub->mA_per_port);
  1033. /* Update the HCD's internal representation of this hub before khubd
  1034. * starts getting port status changes for devices under the hub.
  1035. */
  1036. hcd = bus_to_hcd(hdev->bus);
  1037. if (hcd->driver->update_hub_device) {
  1038. ret = hcd->driver->update_hub_device(hcd, hdev,
  1039. &hub->tt, GFP_KERNEL);
  1040. if (ret < 0) {
  1041. message = "can't update HCD hub info";
  1042. goto fail;
  1043. }
  1044. }
  1045. ret = hub_hub_status(hub, &hubstatus, &hubchange);
  1046. if (ret < 0) {
  1047. message = "can't get hub status";
  1048. goto fail;
  1049. }
  1050. /* local power status reports aren't always correct */
  1051. if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
  1052. dev_dbg(hub_dev, "local power source is %s\n",
  1053. (hubstatus & HUB_STATUS_LOCAL_POWER)
  1054. ? "lost (inactive)" : "good");
  1055. if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
  1056. dev_dbg(hub_dev, "%sover-current condition exists\n",
  1057. (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
  1058. /* set up the interrupt endpoint
  1059. * We use the EP's maxpacket size instead of (PORTS+1+7)/8
  1060. * bytes as USB2.0[11.12.3] says because some hubs are known
  1061. * to send more data (and thus cause overflow). For root hubs,
  1062. * maxpktsize is defined in hcd.c's fake endpoint descriptors
  1063. * to be big enough for at least USB_MAXCHILDREN ports. */
  1064. pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
  1065. maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
  1066. if (maxp > sizeof(*hub->buffer))
  1067. maxp = sizeof(*hub->buffer);
  1068. hub->urb = usb_alloc_urb(0, GFP_KERNEL);
  1069. if (!hub->urb) {
  1070. ret = -ENOMEM;
  1071. goto fail;
  1072. }
  1073. usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
  1074. hub, endpoint->bInterval);
  1075. /* maybe cycle the hub leds */
  1076. if (hub->has_indicators && blinkenlights)
  1077. hub->indicator [0] = INDICATOR_CYCLE;
  1078. hub_activate(hub, HUB_INIT);
  1079. return 0;
  1080. fail:
  1081. dev_err (hub_dev, "config failed, %s (err %d)\n",
  1082. message, ret);
  1083. /* hub_disconnect() frees urb and descriptor */
  1084. return ret;
  1085. }
  1086. static void hub_release(struct kref *kref)
  1087. {
  1088. struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
  1089. usb_put_intf(to_usb_interface(hub->intfdev));
  1090. kfree(hub);
  1091. }
  1092. static unsigned highspeed_hubs;
  1093. static void hub_disconnect(struct usb_interface *intf)
  1094. {
  1095. struct usb_hub *hub = usb_get_intfdata (intf);
  1096. /* Take the hub off the event list and don't let it be added again */
  1097. spin_lock_irq(&hub_event_lock);
  1098. if (!list_empty(&hub->event_list)) {
  1099. list_del_init(&hub->event_list);
  1100. usb_autopm_put_interface_no_suspend(intf);
  1101. }
  1102. hub->disconnected = 1;
  1103. spin_unlock_irq(&hub_event_lock);
  1104. /* Disconnect all children and quiesce the hub */
  1105. hub->error = 0;
  1106. hub_quiesce(hub, HUB_DISCONNECT);
  1107. usb_set_intfdata (intf, NULL);
  1108. hub->hdev->maxchild = 0;
  1109. if (hub->hdev->speed == USB_SPEED_HIGH)
  1110. highspeed_hubs--;
  1111. usb_free_urb(hub->urb);
  1112. kfree(hub->port_owners);
  1113. kfree(hub->descriptor);
  1114. kfree(hub->status);
  1115. kfree(hub->buffer);
  1116. kref_put(&hub->kref, hub_release);
  1117. }
  1118. static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
  1119. {
  1120. struct usb_host_interface *desc;
  1121. struct usb_endpoint_descriptor *endpoint;
  1122. struct usb_device *hdev;
  1123. struct usb_hub *hub;
  1124. desc = intf->cur_altsetting;
  1125. hdev = interface_to_usbdev(intf);
  1126. /* Hubs have proper suspend/resume support */
  1127. usb_enable_autosuspend(hdev);
  1128. if (hdev->level == MAX_TOPO_LEVEL) {
  1129. dev_err(&intf->dev,
  1130. "Unsupported bus topology: hub nested too deep\n");
  1131. return -E2BIG;
  1132. }
  1133. #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
  1134. if (hdev->parent) {
  1135. dev_warn(&intf->dev, "ignoring external hub\n");
  1136. return -ENODEV;
  1137. }
  1138. #endif
  1139. /* Some hubs have a subclass of 1, which AFAICT according to the */
  1140. /* specs is not defined, but it works */
  1141. if ((desc->desc.bInterfaceSubClass != 0) &&
  1142. (desc->desc.bInterfaceSubClass != 1)) {
  1143. descriptor_error:
  1144. dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
  1145. return -EIO;
  1146. }
  1147. /* Multiple endpoints? What kind of mutant ninja-hub is this? */
  1148. if (desc->desc.bNumEndpoints != 1)
  1149. goto descriptor_error;
  1150. endpoint = &desc->endpoint[0].desc;
  1151. /* If it's not an interrupt in endpoint, we'd better punt! */
  1152. if (!usb_endpoint_is_int_in(endpoint))
  1153. goto descriptor_error;
  1154. /* We found a hub */
  1155. dev_info (&intf->dev, "USB hub found\n");
  1156. hub = kzalloc(sizeof(*hub), GFP_KERNEL);
  1157. if (!hub) {
  1158. dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
  1159. return -ENOMEM;
  1160. }
  1161. kref_init(&hub->kref);
  1162. INIT_LIST_HEAD(&hub->event_list);
  1163. hub->intfdev = &intf->dev;
  1164. hub->hdev = hdev;
  1165. INIT_DELAYED_WORK(&hub->leds, led_work);
  1166. INIT_DELAYED_WORK(&hub->init_work, NULL);
  1167. usb_get_intf(intf);
  1168. usb_set_intfdata (intf, hub);
  1169. intf->needs_remote_wakeup = 1;
  1170. if (hdev->speed == USB_SPEED_HIGH)
  1171. highspeed_hubs++;
  1172. if (hub_configure(hub, endpoint) >= 0)
  1173. return 0;
  1174. hub_disconnect (intf);
  1175. return -ENODEV;
  1176. }
  1177. /* No BKL needed */
  1178. static int
  1179. hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
  1180. {
  1181. struct usb_device *hdev = interface_to_usbdev (intf);
  1182. /* assert ifno == 0 (part of hub spec) */
  1183. switch (code) {
  1184. case USBDEVFS_HUB_PORTINFO: {
  1185. struct usbdevfs_hub_portinfo *info = user_data;
  1186. int i;
  1187. spin_lock_irq(&device_state_lock);
  1188. if (hdev->devnum <= 0)
  1189. info->nports = 0;
  1190. else {
  1191. info->nports = hdev->maxchild;
  1192. for (i = 0; i < info->nports; i++) {
  1193. if (hdev->children[i] == NULL)
  1194. info->port[i] = 0;
  1195. else
  1196. info->port[i] =
  1197. hdev->children[i]->devnum;
  1198. }
  1199. }
  1200. spin_unlock_irq(&device_state_lock);
  1201. return info->nports + 1;
  1202. }
  1203. default:
  1204. return -ENOSYS;
  1205. }
  1206. }
  1207. /*
  1208. * Allow user programs to claim ports on a hub. When a device is attached
  1209. * to one of these "claimed" ports, the program will "own" the device.
  1210. */
  1211. static int find_port_owner(struct usb_device *hdev, unsigned port1,
  1212. void ***ppowner)
  1213. {
  1214. if (hdev->state == USB_STATE_NOTATTACHED)
  1215. return -ENODEV;
  1216. if (port1 == 0 || port1 > hdev->maxchild)
  1217. return -EINVAL;
  1218. /* This assumes that devices not managed by the hub driver
  1219. * will always have maxchild equal to 0.
  1220. */
  1221. *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
  1222. return 0;
  1223. }
  1224. /* In the following three functions, the caller must hold hdev's lock */
  1225. int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
  1226. {
  1227. int rc;
  1228. void **powner;
  1229. rc = find_port_owner(hdev, port1, &powner);
  1230. if (rc)
  1231. return rc;
  1232. if (*powner)
  1233. return -EBUSY;
  1234. *powner = owner;
  1235. return rc;
  1236. }
  1237. int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
  1238. {
  1239. int rc;
  1240. void **powner;
  1241. rc = find_port_owner(hdev, port1, &powner);
  1242. if (rc)
  1243. return rc;
  1244. if (*powner != owner)
  1245. return -ENOENT;
  1246. *powner = NULL;
  1247. return rc;
  1248. }
  1249. void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
  1250. {
  1251. int n;
  1252. void **powner;
  1253. n = find_port_owner(hdev, 1, &powner);
  1254. if (n == 0) {
  1255. for (; n < hdev->maxchild; (++n, ++powner)) {
  1256. if (*powner == owner)
  1257. *powner = NULL;
  1258. }
  1259. }
  1260. }
  1261. /* The caller must hold udev's lock */
  1262. bool usb_device_is_owned(struct usb_device *udev)
  1263. {
  1264. struct usb_hub *hub;
  1265. if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
  1266. return false;
  1267. hub = hdev_to_hub(udev->parent);
  1268. return !!hub->port_owners[udev->portnum - 1];
  1269. }
  1270. static void recursively_mark_NOTATTACHED(struct usb_device *udev)
  1271. {
  1272. int i;
  1273. for (i = 0; i < udev->maxchild; ++i) {
  1274. if (udev->children[i])
  1275. recursively_mark_NOTATTACHED(udev->children[i]);
  1276. }
  1277. if (udev->state == USB_STATE_SUSPENDED)
  1278. udev->active_duration -= jiffies;
  1279. udev->state = USB_STATE_NOTATTACHED;
  1280. }
  1281. /**
  1282. * usb_set_device_state - change a device's current state (usbcore, hcds)
  1283. * @udev: pointer to device whose state should be changed
  1284. * @new_state: new state value to be stored
  1285. *
  1286. * udev->state is _not_ fully protected by the device lock. Although
  1287. * most transitions are made only while holding the lock, the state can
  1288. * can change to USB_STATE_NOTATTACHED at almost any time. This
  1289. * is so that devices can be marked as disconnected as soon as possible,
  1290. * without having to wait for any semaphores to be released. As a result,
  1291. * all changes to any device's state must be protected by the
  1292. * device_state_lock spinlock.
  1293. *
  1294. * Once a device has been added to the device tree, all changes to its state
  1295. * should be made using this routine. The state should _not_ be set directly.
  1296. *
  1297. * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
  1298. * Otherwise udev->state is set to new_state, and if new_state is
  1299. * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
  1300. * to USB_STATE_NOTATTACHED.
  1301. */
  1302. void usb_set_device_state(struct usb_device *udev,
  1303. enum usb_device_state new_state)
  1304. {
  1305. unsigned long flags;
  1306. spin_lock_irqsave(&device_state_lock, flags);
  1307. if (udev->state == USB_STATE_NOTATTACHED)
  1308. ; /* do nothing */
  1309. else if (new_state != USB_STATE_NOTATTACHED) {
  1310. /* root hub wakeup capabilities are managed out-of-band
  1311. * and may involve silicon errata ... ignore them here.
  1312. */
  1313. if (udev->parent) {
  1314. if (udev->state == USB_STATE_SUSPENDED
  1315. || new_state == USB_STATE_SUSPENDED)
  1316. ; /* No change to wakeup settings */
  1317. else if (new_state == USB_STATE_CONFIGURED)
  1318. device_set_wakeup_capable(&udev->dev,
  1319. (udev->actconfig->desc.bmAttributes
  1320. & USB_CONFIG_ATT_WAKEUP));
  1321. else
  1322. device_set_wakeup_capable(&udev->dev, 0);
  1323. }
  1324. if (udev->state == USB_STATE_SUSPENDED &&
  1325. new_state != USB_STATE_SUSPENDED)
  1326. udev->active_duration -= jiffies;
  1327. else if (new_state == USB_STATE_SUSPENDED &&
  1328. udev->state != USB_STATE_SUSPENDED)
  1329. udev->active_duration += jiffies;
  1330. udev->state = new_state;
  1331. } else
  1332. recursively_mark_NOTATTACHED(udev);
  1333. spin_unlock_irqrestore(&device_state_lock, flags);
  1334. }
  1335. EXPORT_SYMBOL_GPL(usb_set_device_state);
  1336. /*
  1337. * Choose a device number.
  1338. *
  1339. * Device numbers are used as filenames in usbfs. On USB-1.1 and
  1340. * USB-2.0 buses they are also used as device addresses, however on
  1341. * USB-3.0 buses the address is assigned by the controller hardware
  1342. * and it usually is not the same as the device number.
  1343. *
  1344. * WUSB devices are simple: they have no hubs behind, so the mapping
  1345. * device <-> virtual port number becomes 1:1. Why? to simplify the
  1346. * life of the device connection logic in
  1347. * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
  1348. * handshake we need to assign a temporary address in the unauthorized
  1349. * space. For simplicity we use the first virtual port number found to
  1350. * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
  1351. * and that becomes it's address [X < 128] or its unauthorized address
  1352. * [X | 0x80].
  1353. *
  1354. * We add 1 as an offset to the one-based USB-stack port number
  1355. * (zero-based wusb virtual port index) for two reasons: (a) dev addr
  1356. * 0 is reserved by USB for default address; (b) Linux's USB stack
  1357. * uses always #1 for the root hub of the controller. So USB stack's
  1358. * port #1, which is wusb virtual-port #0 has address #2.
  1359. *
  1360. * Devices connected under xHCI are not as simple. The host controller
  1361. * supports virtualization, so the hardware assigns device addresses and
  1362. * the HCD must setup data structures before issuing a set address
  1363. * command to the hardware.
  1364. */
  1365. static void choose_devnum(struct usb_device *udev)
  1366. {
  1367. int devnum;
  1368. struct usb_bus *bus = udev->bus;
  1369. /* If khubd ever becomes multithreaded, this will need a lock */
  1370. if (udev->wusb) {
  1371. devnum = udev->portnum + 1;
  1372. BUG_ON(test_bit(devnum, bus->devmap.devicemap));
  1373. } else {
  1374. /* Try to allocate the next devnum beginning at
  1375. * bus->devnum_next. */
  1376. devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
  1377. bus->devnum_next);
  1378. if (devnum >= 128)
  1379. devnum = find_next_zero_bit(bus->devmap.devicemap,
  1380. 128, 1);
  1381. bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
  1382. }
  1383. if (devnum < 128) {
  1384. set_bit(devnum, bus->devmap.devicemap);
  1385. udev->devnum = devnum;
  1386. }
  1387. }
  1388. static void release_devnum(struct usb_device *udev)
  1389. {
  1390. if (udev->devnum > 0) {
  1391. clear_bit(udev->devnum, udev->bus->devmap.devicemap);
  1392. udev->devnum = -1;
  1393. }
  1394. }
  1395. static void update_devnum(struct usb_device *udev, int devnum)
  1396. {
  1397. /* The address for a WUSB device is managed by wusbcore. */
  1398. if (!udev->wusb)
  1399. udev->devnum = devnum;
  1400. }
  1401. static void hub_free_dev(struct usb_device *udev)
  1402. {
  1403. struct usb_hcd *hcd = bus_to_hcd(udev->bus);
  1404. /* Root hubs aren't real devices, so don't free HCD resources */
  1405. if (hcd->driver->free_dev && udev->parent)
  1406. hcd->driver->free_dev(hcd, udev);
  1407. }
  1408. /**
  1409. * usb_disconnect - disconnect a device (usbcore-internal)
  1410. * @pdev: pointer to device being disconnected
  1411. * Context: !in_interrupt ()
  1412. *
  1413. * Something got disconnected. Get rid of it and all of its children.
  1414. *
  1415. * If *pdev is a normal device then the parent hub must already be locked.
  1416. * If *pdev is a root hub then this routine will acquire the
  1417. * usb_bus_list_lock on behalf of the caller.
  1418. *
  1419. * Only hub drivers (including virtual root hub drivers for host
  1420. * controllers) should ever call this.
  1421. *
  1422. * This call is synchronous, and may not be used in an interrupt context.
  1423. */
  1424. void usb_disconnect(struct usb_device **pdev)
  1425. {
  1426. struct usb_device *udev = *pdev;
  1427. int i;
  1428. if (!udev) {
  1429. pr_debug ("%s nodev\n", __func__);
  1430. return;
  1431. }
  1432. /* mark the device as inactive, so any further urb submissions for
  1433. * this device (and any of its children) will fail immediately.
  1434. * this quiesces everyting except pending urbs.
  1435. */
  1436. usb_set_device_state(udev, USB_STATE_NOTATTACHED);
  1437. dev_info(&udev->dev, "USB disconnect, device number %d\n",
  1438. udev->devnum);
  1439. usb_lock_device(udev);
  1440. /* Free up all the children before we remove this device */
  1441. for (i = 0; i < USB_MAXCHILDREN; i++) {
  1442. if (udev->children[i])
  1443. usb_disconnect(&udev->children[i]);
  1444. }
  1445. /* deallocate hcd/hardware state ... nuking all pending urbs and
  1446. * cleaning up all state associated with the current configuration
  1447. * so that the hardware is now fully quiesced.
  1448. */
  1449. dev_dbg (&udev->dev, "unregistering device\n");
  1450. usb_disable_device(udev, 0);
  1451. usb_hcd_synchronize_unlinks(udev);
  1452. usb_remove_ep_devs(&udev->ep0);
  1453. usb_unlock_device(udev);
  1454. /* Unregister the device. The device driver is responsible
  1455. * for de-configuring the device and invoking the remove-device
  1456. * notifier chain (used by usbfs and possibly others).
  1457. */
  1458. device_del(&udev->dev);
  1459. /* Free the device number and delete the parent's children[]
  1460. * (or root_hub) pointer.
  1461. */
  1462. release_devnum(udev);
  1463. /* Avoid races with recursively_mark_NOTATTACHED() */
  1464. spin_lock_irq(&device_state_lock);
  1465. *pdev = NULL;
  1466. spin_unlock_irq(&device_state_lock);
  1467. hub_free_dev(udev);
  1468. put_device(&udev->dev);
  1469. }
  1470. #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
  1471. static void show_string(struct usb_device *udev, char *id, char *string)
  1472. {
  1473. if (!string)
  1474. return;
  1475. dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
  1476. }
  1477. static void announce_device(struct usb_device *udev)
  1478. {
  1479. dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
  1480. le16_to_cpu(udev->descriptor.idVendor),
  1481. le16_to_cpu(udev->descriptor.idProduct));
  1482. dev_info(&udev->dev,
  1483. "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
  1484. udev->descriptor.iManufacturer,
  1485. udev->descriptor.iProduct,
  1486. udev->descriptor.iSerialNumber);
  1487. show_string(udev, "Product", udev->product);
  1488. show_string(udev, "Manufacturer", udev->manufacturer);
  1489. show_string(udev, "SerialNumber", udev->serial);
  1490. }
  1491. #else
  1492. static inline void announce_device(struct usb_device *udev) { }
  1493. #endif
  1494. #ifdef CONFIG_USB_OTG
  1495. #include "otg_whitelist.h"
  1496. #endif
  1497. /**
  1498. * usb_enumerate_device_otg - FIXME (usbcore-internal)
  1499. * @udev: newly addressed device (in ADDRESS state)
  1500. *
  1501. * Finish enumeration for On-The-Go devices
  1502. */
  1503. static int usb_enumerate_device_otg(struct usb_device *udev)
  1504. {
  1505. int err = 0;
  1506. #ifdef CONFIG_USB_OTG
  1507. /*
  1508. * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
  1509. * to wake us after we've powered off VBUS; and HNP, switching roles
  1510. * "host" to "peripheral". The OTG descriptor helps figure this out.
  1511. */
  1512. if (!udev->bus->is_b_host
  1513. && udev->config
  1514. && udev->parent == udev->bus->root_hub) {
  1515. struct usb_otg_descriptor *desc = NULL;
  1516. struct usb_bus *bus = udev->bus;
  1517. /* descriptor may appear anywhere in config */
  1518. if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
  1519. le16_to_cpu(udev->config[0].desc.wTotalLength),
  1520. USB_DT_OTG, (void **) &desc) == 0) {
  1521. if (desc->bmAttributes & USB_OTG_HNP) {
  1522. unsigned port1 = udev->portnum;
  1523. dev_info(&udev->dev,
  1524. "Dual-Role OTG device on %sHNP port\n",
  1525. (port1 == bus->otg_port)
  1526. ? "" : "non-");
  1527. /* enable HNP before suspend, it's simpler */
  1528. if (port1 == bus->otg_port)
  1529. bus->b_hnp_enable = 1;
  1530. err = usb_control_msg(udev,
  1531. usb_sndctrlpipe(udev, 0),
  1532. USB_REQ_SET_FEATURE, 0,
  1533. bus->b_hnp_enable
  1534. ? USB_DEVICE_B_HNP_ENABLE
  1535. : USB_DEVICE_A_ALT_HNP_SUPPORT,
  1536. 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
  1537. if (err < 0) {
  1538. /* OTG MESSAGE: report errors here,
  1539. * customize to match your product.
  1540. */
  1541. dev_info(&udev->dev,
  1542. "can't set HNP mode: %d\n",
  1543. err);
  1544. bus->b_hnp_enable = 0;
  1545. }
  1546. }
  1547. }
  1548. }
  1549. if (!is_targeted(udev)) {
  1550. /* Maybe it can talk to us, though we can't talk to it.
  1551. * (Includes HNP test device.)
  1552. */
  1553. if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
  1554. err = usb_port_suspend(udev, PMSG_SUSPEND);
  1555. if (err < 0)
  1556. dev_dbg(&udev->dev, "HNP fail, %d\n", err);
  1557. }
  1558. err = -ENOTSUPP;
  1559. goto fail;
  1560. }
  1561. fail:
  1562. #endif
  1563. return err;
  1564. }
  1565. /**
  1566. * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
  1567. * @udev: newly addressed device (in ADDRESS state)
  1568. *
  1569. * This is only called by usb_new_device() and usb_authorize_device()
  1570. * and FIXME -- all comments that apply to them apply here wrt to
  1571. * environment.
  1572. *
  1573. * If the device is WUSB and not authorized, we don't attempt to read
  1574. * the string descriptors, as they will be errored out by the device
  1575. * until it has been authorized.
  1576. */
  1577. static int usb_enumerate_device(struct usb_device *udev)
  1578. {
  1579. int err;
  1580. if (udev->config == NULL) {
  1581. err = usb_get_configuration(udev);
  1582. if (err < 0) {
  1583. dev_err(&udev->dev, "can't read configurations, error %d\n",
  1584. err);
  1585. goto fail;
  1586. }
  1587. }
  1588. if (udev->wusb == 1 && udev->authorized == 0) {
  1589. udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
  1590. udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
  1591. udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
  1592. }
  1593. else {
  1594. /* read the standard strings and cache them if present */
  1595. udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
  1596. udev->manufacturer = usb_cache_string(udev,
  1597. udev->descriptor.iManufacturer);
  1598. udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
  1599. }
  1600. err = usb_enumerate_device_otg(udev);
  1601. fail:
  1602. return err;
  1603. }
  1604. /**
  1605. * usb_new_device - perform initial device setup (usbcore-internal)
  1606. * @udev: newly addressed device (in ADDRESS state)
  1607. *
  1608. * This is called with devices which have been detected but not fully
  1609. * enumerated. The device descriptor is available, but not descriptors
  1610. * for any device configuration. The caller must have locked either
  1611. * the parent hub (if udev is a normal device) or else the
  1612. * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
  1613. * udev has already been installed, but udev is not yet visible through
  1614. * sysfs or other filesystem code.
  1615. *
  1616. * It will return if the device is configured properly or not. Zero if
  1617. * the interface was registered with the driver core; else a negative
  1618. * errno value.
  1619. *
  1620. * This call is synchronous, and may not be used in an interrupt context.
  1621. *
  1622. * Only the hub driver or root-hub registrar should ever call this.
  1623. */
  1624. int usb_new_device(struct usb_device *udev)
  1625. {
  1626. int err;
  1627. if (udev->parent) {
  1628. /* Initialize non-root-hub device wakeup to disabled;
  1629. * device (un)configuration controls wakeup capable
  1630. * sysfs power/wakeup controls wakeup enabled/disabled
  1631. */
  1632. device_init_wakeup(&udev->dev, 0);
  1633. }
  1634. /* Tell the runtime-PM framework the device is active */
  1635. pm_runtime_set_active(&udev->dev);
  1636. pm_runtime_get_noresume(&udev->dev);
  1637. pm_runtime_use_autosuspend(&udev->dev);
  1638. pm_runtime_enable(&udev->dev);
  1639. /* By default, forbid autosuspend for all devices. It will be
  1640. * allowed for hubs during binding.
  1641. */
  1642. usb_disable_autosuspend(udev);
  1643. err = usb_enumerate_device(udev); /* Read descriptors */
  1644. if (err < 0)
  1645. goto fail;
  1646. dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
  1647. udev->devnum, udev->bus->busnum,
  1648. (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
  1649. /* export the usbdev device-node for libusb */
  1650. udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
  1651. (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
  1652. /* Tell the world! */
  1653. announce_device(udev);
  1654. device_enable_async_suspend(&udev->dev);
  1655. /* Register the device. The device driver is responsible
  1656. * for configuring the device and invoking the add-device
  1657. * notifier chain (used by usbfs and possibly others).
  1658. */
  1659. err = device_add(&udev->dev);
  1660. if (err) {
  1661. dev_err(&udev->dev, "can't device_add, error %d\n", err);
  1662. goto fail;
  1663. }
  1664. (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
  1665. usb_mark_last_busy(udev);
  1666. pm_runtime_put_sync_autosuspend(&udev->dev);
  1667. return err;
  1668. fail:
  1669. usb_set_device_state(udev, USB_STATE_NOTATTACHED);
  1670. pm_runtime_disable(&udev->dev);
  1671. pm_runtime_set_suspended(&udev->dev);
  1672. return err;
  1673. }
  1674. /**
  1675. * usb_deauthorize_device - deauthorize a device (usbcore-internal)
  1676. * @usb_dev: USB device
  1677. *
  1678. * Move the USB device to a very basic state where interfaces are disabled
  1679. * and the device is in fact unconfigured and unusable.
  1680. *
  1681. * We share a lock (that we have) with device_del(), so we need to
  1682. * defer its call.
  1683. */
  1684. int usb_deauthorize_device(struct usb_device *usb_dev)
  1685. {
  1686. usb_lock_device(usb_dev);
  1687. if (usb_dev->authorized == 0)
  1688. goto out_unauthorized;
  1689. usb_dev->authorized = 0;
  1690. usb_set_configuration(usb_dev, -1);
  1691. kfree(usb_dev->product);
  1692. usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
  1693. kfree(usb_dev->manufacturer);
  1694. usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
  1695. kfree(usb_dev->serial);
  1696. usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
  1697. usb_destroy_configuration(usb_dev);
  1698. usb_dev->descriptor.bNumConfigurations = 0;
  1699. out_unauthorized:
  1700. usb_unlock_device(usb_dev);
  1701. return 0;
  1702. }
  1703. int usb_authorize_device(struct usb_device *usb_dev)
  1704. {
  1705. int result = 0, c;
  1706. usb_lock_device(usb_dev);
  1707. if (usb_dev->authorized == 1)
  1708. goto out_authorized;
  1709. result = usb_autoresume_device(usb_dev);
  1710. if (result < 0) {
  1711. dev_err(&usb_dev->dev,
  1712. "can't autoresume for authorization: %d\n", result);
  1713. goto error_autoresume;
  1714. }
  1715. result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
  1716. if (result < 0) {
  1717. dev_err(&usb_dev->dev, "can't re-read device descriptor for "
  1718. "authorization: %d\n", result);
  1719. goto error_device_descriptor;
  1720. }
  1721. kfree(usb_dev->product);
  1722. usb_dev->product = NULL;
  1723. kfree(usb_dev->manufacturer);
  1724. usb_dev->manufacturer = NULL;
  1725. kfree(usb_dev->serial);
  1726. usb_dev->serial = NULL;
  1727. usb_dev->authorized = 1;
  1728. result = usb_enumerate_device(usb_dev);
  1729. if (result < 0)
  1730. goto error_enumerate;
  1731. /* Choose and set the configuration. This registers the interfaces
  1732. * with the driver core and lets interface drivers bind to them.
  1733. */
  1734. c = usb_choose_configuration(usb_dev);
  1735. if (c >= 0) {
  1736. result = usb_set_configuration(usb_dev, c);
  1737. if (result) {
  1738. dev_err(&usb_dev->dev,
  1739. "can't set config #%d, error %d\n", c, result);
  1740. /* This need not be fatal. The user can try to
  1741. * set other configurations. */
  1742. }
  1743. }
  1744. dev_info(&usb_dev->dev, "authorized to connect\n");
  1745. error_enumerate:
  1746. error_device_descriptor:
  1747. usb_autosuspend_device(usb_dev);
  1748. error_autoresume:
  1749. out_authorized:
  1750. usb_unlock_device(usb_dev); // complements locktree
  1751. return result;
  1752. }
  1753. /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
  1754. static unsigned hub_is_wusb(struct usb_hub *hub)
  1755. {
  1756. struct usb_hcd *hcd;
  1757. if (hub->hdev->parent != NULL) /* not a root hub? */
  1758. return 0;
  1759. hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
  1760. return hcd->wireless;
  1761. }
  1762. #define PORT_RESET_TRIES 5
  1763. #define SET_ADDRESS_TRIES 2
  1764. #define GET_DESCRIPTOR_TRIES 2
  1765. #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
  1766. #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
  1767. #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
  1768. #define HUB_SHORT_RESET_TIME 10
  1769. #define HUB_LONG_RESET_TIME 200
  1770. #define HUB_RESET_TIMEOUT 500
  1771. static int hub_port_wait_reset(struct usb_hub *hub, int port1,
  1772. struct usb_device *udev, unsigned int delay)
  1773. {
  1774. int delay_time, ret;
  1775. u16 portstatus;
  1776. u16 portchange;
  1777. for (delay_time = 0;
  1778. delay_time < HUB_RESET_TIMEOUT;
  1779. delay_time += delay) {
  1780. /* wait to give the device a chance to reset */
  1781. msleep(delay);
  1782. /* read and decode port status */
  1783. ret = hub_port_status(hub, port1, &portstatus, &portchange);
  1784. if (ret < 0)
  1785. return ret;
  1786. /* Device went away? */
  1787. if (!(portstatus & USB_PORT_STAT_CONNECTION))
  1788. return -ENOTCONN;
  1789. /* bomb out completely if the connection bounced */
  1790. if ((portchange & USB_PORT_STAT_C_CONNECTION))
  1791. return -ENOTCONN;
  1792. /* if we`ve finished resetting, then break out of the loop */
  1793. if (!(portstatus & USB_PORT_STAT_RESET) &&
  1794. (portstatus & USB_PORT_STAT_ENABLE)) {
  1795. if (hub_is_wusb(hub))
  1796. udev->speed = USB_SPEED_WIRELESS;
  1797. else if (hub_is_superspeed(hub->hdev))
  1798. udev->speed = USB_SPEED_SUPER;
  1799. else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
  1800. udev->speed = USB_SPEED_HIGH;
  1801. else if (portstatus & USB_PORT_STAT_LOW_SPEED)
  1802. udev->speed = USB_SPEED_LOW;
  1803. else
  1804. udev->speed = USB_SPEED_FULL;
  1805. return 0;
  1806. }
  1807. /* switch to the long delay after two short delay failures */
  1808. if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
  1809. delay = HUB_LONG_RESET_TIME;
  1810. dev_dbg (hub->intfdev,
  1811. "port %d not reset yet, waiting %dms\n",
  1812. port1, delay);
  1813. }
  1814. return -EBUSY;
  1815. }
  1816. static int hub_port_reset(struct usb_hub *hub, int port1,
  1817. struct usb_device *udev, unsigned int delay)
  1818. {
  1819. int i, status;
  1820. struct usb_hcd *hcd;
  1821. hcd = bus_to_hcd(udev->bus);
  1822. /* Block EHCI CF initialization during the port reset.
  1823. * Some companion controllers don't like it when they mix.
  1824. */
  1825. down_read(&ehci_cf_port_reset_rwsem);
  1826. /* Reset the port */
  1827. for (i = 0; i < PORT_RESET_TRIES; i++) {
  1828. status = set_port_feature(hub->hdev,
  1829. port1, USB_PORT_FEAT_RESET);
  1830. if (status)
  1831. dev_err(hub->intfdev,
  1832. "cannot reset port %d (err = %d)\n",
  1833. port1, status);
  1834. else {
  1835. status = hub_port_wait_reset(hub, port1, udev, delay);
  1836. if (status && status != -ENOTCONN)
  1837. dev_dbg(hub->intfdev,
  1838. "port_wait_reset: err = %d\n",
  1839. status);
  1840. }
  1841. /* return on disconnect or reset */
  1842. switch (status) {
  1843. case 0:
  1844. /* TRSTRCY = 10 ms; plus some extra */
  1845. msleep(10 + 40);
  1846. update_devnum(udev, 0);
  1847. if (hcd->driver->reset_device) {
  1848. status = hcd->driver->reset_device(hcd, udev);
  1849. if (status < 0) {
  1850. dev_err(&udev->dev, "Cannot reset "
  1851. "HCD device state\n");
  1852. break;
  1853. }
  1854. }
  1855. /* FALL THROUGH */
  1856. case -ENOTCONN:
  1857. case -ENODEV:
  1858. clear_port_feature(hub->hdev,
  1859. port1, USB_PORT_FEAT_C_RESET);
  1860. /* FIXME need disconnect() for NOTATTACHED device */
  1861. usb_set_device_state(udev, status
  1862. ? USB_STATE_NOTATTACHED
  1863. : USB_STATE_DEFAULT);
  1864. goto done;
  1865. }
  1866. dev_dbg (hub->intfdev,
  1867. "port %d not enabled, trying reset again...\n",
  1868. port1);
  1869. delay = HUB_LONG_RESET_TIME;
  1870. }
  1871. dev_err (hub->intfdev,
  1872. "Cannot enable port %i. Maybe the USB cable is bad?\n",
  1873. port1);
  1874. done:
  1875. up_read(&ehci_cf_port_reset_rwsem);
  1876. return status;
  1877. }
  1878. #ifdef CONFIG_PM
  1879. #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
  1880. USB_PORT_STAT_SUSPEND)
  1881. #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
  1882. /* Determine whether the device on a port is ready for a normal resume,
  1883. * is ready for a reset-resume, or should be disconnected.
  1884. */
  1885. static int check_port_resume_type(struct usb_device *udev,
  1886. struct usb_hub *hub, int port1,
  1887. int status, unsigned portchange, unsigned portstatus)
  1888. {
  1889. /* Is the device still present? */
  1890. if (status || (portstatus & MASK_BITS) != WANT_BITS) {
  1891. if (status >= 0)
  1892. status = -ENODEV;
  1893. }
  1894. /* Can't do a normal resume if the port isn't enabled,
  1895. * so try a reset-resume instead.
  1896. */
  1897. else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
  1898. if (udev->persist_enabled)
  1899. udev->reset_resume = 1;
  1900. else
  1901. status = -ENODEV;
  1902. }
  1903. if (status) {
  1904. dev_dbg(hub->intfdev,
  1905. "port %d status %04x.%04x after resume, %d\n",
  1906. port1, portchange, portstatus, status);
  1907. } else if (udev->reset_resume) {
  1908. /* Late port handoff can set status-change bits */
  1909. if (portchange & USB_PORT_STAT_C_CONNECTION)
  1910. clear_port_feature(hub->hdev, port1,
  1911. USB_PORT_FEAT_C_CONNECTION);
  1912. if (portchange & USB_PORT_STAT_C_ENABLE)
  1913. clear_port_feature(hub->hdev, port1,
  1914. USB_PORT_FEAT_C_ENABLE);
  1915. }
  1916. return status;
  1917. }
  1918. #ifdef CONFIG_USB_SUSPEND
  1919. /*
  1920. * usb_port_suspend - suspend a usb device's upstream port
  1921. * @udev: device that's no longer in active use, not a root hub
  1922. * Context: must be able to sleep; device not locked; pm locks held
  1923. *
  1924. * Suspends a USB device that isn't in active use, conserving power.
  1925. * Devices may wake out of a suspend, if anything important happens,
  1926. * using the remote wakeup mechanism. They may also be taken out of
  1927. * suspend by the host, using usb_port_resume(). It's also routine
  1928. * to disconnect devices while they are suspended.
  1929. *
  1930. * This only affects the USB hardware for a device; its interfaces
  1931. * (and, for hubs, child devices) must already have been suspended.
  1932. *
  1933. * Selective port suspend reduces power; most suspended devices draw
  1934. * less than 500 uA. It's also used in OTG, along with remote wakeup.
  1935. * All devices below the suspended port are also suspended.
  1936. *
  1937. * Devices leave suspend state when the host wakes them up. Some devices
  1938. * also support "remote wakeup", where the device can activate the USB
  1939. * tree above them to deliver data, such as a keypress or packet. In
  1940. * some cases, this wakes the USB host.
  1941. *
  1942. * Suspending OTG devices may trigger HNP, if that's been enabled
  1943. * between a pair of dual-role devices. That will change roles, such
  1944. * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
  1945. *
  1946. * Devices on USB hub ports have only one "suspend" state, corresponding
  1947. * to ACPI D2, "may cause the device to lose some context".
  1948. * State transitions include:
  1949. *
  1950. * - suspend, resume ... when the VBUS power link stays live
  1951. * - suspend, disconnect ... VBUS lost
  1952. *
  1953. * Once VBUS drop breaks the circuit, the port it's using has to go through
  1954. * normal re-enumeration procedures, starting with enabling VBUS power.
  1955. * Other than re-initializing the hub (plug/unplug, except for root hubs),
  1956. * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
  1957. * timer, no SRP, no requests through sysfs.
  1958. *
  1959. * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
  1960. * the root hub for their bus goes into global suspend ... so we don't
  1961. * (falsely) update the device power state to say it suspended.
  1962. *
  1963. * Returns 0 on success, else negative errno.
  1964. */
  1965. int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
  1966. {
  1967. struct usb_hub *hub = hdev_to_hub(udev->parent);
  1968. int port1 = udev->portnum;
  1969. int status;
  1970. // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
  1971. /* enable remote wakeup when appropriate; this lets the device
  1972. * wake up the upstream hub (including maybe the root hub).
  1973. *
  1974. * NOTE: OTG devices may issue remote wakeup (or SRP) even when
  1975. * we don't explicitly enable it here.
  1976. */
  1977. if (udev->do_remote_wakeup) {
  1978. status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  1979. USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
  1980. USB_DEVICE_REMOTE_WAKEUP, 0,
  1981. NULL, 0,
  1982. USB_CTRL_SET_TIMEOUT);
  1983. if (status) {
  1984. dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
  1985. status);
  1986. /* bail if autosuspend is requested */
  1987. if (msg.event & PM_EVENT_AUTO)
  1988. return status;
  1989. }
  1990. }
  1991. /* see 7.1.7.6 */
  1992. status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
  1993. if (status) {
  1994. dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
  1995. port1, status);
  1996. /* paranoia: "should not happen" */
  1997. if (udev->do_remote_wakeup)
  1998. (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  1999. USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
  2000. USB_DEVICE_REMOTE_WAKEUP, 0,
  2001. NULL, 0,
  2002. USB_CTRL_SET_TIMEOUT);
  2003. } else {
  2004. /* device has up to 10 msec to fully suspend */
  2005. dev_dbg(&udev->dev, "usb %ssuspend\n",
  2006. (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
  2007. usb_set_device_state(udev, USB_STATE_SUSPENDED);
  2008. msleep(10);
  2009. }
  2010. usb_mark_last_busy(hub->hdev);
  2011. return status;
  2012. }
  2013. /*
  2014. * If the USB "suspend" state is in use (rather than "global suspend"),
  2015. * many devices will be individually taken out of suspend state using
  2016. * special "resume" signaling. This routine kicks in shortly after
  2017. * hardware resume signaling is finished, either because of selective
  2018. * resume (by host) or remote wakeup (by device) ... now see what changed
  2019. * in the tree that's rooted at this device.
  2020. *
  2021. * If @udev->reset_resume is set then the device is reset before the
  2022. * status check is done.
  2023. */
  2024. static int finish_port_resume(struct usb_device *udev)
  2025. {
  2026. int status = 0;
  2027. u16 devstatus;
  2028. /* caller owns the udev device lock */
  2029. dev_dbg(&udev->dev, "%s\n",
  2030. udev->reset_resume ? "finish reset-resume" : "finish resume");
  2031. /* usb ch9 identifies four variants of SUSPENDED, based on what
  2032. * state the device resumes to. Linux currently won't see the
  2033. * first two on the host side; they'd be inside hub_port_init()
  2034. * during many timeouts, but khubd can't suspend until later.
  2035. */
  2036. usb_set_device_state(udev, udev->actconfig
  2037. ? USB_STATE_CONFIGURED
  2038. : USB_STATE_ADDRESS);
  2039. /* 10.5.4.5 says not to reset a suspended port if the attached
  2040. * device is enabled for remote wakeup. Hence the reset
  2041. * operation is carried out here, after the port has been
  2042. * resumed.
  2043. */
  2044. if (udev->reset_resume)
  2045. retry_reset_resume:
  2046. status = usb_reset_and_verify_device(udev);
  2047. /* 10.5.4.5 says be sure devices in the tree are still there.
  2048. * For now let's assume the device didn't go crazy on resume,
  2049. * and device drivers will know about any resume quirks.
  2050. */
  2051. if (status == 0) {
  2052. devstatus = 0;
  2053. status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
  2054. if (status >= 0)
  2055. status = (status > 0 ? 0 : -ENODEV);
  2056. /* If a normal resume failed, try doing a reset-resume */
  2057. if (status && !udev->reset_resume && udev->persist_enabled) {
  2058. dev_dbg(&udev->dev, "retry with reset-resume\n");
  2059. udev->reset_resume = 1;
  2060. goto retry_reset_resume;
  2061. }
  2062. }
  2063. if (status) {
  2064. dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
  2065. status);
  2066. } else if (udev->actconfig) {
  2067. le16_to_cpus(&devstatus);
  2068. if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
  2069. status = usb_control_msg(udev,
  2070. usb_sndctrlpipe(udev, 0),
  2071. USB_REQ_CLEAR_FEATURE,
  2072. USB_RECIP_DEVICE,
  2073. USB_DEVICE_REMOTE_WAKEUP, 0,
  2074. NULL, 0,
  2075. USB_CTRL_SET_TIMEOUT);
  2076. if (status)
  2077. dev_dbg(&udev->dev,
  2078. "disable remote wakeup, status %d\n",
  2079. status);
  2080. }
  2081. status = 0;
  2082. }
  2083. return status;
  2084. }
  2085. /*
  2086. * usb_port_resume - re-activate a suspended usb device's upstream port
  2087. * @udev: device to re-activate, not a root hub
  2088. * Context: must be able to sleep; device not locked; pm locks held
  2089. *
  2090. * This will re-activate the suspended device, increasing power usage
  2091. * while letting drivers communicate again with its endpoints.
  2092. * USB resume explicitly guarantees that the power session between
  2093. * the host and the device is the same as it was when the device
  2094. * suspended.
  2095. *
  2096. * If @udev->reset_resume is set then this routine won't check that the
  2097. * port is still enabled. Furthermore, finish_port_resume() above will
  2098. * reset @udev. The end result is that a broken power session can be
  2099. * recovered and @udev will appear to persist across a loss of VBUS power.
  2100. *
  2101. * For example, if a host controller doesn't maintain VBUS suspend current
  2102. * during a system sleep or is reset when the system wakes up, all the USB
  2103. * power sessions below it will be broken. This is especially troublesome
  2104. * for mass-storage devices containing mounted filesystems, since the
  2105. * device will appear to have disconnected and all the memory mappings
  2106. * to it will be lost. Using the USB_PERSIST facility, the device can be
  2107. * made to appear as if it had not disconnected.
  2108. *
  2109. * This facility can be dangerous. Although usb_reset_and_verify_device() makes
  2110. * every effort to insure that the same device is present after the
  2111. * reset as before, it cannot provide a 100% guarantee. Furthermore it's
  2112. * quite possible for a device to remain unaltered but its media to be
  2113. * changed. If the user replaces a flash memory card while the system is
  2114. * asleep, he will have only himself to blame when the filesystem on the
  2115. * new card is corrupted and the system crashes.
  2116. *
  2117. * Returns 0 on success, else negative errno.
  2118. */
  2119. int usb_port_resume(struct usb_device *udev, pm_message_t msg)
  2120. {
  2121. struct usb_hub *hub = hdev_to_hub(udev->parent);
  2122. int port1 = udev->portnum;
  2123. int status;
  2124. u16 portchange, portstatus;
  2125. /* Skip the initial Clear-Suspend step for a remote wakeup */
  2126. status = hub_port_status(hub, port1, &portstatus, &portchange);
  2127. if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
  2128. goto SuspendCleared;
  2129. // dev_dbg(hub->intfdev, "resume port %d\n", port1);
  2130. set_bit(port1, hub->busy_bits);
  2131. /* see 7.1.7.7; affects power usage, but not budgeting */
  2132. status = clear_port_feature(hub->hdev,
  2133. port1, USB_PORT_FEAT_SUSPEND);
  2134. if (status) {
  2135. dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
  2136. port1, status);
  2137. } else {
  2138. /* drive resume for at least 20 msec */
  2139. dev_dbg(&udev->dev, "usb %sresume\n",
  2140. (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
  2141. msleep(25);
  2142. /* Virtual root hubs can trigger on GET_PORT_STATUS to
  2143. * stop resume signaling. Then finish the resume
  2144. * sequence.
  2145. */
  2146. status = hub_port_status(hub, port1, &portstatus, &portchange);
  2147. /* TRSMRCY = 10 msec */
  2148. msleep(10);
  2149. }
  2150. SuspendCleared:
  2151. if (status == 0) {
  2152. if (portchange & USB_PORT_STAT_C_SUSPEND)
  2153. clear_port_feature(hub->hdev, port1,
  2154. USB_PORT_FEAT_C_SUSPEND);
  2155. }
  2156. clear_bit(port1, hub->busy_bits);
  2157. status = check_port_resume_type(udev,
  2158. hub, port1, status, portchange, portstatus);
  2159. if (status == 0)
  2160. status = finish_port_resume(udev);
  2161. if (status < 0) {
  2162. dev_dbg(&udev->dev, "can't resume, status %d\n", status);
  2163. hub_port_logical_disconnect(hub, port1);
  2164. }
  2165. return status;
  2166. }
  2167. /* caller has locked udev */
  2168. int usb_remote_wakeup(struct usb_device *udev)
  2169. {
  2170. int status = 0;
  2171. if (udev->state == USB_STATE_SUSPENDED) {
  2172. dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
  2173. status = usb_autoresume_device(udev);
  2174. if (status == 0) {
  2175. /* Let the drivers do their thing, then... */
  2176. usb_autosuspend_device(udev);
  2177. }
  2178. }
  2179. return status;
  2180. }
  2181. #else /* CONFIG_USB_SUSPEND */
  2182. /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
  2183. int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
  2184. {
  2185. return 0;
  2186. }
  2187. /* However we may need to do a reset-resume */
  2188. int usb_port_resume(struct usb_device *udev, pm_message_t msg)
  2189. {
  2190. struct usb_hub *hub = hdev_to_hub(udev->parent);
  2191. int port1 = udev->portnum;
  2192. int status;
  2193. u16 portchange, portstatus;
  2194. status = hub_port_status(hub, port1, &portstatus, &portchange);
  2195. status = check_port_resume_type(udev,
  2196. hub, port1, status, portchange, portstatus);
  2197. if (status) {
  2198. dev_dbg(&udev->dev, "can't resume, status %d\n", status);
  2199. hub_port_logical_disconnect(hub, port1);
  2200. } else if (udev->reset_resume) {
  2201. dev_dbg(&udev->dev, "reset-resume\n");
  2202. status = usb_reset_and_verify_device(udev);
  2203. }
  2204. return status;
  2205. }
  2206. #endif
  2207. static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
  2208. {
  2209. struct usb_hub *hub = usb_get_intfdata (intf);
  2210. struct usb_device *hdev = hub->hdev;
  2211. unsigned port1;
  2212. /* fail if children aren't already suspended */
  2213. for (port1 = 1; port1 <= hdev->maxchild; port1++) {
  2214. struct usb_device *udev;
  2215. udev = hdev->children [port1-1];
  2216. if (udev && udev->can_submit) {
  2217. if (!(msg.event & PM_EVENT_AUTO))
  2218. dev_dbg(&intf->dev, "port %d nyet suspended\n",
  2219. port1);
  2220. return -EBUSY;
  2221. }
  2222. }
  2223. dev_dbg(&intf->dev, "%s\n", __func__);
  2224. /* stop khubd and related activity */
  2225. hub_quiesce(hub, HUB_SUSPEND);
  2226. return 0;
  2227. }
  2228. static int hub_resume(struct usb_interface *intf)
  2229. {
  2230. struct usb_hub *hub = usb_get_intfdata(intf);
  2231. dev_dbg(&intf->dev, "%s\n", __func__);
  2232. hub_activate(hub, HUB_RESUME);
  2233. return 0;
  2234. }
  2235. static int hub_reset_resume(struct usb_interface *intf)
  2236. {
  2237. struct usb_hub *hub = usb_get_intfdata(intf);
  2238. dev_dbg(&intf->dev, "%s\n", __func__);
  2239. hub_activate(hub, HUB_RESET_RESUME);
  2240. return 0;
  2241. }
  2242. /**
  2243. * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
  2244. * @rhdev: struct usb_device for the root hub
  2245. *
  2246. * The USB host controller driver calls this function when its root hub
  2247. * is resumed and Vbus power has been interrupted or the controller
  2248. * has been reset. The routine marks @rhdev as having lost power.
  2249. * When the hub driver is resumed it will take notice and carry out
  2250. * power-session recovery for all the "USB-PERSIST"-enabled child devices;
  2251. * the others will be disconnected.
  2252. */
  2253. void usb_root_hub_lost_power(struct usb_device *rhdev)
  2254. {
  2255. dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
  2256. rhdev->reset_resume = 1;
  2257. }
  2258. EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
  2259. #else /* CONFIG_PM */
  2260. #define hub_suspend NULL
  2261. #define hub_resume NULL
  2262. #define hub_reset_resume NULL
  2263. #endif
  2264. /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
  2265. *
  2266. * Between connect detection and reset signaling there must be a delay
  2267. * of 100ms at least for debounce and power-settling. The corresponding
  2268. * timer shall restart whenever the downstream port detects a disconnect.
  2269. *
  2270. * Apparently there are some bluetooth and irda-dongles and a number of
  2271. * low-speed devices for which this debounce period may last over a second.
  2272. * Not covered by the spec - but easy to deal with.
  2273. *
  2274. * This implementation uses a 1500ms total debounce timeout; if the
  2275. * connection isn't stable by then it returns -ETIMEDOUT. It checks
  2276. * every 25ms for transient disconnects. When the port status has been
  2277. * unchanged for 100ms it returns the port status.
  2278. */
  2279. static int hub_port_debounce(struct usb_hub *hub, int port1)
  2280. {
  2281. int ret;
  2282. int total_time, stable_time = 0;
  2283. u16 portchange, portstatus;
  2284. unsigned connection = 0xffff;
  2285. for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
  2286. ret = hub_port_status(hub, port1, &portstatus, &portchange);
  2287. if (ret < 0)
  2288. return ret;
  2289. if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
  2290. (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
  2291. stable_time += HUB_DEBOUNCE_STEP;
  2292. if (stable_time >= HUB_DEBOUNCE_STABLE)
  2293. break;
  2294. } else {
  2295. stable_time = 0;
  2296. connection = portstatus & USB_PORT_STAT_CONNECTION;
  2297. }
  2298. if (portchange & USB_PORT_STAT_C_CONNECTION) {
  2299. clear_port_feature(hub->hdev, port1,
  2300. USB_PORT_FEAT_C_CONNECTION);
  2301. }
  2302. if (total_time >= HUB_DEBOUNCE_TIMEOUT)
  2303. break;
  2304. msleep(HUB_DEBOUNCE_STEP);
  2305. }
  2306. dev_dbg (hub->intfdev,
  2307. "debounce: port %d: total %dms stable %dms status 0x%x\n",
  2308. port1, total_time, stable_time, portstatus);
  2309. if (stable_time < HUB_DEBOUNCE_STABLE)
  2310. return -ETIMEDOUT;
  2311. return portstatus;
  2312. }
  2313. void usb_ep0_reinit(struct usb_device *udev)
  2314. {
  2315. usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
  2316. usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
  2317. usb_enable_endpoint(udev, &udev->ep0, true);
  2318. }
  2319. EXPORT_SYMBOL_GPL(usb_ep0_reinit);
  2320. #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
  2321. #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
  2322. static int hub_set_address(struct usb_device *udev, int devnum)
  2323. {
  2324. int retval;
  2325. struct usb_hcd *hcd = bus_to_hcd(udev->bus);
  2326. /*
  2327. * The host controller will choose the device address,
  2328. * instead of the core having chosen it earlier
  2329. */
  2330. if (!hcd->driver->address_device && devnum <= 1)
  2331. return -EINVAL;
  2332. if (udev->state == USB_STATE_ADDRESS)
  2333. return 0;
  2334. if (udev->state != USB_STATE_DEFAULT)
  2335. return -EINVAL;
  2336. if (hcd->driver->address_device)
  2337. retval = hcd->driver->address_device(hcd, udev);
  2338. else
  2339. retval = usb_control_msg(udev, usb_sndaddr0pipe(),
  2340. USB_REQ_SET_ADDRESS, 0, devnum, 0,
  2341. NULL, 0, USB_CTRL_SET_TIMEOUT);
  2342. if (retval == 0) {
  2343. update_devnum(udev, devnum);
  2344. /* Device now using proper address. */
  2345. usb_set_device_state(udev, USB_STATE_ADDRESS);
  2346. usb_ep0_reinit(udev);
  2347. }
  2348. return retval;
  2349. }
  2350. /* Reset device, (re)assign address, get device descriptor.
  2351. * Device connection must be stable, no more debouncing needed.
  2352. * Returns device in USB_STATE_ADDRESS, except on error.
  2353. *
  2354. * If this is called for an already-existing device (as part of
  2355. * usb_reset_and_verify_device), the caller must own the device lock. For a
  2356. * newly detected device that is not accessible through any global
  2357. * pointers, it's not necessary to lock the device.
  2358. */
  2359. static int
  2360. hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
  2361. int retry_counter)
  2362. {
  2363. static DEFINE_MUTEX(usb_address0_mutex);
  2364. struct usb_device *hdev = hub->hdev;
  2365. struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
  2366. int i, j, retval;
  2367. unsigned delay = HUB_SHORT_RESET_TIME;
  2368. enum usb_device_speed oldspeed = udev->speed;
  2369. char *speed, *type;
  2370. int devnum = udev->devnum;
  2371. /* root hub ports have a slightly longer reset period
  2372. * (from USB 2.0 spec, section 7.1.7.5)
  2373. */
  2374. if (!hdev->parent) {
  2375. delay = HUB_ROOT_RESET_TIME;
  2376. if (port1 == hdev->bus->otg_port)
  2377. hdev->bus->b_hnp_enable = 0;
  2378. }
  2379. /* Some low speed devices have problems with the quick delay, so */
  2380. /* be a bit pessimistic with those devices. RHbug #23670 */
  2381. if (oldspeed == USB_SPEED_LOW)
  2382. delay = HUB_LONG_RESET_TIME;
  2383. mutex_lock(&usb_address0_mutex);
  2384. if (!udev->config && oldspeed == USB_SPEED_SUPER) {
  2385. /* Don't reset USB 3.0 devices during an initial setup */
  2386. usb_set_device_state(udev, USB_STATE_DEFAULT);
  2387. } else {
  2388. /* Reset the device; full speed may morph to high speed */
  2389. /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
  2390. retval = hub_port_reset(hub, port1, udev, delay);
  2391. if (retval < 0) /* error or disconnect */
  2392. goto fail;
  2393. /* success, speed is known */
  2394. }
  2395. retval = -ENODEV;
  2396. if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
  2397. dev_dbg(&udev->dev, "device reset changed speed!\n");
  2398. goto fail;
  2399. }
  2400. oldspeed = udev->speed;
  2401. /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
  2402. * it's fixed size except for full speed devices.
  2403. * For Wireless USB devices, ep0 max packet is always 512 (tho
  2404. * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
  2405. */
  2406. switch (udev->speed) {
  2407. case USB_SPEED_SUPER:
  2408. case USB_SPEED_WIRELESS: /* fixed at 512 */
  2409. udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
  2410. break;
  2411. case USB_SPEED_HIGH: /* fixed at 64 */
  2412. udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
  2413. break;
  2414. case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
  2415. /* to determine the ep0 maxpacket size, try to read
  2416. * the device descriptor to get bMaxPacketSize0 and
  2417. * then correct our initial guess.
  2418. */
  2419. udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
  2420. break;
  2421. case USB_SPEED_LOW: /* fixed at 8 */
  2422. udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
  2423. break;
  2424. default:
  2425. goto fail;
  2426. }
  2427. type = "";
  2428. switch (udev->speed) {
  2429. case USB_SPEED_LOW: speed = "low"; break;
  2430. case USB_SPEED_FULL: speed = "full"; break;
  2431. case USB_SPEED_HIGH: speed = "high"; break;
  2432. case USB_SPEED_SUPER:
  2433. speed = "super";
  2434. break;
  2435. case USB_SPEED_WIRELESS:
  2436. speed = "variable";
  2437. type = "Wireless ";
  2438. break;
  2439. default: speed = "?"; break;
  2440. }
  2441. if (udev->speed != USB_SPEED_SUPER)
  2442. dev_info(&udev->dev,
  2443. "%s %s speed %sUSB device number %d using %s\n",
  2444. (udev->config) ? "reset" : "new", speed, type,
  2445. devnum, udev->bus->controller->driver->name);
  2446. /* Set up TT records, if needed */
  2447. if (hdev->tt) {
  2448. udev->tt = hdev->tt;
  2449. udev->ttport = hdev->ttport;
  2450. } else if (udev->speed != USB_SPEED_HIGH
  2451. && hdev->speed == USB_SPEED_HIGH) {
  2452. if (!hub->tt.hub) {
  2453. dev_err(&udev->dev, "parent hub has no TT\n");
  2454. retval = -EINVAL;
  2455. goto fail;
  2456. }
  2457. udev->tt = &hub->tt;
  2458. udev->ttport = port1;
  2459. }
  2460. /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
  2461. * Because device hardware and firmware is sometimes buggy in
  2462. * this area, and this is how Linux has done it for ages.
  2463. * Change it cautiously.
  2464. *
  2465. * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
  2466. * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
  2467. * so it may help with some non-standards-compliant devices.
  2468. * Otherwise we start with SET_ADDRESS and then try to read the
  2469. * first 8 bytes of the device descriptor to get the ep0 maxpacket
  2470. * value.
  2471. */
  2472. for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
  2473. if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
  2474. struct usb_device_descriptor *buf;
  2475. int r = 0;
  2476. #define GET_DESCRIPTOR_BUFSIZE 64
  2477. buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
  2478. if (!buf) {
  2479. retval = -ENOMEM;
  2480. continue;
  2481. }
  2482. /* Retry on all errors; some devices are flakey.
  2483. * 255 is for WUSB devices, we actually need to use
  2484. * 512 (WUSB1.0[4.8.1]).
  2485. */
  2486. for (j = 0; j < 3; ++j) {
  2487. buf->bMaxPacketSize0 = 0;
  2488. r = usb_control_msg(udev, usb_rcvaddr0pipe(),
  2489. USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
  2490. USB_DT_DEVICE << 8, 0,
  2491. buf, GET_DESCRIPTOR_BUFSIZE,
  2492. initial_descriptor_timeout);
  2493. switch (buf->bMaxPacketSize0) {
  2494. case 8: case 16: case 32: case 64: case 255:
  2495. if (buf->bDescriptorType ==
  2496. USB_DT_DEVICE) {
  2497. r = 0;
  2498. break;
  2499. }
  2500. /* FALL THROUGH */
  2501. default:
  2502. if (r == 0)
  2503. r = -EPROTO;
  2504. break;
  2505. }
  2506. if (r == 0)
  2507. break;
  2508. }
  2509. udev->descriptor.bMaxPacketSize0 =
  2510. buf->bMaxPacketSize0;
  2511. kfree(buf);
  2512. retval = hub_port_reset(hub, port1, udev, delay);
  2513. if (retval < 0) /* error or disconnect */
  2514. goto fail;
  2515. if (oldspeed != udev->speed) {
  2516. dev_dbg(&udev->dev,
  2517. "device reset changed speed!\n");
  2518. retval = -ENODEV;
  2519. goto fail;
  2520. }
  2521. if (r) {
  2522. dev_err(&udev->dev,
  2523. "device descriptor read/64, error %d\n",
  2524. r);
  2525. retval = -EMSGSIZE;
  2526. continue;
  2527. }
  2528. #undef GET_DESCRIPTOR_BUFSIZE
  2529. }
  2530. /*
  2531. * If device is WUSB, we already assigned an
  2532. * unauthorized address in the Connect Ack sequence;
  2533. * authorization will assign the final address.
  2534. */
  2535. if (udev->wusb == 0) {
  2536. for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
  2537. retval = hub_set_address(udev, devnum);
  2538. if (retval >= 0)
  2539. break;
  2540. msleep(200);
  2541. }
  2542. if (retval < 0) {
  2543. dev_err(&udev->dev,
  2544. "device not accepting address %d, error %d\n",
  2545. devnum, retval);
  2546. goto fail;
  2547. }
  2548. if (udev->speed == USB_SPEED_SUPER) {
  2549. devnum = udev->devnum;
  2550. dev_info(&udev->dev,
  2551. "%s SuperSpeed USB device number %d using %s\n",
  2552. (udev->config) ? "reset" : "new",
  2553. devnum, udev->bus->controller->driver->name);
  2554. }
  2555. /* cope with hardware quirkiness:
  2556. * - let SET_ADDRESS settle, some device hardware wants it
  2557. * - read ep0 maxpacket even for high and low speed,
  2558. */
  2559. msleep(10);
  2560. if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
  2561. break;
  2562. }
  2563. retval = usb_get_device_descriptor(udev, 8);
  2564. if (retval < 8) {
  2565. dev_err(&udev->dev,
  2566. "device descriptor read/8, error %d\n",
  2567. retval);
  2568. if (retval >= 0)
  2569. retval = -EMSGSIZE;
  2570. } else {
  2571. retval = 0;
  2572. break;
  2573. }
  2574. }
  2575. if (retval)
  2576. goto fail;
  2577. if (udev->descriptor.bMaxPacketSize0 == 0xff ||
  2578. udev->speed == USB_SPEED_SUPER)
  2579. i = 512;
  2580. else
  2581. i = udev->descriptor.bMaxPacketSize0;
  2582. if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
  2583. if (udev->speed == USB_SPEED_LOW ||
  2584. !(i == 8 || i == 16 || i == 32 || i == 64)) {
  2585. dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
  2586. retval = -EMSGSIZE;
  2587. goto fail;
  2588. }
  2589. if (udev->speed == USB_SPEED_FULL)
  2590. dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
  2591. else
  2592. dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
  2593. udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
  2594. usb_ep0_reinit(udev);
  2595. }
  2596. retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
  2597. if (retval < (signed)sizeof(udev->descriptor)) {
  2598. dev_err(&udev->dev, "device descriptor read/all, error %d\n",
  2599. retval);
  2600. if (retval >= 0)
  2601. retval = -ENOMSG;
  2602. goto fail;
  2603. }
  2604. retval = 0;
  2605. /* notify HCD that we have a device connected and addressed */
  2606. if (hcd->driver->update_device)
  2607. hcd->driver->update_device(hcd, udev);
  2608. fail:
  2609. if (retval) {
  2610. hub_port_disable(hub, port1, 0);
  2611. update_devnum(udev, devnum); /* for disconnect processing */
  2612. }
  2613. mutex_unlock(&usb_address0_mutex);
  2614. return retval;
  2615. }
  2616. static void
  2617. check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
  2618. {
  2619. struct usb_qualifier_descriptor *qual;
  2620. int status;
  2621. qual = kmalloc (sizeof *qual, GFP_KERNEL);
  2622. if (qual == NULL)
  2623. return;
  2624. status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
  2625. qual, sizeof *qual);
  2626. if (status == sizeof *qual) {
  2627. dev_info(&udev->dev, "not running at top speed; "
  2628. "connect to a high speed hub\n");
  2629. /* hub LEDs are probably harder to miss than syslog */
  2630. if (hub->has_indicators) {
  2631. hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
  2632. schedule_delayed_work (&hub->leds, 0);
  2633. }
  2634. }
  2635. kfree(qual);
  2636. }
  2637. static unsigned
  2638. hub_power_remaining (struct usb_hub *hub)
  2639. {
  2640. struct usb_device *hdev = hub->hdev;
  2641. int remaining;
  2642. int port1;
  2643. if (!hub->limited_power)
  2644. return 0;
  2645. remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
  2646. for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
  2647. struct usb_device *udev = hdev->children[port1 - 1];
  2648. int delta;
  2649. if (!udev)
  2650. continue;
  2651. /* Unconfigured devices may not use more than 100mA,
  2652. * or 8mA for OTG ports */
  2653. if (udev->actconfig)
  2654. delta = udev->actconfig->desc.bMaxPower * 2;
  2655. else if (port1 != udev->bus->otg_port || hdev->parent)
  2656. delta = 100;
  2657. else
  2658. delta = 8;
  2659. if (delta > hub->mA_per_port)
  2660. dev_warn(&udev->dev,
  2661. "%dmA is over %umA budget for port %d!\n",
  2662. delta, hub->mA_per_port, port1);
  2663. remaining -= delta;
  2664. }
  2665. if (remaining < 0) {
  2666. dev_warn(hub->intfdev, "%dmA over power budget!\n",
  2667. - remaining);
  2668. remaining = 0;
  2669. }
  2670. return remaining;
  2671. }
  2672. /* Handle physical or logical connection change events.
  2673. * This routine is called when:
  2674. * a port connection-change occurs;
  2675. * a port enable-change occurs (often caused by EMI);
  2676. * usb_reset_and_verify_device() encounters changed descriptors (as from
  2677. * a firmware download)
  2678. * caller already locked the hub
  2679. */
  2680. static void hub_port_connect_change(struct usb_hub *hub, int port1,
  2681. u16 portstatus, u16 portchange)
  2682. {
  2683. struct usb_device *hdev = hub->hdev;
  2684. struct device *hub_dev = hub->intfdev;
  2685. struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
  2686. unsigned wHubCharacteristics =
  2687. le16_to_cpu(hub->descriptor->wHubCharacteristics);
  2688. struct usb_device *udev;
  2689. int status, i;
  2690. dev_dbg (hub_dev,
  2691. "port %d, status %04x, change %04x, %s\n",
  2692. port1, portstatus, portchange, portspeed(hub, portstatus));
  2693. if (hub->has_indicators) {
  2694. set_port_led(hub, port1, HUB_LED_AUTO);
  2695. hub->indicator[port1-1] = INDICATOR_AUTO;
  2696. }
  2697. #ifdef CONFIG_USB_OTG
  2698. /* during HNP, don't repeat the debounce */
  2699. if (hdev->bus->is_b_host)
  2700. portchange &= ~(USB_PORT_STAT_C_CONNECTION |
  2701. USB_PORT_STAT_C_ENABLE);
  2702. #endif
  2703. /* Try to resuscitate an existing device */
  2704. udev = hdev->children[port1-1];
  2705. if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
  2706. udev->state != USB_STATE_NOTATTACHED) {
  2707. usb_lock_device(udev);
  2708. if (portstatus & USB_PORT_STAT_ENABLE) {
  2709. status = 0; /* Nothing to do */
  2710. #ifdef CONFIG_USB_SUSPEND
  2711. } else if (udev->state == USB_STATE_SUSPENDED &&
  2712. udev->persist_enabled) {
  2713. /* For a suspended device, treat this as a
  2714. * remote wakeup event.
  2715. */
  2716. status = usb_remote_wakeup(udev);
  2717. #endif
  2718. } else {
  2719. status = -ENODEV; /* Don't resuscitate */
  2720. }
  2721. usb_unlock_device(udev);
  2722. if (status == 0) {
  2723. clear_bit(port1, hub->change_bits);
  2724. return;
  2725. }
  2726. }
  2727. /* Disconnect any existing devices under this port */
  2728. if (udev)
  2729. usb_disconnect(&hdev->children[port1-1]);
  2730. clear_bit(port1, hub->change_bits);
  2731. /* We can forget about a "removed" device when there's a physical
  2732. * disconnect or the connect status changes.
  2733. */
  2734. if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
  2735. (portchange & USB_PORT_STAT_C_CONNECTION))
  2736. clear_bit(port1, hub->removed_bits);
  2737. if (portchange & (USB_PORT_STAT_C_CONNECTION |
  2738. USB_PORT_STAT_C_ENABLE)) {
  2739. status = hub_port_debounce(hub, port1);
  2740. if (status < 0) {
  2741. if (printk_ratelimit())
  2742. dev_err(hub_dev, "connect-debounce failed, "
  2743. "port %d disabled\n", port1);
  2744. portstatus &= ~USB_PORT_STAT_CONNECTION;
  2745. } else {
  2746. portstatus = status;
  2747. }
  2748. }
  2749. /* Return now if debouncing failed or nothing is connected or
  2750. * the device was "removed".
  2751. */
  2752. if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
  2753. test_bit(port1, hub->removed_bits)) {
  2754. /* maybe switch power back on (e.g. root hub was reset) */
  2755. if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
  2756. && !(portstatus & USB_PORT_STAT_POWER))
  2757. set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
  2758. if (portstatus & USB_PORT_STAT_ENABLE)
  2759. goto done;
  2760. return;
  2761. }
  2762. for (i = 0; i < SET_CONFIG_TRIES; i++) {
  2763. /* reallocate for each attempt, since references
  2764. * to the previous one can escape in various ways
  2765. */
  2766. udev = usb_alloc_dev(hdev, hdev->bus, port1);
  2767. if (!udev) {
  2768. dev_err (hub_dev,
  2769. "couldn't allocate port %d usb_device\n",
  2770. port1);
  2771. goto done;
  2772. }
  2773. usb_set_device_state(udev, USB_STATE_POWERED);
  2774. udev->bus_mA = hub->mA_per_port;
  2775. udev->level = hdev->level + 1;
  2776. udev->wusb = hub_is_wusb(hub);
  2777. /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
  2778. if (hub_is_superspeed(hub->hdev))
  2779. udev->speed = USB_SPEED_SUPER;
  2780. else
  2781. udev->speed = USB_SPEED_UNKNOWN;
  2782. choose_devnum(udev);
  2783. if (udev->devnum <= 0) {
  2784. status = -ENOTCONN; /* Don't retry */
  2785. goto loop;
  2786. }
  2787. /* reset (non-USB 3.0 devices) and get descriptor */
  2788. status = hub_port_init(hub, udev, port1, i);
  2789. if (status < 0)
  2790. goto loop;
  2791. usb_detect_quirks(udev);
  2792. if (udev->quirks & USB_QUIRK_DELAY_INIT)
  2793. msleep(1000);
  2794. /* consecutive bus-powered hubs aren't reliable; they can
  2795. * violate the voltage drop budget. if the new child has
  2796. * a "powered" LED, users should notice we didn't enable it
  2797. * (without reading syslog), even without per-port LEDs
  2798. * on the parent.
  2799. */
  2800. if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
  2801. && udev->bus_mA <= 100) {
  2802. u16 devstat;
  2803. status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
  2804. &devstat);
  2805. if (status < 2) {
  2806. dev_dbg(&udev->dev, "get status %d ?\n", status);
  2807. goto loop_disable;
  2808. }
  2809. le16_to_cpus(&devstat);
  2810. if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
  2811. dev_err(&udev->dev,
  2812. "can't connect bus-powered hub "
  2813. "to this port\n");
  2814. if (hub->has_indicators) {
  2815. hub->indicator[port1-1] =
  2816. INDICATOR_AMBER_BLINK;
  2817. schedule_delayed_work (&hub->leds, 0);
  2818. }
  2819. status = -ENOTCONN; /* Don't retry */
  2820. goto loop_disable;
  2821. }
  2822. }
  2823. /* check for devices running slower than they could */
  2824. if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
  2825. && udev->speed == USB_SPEED_FULL
  2826. && highspeed_hubs != 0)
  2827. check_highspeed (hub, udev, port1);
  2828. /* Store the parent's children[] pointer. At this point
  2829. * udev becomes globally accessible, although presumably
  2830. * no one will look at it until hdev is unlocked.
  2831. */
  2832. status = 0;
  2833. /* We mustn't add new devices if the parent hub has
  2834. * been disconnected; we would race with the
  2835. * recursively_mark_NOTATTACHED() routine.
  2836. */
  2837. spin_lock_irq(&device_state_lock);
  2838. if (hdev->state == USB_STATE_NOTATTACHED)
  2839. status = -ENOTCONN;
  2840. else
  2841. hdev->children[port1-1] = udev;
  2842. spin_unlock_irq(&device_state_lock);
  2843. /* Run it through the hoops (find a driver, etc) */
  2844. if (!status) {
  2845. status = usb_new_device(udev);
  2846. if (status) {
  2847. spin_lock_irq(&device_state_lock);
  2848. hdev->children[port1-1] = NULL;
  2849. spin_unlock_irq(&device_state_lock);
  2850. }
  2851. }
  2852. if (status)
  2853. goto loop_disable;
  2854. status = hub_power_remaining(hub);
  2855. if (status)
  2856. dev_dbg(hub_dev, "%dmA power budget left\n", status);
  2857. return;
  2858. loop_disable:
  2859. hub_port_disable(hub, port1, 1);
  2860. loop:
  2861. usb_ep0_reinit(udev);
  2862. release_devnum(udev);
  2863. hub_free_dev(udev);
  2864. usb_put_dev(udev);
  2865. if ((status == -ENOTCONN) || (status == -ENOTSUPP))
  2866. break;
  2867. }
  2868. if (hub->hdev->parent ||
  2869. !hcd->driver->port_handed_over ||
  2870. !(hcd->driver->port_handed_over)(hcd, port1))
  2871. dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
  2872. port1);
  2873. done:
  2874. hub_port_disable(hub, port1, 1);
  2875. if (hcd->driver->relinquish_port && !hub->hdev->parent)
  2876. hcd->driver->relinquish_port(hcd, port1);
  2877. }
  2878. static void hub_events(void)
  2879. {
  2880. struct list_head *tmp;
  2881. struct usb_device *hdev;
  2882. struct usb_interface *intf;
  2883. struct usb_hub *hub;
  2884. struct device *hub_dev;
  2885. u16 hubstatus;
  2886. u16 hubchange;
  2887. u16 portstatus;
  2888. u16 portchange;
  2889. int i, ret;
  2890. int connect_change;
  2891. /*
  2892. * We restart the list every time to avoid a deadlock with
  2893. * deleting hubs downstream from this one. This should be
  2894. * safe since we delete the hub from the event list.
  2895. * Not the most efficient, but avoids deadlocks.
  2896. */
  2897. while (1) {
  2898. /* Grab the first entry at the beginning of the list */
  2899. spin_lock_irq(&hub_event_lock);
  2900. if (list_empty(&hub_event_list)) {
  2901. spin_unlock_irq(&hub_event_lock);
  2902. break;
  2903. }
  2904. tmp = hub_event_list.next;
  2905. list_del_init(tmp);
  2906. hub = list_entry(tmp, struct usb_hub, event_list);
  2907. kref_get(&hub->kref);
  2908. spin_unlock_irq(&hub_event_lock);
  2909. hdev = hub->hdev;
  2910. hub_dev = hub->intfdev;
  2911. intf = to_usb_interface(hub_dev);
  2912. dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
  2913. hdev->state, hub->descriptor
  2914. ? hub->descriptor->bNbrPorts
  2915. : 0,
  2916. /* NOTE: expects max 15 ports... */
  2917. (u16) hub->change_bits[0],
  2918. (u16) hub->event_bits[0]);
  2919. /* Lock the device, then check to see if we were
  2920. * disconnected while waiting for the lock to succeed. */
  2921. usb_lock_device(hdev);
  2922. if (unlikely(hub->disconnected))
  2923. goto loop_disconnected;
  2924. /* If the hub has died, clean up after it */
  2925. if (hdev->state == USB_STATE_NOTATTACHED) {
  2926. hub->error = -ENODEV;
  2927. hub_quiesce(hub, HUB_DISCONNECT);
  2928. goto loop;
  2929. }
  2930. /* Autoresume */
  2931. ret = usb_autopm_get_interface(intf);
  2932. if (ret) {
  2933. dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
  2934. goto loop;
  2935. }
  2936. /* If this is an inactive hub, do nothing */
  2937. if (hub->quiescing)
  2938. goto loop_autopm;
  2939. if (hub->error) {
  2940. dev_dbg (hub_dev, "resetting for error %d\n",
  2941. hub->error);
  2942. ret = usb_reset_device(hdev);
  2943. if (ret) {
  2944. dev_dbg (hub_dev,
  2945. "error resetting hub: %d\n", ret);
  2946. goto loop_autopm;
  2947. }
  2948. hub->nerrors = 0;
  2949. hub->error = 0;
  2950. }
  2951. /* deal with port status changes */
  2952. for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
  2953. if (test_bit(i, hub->busy_bits))
  2954. continue;
  2955. connect_change = test_bit(i, hub->change_bits);
  2956. if (!test_and_clear_bit(i, hub->event_bits) &&
  2957. !connect_change)
  2958. continue;
  2959. ret = hub_port_status(hub, i,
  2960. &portstatus, &portchange);
  2961. if (ret < 0)
  2962. continue;
  2963. if (portchange & USB_PORT_STAT_C_CONNECTION) {
  2964. clear_port_feature(hdev, i,
  2965. USB_PORT_FEAT_C_CONNECTION);
  2966. connect_change = 1;
  2967. }
  2968. if (portchange & USB_PORT_STAT_C_ENABLE) {
  2969. if (!connect_change)
  2970. dev_dbg (hub_dev,
  2971. "port %d enable change, "
  2972. "status %08x\n",
  2973. i, portstatus);
  2974. clear_port_feature(hdev, i,
  2975. USB_PORT_FEAT_C_ENABLE);
  2976. /*
  2977. * EM interference sometimes causes badly
  2978. * shielded USB devices to be shutdown by
  2979. * the hub, this hack enables them again.
  2980. * Works at least with mouse driver.
  2981. */
  2982. if (!(portstatus & USB_PORT_STAT_ENABLE)
  2983. && !connect_change
  2984. && hdev->children[i-1]) {
  2985. dev_err (hub_dev,
  2986. "port %i "
  2987. "disabled by hub (EMI?), "
  2988. "re-enabling...\n",
  2989. i);
  2990. connect_change = 1;
  2991. }
  2992. }
  2993. if (portchange & USB_PORT_STAT_C_SUSPEND) {
  2994. struct usb_device *udev;
  2995. clear_port_feature(hdev, i,
  2996. USB_PORT_FEAT_C_SUSPEND);
  2997. udev = hdev->children[i-1];
  2998. if (udev) {
  2999. /* TRSMRCY = 10 msec */
  3000. msleep(10);
  3001. usb_lock_device(udev);
  3002. ret = usb_remote_wakeup(hdev->
  3003. children[i-1]);
  3004. usb_unlock_device(udev);
  3005. if (ret < 0)
  3006. connect_change = 1;
  3007. } else {
  3008. ret = -ENODEV;
  3009. hub_port_disable(hub, i, 1);
  3010. }
  3011. dev_dbg (hub_dev,
  3012. "resume on port %d, status %d\n",
  3013. i, ret);
  3014. }
  3015. if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
  3016. u16 status = 0;
  3017. u16 unused;
  3018. dev_dbg(hub_dev, "over-current change on port "
  3019. "%d\n", i);
  3020. clear_port_feature(hdev, i,
  3021. USB_PORT_FEAT_C_OVER_CURRENT);
  3022. msleep(100); /* Cool down */
  3023. hub_power_on(hub, true);
  3024. hub_port_status(hub, i, &status, &unused);
  3025. if (status & USB_PORT_STAT_OVERCURRENT)
  3026. dev_err(hub_dev, "over-current "
  3027. "condition on port %d\n", i);
  3028. }
  3029. if (portchange & USB_PORT_STAT_C_RESET) {
  3030. dev_dbg (hub_dev,
  3031. "reset change on port %d\n",
  3032. i);
  3033. clear_port_feature(hdev, i,
  3034. USB_PORT_FEAT_C_RESET);
  3035. }
  3036. if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
  3037. hub_is_superspeed(hub->hdev)) {
  3038. dev_dbg(hub_dev,
  3039. "warm reset change on port %d\n",
  3040. i);
  3041. clear_port_feature(hdev, i,
  3042. USB_PORT_FEAT_C_BH_PORT_RESET);
  3043. }
  3044. if (portchange & USB_PORT_STAT_C_LINK_STATE) {
  3045. clear_port_feature(hub->hdev, i,
  3046. USB_PORT_FEAT_C_PORT_LINK_STATE);
  3047. }
  3048. if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
  3049. dev_warn(hub_dev,
  3050. "config error on port %d\n",
  3051. i);
  3052. clear_port_feature(hub->hdev, i,
  3053. USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
  3054. }
  3055. if (connect_change)
  3056. hub_port_connect_change(hub, i,
  3057. portstatus, portchange);
  3058. } /* end for i */
  3059. /* deal with hub status changes */
  3060. if (test_and_clear_bit(0, hub->event_bits) == 0)
  3061. ; /* do nothing */
  3062. else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
  3063. dev_err (hub_dev, "get_hub_status failed\n");
  3064. else {
  3065. if (hubchange & HUB_CHANGE_LOCAL_POWER) {
  3066. dev_dbg (hub_dev, "power change\n");
  3067. clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
  3068. if (hubstatus & HUB_STATUS_LOCAL_POWER)
  3069. /* FIXME: Is this always true? */
  3070. hub->limited_power = 1;
  3071. else
  3072. hub->limited_power = 0;
  3073. }
  3074. if (hubchange & HUB_CHANGE_OVERCURRENT) {
  3075. u16 status = 0;
  3076. u16 unused;
  3077. dev_dbg(hub_dev, "over-current change\n");
  3078. clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
  3079. msleep(500); /* Cool down */
  3080. hub_power_on(hub, true);
  3081. hub_hub_status(hub, &status, &unused);
  3082. if (status & HUB_STATUS_OVERCURRENT)
  3083. dev_err(hub_dev, "over-current "
  3084. "condition\n");
  3085. }
  3086. }
  3087. loop_autopm:
  3088. /* Balance the usb_autopm_get_interface() above */
  3089. usb_autopm_put_interface_no_suspend(intf);
  3090. loop:
  3091. /* Balance the usb_autopm_get_interface_no_resume() in
  3092. * kick_khubd() and allow autosuspend.
  3093. */
  3094. usb_autopm_put_interface(intf);
  3095. loop_disconnected:
  3096. usb_unlock_device(hdev);
  3097. kref_put(&hub->kref, hub_release);
  3098. } /* end while (1) */
  3099. }
  3100. static int hub_thread(void *__unused)
  3101. {
  3102. /* khubd needs to be freezable to avoid intefering with USB-PERSIST
  3103. * port handover. Otherwise it might see that a full-speed device
  3104. * was gone before the EHCI controller had handed its port over to
  3105. * the companion full-speed controller.
  3106. */
  3107. set_freezable();
  3108. do {
  3109. hub_events();
  3110. wait_event_freezable(khubd_wait,
  3111. !list_empty(&hub_event_list) ||
  3112. kthread_should_stop());
  3113. } while (!kthread_should_stop() || !list_empty(&hub_event_list));
  3114. pr_debug("%s: khubd exiting\n", usbcore_name);
  3115. return 0;
  3116. }
  3117. static const struct usb_device_id hub_id_table[] = {
  3118. { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
  3119. .bDeviceClass = USB_CLASS_HUB},
  3120. { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
  3121. .bInterfaceClass = USB_CLASS_HUB},
  3122. { } /* Terminating entry */
  3123. };
  3124. MODULE_DEVICE_TABLE (usb, hub_id_table);
  3125. static struct usb_driver hub_driver = {
  3126. .name = "hub",
  3127. .probe = hub_probe,
  3128. .disconnect = hub_disconnect,
  3129. .suspend = hub_suspend,
  3130. .resume = hub_resume,
  3131. .reset_resume = hub_reset_resume,
  3132. .pre_reset = hub_pre_reset,
  3133. .post_reset = hub_post_reset,
  3134. .unlocked_ioctl = hub_ioctl,
  3135. .id_table = hub_id_table,
  3136. .supports_autosuspend = 1,
  3137. };
  3138. int usb_hub_init(void)
  3139. {
  3140. if (usb_register(&hub_driver) < 0) {
  3141. printk(KERN_ERR "%s: can't register hub driver\n",
  3142. usbcore_name);
  3143. return -1;
  3144. }
  3145. khubd_task = kthread_run(hub_thread, NULL, "khubd");
  3146. if (!IS_ERR(khubd_task))
  3147. return 0;
  3148. /* Fall through if kernel_thread failed */
  3149. usb_deregister(&hub_driver);
  3150. printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
  3151. return -1;
  3152. }
  3153. void usb_hub_cleanup(void)
  3154. {
  3155. kthread_stop(khubd_task);
  3156. /*
  3157. * Hub resources are freed for us by usb_deregister. It calls
  3158. * usb_driver_purge on every device which in turn calls that
  3159. * devices disconnect function if it is using this driver.
  3160. * The hub_disconnect function takes care of releasing the
  3161. * individual hub resources. -greg
  3162. */
  3163. usb_deregister(&hub_driver);
  3164. } /* usb_hub_cleanup() */
  3165. static int descriptors_changed(struct usb_device *udev,
  3166. struct usb_device_descriptor *old_device_descriptor)
  3167. {
  3168. int changed = 0;
  3169. unsigned index;
  3170. unsigned serial_len = 0;
  3171. unsigned len;
  3172. unsigned old_length;
  3173. int length;
  3174. char *buf;
  3175. if (memcmp(&udev->descriptor, old_device_descriptor,
  3176. sizeof(*old_device_descriptor)) != 0)
  3177. return 1;
  3178. /* Since the idVendor, idProduct, and bcdDevice values in the
  3179. * device descriptor haven't changed, we will assume the
  3180. * Manufacturer and Product strings haven't changed either.
  3181. * But the SerialNumber string could be different (e.g., a
  3182. * different flash card of the same brand).
  3183. */
  3184. if (udev->serial)
  3185. serial_len = strlen(udev->serial) + 1;
  3186. len = serial_len;
  3187. for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
  3188. old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
  3189. len = max(len, old_length);
  3190. }
  3191. buf = kmalloc(len, GFP_NOIO);
  3192. if (buf == NULL) {
  3193. dev_err(&udev->dev, "no mem to re-read configs after reset\n");
  3194. /* assume the worst */
  3195. return 1;
  3196. }
  3197. for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
  3198. old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
  3199. length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
  3200. old_length);
  3201. if (length != old_length) {
  3202. dev_dbg(&udev->dev, "config index %d, error %d\n",
  3203. index, length);
  3204. changed = 1;
  3205. break;
  3206. }
  3207. if (memcmp (buf, udev->rawdescriptors[index], old_length)
  3208. != 0) {
  3209. dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
  3210. index,
  3211. ((struct usb_config_descriptor *) buf)->
  3212. bConfigurationValue);
  3213. changed = 1;
  3214. break;
  3215. }
  3216. }
  3217. if (!changed && serial_len) {
  3218. length = usb_string(udev, udev->descriptor.iSerialNumber,
  3219. buf, serial_len);
  3220. if (length + 1 != serial_len) {
  3221. dev_dbg(&udev->dev, "serial string error %d\n",
  3222. length);
  3223. changed = 1;
  3224. } else if (memcmp(buf, udev->serial, length) != 0) {
  3225. dev_dbg(&udev->dev, "serial string changed\n");
  3226. changed = 1;
  3227. }
  3228. }
  3229. kfree(buf);
  3230. return changed;
  3231. }
  3232. /**
  3233. * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
  3234. * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
  3235. *
  3236. * WARNING - don't use this routine to reset a composite device
  3237. * (one with multiple interfaces owned by separate drivers)!
  3238. * Use usb_reset_device() instead.
  3239. *
  3240. * Do a port reset, reassign the device's address, and establish its
  3241. * former operating configuration. If the reset fails, or the device's
  3242. * descriptors change from their values before the reset, or the original
  3243. * configuration and altsettings cannot be restored, a flag will be set
  3244. * telling khubd to pretend the device has been disconnected and then
  3245. * re-connected. All drivers will be unbound, and the device will be
  3246. * re-enumerated and probed all over again.
  3247. *
  3248. * Returns 0 if the reset succeeded, -ENODEV if the device has been
  3249. * flagged for logical disconnection, or some other negative error code
  3250. * if the reset wasn't even attempted.
  3251. *
  3252. * The caller must own the device lock. For example, it's safe to use
  3253. * this from a driver probe() routine after downloading new firmware.
  3254. * For calls that might not occur during probe(), drivers should lock
  3255. * the device using usb_lock_device_for_reset().
  3256. *
  3257. * Locking exception: This routine may also be called from within an
  3258. * autoresume handler. Such usage won't conflict with other tasks
  3259. * holding the device lock because these tasks should always call
  3260. * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
  3261. */
  3262. static int usb_reset_and_verify_device(struct usb_device *udev)
  3263. {
  3264. struct usb_device *parent_hdev = udev->parent;
  3265. struct usb_hub *parent_hub;
  3266. struct usb_hcd *hcd = bus_to_hcd(udev->bus);
  3267. struct usb_device_descriptor descriptor = udev->descriptor;
  3268. int i, ret = 0;
  3269. int port1 = udev->portnum;
  3270. if (udev->state == USB_STATE_NOTATTACHED ||
  3271. udev->state == USB_STATE_SUSPENDED) {
  3272. dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
  3273. udev->state);
  3274. return -EINVAL;
  3275. }
  3276. if (!parent_hdev) {
  3277. /* this requires hcd-specific logic; see ohci_restart() */
  3278. dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
  3279. return -EISDIR;
  3280. }
  3281. parent_hub = hdev_to_hub(parent_hdev);
  3282. set_bit(port1, parent_hub->busy_bits);
  3283. for (i = 0; i < SET_CONFIG_TRIES; ++i) {
  3284. /* ep0 maxpacket size may change; let the HCD know about it.
  3285. * Other endpoints will be handled by re-enumeration. */
  3286. usb_ep0_reinit(udev);
  3287. ret = hub_port_init(parent_hub, udev, port1, i);
  3288. if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
  3289. break;
  3290. }
  3291. clear_bit(port1, parent_hub->busy_bits);
  3292. if (ret < 0)
  3293. goto re_enumerate;
  3294. /* Device might have changed firmware (DFU or similar) */
  3295. if (descriptors_changed(udev, &descriptor)) {
  3296. dev_info(&udev->dev, "device firmware changed\n");
  3297. udev->descriptor = descriptor; /* for disconnect() calls */
  3298. goto re_enumerate;
  3299. }
  3300. /* Restore the device's previous configuration */
  3301. if (!udev->actconfig)
  3302. goto done;
  3303. mutex_lock(hcd->bandwidth_mutex);
  3304. ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
  3305. if (ret < 0) {
  3306. dev_warn(&udev->dev,
  3307. "Busted HC? Not enough HCD resources for "
  3308. "old configuration.\n");
  3309. mutex_unlock(hcd->bandwidth_mutex);
  3310. goto re_enumerate;
  3311. }
  3312. ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  3313. USB_REQ_SET_CONFIGURATION, 0,
  3314. udev->actconfig->desc.bConfigurationValue, 0,
  3315. NULL, 0, USB_CTRL_SET_TIMEOUT);
  3316. if (ret < 0) {
  3317. dev_err(&udev->dev,
  3318. "can't restore configuration #%d (error=%d)\n",
  3319. udev->actconfig->desc.bConfigurationValue, ret);
  3320. mutex_unlock(hcd->bandwidth_mutex);
  3321. goto re_enumerate;
  3322. }
  3323. mutex_unlock(hcd->bandwidth_mutex);
  3324. usb_set_device_state(udev, USB_STATE_CONFIGURED);
  3325. /* Put interfaces back into the same altsettings as before.
  3326. * Don't bother to send the Set-Interface request for interfaces
  3327. * that were already in altsetting 0; besides being unnecessary,
  3328. * many devices can't handle it. Instead just reset the host-side
  3329. * endpoint state.
  3330. */
  3331. for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
  3332. struct usb_host_config *config = udev->actconfig;
  3333. struct usb_interface *intf = config->interface[i];
  3334. struct usb_interface_descriptor *desc;
  3335. desc = &intf->cur_altsetting->desc;
  3336. if (desc->bAlternateSetting == 0) {
  3337. usb_disable_interface(udev, intf, true);
  3338. usb_enable_interface(udev, intf, true);
  3339. ret = 0;
  3340. } else {
  3341. /* Let the bandwidth allocation function know that this
  3342. * device has been reset, and it will have to use
  3343. * alternate setting 0 as the current alternate setting.
  3344. */
  3345. intf->resetting_device = 1;
  3346. ret = usb_set_interface(udev, desc->bInterfaceNumber,
  3347. desc->bAlternateSetting);
  3348. intf->resetting_device = 0;
  3349. }
  3350. if (ret < 0) {
  3351. dev_err(&udev->dev, "failed to restore interface %d "
  3352. "altsetting %d (error=%d)\n",
  3353. desc->bInterfaceNumber,
  3354. desc->bAlternateSetting,
  3355. ret);
  3356. goto re_enumerate;
  3357. }
  3358. }
  3359. done:
  3360. return 0;
  3361. re_enumerate:
  3362. hub_port_logical_disconnect(parent_hub, port1);
  3363. return -ENODEV;
  3364. }
  3365. /**
  3366. * usb_reset_device - warn interface drivers and perform a USB port reset
  3367. * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
  3368. *
  3369. * Warns all drivers bound to registered interfaces (using their pre_reset
  3370. * method), performs the port reset, and then lets the drivers know that
  3371. * the reset is over (using their post_reset method).
  3372. *
  3373. * Return value is the same as for usb_reset_and_verify_device().
  3374. *
  3375. * The caller must own the device lock. For example, it's safe to use
  3376. * this from a driver probe() routine after downloading new firmware.
  3377. * For calls that might not occur during probe(), drivers should lock
  3378. * the device using usb_lock_device_for_reset().
  3379. *
  3380. * If an interface is currently being probed or disconnected, we assume
  3381. * its driver knows how to handle resets. For all other interfaces,
  3382. * if the driver doesn't have pre_reset and post_reset methods then
  3383. * we attempt to unbind it and rebind afterward.
  3384. */
  3385. int usb_reset_device(struct usb_device *udev)
  3386. {
  3387. int ret;
  3388. int i;
  3389. struct usb_host_config *config = udev->actconfig;
  3390. if (udev->state == USB_STATE_NOTATTACHED ||
  3391. udev->state == USB_STATE_SUSPENDED) {
  3392. dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
  3393. udev->state);
  3394. return -EINVAL;
  3395. }
  3396. /* Prevent autosuspend during the reset */
  3397. usb_autoresume_device(udev);
  3398. if (config) {
  3399. for (i = 0; i < config->desc.bNumInterfaces; ++i) {
  3400. struct usb_interface *cintf = config->interface[i];
  3401. struct usb_driver *drv;
  3402. int unbind = 0;
  3403. if (cintf->dev.driver) {
  3404. drv = to_usb_driver(cintf->dev.driver);
  3405. if (drv->pre_reset && drv->post_reset)
  3406. unbind = (drv->pre_reset)(cintf);
  3407. else if (cintf->condition ==
  3408. USB_INTERFACE_BOUND)
  3409. unbind = 1;
  3410. if (unbind)
  3411. usb_forced_unbind_intf(cintf);
  3412. }
  3413. }
  3414. }
  3415. ret = usb_reset_and_verify_device(udev);
  3416. if (config) {
  3417. for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
  3418. struct usb_interface *cintf = config->interface[i];
  3419. struct usb_driver *drv;
  3420. int rebind = cintf->needs_binding;
  3421. if (!rebind && cintf->dev.driver) {
  3422. drv = to_usb_driver(cintf->dev.driver);
  3423. if (drv->post_reset)
  3424. rebind = (drv->post_reset)(cintf);
  3425. else if (cintf->condition ==
  3426. USB_INTERFACE_BOUND)
  3427. rebind = 1;
  3428. }
  3429. if (ret == 0 && rebind)
  3430. usb_rebind_intf(cintf);
  3431. }
  3432. }
  3433. usb_autosuspend_device(udev);
  3434. return ret;
  3435. }
  3436. EXPORT_SYMBOL_GPL(usb_reset_device);
  3437. /**
  3438. * usb_queue_reset_device - Reset a USB device from an atomic context
  3439. * @iface: USB interface belonging to the device to reset
  3440. *
  3441. * This function can be used to reset a USB device from an atomic
  3442. * context, where usb_reset_device() won't work (as it blocks).
  3443. *
  3444. * Doing a reset via this method is functionally equivalent to calling
  3445. * usb_reset_device(), except for the fact that it is delayed to a
  3446. * workqueue. This means that any drivers bound to other interfaces
  3447. * might be unbound, as well as users from usbfs in user space.
  3448. *
  3449. * Corner cases:
  3450. *
  3451. * - Scheduling two resets at the same time from two different drivers
  3452. * attached to two different interfaces of the same device is
  3453. * possible; depending on how the driver attached to each interface
  3454. * handles ->pre_reset(), the second reset might happen or not.
  3455. *
  3456. * - If a driver is unbound and it had a pending reset, the reset will
  3457. * be cancelled.
  3458. *
  3459. * - This function can be called during .probe() or .disconnect()
  3460. * times. On return from .disconnect(), any pending resets will be
  3461. * cancelled.
  3462. *
  3463. * There is no no need to lock/unlock the @reset_ws as schedule_work()
  3464. * does its own.
  3465. *
  3466. * NOTE: We don't do any reference count tracking because it is not
  3467. * needed. The lifecycle of the work_struct is tied to the
  3468. * usb_interface. Before destroying the interface we cancel the
  3469. * work_struct, so the fact that work_struct is queued and or
  3470. * running means the interface (and thus, the device) exist and
  3471. * are referenced.
  3472. */
  3473. void usb_queue_reset_device(struct usb_interface *iface)
  3474. {
  3475. schedule_work(&iface->reset_ws);
  3476. }
  3477. EXPORT_SYMBOL_GPL(usb_queue_reset_device);