sys/dev/ixl/ixl_pf.h

   1 /******************************************************************************
   2
   3   Copyright (c) 2013-2018, Intel Corporation
   4   All rights reserved.
   5
   6   Redistribution and use in source and binary forms, with or without
   7   modification, are permitted provided that the following conditions are met:
   8
   9    1. Redistributions of source code must retain the above copyright notice,
  10       this list of conditions and the following disclaimer.
  11
  12    2. Redistributions in binary form must reproduce the above copyright
  13       notice, this list of conditions and the following disclaimer in the
  14       documentation and/or other materials provided with the distribution.
  15
  16    3. Neither the name of the Intel Corporation nor the names of its
  17       contributors may be used to endorse or promote products derived from
  18       this software without specific prior written permission.
  19
  20   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  24   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30   POSSIBILITY OF SUCH DAMAGE.
  31
  32 ******************************************************************************/
  33 /*$FreeBSD$*/
  34
  35
  36 #ifndef _IXL_PF_H_
  37 #define _IXL_PF_H_
  38
  39 #include "i40e_dcb.h"
  40
  41 #include "ixl.h"
  42 #include "ixl_pf_qmgr.h"
  43
  44 #define VF_FLAG_ENABLED                 0x01
  45 #define VF_FLAG_SET_MAC_CAP             0x02
  46 #define VF_FLAG_VLAN_CAP                0x04
  47 #define VF_FLAG_PROMISC_CAP             0x08
  48 #define VF_FLAG_MAC_ANTI_SPOOF          0x10
  49
  50 #define IXL_ICR0_CRIT_ERR_MASK                  \
  51     (I40E_PFINT_ICR0_PCI_EXCEPTION_MASK |       \
  52      I40E_PFINT_ICR0_ECC_ERR_MASK |             \
  53      I40E_PFINT_ICR0_PE_CRITERR_MASK)
  54
  55 /* VF Interrupts */
  56 #define IXL_VPINT_LNKLSTN_REG(hw, vector, vf_num) \
  57         I40E_VPINT_LNKLSTN(((vector) - 1) + \
  58             (((hw)->func_caps.num_msix_vectors_vf - 1) * (vf_num)))
  59
  60 #define IXL_VFINT_DYN_CTLN_REG(hw, vector, vf_num) \
  61         I40E_VFINT_DYN_CTLN(((vector) - 1) + \
  62             (((hw)->func_caps.num_msix_vectors_vf - 1) * (vf_num)))
  63
  64 enum ixl_fw_mode {
  65         IXL_FW_MODE_NORMAL,
  66         IXL_FW_MODE_RECOVERY,
  67         IXL_FW_MODE_UEMPR
  68 };
  69
  70 enum ixl_i2c_access_method_t {
  71         IXL_I2C_ACCESS_METHOD_BEST_AVAILABLE = 0,
  72         IXL_I2C_ACCESS_METHOD_BIT_BANG_I2CPARAMS = 1,
  73         IXL_I2C_ACCESS_METHOD_REGISTER_I2CCMD = 2,
  74         IXL_I2C_ACCESS_METHOD_AQ = 3,
  75         IXL_I2C_ACCESS_METHOD_TYPE_LENGTH = 4
  76 };
  77
  78 /* Used in struct ixl_pf's state field */
  79 enum ixl_pf_state {
  80         IXL_PF_STATE_RECOVERY_MODE      = (1 << 0),
  81         IXL_PF_STATE_RESETTING          = (1 << 1),
  82         IXL_PF_STATE_MDD_PENDING        = (1 << 2),
  83         IXL_PF_STATE_PF_RESET_REQ       = (1 << 3),
  84         IXL_PF_STATE_VF_RESET_REQ       = (1 << 4),
  85         IXL_PF_STATE_PF_CRIT_ERR        = (1 << 5),
  86         IXL_PF_STATE_CORE_RESET_REQ     = (1 << 6),
  87         IXL_PF_STATE_GLOB_RESET_REQ     = (1 << 7),
  88         IXL_PF_STATE_EMP_RESET_REQ      = (1 << 8),
  89         IXL_PF_STATE_FW_LLDP_DISABLED   = (1 << 9),
  90         IXL_PF_STATE_EEE_ENABLED        = (1 << 10),
  91 };
  92
  93 #define IXL_PF_IN_RECOVERY_MODE(pf)     \
  94         ((atomic_load_acq_32(&pf->state) & IXL_PF_STATE_RECOVERY_MODE) != 0)
  95
  96 #define IXL_PF_IS_RESETTING(pf) \
  97         ((atomic_load_acq_32(&pf->state) & IXL_PF_STATE_RESETTING) != 0)
  98
  99 struct ixl_vf {
 100         struct ixl_vsi          vsi;
 101         u32                     vf_flags;
 102         u32                     num_mdd_events;
 103
 104         u8                      mac[ETHER_ADDR_LEN];
 105         u16                     vf_num;
 106         struct virtchnl_version_info version;
 107
 108         struct ixl_pf_qtag      qtag;
 109 };
 110
 111 /* Physical controller structure */
 112 struct ixl_pf {
 113         struct ixl_vsi          vsi;
 114
 115         struct i40e_hw          hw;
 116         struct i40e_osdep       osdep;
 117         device_t                dev;
 118
 119         struct resource         *pci_mem;
 120
 121 #ifdef IXL_IW
 122         int                     iw_msix;
 123         bool                    iw_enabled;
 124 #endif
 125         u32                     state;
 126         u8                      supported_speeds;
 127
 128         struct ixl_pf_qmgr      qmgr;
 129         struct ixl_pf_qtag      qtag;
 130
 131         char admin_mtx_name[16]; /* name of the admin mutex */
 132         struct mtx admin_mtx; /* mutex to protect the admin timer */
 133         struct callout admin_timer; /* timer to trigger admin task */
 134
 135         /* Tunable values */
 136 #ifdef IXL_DEBUG_FC
 137         bool                    enable_tx_fc_filter;
 138 #endif
 139 #ifdef IXL_DEBUG
 140         bool                    recovery_mode;
 141 #endif
 142         int                     dynamic_rx_itr;
 143         int                     dynamic_tx_itr;
 144         int                     tx_itr;
 145         int                     rx_itr;
 146         int                     enable_vf_loopback;
 147
 148         bool                    link_up;
 149         int                     advertised_speed;
 150         int                     fc; /* link flow ctrl setting */
 151         enum ixl_dbg_mask       dbg_mask;
 152         bool                    has_i2c;
 153
 154         /* Misc stats maintained by the driver */
 155         u64                     admin_irq;
 156
 157         /* Statistics from hw */
 158         struct i40e_hw_port_stats       stats;
 159         struct i40e_hw_port_stats       stats_offsets;
 160         bool                            stat_offsets_loaded;
 161
 162         /* I2C access methods */
 163         enum ixl_i2c_access_method_t i2c_access_method;
 164         s32 (*read_i2c_byte)(struct ixl_pf *pf, u8 byte_offset,
 165             u8 dev_addr, u8 *data);
 166         s32 (*write_i2c_byte)(struct ixl_pf *pf, u8 byte_offset,
 167             u8 dev_addr, u8 data);
 168
 169         /* SR-IOV */
 170         struct ixl_vf           *vfs;
 171         int                     num_vfs;
 172         uint16_t                veb_seid;
 173         int                     vc_debug_lvl;
 174 };
 175
 176 /*
 177  * Defines used for NVM update ioctls.
 178  * This value is used in the Solaris tool, too.
 179  */
 180 #define I40E_NVM_ACCESS \
 181      (((((((('E' << 4) + '1') << 4) + 'K') << 4) + 'G') << 4) | 5)
 182
 183 #define IXL_DEFAULT_PHY_INT_MASK \
 184      ((~(I40E_AQ_EVENT_LINK_UPDOWN | I40E_AQ_EVENT_MODULE_QUAL_FAIL \
 185       | I40E_AQ_EVENT_MEDIA_NA)) & 0x3FF)
 186
 187 /*** Sysctl help messages; displayed with "sysctl -d" ***/
 188
 189 #define IXL_SYSCTL_HELP_SET_ADVERTISE   \
 190 "\nControl advertised link speed.\n"    \
 191 "Flags:\n"                              \
 192 "\t 0x1 - advertise 100M\n"             \
 193 "\t 0x2 - advertise 1G\n"               \
 194 "\t 0x4 - advertise 10G\n"              \
 195 "\t 0x8 - advertise 20G\n"              \
 196 "\t0x10 - advertise 25G\n"              \
 197 "\t0x20 - advertise 40G\n"              \
 198 "\t0x40 - advertise 2.5G\n"             \
 199 "\t0x80 - advertise 5G\n\n"             \
 200 "Set to 0 to disable link.\n"           \
 201 "Use \"sysctl -x\" to view flags properly."
 202
 203 #define IXL_SYSCTL_HELP_SUPPORTED_SPEED \
 204 "\nSupported link speeds.\n"            \
 205 "Flags:\n"                              \
 206 "\t 0x1 - 100M\n"                       \
 207 "\t 0x2 - 1G\n"                         \
 208 "\t 0x4 - 10G\n"                        \
 209 "\t 0x8 - 20G\n"                        \
 210 "\t0x10 - 25G\n"                        \
 211 "\t0x20 - 40G\n"                        \
 212 "\t0x40 - 2.5G\n"                       \
 213 "\t0x80 - 5G\n\n"                       \
 214 "Use \"sysctl -x\" to view flags properly."
 215
 216 #define IXL_SYSCTL_HELP_FC                              \
 217 "\nSet flow control mode using the values below.\n"     \
 218 "\t0 - off\n"                                           \
 219 "\t1 - rx pause\n"                                      \
 220 "\t2 - tx pause\n"                                      \
 221 "\t3 - tx and rx pause"
 222
 223 #define IXL_SYSCTL_HELP_LINK_STATUS                                     \
 224 "\nExecutes a \"Get Link Status\" command on the Admin Queue, and displays" \
 225 " the response."
 226
 227 #define IXL_SYSCTL_HELP_FW_LLDP         \
 228 "\nFW LLDP engine:\n"                   \
 229 "\t0 - disable\n"                       \
 230 "\t1 - enable\n"
 231
 232 #define IXL_SYSCTL_HELP_READ_I2C                \
 233 "\nRead a byte from I2C bus\n"                  \
 234 "Input: 32-bit value\n"                         \
 235 "\tbits 0-7:   device address (0xA0 or 0xA2)\n" \
 236 "\tbits 8-15:  offset (0-255)\n"                \
 237 "\tbits 16-31: unused\n"                        \
 238 "Output: 8-bit value read"
 239
 240 #define IXL_SYSCTL_HELP_WRITE_I2C               \
 241 "\nWrite a byte to the I2C bus\n"               \
 242 "Input: 32-bit value\n"                         \
 243 "\tbits 0-7:   device address (0xA0 or 0xA2)\n" \
 244 "\tbits 8-15:  offset (0-255)\n"                \
 245 "\tbits 16-23: value to write\n"                \
 246 "\tbits 24-31: unused\n"                        \
 247 "Output: 8-bit value written"
 248
 249 #define IXL_SYSCTL_HELP_I2C_METHOD              \
 250 "\nI2C access method that driver will use:\n"   \
 251 "\t0 - best available method\n"                 \
 252 "\t1 - bit bang via I2CPARAMS register\n"       \
 253 "\t2 - register read/write via I2CCMD register\n" \
 254 "\t3 - Use Admin Queue command (best)\n"        \
 255 "Using the Admin Queue is only supported on 710 devices with FW version 1.7 or higher"
 256
 257 #define IXL_SYSCTL_HELP_VF_LOOPBACK             \
 258 "\nDetermines mode that embedded device switch will use when SR-IOV is initialized:\n"  \
 259 "\t0 - Disable (VEPA)\n"                        \
 260 "\t1 - Enable (VEB)\n"                          \
 261 "Enabling this will allow VFs in separate VMs to communicate over the hardware bridge."
 262
 263 /*** Functions / Macros ***/
 264 /* Adjust the level here to 10 or over to print stats messages */
 265 #define I40E_VC_DEBUG(p, level, ...)                            \
 266         do {                                                    \
 267                 if (level < 10)                                 \
 268                         ixl_dbg(p, IXL_DBG_IOV_VC, ##__VA_ARGS__); \
 269         } while (0)
 270
 271 #define i40e_send_vf_nack(pf, vf, op, st) \
 272         ixl_send_vf_nack_msg((pf), (vf), (op), (st), __FILE__, __LINE__)
 273
 274 /* Debug printing */
 275 #define ixl_dbg(pf, m, s, ...) ixl_debug_core((pf)->dev, (pf)->dbg_mask, m, s, ##__VA_ARGS__)
 276 #define ixl_dbg_info(pf, s, ...) ixl_debug_core((pf)->dev, (pf)->dbg_mask, IXL_DBG_INFO, s, ##__VA_ARGS__)
 277 #define ixl_dbg_filter(pf, s, ...) ixl_debug_core((pf)->dev, (pf)->dbg_mask, IXL_DBG_FILTER, s, ##__VA_ARGS__)
 278 #define ixl_dbg_iov(pf, s, ...) ixl_debug_core((pf)->dev, (pf)->dbg_mask, IXL_DBG_IOV, s, ##__VA_ARGS__)
 279
 280 /* PF-only function declarations */
 281 int     ixl_setup_interface(device_t, struct ixl_pf *);
 282 void    ixl_print_nvm_cmd(device_t, struct i40e_nvm_access *);
 283
 284 void    ixl_handle_que(void *context, int pending);
 285
 286 void    ixl_init(void *);
 287 void    ixl_local_timer(void *);
 288 void    ixl_register_vlan(void *, struct ifnet *, u16);
 289 void    ixl_unregister_vlan(void *, struct ifnet *, u16);
 290 int     ixl_intr(void *);
 291 int     ixl_msix_que(void *);
 292 int     ixl_msix_adminq(void *);
 293 void    ixl_do_adminq(void *, int);
 294
 295 int     ixl_res_alloc_cmp(const void *, const void *);
 296 const char *    ixl_switch_res_type_string(u8);
 297 void    ixl_add_sysctls_mac_stats(struct sysctl_ctx_list *,
 298                     struct sysctl_oid_list *, struct i40e_hw_port_stats *);
 299
 300 void    ixl_media_status(struct ifnet *, struct ifmediareq *);
 301 int     ixl_media_change(struct ifnet *);
 302 int     ixl_ioctl(struct ifnet *, u_long, caddr_t);
 303
 304 void    ixl_enable_queue(struct i40e_hw *, int);
 305 void    ixl_disable_queue(struct i40e_hw *, int);
 306 void    ixl_enable_intr0(struct i40e_hw *);
 307 void    ixl_disable_intr0(struct i40e_hw *);
 308 void    ixl_nvm_version_str(struct i40e_hw *hw, struct sbuf *buf);
 309 void    ixl_stat_update48(struct i40e_hw *, u32, u32, bool,
 310                     u64 *, u64 *);
 311 void    ixl_stat_update32(struct i40e_hw *, u32, bool,
 312                     u64 *, u64 *);
 313
 314 void    ixl_stop(struct ixl_pf *);
 315 void    ixl_vsi_add_sysctls(struct ixl_vsi *, const char *, bool);
 316 int     ixl_get_hw_capabilities(struct ixl_pf *);
 317 void    ixl_link_up_msg(struct ixl_pf *);
 318 void    ixl_update_link_status(struct ixl_pf *);
 319 int     ixl_setup_stations(struct ixl_pf *);
 320 int     ixl_switch_config(struct ixl_pf *);
 321 void    ixl_stop_locked(struct ixl_pf *);
 322 int     ixl_teardown_hw_structs(struct ixl_pf *);
 323 void    ixl_init_locked(struct ixl_pf *);
 324 void    ixl_set_rss_key(struct ixl_pf *);
 325 void    ixl_set_rss_pctypes(struct ixl_pf *);
 326 void    ixl_set_rss_hlut(struct ixl_pf *);
 327 int     ixl_setup_adminq_msix(struct ixl_pf *);
 328 int     ixl_setup_adminq_tq(struct ixl_pf *);
 329 void    ixl_teardown_adminq_msix(struct ixl_pf *);
 330 void    ixl_configure_intr0_msix(struct ixl_pf *);
 331 void    ixl_configure_queue_intr_msix(struct ixl_pf *);
 332 void    ixl_free_adminq_tq(struct ixl_pf *);
 333 int     ixl_setup_legacy(struct ixl_pf *);
 334 int     ixl_init_msix(struct ixl_pf *);
 335 void    ixl_configure_tx_itr(struct ixl_pf *);
 336 void    ixl_configure_rx_itr(struct ixl_pf *);
 337 void    ixl_configure_itr(struct ixl_pf *);
 338 void    ixl_configure_legacy(struct ixl_pf *);
 339 void    ixl_free_pci_resources(struct ixl_pf *);
 340 void    ixl_link_event(struct ixl_pf *, struct i40e_arq_event_info *);
 341 void    ixl_config_rss(struct ixl_pf *);
 342 int     ixl_set_advertised_speeds(struct ixl_pf *, int, bool);
 343 void    ixl_set_initial_advertised_speeds(struct ixl_pf *);
 344 void    ixl_print_nvm_version(struct ixl_pf *pf);
 345 void    ixl_add_sysctls_recovery_mode(struct ixl_pf *);
 346 void    ixl_add_device_sysctls(struct ixl_pf *);
 347 void    ixl_handle_mdd_event(struct ixl_pf *);
 348 void    ixl_add_hw_stats(struct ixl_pf *);
 349 void    ixl_update_stats_counters(struct ixl_pf *);
 350 void    ixl_pf_reset_stats(struct ixl_pf *);
 351 void    ixl_get_bus_info(struct ixl_pf *pf);
 352 int     ixl_aq_get_link_status(struct ixl_pf *,
 353     struct i40e_aqc_get_link_status *);
 354
 355 int     ixl_handle_nvmupd_cmd(struct ixl_pf *, struct ifdrv *);
 356 int     ixl_handle_i2c_eeprom_read_cmd(struct ixl_pf *, struct ifreq *ifr);
 357
 358 int     ixl_setup_hmc(struct ixl_pf *);
 359 void    ixl_shutdown_hmc(struct ixl_pf *);
 360 void    ixl_handle_empr_reset(struct ixl_pf *);
 361 int     ixl_prepare_for_reset(struct ixl_pf *pf, bool is_up);
 362 int     ixl_rebuild_hw_structs_after_reset(struct ixl_pf *, bool is_up);
 363 int     ixl_pf_reset(struct ixl_pf *);
 364
 365 void    ixl_set_queue_rx_itr(struct ixl_rx_queue *);
 366 void    ixl_set_queue_tx_itr(struct ixl_tx_queue *);
 367
 368 void    ixl_add_filter(struct ixl_vsi *, const u8 *, s16 vlan);
 369 void    ixl_del_filter(struct ixl_vsi *, const u8 *, s16 vlan);
 370 void    ixl_add_vlan_filters(struct ixl_vsi *, const u8 *);
 371 void    ixl_del_all_vlan_filters(struct ixl_vsi *, const u8 *);
 372 void    ixl_reconfigure_filters(struct ixl_vsi *vsi);
 373
 374 int     ixl_disable_rings(struct ixl_pf *, struct ixl_vsi *, struct ixl_pf_qtag *);
 375 int     ixl_disable_tx_ring(struct ixl_pf *, struct ixl_pf_qtag *, u16);
 376 int     ixl_disable_rx_ring(struct ixl_pf *, struct ixl_pf_qtag *, u16);
 377 int     ixl_disable_ring(struct ixl_pf *pf, struct ixl_pf_qtag *, u16);
 378
 379 int     ixl_enable_rings(struct ixl_vsi *);
 380 int     ixl_enable_tx_ring(struct ixl_pf *, struct ixl_pf_qtag *, u16);
 381 int     ixl_enable_rx_ring(struct ixl_pf *, struct ixl_pf_qtag *, u16);
 382 int     ixl_enable_ring(struct ixl_pf *pf, struct ixl_pf_qtag *, u16);
 383
 384 void    ixl_update_eth_stats(struct ixl_vsi *);
 385 void    ixl_cap_txcsum_tso(struct ixl_vsi *, struct ifnet *, int);
 386 int     ixl_initialize_vsi(struct ixl_vsi *);
 387 void    ixl_add_ifmedia(struct ifmedia *, u64);
 388 int     ixl_setup_queue_msix(struct ixl_vsi *);
 389 int     ixl_setup_queue_tqs(struct ixl_vsi *);
 390 int     ixl_teardown_queue_msix(struct ixl_vsi *);
 391 void    ixl_free_queue_tqs(struct ixl_vsi *);
 392 void    ixl_enable_intr(struct ixl_vsi *);
 393 void    ixl_disable_rings_intr(struct ixl_vsi *);
 394 void    ixl_set_promisc(struct ixl_vsi *);
 395 void    ixl_add_multi(struct ixl_vsi *);
 396 void    ixl_del_multi(struct ixl_vsi *, bool);
 397 void    ixl_setup_vlan_filters(struct ixl_vsi *);
 398 void    ixl_init_filters(struct ixl_vsi *);
 399 void    ixl_free_filters(struct ixl_ftl_head *);
 400 void    ixl_add_hw_filters(struct ixl_vsi *, struct ixl_ftl_head *, int);
 401 void    ixl_del_hw_filters(struct ixl_vsi *, struct ixl_ftl_head *, int);
 402 void    ixl_del_default_hw_filters(struct ixl_vsi *);
 403 struct ixl_mac_filter *
 404                 ixl_find_filter(struct ixl_ftl_head *, const u8 *, s16);
 405 void    ixl_update_vsi_stats(struct ixl_vsi *);
 406 void    ixl_vsi_reset_stats(struct ixl_vsi *);
 407
 408 void    ixl_vsi_free_queues(struct ixl_vsi *vsi);
 409
 410 void     ixl_if_init(if_ctx_t ctx);
 411 void     ixl_if_stop(if_ctx_t ctx);
 412
 413 /*
 414  * I2C Function prototypes
 415  */
 416 int     ixl_find_i2c_interface(struct ixl_pf *);
 417 s32     ixl_read_i2c_byte_bb(struct ixl_pf *pf, u8 byte_offset,
 418             u8 dev_addr, u8 *data);
 419 s32     ixl_write_i2c_byte_bb(struct ixl_pf *pf, u8 byte_offset,
 420             u8 dev_addr, u8 data);
 421 s32     ixl_read_i2c_byte_reg(struct ixl_pf *pf, u8 byte_offset,
 422             u8 dev_addr, u8 *data);
 423 s32     ixl_write_i2c_byte_reg(struct ixl_pf *pf, u8 byte_offset,
 424             u8 dev_addr, u8 data);
 425 s32     ixl_read_i2c_byte_aq(struct ixl_pf *pf, u8 byte_offset,
 426             u8 dev_addr, u8 *data);
 427 s32     ixl_write_i2c_byte_aq(struct ixl_pf *pf, u8 byte_offset,
 428             u8 dev_addr, u8 data);
 429
 430 u64     ixl_max_aq_speed_to_value(u8);
 431 int     ixl_attach_get_link_status(struct ixl_pf *);
 432 int     ixl_sysctl_set_flowcntl(SYSCTL_HANDLER_ARGS);
 433
 434 #endif /* _IXL_PF_H_ */