xref: /openbmc/linux/drivers/net/usb/r8153_ecm.c (revision f8bade6c9a6213c2c5ba6e5bf32415ecab6e41e5)
1c1aedf01SHayes Wang // SPDX-License-Identifier: GPL-2.0-or-later
2c1aedf01SHayes Wang #include <linux/module.h>
3c1aedf01SHayes Wang #include <linux/netdevice.h>
4c1aedf01SHayes Wang #include <linux/mii.h>
5c1aedf01SHayes Wang #include <linux/usb.h>
6c1aedf01SHayes Wang #include <linux/usb/cdc.h>
7c1aedf01SHayes Wang #include <linux/usb/usbnet.h>
8c1aedf01SHayes Wang #include <linux/usb/r8152.h>
9c1aedf01SHayes Wang 
10c1aedf01SHayes Wang #define OCP_BASE		0xe86c
11c1aedf01SHayes Wang 
pla_read_word(struct usbnet * dev,u16 index)12c1aedf01SHayes Wang static int pla_read_word(struct usbnet *dev, u16 index)
13c1aedf01SHayes Wang {
14c1aedf01SHayes Wang 	u16 byen = BYTE_EN_WORD;
15c1aedf01SHayes Wang 	u8 shift = index & 2;
16c1aedf01SHayes Wang 	__le32 tmp;
17c1aedf01SHayes Wang 	int ret;
18c1aedf01SHayes Wang 
19c1aedf01SHayes Wang 	if (shift)
20c1aedf01SHayes Wang 		byen <<= shift;
21c1aedf01SHayes Wang 
22c1aedf01SHayes Wang 	index &= ~3;
23c1aedf01SHayes Wang 
24c1aedf01SHayes Wang 	ret = usbnet_read_cmd(dev, RTL8152_REQ_GET_REGS, RTL8152_REQT_READ, index,
25c1aedf01SHayes Wang 			      MCU_TYPE_PLA | byen, &tmp, sizeof(tmp));
26c1aedf01SHayes Wang 	if (ret < 0)
27c1aedf01SHayes Wang 		goto out;
28c1aedf01SHayes Wang 
29c1aedf01SHayes Wang 	ret = __le32_to_cpu(tmp);
30c1aedf01SHayes Wang 	ret >>= (shift * 8);
31c1aedf01SHayes Wang 	ret &= 0xffff;
32c1aedf01SHayes Wang 
33c1aedf01SHayes Wang out:
34c1aedf01SHayes Wang 	return ret;
35c1aedf01SHayes Wang }
36c1aedf01SHayes Wang 
pla_write_word(struct usbnet * dev,u16 index,u32 data)37c1aedf01SHayes Wang static int pla_write_word(struct usbnet *dev, u16 index, u32 data)
38c1aedf01SHayes Wang {
39c1aedf01SHayes Wang 	u32 mask = 0xffff;
40c1aedf01SHayes Wang 	u16 byen = BYTE_EN_WORD;
41c1aedf01SHayes Wang 	u8 shift = index & 2;
42c1aedf01SHayes Wang 	__le32 tmp;
43c1aedf01SHayes Wang 	int ret;
44c1aedf01SHayes Wang 
45c1aedf01SHayes Wang 	data &= mask;
46c1aedf01SHayes Wang 
47c1aedf01SHayes Wang 	if (shift) {
48c1aedf01SHayes Wang 		byen <<= shift;
49c1aedf01SHayes Wang 		mask <<= (shift * 8);
50c1aedf01SHayes Wang 		data <<= (shift * 8);
51c1aedf01SHayes Wang 	}
52c1aedf01SHayes Wang 
53c1aedf01SHayes Wang 	index &= ~3;
54c1aedf01SHayes Wang 
55c1aedf01SHayes Wang 	ret = usbnet_read_cmd(dev, RTL8152_REQ_GET_REGS, RTL8152_REQT_READ, index,
56c1aedf01SHayes Wang 			      MCU_TYPE_PLA | byen, &tmp, sizeof(tmp));
57c1aedf01SHayes Wang 
58c1aedf01SHayes Wang 	if (ret < 0)
59c1aedf01SHayes Wang 		goto out;
60c1aedf01SHayes Wang 
61c1aedf01SHayes Wang 	data |= __le32_to_cpu(tmp) & ~mask;
62c1aedf01SHayes Wang 	tmp = __cpu_to_le32(data);
63c1aedf01SHayes Wang 
64c1aedf01SHayes Wang 	ret = usbnet_write_cmd(dev, RTL8152_REQ_SET_REGS, RTL8152_REQT_WRITE, index,
65c1aedf01SHayes Wang 			       MCU_TYPE_PLA | byen, &tmp, sizeof(tmp));
66c1aedf01SHayes Wang 
67c1aedf01SHayes Wang out:
68c1aedf01SHayes Wang 	return ret;
69c1aedf01SHayes Wang }
70c1aedf01SHayes Wang 
r8153_ecm_mdio_read(struct net_device * netdev,int phy_id,int reg)71c1aedf01SHayes Wang static int r8153_ecm_mdio_read(struct net_device *netdev, int phy_id, int reg)
72c1aedf01SHayes Wang {
73c1aedf01SHayes Wang 	struct usbnet *dev = netdev_priv(netdev);
74c1aedf01SHayes Wang 	int ret;
75c1aedf01SHayes Wang 
76c1aedf01SHayes Wang 	ret = pla_write_word(dev, OCP_BASE, 0xa000);
77c1aedf01SHayes Wang 	if (ret < 0)
78c1aedf01SHayes Wang 		goto out;
79c1aedf01SHayes Wang 
80c1aedf01SHayes Wang 	ret = pla_read_word(dev, 0xb400 + reg * 2);
81c1aedf01SHayes Wang 
82c1aedf01SHayes Wang out:
83c1aedf01SHayes Wang 	return ret;
84c1aedf01SHayes Wang }
85c1aedf01SHayes Wang 
r8153_ecm_mdio_write(struct net_device * netdev,int phy_id,int reg,int val)86c1aedf01SHayes Wang static void r8153_ecm_mdio_write(struct net_device *netdev, int phy_id, int reg, int val)
87c1aedf01SHayes Wang {
88c1aedf01SHayes Wang 	struct usbnet *dev = netdev_priv(netdev);
89c1aedf01SHayes Wang 	int ret;
90c1aedf01SHayes Wang 
91c1aedf01SHayes Wang 	ret = pla_write_word(dev, OCP_BASE, 0xa000);
92c1aedf01SHayes Wang 	if (ret < 0)
93c1aedf01SHayes Wang 		return;
94c1aedf01SHayes Wang 
95c1aedf01SHayes Wang 	ret = pla_write_word(dev, 0xb400 + reg * 2, val);
96c1aedf01SHayes Wang }
97c1aedf01SHayes Wang 
r8153_bind(struct usbnet * dev,struct usb_interface * intf)98c1aedf01SHayes Wang static int r8153_bind(struct usbnet *dev, struct usb_interface *intf)
99c1aedf01SHayes Wang {
100c1aedf01SHayes Wang 	int status;
101c1aedf01SHayes Wang 
102c1aedf01SHayes Wang 	status = usbnet_cdc_bind(dev, intf);
103c1aedf01SHayes Wang 	if (status < 0)
104c1aedf01SHayes Wang 		return status;
105c1aedf01SHayes Wang 
106c1aedf01SHayes Wang 	dev->mii.dev = dev->net;
107c1aedf01SHayes Wang 	dev->mii.mdio_read = r8153_ecm_mdio_read;
108c1aedf01SHayes Wang 	dev->mii.mdio_write = r8153_ecm_mdio_write;
109c1aedf01SHayes Wang 	dev->mii.reg_num_mask = 0x1f;
110c1aedf01SHayes Wang 	dev->mii.supports_gmii = 1;
111c1aedf01SHayes Wang 
112c1aedf01SHayes Wang 	return status;
113c1aedf01SHayes Wang }
114c1aedf01SHayes Wang 
115c1aedf01SHayes Wang static const struct driver_info r8153_info = {
116c1aedf01SHayes Wang 	.description =	"RTL8153 ECM Device",
117c1aedf01SHayes Wang 	.flags =	FLAG_ETHER,
118c1aedf01SHayes Wang 	.bind =		r8153_bind,
119c1aedf01SHayes Wang 	.unbind =	usbnet_cdc_unbind,
120c1aedf01SHayes Wang 	.status =	usbnet_cdc_status,
121c1aedf01SHayes Wang 	.manage_power =	usbnet_manage_power,
122c1aedf01SHayes Wang };
123c1aedf01SHayes Wang 
124c1aedf01SHayes Wang static const struct usb_device_id products[] = {
125*2284bbd0SLeon Schuermann /* Realtek RTL8153 Based USB 3.0 Ethernet Adapters */
126c1aedf01SHayes Wang {
127c1aedf01SHayes Wang 	USB_DEVICE_AND_INTERFACE_INFO(VENDOR_ID_REALTEK, 0x8153, USB_CLASS_COMM,
128c1aedf01SHayes Wang 				      USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
129c1aedf01SHayes Wang 	.driver_info = (unsigned long)&r8153_info,
130c1aedf01SHayes Wang },
131c1aedf01SHayes Wang 
132*2284bbd0SLeon Schuermann /* Lenovo Powered USB-C Travel Hub (4X90S92381, based on Realtek RTL8153) */
133*2284bbd0SLeon Schuermann {
134*2284bbd0SLeon Schuermann 	USB_DEVICE_AND_INTERFACE_INFO(VENDOR_ID_LENOVO, 0x721e, USB_CLASS_COMM,
135*2284bbd0SLeon Schuermann 				      USB_CDC_SUBCLASS_ETHERNET, USB_CDC_PROTO_NONE),
136*2284bbd0SLeon Schuermann 	.driver_info = (unsigned long)&r8153_info,
137*2284bbd0SLeon Schuermann },
138*2284bbd0SLeon Schuermann 
139c1aedf01SHayes Wang 	{ },		/* END */
140c1aedf01SHayes Wang };
141c1aedf01SHayes Wang MODULE_DEVICE_TABLE(usb, products);
142c1aedf01SHayes Wang 
rtl8153_ecm_probe(struct usb_interface * intf,const struct usb_device_id * id)143c1aedf01SHayes Wang static int rtl8153_ecm_probe(struct usb_interface *intf,
144c1aedf01SHayes Wang 			     const struct usb_device_id *id)
145c1aedf01SHayes Wang {
146c1aedf01SHayes Wang #if IS_REACHABLE(CONFIG_USB_RTL8152)
147c1aedf01SHayes Wang 	if (rtl8152_get_version(intf))
148c1aedf01SHayes Wang 		return -ENODEV;
149c1aedf01SHayes Wang #endif
150c1aedf01SHayes Wang 
151c1aedf01SHayes Wang 	return usbnet_probe(intf, id);
152c1aedf01SHayes Wang }
153c1aedf01SHayes Wang 
154c1aedf01SHayes Wang static struct usb_driver r8153_ecm_driver = {
155c1aedf01SHayes Wang 	.name =		"r8153_ecm",
156c1aedf01SHayes Wang 	.id_table =	products,
157c1aedf01SHayes Wang 	.probe =	rtl8153_ecm_probe,
158c1aedf01SHayes Wang 	.disconnect =	usbnet_disconnect,
159c1aedf01SHayes Wang 	.suspend =	usbnet_suspend,
160c1aedf01SHayes Wang 	.resume =	usbnet_resume,
161c1aedf01SHayes Wang 	.reset_resume =	usbnet_resume,
162c1aedf01SHayes Wang 	.supports_autosuspend = 1,
163c1aedf01SHayes Wang 	.disable_hub_initiated_lpm = 1,
164c1aedf01SHayes Wang };
165c1aedf01SHayes Wang 
166c1aedf01SHayes Wang module_usb_driver(r8153_ecm_driver);
167c1aedf01SHayes Wang 
168c1aedf01SHayes Wang MODULE_AUTHOR("Hayes Wang");
169c1aedf01SHayes Wang MODULE_DESCRIPTION("Realtek USB ECM device");
170c1aedf01SHayes Wang MODULE_LICENSE("GPL");
171