phy-rcar-gen3-usb3.c 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * Renesas R-Car Gen3 for USB3.0 PHY driver
  4. *
  5. * Copyright (C) 2017 Renesas Electronics Corporation
  6. */
  7. #include <linux/clk.h>
  8. #include <linux/delay.h>
  9. #include <linux/io.h>
  10. #include <linux/module.h>
  11. #include <linux/of.h>
  12. #include <linux/phy/phy.h>
  13. #include <linux/platform_device.h>
  14. #include <linux/pm_runtime.h>
  15. #define USB30_CLKSET0 0x034
  16. #define USB30_CLKSET1 0x036
  17. #define USB30_SSC_SET 0x038
  18. #define USB30_PHY_ENABLE 0x060
  19. #define USB30_VBUS_EN 0x064
  20. /* USB30_CLKSET0 */
  21. #define CLKSET0_PRIVATE 0x05c0
  22. #define CLKSET0_USB30_FSEL_USB_EXTAL 0x0002
  23. /* USB30_CLKSET1 */
  24. #define CLKSET1_USB30_PLL_MULTI_SHIFT 6
  25. #define CLKSET1_USB30_PLL_MULTI_USB_EXTAL (0x64 << \
  26. CLKSET1_USB30_PLL_MULTI_SHIFT)
  27. #define CLKSET1_PHYRESET BIT(4) /* 1: reset */
  28. #define CLKSET1_REF_CLKDIV BIT(3) /* 1: USB_EXTAL */
  29. #define CLKSET1_PRIVATE_2_1 BIT(1) /* Write B'01 */
  30. #define CLKSET1_REF_CLK_SEL BIT(0) /* 1: USB3S0_CLK_P */
  31. /* USB30_SSC_SET */
  32. #define SSC_SET_SSC_EN BIT(12)
  33. #define SSC_SET_RANGE_SHIFT 9
  34. #define SSC_SET_RANGE_4980 (0x0 << SSC_SET_RANGE_SHIFT)
  35. #define SSC_SET_RANGE_4492 (0x1 << SSC_SET_RANGE_SHIFT)
  36. #define SSC_SET_RANGE_4003 (0x2 << SSC_SET_RANGE_SHIFT)
  37. /* USB30_PHY_ENABLE */
  38. #define PHY_ENABLE_RESET_EN BIT(4)
  39. /* USB30_VBUS_EN */
  40. #define VBUS_EN_VBUS_EN BIT(1)
  41. struct rcar_gen3_usb3 {
  42. void __iomem *base;
  43. struct phy *phy;
  44. u32 ssc_range;
  45. bool usb3s_clk;
  46. bool usb_extal;
  47. };
  48. static void write_clkset1_for_usb_extal(struct rcar_gen3_usb3 *r, bool reset)
  49. {
  50. u16 val = CLKSET1_USB30_PLL_MULTI_USB_EXTAL |
  51. CLKSET1_REF_CLKDIV | CLKSET1_PRIVATE_2_1;
  52. if (reset)
  53. val |= CLKSET1_PHYRESET;
  54. writew(val, r->base + USB30_CLKSET1);
  55. }
  56. static void rcar_gen3_phy_usb3_enable_ssc(struct rcar_gen3_usb3 *r)
  57. {
  58. u16 val = SSC_SET_SSC_EN;
  59. switch (r->ssc_range) {
  60. case 4980:
  61. val |= SSC_SET_RANGE_4980;
  62. break;
  63. case 4492:
  64. val |= SSC_SET_RANGE_4492;
  65. break;
  66. case 4003:
  67. val |= SSC_SET_RANGE_4003;
  68. break;
  69. default:
  70. dev_err(&r->phy->dev, "%s: unsupported range (%x)\n", __func__,
  71. r->ssc_range);
  72. return;
  73. }
  74. writew(val, r->base + USB30_SSC_SET);
  75. }
  76. static void rcar_gen3_phy_usb3_select_usb_extal(struct rcar_gen3_usb3 *r)
  77. {
  78. write_clkset1_for_usb_extal(r, false);
  79. if (r->ssc_range)
  80. rcar_gen3_phy_usb3_enable_ssc(r);
  81. writew(CLKSET0_PRIVATE | CLKSET0_USB30_FSEL_USB_EXTAL,
  82. r->base + USB30_CLKSET0);
  83. writew(PHY_ENABLE_RESET_EN, r->base + USB30_PHY_ENABLE);
  84. write_clkset1_for_usb_extal(r, true);
  85. usleep_range(10, 20);
  86. write_clkset1_for_usb_extal(r, false);
  87. }
  88. static int rcar_gen3_phy_usb3_init(struct phy *p)
  89. {
  90. struct rcar_gen3_usb3 *r = phy_get_drvdata(p);
  91. dev_vdbg(&r->phy->dev, "%s: enter (%d, %d, %d)\n", __func__,
  92. r->usb3s_clk, r->usb_extal, r->ssc_range);
  93. if (!r->usb3s_clk && r->usb_extal)
  94. rcar_gen3_phy_usb3_select_usb_extal(r);
  95. /* Enables VBUS detection anyway */
  96. writew(VBUS_EN_VBUS_EN, r->base + USB30_VBUS_EN);
  97. return 0;
  98. }
  99. static const struct phy_ops rcar_gen3_phy_usb3_ops = {
  100. .init = rcar_gen3_phy_usb3_init,
  101. .owner = THIS_MODULE,
  102. };
  103. static const struct of_device_id rcar_gen3_phy_usb3_match_table[] = {
  104. { .compatible = "renesas,rcar-gen3-usb3-phy" },
  105. { }
  106. };
  107. MODULE_DEVICE_TABLE(of, rcar_gen3_phy_usb3_match_table);
  108. static int rcar_gen3_phy_usb3_probe(struct platform_device *pdev)
  109. {
  110. struct device *dev = &pdev->dev;
  111. struct rcar_gen3_usb3 *r;
  112. struct phy_provider *provider;
  113. struct resource *res;
  114. int ret = 0;
  115. struct clk *clk;
  116. if (!dev->of_node) {
  117. dev_err(dev, "This driver needs device tree\n");
  118. return -EINVAL;
  119. }
  120. r = devm_kzalloc(dev, sizeof(*r), GFP_KERNEL);
  121. if (!r)
  122. return -ENOMEM;
  123. res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  124. r->base = devm_ioremap_resource(dev, res);
  125. if (IS_ERR(r->base))
  126. return PTR_ERR(r->base);
  127. clk = devm_clk_get(dev, "usb3s_clk");
  128. if (!IS_ERR(clk) && !clk_prepare_enable(clk)) {
  129. r->usb3s_clk = !!clk_get_rate(clk);
  130. clk_disable_unprepare(clk);
  131. }
  132. clk = devm_clk_get(dev, "usb_extal");
  133. if (!IS_ERR(clk) && !clk_prepare_enable(clk)) {
  134. r->usb_extal = !!clk_get_rate(clk);
  135. clk_disable_unprepare(clk);
  136. }
  137. if (!r->usb3s_clk && !r->usb_extal) {
  138. dev_err(dev, "This driver needs usb3s_clk and/or usb_extal\n");
  139. ret = -EINVAL;
  140. goto error;
  141. }
  142. /*
  143. * devm_phy_create() will call pm_runtime_enable(&phy->dev);
  144. * And then, phy-core will manage runtime pm for this device.
  145. */
  146. pm_runtime_enable(dev);
  147. r->phy = devm_phy_create(dev, NULL, &rcar_gen3_phy_usb3_ops);
  148. if (IS_ERR(r->phy)) {
  149. dev_err(dev, "Failed to create USB3 PHY\n");
  150. ret = PTR_ERR(r->phy);
  151. goto error;
  152. }
  153. of_property_read_u32(dev->of_node, "renesas,ssc-range", &r->ssc_range);
  154. platform_set_drvdata(pdev, r);
  155. phy_set_drvdata(r->phy, r);
  156. provider = devm_of_phy_provider_register(dev, of_phy_simple_xlate);
  157. if (IS_ERR(provider)) {
  158. dev_err(dev, "Failed to register PHY provider\n");
  159. ret = PTR_ERR(provider);
  160. goto error;
  161. }
  162. return 0;
  163. error:
  164. pm_runtime_disable(dev);
  165. return ret;
  166. }
  167. static int rcar_gen3_phy_usb3_remove(struct platform_device *pdev)
  168. {
  169. pm_runtime_disable(&pdev->dev);
  170. return 0;
  171. };
  172. static struct platform_driver rcar_gen3_phy_usb3_driver = {
  173. .driver = {
  174. .name = "phy_rcar_gen3_usb3",
  175. .of_match_table = rcar_gen3_phy_usb3_match_table,
  176. },
  177. .probe = rcar_gen3_phy_usb3_probe,
  178. .remove = rcar_gen3_phy_usb3_remove,
  179. };
  180. module_platform_driver(rcar_gen3_phy_usb3_driver);
  181. MODULE_LICENSE("GPL v2");
  182. MODULE_DESCRIPTION("Renesas R-Car Gen3 USB 3.0 PHY");
  183. MODULE_AUTHOR("Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>");