drivers/net/dsa/b53/b53_priv.h

   1 /*
   2  * B53 common definitions
   3  *
   4  * Copyright (C) 2011-2013 Jonas Gorski <jogo@openwrt.org>
   5  *
   6  * Permission to use, copy, modify, and/or distribute this software for any
   7  * purpose with or without fee is hereby granted, provided that the above
   8  * copyright notice and this permission notice appear in all copies.
   9  *
  10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  17  */
  18
  19 #ifndef __B53_PRIV_H
  20 #define __B53_PRIV_H
  21
  22 #include <linux/kernel.h>
  23 #include <linux/mutex.h>
  24 #include <linux/phy.h>
  25 #include <linux/etherdevice.h>
  26 #include <net/dsa.h>
  27
  28 #include "b53_regs.h"
  29
  30 struct b53_device;
  31 struct net_device;
  32
  33 struct b53_io_ops {
  34         int (*read8)(struct b53_device *dev, u8 page, u8 reg, u8 *value);
  35         int (*read16)(struct b53_device *dev, u8 page, u8 reg, u16 *value);
  36         int (*read32)(struct b53_device *dev, u8 page, u8 reg, u32 *value);
  37         int (*read48)(struct b53_device *dev, u8 page, u8 reg, u64 *value);
  38         int (*read64)(struct b53_device *dev, u8 page, u8 reg, u64 *value);
  39         int (*write8)(struct b53_device *dev, u8 page, u8 reg, u8 value);
  40         int (*write16)(struct b53_device *dev, u8 page, u8 reg, u16 value);
  41         int (*write32)(struct b53_device *dev, u8 page, u8 reg, u32 value);
  42         int (*write48)(struct b53_device *dev, u8 page, u8 reg, u64 value);
  43         int (*write64)(struct b53_device *dev, u8 page, u8 reg, u64 value);
  44         int (*phy_read16)(struct b53_device *dev, int addr, int reg, u16 *value);
  45         int (*phy_write16)(struct b53_device *dev, int addr, int reg, u16 value);
  46 };
  47
  48 enum {
  49         BCM5325_DEVICE_ID = 0x25,
  50         BCM5365_DEVICE_ID = 0x65,
  51         BCM5395_DEVICE_ID = 0x95,
  52         BCM5397_DEVICE_ID = 0x97,
  53         BCM5398_DEVICE_ID = 0x98,
  54         BCM53115_DEVICE_ID = 0x53115,
  55         BCM53125_DEVICE_ID = 0x53125,
  56         BCM53128_DEVICE_ID = 0x53128,
  57         BCM63XX_DEVICE_ID = 0x6300,
  58         BCM53010_DEVICE_ID = 0x53010,
  59         BCM53011_DEVICE_ID = 0x53011,
  60         BCM53012_DEVICE_ID = 0x53012,
  61         BCM53018_DEVICE_ID = 0x53018,
  62         BCM53019_DEVICE_ID = 0x53019,
  63         BCM58XX_DEVICE_ID = 0x5800,
  64         BCM7445_DEVICE_ID = 0x7445,
  65         BCM7278_DEVICE_ID = 0x7278,
  66 };
  67
  68 #define B53_N_PORTS     9
  69 #define B53_N_PORTS_25  6
  70
  71 struct b53_port {
  72         u16             vlan_ctl_mask;
  73 };
  74
  75 struct b53_vlan {
  76         u16 members;
  77         u16 untag;
  78         bool valid;
  79 };
  80
  81 struct b53_device {
  82         struct dsa_switch *ds;
  83         struct b53_platform_data *pdata;
  84         const char *name;
  85
  86         struct mutex reg_mutex;
  87         struct mutex stats_mutex;
  88         const struct b53_io_ops *ops;
  89
  90         /* chip specific data */
  91         u32 chip_id;
  92         u8 core_rev;
  93         u8 vta_regs[3];
  94         u8 duplex_reg;
  95         u8 jumbo_pm_reg;
  96         u8 jumbo_size_reg;
  97         int reset_gpio;
  98         u8 num_arl_entries;
  99
 100         /* used ports mask */
 101         u16 enabled_ports;
 102         unsigned int cpu_port;
 103
 104         /* connect specific data */
 105         u8 current_page;
 106         struct device *dev;
 107
 108         /* Master MDIO bus we got probed from */
 109         struct mii_bus *bus;
 110
 111         void *priv;
 112
 113         /* run time configuration */
 114         bool enable_jumbo;
 115
 116         unsigned int num_vlans;
 117         struct b53_vlan *vlans;
 118         unsigned int num_ports;
 119         struct b53_port *ports;
 120 };
 121
 122 #define b53_for_each_port(dev, i) \
 123         for (i = 0; i < B53_N_PORTS; i++) \
 124                 if (dev->enabled_ports & BIT(i))
 125
 126
 127 static inline int is5325(struct b53_device *dev)
 128 {
 129         return dev->chip_id == BCM5325_DEVICE_ID;
 130 }
 131
 132 static inline int is5365(struct b53_device *dev)
 133 {
 134 #ifdef CONFIG_BCM47XX
 135         return dev->chip_id == BCM5365_DEVICE_ID;
 136 #else
 137         return 0;
 138 #endif
 139 }
 140
 141 static inline int is5397_98(struct b53_device *dev)
 142 {
 143         return dev->chip_id == BCM5397_DEVICE_ID ||
 144                 dev->chip_id == BCM5398_DEVICE_ID;
 145 }
 146
 147 static inline int is539x(struct b53_device *dev)
 148 {
 149         return dev->chip_id == BCM5395_DEVICE_ID ||
 150                 dev->chip_id == BCM5397_DEVICE_ID ||
 151                 dev->chip_id == BCM5398_DEVICE_ID;
 152 }
 153
 154 static inline int is531x5(struct b53_device *dev)
 155 {
 156         return dev->chip_id == BCM53115_DEVICE_ID ||
 157                 dev->chip_id == BCM53125_DEVICE_ID ||
 158                 dev->chip_id == BCM53128_DEVICE_ID;
 159 }
 160
 161 static inline int is63xx(struct b53_device *dev)
 162 {
 163 #ifdef CONFIG_BCM63XX
 164         return dev->chip_id == BCM63XX_DEVICE_ID;
 165 #else
 166         return 0;
 167 #endif
 168 }
 169
 170 static inline int is5301x(struct b53_device *dev)
 171 {
 172         return dev->chip_id == BCM53010_DEVICE_ID ||
 173                 dev->chip_id == BCM53011_DEVICE_ID ||
 174                 dev->chip_id == BCM53012_DEVICE_ID ||
 175                 dev->chip_id == BCM53018_DEVICE_ID ||
 176                 dev->chip_id == BCM53019_DEVICE_ID;
 177 }
 178
 179 static inline int is58xx(struct b53_device *dev)
 180 {
 181         return dev->chip_id == BCM58XX_DEVICE_ID ||
 182                 dev->chip_id == BCM7445_DEVICE_ID ||
 183                 dev->chip_id == BCM7278_DEVICE_ID;
 184 }
 185
 186 #define B53_CPU_PORT_25 5
 187 #define B53_CPU_PORT    8
 188
 189 static inline int is_cpu_port(struct b53_device *dev, int port)
 190 {
 191         return dev->cpu_port;
 192 }
 193
 194 struct b53_device *b53_switch_alloc(struct device *base,
 195                                     const struct b53_io_ops *ops,
 196                                     void *priv);
 197
 198 int b53_switch_detect(struct b53_device *dev);
 199
 200 int b53_switch_register(struct b53_device *dev);
 201
 202 static inline void b53_switch_remove(struct b53_device *dev)
 203 {
 204         dsa_unregister_switch(dev->ds);
 205 }
 206
 207 static inline int b53_read8(struct b53_device *dev, u8 page, u8 reg, u8 *val)
 208 {
 209         int ret;
 210
 211         mutex_lock(&dev->reg_mutex);
 212         ret = dev->ops->read8(dev, page, reg, val);
 213         mutex_unlock(&dev->reg_mutex);
 214
 215         return ret;
 216 }
 217
 218 static inline int b53_read16(struct b53_device *dev, u8 page, u8 reg, u16 *val)
 219 {
 220         int ret;
 221
 222         mutex_lock(&dev->reg_mutex);
 223         ret = dev->ops->read16(dev, page, reg, val);
 224         mutex_unlock(&dev->reg_mutex);
 225
 226         return ret;
 227 }
 228
 229 static inline int b53_read32(struct b53_device *dev, u8 page, u8 reg, u32 *val)
 230 {
 231         int ret;
 232
 233         mutex_lock(&dev->reg_mutex);
 234         ret = dev->ops->read32(dev, page, reg, val);
 235         mutex_unlock(&dev->reg_mutex);
 236
 237         return ret;
 238 }
 239
 240 static inline int b53_read48(struct b53_device *dev, u8 page, u8 reg, u64 *val)
 241 {
 242         int ret;
 243
 244         mutex_lock(&dev->reg_mutex);
 245         ret = dev->ops->read48(dev, page, reg, val);
 246         mutex_unlock(&dev->reg_mutex);
 247
 248         return ret;
 249 }
 250
 251 static inline int b53_read64(struct b53_device *dev, u8 page, u8 reg, u64 *val)
 252 {
 253         int ret;
 254
 255         mutex_lock(&dev->reg_mutex);
 256         ret = dev->ops->read64(dev, page, reg, val);
 257         mutex_unlock(&dev->reg_mutex);
 258
 259         return ret;
 260 }
 261
 262 static inline int b53_write8(struct b53_device *dev, u8 page, u8 reg, u8 value)
 263 {
 264         int ret;
 265
 266         mutex_lock(&dev->reg_mutex);
 267         ret = dev->ops->write8(dev, page, reg, value);
 268         mutex_unlock(&dev->reg_mutex);
 269
 270         return ret;
 271 }
 272
 273 static inline int b53_write16(struct b53_device *dev, u8 page, u8 reg,
 274                               u16 value)
 275 {
 276         int ret;
 277
 278         mutex_lock(&dev->reg_mutex);
 279         ret = dev->ops->write16(dev, page, reg, value);
 280         mutex_unlock(&dev->reg_mutex);
 281
 282         return ret;
 283 }
 284
 285 static inline int b53_write32(struct b53_device *dev, u8 page, u8 reg,
 286                               u32 value)
 287 {
 288         int ret;
 289
 290         mutex_lock(&dev->reg_mutex);
 291         ret = dev->ops->write32(dev, page, reg, value);
 292         mutex_unlock(&dev->reg_mutex);
 293
 294         return ret;
 295 }
 296
 297 static inline int b53_write48(struct b53_device *dev, u8 page, u8 reg,
 298                               u64 value)
 299 {
 300         int ret;
 301
 302         mutex_lock(&dev->reg_mutex);
 303         ret = dev->ops->write48(dev, page, reg, value);
 304         mutex_unlock(&dev->reg_mutex);
 305
 306         return ret;
 307 }
 308
 309 static inline int b53_write64(struct b53_device *dev, u8 page, u8 reg,
 310                                u64 value)
 311 {
 312         int ret;
 313
 314         mutex_lock(&dev->reg_mutex);
 315         ret = dev->ops->write64(dev, page, reg, value);
 316         mutex_unlock(&dev->reg_mutex);
 317
 318         return ret;
 319 }
 320
 321 struct b53_arl_entry {
 322         u8 port;
 323         u8 mac[ETH_ALEN];
 324         u16 vid;
 325         u8 is_valid:1;
 326         u8 is_age:1;
 327         u8 is_static:1;
 328 };
 329
 330 static inline void b53_arl_to_entry(struct b53_arl_entry *ent,
 331                                     u64 mac_vid, u32 fwd_entry)
 332 {
 333         memset(ent, 0, sizeof(*ent));
 334         ent->port = fwd_entry & ARLTBL_DATA_PORT_ID_MASK;
 335         ent->is_valid = !!(fwd_entry & ARLTBL_VALID);
 336         ent->is_age = !!(fwd_entry & ARLTBL_AGE);
 337         ent->is_static = !!(fwd_entry & ARLTBL_STATIC);
 338         u64_to_ether_addr(mac_vid, ent->mac);
 339         ent->vid = mac_vid >> ARLTBL_VID_S;
 340 }
 341
 342 static inline void b53_arl_from_entry(u64 *mac_vid, u32 *fwd_entry,
 343                                       const struct b53_arl_entry *ent)
 344 {
 345         *mac_vid = ether_addr_to_u64(ent->mac);
 346         *mac_vid |= (u64)(ent->vid & ARLTBL_VID_MASK) << ARLTBL_VID_S;
 347         *fwd_entry = ent->port & ARLTBL_DATA_PORT_ID_MASK;
 348         if (ent->is_valid)
 349                 *fwd_entry |= ARLTBL_VALID;
 350         if (ent->is_static)
 351                 *fwd_entry |= ARLTBL_STATIC;
 352         if (ent->is_age)
 353                 *fwd_entry |= ARLTBL_AGE;
 354 }
 355
 356 #ifdef CONFIG_BCM47XX
 357
 358 #include <linux/bcm47xx_nvram.h>
 359 #include <bcm47xx_board.h>
 360 static inline int b53_switch_get_reset_gpio(struct b53_device *dev)
 361 {
 362         enum bcm47xx_board board = bcm47xx_board_get();
 363
 364         switch (board) {
 365         case BCM47XX_BOARD_LINKSYS_WRT300NV11:
 366         case BCM47XX_BOARD_LINKSYS_WRT310NV1:
 367                 return 8;
 368         default:
 369                 return bcm47xx_nvram_gpio_pin("robo_reset");
 370         }
 371 }
 372 #else
 373 static inline int b53_switch_get_reset_gpio(struct b53_device *dev)
 374 {
 375         return -ENOENT;
 376 }
 377 #endif
 378
 379 /* Exported functions towards other drivers */
 380 void b53_get_strings(struct dsa_switch *ds, int port, uint8_t *data);
 381 void b53_get_ethtool_stats(struct dsa_switch *ds, int port, uint64_t *data);
 382 int b53_get_sset_count(struct dsa_switch *ds);
 383 int b53_br_join(struct dsa_switch *ds, int port, struct net_device *bridge);
 384 void b53_br_leave(struct dsa_switch *ds, int port, struct net_device *bridge);
 385 void b53_br_set_stp_state(struct dsa_switch *ds, int port, u8 state);
 386 void b53_br_fast_age(struct dsa_switch *ds, int port);
 387 int b53_vlan_filtering(struct dsa_switch *ds, int port, bool vlan_filtering);
 388 int b53_vlan_prepare(struct dsa_switch *ds, int port,
 389                      const struct switchdev_obj_port_vlan *vlan,
 390                      struct switchdev_trans *trans);
 391 void b53_vlan_add(struct dsa_switch *ds, int port,
 392                   const struct switchdev_obj_port_vlan *vlan,
 393                   struct switchdev_trans *trans);
 394 int b53_vlan_del(struct dsa_switch *ds, int port,
 395                  const struct switchdev_obj_port_vlan *vlan);
 396 int b53_vlan_dump(struct dsa_switch *ds, int port,
 397                   struct switchdev_obj_port_vlan *vlan,
 398                   switchdev_obj_dump_cb_t *cb);
 399 int b53_fdb_add(struct dsa_switch *ds, int port,
 400                 const unsigned char *addr, u16 vid);
 401 int b53_fdb_del(struct dsa_switch *ds, int port,
 402                 const unsigned char *addr, u16 vid);
 403 int b53_fdb_dump(struct dsa_switch *ds, int port,
 404                  struct switchdev_obj_port_fdb *fdb,
 405                  switchdev_obj_dump_cb_t *cb);
 406 int b53_mirror_add(struct dsa_switch *ds, int port,
 407                    struct dsa_mall_mirror_tc_entry *mirror, bool ingress);
 408 void b53_mirror_del(struct dsa_switch *ds, int port,
 409                     struct dsa_mall_mirror_tc_entry *mirror);
 410
 411 #endif