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         BCM5389_DEVICE_ID = 0x89,
  52         BCM5395_DEVICE_ID = 0x95,
  53         BCM5397_DEVICE_ID = 0x97,
  54         BCM5398_DEVICE_ID = 0x98,
  55         BCM53115_DEVICE_ID = 0x53115,
  56         BCM53125_DEVICE_ID = 0x53125,
  57         BCM53128_DEVICE_ID = 0x53128,
  58         BCM63XX_DEVICE_ID = 0x6300,
  59         BCM53010_DEVICE_ID = 0x53010,
  60         BCM53011_DEVICE_ID = 0x53011,
  61         BCM53012_DEVICE_ID = 0x53012,
  62         BCM53018_DEVICE_ID = 0x53018,
  63         BCM53019_DEVICE_ID = 0x53019,
  64         BCM58XX_DEVICE_ID = 0x5800,
  65         BCM7445_DEVICE_ID = 0x7445,
  66         BCM7278_DEVICE_ID = 0x7278,
  67 };
  68
  69 #define B53_N_PORTS     9
  70 #define B53_N_PORTS_25  6
  71
  72 struct b53_port {
  73         u16             vlan_ctl_mask;
  74 };
  75
  76 struct b53_vlan {
  77         u16 members;
  78         u16 untag;
  79         bool valid;
  80 };
  81
  82 struct b53_device {
  83         struct dsa_switch *ds;
  84         struct b53_platform_data *pdata;
  85         const char *name;
  86
  87         struct mutex reg_mutex;
  88         struct mutex stats_mutex;
  89         const struct b53_io_ops *ops;
  90
  91         /* chip specific data */
  92         u32 chip_id;
  93         u8 core_rev;
  94         u8 vta_regs[3];
  95         u8 duplex_reg;
  96         u8 jumbo_pm_reg;
  97         u8 jumbo_size_reg;
  98         int reset_gpio;
  99         u8 num_arl_entries;
 100
 101         /* used ports mask */
 102         u16 enabled_ports;
 103         unsigned int cpu_port;
 104
 105         /* connect specific data */
 106         u8 current_page;
 107         struct device *dev;
 108
 109         /* Master MDIO bus we got probed from */
 110         struct mii_bus *bus;
 111
 112         void *priv;
 113
 114         /* run time configuration */
 115         bool enable_jumbo;
 116
 117         unsigned int num_vlans;
 118         struct b53_vlan *vlans;
 119         unsigned int num_ports;
 120         struct b53_port *ports;
 121 };
 122
 123 #define b53_for_each_port(dev, i) \
 124         for (i = 0; i < B53_N_PORTS; i++) \
 125                 if (dev->enabled_ports & BIT(i))
 126
 127
 128 static inline int is5325(struct b53_device *dev)
 129 {
 130         return dev->chip_id == BCM5325_DEVICE_ID;
 131 }
 132
 133 static inline int is5365(struct b53_device *dev)
 134 {
 135 #ifdef CONFIG_BCM47XX
 136         return dev->chip_id == BCM5365_DEVICE_ID;
 137 #else
 138         return 0;
 139 #endif
 140 }
 141
 142 static inline int is5397_98(struct b53_device *dev)
 143 {
 144         return dev->chip_id == BCM5397_DEVICE_ID ||
 145                 dev->chip_id == BCM5398_DEVICE_ID;
 146 }
 147
 148 static inline int is539x(struct b53_device *dev)
 149 {
 150         return dev->chip_id == BCM5395_DEVICE_ID ||
 151                 dev->chip_id == BCM5397_DEVICE_ID ||
 152                 dev->chip_id == BCM5398_DEVICE_ID;
 153 }
 154
 155 static inline int is531x5(struct b53_device *dev)
 156 {
 157         return dev->chip_id == BCM53115_DEVICE_ID ||
 158                 dev->chip_id == BCM53125_DEVICE_ID ||
 159                 dev->chip_id == BCM53128_DEVICE_ID;
 160 }
 161
 162 static inline int is63xx(struct b53_device *dev)
 163 {
 164 #ifdef CONFIG_BCM63XX
 165         return dev->chip_id == BCM63XX_DEVICE_ID;
 166 #else
 167         return 0;
 168 #endif
 169 }
 170
 171 static inline int is5301x(struct b53_device *dev)
 172 {
 173         return dev->chip_id == BCM53010_DEVICE_ID ||
 174                 dev->chip_id == BCM53011_DEVICE_ID ||
 175                 dev->chip_id == BCM53012_DEVICE_ID ||
 176                 dev->chip_id == BCM53018_DEVICE_ID ||
 177                 dev->chip_id == BCM53019_DEVICE_ID;
 178 }
 179
 180 static inline int is58xx(struct b53_device *dev)
 181 {
 182         return dev->chip_id == BCM58XX_DEVICE_ID ||
 183                 dev->chip_id == BCM7445_DEVICE_ID ||
 184                 dev->chip_id == BCM7278_DEVICE_ID;
 185 }
 186
 187 #define B53_CPU_PORT_25 5
 188 #define B53_CPU_PORT    8
 189
 190 static inline int is_cpu_port(struct b53_device *dev, int port)
 191 {
 192         return dev->cpu_port;
 193 }
 194
 195 struct b53_device *b53_switch_alloc(struct device *base,
 196                                     const struct b53_io_ops *ops,
 197                                     void *priv);
 198
 199 int b53_switch_detect(struct b53_device *dev);
 200
 201 int b53_switch_register(struct b53_device *dev);
 202
 203 static inline void b53_switch_remove(struct b53_device *dev)
 204 {
 205         dsa_unregister_switch(dev->ds);
 206 }
 207
 208 static inline int b53_read8(struct b53_device *dev, u8 page, u8 reg, u8 *val)
 209 {
 210         int ret;
 211
 212         mutex_lock(&dev->reg_mutex);
 213         ret = dev->ops->read8(dev, page, reg, val);
 214         mutex_unlock(&dev->reg_mutex);
 215
 216         return ret;
 217 }
 218
 219 static inline int b53_read16(struct b53_device *dev, u8 page, u8 reg, u16 *val)
 220 {
 221         int ret;
 222
 223         mutex_lock(&dev->reg_mutex);
 224         ret = dev->ops->read16(dev, page, reg, val);
 225         mutex_unlock(&dev->reg_mutex);
 226
 227         return ret;
 228 }
 229
 230 static inline int b53_read32(struct b53_device *dev, u8 page, u8 reg, u32 *val)
 231 {
 232         int ret;
 233
 234         mutex_lock(&dev->reg_mutex);
 235         ret = dev->ops->read32(dev, page, reg, val);
 236         mutex_unlock(&dev->reg_mutex);
 237
 238         return ret;
 239 }
 240
 241 static inline int b53_read48(struct b53_device *dev, u8 page, u8 reg, u64 *val)
 242 {
 243         int ret;
 244
 245         mutex_lock(&dev->reg_mutex);
 246         ret = dev->ops->read48(dev, page, reg, val);
 247         mutex_unlock(&dev->reg_mutex);
 248
 249         return ret;
 250 }
 251
 252 static inline int b53_read64(struct b53_device *dev, u8 page, u8 reg, u64 *val)
 253 {
 254         int ret;
 255
 256         mutex_lock(&dev->reg_mutex);
 257         ret = dev->ops->read64(dev, page, reg, val);
 258         mutex_unlock(&dev->reg_mutex);
 259
 260         return ret;
 261 }
 262
 263 static inline int b53_write8(struct b53_device *dev, u8 page, u8 reg, u8 value)
 264 {
 265         int ret;
 266
 267         mutex_lock(&dev->reg_mutex);
 268         ret = dev->ops->write8(dev, page, reg, value);
 269         mutex_unlock(&dev->reg_mutex);
 270
 271         return ret;
 272 }
 273
 274 static inline int b53_write16(struct b53_device *dev, u8 page, u8 reg,
 275                               u16 value)
 276 {
 277         int ret;
 278
 279         mutex_lock(&dev->reg_mutex);
 280         ret = dev->ops->write16(dev, page, reg, value);
 281         mutex_unlock(&dev->reg_mutex);
 282
 283         return ret;
 284 }
 285
 286 static inline int b53_write32(struct b53_device *dev, u8 page, u8 reg,
 287                               u32 value)
 288 {
 289         int ret;
 290
 291         mutex_lock(&dev->reg_mutex);
 292         ret = dev->ops->write32(dev, page, reg, value);
 293         mutex_unlock(&dev->reg_mutex);
 294
 295         return ret;
 296 }
 297
 298 static inline int b53_write48(struct b53_device *dev, u8 page, u8 reg,
 299                               u64 value)
 300 {
 301         int ret;
 302
 303         mutex_lock(&dev->reg_mutex);
 304         ret = dev->ops->write48(dev, page, reg, value);
 305         mutex_unlock(&dev->reg_mutex);
 306
 307         return ret;
 308 }
 309
 310 static inline int b53_write64(struct b53_device *dev, u8 page, u8 reg,
 311                                u64 value)
 312 {
 313         int ret;
 314
 315         mutex_lock(&dev->reg_mutex);
 316         ret = dev->ops->write64(dev, page, reg, value);
 317         mutex_unlock(&dev->reg_mutex);
 318
 319         return ret;
 320 }
 321
 322 struct b53_arl_entry {
 323         u8 port;
 324         u8 mac[ETH_ALEN];
 325         u16 vid;
 326         u8 is_valid:1;
 327         u8 is_age:1;
 328         u8 is_static:1;
 329 };
 330
 331 static inline void b53_arl_to_entry(struct b53_arl_entry *ent,
 332                                     u64 mac_vid, u32 fwd_entry)
 333 {
 334         memset(ent, 0, sizeof(*ent));
 335         ent->port = fwd_entry & ARLTBL_DATA_PORT_ID_MASK;
 336         ent->is_valid = !!(fwd_entry & ARLTBL_VALID);
 337         ent->is_age = !!(fwd_entry & ARLTBL_AGE);
 338         ent->is_static = !!(fwd_entry & ARLTBL_STATIC);
 339         u64_to_ether_addr(mac_vid, ent->mac);
 340         ent->vid = mac_vid >> ARLTBL_VID_S;
 341 }
 342
 343 static inline void b53_arl_from_entry(u64 *mac_vid, u32 *fwd_entry,
 344                                       const struct b53_arl_entry *ent)
 345 {
 346         *mac_vid = ether_addr_to_u64(ent->mac);
 347         *mac_vid |= (u64)(ent->vid & ARLTBL_VID_MASK) << ARLTBL_VID_S;
 348         *fwd_entry = ent->port & ARLTBL_DATA_PORT_ID_MASK;
 349         if (ent->is_valid)
 350                 *fwd_entry |= ARLTBL_VALID;
 351         if (ent->is_static)
 352                 *fwd_entry |= ARLTBL_STATIC;
 353         if (ent->is_age)
 354                 *fwd_entry |= ARLTBL_AGE;
 355 }
 356
 357 #ifdef CONFIG_BCM47XX
 358
 359 #include <linux/bcm47xx_nvram.h>
 360 #include <bcm47xx_board.h>
 361 static inline int b53_switch_get_reset_gpio(struct b53_device *dev)
 362 {
 363         enum bcm47xx_board board = bcm47xx_board_get();
 364
 365         switch (board) {
 366         case BCM47XX_BOARD_LINKSYS_WRT300NV11:
 367         case BCM47XX_BOARD_LINKSYS_WRT310NV1:
 368                 return 8;
 369         default:
 370                 return bcm47xx_nvram_gpio_pin("robo_reset");
 371         }
 372 }
 373 #else
 374 static inline int b53_switch_get_reset_gpio(struct b53_device *dev)
 375 {
 376         return -ENOENT;
 377 }
 378 #endif
 379
 380 /* Exported functions towards other drivers */
 381 void b53_get_strings(struct dsa_switch *ds, int port, uint8_t *data);
 382 void b53_get_ethtool_stats(struct dsa_switch *ds, int port, uint64_t *data);
 383 int b53_get_sset_count(struct dsa_switch *ds);
 384 int b53_br_join(struct dsa_switch *ds, int port, struct net_device *bridge);
 385 void b53_br_leave(struct dsa_switch *ds, int port, struct net_device *bridge);
 386 void b53_br_set_stp_state(struct dsa_switch *ds, int port, u8 state);
 387 void b53_br_fast_age(struct dsa_switch *ds, int port);
 388 int b53_vlan_filtering(struct dsa_switch *ds, int port, bool vlan_filtering);
 389 int b53_vlan_prepare(struct dsa_switch *ds, int port,
 390                      const struct switchdev_obj_port_vlan *vlan,
 391                      struct switchdev_trans *trans);
 392 void b53_vlan_add(struct dsa_switch *ds, int port,
 393                   const struct switchdev_obj_port_vlan *vlan,
 394                   struct switchdev_trans *trans);
 395 int b53_vlan_del(struct dsa_switch *ds, int port,
 396                  const struct switchdev_obj_port_vlan *vlan);
 397 int b53_fdb_add(struct dsa_switch *ds, int port,
 398                 const unsigned char *addr, u16 vid);
 399 int b53_fdb_del(struct dsa_switch *ds, int port,
 400                 const unsigned char *addr, u16 vid);
 401 int b53_fdb_dump(struct dsa_switch *ds, int port,
 402                  dsa_fdb_dump_cb_t *cb, void *data);
 403 int b53_mirror_add(struct dsa_switch *ds, int port,
 404                    struct dsa_mall_mirror_tc_entry *mirror, bool ingress);
 405 void b53_mirror_del(struct dsa_switch *ds, int port,
 406                     struct dsa_mall_mirror_tc_entry *mirror);
 407
 408 #endif