drivers/net/dsa/mv88e6xxx/chip.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * Marvell 88E6xxx Ethernet switch single-chip definition
   4  *
   5  * Copyright (c) 2008 Marvell Semiconductor
   6  */
   7
   8 #ifndef _MV88E6XXX_CHIP_H
   9 #define _MV88E6XXX_CHIP_H
  10
  11 #include <linux/idr.h>
  12 #include <linux/if_vlan.h>
  13 #include <linux/irq.h>
  14 #include <linux/gpio/consumer.h>
  15 #include <linux/kthread.h>
  16 #include <linux/phy.h>
  17 #include <linux/ptp_clock_kernel.h>
  18 #include <linux/timecounter.h>
  19 #include <net/dsa.h>
  20
  21 #define EDSA_HLEN               8
  22 #define MV88E6XXX_N_FID         4096
  23
  24 /* PVT limits for 4-bit port and 5-bit switch */
  25 #define MV88E6XXX_MAX_PVT_SWITCHES      32
  26 #define MV88E6XXX_MAX_PVT_PORTS         16
  27 #define MV88E6XXX_MAX_PVT_ENTRIES       \
  28         (MV88E6XXX_MAX_PVT_SWITCHES * MV88E6XXX_MAX_PVT_PORTS)
  29
  30 #define MV88E6XXX_MAX_GPIO      16
  31
  32 enum mv88e6xxx_egress_mode {
  33         MV88E6XXX_EGRESS_MODE_UNMODIFIED,
  34         MV88E6XXX_EGRESS_MODE_UNTAGGED,
  35         MV88E6XXX_EGRESS_MODE_TAGGED,
  36         MV88E6XXX_EGRESS_MODE_ETHERTYPE,
  37 };
  38
  39 enum mv88e6xxx_egress_direction {
  40         MV88E6XXX_EGRESS_DIR_INGRESS,
  41         MV88E6XXX_EGRESS_DIR_EGRESS,
  42 };
  43
  44 enum mv88e6xxx_frame_mode {
  45         MV88E6XXX_FRAME_MODE_NORMAL,
  46         MV88E6XXX_FRAME_MODE_DSA,
  47         MV88E6XXX_FRAME_MODE_PROVIDER,
  48         MV88E6XXX_FRAME_MODE_ETHERTYPE,
  49 };
  50
  51 /* List of supported models */
  52 enum mv88e6xxx_model {
  53         MV88E6085,
  54         MV88E6095,
  55         MV88E6097,
  56         MV88E6123,
  57         MV88E6131,
  58         MV88E6141,
  59         MV88E6161,
  60         MV88E6165,
  61         MV88E6171,
  62         MV88E6172,
  63         MV88E6175,
  64         MV88E6176,
  65         MV88E6185,
  66         MV88E6190,
  67         MV88E6190X,
  68         MV88E6191,
  69         MV88E6191X,
  70         MV88E6193X,
  71         MV88E6220,
  72         MV88E6240,
  73         MV88E6250,
  74         MV88E6290,
  75         MV88E6320,
  76         MV88E6321,
  77         MV88E6341,
  78         MV88E6350,
  79         MV88E6351,
  80         MV88E6352,
  81         MV88E6390,
  82         MV88E6390X,
  83         MV88E6393X,
  84 };
  85
  86 enum mv88e6xxx_family {
  87         MV88E6XXX_FAMILY_NONE,
  88         MV88E6XXX_FAMILY_6065,  /* 6031 6035 6061 6065 */
  89         MV88E6XXX_FAMILY_6095,  /* 6092 6095 */
  90         MV88E6XXX_FAMILY_6097,  /* 6046 6085 6096 6097 */
  91         MV88E6XXX_FAMILY_6165,  /* 6123 6161 6165 */
  92         MV88E6XXX_FAMILY_6185,  /* 6108 6121 6122 6131 6152 6155 6182 6185 */
  93         MV88E6XXX_FAMILY_6250,  /* 6220 6250 */
  94         MV88E6XXX_FAMILY_6320,  /* 6320 6321 */
  95         MV88E6XXX_FAMILY_6341,  /* 6141 6341 */
  96         MV88E6XXX_FAMILY_6351,  /* 6171 6175 6350 6351 */
  97         MV88E6XXX_FAMILY_6352,  /* 6172 6176 6240 6352 */
  98         MV88E6XXX_FAMILY_6390,  /* 6190 6190X 6191 6290 6390 6390X */
  99         MV88E6XXX_FAMILY_6393,  /* 6191X 6193X 6393X */
 100 };
 101
 102 /**
 103  * enum mv88e6xxx_edsa_support - Ethertype DSA tag support level
 104  * @MV88E6XXX_EDSA_UNSUPPORTED:  Device has no support for EDSA tags
 105  * @MV88E6XXX_EDSA_UNDOCUMENTED: Documentation indicates that
 106  *                               egressing FORWARD frames with an EDSA
 107  *                               tag is reserved for future use, but
 108  *                               empirical data shows that this mode
 109  *                               is supported.
 110  * @MV88E6XXX_EDSA_SUPPORTED:    EDSA tags are fully supported.
 111  */
 112 enum mv88e6xxx_edsa_support {
 113         MV88E6XXX_EDSA_UNSUPPORTED = 0,
 114         MV88E6XXX_EDSA_UNDOCUMENTED,
 115         MV88E6XXX_EDSA_SUPPORTED,
 116 };
 117
 118 struct mv88e6xxx_ops;
 119
 120 struct mv88e6xxx_info {
 121         enum mv88e6xxx_family family;
 122         u16 prod_num;
 123         const char *name;
 124         unsigned int num_databases;
 125         unsigned int num_macs;
 126         unsigned int num_ports;
 127         unsigned int num_internal_phys;
 128         unsigned int num_gpio;
 129         unsigned int max_vid;
 130         unsigned int port_base_addr;
 131         unsigned int phy_base_addr;
 132         unsigned int global1_addr;
 133         unsigned int global2_addr;
 134         unsigned int age_time_coeff;
 135         unsigned int g1_irqs;
 136         unsigned int g2_irqs;
 137         bool pvt;
 138
 139         /* Mark certain ports as invalid. This is required for example for the
 140          * MV88E6220 (which is in general a MV88E6250 with 7 ports) but the
 141          * ports 2-4 are not routet to pins.
 142          */
 143         unsigned int invalid_port_mask;
 144         /* Multi-chip Addressing Mode.
 145          * Some chips respond to only 2 registers of its own SMI device address
 146          * when it is non-zero, and use indirect access to internal registers.
 147          */
 148         bool multi_chip;
 149         /* Dual-chip Addressing Mode
 150          * Some chips respond to only half of the 32 SMI addresses,
 151          * allowing two to coexist on the same SMI interface.
 152          */
 153         bool dual_chip;
 154
 155         enum mv88e6xxx_edsa_support edsa_support;
 156
 157         /* Mask for FromPort and ToPort value of PortVec used in ATU Move
 158          * operation. 0 means that the ATU Move operation is not supported.
 159          */
 160         u8 atu_move_port_mask;
 161         const struct mv88e6xxx_ops *ops;
 162
 163         /* Supports PTP */
 164         bool ptp_support;
 165 };
 166
 167 struct mv88e6xxx_atu_entry {
 168         u8      state;
 169         bool    trunk;
 170         u16     portvec;
 171         u8      mac[ETH_ALEN];
 172 };
 173
 174 struct mv88e6xxx_vtu_entry {
 175         u16     vid;
 176         u16     fid;
 177         u8      sid;
 178         bool    valid;
 179         u8      member[DSA_MAX_PORTS];
 180         u8      state[DSA_MAX_PORTS];
 181 };
 182
 183 struct mv88e6xxx_bus_ops;
 184 struct mv88e6xxx_irq_ops;
 185 struct mv88e6xxx_gpio_ops;
 186 struct mv88e6xxx_avb_ops;
 187 struct mv88e6xxx_ptp_ops;
 188
 189 struct mv88e6xxx_irq {
 190         u16 masked;
 191         struct irq_chip chip;
 192         struct irq_domain *domain;
 193         int nirqs;
 194 };
 195
 196 /* state flags for mv88e6xxx_port_hwtstamp::state */
 197 enum {
 198         MV88E6XXX_HWTSTAMP_ENABLED,
 199         MV88E6XXX_HWTSTAMP_TX_IN_PROGRESS,
 200 };
 201
 202 struct mv88e6xxx_port_hwtstamp {
 203         /* Port index */
 204         int port_id;
 205
 206         /* Timestamping state */
 207         unsigned long state;
 208
 209         /* Resources for receive timestamping */
 210         struct sk_buff_head rx_queue;
 211         struct sk_buff_head rx_queue2;
 212
 213         /* Resources for transmit timestamping */
 214         unsigned long tx_tstamp_start;
 215         struct sk_buff *tx_skb;
 216         u16 tx_seq_id;
 217
 218         /* Current timestamp configuration */
 219         struct hwtstamp_config tstamp_config;
 220 };
 221
 222 enum mv88e6xxx_policy_mapping {
 223         MV88E6XXX_POLICY_MAPPING_DA,
 224         MV88E6XXX_POLICY_MAPPING_SA,
 225         MV88E6XXX_POLICY_MAPPING_VTU,
 226         MV88E6XXX_POLICY_MAPPING_ETYPE,
 227         MV88E6XXX_POLICY_MAPPING_PPPOE,
 228         MV88E6XXX_POLICY_MAPPING_VBAS,
 229         MV88E6XXX_POLICY_MAPPING_OPT82,
 230         MV88E6XXX_POLICY_MAPPING_UDP,
 231 };
 232
 233 enum mv88e6xxx_policy_action {
 234         MV88E6XXX_POLICY_ACTION_NORMAL,
 235         MV88E6XXX_POLICY_ACTION_MIRROR,
 236         MV88E6XXX_POLICY_ACTION_TRAP,
 237         MV88E6XXX_POLICY_ACTION_DISCARD,
 238 };
 239
 240 struct mv88e6xxx_policy {
 241         enum mv88e6xxx_policy_mapping mapping;
 242         enum mv88e6xxx_policy_action action;
 243         struct ethtool_rx_flow_spec fs;
 244         u8 addr[ETH_ALEN];
 245         int port;
 246         u16 vid;
 247 };
 248
 249 struct mv88e6xxx_port {
 250         struct mv88e6xxx_chip *chip;
 251         int port;
 252         u64 serdes_stats[2];
 253         u64 atu_member_violation;
 254         u64 atu_miss_violation;
 255         u64 atu_full_violation;
 256         u64 vtu_member_violation;
 257         u64 vtu_miss_violation;
 258         phy_interface_t interface;
 259         u8 cmode;
 260         bool mirror_ingress;
 261         bool mirror_egress;
 262         unsigned int serdes_irq;
 263         char serdes_irq_name[64];
 264         struct devlink_region *region;
 265 };
 266
 267 enum mv88e6xxx_region_id {
 268         MV88E6XXX_REGION_GLOBAL1 = 0,
 269         MV88E6XXX_REGION_GLOBAL2,
 270         MV88E6XXX_REGION_ATU,
 271         MV88E6XXX_REGION_VTU,
 272         MV88E6XXX_REGION_PVT,
 273
 274         _MV88E6XXX_REGION_MAX,
 275 };
 276
 277 struct mv88e6xxx_region_priv {
 278         enum mv88e6xxx_region_id id;
 279 };
 280
 281 struct mv88e6xxx_chip {
 282         const struct mv88e6xxx_info *info;
 283
 284         /* Currently configured tagging protocol */
 285         enum dsa_tag_protocol tag_protocol;
 286
 287         /* The dsa_switch this private structure is related to */
 288         struct dsa_switch *ds;
 289
 290         /* The device this structure is associated to */
 291         struct device *dev;
 292
 293         /* This mutex protects the access to the switch registers */
 294         struct mutex reg_lock;
 295
 296         /* The MII bus and the address on the bus that is used to
 297          * communication with the switch
 298          */
 299         const struct mv88e6xxx_bus_ops *smi_ops;
 300         struct mii_bus *bus;
 301         int sw_addr;
 302
 303         /* Handles automatic disabling and re-enabling of the PHY
 304          * polling unit.
 305          */
 306         const struct mv88e6xxx_bus_ops *phy_ops;
 307         struct mutex            ppu_mutex;
 308         int                     ppu_disabled;
 309         struct work_struct      ppu_work;
 310         struct timer_list       ppu_timer;
 311
 312         /* This mutex serialises access to the statistics unit.
 313          * Hold this mutex over snapshot + dump sequences.
 314          */
 315         struct mutex    stats_mutex;
 316
 317         /* A switch may have a GPIO line tied to its reset pin. Parse
 318          * this from the device tree, and use it before performing
 319          * switch soft reset.
 320          */
 321         struct gpio_desc *reset;
 322
 323         /* set to size of eeprom if supported by the switch */
 324         u32 eeprom_len;
 325
 326         /* List of mdio busses */
 327         struct list_head mdios;
 328
 329         /* Policy Control List IDs and rules */
 330         struct idr policies;
 331
 332         /* There can be two interrupt controllers, which are chained
 333          * off a GPIO as interrupt source
 334          */
 335         struct mv88e6xxx_irq g1_irq;
 336         struct mv88e6xxx_irq g2_irq;
 337         int irq;
 338         char irq_name[64];
 339         int device_irq;
 340         char device_irq_name[64];
 341         int watchdog_irq;
 342         char watchdog_irq_name[64];
 343
 344         int atu_prob_irq;
 345         char atu_prob_irq_name[64];
 346         int vtu_prob_irq;
 347         char vtu_prob_irq_name[64];
 348         struct kthread_worker *kworker;
 349         struct kthread_delayed_work irq_poll_work;
 350
 351         /* GPIO resources */
 352         u8 gpio_data[2];
 353
 354         /* This cyclecounter abstracts the switch PTP time.
 355          * reg_lock must be held for any operation that read()s.
 356          */
 357         struct cyclecounter     tstamp_cc;
 358         struct timecounter      tstamp_tc;
 359         struct delayed_work     overflow_work;
 360
 361         struct ptp_clock        *ptp_clock;
 362         struct ptp_clock_info   ptp_clock_info;
 363         struct delayed_work     tai_event_work;
 364         struct ptp_pin_desc     pin_config[MV88E6XXX_MAX_GPIO];
 365         u16 trig_config;
 366         u16 evcap_config;
 367         u16 enable_count;
 368
 369         /* Current ingress and egress monitor ports */
 370         int egress_dest_port;
 371         int ingress_dest_port;
 372
 373         /* Per-port timestamping resources. */
 374         struct mv88e6xxx_port_hwtstamp port_hwtstamp[DSA_MAX_PORTS];
 375
 376         /* Array of port structures. */
 377         struct mv88e6xxx_port ports[DSA_MAX_PORTS];
 378
 379         /* devlink regions */
 380         struct devlink_region *regions[_MV88E6XXX_REGION_MAX];
 381 };
 382
 383 struct mv88e6xxx_bus_ops {
 384         int (*read)(struct mv88e6xxx_chip *chip, int addr, int reg, u16 *val);
 385         int (*write)(struct mv88e6xxx_chip *chip, int addr, int reg, u16 val);
 386 };
 387
 388 struct mv88e6xxx_mdio_bus {
 389         struct mii_bus *bus;
 390         struct mv88e6xxx_chip *chip;
 391         struct list_head list;
 392         bool external;
 393 };
 394
 395 struct mv88e6xxx_ops {
 396         /* Switch Setup Errata, called early in the switch setup to
 397          * allow any errata actions to be performed
 398          */
 399         int (*setup_errata)(struct mv88e6xxx_chip *chip);
 400
 401         int (*ieee_pri_map)(struct mv88e6xxx_chip *chip);
 402         int (*ip_pri_map)(struct mv88e6xxx_chip *chip);
 403
 404         /* Ingress Rate Limit unit (IRL) operations */
 405         int (*irl_init_all)(struct mv88e6xxx_chip *chip, int port);
 406
 407         int (*get_eeprom)(struct mv88e6xxx_chip *chip,
 408                           struct ethtool_eeprom *eeprom, u8 *data);
 409         int (*set_eeprom)(struct mv88e6xxx_chip *chip,
 410                           struct ethtool_eeprom *eeprom, u8 *data);
 411
 412         int (*set_switch_mac)(struct mv88e6xxx_chip *chip, u8 *addr);
 413
 414         int (*phy_read)(struct mv88e6xxx_chip *chip,
 415                         struct mii_bus *bus,
 416                         int addr, int reg, u16 *val);
 417         int (*phy_write)(struct mv88e6xxx_chip *chip,
 418                          struct mii_bus *bus,
 419                          int addr, int reg, u16 val);
 420
 421         /* Priority Override Table operations */
 422         int (*pot_clear)(struct mv88e6xxx_chip *chip);
 423
 424         /* PHY Polling Unit (PPU) operations */
 425         int (*ppu_enable)(struct mv88e6xxx_chip *chip);
 426         int (*ppu_disable)(struct mv88e6xxx_chip *chip);
 427
 428         /* Switch Software Reset */
 429         int (*reset)(struct mv88e6xxx_chip *chip);
 430
 431         /* RGMII Receive/Transmit Timing Control
 432          * Add delay on PHY_INTERFACE_MODE_RGMII_*ID, no delay otherwise.
 433          */
 434         int (*port_set_rgmii_delay)(struct mv88e6xxx_chip *chip, int port,
 435                                     phy_interface_t mode);
 436
 437 #define LINK_FORCED_DOWN        0
 438 #define LINK_FORCED_UP          1
 439 #define LINK_UNFORCED           -2
 440
 441         /* Port's MAC link state
 442          * Use LINK_FORCED_UP or LINK_FORCED_DOWN to force link up or down,
 443          * or LINK_UNFORCED for normal link detection.
 444          */
 445         int (*port_set_link)(struct mv88e6xxx_chip *chip, int port, int link);
 446
 447         /* Synchronise the port link state with that of the SERDES
 448          */
 449         int (*port_sync_link)(struct mv88e6xxx_chip *chip, int port, unsigned int mode, bool isup);
 450
 451 #define PAUSE_ON                1
 452 #define PAUSE_OFF               0
 453
 454         /* Enable/disable sending Pause */
 455         int (*port_set_pause)(struct mv88e6xxx_chip *chip, int port,
 456                               int pause);
 457
 458 #define SPEED_MAX               INT_MAX
 459 #define SPEED_UNFORCED          -2
 460 #define DUPLEX_UNFORCED         -2
 461
 462         /* Port's MAC speed (in Mbps) and MAC duplex mode
 463          *
 464          * Depending on the chip, 10, 100, 200, 1000, 2500, 10000 are valid.
 465          * Use SPEED_UNFORCED for normal detection, SPEED_MAX for max value.
 466          *
 467          * Use DUPLEX_HALF or DUPLEX_FULL to force half or full duplex,
 468          * or DUPLEX_UNFORCED for normal duplex detection.
 469          */
 470         int (*port_set_speed_duplex)(struct mv88e6xxx_chip *chip, int port,
 471                                      int speed, int duplex);
 472
 473         /* What interface mode should be used for maximum speed? */
 474         phy_interface_t (*port_max_speed_mode)(int port);
 475
 476         int (*port_tag_remap)(struct mv88e6xxx_chip *chip, int port);
 477
 478         int (*port_set_policy)(struct mv88e6xxx_chip *chip, int port,
 479                                enum mv88e6xxx_policy_mapping mapping,
 480                                enum mv88e6xxx_policy_action action);
 481
 482         int (*port_set_frame_mode)(struct mv88e6xxx_chip *chip, int port,
 483                                    enum mv88e6xxx_frame_mode mode);
 484         int (*port_set_ucast_flood)(struct mv88e6xxx_chip *chip, int port,
 485                                     bool unicast);
 486         int (*port_set_mcast_flood)(struct mv88e6xxx_chip *chip, int port,
 487                                     bool multicast);
 488         int (*port_set_ether_type)(struct mv88e6xxx_chip *chip, int port,
 489                                    u16 etype);
 490         int (*port_set_jumbo_size)(struct mv88e6xxx_chip *chip, int port,
 491                                    size_t size);
 492
 493         int (*port_egress_rate_limiting)(struct mv88e6xxx_chip *chip, int port);
 494         int (*port_pause_limit)(struct mv88e6xxx_chip *chip, int port, u8 in,
 495                                 u8 out);
 496         int (*port_disable_learn_limit)(struct mv88e6xxx_chip *chip, int port);
 497         int (*port_disable_pri_override)(struct mv88e6xxx_chip *chip, int port);
 498         int (*port_setup_message_port)(struct mv88e6xxx_chip *chip, int port);
 499
 500         /* CMODE control what PHY mode the MAC will use, eg. SGMII, RGMII, etc.
 501          * Some chips allow this to be configured on specific ports.
 502          */
 503         int (*port_set_cmode)(struct mv88e6xxx_chip *chip, int port,
 504                               phy_interface_t mode);
 505         int (*port_get_cmode)(struct mv88e6xxx_chip *chip, int port, u8 *cmode);
 506
 507         /* Some devices have a per port register indicating what is
 508          * the upstream port this port should forward to.
 509          */
 510         int (*port_set_upstream_port)(struct mv88e6xxx_chip *chip, int port,
 511                                       int upstream_port);
 512
 513         /* Snapshot the statistics for a port. The statistics can then
 514          * be read back a leisure but still with a consistent view.
 515          */
 516         int (*stats_snapshot)(struct mv88e6xxx_chip *chip, int port);
 517
 518         /* Set the histogram mode for statistics, when the control registers
 519          * are separated out of the STATS_OP register.
 520          */
 521         int (*stats_set_histogram)(struct mv88e6xxx_chip *chip);
 522
 523         /* Return the number of strings describing statistics */
 524         int (*stats_get_sset_count)(struct mv88e6xxx_chip *chip);
 525         int (*stats_get_strings)(struct mv88e6xxx_chip *chip,  uint8_t *data);
 526         int (*stats_get_stats)(struct mv88e6xxx_chip *chip,  int port,
 527                                uint64_t *data);
 528         int (*set_cpu_port)(struct mv88e6xxx_chip *chip, int port);
 529         int (*set_egress_port)(struct mv88e6xxx_chip *chip,
 530                                enum mv88e6xxx_egress_direction direction,
 531                                int port);
 532
 533 #define MV88E6XXX_CASCADE_PORT_NONE             0xe
 534 #define MV88E6XXX_CASCADE_PORT_MULTIPLE         0xf
 535
 536         int (*set_cascade_port)(struct mv88e6xxx_chip *chip, int port);
 537
 538         const struct mv88e6xxx_irq_ops *watchdog_ops;
 539
 540         int (*mgmt_rsvd2cpu)(struct mv88e6xxx_chip *chip);
 541
 542         /* Power on/off a SERDES interface */
 543         int (*serdes_power)(struct mv88e6xxx_chip *chip, int port, int lane,
 544                             bool up);
 545
 546         /* SERDES lane mapping */
 547         int (*serdes_get_lane)(struct mv88e6xxx_chip *chip, int port);
 548
 549         int (*serdes_pcs_get_state)(struct mv88e6xxx_chip *chip, int port,
 550                                     int lane, struct phylink_link_state *state);
 551         int (*serdes_pcs_config)(struct mv88e6xxx_chip *chip, int port,
 552                                  int lane, unsigned int mode,
 553                                  phy_interface_t interface,
 554                                  const unsigned long *advertise);
 555         int (*serdes_pcs_an_restart)(struct mv88e6xxx_chip *chip, int port,
 556                                      int lane);
 557         int (*serdes_pcs_link_up)(struct mv88e6xxx_chip *chip, int port,
 558                                   int lane, int speed, int duplex);
 559
 560         /* SERDES interrupt handling */
 561         unsigned int (*serdes_irq_mapping)(struct mv88e6xxx_chip *chip,
 562                                            int port);
 563         int (*serdes_irq_enable)(struct mv88e6xxx_chip *chip, int port, int lane,
 564                                  bool enable);
 565         irqreturn_t (*serdes_irq_status)(struct mv88e6xxx_chip *chip, int port,
 566                                          int lane);
 567
 568         /* Statistics from the SERDES interface */
 569         int (*serdes_get_sset_count)(struct mv88e6xxx_chip *chip, int port);
 570         int (*serdes_get_strings)(struct mv88e6xxx_chip *chip,  int port,
 571                                   uint8_t *data);
 572         int (*serdes_get_stats)(struct mv88e6xxx_chip *chip,  int port,
 573                                 uint64_t *data);
 574
 575         /* SERDES registers for ethtool */
 576         int (*serdes_get_regs_len)(struct mv88e6xxx_chip *chip,  int port);
 577         void (*serdes_get_regs)(struct mv88e6xxx_chip *chip, int port,
 578                                 void *_p);
 579
 580         /* Address Translation Unit operations */
 581         int (*atu_get_hash)(struct mv88e6xxx_chip *chip, u8 *hash);
 582         int (*atu_set_hash)(struct mv88e6xxx_chip *chip, u8 hash);
 583
 584         /* VLAN Translation Unit operations */
 585         int (*vtu_getnext)(struct mv88e6xxx_chip *chip,
 586                            struct mv88e6xxx_vtu_entry *entry);
 587         int (*vtu_loadpurge)(struct mv88e6xxx_chip *chip,
 588                              struct mv88e6xxx_vtu_entry *entry);
 589
 590         /* GPIO operations */
 591         const struct mv88e6xxx_gpio_ops *gpio_ops;
 592
 593         /* Interface to the AVB/PTP registers */
 594         const struct mv88e6xxx_avb_ops *avb_ops;
 595
 596         /* Remote Management Unit operations */
 597         int (*rmu_disable)(struct mv88e6xxx_chip *chip);
 598
 599         /* Precision Time Protocol operations */
 600         const struct mv88e6xxx_ptp_ops *ptp_ops;
 601
 602         /* Phylink */
 603         void (*phylink_validate)(struct mv88e6xxx_chip *chip, int port,
 604                                  unsigned long *mask,
 605                                  struct phylink_link_state *state);
 606
 607         /* Max Frame Size */
 608         int (*set_max_frame_size)(struct mv88e6xxx_chip *chip, int mtu);
 609 };
 610
 611 struct mv88e6xxx_irq_ops {
 612         /* Action to be performed when the interrupt happens */
 613         int (*irq_action)(struct mv88e6xxx_chip *chip, int irq);
 614         /* Setup the hardware to generate the interrupt */
 615         int (*irq_setup)(struct mv88e6xxx_chip *chip);
 616         /* Reset the hardware to stop generating the interrupt */
 617         void (*irq_free)(struct mv88e6xxx_chip *chip);
 618 };
 619
 620 struct mv88e6xxx_gpio_ops {
 621         /* Get/set data on GPIO pin */
 622         int (*get_data)(struct mv88e6xxx_chip *chip, unsigned int pin);
 623         int (*set_data)(struct mv88e6xxx_chip *chip, unsigned int pin,
 624                         int value);
 625
 626         /* get/set GPIO direction */
 627         int (*get_dir)(struct mv88e6xxx_chip *chip, unsigned int pin);
 628         int (*set_dir)(struct mv88e6xxx_chip *chip, unsigned int pin,
 629                        bool input);
 630
 631         /* get/set GPIO pin control */
 632         int (*get_pctl)(struct mv88e6xxx_chip *chip, unsigned int pin,
 633                         int *func);
 634         int (*set_pctl)(struct mv88e6xxx_chip *chip, unsigned int pin,
 635                         int func);
 636 };
 637
 638 struct mv88e6xxx_avb_ops {
 639         /* Access port-scoped Precision Time Protocol registers */
 640         int (*port_ptp_read)(struct mv88e6xxx_chip *chip, int port, int addr,
 641                              u16 *data, int len);
 642         int (*port_ptp_write)(struct mv88e6xxx_chip *chip, int port, int addr,
 643                               u16 data);
 644
 645         /* Access global Precision Time Protocol registers */
 646         int (*ptp_read)(struct mv88e6xxx_chip *chip, int addr, u16 *data,
 647                         int len);
 648         int (*ptp_write)(struct mv88e6xxx_chip *chip, int addr, u16 data);
 649
 650         /* Access global Time Application Interface registers */
 651         int (*tai_read)(struct mv88e6xxx_chip *chip, int addr, u16 *data,
 652                         int len);
 653         int (*tai_write)(struct mv88e6xxx_chip *chip, int addr, u16 data);
 654 };
 655
 656 struct mv88e6xxx_ptp_ops {
 657         u64 (*clock_read)(const struct cyclecounter *cc);
 658         int (*ptp_enable)(struct ptp_clock_info *ptp,
 659                           struct ptp_clock_request *rq, int on);
 660         int (*ptp_verify)(struct ptp_clock_info *ptp, unsigned int pin,
 661                           enum ptp_pin_function func, unsigned int chan);
 662         void (*event_work)(struct work_struct *ugly);
 663         int (*port_enable)(struct mv88e6xxx_chip *chip, int port);
 664         int (*port_disable)(struct mv88e6xxx_chip *chip, int port);
 665         int (*global_enable)(struct mv88e6xxx_chip *chip);
 666         int (*global_disable)(struct mv88e6xxx_chip *chip);
 667         int n_ext_ts;
 668         int arr0_sts_reg;
 669         int arr1_sts_reg;
 670         int dep_sts_reg;
 671         u32 rx_filters;
 672         u32 cc_shift;
 673         u32 cc_mult;
 674         u32 cc_mult_num;
 675         u32 cc_mult_dem;
 676 };
 677
 678 #define STATS_TYPE_PORT         BIT(0)
 679 #define STATS_TYPE_BANK0        BIT(1)
 680 #define STATS_TYPE_BANK1        BIT(2)
 681
 682 struct mv88e6xxx_hw_stat {
 683         char string[ETH_GSTRING_LEN];
 684         size_t size;
 685         int reg;
 686         int type;
 687 };
 688
 689 static inline bool mv88e6xxx_has_pvt(struct mv88e6xxx_chip *chip)
 690 {
 691         return chip->info->pvt;
 692 }
 693
 694 static inline bool mv88e6xxx_has_lag(struct mv88e6xxx_chip *chip)
 695 {
 696         return !!chip->info->global2_addr;
 697 }
 698
 699 static inline unsigned int mv88e6xxx_num_databases(struct mv88e6xxx_chip *chip)
 700 {
 701         return chip->info->num_databases;
 702 }
 703
 704 static inline unsigned int mv88e6xxx_num_macs(struct  mv88e6xxx_chip *chip)
 705 {
 706         return chip->info->num_macs;
 707 }
 708
 709 static inline unsigned int mv88e6xxx_num_ports(struct mv88e6xxx_chip *chip)
 710 {
 711         return chip->info->num_ports;
 712 }
 713
 714 static inline unsigned int mv88e6xxx_max_vid(struct mv88e6xxx_chip *chip)
 715 {
 716         return chip->info->max_vid;
 717 }
 718
 719 static inline u16 mv88e6xxx_port_mask(struct mv88e6xxx_chip *chip)
 720 {
 721         return GENMASK((s32)mv88e6xxx_num_ports(chip) - 1, 0);
 722 }
 723
 724 static inline unsigned int mv88e6xxx_num_gpio(struct mv88e6xxx_chip *chip)
 725 {
 726         return chip->info->num_gpio;
 727 }
 728
 729 static inline bool mv88e6xxx_is_invalid_port(struct mv88e6xxx_chip *chip, int port)
 730 {
 731         return (chip->info->invalid_port_mask & BIT(port)) != 0;
 732 }
 733
 734 int mv88e6xxx_read(struct mv88e6xxx_chip *chip, int addr, int reg, u16 *val);
 735 int mv88e6xxx_write(struct mv88e6xxx_chip *chip, int addr, int reg, u16 val);
 736 int mv88e6xxx_wait_mask(struct mv88e6xxx_chip *chip, int addr, int reg,
 737                         u16 mask, u16 val);
 738 int mv88e6xxx_wait_bit(struct mv88e6xxx_chip *chip, int addr, int reg,
 739                        int bit, int val);
 740 struct mii_bus *mv88e6xxx_default_mdio_bus(struct mv88e6xxx_chip *chip);
 741
 742 static inline void mv88e6xxx_reg_lock(struct mv88e6xxx_chip *chip)
 743 {
 744         mutex_lock(&chip->reg_lock);
 745 }
 746
 747 static inline void mv88e6xxx_reg_unlock(struct mv88e6xxx_chip *chip)
 748 {
 749         mutex_unlock(&chip->reg_lock);
 750 }
 751
 752 int mv88e6xxx_fid_map(struct mv88e6xxx_chip *chip, unsigned long *bitmap);
 753
 754 #endif /* _MV88E6XXX_CHIP_H */