xref: /openbmc/linux/drivers/net/ethernet/mscc/ocelot.h (revision 83946783)
1 /* SPDX-License-Identifier: (GPL-2.0 OR MIT) */
2 /*
3  * Microsemi Ocelot Switch driver
4  *
5  * Copyright (c) 2017 Microsemi Corporation
6  */
7 
8 #ifndef _MSCC_OCELOT_H_
9 #define _MSCC_OCELOT_H_
10 
11 #include <linux/bitops.h>
12 #include <linux/etherdevice.h>
13 #include <linux/if_vlan.h>
14 #include <linux/net_tstamp.h>
15 #include <linux/phylink.h>
16 #include <linux/platform_device.h>
17 #include <linux/regmap.h>
18 
19 #include <soc/mscc/ocelot_qsys.h>
20 #include <soc/mscc/ocelot_sys.h>
21 #include <soc/mscc/ocelot_dev.h>
22 #include <soc/mscc/ocelot_ana.h>
23 #include <soc/mscc/ocelot_ptp.h>
24 #include <soc/mscc/ocelot.h>
25 #include "ocelot_rew.h"
26 #include "ocelot_qs.h"
27 
28 #define OCELOT_VLAN_UNAWARE_PVID 0
29 #define OCELOT_BUFFER_CELL_SZ 60
30 
31 #define OCELOT_STATS_CHECK_DELAY (2 * HZ)
32 
33 #define OCELOT_PTP_QUEUE_SZ	128
34 
35 struct ocelot_port_tc {
36 	bool block_shared;
37 	unsigned long offload_cnt;
38 
39 	unsigned long police_id;
40 };
41 
42 struct ocelot_port_private {
43 	struct ocelot_port port;
44 	struct net_device *dev;
45 	struct phylink *phylink;
46 	struct phylink_config phylink_config;
47 	u8 chip_port;
48 	struct ocelot_port_tc tc;
49 };
50 
51 struct ocelot_dump_ctx {
52 	struct net_device *dev;
53 	struct sk_buff *skb;
54 	struct netlink_callback *cb;
55 	int idx;
56 };
57 
58 /* MAC table entry types.
59  * ENTRYTYPE_NORMAL is subject to aging.
60  * ENTRYTYPE_LOCKED is not subject to aging.
61  * ENTRYTYPE_MACv4 is not subject to aging. For IPv4 multicast.
62  * ENTRYTYPE_MACv6 is not subject to aging. For IPv6 multicast.
63  */
64 enum macaccess_entry_type {
65 	ENTRYTYPE_NORMAL = 0,
66 	ENTRYTYPE_LOCKED,
67 	ENTRYTYPE_MACv4,
68 	ENTRYTYPE_MACv6,
69 };
70 
71 /* A (PGID) port mask structure, encoding the 2^ocelot->num_phys_ports
72  * possibilities of egress port masks for L2 multicast traffic.
73  * For a switch with 9 user ports, there are 512 possible port masks, but the
74  * hardware only has 46 individual PGIDs that it can forward multicast traffic
75  * to. So we need a structure that maps the limited PGID indices to the port
76  * destinations requested by the user for L2 multicast.
77  */
78 struct ocelot_pgid {
79 	unsigned long ports;
80 	int index;
81 	refcount_t refcount;
82 	struct list_head list;
83 };
84 
85 struct ocelot_multicast {
86 	struct list_head list;
87 	enum macaccess_entry_type entry_type;
88 	unsigned char addr[ETH_ALEN];
89 	u16 vid;
90 	u16 ports;
91 	struct ocelot_pgid *pgid;
92 };
93 
94 int ocelot_port_fdb_do_dump(const unsigned char *addr, u16 vid,
95 			    bool is_static, void *data);
96 int ocelot_mact_learn(struct ocelot *ocelot, int port,
97 		      const unsigned char mac[ETH_ALEN],
98 		      unsigned int vid, enum macaccess_entry_type type);
99 int ocelot_mact_forget(struct ocelot *ocelot,
100 		       const unsigned char mac[ETH_ALEN], unsigned int vid);
101 struct net_device *ocelot_port_to_netdev(struct ocelot *ocelot, int port);
102 int ocelot_netdev_to_port(struct net_device *dev);
103 
104 u32 ocelot_port_readl(struct ocelot_port *port, u32 reg);
105 void ocelot_port_writel(struct ocelot_port *port, u32 val, u32 reg);
106 
107 int ocelot_probe_port(struct ocelot *ocelot, int port, struct regmap *target,
108 		      struct device_node *portnp);
109 void ocelot_release_port(struct ocelot_port *ocelot_port);
110 int ocelot_devlink_init(struct ocelot *ocelot);
111 void ocelot_devlink_teardown(struct ocelot *ocelot);
112 int ocelot_port_devlink_init(struct ocelot *ocelot, int port,
113 			     enum devlink_port_flavour flavour);
114 void ocelot_port_devlink_teardown(struct ocelot *ocelot, int port);
115 
116 extern struct notifier_block ocelot_netdevice_nb;
117 extern struct notifier_block ocelot_switchdev_nb;
118 extern struct notifier_block ocelot_switchdev_blocking_nb;
119 extern const struct devlink_ops ocelot_devlink_ops;
120 
121 #endif
122