hub.c 88 KB

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