sys/dev/ixl/ixlv.h

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