core.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * Cadence USBSS DRD Driver.
  4. *
  5. * Copyright (C) 2018-2019 Cadence.
  6. * Copyright (C) 2017-2018 NXP
  7. * Copyright (C) 2019 Texas Instruments
  8. *
  9. * Author: Peter Chen <peter.chen@nxp.com>
  10. * Pawel Laszczak <pawell@cadence.com>
  11. * Roger Quadros <rogerq@ti.com>
  12. */
  13. #include <common.h>
  14. #include <dm.h>
  15. #include <log.h>
  16. #include <dm/device-internal.h>
  17. #include <dm/device_compat.h>
  18. #include <dm/devres.h>
  19. #include <dm/lists.h>
  20. #include <linux/bug.h>
  21. #include <linux/kernel.h>
  22. #include <linux/io.h>
  23. #include <usb.h>
  24. #include <usb/xhci.h>
  25. #include "core.h"
  26. #include "host-export.h"
  27. #include "gadget-export.h"
  28. #include "drd.h"
  29. static int cdns3_idle_init(struct cdns3 *cdns);
  30. struct cdns3_host_priv {
  31. struct xhci_ctrl xhci_ctrl;
  32. struct cdns3 cdns;
  33. };
  34. struct cdns3_gadget_priv {
  35. struct cdns3 cdns;
  36. };
  37. static inline
  38. struct cdns3_role_driver *cdns3_get_current_role_driver(struct cdns3 *cdns)
  39. {
  40. WARN_ON(!cdns->roles[cdns->role]);
  41. return cdns->roles[cdns->role];
  42. }
  43. static int cdns3_role_start(struct cdns3 *cdns, enum usb_role role)
  44. {
  45. int ret;
  46. if (WARN_ON(role > USB_ROLE_DEVICE))
  47. return 0;
  48. mutex_lock(&cdns->mutex);
  49. cdns->role = role;
  50. mutex_unlock(&cdns->mutex);
  51. if (!cdns->roles[role])
  52. return -ENXIO;
  53. if (cdns->roles[role]->state == CDNS3_ROLE_STATE_ACTIVE)
  54. return 0;
  55. mutex_lock(&cdns->mutex);
  56. ret = cdns->roles[role]->start(cdns);
  57. if (!ret)
  58. cdns->roles[role]->state = CDNS3_ROLE_STATE_ACTIVE;
  59. mutex_unlock(&cdns->mutex);
  60. return ret;
  61. }
  62. static void cdns3_role_stop(struct cdns3 *cdns)
  63. {
  64. enum usb_role role = cdns->role;
  65. if (WARN_ON(role > USB_ROLE_DEVICE))
  66. return;
  67. if (cdns->roles[role]->state == CDNS3_ROLE_STATE_INACTIVE)
  68. return;
  69. mutex_lock(&cdns->mutex);
  70. cdns->roles[role]->stop(cdns);
  71. cdns->roles[role]->state = CDNS3_ROLE_STATE_INACTIVE;
  72. mutex_unlock(&cdns->mutex);
  73. }
  74. static void cdns3_exit_roles(struct cdns3 *cdns)
  75. {
  76. cdns3_role_stop(cdns);
  77. cdns3_drd_exit(cdns);
  78. }
  79. static enum usb_role cdsn3_hw_role_state_machine(struct cdns3 *cdns);
  80. /**
  81. * cdns3_core_init_role - initialize role of operation
  82. * @cdns: Pointer to cdns3 structure
  83. *
  84. * Returns 0 on success otherwise negative errno
  85. */
  86. static int cdns3_core_init_role(struct cdns3 *cdns)
  87. {
  88. struct udevice *dev = cdns->dev;
  89. enum usb_dr_mode best_dr_mode;
  90. enum usb_dr_mode dr_mode;
  91. int ret = 0;
  92. dr_mode = usb_get_dr_mode(dev_ofnode(dev));
  93. cdns->role = USB_ROLE_NONE;
  94. if (dr_mode == USB_DR_MODE_UNKNOWN) {
  95. ret = ofnode_read_u32(dev_ofnode(dev), "dr_num_mode" , &dr_mode);
  96. if (ret)
  97. return ret;
  98. }
  99. /*
  100. * If driver can't read mode by means of usb_get_dr_mode function then
  101. * chooses mode according with Kernel configuration. This setting
  102. * can be restricted later depending on strap pin configuration.
  103. */
  104. if (dr_mode == USB_DR_MODE_UNKNOWN) {
  105. if (IS_ENABLED(CONFIG_USB_CDNS3_HOST) &&
  106. IS_ENABLED(CONFIG_USB_CDNS3_GADGET))
  107. dr_mode = USB_DR_MODE_OTG;
  108. else if (IS_ENABLED(CONFIG_USB_CDNS3_HOST))
  109. dr_mode = USB_DR_MODE_HOST;
  110. else if (IS_ENABLED(CONFIG_USB_CDNS3_GADGET))
  111. dr_mode = USB_DR_MODE_PERIPHERAL;
  112. }
  113. /*
  114. * At this point cdns->dr_mode contains strap configuration.
  115. * Driver try update this setting considering kernel configuration
  116. */
  117. best_dr_mode = cdns->dr_mode;
  118. ret = cdns3_idle_init(cdns);
  119. if (ret)
  120. return ret;
  121. if (dr_mode == USB_DR_MODE_OTG) {
  122. best_dr_mode = cdns->dr_mode;
  123. } else if (cdns->dr_mode == USB_DR_MODE_OTG) {
  124. best_dr_mode = dr_mode;
  125. } else if (cdns->dr_mode != dr_mode) {
  126. dev_err(dev, "Incorrect DRD configuration\n");
  127. return -EINVAL;
  128. }
  129. dr_mode = best_dr_mode;
  130. #if defined(CONFIG_SPL_USB_HOST) || !defined(CONFIG_SPL_BUILD)
  131. if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_HOST) {
  132. ret = cdns3_host_init(cdns);
  133. if (ret) {
  134. dev_err(dev, "Host initialization failed with %d\n",
  135. ret);
  136. goto err;
  137. }
  138. }
  139. #endif
  140. #if CONFIG_IS_ENABLED(DM_USB_GADGET)
  141. if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_PERIPHERAL) {
  142. ret = cdns3_gadget_init(cdns);
  143. if (ret) {
  144. dev_err(dev, "Device initialization failed with %d\n",
  145. ret);
  146. goto err;
  147. }
  148. }
  149. #endif
  150. cdns->dr_mode = dr_mode;
  151. ret = cdns3_drd_update_mode(cdns);
  152. if (ret)
  153. goto err;
  154. if (cdns->dr_mode != USB_DR_MODE_OTG) {
  155. ret = cdns3_hw_role_switch(cdns);
  156. if (ret)
  157. goto err;
  158. }
  159. return ret;
  160. err:
  161. cdns3_exit_roles(cdns);
  162. return ret;
  163. }
  164. /**
  165. * cdsn3_hw_role_state_machine - role switch state machine based on hw events
  166. * @cdns: Pointer to controller structure.
  167. *
  168. * Returns next role to be entered based on hw events.
  169. */
  170. static enum usb_role cdsn3_hw_role_state_machine(struct cdns3 *cdns)
  171. {
  172. enum usb_role role;
  173. int id, vbus;
  174. if (cdns->dr_mode != USB_DR_MODE_OTG)
  175. goto not_otg;
  176. id = cdns3_get_id(cdns);
  177. vbus = cdns3_get_vbus(cdns);
  178. /*
  179. * Role change state machine
  180. * Inputs: ID, VBUS
  181. * Previous state: cdns->role
  182. * Next state: role
  183. */
  184. role = cdns->role;
  185. switch (role) {
  186. case USB_ROLE_NONE:
  187. /*
  188. * Driver treats USB_ROLE_NONE synonymous to IDLE state from
  189. * controller specification.
  190. */
  191. if (!id)
  192. role = USB_ROLE_HOST;
  193. else if (vbus)
  194. role = USB_ROLE_DEVICE;
  195. break;
  196. case USB_ROLE_HOST: /* from HOST, we can only change to NONE */
  197. if (id)
  198. role = USB_ROLE_NONE;
  199. break;
  200. case USB_ROLE_DEVICE: /* from GADGET, we can only change to NONE*/
  201. if (!vbus)
  202. role = USB_ROLE_NONE;
  203. break;
  204. }
  205. dev_dbg(cdns->dev, "role %d -> %d\n", cdns->role, role);
  206. return role;
  207. not_otg:
  208. if (cdns3_is_host(cdns))
  209. role = USB_ROLE_HOST;
  210. if (cdns3_is_device(cdns))
  211. role = USB_ROLE_DEVICE;
  212. return role;
  213. }
  214. static int cdns3_idle_role_start(struct cdns3 *cdns)
  215. {
  216. return 0;
  217. }
  218. static void cdns3_idle_role_stop(struct cdns3 *cdns)
  219. {
  220. /* Program Lane swap and bring PHY out of RESET */
  221. generic_phy_reset(&cdns->usb3_phy);
  222. }
  223. static int cdns3_idle_init(struct cdns3 *cdns)
  224. {
  225. struct cdns3_role_driver *rdrv;
  226. rdrv = devm_kzalloc(cdns->dev, sizeof(*rdrv), GFP_KERNEL);
  227. if (!rdrv)
  228. return -ENOMEM;
  229. rdrv->start = cdns3_idle_role_start;
  230. rdrv->stop = cdns3_idle_role_stop;
  231. rdrv->state = CDNS3_ROLE_STATE_INACTIVE;
  232. rdrv->suspend = NULL;
  233. rdrv->resume = NULL;
  234. rdrv->name = "idle";
  235. cdns->roles[USB_ROLE_NONE] = rdrv;
  236. return 0;
  237. }
  238. /**
  239. * cdns3_hw_role_switch - switch roles based on HW state
  240. * @cdns3: controller
  241. */
  242. int cdns3_hw_role_switch(struct cdns3 *cdns)
  243. {
  244. enum usb_role real_role, current_role;
  245. int ret = 0;
  246. /* Do nothing if role based on syfs. */
  247. if (cdns->role_override)
  248. return 0;
  249. current_role = cdns->role;
  250. real_role = cdsn3_hw_role_state_machine(cdns);
  251. /* Do nothing if nothing changed */
  252. if (current_role == real_role)
  253. goto exit;
  254. cdns3_role_stop(cdns);
  255. dev_dbg(cdns->dev, "Switching role %d -> %d", current_role, real_role);
  256. ret = cdns3_role_start(cdns, real_role);
  257. if (ret) {
  258. /* Back to current role */
  259. dev_err(cdns->dev, "set %d has failed, back to %d\n",
  260. real_role, current_role);
  261. ret = cdns3_role_start(cdns, current_role);
  262. if (ret)
  263. dev_err(cdns->dev, "back to %d failed too\n",
  264. current_role);
  265. }
  266. exit:
  267. return ret;
  268. }
  269. static int cdns3_probe(struct cdns3 *cdns)
  270. {
  271. struct udevice *dev = cdns->dev;
  272. int ret;
  273. cdns->xhci_regs = dev_remap_addr_name(dev, "xhci");
  274. if (!cdns->xhci_regs)
  275. return -EINVAL;
  276. cdns->dev_regs = dev_remap_addr_name(dev, "dev");
  277. if (!cdns->dev_regs)
  278. return -EINVAL;
  279. mutex_init(&cdns->mutex);
  280. ret = generic_phy_get_by_name(dev, "cdns3,usb2-phy", &cdns->usb2_phy);
  281. if (ret)
  282. dev_warn(dev, "Unable to get USB2 phy (ret %d)\n", ret);
  283. ret = generic_phy_init(&cdns->usb2_phy);
  284. if (ret)
  285. return ret;
  286. ret = generic_phy_get_by_name(dev, "cdns3,usb3-phy", &cdns->usb3_phy);
  287. if (ret)
  288. dev_warn(dev, "Unable to get USB3 phy (ret %d)\n", ret);
  289. ret = generic_phy_init(&cdns->usb3_phy);
  290. if (ret)
  291. return ret;
  292. ret = generic_phy_power_on(&cdns->usb2_phy);
  293. if (ret)
  294. return ret;
  295. ret = generic_phy_power_on(&cdns->usb3_phy);
  296. if (ret)
  297. return ret;
  298. ret = cdns3_drd_init(cdns);
  299. if (ret)
  300. return ret;
  301. ret = cdns3_core_init_role(cdns);
  302. if (ret)
  303. return ret;
  304. dev_dbg(dev, "Cadence USB3 core: probe succeed\n");
  305. return 0;
  306. }
  307. static int cdns3_remove(struct cdns3 *cdns)
  308. {
  309. cdns3_exit_roles(cdns);
  310. generic_phy_power_off(&cdns->usb2_phy);
  311. generic_phy_power_off(&cdns->usb3_phy);
  312. generic_phy_exit(&cdns->usb2_phy);
  313. generic_phy_exit(&cdns->usb3_phy);
  314. return 0;
  315. }
  316. static const struct udevice_id cdns3_ids[] = {
  317. { .compatible = "cdns,usb3" },
  318. { },
  319. };
  320. int cdns3_bind(struct udevice *parent)
  321. {
  322. enum usb_dr_mode dr_mode;
  323. struct udevice *dev;
  324. const char *driver;
  325. const char *name;
  326. ofnode node;
  327. int ret;
  328. node = ofnode_by_compatible(dev_ofnode(parent), "cdns,usb3");
  329. if (!ofnode_valid(node)) {
  330. ret = -ENODEV;
  331. goto fail;
  332. }
  333. name = ofnode_get_name(node);
  334. dr_mode = usb_get_dr_mode(node);
  335. switch (dr_mode) {
  336. #if defined(CONFIG_SPL_USB_HOST) || \
  337. (!defined(CONFIG_SPL_BUILD) && defined(CONFIG_USB_HOST))
  338. case USB_DR_MODE_HOST:
  339. debug("%s: dr_mode: HOST\n", __func__);
  340. driver = "cdns-usb3-host";
  341. break;
  342. #endif
  343. #if CONFIG_IS_ENABLED(DM_USB_GADGET)
  344. case USB_DR_MODE_PERIPHERAL:
  345. debug("%s: dr_mode: PERIPHERAL\n", __func__);
  346. driver = "cdns-usb3-peripheral";
  347. break;
  348. #endif
  349. default:
  350. printf("%s: unsupported dr_mode\n", __func__);
  351. ret = -ENODEV;
  352. goto fail;
  353. };
  354. ret = device_bind_driver_to_node(parent, driver, name, node, &dev);
  355. if (ret) {
  356. printf("%s: not able to bind usb device mode\n",
  357. __func__);
  358. goto fail;
  359. }
  360. return 0;
  361. fail:
  362. /* do not return an error: failing to bind would hang the board */
  363. return 0;
  364. }
  365. #if CONFIG_IS_ENABLED(DM_USB_GADGET)
  366. static int cdns3_gadget_probe(struct udevice *dev)
  367. {
  368. struct cdns3_gadget_priv *priv = dev_get_priv(dev);
  369. struct cdns3 *cdns = &priv->cdns;
  370. cdns->dev = dev;
  371. return cdns3_probe(cdns);
  372. }
  373. static int cdns3_gadget_remove(struct udevice *dev)
  374. {
  375. struct cdns3_gadget_priv *priv = dev_get_priv(dev);
  376. struct cdns3 *cdns = &priv->cdns;
  377. return cdns3_remove(cdns);
  378. }
  379. U_BOOT_DRIVER(cdns_usb3_peripheral) = {
  380. .name = "cdns-usb3-peripheral",
  381. .id = UCLASS_USB_GADGET_GENERIC,
  382. .of_match = cdns3_ids,
  383. .probe = cdns3_gadget_probe,
  384. .remove = cdns3_gadget_remove,
  385. .priv_auto = sizeof(struct cdns3_gadget_priv),
  386. .flags = DM_FLAG_ALLOC_PRIV_DMA,
  387. };
  388. #endif
  389. #if defined(CONFIG_SPL_USB_HOST) || \
  390. (!defined(CONFIG_SPL_BUILD) && defined(CONFIG_USB_HOST))
  391. static int cdns3_host_probe(struct udevice *dev)
  392. {
  393. struct cdns3_host_priv *priv = dev_get_priv(dev);
  394. struct cdns3 *cdns = &priv->cdns;
  395. cdns->dev = dev;
  396. return cdns3_probe(cdns);
  397. }
  398. static int cdns3_host_remove(struct udevice *dev)
  399. {
  400. struct cdns3_host_priv *priv = dev_get_priv(dev);
  401. struct cdns3 *cdns = &priv->cdns;
  402. return cdns3_remove(cdns);
  403. }
  404. U_BOOT_DRIVER(cdns_usb3_host) = {
  405. .name = "cdns-usb3-host",
  406. .id = UCLASS_USB,
  407. .of_match = cdns3_ids,
  408. .probe = cdns3_host_probe,
  409. .remove = cdns3_host_remove,
  410. .priv_auto = sizeof(struct cdns3_host_priv),
  411. .ops = &xhci_usb_ops,
  412. .flags = DM_FLAG_ALLOC_PRIV_DMA,
  413. };
  414. #endif