7ec59eeac8
A control queue is a hardware interface which is used by the driver to interact with other subsystems (like firmware, PHY, etc.). It is implemented as a producer-consumer ring. More specifically, an "admin queue" is a type of control queue used to interact with the firmware. This patch introduces data structures and functions to initialize and teardown control/admin queues. Once the admin queue is initialized, the driver uses it to get the firmware version. Signed-off-by: Anirudh Venkataramanan <anirudh.venkataramanan@intel.com> Tested-by: Tony Brelinski <tonyx.brelinski@intel.com> Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
84 lines
2.2 KiB
C
84 lines
2.2 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
/* Copyright (c) 2018, Intel Corporation. */
|
|
|
|
#ifndef _ICE_CONTROLQ_H_
|
|
#define _ICE_CONTROLQ_H_
|
|
|
|
#include "ice_adminq_cmd.h"
|
|
|
|
#define ICE_CTL_Q_DESC(R, i) \
|
|
(&(((struct ice_aq_desc *)((R).desc_buf.va))[i]))
|
|
|
|
#define ICE_CTL_Q_DESC_UNUSED(R) \
|
|
(u16)((((R)->next_to_clean > (R)->next_to_use) ? 0 : (R)->count) + \
|
|
(R)->next_to_clean - (R)->next_to_use - 1)
|
|
|
|
/* Defines that help manage the driver vs FW API checks.
|
|
* Take a look at ice_aq_ver_check in ice_controlq.c for actual usage.
|
|
*
|
|
*/
|
|
#define EXP_FW_API_VER_BRANCH 0x00
|
|
#define EXP_FW_API_VER_MAJOR 0x00
|
|
#define EXP_FW_API_VER_MINOR 0x01
|
|
|
|
/* Different control queue types: These are mainly for SW consumption. */
|
|
enum ice_ctl_q {
|
|
ICE_CTL_Q_UNKNOWN = 0,
|
|
ICE_CTL_Q_ADMIN,
|
|
};
|
|
|
|
/* Control Queue default settings */
|
|
#define ICE_CTL_Q_SQ_CMD_TIMEOUT 250 /* msecs */
|
|
|
|
struct ice_ctl_q_ring {
|
|
void *dma_head; /* Virtual address to dma head */
|
|
struct ice_dma_mem desc_buf; /* descriptor ring memory */
|
|
void *cmd_buf; /* command buffer memory */
|
|
|
|
union {
|
|
struct ice_dma_mem *sq_bi;
|
|
struct ice_dma_mem *rq_bi;
|
|
} r;
|
|
|
|
u16 count; /* Number of descriptors */
|
|
|
|
/* 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;
|
|
u32 len_mask;
|
|
u32 len_ena_mask;
|
|
u32 head_mask;
|
|
};
|
|
|
|
/* sq transaction details */
|
|
struct ice_sq_cd {
|
|
struct ice_aq_desc *wb_desc;
|
|
};
|
|
|
|
#define ICE_CTL_Q_DETAILS(R, i) (&(((struct ice_sq_cd *)((R).cmd_buf))[i]))
|
|
|
|
/* Control Queue information */
|
|
struct ice_ctl_q_info {
|
|
enum ice_ctl_q qtype;
|
|
struct ice_ctl_q_ring rq; /* receive queue */
|
|
struct ice_ctl_q_ring sq; /* send queue */
|
|
u32 sq_cmd_timeout; /* send queue cmd write back timeout */
|
|
u16 num_rq_entries; /* receive queue depth */
|
|
u16 num_sq_entries; /* send queue depth */
|
|
u16 rq_buf_size; /* receive queue buffer size */
|
|
u16 sq_buf_size; /* send queue buffer size */
|
|
struct mutex sq_lock; /* Send queue lock */
|
|
struct mutex rq_lock; /* Receive queue lock */
|
|
enum ice_aq_err sq_last_status; /* last status on send queue */
|
|
enum ice_aq_err rq_last_status; /* last status on receive queue */
|
|
};
|
|
|
|
#endif /* _ICE_CONTROLQ_H_ */
|