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