1 // SPDX-License-Identifier: GPL-2.0
3 * phy-rtk-usb2.c RTK usb2.0 PHY driver
5 * Copyright (C) 2023 Realtek Semiconductor Corporation
9 #include <linux/module.h>
11 #include <linux/of_address.h>
12 #include <linux/platform_device.h>
13 #include <linux/uaccess.h>
14 #include <linux/debugfs.h>
15 #include <linux/nvmem-consumer.h>
16 #include <linux/regmap.h>
17 #include <linux/sys_soc.h>
18 #include <linux/mfd/syscon.h>
19 #include <linux/phy/phy.h>
20 #include <linux/usb.h>
22 /* GUSB2PHYACCn register */
23 #define PHY_NEW_REG_REQ BIT(25)
24 #define PHY_VSTS_BUSY BIT(23)
25 #define PHY_VCTRL_SHIFT 8
26 #define PHY_REG_DATA_MASK 0xff
28 #define GET_LOW_NIBBLE(addr) ((addr) & 0x0f)
29 #define GET_HIGH_NIBBLE(addr) (((addr) & 0xf0) >> 4)
31 #define EFUS_USB_DC_CAL_RATE 2
32 #define EFUS_USB_DC_CAL_MAX 7
34 #define EFUS_USB_DC_DIS_RATE 1
35 #define EFUS_USB_DC_DIS_MAX 7
37 #define MAX_PHY_DATA_SIZE 20
38 #define OFFEST_PHY_READ 0x20
40 #define MAX_USB_PHY_NUM 4
41 #define MAX_USB_PHY_PAGE0_DATA_SIZE 16
42 #define MAX_USB_PHY_PAGE1_DATA_SIZE 16
43 #define MAX_USB_PHY_PAGE2_DATA_SIZE 8
45 #define SET_PAGE_OFFSET 0xf4
46 #define SET_PAGE_0 0x9b
47 #define SET_PAGE_1 0xbb
48 #define SET_PAGE_2 0xdb
50 #define PAGE_START 0xe0
51 #define PAGE0_0XE4 0xe4
52 #define PAGE0_0XE6 0xe6
53 #define PAGE0_0XE7 0xe7
54 #define PAGE1_0XE0 0xe0
55 #define PAGE1_0XE2 0xe2
57 #define SENSITIVITY_CTRL (BIT(4) | BIT(5) | BIT(6))
58 #define ENABLE_AUTO_SENSITIVITY_CALIBRATION BIT(2)
59 #define DEFAULT_DC_DRIVING_VALUE (0x8)
60 #define DEFAULT_DC_DISCONNECTION_VALUE (0x6)
61 #define HS_CLK_SELECT BIT(6)
64 void __iomem *reg_wrap_vstatus;
65 void __iomem *reg_gusb2phyacc0;
76 struct phy_data page0[MAX_USB_PHY_PAGE0_DATA_SIZE];
78 struct phy_data page1[MAX_USB_PHY_PAGE1_DATA_SIZE];
80 struct phy_data page2[MAX_USB_PHY_PAGE2_DATA_SIZE];
85 int check_efuse_version;
86 #define CHECK_EFUSE_V1 1
87 #define CHECK_EFUSE_V2 2
88 int efuse_dc_driving_rate;
89 int efuse_dc_disconnect_rate;
91 int dc_disconnect_mask;
92 bool usb_dc_disconnect_at_page0;
93 int driving_updated_for_dev_dis;
96 bool do_toggle_driving;
97 bool use_default_parameter;
98 bool is_double_sensitivity_mode;
101 struct phy_parameter {
102 struct phy_reg phy_reg;
109 bool inverse_hstx_sync_clock;
111 s32 driving_level_compensate;
112 s32 disconnection_compensate;
118 struct phy_cfg *phy_cfg;
120 struct phy_parameter *phy_parameter;
122 struct dentry *debug_dir;
125 /* mapping 0xE0 to 0 ... 0xE7 to 7, 0xF0 to 8 ,,, 0xF7 to 15 */
126 static inline int page_addr_to_array_index(u8 addr)
128 return (int)((((addr) - PAGE_START) & 0x7) +
129 ((((addr) - PAGE_START) & 0x10) >> 1));
132 static inline u8 array_index_to_page_addr(int index)
134 return ((((index) + PAGE_START) & 0x7) +
135 ((((index) & 0x8) << 1) + PAGE_START));
138 #define PHY_IO_TIMEOUT_USEC (50000)
139 #define PHY_IO_DELAY_US (100)
141 static inline int utmi_wait_register(void __iomem *reg, u32 mask, u32 result)
146 ret = read_poll_timeout(readl, val, ((val & mask) == result),
147 PHY_IO_DELAY_US, PHY_IO_TIMEOUT_USEC, false, reg);
149 pr_err("%s can't program USB phy\n", __func__);
156 static char rtk_phy_read(struct phy_reg *phy_reg, char addr)
158 void __iomem *reg_gusb2phyacc0 = phy_reg->reg_gusb2phyacc0;
162 addr -= OFFEST_PHY_READ;
164 /* polling until VBusy == 0 */
165 ret = utmi_wait_register(reg_gusb2phyacc0, PHY_VSTS_BUSY, 0);
169 /* VCtrl = low nibble of addr, and set PHY_NEW_REG_REQ */
170 val = PHY_NEW_REG_REQ | (GET_LOW_NIBBLE(addr) << PHY_VCTRL_SHIFT);
171 writel(val, reg_gusb2phyacc0);
172 ret = utmi_wait_register(reg_gusb2phyacc0, PHY_VSTS_BUSY, 0);
176 /* VCtrl = high nibble of addr, and set PHY_NEW_REG_REQ */
177 val = PHY_NEW_REG_REQ | (GET_HIGH_NIBBLE(addr) << PHY_VCTRL_SHIFT);
178 writel(val, reg_gusb2phyacc0);
179 ret = utmi_wait_register(reg_gusb2phyacc0, PHY_VSTS_BUSY, 0);
183 val = readl(reg_gusb2phyacc0);
185 return (char)(val & PHY_REG_DATA_MASK);
188 static int rtk_phy_write(struct phy_reg *phy_reg, char addr, char data)
191 void __iomem *reg_wrap_vstatus = phy_reg->reg_wrap_vstatus;
192 void __iomem *reg_gusb2phyacc0 = phy_reg->reg_gusb2phyacc0;
193 int shift_bits = phy_reg->vstatus_index * 8;
196 /* write data to VStatusOut2 (data output to phy) */
197 writel((u32)data << shift_bits, reg_wrap_vstatus);
199 ret = utmi_wait_register(reg_gusb2phyacc0, PHY_VSTS_BUSY, 0);
203 /* VCtrl = low nibble of addr, set PHY_NEW_REG_REQ */
204 val = PHY_NEW_REG_REQ | (GET_LOW_NIBBLE(addr) << PHY_VCTRL_SHIFT);
206 writel(val, reg_gusb2phyacc0);
207 ret = utmi_wait_register(reg_gusb2phyacc0, PHY_VSTS_BUSY, 0);
211 /* VCtrl = high nibble of addr, set PHY_NEW_REG_REQ */
212 val = PHY_NEW_REG_REQ | (GET_HIGH_NIBBLE(addr) << PHY_VCTRL_SHIFT);
214 writel(val, reg_gusb2phyacc0);
215 ret = utmi_wait_register(reg_gusb2phyacc0, PHY_VSTS_BUSY, 0);
222 static int rtk_phy_set_page(struct phy_reg *phy_reg, int page)
226 return rtk_phy_write(phy_reg, SET_PAGE_OFFSET, SET_PAGE_0);
228 return rtk_phy_write(phy_reg, SET_PAGE_OFFSET, SET_PAGE_1);
230 return rtk_phy_write(phy_reg, SET_PAGE_OFFSET, SET_PAGE_2);
232 pr_err("%s error page=%d\n", __func__, page);
238 static u8 __updated_dc_disconnect_level_page0_0xe4(struct phy_cfg *phy_cfg,
239 struct phy_parameter *phy_parameter, u8 data)
243 s32 dc_disconnect_mask = phy_cfg->dc_disconnect_mask;
246 val = (s32)((data >> offset) & dc_disconnect_mask)
247 + phy_parameter->efuse_usb_dc_dis
248 + phy_parameter->disconnection_compensate;
250 if (val > dc_disconnect_mask)
251 val = dc_disconnect_mask;
255 ret = (data & (~(dc_disconnect_mask << offset))) |
256 (val & dc_disconnect_mask) << offset;
261 /* updated disconnect level at page0 */
262 static void update_dc_disconnect_level_at_page0(struct rtk_phy *rtk_phy,
263 struct phy_parameter *phy_parameter, bool update)
265 struct phy_cfg *phy_cfg;
266 struct phy_reg *phy_reg;
267 struct phy_data *phy_data_page;
268 struct phy_data *phy_data;
271 s32 dc_disconnect_mask;
274 phy_cfg = rtk_phy->phy_cfg;
275 phy_reg = &phy_parameter->phy_reg;
278 phy_data_page = phy_cfg->page0;
279 rtk_phy_set_page(phy_reg, 0);
281 i = page_addr_to_array_index(PAGE0_0XE4);
282 phy_data = phy_data_page + i;
283 if (!phy_data->addr) {
284 phy_data->addr = PAGE0_0XE4;
285 phy_data->data = rtk_phy_read(phy_reg, PAGE0_0XE4);
288 addr = phy_data->addr;
289 data = phy_data->data;
290 dc_disconnect_mask = phy_cfg->dc_disconnect_mask;
293 data = __updated_dc_disconnect_level_page0_0xe4(phy_cfg, phy_parameter, data);
295 data = (data & ~(dc_disconnect_mask << offset)) |
296 (DEFAULT_DC_DISCONNECTION_VALUE << offset);
298 if (rtk_phy_write(phy_reg, addr, data))
299 dev_err(rtk_phy->dev,
300 "%s: Error to set page1 parameter addr=0x%x value=0x%x\n",
301 __func__, addr, data);
304 static u8 __updated_dc_disconnect_level_page1_0xe2(struct phy_cfg *phy_cfg,
305 struct phy_parameter *phy_parameter, u8 data)
309 s32 dc_disconnect_mask = phy_cfg->dc_disconnect_mask;
311 if (phy_cfg->check_efuse_version == CHECK_EFUSE_V1) {
312 val = (s32)(data & dc_disconnect_mask)
313 + phy_parameter->efuse_usb_dc_dis
314 + phy_parameter->disconnection_compensate;
315 } else { /* for CHECK_EFUSE_V2 or no efuse */
316 if (phy_parameter->efuse_usb_dc_dis)
317 val = (s32)(phy_parameter->efuse_usb_dc_dis +
318 phy_parameter->disconnection_compensate);
320 val = (s32)((data & dc_disconnect_mask) +
321 phy_parameter->disconnection_compensate);
324 if (val > dc_disconnect_mask)
325 val = dc_disconnect_mask;
329 ret = (data & (~dc_disconnect_mask)) | (val & dc_disconnect_mask);
334 /* updated disconnect level at page1 */
335 static void update_dc_disconnect_level_at_page1(struct rtk_phy *rtk_phy,
336 struct phy_parameter *phy_parameter, bool update)
338 struct phy_cfg *phy_cfg;
339 struct phy_data *phy_data_page;
340 struct phy_data *phy_data;
341 struct phy_reg *phy_reg;
343 s32 dc_disconnect_mask;
346 phy_cfg = rtk_phy->phy_cfg;
347 phy_reg = &phy_parameter->phy_reg;
350 phy_data_page = phy_cfg->page1;
351 rtk_phy_set_page(phy_reg, 1);
353 i = page_addr_to_array_index(PAGE1_0XE2);
354 phy_data = phy_data_page + i;
355 if (!phy_data->addr) {
356 phy_data->addr = PAGE1_0XE2;
357 phy_data->data = rtk_phy_read(phy_reg, PAGE1_0XE2);
360 addr = phy_data->addr;
361 data = phy_data->data;
362 dc_disconnect_mask = phy_cfg->dc_disconnect_mask;
365 data = __updated_dc_disconnect_level_page1_0xe2(phy_cfg, phy_parameter, data);
367 data = (data & ~dc_disconnect_mask) | DEFAULT_DC_DISCONNECTION_VALUE;
369 if (rtk_phy_write(phy_reg, addr, data))
370 dev_err(rtk_phy->dev,
371 "%s: Error to set page1 parameter addr=0x%x value=0x%x\n",
372 __func__, addr, data);
375 static void update_dc_disconnect_level(struct rtk_phy *rtk_phy,
376 struct phy_parameter *phy_parameter, bool update)
378 struct phy_cfg *phy_cfg = rtk_phy->phy_cfg;
380 if (phy_cfg->usb_dc_disconnect_at_page0)
381 update_dc_disconnect_level_at_page0(rtk_phy, phy_parameter, update);
383 update_dc_disconnect_level_at_page1(rtk_phy, phy_parameter, update);
386 static u8 __update_dc_driving_page0_0xe4(struct phy_cfg *phy_cfg,
387 struct phy_parameter *phy_parameter, u8 data)
389 s32 driving_level_compensate = phy_parameter->driving_level_compensate;
390 s32 dc_driving_mask = phy_cfg->dc_driving_mask;
394 if (phy_cfg->check_efuse_version == CHECK_EFUSE_V1) {
395 val = (s32)(data & dc_driving_mask) + driving_level_compensate
396 + phy_parameter->efuse_usb_dc_cal;
397 } else { /* for CHECK_EFUSE_V2 or no efuse */
398 if (phy_parameter->efuse_usb_dc_cal)
399 val = (s32)((phy_parameter->efuse_usb_dc_cal & dc_driving_mask)
400 + driving_level_compensate);
402 val = (s32)(data & dc_driving_mask);
405 if (val > dc_driving_mask)
406 val = dc_driving_mask;
410 ret = (data & (~dc_driving_mask)) | (val & dc_driving_mask);
415 static void update_dc_driving_level(struct rtk_phy *rtk_phy,
416 struct phy_parameter *phy_parameter)
418 struct phy_cfg *phy_cfg;
419 struct phy_reg *phy_reg;
421 phy_reg = &phy_parameter->phy_reg;
422 phy_cfg = rtk_phy->phy_cfg;
423 if (!phy_cfg->page0[4].addr) {
424 rtk_phy_set_page(phy_reg, 0);
425 phy_cfg->page0[4].addr = PAGE0_0XE4;
426 phy_cfg->page0[4].data = rtk_phy_read(phy_reg, PAGE0_0XE4);
429 if (phy_parameter->driving_level != DEFAULT_DC_DRIVING_VALUE) {
434 data = phy_cfg->page0[4].data;
435 dc_driving_mask = phy_cfg->dc_driving_mask;
436 driving_level = data & dc_driving_mask;
438 dev_dbg(rtk_phy->dev, "%s driving_level=%d => dts driving_level=%d\n",
439 __func__, driving_level, phy_parameter->driving_level);
441 phy_cfg->page0[4].data = (data & (~dc_driving_mask)) |
442 (phy_parameter->driving_level & dc_driving_mask);
445 phy_cfg->page0[4].data = __update_dc_driving_page0_0xe4(phy_cfg,
447 phy_cfg->page0[4].data);
450 static void update_hs_clk_select(struct rtk_phy *rtk_phy,
451 struct phy_parameter *phy_parameter)
453 struct phy_cfg *phy_cfg;
454 struct phy_reg *phy_reg;
456 phy_cfg = rtk_phy->phy_cfg;
457 phy_reg = &phy_parameter->phy_reg;
459 if (phy_parameter->inverse_hstx_sync_clock) {
460 if (!phy_cfg->page0[6].addr) {
461 rtk_phy_set_page(phy_reg, 0);
462 phy_cfg->page0[6].addr = PAGE0_0XE6;
463 phy_cfg->page0[6].data = rtk_phy_read(phy_reg, PAGE0_0XE6);
466 phy_cfg->page0[6].data = phy_cfg->page0[6].data | HS_CLK_SELECT;
470 static void do_rtk_phy_toggle(struct rtk_phy *rtk_phy,
471 int index, bool connect)
473 struct phy_parameter *phy_parameter;
474 struct phy_cfg *phy_cfg;
475 struct phy_reg *phy_reg;
476 struct phy_data *phy_data_page;
480 phy_cfg = rtk_phy->phy_cfg;
481 phy_parameter = &((struct phy_parameter *)rtk_phy->phy_parameter)[index];
482 phy_reg = &phy_parameter->phy_reg;
484 if (!phy_cfg->do_toggle)
487 if (phy_cfg->is_double_sensitivity_mode)
488 goto do_toggle_driving;
491 rtk_phy_set_page(phy_reg, 0);
494 data = rtk_phy_read(phy_reg, addr);
497 rtk_phy_write(phy_reg, addr, data & (~SENSITIVITY_CTRL));
499 rtk_phy_write(phy_reg, addr, data | (SENSITIVITY_CTRL));
503 if (!phy_cfg->do_toggle_driving)
506 /* Page 0 addr 0xE4 driving capability */
509 phy_data_page = phy_cfg->page0;
510 rtk_phy_set_page(phy_reg, 0);
512 i = page_addr_to_array_index(PAGE0_0XE4);
513 addr = phy_data_page[i].addr;
514 data = phy_data_page[i].data;
517 rtk_phy_write(phy_reg, addr, data);
521 s32 driving_updated =
522 phy_cfg->driving_updated_for_dev_dis;
523 s32 dc_driving_mask = phy_cfg->dc_driving_mask;
525 tmp = (s32)(data & dc_driving_mask) + driving_updated;
527 if (tmp > dc_driving_mask)
528 tmp = dc_driving_mask;
532 value = (data & (~dc_driving_mask)) | (tmp & dc_driving_mask);
534 rtk_phy_write(phy_reg, addr, value);
538 /* restore dc disconnect level before toggle */
539 update_dc_disconnect_level(rtk_phy, phy_parameter, false);
542 rtk_phy_set_page(phy_reg, 1);
545 data = rtk_phy_read(phy_reg, addr);
547 rtk_phy_write(phy_reg, addr, data &
548 (~ENABLE_AUTO_SENSITIVITY_CALIBRATION));
550 rtk_phy_write(phy_reg, addr, data |
551 (ENABLE_AUTO_SENSITIVITY_CALIBRATION));
553 /* update dc disconnect level after toggle */
554 update_dc_disconnect_level(rtk_phy, phy_parameter, true);
560 static int do_rtk_phy_init(struct rtk_phy *rtk_phy, int index)
562 struct phy_parameter *phy_parameter;
563 struct phy_cfg *phy_cfg;
564 struct phy_data *phy_data_page;
565 struct phy_reg *phy_reg;
568 phy_cfg = rtk_phy->phy_cfg;
569 phy_parameter = &((struct phy_parameter *)rtk_phy->phy_parameter)[index];
570 phy_reg = &phy_parameter->phy_reg;
572 if (phy_cfg->use_default_parameter) {
573 dev_dbg(rtk_phy->dev, "%s phy#%d use default parameter\n",
579 phy_data_page = phy_cfg->page0;
580 rtk_phy_set_page(phy_reg, 0);
582 for (i = 0; i < phy_cfg->page0_size; i++) {
583 struct phy_data *phy_data = phy_data_page + i;
584 u8 addr = phy_data->addr;
585 u8 data = phy_data->data;
590 if (rtk_phy_write(phy_reg, addr, data)) {
591 dev_err(rtk_phy->dev,
592 "%s: Error to set page0 parameter addr=0x%x value=0x%x\n",
593 __func__, addr, data);
599 phy_data_page = phy_cfg->page1;
600 rtk_phy_set_page(phy_reg, 1);
602 for (i = 0; i < phy_cfg->page1_size; i++) {
603 struct phy_data *phy_data = phy_data_page + i;
604 u8 addr = phy_data->addr;
605 u8 data = phy_data->data;
610 if (rtk_phy_write(phy_reg, addr, data)) {
611 dev_err(rtk_phy->dev,
612 "%s: Error to set page1 parameter addr=0x%x value=0x%x\n",
613 __func__, addr, data);
618 if (phy_cfg->page2_size == 0)
622 phy_data_page = phy_cfg->page2;
623 rtk_phy_set_page(phy_reg, 2);
625 for (i = 0; i < phy_cfg->page2_size; i++) {
626 struct phy_data *phy_data = phy_data_page + i;
627 u8 addr = phy_data->addr;
628 u8 data = phy_data->data;
633 if (rtk_phy_write(phy_reg, addr, data)) {
634 dev_err(rtk_phy->dev,
635 "%s: Error to set page2 parameter addr=0x%x value=0x%x\n",
636 __func__, addr, data);
642 do_rtk_phy_toggle(rtk_phy, index, false);
647 static int rtk_phy_init(struct phy *phy)
649 struct rtk_phy *rtk_phy = phy_get_drvdata(phy);
650 unsigned long phy_init_time = jiffies;
656 for (i = 0; i < rtk_phy->num_phy; i++)
657 ret = do_rtk_phy_init(rtk_phy, i);
659 dev_dbg(rtk_phy->dev, "Initialized RTK USB 2.0 PHY (take %dms)\n",
660 jiffies_to_msecs(jiffies - phy_init_time));
664 static int rtk_phy_exit(struct phy *phy)
669 static void rtk_phy_toggle(struct rtk_phy *rtk_phy, bool connect, int port)
673 if (index > rtk_phy->num_phy) {
674 dev_err(rtk_phy->dev, "%s: The port=%d is not in usb phy (num_phy=%d)\n",
675 __func__, index, rtk_phy->num_phy);
679 do_rtk_phy_toggle(rtk_phy, index, connect);
682 static int rtk_phy_connect(struct phy *phy, int port)
684 struct rtk_phy *rtk_phy = phy_get_drvdata(phy);
686 dev_dbg(rtk_phy->dev, "%s port=%d\n", __func__, port);
687 rtk_phy_toggle(rtk_phy, true, port);
692 static int rtk_phy_disconnect(struct phy *phy, int port)
694 struct rtk_phy *rtk_phy = phy_get_drvdata(phy);
696 dev_dbg(rtk_phy->dev, "%s port=%d\n", __func__, port);
697 rtk_phy_toggle(rtk_phy, false, port);
702 static const struct phy_ops ops = {
703 .init = rtk_phy_init,
704 .exit = rtk_phy_exit,
705 .connect = rtk_phy_connect,
706 .disconnect = rtk_phy_disconnect,
707 .owner = THIS_MODULE,
710 #ifdef CONFIG_DEBUG_FS
711 static struct dentry *create_phy_debug_root(void)
713 struct dentry *phy_debug_root;
715 phy_debug_root = debugfs_lookup("phy", usb_debug_root);
717 phy_debug_root = debugfs_create_dir("phy", usb_debug_root);
719 return phy_debug_root;
722 static int rtk_usb2_parameter_show(struct seq_file *s, void *unused)
724 struct rtk_phy *rtk_phy = s->private;
725 struct phy_cfg *phy_cfg;
728 phy_cfg = rtk_phy->phy_cfg;
730 seq_puts(s, "Property:\n");
731 seq_printf(s, " check_efuse: %s\n",
732 phy_cfg->check_efuse ? "Enable" : "Disable");
733 seq_printf(s, " check_efuse_version: %d\n",
734 phy_cfg->check_efuse_version);
735 seq_printf(s, " efuse_dc_driving_rate: %d\n",
736 phy_cfg->efuse_dc_driving_rate);
737 seq_printf(s, " dc_driving_mask: 0x%x\n",
738 phy_cfg->dc_driving_mask);
739 seq_printf(s, " efuse_dc_disconnect_rate: %d\n",
740 phy_cfg->efuse_dc_disconnect_rate);
741 seq_printf(s, " dc_disconnect_mask: 0x%x\n",
742 phy_cfg->dc_disconnect_mask);
743 seq_printf(s, " usb_dc_disconnect_at_page0: %s\n",
744 phy_cfg->usb_dc_disconnect_at_page0 ? "true" : "false");
745 seq_printf(s, " do_toggle: %s\n",
746 phy_cfg->do_toggle ? "Enable" : "Disable");
747 seq_printf(s, " do_toggle_driving: %s\n",
748 phy_cfg->do_toggle_driving ? "Enable" : "Disable");
749 seq_printf(s, " driving_updated_for_dev_dis: 0x%x\n",
750 phy_cfg->driving_updated_for_dev_dis);
751 seq_printf(s, " use_default_parameter: %s\n",
752 phy_cfg->use_default_parameter ? "Enable" : "Disable");
753 seq_printf(s, " is_double_sensitivity_mode: %s\n",
754 phy_cfg->is_double_sensitivity_mode ? "Enable" : "Disable");
756 for (index = 0; index < rtk_phy->num_phy; index++) {
757 struct phy_parameter *phy_parameter;
758 struct phy_reg *phy_reg;
759 struct phy_data *phy_data_page;
761 phy_parameter = &((struct phy_parameter *)rtk_phy->phy_parameter)[index];
762 phy_reg = &phy_parameter->phy_reg;
764 seq_printf(s, "PHY %d:\n", index);
766 seq_puts(s, "Page 0:\n");
768 phy_data_page = phy_cfg->page0;
769 rtk_phy_set_page(phy_reg, 0);
771 for (i = 0; i < phy_cfg->page0_size; i++) {
772 struct phy_data *phy_data = phy_data_page + i;
773 u8 addr = array_index_to_page_addr(i);
774 u8 data = phy_data->data;
775 u8 value = rtk_phy_read(phy_reg, addr);
778 seq_printf(s, " Page 0: addr=0x%x data=0x%02x ==> read value=0x%02x\n",
781 seq_printf(s, " Page 0: addr=0x%x data=none ==> read value=0x%02x\n",
785 seq_puts(s, "Page 1:\n");
787 phy_data_page = phy_cfg->page1;
788 rtk_phy_set_page(phy_reg, 1);
790 for (i = 0; i < phy_cfg->page1_size; i++) {
791 struct phy_data *phy_data = phy_data_page + i;
792 u8 addr = array_index_to_page_addr(i);
793 u8 data = phy_data->data;
794 u8 value = rtk_phy_read(phy_reg, addr);
797 seq_printf(s, " Page 1: addr=0x%x data=0x%02x ==> read value=0x%02x\n",
800 seq_printf(s, " Page 1: addr=0x%x data=none ==> read value=0x%02x\n",
804 if (phy_cfg->page2_size == 0)
807 seq_puts(s, "Page 2:\n");
809 phy_data_page = phy_cfg->page2;
810 rtk_phy_set_page(phy_reg, 2);
812 for (i = 0; i < phy_cfg->page2_size; i++) {
813 struct phy_data *phy_data = phy_data_page + i;
814 u8 addr = array_index_to_page_addr(i);
815 u8 data = phy_data->data;
816 u8 value = rtk_phy_read(phy_reg, addr);
819 seq_printf(s, " Page 2: addr=0x%x data=0x%02x ==> read value=0x%02x\n",
822 seq_printf(s, " Page 2: addr=0x%x data=none ==> read value=0x%02x\n",
827 seq_puts(s, "PHY Property:\n");
828 seq_printf(s, " efuse_usb_dc_cal: %d\n",
829 (int)phy_parameter->efuse_usb_dc_cal);
830 seq_printf(s, " efuse_usb_dc_dis: %d\n",
831 (int)phy_parameter->efuse_usb_dc_dis);
832 seq_printf(s, " inverse_hstx_sync_clock: %s\n",
833 phy_parameter->inverse_hstx_sync_clock ? "Enable" : "Disable");
834 seq_printf(s, " driving_level: %d\n",
835 phy_parameter->driving_level);
836 seq_printf(s, " driving_level_compensate: %d\n",
837 phy_parameter->driving_level_compensate);
838 seq_printf(s, " disconnection_compensate: %d\n",
839 phy_parameter->disconnection_compensate);
844 DEFINE_SHOW_ATTRIBUTE(rtk_usb2_parameter);
846 static inline void create_debug_files(struct rtk_phy *rtk_phy)
848 struct dentry *phy_debug_root = NULL;
850 phy_debug_root = create_phy_debug_root();
854 rtk_phy->debug_dir = debugfs_create_dir(dev_name(rtk_phy->dev),
857 debugfs_create_file("parameter", 0444, rtk_phy->debug_dir, rtk_phy,
858 &rtk_usb2_parameter_fops);
861 static inline void remove_debug_files(struct rtk_phy *rtk_phy)
863 debugfs_remove_recursive(rtk_phy->debug_dir);
866 static inline void create_debug_files(struct rtk_phy *rtk_phy) { }
867 static inline void remove_debug_files(struct rtk_phy *rtk_phy) { }
868 #endif /* CONFIG_DEBUG_FS */
870 static int get_phy_data_by_efuse(struct rtk_phy *rtk_phy,
871 struct phy_parameter *phy_parameter, int index)
873 struct phy_cfg *phy_cfg = rtk_phy->phy_cfg;
875 struct nvmem_cell *cell;
876 struct soc_device_attribute rtk_soc_groot[] = {
877 { .family = "Realtek Groot",},
880 if (!phy_cfg->check_efuse)
883 /* Read efuse for usb dc cal */
884 cell = nvmem_cell_get(rtk_phy->dev, "usb-dc-cal");
886 dev_dbg(rtk_phy->dev, "%s no usb-dc-cal: %ld\n",
887 __func__, PTR_ERR(cell));
892 buf = nvmem_cell_read(cell, &buf_size);
894 value = buf[0] & phy_cfg->dc_driving_mask;
897 nvmem_cell_put(cell);
900 if (phy_cfg->check_efuse_version == CHECK_EFUSE_V1) {
901 int rate = phy_cfg->efuse_dc_driving_rate;
903 if (value <= EFUS_USB_DC_CAL_MAX)
904 phy_parameter->efuse_usb_dc_cal = (int8_t)(value * rate);
906 phy_parameter->efuse_usb_dc_cal = -(int8_t)
907 ((EFUS_USB_DC_CAL_MAX & value) * rate);
909 if (soc_device_match(rtk_soc_groot)) {
910 dev_dbg(rtk_phy->dev, "For groot IC we need a workaround to adjust efuse_usb_dc_cal\n");
912 /* We don't multiple dc_cal_rate=2 for positive dc cal compensate */
913 if (value <= EFUS_USB_DC_CAL_MAX)
914 phy_parameter->efuse_usb_dc_cal = (int8_t)(value);
916 /* We set max dc cal compensate is 0x8 if otp is 0x7 */
918 phy_parameter->efuse_usb_dc_cal = (int8_t)(value + 1);
920 } else { /* for CHECK_EFUSE_V2 */
921 phy_parameter->efuse_usb_dc_cal = value & phy_cfg->dc_driving_mask;
924 /* Read efuse for usb dc disconnect level */
926 cell = nvmem_cell_get(rtk_phy->dev, "usb-dc-dis");
928 dev_dbg(rtk_phy->dev, "%s no usb-dc-dis: %ld\n",
929 __func__, PTR_ERR(cell));
934 buf = nvmem_cell_read(cell, &buf_size);
936 value = buf[0] & phy_cfg->dc_disconnect_mask;
939 nvmem_cell_put(cell);
942 if (phy_cfg->check_efuse_version == CHECK_EFUSE_V1) {
943 int rate = phy_cfg->efuse_dc_disconnect_rate;
945 if (value <= EFUS_USB_DC_DIS_MAX)
946 phy_parameter->efuse_usb_dc_dis = (int8_t)(value * rate);
948 phy_parameter->efuse_usb_dc_dis = -(int8_t)
949 ((EFUS_USB_DC_DIS_MAX & value) * rate);
950 } else { /* for CHECK_EFUSE_V2 */
951 phy_parameter->efuse_usb_dc_dis = value & phy_cfg->dc_disconnect_mask;
958 static int parse_phy_data(struct rtk_phy *rtk_phy)
960 struct device *dev = rtk_phy->dev;
961 struct device_node *np = dev->of_node;
962 struct phy_parameter *phy_parameter;
966 rtk_phy->phy_parameter = devm_kzalloc(dev, sizeof(struct phy_parameter) *
967 rtk_phy->num_phy, GFP_KERNEL);
968 if (!rtk_phy->phy_parameter)
971 for (index = 0; index < rtk_phy->num_phy; index++) {
972 phy_parameter = &((struct phy_parameter *)rtk_phy->phy_parameter)[index];
974 phy_parameter->phy_reg.reg_wrap_vstatus = of_iomap(np, 0);
975 phy_parameter->phy_reg.reg_gusb2phyacc0 = of_iomap(np, 1) + index;
976 phy_parameter->phy_reg.vstatus_index = index;
978 if (of_property_read_bool(np, "realtek,inverse-hstx-sync-clock"))
979 phy_parameter->inverse_hstx_sync_clock = true;
981 phy_parameter->inverse_hstx_sync_clock = false;
983 if (of_property_read_u32_index(np, "realtek,driving-level",
984 index, &phy_parameter->driving_level))
985 phy_parameter->driving_level = DEFAULT_DC_DRIVING_VALUE;
987 if (of_property_read_u32_index(np, "realtek,driving-level-compensate",
988 index, &phy_parameter->driving_level_compensate))
989 phy_parameter->driving_level_compensate = 0;
991 if (of_property_read_u32_index(np, "realtek,disconnection-compensate",
992 index, &phy_parameter->disconnection_compensate))
993 phy_parameter->disconnection_compensate = 0;
995 get_phy_data_by_efuse(rtk_phy, phy_parameter, index);
997 update_dc_driving_level(rtk_phy, phy_parameter);
999 update_hs_clk_select(rtk_phy, phy_parameter);
1005 static int rtk_usb2phy_probe(struct platform_device *pdev)
1007 struct rtk_phy *rtk_phy;
1008 struct device *dev = &pdev->dev;
1009 struct phy *generic_phy;
1010 struct phy_provider *phy_provider;
1011 const struct phy_cfg *phy_cfg;
1014 phy_cfg = of_device_get_match_data(dev);
1016 dev_err(dev, "phy config are not assigned!\n");
1020 rtk_phy = devm_kzalloc(dev, sizeof(*rtk_phy), GFP_KERNEL);
1024 rtk_phy->dev = &pdev->dev;
1025 rtk_phy->phy_cfg = devm_kzalloc(dev, sizeof(*phy_cfg), GFP_KERNEL);
1027 memcpy(rtk_phy->phy_cfg, phy_cfg, sizeof(*phy_cfg));
1029 rtk_phy->num_phy = phy_cfg->num_phy;
1031 ret = parse_phy_data(rtk_phy);
1035 platform_set_drvdata(pdev, rtk_phy);
1037 generic_phy = devm_phy_create(rtk_phy->dev, NULL, &ops);
1038 if (IS_ERR(generic_phy))
1039 return PTR_ERR(generic_phy);
1041 phy_set_drvdata(generic_phy, rtk_phy);
1043 phy_provider = devm_of_phy_provider_register(rtk_phy->dev,
1044 of_phy_simple_xlate);
1045 if (IS_ERR(phy_provider))
1046 return PTR_ERR(phy_provider);
1048 create_debug_files(rtk_phy);
1054 static void rtk_usb2phy_remove(struct platform_device *pdev)
1056 struct rtk_phy *rtk_phy = platform_get_drvdata(pdev);
1058 remove_debug_files(rtk_phy);
1061 static const struct phy_cfg rtd1295_phy_cfg = {
1062 .page0_size = MAX_USB_PHY_PAGE0_DATA_SIZE,
1063 .page0 = { [0] = {0xe0, 0x90},
1067 [13] = {0xf5, 0x81},
1068 [15] = {0xf7, 0x02}, },
1070 .page1 = { /* default parameter */ },
1072 .page2 = { /* no parameter */ },
1074 .check_efuse = false,
1075 .check_efuse_version = CHECK_EFUSE_V1,
1076 .efuse_dc_driving_rate = 1,
1077 .dc_driving_mask = 0xf,
1078 .efuse_dc_disconnect_rate = EFUS_USB_DC_DIS_RATE,
1079 .dc_disconnect_mask = 0xf,
1080 .usb_dc_disconnect_at_page0 = true,
1082 .do_toggle_driving = false,
1083 .driving_updated_for_dev_dis = 0xf,
1084 .use_default_parameter = false,
1085 .is_double_sensitivity_mode = false,
1088 static const struct phy_cfg rtd1395_phy_cfg = {
1089 .page0_size = MAX_USB_PHY_PAGE0_DATA_SIZE,
1090 .page0 = { [4] = {0xe4, 0xac},
1091 [13] = {0xf5, 0x00},
1092 [15] = {0xf7, 0x02}, },
1094 .page1 = { /* default parameter */ },
1096 .page2 = { /* no parameter */ },
1098 .check_efuse = false,
1099 .check_efuse_version = CHECK_EFUSE_V1,
1100 .efuse_dc_driving_rate = 1,
1101 .dc_driving_mask = 0xf,
1102 .efuse_dc_disconnect_rate = EFUS_USB_DC_DIS_RATE,
1103 .dc_disconnect_mask = 0xf,
1104 .usb_dc_disconnect_at_page0 = true,
1106 .do_toggle_driving = false,
1107 .driving_updated_for_dev_dis = 0xf,
1108 .use_default_parameter = false,
1109 .is_double_sensitivity_mode = false,
1112 static const struct phy_cfg rtd1395_phy_cfg_2port = {
1113 .page0_size = MAX_USB_PHY_PAGE0_DATA_SIZE,
1114 .page0 = { [4] = {0xe4, 0xac},
1115 [13] = {0xf5, 0x00},
1116 [15] = {0xf7, 0x02}, },
1118 .page1 = { /* default parameter */ },
1120 .page2 = { /* no parameter */ },
1122 .check_efuse = false,
1123 .check_efuse_version = CHECK_EFUSE_V1,
1124 .efuse_dc_driving_rate = 1,
1125 .dc_driving_mask = 0xf,
1126 .efuse_dc_disconnect_rate = EFUS_USB_DC_DIS_RATE,
1127 .dc_disconnect_mask = 0xf,
1128 .usb_dc_disconnect_at_page0 = true,
1130 .do_toggle_driving = false,
1131 .driving_updated_for_dev_dis = 0xf,
1132 .use_default_parameter = false,
1133 .is_double_sensitivity_mode = false,
1136 static const struct phy_cfg rtd1619_phy_cfg = {
1137 .page0_size = MAX_USB_PHY_PAGE0_DATA_SIZE,
1138 .page0 = { [4] = {0xe4, 0x68}, },
1140 .page1 = { /* default parameter */ },
1142 .page2 = { /* no parameter */ },
1144 .check_efuse = true,
1145 .check_efuse_version = CHECK_EFUSE_V1,
1146 .efuse_dc_driving_rate = 1,
1147 .dc_driving_mask = 0xf,
1148 .efuse_dc_disconnect_rate = EFUS_USB_DC_DIS_RATE,
1149 .dc_disconnect_mask = 0xf,
1150 .usb_dc_disconnect_at_page0 = true,
1152 .do_toggle_driving = false,
1153 .driving_updated_for_dev_dis = 0xf,
1154 .use_default_parameter = false,
1155 .is_double_sensitivity_mode = false,
1158 static const struct phy_cfg rtd1319_phy_cfg = {
1159 .page0_size = MAX_USB_PHY_PAGE0_DATA_SIZE,
1160 .page0 = { [0] = {0xe0, 0x18},
1163 [13] = {0xf5, 0x15},
1164 [15] = {0xf7, 0x32}, },
1166 .page1 = { [3] = {0xe3, 0x44}, },
1167 .page2_size = MAX_USB_PHY_PAGE2_DATA_SIZE,
1168 .page2 = { [0] = {0xe0, 0x01}, },
1170 .check_efuse = true,
1171 .check_efuse_version = CHECK_EFUSE_V1,
1172 .efuse_dc_driving_rate = 1,
1173 .dc_driving_mask = 0xf,
1174 .efuse_dc_disconnect_rate = EFUS_USB_DC_DIS_RATE,
1175 .dc_disconnect_mask = 0xf,
1176 .usb_dc_disconnect_at_page0 = true,
1178 .do_toggle_driving = true,
1179 .driving_updated_for_dev_dis = 0xf,
1180 .use_default_parameter = false,
1181 .is_double_sensitivity_mode = true,
1184 static const struct phy_cfg rtd1312c_phy_cfg = {
1185 .page0_size = MAX_USB_PHY_PAGE0_DATA_SIZE,
1186 .page0 = { [0] = {0xe0, 0x14},
1188 [5] = {0xe5, 0x55}, },
1190 .page1 = { [3] = {0xe3, 0x23},
1191 [6] = {0xe6, 0x58}, },
1192 .page2_size = MAX_USB_PHY_PAGE2_DATA_SIZE,
1193 .page2 = { /* default parameter */ },
1195 .check_efuse = true,
1196 .check_efuse_version = CHECK_EFUSE_V1,
1197 .efuse_dc_driving_rate = 1,
1198 .dc_driving_mask = 0xf,
1199 .efuse_dc_disconnect_rate = EFUS_USB_DC_DIS_RATE,
1200 .dc_disconnect_mask = 0xf,
1201 .usb_dc_disconnect_at_page0 = true,
1203 .do_toggle_driving = true,
1204 .driving_updated_for_dev_dis = 0xf,
1205 .use_default_parameter = false,
1206 .is_double_sensitivity_mode = true,
1209 static const struct phy_cfg rtd1619b_phy_cfg = {
1210 .page0_size = MAX_USB_PHY_PAGE0_DATA_SIZE,
1211 .page0 = { [0] = {0xe0, 0xa3},
1214 [6] = {0xe6, 0x02}, },
1216 .page1 = { [3] = {0xe3, 0x64}, },
1217 .page2_size = MAX_USB_PHY_PAGE2_DATA_SIZE,
1218 .page2 = { [7] = {0xe7, 0x45}, },
1220 .check_efuse = true,
1221 .check_efuse_version = CHECK_EFUSE_V1,
1222 .efuse_dc_driving_rate = EFUS_USB_DC_CAL_RATE,
1223 .dc_driving_mask = 0x1f,
1224 .efuse_dc_disconnect_rate = EFUS_USB_DC_DIS_RATE,
1225 .dc_disconnect_mask = 0xf,
1226 .usb_dc_disconnect_at_page0 = false,
1228 .do_toggle_driving = true,
1229 .driving_updated_for_dev_dis = 0x8,
1230 .use_default_parameter = false,
1231 .is_double_sensitivity_mode = true,
1234 static const struct phy_cfg rtd1319d_phy_cfg = {
1235 .page0_size = MAX_USB_PHY_PAGE0_DATA_SIZE,
1236 .page0 = { [0] = {0xe0, 0xa3},
1239 [6] = {0xe6, 0x02}, },
1240 .page1_size = MAX_USB_PHY_PAGE1_DATA_SIZE,
1241 .page1 = { [14] = {0xf5, 0x1}, },
1242 .page2_size = MAX_USB_PHY_PAGE2_DATA_SIZE,
1243 .page2 = { [7] = {0xe7, 0x44}, },
1244 .check_efuse = true,
1246 .check_efuse_version = CHECK_EFUSE_V1,
1247 .efuse_dc_driving_rate = EFUS_USB_DC_CAL_RATE,
1248 .dc_driving_mask = 0x1f,
1249 .efuse_dc_disconnect_rate = EFUS_USB_DC_DIS_RATE,
1250 .dc_disconnect_mask = 0xf,
1251 .usb_dc_disconnect_at_page0 = false,
1253 .do_toggle_driving = false,
1254 .driving_updated_for_dev_dis = 0x8,
1255 .use_default_parameter = false,
1256 .is_double_sensitivity_mode = true,
1259 static const struct phy_cfg rtd1315e_phy_cfg = {
1260 .page0_size = MAX_USB_PHY_PAGE0_DATA_SIZE,
1261 .page0 = { [0] = {0xe0, 0xa3},
1264 [6] = {0xe6, 0x02}, },
1265 .page1_size = MAX_USB_PHY_PAGE1_DATA_SIZE,
1266 .page1 = { [3] = {0xe3, 0x7f},
1267 [14] = {0xf5, 0x01}, },
1268 .page2_size = MAX_USB_PHY_PAGE2_DATA_SIZE,
1269 .page2 = { [7] = {0xe7, 0x44}, },
1271 .check_efuse = true,
1272 .check_efuse_version = CHECK_EFUSE_V2,
1273 .efuse_dc_driving_rate = EFUS_USB_DC_CAL_RATE,
1274 .dc_driving_mask = 0x1f,
1275 .efuse_dc_disconnect_rate = EFUS_USB_DC_DIS_RATE,
1276 .dc_disconnect_mask = 0xf,
1277 .usb_dc_disconnect_at_page0 = false,
1279 .do_toggle_driving = false,
1280 .driving_updated_for_dev_dis = 0x8,
1281 .use_default_parameter = false,
1282 .is_double_sensitivity_mode = true,
1285 static const struct of_device_id usbphy_rtk_dt_match[] = {
1286 { .compatible = "realtek,rtd1295-usb2phy", .data = &rtd1295_phy_cfg },
1287 { .compatible = "realtek,rtd1312c-usb2phy", .data = &rtd1312c_phy_cfg },
1288 { .compatible = "realtek,rtd1315e-usb2phy", .data = &rtd1315e_phy_cfg },
1289 { .compatible = "realtek,rtd1319-usb2phy", .data = &rtd1319_phy_cfg },
1290 { .compatible = "realtek,rtd1319d-usb2phy", .data = &rtd1319d_phy_cfg },
1291 { .compatible = "realtek,rtd1395-usb2phy", .data = &rtd1395_phy_cfg },
1292 { .compatible = "realtek,rtd1395-usb2phy-2port", .data = &rtd1395_phy_cfg_2port },
1293 { .compatible = "realtek,rtd1619-usb2phy", .data = &rtd1619_phy_cfg },
1294 { .compatible = "realtek,rtd1619b-usb2phy", .data = &rtd1619b_phy_cfg },
1297 MODULE_DEVICE_TABLE(of, usbphy_rtk_dt_match);
1299 static struct platform_driver rtk_usb2phy_driver = {
1300 .probe = rtk_usb2phy_probe,
1301 .remove_new = rtk_usb2phy_remove,
1303 .name = "rtk-usb2phy",
1304 .of_match_table = usbphy_rtk_dt_match,
1308 module_platform_driver(rtk_usb2phy_driver);
1310 MODULE_LICENSE("GPL");
1311 MODULE_AUTHOR("Stanley Chang <stanley_chang@realtek.com>");
1312 MODULE_DESCRIPTION("Realtek usb 2.0 phy driver");