phy-bcm-ns-usb3.c 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * Broadcom Northstar USB 3.0 PHY Driver
  4. *
  5. * Copyright (C) 2016 Rafał Miłecki <rafal@milecki.pl>
  6. * Copyright (C) 2016 Broadcom
  7. *
  8. * All magic values used for initialization (and related comments) were obtained
  9. * from Broadcom's SDK:
  10. * Copyright (c) Broadcom Corp, 2012
  11. */
  12. #include <linux/bcma/bcma.h>
  13. #include <linux/delay.h>
  14. #include <linux/err.h>
  15. #include <linux/iopoll.h>
  16. #include <linux/mdio.h>
  17. #include <linux/module.h>
  18. #include <linux/of_address.h>
  19. #include <linux/of_platform.h>
  20. #include <linux/platform_device.h>
  21. #include <linux/phy/phy.h>
  22. #include <linux/slab.h>
  23. #define BCM_NS_USB3_MII_MNG_TIMEOUT_US 1000 /* usecs */
  24. #define BCM_NS_USB3_PHY_BASE_ADDR_REG 0x1f
  25. #define BCM_NS_USB3_PHY_PLL30_BLOCK 0x8000
  26. #define BCM_NS_USB3_PHY_TX_PMD_BLOCK 0x8040
  27. #define BCM_NS_USB3_PHY_PIPE_BLOCK 0x8060
  28. /* Registers of PLL30 block */
  29. #define BCM_NS_USB3_PLL_CONTROL 0x01
  30. #define BCM_NS_USB3_PLLA_CONTROL0 0x0a
  31. #define BCM_NS_USB3_PLLA_CONTROL1 0x0b
  32. /* Registers of TX PMD block */
  33. #define BCM_NS_USB3_TX_PMD_CONTROL1 0x01
  34. /* Registers of PIPE block */
  35. #define BCM_NS_USB3_LFPS_CMP 0x02
  36. #define BCM_NS_USB3_LFPS_DEGLITCH 0x03
  37. enum bcm_ns_family {
  38. BCM_NS_UNKNOWN,
  39. BCM_NS_AX,
  40. BCM_NS_BX,
  41. };
  42. struct bcm_ns_usb3 {
  43. struct device *dev;
  44. enum bcm_ns_family family;
  45. void __iomem *dmp;
  46. void __iomem *ccb_mii;
  47. struct mdio_device *mdiodev;
  48. struct phy *phy;
  49. int (*phy_write)(struct bcm_ns_usb3 *usb3, u16 reg, u16 value);
  50. };
  51. static const struct of_device_id bcm_ns_usb3_id_table[] = {
  52. {
  53. .compatible = "brcm,ns-ax-usb3-phy",
  54. .data = (int *)BCM_NS_AX,
  55. },
  56. {
  57. .compatible = "brcm,ns-bx-usb3-phy",
  58. .data = (int *)BCM_NS_BX,
  59. },
  60. {},
  61. };
  62. MODULE_DEVICE_TABLE(of, bcm_ns_usb3_id_table);
  63. static int bcm_ns_usb3_mdio_phy_write(struct bcm_ns_usb3 *usb3, u16 reg,
  64. u16 value)
  65. {
  66. return usb3->phy_write(usb3, reg, value);
  67. }
  68. static int bcm_ns_usb3_phy_init_ns_bx(struct bcm_ns_usb3 *usb3)
  69. {
  70. int err;
  71. /* USB3 PLL Block */
  72. err = bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_PHY_BASE_ADDR_REG,
  73. BCM_NS_USB3_PHY_PLL30_BLOCK);
  74. if (err < 0)
  75. return err;
  76. /* Assert Ana_Pllseq start */
  77. bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_PLL_CONTROL, 0x1000);
  78. /* Assert CML Divider ratio to 26 */
  79. bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_PLLA_CONTROL0, 0x6400);
  80. /* Asserting PLL Reset */
  81. bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_PLLA_CONTROL1, 0xc000);
  82. /* Deaaserting PLL Reset */
  83. bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_PLLA_CONTROL1, 0x8000);
  84. /* Deasserting USB3 system reset */
  85. writel(0, usb3->dmp + BCMA_RESET_CTL);
  86. /* PLL frequency monitor enable */
  87. bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_PLL_CONTROL, 0x9000);
  88. /* PIPE Block */
  89. bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_PHY_BASE_ADDR_REG,
  90. BCM_NS_USB3_PHY_PIPE_BLOCK);
  91. /* CMPMAX & CMPMINTH setting */
  92. bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_LFPS_CMP, 0xf30d);
  93. /* DEGLITCH MIN & MAX setting */
  94. bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_LFPS_DEGLITCH, 0x6302);
  95. /* TXPMD block */
  96. bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_PHY_BASE_ADDR_REG,
  97. BCM_NS_USB3_PHY_TX_PMD_BLOCK);
  98. /* Enabling SSC */
  99. bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_TX_PMD_CONTROL1, 0x1003);
  100. return 0;
  101. }
  102. static int bcm_ns_usb3_phy_init_ns_ax(struct bcm_ns_usb3 *usb3)
  103. {
  104. int err;
  105. /* PLL30 block */
  106. err = bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_PHY_BASE_ADDR_REG,
  107. BCM_NS_USB3_PHY_PLL30_BLOCK);
  108. if (err < 0)
  109. return err;
  110. bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_PLLA_CONTROL0, 0x6400);
  111. bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_PHY_BASE_ADDR_REG, 0x80e0);
  112. bcm_ns_usb3_mdio_phy_write(usb3, 0x02, 0x009c);
  113. /* Enable SSC */
  114. bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_PHY_BASE_ADDR_REG,
  115. BCM_NS_USB3_PHY_TX_PMD_BLOCK);
  116. bcm_ns_usb3_mdio_phy_write(usb3, 0x02, 0x21d3);
  117. bcm_ns_usb3_mdio_phy_write(usb3, BCM_NS_USB3_TX_PMD_CONTROL1, 0x1003);
  118. /* Deasserting USB3 system reset */
  119. writel(0, usb3->dmp + BCMA_RESET_CTL);
  120. return 0;
  121. }
  122. static int bcm_ns_usb3_phy_init(struct phy *phy)
  123. {
  124. struct bcm_ns_usb3 *usb3 = phy_get_drvdata(phy);
  125. int err;
  126. /* Perform USB3 system soft reset */
  127. writel(BCMA_RESET_CTL_RESET, usb3->dmp + BCMA_RESET_CTL);
  128. switch (usb3->family) {
  129. case BCM_NS_AX:
  130. err = bcm_ns_usb3_phy_init_ns_ax(usb3);
  131. break;
  132. case BCM_NS_BX:
  133. err = bcm_ns_usb3_phy_init_ns_bx(usb3);
  134. break;
  135. default:
  136. WARN_ON(1);
  137. err = -ENOTSUPP;
  138. }
  139. return err;
  140. }
  141. static const struct phy_ops ops = {
  142. .init = bcm_ns_usb3_phy_init,
  143. .owner = THIS_MODULE,
  144. };
  145. /**************************************************
  146. * MDIO driver code
  147. **************************************************/
  148. static int bcm_ns_usb3_mdiodev_phy_write(struct bcm_ns_usb3 *usb3, u16 reg,
  149. u16 value)
  150. {
  151. struct mdio_device *mdiodev = usb3->mdiodev;
  152. return mdiobus_write(mdiodev->bus, mdiodev->addr, reg, value);
  153. }
  154. static int bcm_ns_usb3_mdio_probe(struct mdio_device *mdiodev)
  155. {
  156. struct device *dev = &mdiodev->dev;
  157. const struct of_device_id *of_id;
  158. struct phy_provider *phy_provider;
  159. struct device_node *syscon_np;
  160. struct bcm_ns_usb3 *usb3;
  161. struct resource res;
  162. int err;
  163. usb3 = devm_kzalloc(dev, sizeof(*usb3), GFP_KERNEL);
  164. if (!usb3)
  165. return -ENOMEM;
  166. usb3->dev = dev;
  167. usb3->mdiodev = mdiodev;
  168. of_id = of_match_device(bcm_ns_usb3_id_table, dev);
  169. if (!of_id)
  170. return -EINVAL;
  171. usb3->family = (enum bcm_ns_family)of_id->data;
  172. syscon_np = of_parse_phandle(dev->of_node, "usb3-dmp-syscon", 0);
  173. err = of_address_to_resource(syscon_np, 0, &res);
  174. of_node_put(syscon_np);
  175. if (err)
  176. return err;
  177. usb3->dmp = devm_ioremap_resource(dev, &res);
  178. if (IS_ERR(usb3->dmp)) {
  179. dev_err(dev, "Failed to map DMP regs\n");
  180. return PTR_ERR(usb3->dmp);
  181. }
  182. usb3->phy_write = bcm_ns_usb3_mdiodev_phy_write;
  183. usb3->phy = devm_phy_create(dev, NULL, &ops);
  184. if (IS_ERR(usb3->phy)) {
  185. dev_err(dev, "Failed to create PHY\n");
  186. return PTR_ERR(usb3->phy);
  187. }
  188. phy_set_drvdata(usb3->phy, usb3);
  189. phy_provider = devm_of_phy_provider_register(dev, of_phy_simple_xlate);
  190. return PTR_ERR_OR_ZERO(phy_provider);
  191. }
  192. static struct mdio_driver bcm_ns_usb3_mdio_driver = {
  193. .mdiodrv = {
  194. .driver = {
  195. .name = "bcm_ns_mdio_usb3",
  196. .of_match_table = bcm_ns_usb3_id_table,
  197. },
  198. },
  199. .probe = bcm_ns_usb3_mdio_probe,
  200. };
  201. /**************************************************
  202. * Platform driver code
  203. **************************************************/
  204. static int bcm_ns_usb3_wait_reg(struct bcm_ns_usb3 *usb3, void __iomem *addr,
  205. u32 mask, u32 value, int usec)
  206. {
  207. u32 val;
  208. int ret;
  209. ret = readl_poll_timeout_atomic(addr, val, ((val & mask) == value),
  210. 10, usec);
  211. if (ret)
  212. dev_err(usb3->dev, "Timeout waiting for register %p\n", addr);
  213. return ret;
  214. }
  215. static inline int bcm_ns_usb3_mii_mng_wait_idle(struct bcm_ns_usb3 *usb3)
  216. {
  217. return bcm_ns_usb3_wait_reg(usb3, usb3->ccb_mii + BCMA_CCB_MII_MNG_CTL,
  218. 0x0100, 0x0000,
  219. BCM_NS_USB3_MII_MNG_TIMEOUT_US);
  220. }
  221. static int bcm_ns_usb3_platform_phy_write(struct bcm_ns_usb3 *usb3, u16 reg,
  222. u16 value)
  223. {
  224. u32 tmp = 0;
  225. int err;
  226. err = bcm_ns_usb3_mii_mng_wait_idle(usb3);
  227. if (err < 0) {
  228. dev_err(usb3->dev, "Couldn't write 0x%08x value\n", value);
  229. return err;
  230. }
  231. /* TODO: Use a proper MDIO bus layer */
  232. tmp |= 0x58020000; /* Magic value for MDIO PHY write */
  233. tmp |= reg << 18;
  234. tmp |= value;
  235. writel(tmp, usb3->ccb_mii + BCMA_CCB_MII_MNG_CMD_DATA);
  236. return bcm_ns_usb3_mii_mng_wait_idle(usb3);
  237. }
  238. static int bcm_ns_usb3_probe(struct platform_device *pdev)
  239. {
  240. struct device *dev = &pdev->dev;
  241. const struct of_device_id *of_id;
  242. struct bcm_ns_usb3 *usb3;
  243. struct resource *res;
  244. struct phy_provider *phy_provider;
  245. usb3 = devm_kzalloc(dev, sizeof(*usb3), GFP_KERNEL);
  246. if (!usb3)
  247. return -ENOMEM;
  248. usb3->dev = dev;
  249. of_id = of_match_device(bcm_ns_usb3_id_table, dev);
  250. if (!of_id)
  251. return -EINVAL;
  252. usb3->family = (enum bcm_ns_family)of_id->data;
  253. res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "dmp");
  254. usb3->dmp = devm_ioremap_resource(dev, res);
  255. if (IS_ERR(usb3->dmp)) {
  256. dev_err(dev, "Failed to map DMP regs\n");
  257. return PTR_ERR(usb3->dmp);
  258. }
  259. res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "ccb-mii");
  260. usb3->ccb_mii = devm_ioremap_resource(dev, res);
  261. if (IS_ERR(usb3->ccb_mii)) {
  262. dev_err(dev, "Failed to map ChipCommon B MII regs\n");
  263. return PTR_ERR(usb3->ccb_mii);
  264. }
  265. /* Enable MDIO. Setting MDCDIV as 26 */
  266. writel(0x0000009a, usb3->ccb_mii + BCMA_CCB_MII_MNG_CTL);
  267. /* Wait for MDIO? */
  268. udelay(2);
  269. usb3->phy_write = bcm_ns_usb3_platform_phy_write;
  270. usb3->phy = devm_phy_create(dev, NULL, &ops);
  271. if (IS_ERR(usb3->phy)) {
  272. dev_err(dev, "Failed to create PHY\n");
  273. return PTR_ERR(usb3->phy);
  274. }
  275. phy_set_drvdata(usb3->phy, usb3);
  276. platform_set_drvdata(pdev, usb3);
  277. phy_provider = devm_of_phy_provider_register(dev, of_phy_simple_xlate);
  278. if (!IS_ERR(phy_provider))
  279. dev_info(dev, "Registered Broadcom Northstar USB 3.0 PHY driver\n");
  280. return PTR_ERR_OR_ZERO(phy_provider);
  281. }
  282. static struct platform_driver bcm_ns_usb3_driver = {
  283. .probe = bcm_ns_usb3_probe,
  284. .driver = {
  285. .name = "bcm_ns_usb3",
  286. .of_match_table = bcm_ns_usb3_id_table,
  287. },
  288. };
  289. static int __init bcm_ns_usb3_module_init(void)
  290. {
  291. int err;
  292. /*
  293. * For backward compatibility we register as MDIO and platform driver.
  294. * After getting MDIO binding commonly used (e.g. switching all DT files
  295. * to use it) we should deprecate the old binding and eventually drop
  296. * support for it.
  297. */
  298. err = mdio_driver_register(&bcm_ns_usb3_mdio_driver);
  299. if (err)
  300. return err;
  301. err = platform_driver_register(&bcm_ns_usb3_driver);
  302. if (err)
  303. mdio_driver_unregister(&bcm_ns_usb3_mdio_driver);
  304. return err;
  305. }
  306. module_init(bcm_ns_usb3_module_init);
  307. static void __exit bcm_ns_usb3_module_exit(void)
  308. {
  309. platform_driver_unregister(&bcm_ns_usb3_driver);
  310. mdio_driver_unregister(&bcm_ns_usb3_mdio_driver);
  311. }
  312. module_exit(bcm_ns_usb3_module_exit)
  313. MODULE_LICENSE("GPL v2");