GNU Linux-libre 5.10.153-gnu1
[releases.git] / drivers / net / dsa / mv88e6060.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * net/dsa/mv88e6060.c - Driver for Marvell 88e6060 switch chips
4  * Copyright (c) 2008-2009 Marvell Semiconductor
5  */
6
7 #include <linux/delay.h>
8 #include <linux/etherdevice.h>
9 #include <linux/jiffies.h>
10 #include <linux/list.h>
11 #include <linux/module.h>
12 #include <linux/netdevice.h>
13 #include <linux/phy.h>
14 #include <net/dsa.h>
15 #include "mv88e6060.h"
16
17 static int reg_read(struct mv88e6060_priv *priv, int addr, int reg)
18 {
19         return mdiobus_read_nested(priv->bus, priv->sw_addr + addr, reg);
20 }
21
22 static int reg_write(struct mv88e6060_priv *priv, int addr, int reg, u16 val)
23 {
24         return mdiobus_write_nested(priv->bus, priv->sw_addr + addr, reg, val);
25 }
26
27 static const char *mv88e6060_get_name(struct mii_bus *bus, int sw_addr)
28 {
29         int ret;
30
31         ret = mdiobus_read(bus, sw_addr + REG_PORT(0), PORT_SWITCH_ID);
32         if (ret >= 0) {
33                 if (ret == PORT_SWITCH_ID_6060)
34                         return "Marvell 88E6060 (A0)";
35                 if (ret == PORT_SWITCH_ID_6060_R1 ||
36                     ret == PORT_SWITCH_ID_6060_R2)
37                         return "Marvell 88E6060 (B0)";
38                 if ((ret & PORT_SWITCH_ID_6060_MASK) == PORT_SWITCH_ID_6060)
39                         return "Marvell 88E6060";
40         }
41
42         return NULL;
43 }
44
45 static enum dsa_tag_protocol mv88e6060_get_tag_protocol(struct dsa_switch *ds,
46                                                         int port,
47                                                         enum dsa_tag_protocol m)
48 {
49         return DSA_TAG_PROTO_TRAILER;
50 }
51
52 static int mv88e6060_switch_reset(struct mv88e6060_priv *priv)
53 {
54         int i;
55         int ret;
56         unsigned long timeout;
57
58         /* Set all ports to the disabled state. */
59         for (i = 0; i < MV88E6060_PORTS; i++) {
60                 ret = reg_read(priv, REG_PORT(i), PORT_CONTROL);
61                 if (ret < 0)
62                         return ret;
63                 ret = reg_write(priv, REG_PORT(i), PORT_CONTROL,
64                                 ret & ~PORT_CONTROL_STATE_MASK);
65                 if (ret)
66                         return ret;
67         }
68
69         /* Wait for transmit queues to drain. */
70         usleep_range(2000, 4000);
71
72         /* Reset the switch. */
73         ret = reg_write(priv, REG_GLOBAL, GLOBAL_ATU_CONTROL,
74                         GLOBAL_ATU_CONTROL_SWRESET |
75                         GLOBAL_ATU_CONTROL_LEARNDIS);
76         if (ret)
77                 return ret;
78
79         /* Wait up to one second for reset to complete. */
80         timeout = jiffies + 1 * HZ;
81         while (time_before(jiffies, timeout)) {
82                 ret = reg_read(priv, REG_GLOBAL, GLOBAL_STATUS);
83                 if (ret < 0)
84                         return ret;
85
86                 if (ret & GLOBAL_STATUS_INIT_READY)
87                         break;
88
89                 usleep_range(1000, 2000);
90         }
91         if (time_after(jiffies, timeout))
92                 return -ETIMEDOUT;
93
94         return 0;
95 }
96
97 static int mv88e6060_setup_global(struct mv88e6060_priv *priv)
98 {
99         int ret;
100
101         /* Disable discarding of frames with excessive collisions,
102          * set the maximum frame size to 1536 bytes, and mask all
103          * interrupt sources.
104          */
105         ret = reg_write(priv, REG_GLOBAL, GLOBAL_CONTROL,
106                         GLOBAL_CONTROL_MAX_FRAME_1536);
107         if (ret)
108                 return ret;
109
110         /* Disable automatic address learning.
111          */
112         return reg_write(priv, REG_GLOBAL, GLOBAL_ATU_CONTROL,
113                          GLOBAL_ATU_CONTROL_LEARNDIS);
114 }
115
116 static int mv88e6060_setup_port(struct mv88e6060_priv *priv, int p)
117 {
118         int addr = REG_PORT(p);
119         int ret;
120
121         if (dsa_is_unused_port(priv->ds, p))
122                 return 0;
123
124         /* Do not force flow control, disable Ingress and Egress
125          * Header tagging, disable VLAN tunneling, and set the port
126          * state to Forwarding.  Additionally, if this is the CPU
127          * port, enable Ingress and Egress Trailer tagging mode.
128          */
129         ret = reg_write(priv, addr, PORT_CONTROL,
130                         dsa_is_cpu_port(priv->ds, p) ?
131                         PORT_CONTROL_TRAILER |
132                         PORT_CONTROL_INGRESS_MODE |
133                         PORT_CONTROL_STATE_FORWARDING :
134                         PORT_CONTROL_STATE_FORWARDING);
135         if (ret)
136                 return ret;
137
138         /* Port based VLAN map: give each port its own address
139          * database, allow the CPU port to talk to each of the 'real'
140          * ports, and allow each of the 'real' ports to only talk to
141          * the CPU port.
142          */
143         ret = reg_write(priv, addr, PORT_VLAN_MAP,
144                         ((p & 0xf) << PORT_VLAN_MAP_DBNUM_SHIFT) |
145                         (dsa_is_cpu_port(priv->ds, p) ?
146                          dsa_user_ports(priv->ds) :
147                          BIT(dsa_to_port(priv->ds, p)->cpu_dp->index)));
148         if (ret)
149                 return ret;
150
151         /* Port Association Vector: when learning source addresses
152          * of packets, add the address to the address database using
153          * a port bitmap that has only the bit for this port set and
154          * the other bits clear.
155          */
156         return reg_write(priv, addr, PORT_ASSOC_VECTOR, BIT(p));
157 }
158
159 static int mv88e6060_setup_addr(struct mv88e6060_priv *priv)
160 {
161         u8 addr[ETH_ALEN];
162         int ret;
163         u16 val;
164
165         eth_random_addr(addr);
166
167         val = addr[0] << 8 | addr[1];
168
169         /* The multicast bit is always transmitted as a zero, so the switch uses
170          * bit 8 for "DiffAddr", where 0 means all ports transmit the same SA.
171          */
172         val &= 0xfeff;
173
174         ret = reg_write(priv, REG_GLOBAL, GLOBAL_MAC_01, val);
175         if (ret)
176                 return ret;
177
178         ret = reg_write(priv, REG_GLOBAL, GLOBAL_MAC_23,
179                         (addr[2] << 8) | addr[3]);
180         if (ret)
181                 return ret;
182
183         return reg_write(priv, REG_GLOBAL, GLOBAL_MAC_45,
184                          (addr[4] << 8) | addr[5]);
185 }
186
187 static int mv88e6060_setup(struct dsa_switch *ds)
188 {
189         struct mv88e6060_priv *priv = ds->priv;
190         int ret;
191         int i;
192
193         priv->ds = ds;
194
195         ret = mv88e6060_switch_reset(priv);
196         if (ret < 0)
197                 return ret;
198
199         /* @@@ initialise atu */
200
201         ret = mv88e6060_setup_global(priv);
202         if (ret < 0)
203                 return ret;
204
205         ret = mv88e6060_setup_addr(priv);
206         if (ret < 0)
207                 return ret;
208
209         for (i = 0; i < MV88E6060_PORTS; i++) {
210                 ret = mv88e6060_setup_port(priv, i);
211                 if (ret < 0)
212                         return ret;
213         }
214
215         return 0;
216 }
217
218 static int mv88e6060_port_to_phy_addr(int port)
219 {
220         if (port >= 0 && port < MV88E6060_PORTS)
221                 return port;
222         return -1;
223 }
224
225 static int mv88e6060_phy_read(struct dsa_switch *ds, int port, int regnum)
226 {
227         struct mv88e6060_priv *priv = ds->priv;
228         int addr;
229
230         addr = mv88e6060_port_to_phy_addr(port);
231         if (addr == -1)
232                 return 0xffff;
233
234         return reg_read(priv, addr, regnum);
235 }
236
237 static int
238 mv88e6060_phy_write(struct dsa_switch *ds, int port, int regnum, u16 val)
239 {
240         struct mv88e6060_priv *priv = ds->priv;
241         int addr;
242
243         addr = mv88e6060_port_to_phy_addr(port);
244         if (addr == -1)
245                 return 0xffff;
246
247         return reg_write(priv, addr, regnum, val);
248 }
249
250 static const struct dsa_switch_ops mv88e6060_switch_ops = {
251         .get_tag_protocol = mv88e6060_get_tag_protocol,
252         .setup          = mv88e6060_setup,
253         .phy_read       = mv88e6060_phy_read,
254         .phy_write      = mv88e6060_phy_write,
255 };
256
257 static int mv88e6060_probe(struct mdio_device *mdiodev)
258 {
259         struct device *dev = &mdiodev->dev;
260         struct mv88e6060_priv *priv;
261         struct dsa_switch *ds;
262         const char *name;
263
264         priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
265         if (!priv)
266                 return -ENOMEM;
267
268         priv->bus = mdiodev->bus;
269         priv->sw_addr = mdiodev->addr;
270
271         name = mv88e6060_get_name(priv->bus, priv->sw_addr);
272         if (!name)
273                 return -ENODEV;
274
275         dev_info(dev, "switch %s detected\n", name);
276
277         ds = devm_kzalloc(dev, sizeof(*ds), GFP_KERNEL);
278         if (!ds)
279                 return -ENOMEM;
280
281         ds->dev = dev;
282         ds->num_ports = MV88E6060_PORTS;
283         ds->priv = priv;
284         ds->dev = dev;
285         ds->ops = &mv88e6060_switch_ops;
286
287         dev_set_drvdata(dev, ds);
288
289         return dsa_register_switch(ds);
290 }
291
292 static void mv88e6060_remove(struct mdio_device *mdiodev)
293 {
294         struct dsa_switch *ds = dev_get_drvdata(&mdiodev->dev);
295
296         dsa_unregister_switch(ds);
297 }
298
299 static const struct of_device_id mv88e6060_of_match[] = {
300         {
301                 .compatible = "marvell,mv88e6060",
302         },
303         { /* sentinel */ },
304 };
305
306 static struct mdio_driver mv88e6060_driver = {
307         .probe  = mv88e6060_probe,
308         .remove = mv88e6060_remove,
309         .mdiodrv.driver = {
310                 .name = "mv88e6060",
311                 .of_match_table = mv88e6060_of_match,
312         },
313 };
314
315 mdio_module_driver(mv88e6060_driver);
316
317 MODULE_AUTHOR("Lennert Buytenhek <buytenh@wantstofly.org>");
318 MODULE_DESCRIPTION("Driver for Marvell 88E6060 ethernet switch chip");
319 MODULE_LICENSE("GPL");
320 MODULE_ALIAS("platform:mv88e6060");