hub.c 108 KB

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