1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * ASIX AX88172A based USB 2.0 Ethernet Devices
4 * Copyright (C) 2012 OMICRON electronics GmbH
5 *
6 * Supports external PHYs via phylib. Based on the driver for the
7 * AX88772. Original copyrights follow:
8 *
9 * Copyright (C) 2003-2006 David Hollis <dhollis@davehollis.com>
10 * Copyright (C) 2005 Phil Chang <pchang23@sbcglobal.net>
11 * Copyright (C) 2006 James Painter <jamie.painter@iname.com>
12 * Copyright (c) 2002-2003 TiVo Inc.
13 */
14
15#include "asix.h"
16#include <linux/phy.h>
17
18struct ax88172a_private {
19	struct mii_bus *mdio;
20	struct phy_device *phydev;
21	char phy_name[20];
22	u16 phy_addr;
23	u16 oldmode;
24	int use_embdphy;
25	struct asix_rx_fixup_info rx_fixup_info;
26};
27
28/* MDIO read and write wrappers for phylib */
29static int asix_mdio_bus_read(struct mii_bus *bus, int phy_id, int regnum)
30{
31	return asix_mdio_read(((struct usbnet *)bus->priv)->net, phy_id,
32			      regnum);
33}
34
35static int asix_mdio_bus_write(struct mii_bus *bus, int phy_id, int regnum,
36			       u16 val)
37{
38	asix_mdio_write(((struct usbnet *)bus->priv)->net, phy_id, regnum, val);
39	return 0;
40}
41
42/* set MAC link settings according to information from phylib */
43static void ax88172a_adjust_link(struct net_device *netdev)
44{
45	struct phy_device *phydev = netdev->phydev;
46	struct usbnet *dev = netdev_priv(netdev);
47	struct ax88172a_private *priv = dev->driver_priv;
48	u16 mode = 0;
49
50	if (phydev->link) {
51		mode = AX88772_MEDIUM_DEFAULT;
52
53		if (phydev->duplex == DUPLEX_HALF)
54			mode &= ~AX_MEDIUM_FD;
55
56		if (phydev->speed != SPEED_100)
57			mode &= ~AX_MEDIUM_PS;
58	}
59
60	if (mode != priv->oldmode) {
61		asix_write_medium_mode(dev, mode, 0);
62		priv->oldmode = mode;
63		netdev_dbg(netdev, "speed %u duplex %d, setting mode to 0x%04x\n",
64			   phydev->speed, phydev->duplex, mode);
65		phy_print_status(phydev);
66	}
67}
68
69static void ax88172a_status(struct usbnet *dev, struct urb *urb)
70{
71	/* link changes are detected by polling the phy */
72}
73
74/* use phylib infrastructure */
75static int ax88172a_init_mdio(struct usbnet *dev)
76{
77	struct ax88172a_private *priv = dev->driver_priv;
78	int ret;
79
80	priv->mdio = mdiobus_alloc();
81	if (!priv->mdio) {
82		netdev_err(dev->net, "Could not allocate MDIO bus\n");
83		return -ENOMEM;
84	}
85
86	priv->mdio->priv = (void *)dev;
87	priv->mdio->read = &asix_mdio_bus_read;
88	priv->mdio->write = &asix_mdio_bus_write;
89	priv->mdio->name = "Asix MDIO Bus";
90	/* mii bus name is usb-<usb bus number>-<usb device number> */
91	snprintf(priv->mdio->id, MII_BUS_ID_SIZE, "usb-%03d:%03d",
92		 dev->udev->bus->busnum, dev->udev->devnum);
93
94	ret = mdiobus_register(priv->mdio);
95	if (ret) {
96		netdev_err(dev->net, "Could not register MDIO bus\n");
97		goto mfree;
98	}
99
100	netdev_info(dev->net, "registered mdio bus %s\n", priv->mdio->id);
101	return 0;
102
103mfree:
104	mdiobus_free(priv->mdio);
105	return ret;
106}
107
108static void ax88172a_remove_mdio(struct usbnet *dev)
109{
110	struct ax88172a_private *priv = dev->driver_priv;
111
112	netdev_info(dev->net, "deregistering mdio bus %s\n", priv->mdio->id);
113	mdiobus_unregister(priv->mdio);
114	mdiobus_free(priv->mdio);
115}
116
117static const struct net_device_ops ax88172a_netdev_ops = {
118	.ndo_open		= usbnet_open,
119	.ndo_stop		= usbnet_stop,
120	.ndo_start_xmit		= usbnet_start_xmit,
121	.ndo_tx_timeout		= usbnet_tx_timeout,
122	.ndo_change_mtu		= usbnet_change_mtu,
123	.ndo_get_stats64	= usbnet_get_stats64,
124	.ndo_set_mac_address	= asix_set_mac_address,
125	.ndo_validate_addr	= eth_validate_addr,
126	.ndo_do_ioctl		= phy_do_ioctl_running,
127	.ndo_set_rx_mode        = asix_set_multicast,
128};
129
130static const struct ethtool_ops ax88172a_ethtool_ops = {
131	.get_drvinfo		= asix_get_drvinfo,
132	.get_link		= usbnet_get_link,
133	.get_msglevel		= usbnet_get_msglevel,
134	.set_msglevel		= usbnet_set_msglevel,
135	.get_wol		= asix_get_wol,
136	.set_wol		= asix_set_wol,
137	.get_eeprom_len		= asix_get_eeprom_len,
138	.get_eeprom		= asix_get_eeprom,
139	.set_eeprom		= asix_set_eeprom,
140	.nway_reset		= phy_ethtool_nway_reset,
141	.get_link_ksettings	= phy_ethtool_get_link_ksettings,
142	.set_link_ksettings	= phy_ethtool_set_link_ksettings,
143};
144
145static int ax88172a_reset_phy(struct usbnet *dev, int embd_phy)
146{
147	int ret;
148
149	ret = asix_sw_reset(dev, AX_SWRESET_IPPD, 0);
150	if (ret < 0)
151		goto err;
152
153	msleep(150);
154	ret = asix_sw_reset(dev, AX_SWRESET_CLEAR, 0);
155	if (ret < 0)
156		goto err;
157
158	msleep(150);
159
160	ret = asix_sw_reset(dev, embd_phy ? AX_SWRESET_IPRL : AX_SWRESET_IPPD,
161			    0);
162	if (ret < 0)
163		goto err;
164
165	return 0;
166
167err:
168	return ret;
169}
170
171
172static int ax88172a_bind(struct usbnet *dev, struct usb_interface *intf)
173{
174	int ret;
175	u8 buf[ETH_ALEN];
176	struct ax88172a_private *priv;
177
178	ret = usbnet_get_endpoints(dev, intf);
179	if (ret)
180		return ret;
181
182	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
183	if (!priv)
184		return -ENOMEM;
185
186	dev->driver_priv = priv;
187
188	/* Get the MAC address */
189	ret = asix_read_cmd(dev, AX_CMD_READ_NODE_ID, 0, 0, ETH_ALEN, buf, 0);
190	if (ret < ETH_ALEN) {
191		netdev_err(dev->net, "Failed to read MAC address: %d\n", ret);
192		ret = -EIO;
193		goto free;
194	}
195	memcpy(dev->net->dev_addr, buf, ETH_ALEN);
196
197	dev->net->netdev_ops = &ax88172a_netdev_ops;
198	dev->net->ethtool_ops = &ax88172a_ethtool_ops;
199
200	/* are we using the internal or the external phy? */
201	ret = asix_read_cmd(dev, AX_CMD_SW_PHY_STATUS, 0, 0, 1, buf, 0);
202	if (ret < 0) {
203		netdev_err(dev->net, "Failed to read software interface selection register: %d\n",
204			   ret);
205		goto free;
206	}
207
208	netdev_dbg(dev->net, "AX_CMD_SW_PHY_STATUS = 0x%02x\n", buf[0]);
209	switch (buf[0] & AX_PHY_SELECT_MASK) {
210	case AX_PHY_SELECT_INTERNAL:
211		netdev_dbg(dev->net, "use internal phy\n");
212		priv->use_embdphy = 1;
213		break;
214	case AX_PHY_SELECT_EXTERNAL:
215		netdev_dbg(dev->net, "use external phy\n");
216		priv->use_embdphy = 0;
217		break;
218	default:
219		netdev_err(dev->net, "Interface mode not supported by driver\n");
220		ret = -ENOTSUPP;
221		goto free;
222	}
223
224	priv->phy_addr = asix_read_phy_addr(dev, priv->use_embdphy);
225	ax88172a_reset_phy(dev, priv->use_embdphy);
226
227	/* Asix framing packs multiple eth frames into a 2K usb bulk transfer */
228	if (dev->driver_info->flags & FLAG_FRAMING_AX) {
229		/* hard_mtu  is still the default - the device does not support
230		   jumbo eth frames */
231		dev->rx_urb_size = 2048;
232	}
233
234	/* init MDIO bus */
235	ret = ax88172a_init_mdio(dev);
236	if (ret)
237		goto free;
238
239	return 0;
240
241free:
242	kfree(priv);
243	return ret;
244}
245
246static int ax88172a_stop(struct usbnet *dev)
247{
248	struct ax88172a_private *priv = dev->driver_priv;
249
250	netdev_dbg(dev->net, "Stopping interface\n");
251
252	if (priv->phydev) {
253		netdev_info(dev->net, "Disconnecting from phy %s\n",
254			    priv->phy_name);
255		phy_stop(priv->phydev);
256		phy_disconnect(priv->phydev);
257	}
258
259	return 0;
260}
261
262static void ax88172a_unbind(struct usbnet *dev, struct usb_interface *intf)
263{
264	struct ax88172a_private *priv = dev->driver_priv;
265
266	ax88172a_remove_mdio(dev);
267	kfree(priv);
268}
269
270static int ax88172a_reset(struct usbnet *dev)
271{
272	struct asix_data *data = (struct asix_data *)&dev->data;
273	struct ax88172a_private *priv = dev->driver_priv;
274	int ret;
275	u16 rx_ctl;
276
277	ax88172a_reset_phy(dev, priv->use_embdphy);
278
279	msleep(150);
280	rx_ctl = asix_read_rx_ctl(dev, 0);
281	netdev_dbg(dev->net, "RX_CTL is 0x%04x after software reset\n", rx_ctl);
282	ret = asix_write_rx_ctl(dev, 0x0000, 0);
283	if (ret < 0)
284		goto out;
285
286	rx_ctl = asix_read_rx_ctl(dev, 0);
287	netdev_dbg(dev->net, "RX_CTL is 0x%04x setting to 0x0000\n", rx_ctl);
288
289	msleep(150);
290
291	ret = asix_write_cmd(dev, AX_CMD_WRITE_IPG0,
292			     AX88772_IPG0_DEFAULT | AX88772_IPG1_DEFAULT,
293			     AX88772_IPG2_DEFAULT, 0, NULL, 0);
294	if (ret < 0) {
295		netdev_err(dev->net, "Write IPG,IPG1,IPG2 failed: %d\n", ret);
296		goto out;
297	}
298
299	/* Rewrite MAC address */
300	memcpy(data->mac_addr, dev->net->dev_addr, ETH_ALEN);
301	ret = asix_write_cmd(dev, AX_CMD_WRITE_NODE_ID, 0, 0, ETH_ALEN,
302			     data->mac_addr, 0);
303	if (ret < 0)
304		goto out;
305
306	/* Set RX_CTL to default values with 2k buffer, and enable cactus */
307	ret = asix_write_rx_ctl(dev, AX_DEFAULT_RX_CTL, 0);
308	if (ret < 0)
309		goto out;
310
311	rx_ctl = asix_read_rx_ctl(dev, 0);
312	netdev_dbg(dev->net, "RX_CTL is 0x%04x after all initializations\n",
313		   rx_ctl);
314
315	rx_ctl = asix_read_medium_status(dev, 0);
316	netdev_dbg(dev->net, "Medium Status is 0x%04x after all initializations\n",
317		   rx_ctl);
318
319	/* Connect to PHY */
320	snprintf(priv->phy_name, 20, PHY_ID_FMT,
321		 priv->mdio->id, priv->phy_addr);
322
323	priv->phydev = phy_connect(dev->net, priv->phy_name,
324				   &ax88172a_adjust_link,
325				   PHY_INTERFACE_MODE_MII);
326	if (IS_ERR(priv->phydev)) {
327		netdev_err(dev->net, "Could not connect to PHY device %s\n",
328			   priv->phy_name);
329		ret = PTR_ERR(priv->phydev);
330		goto out;
331	}
332
333	netdev_info(dev->net, "Connected to phy %s\n", priv->phy_name);
334
335	/* During power-up, the AX88172A set the power down (BMCR_PDOWN)
336	 * bit of the PHY. Bring the PHY up again.
337	 */
338	genphy_resume(priv->phydev);
339	phy_start(priv->phydev);
340
341	return 0;
342
343out:
344	return ret;
345
346}
347
348static int ax88172a_rx_fixup(struct usbnet *dev, struct sk_buff *skb)
349{
350	struct ax88172a_private *dp = dev->driver_priv;
351	struct asix_rx_fixup_info *rx = &dp->rx_fixup_info;
352
353	return asix_rx_fixup_internal(dev, skb, rx);
354}
355
356const struct driver_info ax88172a_info = {
357	.description = "ASIX AX88172A USB 2.0 Ethernet",
358	.bind = ax88172a_bind,
359	.reset = ax88172a_reset,
360	.stop = ax88172a_stop,
361	.unbind = ax88172a_unbind,
362	.status = ax88172a_status,
363	.flags = FLAG_ETHER | FLAG_FRAMING_AX | FLAG_LINK_INTR |
364		 FLAG_MULTI_PACKET,
365	.rx_fixup = ax88172a_rx_fixup,
366	.tx_fixup = asix_tx_fixup,
367};
368