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