drivers/net/ethernet/intel/i40e/i40e_adminq.h

   1 /*******************************************************************************
   2  *
   3  * Intel Ethernet Controller XL710 Family Linux Driver
   4  * Copyright(c) 2013 - 2014 Intel Corporation.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms and conditions of the GNU General Public License,
   8  * version 2, as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * The full GNU General Public License is included in this distribution in
  19  * the file called "COPYING".
  20  *
  21  * Contact Information:
  22  * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  24  *
  25  ******************************************************************************/
  26
  27 #ifndef _I40E_ADMINQ_H_
  28 #define _I40E_ADMINQ_H_
  29
  30 #include "i40e_osdep.h"
  31 #include "i40e_status.h"
  32 #include "i40e_adminq_cmd.h"
  33
  34 #define I40E_ADMINQ_DESC(R, i)   \
  35         (&(((struct i40e_aq_desc *)((R).desc_buf.va))[i]))
  36
  37 #define I40E_ADMINQ_DESC_ALIGNMENT 4096
  38
  39 struct i40e_adminq_ring {
  40         struct i40e_virt_mem dma_head;  /* space for dma structures */
  41         struct i40e_dma_mem desc_buf;   /* descriptor ring memory */
  42         struct i40e_virt_mem cmd_buf;   /* command buffer memory */
  43
  44         union {
  45                 struct i40e_dma_mem *asq_bi;
  46                 struct i40e_dma_mem *arq_bi;
  47         } r;
  48
  49         u16 count;              /* Number of descriptors */
  50         u16 rx_buf_len;         /* Admin Receive Queue buffer length */
  51
  52         /* used for interrupt processing */
  53         u16 next_to_use;
  54         u16 next_to_clean;
  55
  56         /* used for queue tracking */
  57         u32 head;
  58         u32 tail;
  59         u32 len;
  60         u32 bah;
  61         u32 bal;
  62 };
  63
  64 /* ASQ transaction details */
  65 struct i40e_asq_cmd_details {
  66         void *callback; /* cast from type I40E_ADMINQ_CALLBACK */
  67         u64 cookie;
  68         u16 flags_ena;
  69         u16 flags_dis;
  70         bool async;
  71         bool postpone;
  72 };
  73
  74 #define I40E_ADMINQ_DETAILS(R, i)   \
  75         (&(((struct i40e_asq_cmd_details *)((R).cmd_buf.va))[i]))
  76
  77 /* ARQ event information */
  78 struct i40e_arq_event_info {
  79         struct i40e_aq_desc desc;
  80         u16 msg_len;
  81         u16 buf_len;
  82         u8 *msg_buf;
  83 };
  84
  85 /* Admin Queue information */
  86 struct i40e_adminq_info {
  87         struct i40e_adminq_ring arq;    /* receive queue */
  88         struct i40e_adminq_ring asq;    /* send queue */
  89         u32 asq_cmd_timeout;            /* send queue cmd write back timeout*/
  90         u16 num_arq_entries;            /* receive queue depth */
  91         u16 num_asq_entries;            /* send queue depth */
  92         u16 arq_buf_size;               /* receive queue buffer size */
  93         u16 asq_buf_size;               /* send queue buffer size */
  94         u16 fw_maj_ver;                 /* firmware major version */
  95         u16 fw_min_ver;                 /* firmware minor version */
  96         u16 api_maj_ver;                /* api major version */
  97         u16 api_min_ver;                /* api minor version */
  98         bool nvm_release_on_done;
  99
 100         struct mutex asq_mutex; /* Send queue lock */
 101         struct mutex arq_mutex; /* Receive queue lock */
 102
 103         /* last status values on send and receive queues */
 104         enum i40e_admin_queue_err asq_last_status;
 105         enum i40e_admin_queue_err arq_last_status;
 106 };
 107
 108 /**
 109  * i40e_aq_rc_to_posix - convert errors to user-land codes
 110  * aq_rc: AdminQ error code to convert
 111  **/
 112 static inline int i40e_aq_rc_to_posix(u32 aq_ret, u16 aq_rc)
 113 {
 114         int aq_to_posix[] = {
 115                 0,           /* I40E_AQ_RC_OK */
 116                 -EPERM,      /* I40E_AQ_RC_EPERM */
 117                 -ENOENT,     /* I40E_AQ_RC_ENOENT */
 118                 -ESRCH,      /* I40E_AQ_RC_ESRCH */
 119                 -EINTR,      /* I40E_AQ_RC_EINTR */
 120                 -EIO,        /* I40E_AQ_RC_EIO */
 121                 -ENXIO,      /* I40E_AQ_RC_ENXIO */
 122                 -E2BIG,      /* I40E_AQ_RC_E2BIG */
 123                 -EAGAIN,     /* I40E_AQ_RC_EAGAIN */
 124                 -ENOMEM,     /* I40E_AQ_RC_ENOMEM */
 125                 -EACCES,     /* I40E_AQ_RC_EACCES */
 126                 -EFAULT,     /* I40E_AQ_RC_EFAULT */
 127                 -EBUSY,      /* I40E_AQ_RC_EBUSY */
 128                 -EEXIST,     /* I40E_AQ_RC_EEXIST */
 129                 -EINVAL,     /* I40E_AQ_RC_EINVAL */
 130                 -ENOTTY,     /* I40E_AQ_RC_ENOTTY */
 131                 -ENOSPC,     /* I40E_AQ_RC_ENOSPC */
 132                 -ENOSYS,     /* I40E_AQ_RC_ENOSYS */
 133                 -ERANGE,     /* I40E_AQ_RC_ERANGE */
 134                 -EPIPE,      /* I40E_AQ_RC_EFLUSHED */
 135                 -ESPIPE,     /* I40E_AQ_RC_BAD_ADDR */
 136                 -EROFS,      /* I40E_AQ_RC_EMODE */
 137                 -EFBIG,      /* I40E_AQ_RC_EFBIG */
 138         };
 139
 140         /* aq_rc is invalid if AQ timed out */
 141         if (aq_ret == I40E_ERR_ADMIN_QUEUE_TIMEOUT)
 142                 return -EAGAIN;
 143
 144         if (aq_rc >= ARRAY_SIZE(aq_to_posix))
 145                 return -ERANGE;
 146         return aq_to_posix[aq_rc];
 147 }
 148
 149 /* general information */
 150 #define I40E_AQ_LARGE_BUF       512
 151 #define I40E_ASQ_CMD_TIMEOUT    250  /* msecs */
 152
 153 void i40e_fill_default_direct_cmd_desc(struct i40e_aq_desc *desc,
 154                                        u16 opcode);
 155
 156 #endif /* _I40E_ADMINQ_H_ */