usb_hub.c 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * Most of this source has been derived from the Linux USB
  4. * project:
  5. * (C) Copyright Linus Torvalds 1999
  6. * (C) Copyright Johannes Erdfelt 1999-2001
  7. * (C) Copyright Andreas Gal 1999
  8. * (C) Copyright Gregory P. Smith 1999
  9. * (C) Copyright Deti Fliegl 1999 (new USB architecture)
  10. * (C) Copyright Randy Dunlap 2000
  11. * (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
  12. * (C) Copyright Yggdrasil Computing, Inc. 2000
  13. * (usb_device_id matching changes by Adam J. Richter)
  14. *
  15. * Adapted for U-Boot:
  16. * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
  17. */
  18. /****************************************************************************
  19. * HUB "Driver"
  20. * Probes device for being a hub and configurate it
  21. */
  22. #include <common.h>
  23. #include <command.h>
  24. #include <dm.h>
  25. #include <env.h>
  26. #include <errno.h>
  27. #include <log.h>
  28. #include <malloc.h>
  29. #include <memalign.h>
  30. #include <asm/processor.h>
  31. #include <asm/unaligned.h>
  32. #include <linux/ctype.h>
  33. #include <linux/delay.h>
  34. #include <linux/list.h>
  35. #include <asm/byteorder.h>
  36. #ifdef CONFIG_SANDBOX
  37. #include <asm/state.h>
  38. #endif
  39. #include <asm/unaligned.h>
  40. #include <usb.h>
  41. #define USB_BUFSIZ 512
  42. #define HUB_SHORT_RESET_TIME 20
  43. #define HUB_LONG_RESET_TIME 200
  44. #define PORT_OVERCURRENT_MAX_SCAN_COUNT 3
  45. struct usb_device_scan {
  46. struct usb_device *dev; /* USB hub device to scan */
  47. struct usb_hub_device *hub; /* USB hub struct */
  48. int port; /* USB port to scan */
  49. struct list_head list;
  50. };
  51. static LIST_HEAD(usb_scan_list);
  52. __weak void usb_hub_reset_devices(struct usb_hub_device *hub, int port)
  53. {
  54. return;
  55. }
  56. static inline bool usb_hub_is_superspeed(struct usb_device *hdev)
  57. {
  58. return hdev->descriptor.bDeviceProtocol == 3;
  59. }
  60. #if CONFIG_IS_ENABLED(DM_USB)
  61. bool usb_hub_is_root_hub(struct udevice *hub)
  62. {
  63. if (device_get_uclass_id(hub->parent) != UCLASS_USB_HUB)
  64. return true;
  65. return false;
  66. }
  67. static int usb_set_hub_depth(struct usb_device *dev, int depth)
  68. {
  69. if (depth < 0 || depth > 4)
  70. return -EINVAL;
  71. return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  72. USB_REQ_SET_HUB_DEPTH, USB_DIR_OUT | USB_RT_HUB,
  73. depth, 0, NULL, 0, USB_CNTL_TIMEOUT);
  74. }
  75. #endif
  76. static int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
  77. {
  78. unsigned short dtype = USB_DT_HUB;
  79. if (usb_hub_is_superspeed(dev))
  80. dtype = USB_DT_SS_HUB;
  81. return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
  82. USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
  83. dtype << 8, 0, data, size, USB_CNTL_TIMEOUT);
  84. }
  85. static int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
  86. {
  87. return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  88. USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
  89. port, NULL, 0, USB_CNTL_TIMEOUT);
  90. }
  91. static int usb_set_port_feature(struct usb_device *dev, int port, int feature)
  92. {
  93. return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  94. USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
  95. port, NULL, 0, USB_CNTL_TIMEOUT);
  96. }
  97. static int usb_get_hub_status(struct usb_device *dev, void *data)
  98. {
  99. return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
  100. USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
  101. data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
  102. }
  103. int usb_get_port_status(struct usb_device *dev, int port, void *data)
  104. {
  105. int ret;
  106. ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
  107. USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
  108. data, sizeof(struct usb_port_status), USB_CNTL_TIMEOUT);
  109. #if CONFIG_IS_ENABLED(DM_USB)
  110. if (ret < 0)
  111. return ret;
  112. /*
  113. * Translate the USB 3.0 hub port status field into the old version
  114. * that U-Boot understands. Do this only when the hub is not root hub.
  115. * For root hub, the port status field has already been translated
  116. * in the host controller driver (see xhci_submit_root() in xhci.c).
  117. *
  118. * Note: this only supports driver model.
  119. */
  120. if (!usb_hub_is_root_hub(dev->dev) && usb_hub_is_superspeed(dev)) {
  121. struct usb_port_status *status = (struct usb_port_status *)data;
  122. u16 tmp = le16_to_cpu(status->wPortStatus) &
  123. USB_SS_PORT_STAT_MASK;
  124. if (status->wPortStatus & USB_SS_PORT_STAT_POWER)
  125. tmp |= USB_PORT_STAT_POWER;
  126. if ((status->wPortStatus & USB_SS_PORT_STAT_SPEED) ==
  127. USB_SS_PORT_STAT_SPEED_5GBPS)
  128. tmp |= USB_PORT_STAT_SUPER_SPEED;
  129. status->wPortStatus = cpu_to_le16(tmp);
  130. }
  131. #endif
  132. return ret;
  133. }
  134. static void usb_hub_power_on(struct usb_hub_device *hub)
  135. {
  136. int i;
  137. struct usb_device *dev;
  138. unsigned pgood_delay = hub->desc.bPwrOn2PwrGood * 2;
  139. const char *env;
  140. dev = hub->pusb_dev;
  141. debug("enabling power on all ports\n");
  142. for (i = 0; i < dev->maxchild; i++) {
  143. usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
  144. debug("port %d returns %lX\n", i + 1, dev->status);
  145. }
  146. #ifdef CONFIG_SANDBOX
  147. /*
  148. * Don't set timeout / delay values here. This results
  149. * in these values still being reset to 0.
  150. */
  151. if (state_get_skip_delays())
  152. return;
  153. #endif
  154. /*
  155. * Wait for power to become stable,
  156. * plus spec-defined max time for device to connect
  157. * but allow this time to be increased via env variable as some
  158. * devices break the spec and require longer warm-up times
  159. */
  160. env = env_get("usb_pgood_delay");
  161. if (env)
  162. pgood_delay = max(pgood_delay,
  163. (unsigned)simple_strtol(env, NULL, 0));
  164. debug("pgood_delay=%dms\n", pgood_delay);
  165. /*
  166. * Do a minimum delay of the larger value of 100ms or pgood_delay
  167. * so that the power can stablize before the devices are queried
  168. */
  169. hub->query_delay = get_timer(0) + max(100, (int)pgood_delay);
  170. /*
  171. * Record the power-on timeout here. The max. delay (timeout)
  172. * will be done based on this value in the USB port loop in
  173. * usb_hub_configure() later.
  174. */
  175. hub->connect_timeout = hub->query_delay + 1000;
  176. debug("devnum=%d poweron: query_delay=%d connect_timeout=%d\n",
  177. dev->devnum, max(100, (int)pgood_delay),
  178. max(100, (int)pgood_delay) + 1000);
  179. }
  180. #if !CONFIG_IS_ENABLED(DM_USB)
  181. static struct usb_hub_device hub_dev[USB_MAX_HUB];
  182. static int usb_hub_index;
  183. void usb_hub_reset(void)
  184. {
  185. usb_hub_index = 0;
  186. /* Zero out global hub_dev in case its re-used again */
  187. memset(hub_dev, 0, sizeof(hub_dev));
  188. }
  189. static struct usb_hub_device *usb_hub_allocate(void)
  190. {
  191. if (usb_hub_index < USB_MAX_HUB)
  192. return &hub_dev[usb_hub_index++];
  193. printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
  194. return NULL;
  195. }
  196. #endif
  197. #define MAX_TRIES 5
  198. static inline const char *portspeed(int portstatus)
  199. {
  200. switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
  201. case USB_PORT_STAT_SUPER_SPEED:
  202. return "5 Gb/s";
  203. case USB_PORT_STAT_HIGH_SPEED:
  204. return "480 Mb/s";
  205. case USB_PORT_STAT_LOW_SPEED:
  206. return "1.5 Mb/s";
  207. default:
  208. return "12 Mb/s";
  209. }
  210. }
  211. /**
  212. * usb_hub_port_reset() - reset a port given its usb_device pointer
  213. *
  214. * Reset a hub port and see if a device is present on that port, providing
  215. * sufficient time for it to show itself. The port status is returned.
  216. *
  217. * @dev: USB device to reset
  218. * @port: Port number to reset (note ports are numbered from 0 here)
  219. * @portstat: Returns port status
  220. */
  221. static int usb_hub_port_reset(struct usb_device *dev, int port,
  222. unsigned short *portstat)
  223. {
  224. int err, tries;
  225. ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
  226. unsigned short portstatus, portchange;
  227. int delay = HUB_SHORT_RESET_TIME; /* start with short reset delay */
  228. #if CONFIG_IS_ENABLED(DM_USB)
  229. debug("%s: resetting '%s' port %d...\n", __func__, dev->dev->name,
  230. port + 1);
  231. #else
  232. debug("%s: resetting port %d...\n", __func__, port + 1);
  233. #endif
  234. for (tries = 0; tries < MAX_TRIES; tries++) {
  235. err = usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
  236. if (err < 0)
  237. return err;
  238. mdelay(delay);
  239. if (usb_get_port_status(dev, port + 1, portsts) < 0) {
  240. debug("get_port_status failed status %lX\n",
  241. dev->status);
  242. return -1;
  243. }
  244. portstatus = le16_to_cpu(portsts->wPortStatus);
  245. portchange = le16_to_cpu(portsts->wPortChange);
  246. debug("portstatus %x, change %x, %s\n", portstatus, portchange,
  247. portspeed(portstatus));
  248. debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
  249. " USB_PORT_STAT_ENABLE %d\n",
  250. (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
  251. (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
  252. (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
  253. /*
  254. * Perhaps we should check for the following here:
  255. * - C_CONNECTION hasn't been set.
  256. * - CONNECTION is still set.
  257. *
  258. * Doing so would ensure that the device is still connected
  259. * to the bus, and hasn't been unplugged or replaced while the
  260. * USB bus reset was going on.
  261. *
  262. * However, if we do that, then (at least) a San Disk Ultra
  263. * USB 3.0 16GB device fails to reset on (at least) an NVIDIA
  264. * Tegra Jetson TK1 board. For some reason, the device appears
  265. * to briefly drop off the bus when this second bus reset is
  266. * executed, yet if we retry this loop, it'll eventually come
  267. * back after another reset or two.
  268. */
  269. if (portstatus & USB_PORT_STAT_ENABLE)
  270. break;
  271. /* Switch to long reset delay for the next round */
  272. delay = HUB_LONG_RESET_TIME;
  273. }
  274. if (tries == MAX_TRIES) {
  275. debug("Cannot enable port %i after %i retries, " \
  276. "disabling port.\n", port + 1, MAX_TRIES);
  277. debug("Maybe the USB cable is bad?\n");
  278. return -1;
  279. }
  280. usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
  281. *portstat = portstatus;
  282. return 0;
  283. }
  284. int usb_hub_port_connect_change(struct usb_device *dev, int port)
  285. {
  286. ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
  287. unsigned short portstatus;
  288. int ret, speed;
  289. /* Check status */
  290. ret = usb_get_port_status(dev, port + 1, portsts);
  291. if (ret < 0) {
  292. debug("get_port_status failed\n");
  293. return ret;
  294. }
  295. portstatus = le16_to_cpu(portsts->wPortStatus);
  296. debug("portstatus %x, change %x, %s\n",
  297. portstatus,
  298. le16_to_cpu(portsts->wPortChange),
  299. portspeed(portstatus));
  300. /* Clear the connection change status */
  301. usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
  302. /* Disconnect any existing devices under this port */
  303. if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
  304. (!(portstatus & USB_PORT_STAT_ENABLE))) ||
  305. usb_device_has_child_on_port(dev, port)) {
  306. debug("usb_disconnect(&hub->children[port]);\n");
  307. /* Return now if nothing is connected */
  308. if (!(portstatus & USB_PORT_STAT_CONNECTION))
  309. return -ENOTCONN;
  310. }
  311. /* Reset the port */
  312. ret = usb_hub_port_reset(dev, port, &portstatus);
  313. if (ret < 0) {
  314. if (ret != -ENXIO)
  315. printf("cannot reset port %i!?\n", port + 1);
  316. return ret;
  317. }
  318. switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
  319. case USB_PORT_STAT_SUPER_SPEED:
  320. speed = USB_SPEED_SUPER;
  321. break;
  322. case USB_PORT_STAT_HIGH_SPEED:
  323. speed = USB_SPEED_HIGH;
  324. break;
  325. case USB_PORT_STAT_LOW_SPEED:
  326. speed = USB_SPEED_LOW;
  327. break;
  328. default:
  329. speed = USB_SPEED_FULL;
  330. break;
  331. }
  332. #if CONFIG_IS_ENABLED(DM_USB)
  333. struct udevice *child;
  334. ret = usb_scan_device(dev->dev, port + 1, speed, &child);
  335. #else
  336. struct usb_device *usb;
  337. ret = usb_alloc_new_device(dev->controller, &usb);
  338. if (ret) {
  339. printf("cannot create new device: ret=%d", ret);
  340. return ret;
  341. }
  342. dev->children[port] = usb;
  343. usb->speed = speed;
  344. usb->parent = dev;
  345. usb->portnr = port + 1;
  346. /* Run it through the hoops (find a driver, etc) */
  347. ret = usb_new_device(usb);
  348. if (ret < 0) {
  349. /* Woops, disable the port */
  350. usb_free_device(dev->controller);
  351. dev->children[port] = NULL;
  352. }
  353. #endif
  354. if (ret < 0) {
  355. debug("hub: disabling port %d\n", port + 1);
  356. usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
  357. }
  358. return ret;
  359. }
  360. static int usb_scan_port(struct usb_device_scan *usb_scan)
  361. {
  362. ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
  363. unsigned short portstatus;
  364. unsigned short portchange;
  365. struct usb_device *dev;
  366. struct usb_hub_device *hub;
  367. int ret = 0;
  368. int i;
  369. dev = usb_scan->dev;
  370. hub = usb_scan->hub;
  371. i = usb_scan->port;
  372. /*
  373. * Don't talk to the device before the query delay is expired.
  374. * This is needed for voltages to stabalize.
  375. */
  376. if (get_timer(0) < hub->query_delay)
  377. return 0;
  378. ret = usb_get_port_status(dev, i + 1, portsts);
  379. if (ret < 0) {
  380. debug("get_port_status failed\n");
  381. if (get_timer(0) >= hub->connect_timeout) {
  382. debug("devnum=%d port=%d: timeout\n",
  383. dev->devnum, i + 1);
  384. /* Remove this device from scanning list */
  385. list_del(&usb_scan->list);
  386. free(usb_scan);
  387. return 0;
  388. }
  389. return 0;
  390. }
  391. portstatus = le16_to_cpu(portsts->wPortStatus);
  392. portchange = le16_to_cpu(portsts->wPortChange);
  393. debug("Port %d Status %X Change %X\n", i + 1, portstatus, portchange);
  394. /*
  395. * No connection change happened, wait a bit more.
  396. *
  397. * For some situation, the hub reports no connection change but a
  398. * device is connected to the port (eg: CCS bit is set but CSC is not
  399. * in the PORTSC register of a root hub), ignore such case.
  400. */
  401. if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
  402. !(portstatus & USB_PORT_STAT_CONNECTION)) {
  403. if (get_timer(0) >= hub->connect_timeout) {
  404. debug("devnum=%d port=%d: timeout\n",
  405. dev->devnum, i + 1);
  406. /* Remove this device from scanning list */
  407. list_del(&usb_scan->list);
  408. free(usb_scan);
  409. return 0;
  410. }
  411. return 0;
  412. }
  413. if (portchange & USB_PORT_STAT_C_RESET) {
  414. debug("port %d reset change\n", i + 1);
  415. usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_RESET);
  416. }
  417. if ((portchange & USB_SS_PORT_STAT_C_BH_RESET) &&
  418. usb_hub_is_superspeed(dev)) {
  419. debug("port %d BH reset change\n", i + 1);
  420. usb_clear_port_feature(dev, i + 1, USB_SS_PORT_FEAT_C_BH_RESET);
  421. }
  422. /* A new USB device is ready at this point */
  423. debug("devnum=%d port=%d: USB dev found\n", dev->devnum, i + 1);
  424. usb_hub_port_connect_change(dev, i);
  425. if (portchange & USB_PORT_STAT_C_ENABLE) {
  426. debug("port %d enable change, status %x\n", i + 1, portstatus);
  427. usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_ENABLE);
  428. /*
  429. * The following hack causes a ghost device problem
  430. * to Faraday EHCI
  431. */
  432. #ifndef CONFIG_USB_EHCI_FARADAY
  433. /*
  434. * EM interference sometimes causes bad shielded USB
  435. * devices to be shutdown by the hub, this hack enables
  436. * them again. Works at least with mouse driver
  437. */
  438. if (!(portstatus & USB_PORT_STAT_ENABLE) &&
  439. (portstatus & USB_PORT_STAT_CONNECTION) &&
  440. usb_device_has_child_on_port(dev, i)) {
  441. debug("already running port %i disabled by hub (EMI?), re-enabling...\n",
  442. i + 1);
  443. usb_hub_port_connect_change(dev, i);
  444. }
  445. #endif
  446. }
  447. if (portstatus & USB_PORT_STAT_SUSPEND) {
  448. debug("port %d suspend change\n", i + 1);
  449. usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_SUSPEND);
  450. }
  451. if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
  452. debug("port %d over-current change\n", i + 1);
  453. usb_clear_port_feature(dev, i + 1,
  454. USB_PORT_FEAT_C_OVER_CURRENT);
  455. /* Only power-on this one port */
  456. usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
  457. hub->overcurrent_count[i]++;
  458. /*
  459. * If the max-scan-count is not reached, return without removing
  460. * the device from scan-list. This will re-issue a new scan.
  461. */
  462. if (hub->overcurrent_count[i] <=
  463. PORT_OVERCURRENT_MAX_SCAN_COUNT)
  464. return 0;
  465. /* Otherwise the device will get removed */
  466. printf("Port %d over-current occurred %d times\n", i + 1,
  467. hub->overcurrent_count[i]);
  468. }
  469. /*
  470. * We're done with this device, so let's remove this device from
  471. * scanning list
  472. */
  473. list_del(&usb_scan->list);
  474. free(usb_scan);
  475. return 0;
  476. }
  477. static int usb_device_list_scan(void)
  478. {
  479. struct usb_device_scan *usb_scan;
  480. struct usb_device_scan *tmp;
  481. static int running;
  482. int ret = 0;
  483. /* Only run this loop once for each controller */
  484. if (running)
  485. return 0;
  486. running = 1;
  487. while (1) {
  488. /* We're done, once the list is empty again */
  489. if (list_empty(&usb_scan_list))
  490. goto out;
  491. list_for_each_entry_safe(usb_scan, tmp, &usb_scan_list, list) {
  492. int ret;
  493. /* Scan this port */
  494. ret = usb_scan_port(usb_scan);
  495. if (ret)
  496. goto out;
  497. }
  498. }
  499. out:
  500. /*
  501. * This USB controller has finished scanning all its connected
  502. * USB devices. Set "running" back to 0, so that other USB controllers
  503. * will scan their devices too.
  504. */
  505. running = 0;
  506. return ret;
  507. }
  508. static struct usb_hub_device *usb_get_hub_device(struct usb_device *dev)
  509. {
  510. struct usb_hub_device *hub;
  511. #if !CONFIG_IS_ENABLED(DM_USB)
  512. /* "allocate" Hub device */
  513. hub = usb_hub_allocate();
  514. #else
  515. hub = dev_get_uclass_priv(dev->dev);
  516. #endif
  517. return hub;
  518. }
  519. static int usb_hub_configure(struct usb_device *dev)
  520. {
  521. int i, length;
  522. ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
  523. unsigned char *bitmap;
  524. short hubCharacteristics;
  525. struct usb_hub_descriptor *descriptor;
  526. struct usb_hub_device *hub;
  527. struct usb_hub_status *hubsts;
  528. int ret;
  529. hub = usb_get_hub_device(dev);
  530. if (hub == NULL)
  531. return -ENOMEM;
  532. hub->pusb_dev = dev;
  533. /* Get the the hub descriptor */
  534. ret = usb_get_hub_descriptor(dev, buffer, 4);
  535. if (ret < 0) {
  536. debug("usb_hub_configure: failed to get hub " \
  537. "descriptor, giving up %lX\n", dev->status);
  538. return ret;
  539. }
  540. descriptor = (struct usb_hub_descriptor *)buffer;
  541. length = min_t(int, descriptor->bLength,
  542. sizeof(struct usb_hub_descriptor));
  543. ret = usb_get_hub_descriptor(dev, buffer, length);
  544. if (ret < 0) {
  545. debug("usb_hub_configure: failed to get hub " \
  546. "descriptor 2nd giving up %lX\n", dev->status);
  547. return ret;
  548. }
  549. memcpy((unsigned char *)&hub->desc, buffer, length);
  550. /* adjust 16bit values */
  551. put_unaligned(le16_to_cpu(get_unaligned(
  552. &descriptor->wHubCharacteristics)),
  553. &hub->desc.wHubCharacteristics);
  554. /* set the bitmap */
  555. bitmap = (unsigned char *)&hub->desc.u.hs.DeviceRemovable[0];
  556. /* devices not removable by default */
  557. memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
  558. bitmap = (unsigned char *)&hub->desc.u.hs.PortPowerCtrlMask[0];
  559. memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
  560. for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
  561. hub->desc.u.hs.DeviceRemovable[i] =
  562. descriptor->u.hs.DeviceRemovable[i];
  563. for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
  564. hub->desc.u.hs.PortPowerCtrlMask[i] =
  565. descriptor->u.hs.PortPowerCtrlMask[i];
  566. dev->maxchild = descriptor->bNbrPorts;
  567. debug("%d ports detected\n", dev->maxchild);
  568. hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
  569. switch (hubCharacteristics & HUB_CHAR_LPSM) {
  570. case 0x00:
  571. debug("ganged power switching\n");
  572. break;
  573. case 0x01:
  574. debug("individual port power switching\n");
  575. break;
  576. case 0x02:
  577. case 0x03:
  578. debug("unknown reserved power switching mode\n");
  579. break;
  580. }
  581. if (hubCharacteristics & HUB_CHAR_COMPOUND)
  582. debug("part of a compound device\n");
  583. else
  584. debug("standalone hub\n");
  585. switch (hubCharacteristics & HUB_CHAR_OCPM) {
  586. case 0x00:
  587. debug("global over-current protection\n");
  588. break;
  589. case 0x08:
  590. debug("individual port over-current protection\n");
  591. break;
  592. case 0x10:
  593. case 0x18:
  594. debug("no over-current protection\n");
  595. break;
  596. }
  597. switch (dev->descriptor.bDeviceProtocol) {
  598. case USB_HUB_PR_FS:
  599. break;
  600. case USB_HUB_PR_HS_SINGLE_TT:
  601. debug("Single TT\n");
  602. break;
  603. case USB_HUB_PR_HS_MULTI_TT:
  604. ret = usb_set_interface(dev, 0, 1);
  605. if (ret == 0) {
  606. debug("TT per port\n");
  607. hub->tt.multi = true;
  608. } else {
  609. debug("Using single TT (err %d)\n", ret);
  610. }
  611. break;
  612. case USB_HUB_PR_SS:
  613. /* USB 3.0 hubs don't have a TT */
  614. break;
  615. default:
  616. debug("Unrecognized hub protocol %d\n",
  617. dev->descriptor.bDeviceProtocol);
  618. break;
  619. }
  620. /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
  621. switch (hubCharacteristics & HUB_CHAR_TTTT) {
  622. case HUB_TTTT_8_BITS:
  623. if (dev->descriptor.bDeviceProtocol != 0) {
  624. hub->tt.think_time = 666;
  625. debug("TT requires at most %d FS bit times (%d ns)\n",
  626. 8, hub->tt.think_time);
  627. }
  628. break;
  629. case HUB_TTTT_16_BITS:
  630. hub->tt.think_time = 666 * 2;
  631. debug("TT requires at most %d FS bit times (%d ns)\n",
  632. 16, hub->tt.think_time);
  633. break;
  634. case HUB_TTTT_24_BITS:
  635. hub->tt.think_time = 666 * 3;
  636. debug("TT requires at most %d FS bit times (%d ns)\n",
  637. 24, hub->tt.think_time);
  638. break;
  639. case HUB_TTTT_32_BITS:
  640. hub->tt.think_time = 666 * 4;
  641. debug("TT requires at most %d FS bit times (%d ns)\n",
  642. 32, hub->tt.think_time);
  643. break;
  644. }
  645. debug("power on to power good time: %dms\n",
  646. descriptor->bPwrOn2PwrGood * 2);
  647. debug("hub controller current requirement: %dmA\n",
  648. descriptor->bHubContrCurrent);
  649. for (i = 0; i < dev->maxchild; i++)
  650. debug("port %d is%s removable\n", i + 1,
  651. hub->desc.u.hs.DeviceRemovable[(i + 1) / 8] & \
  652. (1 << ((i + 1) % 8)) ? " not" : "");
  653. if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
  654. debug("usb_hub_configure: failed to get Status - " \
  655. "too long: %d\n", descriptor->bLength);
  656. return -EFBIG;
  657. }
  658. ret = usb_get_hub_status(dev, buffer);
  659. if (ret < 0) {
  660. debug("usb_hub_configure: failed to get Status %lX\n",
  661. dev->status);
  662. return ret;
  663. }
  664. hubsts = (struct usb_hub_status *)buffer;
  665. debug("get_hub_status returned status %X, change %X\n",
  666. le16_to_cpu(hubsts->wHubStatus),
  667. le16_to_cpu(hubsts->wHubChange));
  668. debug("local power source is %s\n",
  669. (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
  670. "lost (inactive)" : "good");
  671. debug("%sover-current condition exists\n",
  672. (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
  673. "" : "no ");
  674. #if CONFIG_IS_ENABLED(DM_USB)
  675. /*
  676. * Update USB host controller's internal representation of this hub
  677. * after the hub descriptor is fetched.
  678. */
  679. ret = usb_update_hub_device(dev);
  680. if (ret < 0 && ret != -ENOSYS) {
  681. debug("%s: failed to update hub device for HCD (%x)\n",
  682. __func__, ret);
  683. return ret;
  684. }
  685. /*
  686. * A maximum of seven tiers are allowed in a USB topology, and the
  687. * root hub occupies the first tier. The last tier ends with a normal
  688. * USB device. USB 3.0 hubs use a 20-bit field called 'route string'
  689. * to route packets to the designated downstream port. The hub uses a
  690. * hub depth value multiplied by four as an offset into the 'route
  691. * string' to locate the bits it uses to determine the downstream
  692. * port number.
  693. */
  694. if (usb_hub_is_root_hub(dev->dev)) {
  695. hub->hub_depth = -1;
  696. } else {
  697. struct udevice *hdev;
  698. int depth = 0;
  699. hdev = dev->dev->parent;
  700. while (!usb_hub_is_root_hub(hdev)) {
  701. depth++;
  702. hdev = hdev->parent;
  703. }
  704. hub->hub_depth = depth;
  705. if (usb_hub_is_superspeed(dev)) {
  706. debug("set hub (%p) depth to %d\n", dev, depth);
  707. /*
  708. * This request sets the value that the hub uses to
  709. * determine the index into the 'route string index'
  710. * for this hub.
  711. */
  712. ret = usb_set_hub_depth(dev, depth);
  713. if (ret < 0) {
  714. debug("%s: failed to set hub depth (%lX)\n",
  715. __func__, dev->status);
  716. return ret;
  717. }
  718. }
  719. }
  720. #endif
  721. usb_hub_power_on(hub);
  722. /*
  723. * Reset any devices that may be in a bad state when applying
  724. * the power. This is a __weak function. Resetting of the devices
  725. * should occur in the board file of the device.
  726. */
  727. for (i = 0; i < dev->maxchild; i++)
  728. usb_hub_reset_devices(hub, i + 1);
  729. /*
  730. * Only add the connected USB devices, including potential hubs,
  731. * to a scanning list. This list will get scanned and devices that
  732. * are detected (either via port connected or via port timeout)
  733. * will get removed from this list. Scanning of the devices on this
  734. * list will continue until all devices are removed.
  735. */
  736. for (i = 0; i < dev->maxchild; i++) {
  737. struct usb_device_scan *usb_scan;
  738. usb_scan = calloc(1, sizeof(*usb_scan));
  739. if (!usb_scan) {
  740. printf("Can't allocate memory for USB device!\n");
  741. return -ENOMEM;
  742. }
  743. usb_scan->dev = dev;
  744. usb_scan->hub = hub;
  745. usb_scan->port = i;
  746. list_add_tail(&usb_scan->list, &usb_scan_list);
  747. }
  748. /*
  749. * And now call the scanning code which loops over the generated list
  750. */
  751. ret = usb_device_list_scan();
  752. return ret;
  753. }
  754. static int usb_hub_check(struct usb_device *dev, int ifnum)
  755. {
  756. struct usb_interface *iface;
  757. struct usb_endpoint_descriptor *ep = NULL;
  758. iface = &dev->config.if_desc[ifnum];
  759. /* Is it a hub? */
  760. if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
  761. goto err;
  762. /* Some hubs have a subclass of 1, which AFAICT according to the */
  763. /* specs is not defined, but it works */
  764. if ((iface->desc.bInterfaceSubClass != 0) &&
  765. (iface->desc.bInterfaceSubClass != 1))
  766. goto err;
  767. /* Multiple endpoints? What kind of mutant ninja-hub is this? */
  768. if (iface->desc.bNumEndpoints != 1)
  769. goto err;
  770. ep = &iface->ep_desc[0];
  771. /* Output endpoint? Curiousier and curiousier.. */
  772. if (!(ep->bEndpointAddress & USB_DIR_IN))
  773. goto err;
  774. /* If it's not an interrupt endpoint, we'd better punt! */
  775. if ((ep->bmAttributes & 3) != 3)
  776. goto err;
  777. /* We found a hub */
  778. debug("USB hub found\n");
  779. return 0;
  780. err:
  781. debug("USB hub not found: bInterfaceClass=%d, bInterfaceSubClass=%d, bNumEndpoints=%d\n",
  782. iface->desc.bInterfaceClass, iface->desc.bInterfaceSubClass,
  783. iface->desc.bNumEndpoints);
  784. if (ep) {
  785. debug(" bEndpointAddress=%#x, bmAttributes=%d",
  786. ep->bEndpointAddress, ep->bmAttributes);
  787. }
  788. return -ENOENT;
  789. }
  790. int usb_hub_probe(struct usb_device *dev, int ifnum)
  791. {
  792. int ret;
  793. ret = usb_hub_check(dev, ifnum);
  794. if (ret)
  795. return 0;
  796. ret = usb_hub_configure(dev);
  797. return ret;
  798. }
  799. #if CONFIG_IS_ENABLED(DM_USB)
  800. int usb_hub_scan(struct udevice *hub)
  801. {
  802. struct usb_device *udev = dev_get_parent_priv(hub);
  803. return usb_hub_configure(udev);
  804. }
  805. static int usb_hub_post_probe(struct udevice *dev)
  806. {
  807. debug("%s\n", __func__);
  808. return usb_hub_scan(dev);
  809. }
  810. static const struct udevice_id usb_hub_ids[] = {
  811. { .compatible = "usb-hub" },
  812. { }
  813. };
  814. U_BOOT_DRIVER(usb_generic_hub) = {
  815. .name = "usb_hub",
  816. .id = UCLASS_USB_HUB,
  817. .of_match = usb_hub_ids,
  818. .flags = DM_FLAG_ALLOC_PRIV_DMA,
  819. };
  820. UCLASS_DRIVER(usb_hub) = {
  821. .id = UCLASS_USB_HUB,
  822. .name = "usb_hub",
  823. .post_bind = dm_scan_fdt_dev,
  824. .post_probe = usb_hub_post_probe,
  825. .child_pre_probe = usb_child_pre_probe,
  826. .per_child_auto = sizeof(struct usb_device),
  827. .per_child_plat_auto = sizeof(struct usb_dev_plat),
  828. .per_device_auto = sizeof(struct usb_hub_device),
  829. };
  830. static const struct usb_device_id hub_id_table[] = {
  831. {
  832. .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
  833. .bDeviceClass = USB_CLASS_HUB
  834. },
  835. { } /* Terminating entry */
  836. };
  837. U_BOOT_USB_DEVICE(usb_generic_hub, hub_id_table);
  838. #endif