hub.c 109 KB

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