core.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499
  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. /*
  95. * If driver can't read mode by means of usb_get_dr_mode function then
  96. * chooses mode according with Kernel configuration. This setting
  97. * can be restricted later depending on strap pin configuration.
  98. */
  99. if (dr_mode == USB_DR_MODE_UNKNOWN) {
  100. if (IS_ENABLED(CONFIG_USB_CDNS3_HOST) &&
  101. IS_ENABLED(CONFIG_USB_CDNS3_GADGET))
  102. dr_mode = USB_DR_MODE_OTG;
  103. else if (IS_ENABLED(CONFIG_USB_CDNS3_HOST))
  104. dr_mode = USB_DR_MODE_HOST;
  105. else if (IS_ENABLED(CONFIG_USB_CDNS3_GADGET))
  106. dr_mode = USB_DR_MODE_PERIPHERAL;
  107. }
  108. /*
  109. * At this point cdns->dr_mode contains strap configuration.
  110. * Driver try update this setting considering kernel configuration
  111. */
  112. best_dr_mode = cdns->dr_mode;
  113. ret = cdns3_idle_init(cdns);
  114. if (ret)
  115. return ret;
  116. if (dr_mode == USB_DR_MODE_OTG) {
  117. best_dr_mode = cdns->dr_mode;
  118. } else if (cdns->dr_mode == USB_DR_MODE_OTG) {
  119. best_dr_mode = dr_mode;
  120. } else if (cdns->dr_mode != dr_mode) {
  121. dev_err(dev, "Incorrect DRD configuration\n");
  122. return -EINVAL;
  123. }
  124. dr_mode = best_dr_mode;
  125. #if defined(CONFIG_SPL_USB_HOST) || !defined(CONFIG_SPL_BUILD)
  126. if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_HOST) {
  127. ret = cdns3_host_init(cdns);
  128. if (ret) {
  129. dev_err(dev, "Host initialization failed with %d\n",
  130. ret);
  131. goto err;
  132. }
  133. }
  134. #endif
  135. #if CONFIG_IS_ENABLED(DM_USB_GADGET)
  136. if (dr_mode == USB_DR_MODE_OTG || dr_mode == USB_DR_MODE_PERIPHERAL) {
  137. ret = cdns3_gadget_init(cdns);
  138. if (ret) {
  139. dev_err(dev, "Device initialization failed with %d\n",
  140. ret);
  141. goto err;
  142. }
  143. }
  144. #endif
  145. cdns->dr_mode = dr_mode;
  146. ret = cdns3_drd_update_mode(cdns);
  147. if (ret)
  148. goto err;
  149. if (cdns->dr_mode != USB_DR_MODE_OTG) {
  150. ret = cdns3_hw_role_switch(cdns);
  151. if (ret)
  152. goto err;
  153. }
  154. return ret;
  155. err:
  156. cdns3_exit_roles(cdns);
  157. return ret;
  158. }
  159. /**
  160. * cdsn3_hw_role_state_machine - role switch state machine based on hw events
  161. * @cdns: Pointer to controller structure.
  162. *
  163. * Returns next role to be entered based on hw events.
  164. */
  165. static enum usb_role cdsn3_hw_role_state_machine(struct cdns3 *cdns)
  166. {
  167. enum usb_role role;
  168. int id, vbus;
  169. if (cdns->dr_mode != USB_DR_MODE_OTG)
  170. goto not_otg;
  171. id = cdns3_get_id(cdns);
  172. vbus = cdns3_get_vbus(cdns);
  173. /*
  174. * Role change state machine
  175. * Inputs: ID, VBUS
  176. * Previous state: cdns->role
  177. * Next state: role
  178. */
  179. role = cdns->role;
  180. switch (role) {
  181. case USB_ROLE_NONE:
  182. /*
  183. * Driver treats USB_ROLE_NONE synonymous to IDLE state from
  184. * controller specification.
  185. */
  186. if (!id)
  187. role = USB_ROLE_HOST;
  188. else if (vbus)
  189. role = USB_ROLE_DEVICE;
  190. break;
  191. case USB_ROLE_HOST: /* from HOST, we can only change to NONE */
  192. if (id)
  193. role = USB_ROLE_NONE;
  194. break;
  195. case USB_ROLE_DEVICE: /* from GADGET, we can only change to NONE*/
  196. if (!vbus)
  197. role = USB_ROLE_NONE;
  198. break;
  199. }
  200. dev_dbg(cdns->dev, "role %d -> %d\n", cdns->role, role);
  201. return role;
  202. not_otg:
  203. if (cdns3_is_host(cdns))
  204. role = USB_ROLE_HOST;
  205. if (cdns3_is_device(cdns))
  206. role = USB_ROLE_DEVICE;
  207. return role;
  208. }
  209. static int cdns3_idle_role_start(struct cdns3 *cdns)
  210. {
  211. return 0;
  212. }
  213. static void cdns3_idle_role_stop(struct cdns3 *cdns)
  214. {
  215. /* Program Lane swap and bring PHY out of RESET */
  216. generic_phy_reset(&cdns->usb3_phy);
  217. }
  218. static int cdns3_idle_init(struct cdns3 *cdns)
  219. {
  220. struct cdns3_role_driver *rdrv;
  221. rdrv = devm_kzalloc(cdns->dev, sizeof(*rdrv), GFP_KERNEL);
  222. if (!rdrv)
  223. return -ENOMEM;
  224. rdrv->start = cdns3_idle_role_start;
  225. rdrv->stop = cdns3_idle_role_stop;
  226. rdrv->state = CDNS3_ROLE_STATE_INACTIVE;
  227. rdrv->suspend = NULL;
  228. rdrv->resume = NULL;
  229. rdrv->name = "idle";
  230. cdns->roles[USB_ROLE_NONE] = rdrv;
  231. return 0;
  232. }
  233. /**
  234. * cdns3_hw_role_switch - switch roles based on HW state
  235. * @cdns3: controller
  236. */
  237. int cdns3_hw_role_switch(struct cdns3 *cdns)
  238. {
  239. enum usb_role real_role, current_role;
  240. int ret = 0;
  241. /* Do nothing if role based on syfs. */
  242. if (cdns->role_override)
  243. return 0;
  244. current_role = cdns->role;
  245. real_role = cdsn3_hw_role_state_machine(cdns);
  246. /* Do nothing if nothing changed */
  247. if (current_role == real_role)
  248. goto exit;
  249. cdns3_role_stop(cdns);
  250. dev_dbg(cdns->dev, "Switching role %d -> %d", current_role, real_role);
  251. ret = cdns3_role_start(cdns, real_role);
  252. if (ret) {
  253. /* Back to current role */
  254. dev_err(cdns->dev, "set %d has failed, back to %d\n",
  255. real_role, current_role);
  256. ret = cdns3_role_start(cdns, current_role);
  257. if (ret)
  258. dev_err(cdns->dev, "back to %d failed too\n",
  259. current_role);
  260. }
  261. exit:
  262. return ret;
  263. }
  264. static int cdns3_probe(struct cdns3 *cdns)
  265. {
  266. struct udevice *dev = cdns->dev;
  267. int ret;
  268. cdns->xhci_regs = dev_remap_addr_name(dev, "xhci");
  269. if (!cdns->xhci_regs)
  270. return -EINVAL;
  271. cdns->dev_regs = dev_remap_addr_name(dev, "dev");
  272. if (!cdns->dev_regs)
  273. return -EINVAL;
  274. mutex_init(&cdns->mutex);
  275. ret = generic_phy_get_by_name(dev, "cdns3,usb2-phy", &cdns->usb2_phy);
  276. if (ret)
  277. dev_warn(dev, "Unable to get USB2 phy (ret %d)\n", ret);
  278. ret = generic_phy_init(&cdns->usb2_phy);
  279. if (ret)
  280. return ret;
  281. ret = generic_phy_get_by_name(dev, "cdns3,usb3-phy", &cdns->usb3_phy);
  282. if (ret)
  283. dev_warn(dev, "Unable to get USB3 phy (ret %d)\n", ret);
  284. ret = generic_phy_init(&cdns->usb3_phy);
  285. if (ret)
  286. return ret;
  287. ret = generic_phy_power_on(&cdns->usb2_phy);
  288. if (ret)
  289. return ret;
  290. ret = generic_phy_power_on(&cdns->usb3_phy);
  291. if (ret)
  292. return ret;
  293. ret = cdns3_drd_init(cdns);
  294. if (ret)
  295. return ret;
  296. ret = cdns3_core_init_role(cdns);
  297. if (ret)
  298. return ret;
  299. dev_dbg(dev, "Cadence USB3 core: probe succeed\n");
  300. return 0;
  301. }
  302. static int cdns3_remove(struct cdns3 *cdns)
  303. {
  304. cdns3_exit_roles(cdns);
  305. generic_phy_power_off(&cdns->usb2_phy);
  306. generic_phy_power_off(&cdns->usb3_phy);
  307. generic_phy_exit(&cdns->usb2_phy);
  308. generic_phy_exit(&cdns->usb3_phy);
  309. return 0;
  310. }
  311. static const struct udevice_id cdns3_ids[] = {
  312. { .compatible = "cdns,usb3" },
  313. { },
  314. };
  315. int cdns3_bind(struct udevice *parent)
  316. {
  317. enum usb_dr_mode dr_mode;
  318. struct udevice *dev;
  319. const char *driver;
  320. const char *name;
  321. ofnode node;
  322. int ret;
  323. node = ofnode_by_compatible(dev_ofnode(parent), "cdns,usb3");
  324. if (!ofnode_valid(node)) {
  325. ret = -ENODEV;
  326. goto fail;
  327. }
  328. name = ofnode_get_name(node);
  329. dr_mode = usb_get_dr_mode(node);
  330. switch (dr_mode) {
  331. #if defined(CONFIG_SPL_USB_HOST) || \
  332. (!defined(CONFIG_SPL_BUILD) && defined(CONFIG_USB_HOST))
  333. case USB_DR_MODE_HOST:
  334. debug("%s: dr_mode: HOST\n", __func__);
  335. driver = "cdns-usb3-host";
  336. break;
  337. #endif
  338. #if CONFIG_IS_ENABLED(DM_USB_GADGET)
  339. case USB_DR_MODE_PERIPHERAL:
  340. debug("%s: dr_mode: PERIPHERAL\n", __func__);
  341. driver = "cdns-usb3-peripheral";
  342. break;
  343. #endif
  344. default:
  345. printf("%s: unsupported dr_mode\n", __func__);
  346. ret = -ENODEV;
  347. goto fail;
  348. };
  349. ret = device_bind_driver_to_node(parent, driver, name, node, &dev);
  350. if (ret) {
  351. printf("%s: not able to bind usb device mode\n",
  352. __func__);
  353. goto fail;
  354. }
  355. return 0;
  356. fail:
  357. /* do not return an error: failing to bind would hang the board */
  358. return 0;
  359. }
  360. #if CONFIG_IS_ENABLED(DM_USB_GADGET)
  361. static int cdns3_gadget_probe(struct udevice *dev)
  362. {
  363. struct cdns3_gadget_priv *priv = dev_get_priv(dev);
  364. struct cdns3 *cdns = &priv->cdns;
  365. cdns->dev = dev;
  366. return cdns3_probe(cdns);
  367. }
  368. static int cdns3_gadget_remove(struct udevice *dev)
  369. {
  370. struct cdns3_gadget_priv *priv = dev_get_priv(dev);
  371. struct cdns3 *cdns = &priv->cdns;
  372. return cdns3_remove(cdns);
  373. }
  374. U_BOOT_DRIVER(cdns_usb3_peripheral) = {
  375. .name = "cdns-usb3-peripheral",
  376. .id = UCLASS_USB_GADGET_GENERIC,
  377. .of_match = cdns3_ids,
  378. .probe = cdns3_gadget_probe,
  379. .remove = cdns3_gadget_remove,
  380. .priv_auto = sizeof(struct cdns3_gadget_priv),
  381. .flags = DM_FLAG_ALLOC_PRIV_DMA,
  382. };
  383. #endif
  384. #if defined(CONFIG_SPL_USB_HOST) || \
  385. (!defined(CONFIG_SPL_BUILD) && defined(CONFIG_USB_HOST))
  386. static int cdns3_host_probe(struct udevice *dev)
  387. {
  388. struct cdns3_host_priv *priv = dev_get_priv(dev);
  389. struct cdns3 *cdns = &priv->cdns;
  390. cdns->dev = dev;
  391. return cdns3_probe(cdns);
  392. }
  393. static int cdns3_host_remove(struct udevice *dev)
  394. {
  395. struct cdns3_host_priv *priv = dev_get_priv(dev);
  396. struct cdns3 *cdns = &priv->cdns;
  397. return cdns3_remove(cdns);
  398. }
  399. U_BOOT_DRIVER(cdns_usb3_host) = {
  400. .name = "cdns-usb3-host",
  401. .id = UCLASS_USB,
  402. .of_match = cdns3_ids,
  403. .probe = cdns3_host_probe,
  404. .remove = cdns3_host_remove,
  405. .priv_auto = sizeof(struct cdns3_host_priv),
  406. .ops = &xhci_usb_ops,
  407. .flags = DM_FLAG_ALLOC_PRIV_DMA,
  408. };
  409. #endif