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