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         u16             pvid;
  95 };
  96
  97 struct b53_vlan {
  98         u16 members;
  99         u16 untag;
 100         bool valid;
 101 };
 102
 103 struct b53_device {
 104         struct dsa_switch *ds;
 105         struct b53_platform_data *pdata;
 106         const char *name;
 107
 108         struct mutex reg_mutex;
 109         struct mutex stats_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_entries;
 121
 122         /* used ports mask */
 123         u16 enabled_ports;
 124         unsigned int cpu_port;
 125
 126         /* connect specific data */
 127         u8 current_page;
 128         struct device *dev;
 129         u8 serdes_lane;
 130
 131         /* Master MDIO bus we got probed from */
 132         struct mii_bus *bus;
 133
 134         void *priv;
 135
 136         /* run time configuration */
 137         bool enable_jumbo;
 138
 139         unsigned int num_vlans;
 140         struct b53_vlan *vlans;
 141         bool vlan_enabled;
 142         unsigned int num_ports;
 143         struct b53_port *ports;
 144 };
 145
 146 #define b53_for_each_port(dev, i) \
 147         for (i = 0; i < B53_N_PORTS; i++) \
 148                 if (dev->enabled_ports & BIT(i))
 149
 150
 151 static inline int is5325(struct b53_device *dev)
 152 {
 153         return dev->chip_id == BCM5325_DEVICE_ID;
 154 }
 155
 156 static inline int is5365(struct b53_device *dev)
 157 {
 158 #ifdef CONFIG_BCM47XX
 159         return dev->chip_id == BCM5365_DEVICE_ID;
 160 #else
 161         return 0;
 162 #endif
 163 }
 164
 165 static inline int is5397_98(struct b53_device *dev)
 166 {
 167         return dev->chip_id == BCM5397_DEVICE_ID ||
 168                 dev->chip_id == BCM5398_DEVICE_ID;
 169 }
 170
 171 static inline int is539x(struct b53_device *dev)
 172 {
 173         return dev->chip_id == BCM5395_DEVICE_ID ||
 174                 dev->chip_id == BCM5397_DEVICE_ID ||
 175                 dev->chip_id == BCM5398_DEVICE_ID;
 176 }
 177
 178 static inline int is531x5(struct b53_device *dev)
 179 {
 180         return dev->chip_id == BCM53115_DEVICE_ID ||
 181                 dev->chip_id == BCM53125_DEVICE_ID ||
 182                 dev->chip_id == BCM53128_DEVICE_ID;
 183 }
 184
 185 static inline int is63xx(struct b53_device *dev)
 186 {
 187 #ifdef CONFIG_BCM63XX
 188         return dev->chip_id == BCM63XX_DEVICE_ID;
 189 #else
 190         return 0;
 191 #endif
 192 }
 193
 194 static inline int is5301x(struct b53_device *dev)
 195 {
 196         return dev->chip_id == BCM53010_DEVICE_ID ||
 197                 dev->chip_id == BCM53011_DEVICE_ID ||
 198                 dev->chip_id == BCM53012_DEVICE_ID ||
 199                 dev->chip_id == BCM53018_DEVICE_ID ||
 200                 dev->chip_id == BCM53019_DEVICE_ID;
 201 }
 202
 203 static inline int is58xx(struct b53_device *dev)
 204 {
 205         return dev->chip_id == BCM58XX_DEVICE_ID ||
 206                 dev->chip_id == BCM583XX_DEVICE_ID ||
 207                 dev->chip_id == BCM7445_DEVICE_ID ||
 208                 dev->chip_id == BCM7278_DEVICE_ID;
 209 }
 210
 211 #define B53_CPU_PORT_25 5
 212 #define B53_CPU_PORT    8
 213
 214 struct b53_device *b53_switch_alloc(struct device *base,
 215                                     const struct b53_io_ops *ops,
 216                                     void *priv);
 217
 218 int b53_switch_detect(struct b53_device *dev);
 219
 220 int b53_switch_register(struct b53_device *dev);
 221
 222 static inline void b53_switch_remove(struct b53_device *dev)
 223 {
 224         dsa_unregister_switch(dev->ds);
 225 }
 226
 227 #define b53_build_op(type_op_size, val_type)                            \
 228 static inline int b53_##type_op_size(struct b53_device *dev, u8 page,   \
 229                                      u8 reg, val_type val)              \
 230 {                                                                       \
 231         int ret;                                                        \
 232                                                                         \
 233         mutex_lock(&dev->reg_mutex);                                    \
 234         ret = dev->ops->type_op_size(dev, page, reg, val);              \
 235         mutex_unlock(&dev->reg_mutex);                                  \
 236                                                                         \
 237         return ret;                                                     \
 238 }
 239
 240 b53_build_op(read8, u8 *);
 241 b53_build_op(read16, u16 *);
 242 b53_build_op(read32, u32 *);
 243 b53_build_op(read48, u64 *);
 244 b53_build_op(read64, u64 *);
 245
 246 b53_build_op(write8, u8);
 247 b53_build_op(write16, u16);
 248 b53_build_op(write32, u32);
 249 b53_build_op(write48, u64);
 250 b53_build_op(write64, u64);
 251
 252 struct b53_arl_entry {
 253         u8 port;
 254         u8 mac[ETH_ALEN];
 255         u16 vid;
 256         u8 is_valid:1;
 257         u8 is_age:1;
 258         u8 is_static:1;
 259 };
 260
 261 static inline void b53_arl_to_entry(struct b53_arl_entry *ent,
 262                                     u64 mac_vid, u32 fwd_entry)
 263 {
 264         memset(ent, 0, sizeof(*ent));
 265         ent->port = fwd_entry & ARLTBL_DATA_PORT_ID_MASK;
 266         ent->is_valid = !!(fwd_entry & ARLTBL_VALID);
 267         ent->is_age = !!(fwd_entry & ARLTBL_AGE);
 268         ent->is_static = !!(fwd_entry & ARLTBL_STATIC);
 269         u64_to_ether_addr(mac_vid, ent->mac);
 270         ent->vid = mac_vid >> ARLTBL_VID_S;
 271 }
 272
 273 static inline void b53_arl_from_entry(u64 *mac_vid, u32 *fwd_entry,
 274                                       const struct b53_arl_entry *ent)
 275 {
 276         *mac_vid = ether_addr_to_u64(ent->mac);
 277         *mac_vid |= (u64)(ent->vid & ARLTBL_VID_MASK) << ARLTBL_VID_S;
 278         *fwd_entry = ent->port & ARLTBL_DATA_PORT_ID_MASK;
 279         if (ent->is_valid)
 280                 *fwd_entry |= ARLTBL_VALID;
 281         if (ent->is_static)
 282                 *fwd_entry |= ARLTBL_STATIC;
 283         if (ent->is_age)
 284                 *fwd_entry |= ARLTBL_AGE;
 285 }
 286
 287 #ifdef CONFIG_BCM47XX
 288
 289 #include <linux/bcm47xx_nvram.h>
 290 #include <bcm47xx_board.h>
 291 static inline int b53_switch_get_reset_gpio(struct b53_device *dev)
 292 {
 293         enum bcm47xx_board board = bcm47xx_board_get();
 294
 295         switch (board) {
 296         case BCM47XX_BOARD_LINKSYS_WRT300NV11:
 297         case BCM47XX_BOARD_LINKSYS_WRT310NV1:
 298                 return 8;
 299         default:
 300                 return bcm47xx_nvram_gpio_pin("robo_reset");
 301         }
 302 }
 303 #else
 304 static inline int b53_switch_get_reset_gpio(struct b53_device *dev)
 305 {
 306         return -ENOENT;
 307 }
 308 #endif
 309
 310 /* Exported functions towards other drivers */
 311 void b53_imp_vlan_setup(struct dsa_switch *ds, int cpu_port);
 312 int b53_configure_vlan(struct dsa_switch *ds);
 313 void b53_get_strings(struct dsa_switch *ds, int port, u32 stringset,
 314                      uint8_t *data);
 315 void b53_get_ethtool_stats(struct dsa_switch *ds, int port, uint64_t *data);
 316 int b53_get_sset_count(struct dsa_switch *ds, int port, int sset);
 317 void b53_get_ethtool_phy_stats(struct dsa_switch *ds, int port, uint64_t *data);
 318 int b53_br_join(struct dsa_switch *ds, int port, struct net_device *bridge);
 319 void b53_br_leave(struct dsa_switch *ds, int port, struct net_device *bridge);
 320 void b53_br_set_stp_state(struct dsa_switch *ds, int port, u8 state);
 321 void b53_br_fast_age(struct dsa_switch *ds, int port);
 322 void b53_port_event(struct dsa_switch *ds, int port);
 323 void b53_phylink_validate(struct dsa_switch *ds, int port,
 324                           unsigned long *supported,
 325                           struct phylink_link_state *state);
 326 int b53_phylink_mac_link_state(struct dsa_switch *ds, int port,
 327                                struct phylink_link_state *state);
 328 void b53_phylink_mac_config(struct dsa_switch *ds, int port,
 329                             unsigned int mode,
 330                             const struct phylink_link_state *state);
 331 void b53_phylink_mac_an_restart(struct dsa_switch *ds, int port);
 332 void b53_phylink_mac_link_down(struct dsa_switch *ds, int port,
 333                                unsigned int mode,
 334                                phy_interface_t interface);
 335 void b53_phylink_mac_link_up(struct dsa_switch *ds, int port,
 336                              unsigned int mode,
 337                              phy_interface_t interface,
 338                              struct phy_device *phydev);
 339 int b53_vlan_filtering(struct dsa_switch *ds, int port, bool vlan_filtering);
 340 int b53_vlan_prepare(struct dsa_switch *ds, int port,
 341                      const struct switchdev_obj_port_vlan *vlan);
 342 void b53_vlan_add(struct dsa_switch *ds, int port,
 343                   const struct switchdev_obj_port_vlan *vlan);
 344 int b53_vlan_del(struct dsa_switch *ds, int port,
 345                  const struct switchdev_obj_port_vlan *vlan);
 346 int b53_fdb_add(struct dsa_switch *ds, int port,
 347                 const unsigned char *addr, u16 vid);
 348 int b53_fdb_del(struct dsa_switch *ds, int port,
 349                 const unsigned char *addr, u16 vid);
 350 int b53_fdb_dump(struct dsa_switch *ds, int port,
 351                  dsa_fdb_dump_cb_t *cb, void *data);
 352 int b53_mirror_add(struct dsa_switch *ds, int port,
 353                    struct dsa_mall_mirror_tc_entry *mirror, bool ingress);
 354 enum dsa_tag_protocol b53_get_tag_protocol(struct dsa_switch *ds, int port);
 355 void b53_mirror_del(struct dsa_switch *ds, int port,
 356                     struct dsa_mall_mirror_tc_entry *mirror);
 357 int b53_enable_port(struct dsa_switch *ds, int port, struct phy_device *phy);
 358 void b53_disable_port(struct dsa_switch *ds, int port);
 359 void b53_brcm_hdr_setup(struct dsa_switch *ds, int port);
 360 void b53_eee_enable_set(struct dsa_switch *ds, int port, bool enable);
 361 int b53_eee_init(struct dsa_switch *ds, int port, struct phy_device *phy);
 362 int b53_get_mac_eee(struct dsa_switch *ds, int port, struct ethtool_eee *e);
 363 int b53_set_mac_eee(struct dsa_switch *ds, int port, struct ethtool_eee *e);
 364
 365 #endif