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