drivers/net/dsa/microchip/ksz_common.h - linux - Git at Google

 /* SPDX-License-Identifier: GPL-2.0 */
 /* Microchip switch driver common header
  *
  * Copyright (C) 2017-2019 Microchip Technology Inc.
  */

 #ifndef __KSZ_COMMON_H
 #define __KSZ_COMMON_H

 #include <linux/etherdevice.h>
 #include <linux/kernel.h>
 #include <linux/mutex.h>
 #include <linux/phy.h>
 #include <linux/regmap.h>
 #include <net/dsa.h>

 struct vlan_table {
 	u32 table[3];
 };

 struct ksz_port_mib {
 	struct mutex cnt_mutex;		/* structure access */
 	u8 cnt_ptr;
 	u64 *counters;
 };

 struct ksz_port {
 	bool remove_tag;		/* Remove Tag flag set, for ksz8795 only */
 	int stp_state;
 	struct phy_device phydev;

 	u32 on:1;			/* port is not disabled by hardware */
 	u32 phy:1;			/* port has a PHY */
 	u32 fiber:1;			/* port is fiber */
 	u32 sgmii:1;			/* port is SGMII */
 	u32 force:1;
 	u32 read:1;			/* read MIB counters in background */
 	u32 freeze:1;			/* MIB counter freeze is enabled */

 	struct ksz_port_mib mib;
 	phy_interface_t interface;
 };

 struct ksz_device {
 	struct dsa_switch *ds;
 	struct ksz_platform_data *pdata;
 	const char *name;

 	struct mutex dev_mutex;		/* device access */
 	struct mutex regmap_mutex;	/* regmap access */
 	struct mutex alu_mutex;		/* ALU access */
 	struct mutex vlan_mutex;	/* vlan access */
 	const struct ksz_dev_ops *dev_ops;

 	struct device *dev;
 	struct regmap *regmap[3];

 	void *priv;

 	struct gpio_desc *reset_gpio;	/* Optional reset GPIO */

 	/* chip specific data */
 	u32 chip_id;
 	int num_vlans;
 	int num_alus;
 	int num_statics;
 	int cpu_port;			/* port connected to CPU */
 	int cpu_ports;			/* port bitmap can be cpu port */
 	int phy_port_cnt;
 	int port_cnt;
 	u8 reg_mib_cnt;
 	int mib_cnt;
 	const struct mib_names *mib_names;
 	phy_interface_t compat_interface;
 	u32 regs_size;
 	bool phy_errata_9477;
 	bool synclko_125;

 	struct vlan_table *vlan_cache;

 	struct ksz_port *ports;
 	struct delayed_work mib_read;
 	unsigned long mib_read_interval;
 	u16 mirror_rx;
 	u16 mirror_tx;
 	u32 features;			/* chip specific features */
 	u32 overrides;			/* chip functions set by user */
 	u16 host_mask;
 	u16 port_mask;
 };

 struct alu_struct {
 	/* entry 1 */
 	u8	is_static:1;
 	u8	is_src_filter:1;
 	u8	is_dst_filter:1;
 	u8	prio_age:3;
 	u32	_reserv_0_1:23;
 	u8	mstp:3;
 	/* entry 2 */
 	u8	is_override:1;
 	u8	is_use_fid:1;
 	u32	_reserv_1_1:23;
 	u8	port_forward:7;
 	/* entry 3 & 4*/
 	u32	_reserv_2_1:9;
 	u8	fid:7;
 	u8	mac[ETH_ALEN];
 };

 struct ksz_dev_ops {
 	u32 (*get_port_addr)(int port, int offset);
 	void (*cfg_port_member)(struct ksz_device *dev, int port, u8 member);
 	void (*flush_dyn_mac_table)(struct ksz_device *dev, int port);
 	void (*port_cleanup)(struct ksz_device *dev, int port);
 	void (*port_setup)(struct ksz_device *dev, int port, bool cpu_port);
 	void (*r_phy)(struct ksz_device *dev, u16 phy, u16 reg, u16 *val);
 	void (*w_phy)(struct ksz_device *dev, u16 phy, u16 reg, u16 val);
 	int (*r_dyn_mac_table)(struct ksz_device *dev, u16 addr, u8 *mac_addr,
 			       u8 *fid, u8 *src_port, u8 *timestamp,
 			       u16 *entries);
 	int (*r_sta_mac_table)(struct ksz_device *dev, u16 addr,
 			       struct alu_struct *alu);
 	void (*w_sta_mac_table)(struct ksz_device *dev, u16 addr,
 				struct alu_struct *alu);
 	void (*r_mib_cnt)(struct ksz_device *dev, int port, u16 addr,
 			  u64 *cnt);
 	void (*r_mib_pkt)(struct ksz_device *dev, int port, u16 addr,
 			  u64 *dropped, u64 *cnt);
 	void (*freeze_mib)(struct ksz_device *dev, int port, bool freeze);
 	void (*port_init_cnt)(struct ksz_device *dev, int port);
 	int (*shutdown)(struct ksz_device *dev);
 	int (*detect)(struct ksz_device *dev);
 	int (*init)(struct ksz_device *dev);
 	void (*exit)(struct ksz_device *dev);
 };

 struct ksz_device *ksz_switch_alloc(struct device *base, void *priv);
 int ksz_switch_register(struct ksz_device *dev,
 			const struct ksz_dev_ops *ops);
 void ksz_switch_remove(struct ksz_device *dev);

 int ksz8_switch_register(struct ksz_device *dev);
 int ksz9477_switch_register(struct ksz_device *dev);

 void ksz_update_port_member(struct ksz_device *dev, int port);
 void ksz_init_mib_timer(struct ksz_device *dev);

 /* Common DSA access functions */

 int ksz_phy_read16(struct dsa_switch *ds, int addr, int reg);
 int ksz_phy_write16(struct dsa_switch *ds, int addr, int reg, u16 val);
 void ksz_mac_link_down(struct dsa_switch *ds, int port, unsigned int mode,
 		       phy_interface_t interface);
 int ksz_sset_count(struct dsa_switch *ds, int port, int sset);
 void ksz_get_ethtool_stats(struct dsa_switch *ds, int port, uint64_t *buf);
 int ksz_port_bridge_join(struct dsa_switch *ds, int port,
 			 struct net_device *br);
 void ksz_port_bridge_leave(struct dsa_switch *ds, int port,
 			   struct net_device *br);
 void ksz_port_fast_age(struct dsa_switch *ds, int port);
 int ksz_port_fdb_dump(struct dsa_switch *ds, int port, dsa_fdb_dump_cb_t *cb,
 		      void *data);
 int ksz_port_mdb_add(struct dsa_switch *ds, int port,
 		     const struct switchdev_obj_port_mdb *mdb);
 int ksz_port_mdb_del(struct dsa_switch *ds, int port,
 		     const struct switchdev_obj_port_mdb *mdb);
 int ksz_enable_port(struct dsa_switch *ds, int port, struct phy_device *phy);

 /* Common register access functions */

 static inline int ksz_read8(struct ksz_device *dev, u32 reg, u8 *val)
 {
 	unsigned int value;
 	int ret = regmap_read(dev->regmap[0], reg, &value);

 	*val = value;
 	return ret;
 }

 static inline int ksz_read16(struct ksz_device *dev, u32 reg, u16 *val)
 {
 	unsigned int value;
 	int ret = regmap_read(dev->regmap[1], reg, &value);

 	*val = value;
 	return ret;
 }

 static inline int ksz_read32(struct ksz_device *dev, u32 reg, u32 *val)
 {
 	unsigned int value;
 	int ret = regmap_read(dev->regmap[2], reg, &value);

 	*val = value;
 	return ret;
 }

 static inline int ksz_read64(struct ksz_device *dev, u32 reg, u64 *val)
 {
 	u32 value[2];
 	int ret;

 	ret = regmap_bulk_read(dev->regmap[2], reg, value, 2);
 	if (!ret)
 		*val = (u64)value[0] << 32 | value[1];

 	return ret;
 }

 static inline int ksz_write8(struct ksz_device *dev, u32 reg, u8 value)
 {
 	return regmap_write(dev->regmap[0], reg, value);
 }

 static inline int ksz_write16(struct ksz_device *dev, u32 reg, u16 value)
 {
 	return regmap_write(dev->regmap[1], reg, value);
 }

 static inline int ksz_write32(struct ksz_device *dev, u32 reg, u32 value)
 {
 	return regmap_write(dev->regmap[2], reg, value);
 }

 static inline int ksz_write64(struct ksz_device *dev, u32 reg, u64 value)
 {
 	u32 val[2];

 	/* Ick! ToDo: Add 64bit R/W to regmap on 32bit systems */
 	value = swab64(value);
 	val[0] = swab32(value & 0xffffffffULL);
 	val[1] = swab32(value >> 32ULL);

 	return regmap_bulk_write(dev->regmap[2], reg, val, 2);
 }

 static inline void ksz_pread8(struct ksz_device *dev, int port, int offset,
 			      u8 *data)
 {
 	ksz_read8(dev, dev->dev_ops->get_port_addr(port, offset), data);
 }

 static inline void ksz_pread16(struct ksz_device *dev, int port, int offset,
 			       u16 *data)
 {
 	ksz_read16(dev, dev->dev_ops->get_port_addr(port, offset), data);
 }

 static inline void ksz_pread32(struct ksz_device *dev, int port, int offset,
 			       u32 *data)
 {
 	ksz_read32(dev, dev->dev_ops->get_port_addr(port, offset), data);
 }

 static inline void ksz_pwrite8(struct ksz_device *dev, int port, int offset,
 			       u8 data)
 {
 	ksz_write8(dev, dev->dev_ops->get_port_addr(port, offset), data);
 }

 static inline void ksz_pwrite16(struct ksz_device *dev, int port, int offset,
 				u16 data)
 {
 	ksz_write16(dev, dev->dev_ops->get_port_addr(port, offset), data);
 }

 static inline void ksz_pwrite32(struct ksz_device *dev, int port, int offset,
 				u32 data)
 {
 	ksz_write32(dev, dev->dev_ops->get_port_addr(port, offset), data);
 }

 static inline void ksz_regmap_lock(void *__mtx)
 {
 	struct mutex *mtx = __mtx;
 	mutex_lock(mtx);
 }

 static inline void ksz_regmap_unlock(void *__mtx)
 {
 	struct mutex *mtx = __mtx;
 	mutex_unlock(mtx);
 }

 /* Regmap tables generation */
 #define KSZ_SPI_OP_RD		3
 #define KSZ_SPI_OP_WR		2

 #define swabnot_used(x)		0

 #define KSZ_SPI_OP_FLAG_MASK(opcode, swp, regbits, regpad)		\
 	swab##swp((opcode) << ((regbits) + (regpad)))

 #define KSZ_REGMAP_ENTRY(width, swp, regbits, regpad, regalign)		\
 	{								\
 		.name = #width,						\
 		.val_bits = (width),					\
 		.reg_stride = 1,					\
 		.reg_bits = (regbits) + (regalign),			\
 		.pad_bits = (regpad),					\
 		.max_register = BIT(regbits) - 1,			\
 		.cache_type = REGCACHE_NONE,				\
 		.read_flag_mask =					\
 			KSZ_SPI_OP_FLAG_MASK(KSZ_SPI_OP_RD, swp,	\
 					     regbits, regpad),		\
 		.write_flag_mask =					\
 			KSZ_SPI_OP_FLAG_MASK(KSZ_SPI_OP_WR, swp,	\
 					     regbits, regpad),		\
 		.lock = ksz_regmap_lock,				\
 		.unlock = ksz_regmap_unlock,				\
 		.reg_format_endian = REGMAP_ENDIAN_BIG,			\
 		.val_format_endian = REGMAP_ENDIAN_BIG			\
 	}

 #define KSZ_REGMAP_TABLE(ksz, swp, regbits, regpad, regalign)		\
 	static const struct regmap_config ksz##_regmap_config[] = {	\
 		KSZ_REGMAP_ENTRY(8, swp, (regbits), (regpad), (regalign)), \
 		KSZ_REGMAP_ENTRY(16, swp, (regbits), (regpad), (regalign)), \
 		KSZ_REGMAP_ENTRY(32, swp, (regbits), (regpad), (regalign)), \
 	}

 #endif
	/* SPDX-License-Identifier: GPL-2.0 */
	/* Microchip switch driver common header
	*
	* Copyright (C) 2017-2019 Microchip Technology Inc.
	*/

	#ifndef __KSZ_COMMON_H
	#define __KSZ_COMMON_H

	#include <linux/etherdevice.h>
	#include <linux/kernel.h>
	#include <linux/mutex.h>
	#include <linux/phy.h>
	#include <linux/regmap.h>
	#include <net/dsa.h>

	struct vlan_table {
	u32 table[3];
	};

	struct ksz_port_mib {
	struct mutex cnt_mutex; /* structure access */
	u8 cnt_ptr;
	u64 *counters;
	};

	struct ksz_port {
	bool remove_tag; /* Remove Tag flag set, for ksz8795 only */
	int stp_state;
	struct phy_device phydev;

	u32 on:1; /* port is not disabled by hardware */
	u32 phy:1; /* port has a PHY */
	u32 fiber:1; /* port is fiber */
	u32 sgmii:1; /* port is SGMII */
	u32 force:1;
	u32 read:1; /* read MIB counters in background */
	u32 freeze:1; /* MIB counter freeze is enabled */

	struct ksz_port_mib mib;
	phy_interface_t interface;
	};

	struct ksz_device {
	struct dsa_switch *ds;
	struct ksz_platform_data *pdata;
	const char *name;

	struct mutex dev_mutex; /* device access */
	struct mutex regmap_mutex; /* regmap access */
	struct mutex alu_mutex; /* ALU access */
	struct mutex vlan_mutex; /* vlan access */
	const struct ksz_dev_ops *dev_ops;

	struct device *dev;
	struct regmap *regmap[3];

	void *priv;

	struct gpio_desc reset_gpio; / Optional reset GPIO */

	/* chip specific data */
	u32 chip_id;
	int num_vlans;
	int num_alus;
	int num_statics;
	int cpu_port; /* port connected to CPU */
	int cpu_ports; /* port bitmap can be cpu port */
	int phy_port_cnt;
	int port_cnt;
	u8 reg_mib_cnt;
	int mib_cnt;
	const struct mib_names *mib_names;
	phy_interface_t compat_interface;
	u32 regs_size;
	bool phy_errata_9477;
	bool synclko_125;

	struct vlan_table *vlan_cache;

	struct ksz_port *ports;
	struct delayed_work mib_read;
	unsigned long mib_read_interval;
	u16 mirror_rx;
	u16 mirror_tx;
	u32 features; /* chip specific features */
	u32 overrides; /* chip functions set by user */
	u16 host_mask;
	u16 port_mask;
	};

	struct alu_struct {
	/* entry 1 */
	u8 is_static:1;
	u8 is_src_filter:1;
	u8 is_dst_filter:1;
	u8 prio_age:3;
	u32 _reserv_0_1:23;
	u8 mstp:3;
	/* entry 2 */
	u8 is_override:1;
	u8 is_use_fid:1;
	u32 _reserv_1_1:23;
	u8 port_forward:7;
	/* entry 3 & 4*/
	u32 _reserv_2_1:9;
	u8 fid:7;
	u8 mac[ETH_ALEN];
	};

	struct ksz_dev_ops {
	u32 (*get_port_addr)(int port, int offset);
	void (cfg_port_member)(struct ksz_device dev, int port, u8 member);
	void (flush_dyn_mac_table)(struct ksz_device dev, int port);
	void (port_cleanup)(struct ksz_device dev, int port);
	void (port_setup)(struct ksz_device dev, int port, bool cpu_port);
	void (r_phy)(struct ksz_device dev, u16 phy, u16 reg, u16 *val);
	void (w_phy)(struct ksz_device dev, u16 phy, u16 reg, u16 val);
	int (r_dyn_mac_table)(struct ksz_device dev, u16 addr, u8 *mac_addr,
	u8 fid, u8 src_port, u8 *timestamp,
	u16 *entries);
	int (r_sta_mac_table)(struct ksz_device dev, u16 addr,
	struct alu_struct *alu);
	void (w_sta_mac_table)(struct ksz_device dev, u16 addr,
	struct alu_struct *alu);
	void (r_mib_cnt)(struct ksz_device dev, int port, u16 addr,
	u64 *cnt);
	void (r_mib_pkt)(struct ksz_device dev, int port, u16 addr,
	u64 dropped, u64 cnt);
	void (freeze_mib)(struct ksz_device dev, int port, bool freeze);
	void (port_init_cnt)(struct ksz_device dev, int port);
	int (shutdown)(struct ksz_device dev);
	int (detect)(struct ksz_device dev);
	int (init)(struct ksz_device dev);
	void (exit)(struct ksz_device dev);
	};

	struct ksz_device ksz_switch_alloc(struct device base, void *priv);
	int ksz_switch_register(struct ksz_device *dev,
	const struct ksz_dev_ops *ops);
	void ksz_switch_remove(struct ksz_device *dev);

	int ksz8_switch_register(struct ksz_device *dev);
	int ksz9477_switch_register(struct ksz_device *dev);

	void ksz_update_port_member(struct ksz_device *dev, int port);
	void ksz_init_mib_timer(struct ksz_device *dev);

	/* Common DSA access functions */

	int ksz_phy_read16(struct dsa_switch *ds, int addr, int reg);
	int ksz_phy_write16(struct dsa_switch *ds, int addr, int reg, u16 val);
	void ksz_mac_link_down(struct dsa_switch *ds, int port, unsigned int mode,
	phy_interface_t interface);
	int ksz_sset_count(struct dsa_switch *ds, int port, int sset);
	void ksz_get_ethtool_stats(struct dsa_switch ds, int port, uint64_t buf);
	int ksz_port_bridge_join(struct dsa_switch *ds, int port,
	struct net_device *br);
	void ksz_port_bridge_leave(struct dsa_switch *ds, int port,
	struct net_device *br);
	void ksz_port_fast_age(struct dsa_switch *ds, int port);
	int ksz_port_fdb_dump(struct dsa_switch ds, int port, dsa_fdb_dump_cb_t cb,
	void *data);
	int ksz_port_mdb_add(struct dsa_switch *ds, int port,
	const struct switchdev_obj_port_mdb *mdb);
	int ksz_port_mdb_del(struct dsa_switch *ds, int port,
	const struct switchdev_obj_port_mdb *mdb);
	int ksz_enable_port(struct dsa_switch ds, int port, struct phy_device phy);

	/* Common register access functions */

	static inline int ksz_read8(struct ksz_device dev, u32 reg, u8 val)
	{
	unsigned int value;
	int ret = regmap_read(dev->regmap[0], reg, &value);

	*val = value;
	return ret;
	}

	static inline int ksz_read16(struct ksz_device dev, u32 reg, u16 val)
	{
	unsigned int value;
	int ret = regmap_read(dev->regmap[1], reg, &value);

	*val = value;
	return ret;
	}

	static inline int ksz_read32(struct ksz_device dev, u32 reg, u32 val)
	{
	unsigned int value;
	int ret = regmap_read(dev->regmap[2], reg, &value);

	*val = value;
	return ret;
	}

	static inline int ksz_read64(struct ksz_device dev, u32 reg, u64 val)
	{
	u32 value[2];
	int ret;

	ret = regmap_bulk_read(dev->regmap[2], reg, value, 2);
	if (!ret)
	*val = (u64)value[0] << 32 \| value[1];

	return ret;
	}

	static inline int ksz_write8(struct ksz_device *dev, u32 reg, u8 value)
	{
	return regmap_write(dev->regmap[0], reg, value);
	}

	static inline int ksz_write16(struct ksz_device *dev, u32 reg, u16 value)
	{
	return regmap_write(dev->regmap[1], reg, value);
	}

	static inline int ksz_write32(struct ksz_device *dev, u32 reg, u32 value)
	{
	return regmap_write(dev->regmap[2], reg, value);
	}

	static inline int ksz_write64(struct ksz_device *dev, u32 reg, u64 value)
	{
	u32 val[2];

	/* Ick! ToDo: Add 64bit R/W to regmap on 32bit systems */
	value = swab64(value);
	val[0] = swab32(value & 0xffffffffULL);
	val[1] = swab32(value >> 32ULL);

	return regmap_bulk_write(dev->regmap[2], reg, val, 2);
	}

	static inline void ksz_pread8(struct ksz_device *dev, int port, int offset,
	u8 *data)
	{
	ksz_read8(dev, dev->dev_ops->get_port_addr(port, offset), data);
	}

	static inline void ksz_pread16(struct ksz_device *dev, int port, int offset,
	u16 *data)
	{
	ksz_read16(dev, dev->dev_ops->get_port_addr(port, offset), data);
	}

	static inline void ksz_pread32(struct ksz_device *dev, int port, int offset,
	u32 *data)
	{
	ksz_read32(dev, dev->dev_ops->get_port_addr(port, offset), data);
	}

	static inline void ksz_pwrite8(struct ksz_device *dev, int port, int offset,
	u8 data)
	{
	ksz_write8(dev, dev->dev_ops->get_port_addr(port, offset), data);
	}

	static inline void ksz_pwrite16(struct ksz_device *dev, int port, int offset,
	u16 data)
	{
	ksz_write16(dev, dev->dev_ops->get_port_addr(port, offset), data);
	}

	static inline void ksz_pwrite32(struct ksz_device *dev, int port, int offset,
	u32 data)
	{
	ksz_write32(dev, dev->dev_ops->get_port_addr(port, offset), data);
	}

	static inline void ksz_regmap_lock(void *__mtx)
	{
	struct mutex *mtx = __mtx;
	mutex_lock(mtx);
	}

	static inline void ksz_regmap_unlock(void *__mtx)
	{
	struct mutex *mtx = __mtx;
	mutex_unlock(mtx);
	}

	/* Regmap tables generation */
	#define KSZ_SPI_OP_RD 3
	#define KSZ_SPI_OP_WR 2

	#define swabnot_used(x) 0

	#define KSZ_SPI_OP_FLAG_MASK(opcode, swp, regbits, regpad) \
	swab##swp((opcode) << ((regbits) + (regpad)))

	#define KSZ_REGMAP_ENTRY(width, swp, regbits, regpad, regalign) \
	{ \
	.name = #width, \
	.val_bits = (width), \
	.reg_stride = 1, \
	.reg_bits = (regbits) + (regalign), \
	.pad_bits = (regpad), \
	.max_register = BIT(regbits) - 1, \
	.cache_type = REGCACHE_NONE, \
	.read_flag_mask = \
	KSZ_SPI_OP_FLAG_MASK(KSZ_SPI_OP_RD, swp, \
	regbits, regpad), \
	.write_flag_mask = \
	KSZ_SPI_OP_FLAG_MASK(KSZ_SPI_OP_WR, swp, \
	regbits, regpad), \
	.lock = ksz_regmap_lock, \
	.unlock = ksz_regmap_unlock, \
	.reg_format_endian = REGMAP_ENDIAN_BIG, \
	.val_format_endian = REGMAP_ENDIAN_BIG \
	}

	#define KSZ_REGMAP_TABLE(ksz, swp, regbits, regpad, regalign) \
	static const struct regmap_config ksz##_regmap_config[] = { \
	KSZ_REGMAP_ENTRY(8, swp, (regbits), (regpad), (regalign)), \
	KSZ_REGMAP_ENTRY(16, swp, (regbits), (regpad), (regalign)), \
	KSZ_REGMAP_ENTRY(32, swp, (regbits), (regpad), (regalign)), \
	}

	#endif