sys/dev/ixl/ixlv.h

   1 /******************************************************************************
   2
   3   Copyright (c) 2013-2017, 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 _IXLV_H_
  37 #define _IXLV_H_
  38
  39 #include "ixlv_vc_mgr.h"
  40
  41 #define IXLV_AQ_MAX_ERR         30
  42 #define IXLV_MAX_INIT_WAIT      120
  43 #define IXLV_MAX_FILTERS        128
  44 #define IXLV_MAX_QUEUES         16
  45 #define IXLV_AQ_TIMEOUT         (1 * hz)
  46 #define IXLV_CALLOUT_TIMO       (hz / 50)       /* 20 msec */
  47
  48 #define IXLV_FLAG_AQ_ENABLE_QUEUES            (u32)(1 << 0)
  49 #define IXLV_FLAG_AQ_DISABLE_QUEUES           (u32)(1 << 1)
  50 #define IXLV_FLAG_AQ_ADD_MAC_FILTER           (u32)(1 << 2)
  51 #define IXLV_FLAG_AQ_ADD_VLAN_FILTER          (u32)(1 << 3)
  52 #define IXLV_FLAG_AQ_DEL_MAC_FILTER           (u32)(1 << 4)
  53 #define IXLV_FLAG_AQ_DEL_VLAN_FILTER          (u32)(1 << 5)
  54 #define IXLV_FLAG_AQ_CONFIGURE_QUEUES         (u32)(1 << 6)
  55 #define IXLV_FLAG_AQ_MAP_VECTORS              (u32)(1 << 7)
  56 #define IXLV_FLAG_AQ_HANDLE_RESET             (u32)(1 << 8)
  57 #define IXLV_FLAG_AQ_CONFIGURE_PROMISC        (u32)(1 << 9)
  58 #define IXLV_FLAG_AQ_GET_STATS                (u32)(1 << 10)
  59 #define IXLV_FLAG_AQ_CONFIG_RSS_KEY           (u32)(1 << 11)
  60 #define IXLV_FLAG_AQ_SET_RSS_HENA             (u32)(1 << 12)
  61 #define IXLV_FLAG_AQ_GET_RSS_HENA_CAPS        (u32)(1 << 13)
  62 #define IXLV_FLAG_AQ_CONFIG_RSS_LUT          (u32)(1 << 14)
  63
  64 /* printf %b arg */
  65 #define IXLV_FLAGS \
  66     "\20\1ENABLE_QUEUES\2DISABLE_QUEUES\3ADD_MAC_FILTER" \
  67     "\4ADD_VLAN_FILTER\5DEL_MAC_FILTER\6DEL_VLAN_FILTER" \
  68     "\7CONFIGURE_QUEUES\10MAP_VECTORS\11HANDLE_RESET" \
  69     "\12CONFIGURE_PROMISC\13GET_STATS"
  70 #define IXLV_PRINTF_VF_OFFLOAD_FLAGS \
  71     "\20\1I40E_VIRTCHNL_VF_OFFLOAD_L2" \
  72     "\2I40E_VIRTCHNL_VF_OFFLOAD_IWARP" \
  73     "\3I40E_VIRTCHNL_VF_OFFLOAD_FCOE" \
  74     "\4I40E_VIRTCHNL_VF_OFFLOAD_RSS_AQ" \
  75     "\5I40E_VIRTCHNL_VF_OFFLOAD_RSS_REG" \
  76     "\6I40E_VIRTCHNL_VF_OFFLOAD_WB_ON_ITR" \
  77     "\21I40E_VIRTCHNL_VF_OFFLOAD_VLAN" \
  78     "\22I40E_VIRTCHNL_VF_OFFLOAD_RX_POLLING" \
  79     "\23I40E_VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2" \
  80     "\24I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF"
  81
  82 /* Driver state */
  83 enum ixlv_state_t {
  84         IXLV_START,
  85         IXLV_FAILED,
  86         IXLV_RESET_REQUIRED,
  87         IXLV_RESET_PENDING,
  88         IXLV_VERSION_CHECK,
  89         IXLV_GET_RESOURCES,
  90         IXLV_INIT_READY,
  91         IXLV_INIT_START,
  92         IXLV_INIT_CONFIG,
  93         IXLV_INIT_MAPPING,
  94         IXLV_INIT_ENABLE,
  95         IXLV_INIT_COMPLETE,
  96         IXLV_RUNNING,
  97 };
  98
  99 /* Structs */
 100
 101 struct ixlv_mac_filter {
 102         SLIST_ENTRY(ixlv_mac_filter)  next;
 103         u8      macaddr[ETHER_ADDR_LEN];
 104         u16     flags;
 105 };
 106 SLIST_HEAD(mac_list, ixlv_mac_filter);
 107
 108 struct ixlv_vlan_filter {
 109         SLIST_ENTRY(ixlv_vlan_filter)  next;
 110         u16     vlan;
 111         u16     flags;
 112 };
 113 SLIST_HEAD(vlan_list, ixlv_vlan_filter);
 114
 115 /* Software controller structure */
 116 struct ixlv_sc {
 117         struct i40e_hw          hw;
 118         struct i40e_osdep       osdep;
 119         device_t                dev;
 120
 121         struct resource         *pci_mem;
 122         struct resource         *msix_mem;
 123
 124         enum ixlv_state_t       init_state;
 125         int                     init_in_progress;
 126
 127         /*
 128          * Interrupt resources
 129          */
 130         void                    *tag;
 131         struct resource         *res; /* For the AQ */
 132
 133         struct ifmedia          media;
 134         struct callout          timer;
 135         int                     msix;
 136         int                     pf_version;
 137         int                     if_flags;
 138
 139         bool                            link_up;
 140         enum virtchnl_link_speed        link_speed;
 141
 142         struct mtx              mtx;
 143
 144         u32                     qbase;
 145         u32                     admvec;
 146         struct timeout_task     timeout;
 147         struct task             aq_irq;
 148         struct task             aq_sched;
 149         struct taskqueue        *tq;
 150
 151         struct ixl_vsi          vsi;
 152
 153         /* Filter lists */
 154         struct mac_list         *mac_filters;
 155         struct vlan_list        *vlan_filters;
 156
 157         /* Promiscuous mode */
 158         u32                     promiscuous_flags;
 159
 160         /* Admin queue task flags */
 161         u32                     aq_wait_count;
 162
 163         struct ixl_vc_mgr       vc_mgr;
 164         struct ixl_vc_cmd       add_mac_cmd;
 165         struct ixl_vc_cmd       del_mac_cmd;
 166         struct ixl_vc_cmd       config_queues_cmd;
 167         struct ixl_vc_cmd       map_vectors_cmd;
 168         struct ixl_vc_cmd       enable_queues_cmd;
 169         struct ixl_vc_cmd       add_vlan_cmd;
 170         struct ixl_vc_cmd       del_vlan_cmd;
 171         struct ixl_vc_cmd       add_multi_cmd;
 172         struct ixl_vc_cmd       del_multi_cmd;
 173         struct ixl_vc_cmd       config_rss_key_cmd;
 174         struct ixl_vc_cmd       get_rss_hena_caps_cmd;
 175         struct ixl_vc_cmd       set_rss_hena_cmd;
 176         struct ixl_vc_cmd       config_rss_lut_cmd;
 177
 178         /* Virtual comm channel */
 179         struct virtchnl_vf_resource *vf_res;
 180         struct virtchnl_vsi_resource *vsi_res;
 181
 182         /* Misc stats maintained by the driver */
 183         u64                     watchdog_events;
 184         u64                     admin_irq;
 185
 186         u8                      aq_buffer[IXL_AQ_BUF_SZ];
 187 };
 188
 189 #define IXLV_CORE_LOCK_ASSERT(sc)       mtx_assert(&(sc)->mtx, MA_OWNED)
 190 /*
 191 ** This checks for a zero mac addr, something that will be likely
 192 ** unless the Admin on the Host has created one.
 193 */
 194 static inline bool
 195 ixlv_check_ether_addr(u8 *addr)
 196 {
 197         bool status = TRUE;
 198
 199         if ((addr[0] == 0 && addr[1]== 0 && addr[2] == 0 &&
 200             addr[3] == 0 && addr[4]== 0 && addr[5] == 0))
 201                 status = FALSE;
 202         return (status);
 203 }
 204
 205 /*
 206 ** VF Common function prototypes
 207 */
 208 int     ixlv_send_api_ver(struct ixlv_sc *);
 209 int     ixlv_verify_api_ver(struct ixlv_sc *);
 210 int     ixlv_send_vf_config_msg(struct ixlv_sc *);
 211 int     ixlv_get_vf_config(struct ixlv_sc *);
 212 void    ixlv_init(void *);
 213 int     ixlv_reinit_locked(struct ixlv_sc *);
 214 void    ixlv_configure_queues(struct ixlv_sc *);
 215 void    ixlv_enable_queues(struct ixlv_sc *);
 216 void    ixlv_disable_queues(struct ixlv_sc *);
 217 void    ixlv_map_queues(struct ixlv_sc *);
 218 void    ixlv_enable_intr(struct ixl_vsi *);
 219 void    ixlv_disable_intr(struct ixl_vsi *);
 220 void    ixlv_add_ether_filters(struct ixlv_sc *);
 221 void    ixlv_del_ether_filters(struct ixlv_sc *);
 222 void    ixlv_request_stats(struct ixlv_sc *);
 223 void    ixlv_request_reset(struct ixlv_sc *);
 224 void    ixlv_vc_completion(struct ixlv_sc *,
 225         enum virtchnl_ops, enum virtchnl_status_code,
 226         u8 *, u16);
 227 void    ixlv_add_ether_filter(struct ixlv_sc *);
 228 void    ixlv_add_vlans(struct ixlv_sc *);
 229 void    ixlv_del_vlans(struct ixlv_sc *);
 230 void    ixlv_update_stats_counters(struct ixlv_sc *,
 231                     struct i40e_eth_stats *);
 232 void    ixlv_update_link_status(struct ixlv_sc *);
 233 void    ixlv_get_default_rss_key(u32 *, bool);
 234 void    ixlv_config_rss_key(struct ixlv_sc *);
 235 void    ixlv_set_rss_hena(struct ixlv_sc *);
 236 void    ixlv_config_rss_lut(struct ixlv_sc *);
 237
 238 #endif /* _IXLV_H_ */