mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-13 06:08:07 +00:00
b50f7bca5e
This takes care of all of the trivial W=1 fixes in the Intel Ethernet drivers, which allows developers and maintainers to build more of the networking tree with more complete warning checks. There are three classes of kdoc warnings fixed: - cannot understand function prototype: 'x' - Excess function parameter 'x' description in 'y' - Function parameter or member 'x' not described in 'y' All of the changes were trivial comment updates on function headers. Inspired by Lee Jones' series of wireless work to do the same. Compile tested only, and passes simple test of $ git ls-files *.[ch] | egrep drivers/net/ethernet/intel | \ xargs scripts/kernel-doc -none Signed-off-by: Jesse Brandeburg <jesse.brandeburg@intel.com> Tested-by: Aaron Brown <aaron.f.brown@intel.com> Signed-off-by: David S. Miller <davem@davemloft.net>
136 lines
3.9 KiB
C
136 lines
3.9 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
/* Copyright(c) 2013 - 2018 Intel Corporation. */
|
|
|
|
#ifndef _I40E_ADMINQ_H_
|
|
#define _I40E_ADMINQ_H_
|
|
|
|
#include "i40e_osdep.h"
|
|
#include "i40e_status.h"
|
|
#include "i40e_adminq_cmd.h"
|
|
|
|
#define I40E_ADMINQ_DESC(R, i) \
|
|
(&(((struct i40e_aq_desc *)((R).desc_buf.va))[i]))
|
|
|
|
#define I40E_ADMINQ_DESC_ALIGNMENT 4096
|
|
|
|
struct i40e_adminq_ring {
|
|
struct i40e_virt_mem dma_head; /* space for dma structures */
|
|
struct i40e_dma_mem desc_buf; /* descriptor ring memory */
|
|
struct i40e_virt_mem cmd_buf; /* command buffer memory */
|
|
|
|
union {
|
|
struct i40e_dma_mem *asq_bi;
|
|
struct i40e_dma_mem *arq_bi;
|
|
} r;
|
|
|
|
u16 count; /* Number of descriptors */
|
|
u16 rx_buf_len; /* Admin Receive Queue buffer length */
|
|
|
|
/* used for interrupt processing */
|
|
u16 next_to_use;
|
|
u16 next_to_clean;
|
|
|
|
/* used for queue tracking */
|
|
u32 head;
|
|
u32 tail;
|
|
u32 len;
|
|
u32 bah;
|
|
u32 bal;
|
|
};
|
|
|
|
/* ASQ transaction details */
|
|
struct i40e_asq_cmd_details {
|
|
void *callback; /* cast from type I40E_ADMINQ_CALLBACK */
|
|
u64 cookie;
|
|
u16 flags_ena;
|
|
u16 flags_dis;
|
|
bool async;
|
|
bool postpone;
|
|
struct i40e_aq_desc *wb_desc;
|
|
};
|
|
|
|
#define I40E_ADMINQ_DETAILS(R, i) \
|
|
(&(((struct i40e_asq_cmd_details *)((R).cmd_buf.va))[i]))
|
|
|
|
/* ARQ event information */
|
|
struct i40e_arq_event_info {
|
|
struct i40e_aq_desc desc;
|
|
u16 msg_len;
|
|
u16 buf_len;
|
|
u8 *msg_buf;
|
|
};
|
|
|
|
/* Admin Queue information */
|
|
struct i40e_adminq_info {
|
|
struct i40e_adminq_ring arq; /* receive queue */
|
|
struct i40e_adminq_ring asq; /* send queue */
|
|
u32 asq_cmd_timeout; /* send queue cmd write back timeout*/
|
|
u16 num_arq_entries; /* receive queue depth */
|
|
u16 num_asq_entries; /* send queue depth */
|
|
u16 arq_buf_size; /* receive queue buffer size */
|
|
u16 asq_buf_size; /* send queue buffer size */
|
|
u16 fw_maj_ver; /* firmware major version */
|
|
u16 fw_min_ver; /* firmware minor version */
|
|
u32 fw_build; /* firmware build number */
|
|
u16 api_maj_ver; /* api major version */
|
|
u16 api_min_ver; /* api minor version */
|
|
|
|
struct mutex asq_mutex; /* Send queue lock */
|
|
struct mutex arq_mutex; /* Receive queue lock */
|
|
|
|
/* last status values on send and receive queues */
|
|
enum i40e_admin_queue_err asq_last_status;
|
|
enum i40e_admin_queue_err arq_last_status;
|
|
};
|
|
|
|
/**
|
|
* i40e_aq_rc_to_posix - convert errors to user-land codes
|
|
* @aq_ret: AdminQ handler error code can override aq_rc
|
|
* @aq_rc: AdminQ firmware error code to convert
|
|
**/
|
|
static inline int i40e_aq_rc_to_posix(int aq_ret, int aq_rc)
|
|
{
|
|
int aq_to_posix[] = {
|
|
0, /* I40E_AQ_RC_OK */
|
|
-EPERM, /* I40E_AQ_RC_EPERM */
|
|
-ENOENT, /* I40E_AQ_RC_ENOENT */
|
|
-ESRCH, /* I40E_AQ_RC_ESRCH */
|
|
-EINTR, /* I40E_AQ_RC_EINTR */
|
|
-EIO, /* I40E_AQ_RC_EIO */
|
|
-ENXIO, /* I40E_AQ_RC_ENXIO */
|
|
-E2BIG, /* I40E_AQ_RC_E2BIG */
|
|
-EAGAIN, /* I40E_AQ_RC_EAGAIN */
|
|
-ENOMEM, /* I40E_AQ_RC_ENOMEM */
|
|
-EACCES, /* I40E_AQ_RC_EACCES */
|
|
-EFAULT, /* I40E_AQ_RC_EFAULT */
|
|
-EBUSY, /* I40E_AQ_RC_EBUSY */
|
|
-EEXIST, /* I40E_AQ_RC_EEXIST */
|
|
-EINVAL, /* I40E_AQ_RC_EINVAL */
|
|
-ENOTTY, /* I40E_AQ_RC_ENOTTY */
|
|
-ENOSPC, /* I40E_AQ_RC_ENOSPC */
|
|
-ENOSYS, /* I40E_AQ_RC_ENOSYS */
|
|
-ERANGE, /* I40E_AQ_RC_ERANGE */
|
|
-EPIPE, /* I40E_AQ_RC_EFLUSHED */
|
|
-ESPIPE, /* I40E_AQ_RC_BAD_ADDR */
|
|
-EROFS, /* I40E_AQ_RC_EMODE */
|
|
-EFBIG, /* I40E_AQ_RC_EFBIG */
|
|
};
|
|
|
|
/* aq_rc is invalid if AQ timed out */
|
|
if (aq_ret == I40E_ERR_ADMIN_QUEUE_TIMEOUT)
|
|
return -EAGAIN;
|
|
|
|
if (!((u32)aq_rc < (sizeof(aq_to_posix) / sizeof((aq_to_posix)[0]))))
|
|
return -ERANGE;
|
|
|
|
return aq_to_posix[aq_rc];
|
|
}
|
|
|
|
/* general information */
|
|
#define I40E_AQ_LARGE_BUF 512
|
|
#define I40E_ASQ_CMD_TIMEOUT 250000 /* usecs */
|
|
|
|
void i40e_fill_default_direct_cmd_desc(struct i40e_aq_desc *desc,
|
|
u16 opcode);
|
|
|
|
#endif /* _I40E_ADMINQ_H_ */
|