usb_hub.c 26 KB

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