hub.c 108 KB

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