xref: /linux/drivers/net/dsa/ocelot/felix.h (revision 07fdad3a93756b872da7b53647715c48d0f4a2d0)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright 2019 NXP
3  */
4 #ifndef _MSCC_FELIX_H
5 #define _MSCC_FELIX_H
6 
7 #define ocelot_to_felix(o)		container_of((o), struct felix, ocelot)
8 #define FELIX_MAC_QUIRKS		OCELOT_QUIRK_PCS_PERFORMS_RATE_ADAPTATION
9 
10 #define OCELOT_PORT_MODE_NONE		0
11 #define OCELOT_PORT_MODE_INTERNAL	BIT(0)
12 #define OCELOT_PORT_MODE_SGMII		BIT(1)
13 #define OCELOT_PORT_MODE_QSGMII		BIT(2)
14 #define OCELOT_PORT_MODE_2500BASEX	BIT(3)
15 #define OCELOT_PORT_MODE_USXGMII	BIT(4) /* compatibility */
16 #define OCELOT_PORT_MODE_1000BASEX	BIT(5)
17 #define OCELOT_PORT_MODE_10G_QXGMII	BIT(6)
18 
19 struct device_node;
20 
21 /* Platform-specific information */
22 struct felix_info {
23 	/* Hardcoded resources provided by the hardware instantiation. */
24 	const struct resource		*resources;
25 	size_t				num_resources;
26 	/* Names of the mandatory resources that will be requested during
27 	 * probe. Must have TARGET_MAX elements, since it is indexed by target.
28 	 */
29 	const char *const		*resource_names;
30 	const struct reg_field		*regfields;
31 	const u32 *const		*map;
32 	const struct ocelot_ops		*ops;
33 	const u32			*port_modes;
34 	int				num_mact_rows;
35 	int				num_ports;
36 	struct vcap_props		*vcap;
37 	u16				vcap_pol_base;
38 	u16				vcap_pol_max;
39 	u16				vcap_pol_base2;
40 	u16				vcap_pol_max2;
41 	const struct ptp_clock_info	*ptp_caps;
42 	unsigned long			quirks;
43 
44 	/* Some Ocelot switches are integrated into the SoC without the
45 	 * extraction IRQ line connected to the ARM GIC. By enabling this
46 	 * workaround, the few packets that are delivered to the CPU port
47 	 * module (currently only PTP) are copied not only to the hardware CPU
48 	 * port module, but also to the 802.1Q Ethernet CPU port, and polling
49 	 * the extraction registers is triggered once the DSA tagger sees a PTP
50 	 * frame. The Ethernet frame is only used as a notification: it is
51 	 * dropped, and the original frame is extracted over MMIO and annotated
52 	 * with the RX timestamp.
53 	 */
54 	bool				quirk_no_xtr_irq;
55 
56 	int	(*mdio_bus_alloc)(struct ocelot *ocelot);
57 	void	(*mdio_bus_free)(struct ocelot *ocelot);
58 	int	(*port_setup_tc)(struct dsa_switch *ds, int port,
59 				 enum tc_setup_type type, void *type_data);
60 	void	(*port_sched_speed_set)(struct ocelot *ocelot, int port,
61 					u32 speed);
62 	void	(*phylink_mac_config)(struct ocelot *ocelot, int port,
63 				      unsigned int mode,
64 				      const struct phylink_link_state *state);
65 	int	(*configure_serdes)(struct ocelot *ocelot, int port,
66 				    struct device_node *portnp);
67 	int	(*request_irq)(struct ocelot *ocelot);
68 };
69 
70 /* Methods for initializing the hardware resources specific to a tagging
71  * protocol (like the NPI port, for "ocelot" or "seville", or the VCAP TCAMs,
72  * for "ocelot-8021q").
73  * It is important that the resources configured here do not have side effects
74  * for the other tagging protocols. If that is the case, their configuration
75  * needs to go to felix_tag_proto_setup_shared().
76  */
77 struct felix_tag_proto_ops {
78 	int (*setup)(struct dsa_switch *ds);
79 	void (*teardown)(struct dsa_switch *ds);
80 	unsigned long (*get_host_fwd_mask)(struct dsa_switch *ds);
81 	int (*change_conduit)(struct dsa_switch *ds, int port,
82 			      struct net_device *conduit,
83 			      struct netlink_ext_ack *extack);
84 };
85 
86 /* DSA glue / front-end for struct ocelot */
87 struct felix {
88 	struct dsa_switch		*ds;
89 	const struct felix_info		*info;
90 	struct ocelot			ocelot;
91 	struct mii_bus			*imdio;
92 	struct phylink_pcs		**pcs;
93 	resource_size_t			switch_base;
94 	enum dsa_tag_protocol		tag_proto;
95 	const struct felix_tag_proto_ops *tag_proto_ops;
96 	struct kthread_worker		*xmit_worker;
97 	unsigned long			host_flood_uc_mask;
98 	unsigned long			host_flood_mc_mask;
99 };
100 
101 int felix_register_switch(struct device *dev, resource_size_t switch_base,
102 			  int num_flooding_pgids, bool ptp,
103 			  bool mm_supported,
104 			  enum dsa_tag_protocol init_tag_proto,
105 			  const struct felix_info *info);
106 struct net_device *felix_port_to_netdev(struct ocelot *ocelot, int port);
107 int felix_netdev_to_port(struct net_device *dev);
108 
109 #endif
110