drivers/net/cxgbe/base/common.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2014-2017 Chelsio Communications.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Chelsio Communications nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef __CHELSIO_COMMON_H
  35 #define __CHELSIO_COMMON_H
  36
  37 #include "cxgbe_compat.h"
  38 #include "t4_hw.h"
  39 #include "t4vf_hw.h"
  40 #include "t4_chip_type.h"
  41 #include "t4fw_interface.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 #define CXGBE_PAGE_SIZE RTE_PGSIZE_4K
  48
  49 enum {
  50         MAX_NPORTS     = 4,     /* max # of ports */
  51 };
  52
  53 enum {
  54         T5_REGMAP_SIZE = (332 * 1024),
  55 };
  56
  57 enum {
  58         MEMWIN0_APERTURE = 2048,
  59         MEMWIN0_BASE     = 0x1b800,
  60 };
  61
  62 enum dev_master { MASTER_CANT, MASTER_MAY, MASTER_MUST };
  63
  64 enum dev_state { DEV_STATE_UNINIT, DEV_STATE_INIT, DEV_STATE_ERR };
  65
  66 enum cc_pause {
  67         PAUSE_RX      = 1 << 0,
  68         PAUSE_TX      = 1 << 1,
  69         PAUSE_AUTONEG = 1 << 2
  70 };
  71
  72 enum cc_fec {
  73         FEC_AUTO     = 1 << 0,    /* IEEE 802.3 "automatic" */
  74         FEC_RS       = 1 << 1,    /* Reed-Solomon */
  75         FEC_BASER_RS = 1 << 2,    /* BaseR/Reed-Solomon */
  76 };
  77
  78 struct port_stats {
  79         u64 tx_octets;            /* total # of octets in good frames */
  80         u64 tx_frames;            /* all good frames */
  81         u64 tx_bcast_frames;      /* all broadcast frames */
  82         u64 tx_mcast_frames;      /* all multicast frames */
  83         u64 tx_ucast_frames;      /* all unicast frames */
  84         u64 tx_error_frames;      /* all error frames */
  85
  86         u64 tx_frames_64;         /* # of Tx frames in a particular range */
  87         u64 tx_frames_65_127;
  88         u64 tx_frames_128_255;
  89         u64 tx_frames_256_511;
  90         u64 tx_frames_512_1023;
  91         u64 tx_frames_1024_1518;
  92         u64 tx_frames_1519_max;
  93
  94         u64 tx_drop;              /* # of dropped Tx frames */
  95         u64 tx_pause;             /* # of transmitted pause frames */
  96         u64 tx_ppp0;              /* # of transmitted PPP prio 0 frames */
  97         u64 tx_ppp1;              /* # of transmitted PPP prio 1 frames */
  98         u64 tx_ppp2;              /* # of transmitted PPP prio 2 frames */
  99         u64 tx_ppp3;              /* # of transmitted PPP prio 3 frames */
 100         u64 tx_ppp4;              /* # of transmitted PPP prio 4 frames */
 101         u64 tx_ppp5;              /* # of transmitted PPP prio 5 frames */
 102         u64 tx_ppp6;              /* # of transmitted PPP prio 6 frames */
 103         u64 tx_ppp7;              /* # of transmitted PPP prio 7 frames */
 104
 105         u64 rx_octets;            /* total # of octets in good frames */
 106         u64 rx_frames;            /* all good frames */
 107         u64 rx_bcast_frames;      /* all broadcast frames */
 108         u64 rx_mcast_frames;      /* all multicast frames */
 109         u64 rx_ucast_frames;      /* all unicast frames */
 110         u64 rx_too_long;          /* # of frames exceeding MTU */
 111         u64 rx_jabber;            /* # of jabber frames */
 112         u64 rx_fcs_err;           /* # of received frames with bad FCS */
 113         u64 rx_len_err;           /* # of received frames with length error */
 114         u64 rx_symbol_err;        /* symbol errors */
 115         u64 rx_runt;              /* # of short frames */
 116
 117         u64 rx_frames_64;         /* # of Rx frames in a particular range */
 118         u64 rx_frames_65_127;
 119         u64 rx_frames_128_255;
 120         u64 rx_frames_256_511;
 121         u64 rx_frames_512_1023;
 122         u64 rx_frames_1024_1518;
 123         u64 rx_frames_1519_max;
 124
 125         u64 rx_pause;             /* # of received pause frames */
 126         u64 rx_ppp0;              /* # of received PPP prio 0 frames */
 127         u64 rx_ppp1;              /* # of received PPP prio 1 frames */
 128         u64 rx_ppp2;              /* # of received PPP prio 2 frames */
 129         u64 rx_ppp3;              /* # of received PPP prio 3 frames */
 130         u64 rx_ppp4;              /* # of received PPP prio 4 frames */
 131         u64 rx_ppp5;              /* # of received PPP prio 5 frames */
 132         u64 rx_ppp6;              /* # of received PPP prio 6 frames */
 133         u64 rx_ppp7;              /* # of received PPP prio 7 frames */
 134
 135         u64 rx_ovflow0;           /* drops due to buffer-group 0 overflows */
 136         u64 rx_ovflow1;           /* drops due to buffer-group 1 overflows */
 137         u64 rx_ovflow2;           /* drops due to buffer-group 2 overflows */
 138         u64 rx_ovflow3;           /* drops due to buffer-group 3 overflows */
 139         u64 rx_trunc0;            /* buffer-group 0 truncated packets */
 140         u64 rx_trunc1;            /* buffer-group 1 truncated packets */
 141         u64 rx_trunc2;            /* buffer-group 2 truncated packets */
 142         u64 rx_trunc3;            /* buffer-group 3 truncated packets */
 143 };
 144
 145 struct sge_params {
 146         u32 hps;                        /* host page size for our PF/VF */
 147         u32 eq_qpp;                     /* egress queues/page for our PF/VF */
 148         u32 iq_qpp;                     /* egress queues/page for our PF/VF */
 149 };
 150
 151 struct tp_params {
 152         unsigned int ntxchan;        /* # of Tx channels */
 153         unsigned int tre;            /* log2 of core clocks per TP tick */
 154         unsigned int dack_re;        /* DACK timer resolution */
 155         unsigned int la_mask;        /* what events are recorded by TP LA */
 156         unsigned short tx_modq[NCHAN];  /* channel to modulation queue map */
 157
 158         u32 vlan_pri_map;               /* cached TP_VLAN_PRI_MAP */
 159         u32 ingress_config;             /* cached TP_INGRESS_CONFIG */
 160
 161         /* cached TP_OUT_CONFIG compressed error vector
 162          * and passing outer header info for encapsulated packets.
 163          */
 164         int rx_pkt_encap;
 165
 166         /*
 167          * TP_VLAN_PRI_MAP Compressed Filter Tuple field offsets.  This is a
 168          * subset of the set of fields which may be present in the Compressed
 169          * Filter Tuple portion of filters and TCP TCB connections.  The
 170          * fields which are present are controlled by the TP_VLAN_PRI_MAP.
 171          * Since a variable number of fields may or may not be present, their
 172          * shifted field positions within the Compressed Filter Tuple may
 173          * vary, or not even be present if the field isn't selected in
 174          * TP_VLAN_PRI_MAP.  Since some of these fields are needed in various
 175          * places we store their offsets here, or a -1 if the field isn't
 176          * present.
 177          */
 178         int vlan_shift;
 179         int vnic_shift;
 180         int port_shift;
 181         int protocol_shift;
 182 };
 183
 184 struct vpd_params {
 185         unsigned int cclk;
 186 };
 187
 188 struct pci_params {
 189         uint16_t        vendor_id;
 190         uint16_t        device_id;
 191         uint32_t        vpd_cap_addr;
 192         uint16_t        speed;
 193         uint8_t         width;
 194 };
 195
 196 /*
 197  * Firmware device log.
 198  */
 199 struct devlog_params {
 200         u32 memtype;                    /* which memory (EDC0, EDC1, MC) */
 201         u32 start;                      /* start of log in firmware memory */
 202         u32 size;                       /* size of log */
 203 };
 204
 205 struct arch_specific_params {
 206         u8 nchan;
 207         u16 mps_rplc_size;
 208         u16 vfcount;
 209         u32 sge_fl_db;
 210         u16 mps_tcam_size;
 211 };
 212
 213 struct adapter_params {
 214         struct sge_params sge;
 215         struct tp_params  tp;
 216         struct vpd_params vpd;
 217         struct pci_params pci;
 218         struct devlog_params devlog;
 219         enum pcie_memwin drv_memwin;
 220
 221         unsigned int sf_size;             /* serial flash size in bytes */
 222         unsigned int sf_nsec;             /* # of flash sectors */
 223
 224         unsigned int fw_vers;
 225         unsigned int bs_vers;
 226         unsigned int tp_vers;
 227         unsigned int er_vers;
 228
 229         unsigned short mtus[NMTUS];
 230         unsigned short a_wnd[NCCTRL_WIN];
 231         unsigned short b_wnd[NCCTRL_WIN];
 232
 233         unsigned int mc_size;             /* MC memory size */
 234         unsigned int cim_la_size;
 235
 236         unsigned char nports;             /* # of ethernet ports */
 237         unsigned char portvec;
 238
 239         enum chip_type chip;              /* chip code */
 240         struct arch_specific_params arch; /* chip specific params */
 241
 242         bool ulptx_memwrite_dsgl;          /* use of T5 DSGL allowed */
 243         u8 fw_caps_support;               /* 32-bit Port Capabilities */
 244 };
 245
 246 /* Firmware Port Capabilities types.
 247  */
 248 typedef u16 fw_port_cap16_t;    /* 16-bit Port Capabilities integral value */
 249 typedef u32 fw_port_cap32_t;    /* 32-bit Port Capabilities integral value */
 250
 251 enum fw_caps {
 252         FW_CAPS_UNKNOWN = 0,    /* 0'ed out initial state */
 253         FW_CAPS16       = 1,    /* old Firmware: 16-bit Port Capabilities */
 254         FW_CAPS32       = 2,    /* new Firmware: 32-bit Port Capabilities */
 255 };
 256
 257 struct link_config {
 258         fw_port_cap32_t pcaps;          /* link capabilities */
 259         fw_port_cap32_t acaps;          /* advertised capabilities */
 260
 261         u32 requested_speed;            /* speed (Mb/s) user has requested */
 262         u32 speed;                      /* actual link speed (Mb/s) */
 263
 264         enum cc_pause requested_fc;     /* flow control user has requested */
 265         enum cc_pause fc;               /* actual link flow control */
 266
 267         enum cc_fec auto_fec;           /* Forward Error Correction
 268                                          * "automatic" (IEEE 802.3)
 269                                          */
 270         enum cc_fec requested_fec;      /* Forward Error Correction requested */
 271         enum cc_fec fec;                /* Forward Error Correction actual */
 272
 273         unsigned char autoneg;          /* autonegotiating? */
 274
 275         unsigned char link_ok;          /* link up? */
 276         unsigned char link_down_rc;     /* link down reason */
 277 };
 278
 279 #include "adapter.h"
 280
 281 void t4_set_reg_field(struct adapter *adap, unsigned int addr, u32 mask,
 282                       u32 val);
 283 int t4_wait_op_done_val(struct adapter *adapter, int reg, u32 mask,
 284                         int polarity,
 285                         int attempts, int delay, u32 *valp);
 286
 287 static inline int t4_wait_op_done(struct adapter *adapter, int reg, u32 mask,
 288                                   int polarity, int attempts, int delay)
 289 {
 290         return t4_wait_op_done_val(adapter, reg, mask, polarity, attempts,
 291                                    delay, NULL);
 292 }
 293
 294 static inline int is_pf4(struct adapter *adap)
 295 {
 296         return adap->pf == 4;
 297 }
 298
 299 #define for_each_port(adapter, iter) \
 300         for (iter = 0; iter < (adapter)->params.nports; ++iter)
 301
 302 void t4_read_mtu_tbl(struct adapter *adap, u16 *mtus, u8 *mtu_log);
 303 void t4_tp_wr_bits_indirect(struct adapter *adap, unsigned int addr,
 304                             unsigned int mask, unsigned int val);
 305 void t4_intr_enable(struct adapter *adapter);
 306 void t4_intr_disable(struct adapter *adapter);
 307 int t4_link_l1cfg(struct adapter *adap, unsigned int mbox, unsigned int port,
 308                   struct link_config *lc);
 309 void t4_load_mtus(struct adapter *adap, const unsigned short *mtus,
 310                   const unsigned short *alpha, const unsigned short *beta);
 311 int t4_fw_hello(struct adapter *adap, unsigned int mbox, unsigned int evt_mbox,
 312                 enum dev_master master, enum dev_state *state);
 313 int t4_fw_bye(struct adapter *adap, unsigned int mbox);
 314 int t4_fw_reset(struct adapter *adap, unsigned int mbox, int reset);
 315 int t4_fw_halt(struct adapter *adap, unsigned int mbox, int reset);
 316 int t4_fw_restart(struct adapter *adap, unsigned int mbox, int reset);
 317 int t4_fl_pkt_align(struct adapter *adap);
 318 int t4_fixup_host_params_compat(struct adapter *adap, unsigned int page_size,
 319                                 unsigned int cache_line_size,
 320                                 enum chip_type chip_compat);
 321 int t4_fixup_host_params(struct adapter *adap, unsigned int page_size,
 322                          unsigned int cache_line_size);
 323 int t4_fw_initialize(struct adapter *adap, unsigned int mbox);
 324 int t4_query_params(struct adapter *adap, unsigned int mbox, unsigned int pf,
 325                     unsigned int vf, unsigned int nparams, const u32 *params,
 326                     u32 *val);
 327 int t4_set_params_timeout(struct adapter *adap, unsigned int mbox,
 328                           unsigned int pf, unsigned int vf,
 329                           unsigned int nparams, const u32 *params,
 330                           const u32 *val, int timeout);
 331 int t4_set_params(struct adapter *adap, unsigned int mbox, unsigned int pf,
 332                   unsigned int vf, unsigned int nparams, const u32 *params,
 333                   const u32 *val);
 334 int t4_alloc_vi_func(struct adapter *adap, unsigned int mbox,
 335                      unsigned int port, unsigned int pf, unsigned int vf,
 336                      unsigned int nmac, u8 *mac, unsigned int *rss_size,
 337                      unsigned int portfunc, unsigned int idstype);
 338 int t4_alloc_vi(struct adapter *adap, unsigned int mbox, unsigned int port,
 339                 unsigned int pf, unsigned int vf, unsigned int nmac, u8 *mac,
 340                 unsigned int *rss_size);
 341 int t4_free_vi(struct adapter *adap, unsigned int mbox,
 342                unsigned int pf, unsigned int vf,
 343                unsigned int viid);
 344 int t4_set_rxmode(struct adapter *adap, unsigned int mbox, unsigned int viid,
 345                   int mtu, int promisc, int all_multi, int bcast, int vlanex,
 346                   bool sleep_ok);
 347 int t4_change_mac(struct adapter *adap, unsigned int mbox, unsigned int viid,
 348                   int idx, const u8 *addr, bool persist, bool add_smt);
 349 int t4_enable_vi_params(struct adapter *adap, unsigned int mbox,
 350                         unsigned int viid, bool rx_en, bool tx_en, bool dcb_en);
 351 int t4_enable_vi(struct adapter *adap, unsigned int mbox, unsigned int viid,
 352                  bool rx_en, bool tx_en);
 353 int t4_iq_start_stop(struct adapter *adap, unsigned int mbox, bool start,
 354                      unsigned int pf, unsigned int vf, unsigned int iqid,
 355                      unsigned int fl0id, unsigned int fl1id);
 356 int t4_iq_free(struct adapter *adap, unsigned int mbox, unsigned int pf,
 357                unsigned int vf, unsigned int iqtype, unsigned int iqid,
 358                unsigned int fl0id, unsigned int fl1id);
 359 int t4_eth_eq_free(struct adapter *adap, unsigned int mbox, unsigned int pf,
 360                    unsigned int vf, unsigned int eqid);
 361
 362 static inline unsigned int core_ticks_per_usec(const struct adapter *adap)
 363 {
 364         return adap->params.vpd.cclk / 1000;
 365 }
 366
 367 static inline unsigned int us_to_core_ticks(const struct adapter *adap,
 368                                             unsigned int us)
 369 {
 370         return (us * adap->params.vpd.cclk) / 1000;
 371 }
 372
 373 static inline unsigned int core_ticks_to_us(const struct adapter *adapter,
 374                                             unsigned int ticks)
 375 {
 376         /* add Core Clock / 2 to round ticks to nearest uS */
 377         return ((ticks * 1000 + adapter->params.vpd.cclk / 2) /
 378                 adapter->params.vpd.cclk);
 379 }
 380
 381 int t4_wr_mbox_meat_timeout(struct adapter *adap, int mbox, const void *cmd,
 382                             int size, void *rpl, bool sleep_ok, int timeout);
 383 int t4_wr_mbox_meat(struct adapter *adap, int mbox,
 384                     const void __attribute__((__may_alias__)) *cmd, int size,
 385                     void *rpl, bool sleep_ok);
 386
 387 static inline int t4_wr_mbox_timeout(struct adapter *adap, int mbox,
 388                                      const void *cmd, int size, void *rpl,
 389                                      int timeout)
 390 {
 391         return t4_wr_mbox_meat_timeout(adap, mbox, cmd, size, rpl, true,
 392                                        timeout);
 393 }
 394
 395 int t4_get_core_clock(struct adapter *adapter, struct vpd_params *p);
 396
 397 static inline int t4_wr_mbox(struct adapter *adap, int mbox, const void *cmd,
 398                              int size, void *rpl)
 399 {
 400         return t4_wr_mbox_meat(adap, mbox, cmd, size, rpl, true);
 401 }
 402
 403 static inline int t4_wr_mbox_ns(struct adapter *adap, int mbox, const void *cmd,
 404                                 int size, void *rpl)
 405 {
 406         return t4_wr_mbox_meat(adap, mbox, cmd, size, rpl, false);
 407 }
 408
 409 int t4vf_wr_mbox_core(struct adapter *, const void *, int, void *, bool);
 410
 411 static inline int t4vf_wr_mbox(struct adapter *adapter, const void *cmd,
 412                                int size, void *rpl)
 413 {
 414         return t4vf_wr_mbox_core(adapter, cmd, size, rpl, true);
 415 }
 416
 417 static inline int t4vf_wr_mbox_ns(struct adapter *adapter, const void *cmd,
 418                                   int size, void *rpl)
 419 {
 420         return t4vf_wr_mbox_core(adapter, cmd, size, rpl, false);
 421 }
 422
 423
 424 void t4_read_indirect(struct adapter *adap, unsigned int addr_reg,
 425                       unsigned int data_reg, u32 *vals, unsigned int nregs,
 426                       unsigned int start_idx);
 427 void t4_write_indirect(struct adapter *adap, unsigned int addr_reg,
 428                        unsigned int data_reg, const u32 *vals,
 429                        unsigned int nregs, unsigned int start_idx);
 430
 431 int t4_get_vpd_params(struct adapter *adapter, struct vpd_params *p);
 432 int t4_read_flash(struct adapter *adapter, unsigned int addr,
 433                   unsigned int nwords, u32 *data, int byte_oriented);
 434 int t4_flash_cfg_addr(struct adapter *adapter);
 435 unsigned int t4_get_mps_bg_map(struct adapter *adapter, unsigned int pidx);
 436 unsigned int t4_get_tp_ch_map(struct adapter *adapter, unsigned int pidx);
 437 const char *t4_get_port_type_description(enum fw_port_type port_type);
 438 void t4_get_port_stats(struct adapter *adap, int idx, struct port_stats *p);
 439 void t4_get_port_stats_offset(struct adapter *adap, int idx,
 440                               struct port_stats *stats,
 441                               struct port_stats *offset);
 442 void t4_clr_port_stats(struct adapter *adap, int idx);
 443 void t4_reset_link_config(struct adapter *adap, int idx);
 444 int t4_get_version_info(struct adapter *adapter);
 445 void t4_dump_version_info(struct adapter *adapter);
 446 int t4_get_flash_params(struct adapter *adapter);
 447 int t4_get_chip_type(struct adapter *adap, int ver);
 448 int t4_prep_adapter(struct adapter *adapter);
 449 int t4_port_init(struct adapter *adap, int mbox, int pf, int vf);
 450 int t4_init_rss_mode(struct adapter *adap, int mbox);
 451 int t4_config_rss_range(struct adapter *adapter, int mbox, unsigned int viid,
 452                         int start, int n, const u16 *rspq, unsigned int nrspq);
 453 int t4_config_vi_rss(struct adapter *adapter, int mbox, unsigned int viid,
 454                      unsigned int flags, unsigned int defq);
 455 int t4_read_config_vi_rss(struct adapter *adapter, int mbox, unsigned int viid,
 456                           u64 *flags, unsigned int *defq);
 457 void t4_fw_tp_pio_rw(struct adapter *adap, u32 *vals, unsigned int nregs,
 458                      unsigned int start_index, unsigned int rw);
 459 void t4_write_rss_key(struct adapter *adap, u32 *key, int idx);
 460 void t4_read_rss_key(struct adapter *adap, u32 *key);
 461
 462 enum t4_bar2_qtype { T4_BAR2_QTYPE_EGRESS, T4_BAR2_QTYPE_INGRESS };
 463 int t4_bar2_sge_qregs(struct adapter *adapter, unsigned int qid,
 464                       unsigned int qtype, u64 *pbar2_qoffset,
 465                       unsigned int *pbar2_qid);
 466
 467 int t4_init_sge_params(struct adapter *adapter);
 468 int t4_init_tp_params(struct adapter *adap);
 469 int t4_filter_field_shift(const struct adapter *adap, unsigned int filter_sel);
 470 int t4_handle_fw_rpl(struct adapter *adap, const __be64 *rpl);
 471 unsigned int t4_get_regs_len(struct adapter *adap);
 472 void t4_get_regs(struct adapter *adap, void *buf, size_t buf_size);
 473 int t4_seeprom_read(struct adapter *adapter, u32 addr, u32 *data);
 474 int t4_seeprom_write(struct adapter *adapter, u32 addr, u32 data);
 475 int t4_seeprom_wp(struct adapter *adapter, int enable);
 476 #endif /* __CHELSIO_COMMON_H */