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_INTERNAL	BIT(0)
11#define OCELOT_PORT_MODE_SGMII		BIT(1)
12#define OCELOT_PORT_MODE_QSGMII		BIT(2)
13#define OCELOT_PORT_MODE_2500BASEX	BIT(3)
14#define OCELOT_PORT_MODE_USXGMII	BIT(4)
15#define OCELOT_PORT_MODE_1000BASEX	BIT(5)
16
17/* Platform-specific information */
18struct felix_info {
19	/* Hardcoded resources provided by the hardware instantiation. */
20	const struct resource		*resources;
21	size_t				num_resources;
22	/* Names of the mandatory resources that will be requested during
23	 * probe. Must have TARGET_MAX elements, since it is indexed by target.
24	 */
25	const char *const		*resource_names;
26	const struct reg_field		*regfields;
27	const u32 *const		*map;
28	const struct ocelot_ops		*ops;
29	const u32			*port_modes;
30	int				num_mact_rows;
31	int				num_ports;
32	int				num_tx_queues;
33	struct vcap_props		*vcap;
34	u16				vcap_pol_base;
35	u16				vcap_pol_max;
36	u16				vcap_pol_base2;
37	u16				vcap_pol_max2;
38	const struct ptp_clock_info	*ptp_caps;
39
40	/* Some Ocelot switches are integrated into the SoC without the
41	 * extraction IRQ line connected to the ARM GIC. By enabling this
42	 * workaround, the few packets that are delivered to the CPU port
43	 * module (currently only PTP) are copied not only to the hardware CPU
44	 * port module, but also to the 802.1Q Ethernet CPU port, and polling
45	 * the extraction registers is triggered once the DSA tagger sees a PTP
46	 * frame. The Ethernet frame is only used as a notification: it is
47	 * dropped, and the original frame is extracted over MMIO and annotated
48	 * with the RX timestamp.
49	 */
50	bool				quirk_no_xtr_irq;
51
52	int	(*mdio_bus_alloc)(struct ocelot *ocelot);
53	void	(*mdio_bus_free)(struct ocelot *ocelot);
54	int	(*port_setup_tc)(struct dsa_switch *ds, int port,
55				 enum tc_setup_type type, void *type_data);
56	void	(*tas_guard_bands_update)(struct ocelot *ocelot, int port);
57	void	(*port_sched_speed_set)(struct ocelot *ocelot, int port,
58					u32 speed);
59};
60
61/* Methods for initializing the hardware resources specific to a tagging
62 * protocol (like the NPI port, for "ocelot" or "seville", or the VCAP TCAMs,
63 * for "ocelot-8021q").
64 * It is important that the resources configured here do not have side effects
65 * for the other tagging protocols. If that is the case, their configuration
66 * needs to go to felix_tag_proto_setup_shared().
67 */
68struct felix_tag_proto_ops {
69	int (*setup)(struct dsa_switch *ds);
70	void (*teardown)(struct dsa_switch *ds);
71	unsigned long (*get_host_fwd_mask)(struct dsa_switch *ds);
72	int (*change_master)(struct dsa_switch *ds, int port,
73			     struct net_device *master,
74			     struct netlink_ext_ack *extack);
75};
76
77extern const struct dsa_switch_ops felix_switch_ops;
78
79/* DSA glue / front-end for struct ocelot */
80struct felix {
81	struct dsa_switch		*ds;
82	const struct felix_info		*info;
83	struct ocelot			ocelot;
84	struct mii_bus			*imdio;
85	struct phylink_pcs		**pcs;
86	resource_size_t			switch_base;
87	enum dsa_tag_protocol		tag_proto;
88	const struct felix_tag_proto_ops *tag_proto_ops;
89	struct kthread_worker		*xmit_worker;
90	unsigned long			host_flood_uc_mask;
91	unsigned long			host_flood_mc_mask;
92};
93
94struct net_device *felix_port_to_netdev(struct ocelot *ocelot, int port);
95int felix_netdev_to_port(struct net_device *dev);
96
97#endif