1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* Microchip switch driver common header 3 * 4 * Copyright (C) 2017-2019 Microchip Technology Inc. 5 */ 6 7 #ifndef __KSZ_COMMON_H 8 #define __KSZ_COMMON_H 9 10 #include <linux/etherdevice.h> 11 #include <linux/kernel.h> 12 #include <linux/mutex.h> 13 #include <linux/phy.h> 14 #include <linux/regmap.h> 15 #include <net/dsa.h> 16 17 struct vlan_table { 18 u32 table[3]; 19 }; 20 21 struct ksz_port_mib { 22 struct mutex cnt_mutex; /* structure access */ 23 u8 cnt_ptr; 24 u64 *counters; 25 }; 26 27 struct ksz_port { 28 bool remove_tag; /* Remove Tag flag set, for ksz8795 only */ 29 int stp_state; 30 struct phy_device phydev; 31 32 u32 on:1; /* port is not disabled by hardware */ 33 u32 phy:1; /* port has a PHY */ 34 u32 fiber:1; /* port is fiber */ 35 u32 sgmii:1; /* port is SGMII */ 36 u32 force:1; 37 u32 read:1; /* read MIB counters in background */ 38 u32 freeze:1; /* MIB counter freeze is enabled */ 39 40 struct ksz_port_mib mib; 41 phy_interface_t interface; 42 }; 43 44 struct ksz_device { 45 struct dsa_switch *ds; 46 struct ksz_platform_data *pdata; 47 const char *name; 48 49 struct mutex dev_mutex; /* device access */ 50 struct mutex regmap_mutex; /* regmap access */ 51 struct mutex alu_mutex; /* ALU access */ 52 struct mutex vlan_mutex; /* vlan access */ 53 const struct ksz_dev_ops *dev_ops; 54 55 struct device *dev; 56 struct regmap *regmap[3]; 57 58 void *priv; 59 60 struct gpio_desc *reset_gpio; /* Optional reset GPIO */ 61 62 /* chip specific data */ 63 u32 chip_id; 64 int num_vlans; 65 int num_alus; 66 int num_statics; 67 int cpu_port; /* port connected to CPU */ 68 int cpu_ports; /* port bitmap can be cpu port */ 69 int phy_port_cnt; 70 int port_cnt; 71 u8 reg_mib_cnt; 72 int mib_cnt; 73 const struct mib_names *mib_names; 74 phy_interface_t compat_interface; 75 u32 regs_size; 76 bool phy_errata_9477; 77 bool synclko_125; 78 bool synclko_disable; 79 80 struct vlan_table *vlan_cache; 81 82 struct ksz_port *ports; 83 struct delayed_work mib_read; 84 unsigned long mib_read_interval; 85 u16 mirror_rx; 86 u16 mirror_tx; 87 u32 features; /* chip specific features */ 88 u32 overrides; /* chip functions set by user */ 89 u16 host_mask; 90 u16 port_mask; 91 }; 92 93 struct alu_struct { 94 /* entry 1 */ 95 u8 is_static:1; 96 u8 is_src_filter:1; 97 u8 is_dst_filter:1; 98 u8 prio_age:3; 99 u32 _reserv_0_1:23; 100 u8 mstp:3; 101 /* entry 2 */ 102 u8 is_override:1; 103 u8 is_use_fid:1; 104 u32 _reserv_1_1:23; 105 u8 port_forward:7; 106 /* entry 3 & 4*/ 107 u32 _reserv_2_1:9; 108 u8 fid:7; 109 u8 mac[ETH_ALEN]; 110 }; 111 112 struct ksz_dev_ops { 113 u32 (*get_port_addr)(int port, int offset); 114 void (*cfg_port_member)(struct ksz_device *dev, int port, u8 member); 115 void (*flush_dyn_mac_table)(struct ksz_device *dev, int port); 116 void (*port_cleanup)(struct ksz_device *dev, int port); 117 void (*port_setup)(struct ksz_device *dev, int port, bool cpu_port); 118 void (*r_phy)(struct ksz_device *dev, u16 phy, u16 reg, u16 *val); 119 void (*w_phy)(struct ksz_device *dev, u16 phy, u16 reg, u16 val); 120 int (*r_dyn_mac_table)(struct ksz_device *dev, u16 addr, u8 *mac_addr, 121 u8 *fid, u8 *src_port, u8 *timestamp, 122 u16 *entries); 123 int (*r_sta_mac_table)(struct ksz_device *dev, u16 addr, 124 struct alu_struct *alu); 125 void (*w_sta_mac_table)(struct ksz_device *dev, u16 addr, 126 struct alu_struct *alu); 127 void (*r_mib_cnt)(struct ksz_device *dev, int port, u16 addr, 128 u64 *cnt); 129 void (*r_mib_pkt)(struct ksz_device *dev, int port, u16 addr, 130 u64 *dropped, u64 *cnt); 131 void (*freeze_mib)(struct ksz_device *dev, int port, bool freeze); 132 void (*port_init_cnt)(struct ksz_device *dev, int port); 133 int (*shutdown)(struct ksz_device *dev); 134 int (*detect)(struct ksz_device *dev); 135 int (*init)(struct ksz_device *dev); 136 void (*exit)(struct ksz_device *dev); 137 }; 138 139 struct ksz_device *ksz_switch_alloc(struct device *base, void *priv); 140 int ksz_switch_register(struct ksz_device *dev, 141 const struct ksz_dev_ops *ops); 142 void ksz_switch_remove(struct ksz_device *dev); 143 144 int ksz8_switch_register(struct ksz_device *dev); 145 int ksz9477_switch_register(struct ksz_device *dev); 146 147 void ksz_update_port_member(struct ksz_device *dev, int port); 148 void ksz_init_mib_timer(struct ksz_device *dev); 149 150 /* Common DSA access functions */ 151 152 int ksz_phy_read16(struct dsa_switch *ds, int addr, int reg); 153 int ksz_phy_write16(struct dsa_switch *ds, int addr, int reg, u16 val); 154 void ksz_mac_link_down(struct dsa_switch *ds, int port, unsigned int mode, 155 phy_interface_t interface); 156 int ksz_sset_count(struct dsa_switch *ds, int port, int sset); 157 void ksz_get_ethtool_stats(struct dsa_switch *ds, int port, uint64_t *buf); 158 int ksz_port_bridge_join(struct dsa_switch *ds, int port, 159 struct dsa_bridge bridge, bool *tx_fwd_offload); 160 void ksz_port_bridge_leave(struct dsa_switch *ds, int port, 161 struct dsa_bridge bridge); 162 void ksz_port_fast_age(struct dsa_switch *ds, int port); 163 int ksz_port_fdb_dump(struct dsa_switch *ds, int port, dsa_fdb_dump_cb_t *cb, 164 void *data); 165 int ksz_port_mdb_add(struct dsa_switch *ds, int port, 166 const struct switchdev_obj_port_mdb *mdb); 167 int ksz_port_mdb_del(struct dsa_switch *ds, int port, 168 const struct switchdev_obj_port_mdb *mdb); 169 int ksz_enable_port(struct dsa_switch *ds, int port, struct phy_device *phy); 170 171 /* Common register access functions */ 172 173 static inline int ksz_read8(struct ksz_device *dev, u32 reg, u8 *val) 174 { 175 unsigned int value; 176 int ret = regmap_read(dev->regmap[0], reg, &value); 177 178 *val = value; 179 return ret; 180 } 181 182 static inline int ksz_read16(struct ksz_device *dev, u32 reg, u16 *val) 183 { 184 unsigned int value; 185 int ret = regmap_read(dev->regmap[1], reg, &value); 186 187 *val = value; 188 return ret; 189 } 190 191 static inline int ksz_read32(struct ksz_device *dev, u32 reg, u32 *val) 192 { 193 unsigned int value; 194 int ret = regmap_read(dev->regmap[2], reg, &value); 195 196 *val = value; 197 return ret; 198 } 199 200 static inline int ksz_read64(struct ksz_device *dev, u32 reg, u64 *val) 201 { 202 u32 value[2]; 203 int ret; 204 205 ret = regmap_bulk_read(dev->regmap[2], reg, value, 2); 206 if (!ret) 207 *val = (u64)value[0] << 32 | value[1]; 208 209 return ret; 210 } 211 212 static inline int ksz_write8(struct ksz_device *dev, u32 reg, u8 value) 213 { 214 return regmap_write(dev->regmap[0], reg, value); 215 } 216 217 static inline int ksz_write16(struct ksz_device *dev, u32 reg, u16 value) 218 { 219 return regmap_write(dev->regmap[1], reg, value); 220 } 221 222 static inline int ksz_write32(struct ksz_device *dev, u32 reg, u32 value) 223 { 224 return regmap_write(dev->regmap[2], reg, value); 225 } 226 227 static inline int ksz_write64(struct ksz_device *dev, u32 reg, u64 value) 228 { 229 u32 val[2]; 230 231 /* Ick! ToDo: Add 64bit R/W to regmap on 32bit systems */ 232 value = swab64(value); 233 val[0] = swab32(value & 0xffffffffULL); 234 val[1] = swab32(value >> 32ULL); 235 236 return regmap_bulk_write(dev->regmap[2], reg, val, 2); 237 } 238 239 static inline void ksz_pread8(struct ksz_device *dev, int port, int offset, 240 u8 *data) 241 { 242 ksz_read8(dev, dev->dev_ops->get_port_addr(port, offset), data); 243 } 244 245 static inline void ksz_pread16(struct ksz_device *dev, int port, int offset, 246 u16 *data) 247 { 248 ksz_read16(dev, dev->dev_ops->get_port_addr(port, offset), data); 249 } 250 251 static inline void ksz_pread32(struct ksz_device *dev, int port, int offset, 252 u32 *data) 253 { 254 ksz_read32(dev, dev->dev_ops->get_port_addr(port, offset), data); 255 } 256 257 static inline void ksz_pwrite8(struct ksz_device *dev, int port, int offset, 258 u8 data) 259 { 260 ksz_write8(dev, dev->dev_ops->get_port_addr(port, offset), data); 261 } 262 263 static inline void ksz_pwrite16(struct ksz_device *dev, int port, int offset, 264 u16 data) 265 { 266 ksz_write16(dev, dev->dev_ops->get_port_addr(port, offset), data); 267 } 268 269 static inline void ksz_pwrite32(struct ksz_device *dev, int port, int offset, 270 u32 data) 271 { 272 ksz_write32(dev, dev->dev_ops->get_port_addr(port, offset), data); 273 } 274 275 static inline void ksz_regmap_lock(void *__mtx) 276 { 277 struct mutex *mtx = __mtx; 278 mutex_lock(mtx); 279 } 280 281 static inline void ksz_regmap_unlock(void *__mtx) 282 { 283 struct mutex *mtx = __mtx; 284 mutex_unlock(mtx); 285 } 286 287 /* Regmap tables generation */ 288 #define KSZ_SPI_OP_RD 3 289 #define KSZ_SPI_OP_WR 2 290 291 #define swabnot_used(x) 0 292 293 #define KSZ_SPI_OP_FLAG_MASK(opcode, swp, regbits, regpad) \ 294 swab##swp((opcode) << ((regbits) + (regpad))) 295 296 #define KSZ_REGMAP_ENTRY(width, swp, regbits, regpad, regalign) \ 297 { \ 298 .name = #width, \ 299 .val_bits = (width), \ 300 .reg_stride = 1, \ 301 .reg_bits = (regbits) + (regalign), \ 302 .pad_bits = (regpad), \ 303 .max_register = BIT(regbits) - 1, \ 304 .cache_type = REGCACHE_NONE, \ 305 .read_flag_mask = \ 306 KSZ_SPI_OP_FLAG_MASK(KSZ_SPI_OP_RD, swp, \ 307 regbits, regpad), \ 308 .write_flag_mask = \ 309 KSZ_SPI_OP_FLAG_MASK(KSZ_SPI_OP_WR, swp, \ 310 regbits, regpad), \ 311 .lock = ksz_regmap_lock, \ 312 .unlock = ksz_regmap_unlock, \ 313 .reg_format_endian = REGMAP_ENDIAN_BIG, \ 314 .val_format_endian = REGMAP_ENDIAN_BIG \ 315 } 316 317 #define KSZ_REGMAP_TABLE(ksz, swp, regbits, regpad, regalign) \ 318 static const struct regmap_config ksz##_regmap_config[] = { \ 319 KSZ_REGMAP_ENTRY(8, swp, (regbits), (regpad), (regalign)), \ 320 KSZ_REGMAP_ENTRY(16, swp, (regbits), (regpad), (regalign)), \ 321 KSZ_REGMAP_ENTRY(32, swp, (regbits), (regpad), (regalign)), \ 322 } 323 324 #endif 325