Commit 19198e4e authored by Prabhakar Kushwaha's avatar Prabhakar Kushwaha Committed by David S. Miller

qed: Fix kernel-doc warnings

This patch fixes all the qed and qede kernel-doc warnings
according to the guidelines that are described in
Documentation/doc-guide/kernel-doc.rst.
Signed-off-by: default avatarAriel Elior <aelior@marvell.com>
Signed-off-by: default avatarOmkar Kulkarni <okulkarni@marvell.com>
Signed-off-by: default avatarShai Malin <smalin@marvell.com>
Signed-off-by: default avatarPrabhakar Kushwaha <pkushwaha@marvell.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent cfbe9b00
......@@ -877,12 +877,13 @@ u32 qed_get_hsi_def_val(struct qed_dev *cdev, enum qed_hsi_def_type type);
/**
* @brief qed_concrete_to_sw_fid - get the sw function id from
* qed_concrete_to_sw_fid(): Get the sw function id from
* the concrete value.
*
* @param concrete_fid
* @cdev: Qed dev pointer.
* @concrete_fid: Concrete fid.
*
* @return inline u8
* Return: inline u8.
*/
static inline u8 qed_concrete_to_sw_fid(struct qed_dev *cdev,
u32 concrete_fid)
......
......@@ -28,24 +28,23 @@ struct qed_tid_mem {
};
/**
* @brief qedo_cid_get_cxt_info - Returns the context info for a specific cid
* qed_cxt_get_cid_info(): Returns the context info for a specific cidi.
*
* @p_hwfn: HW device data.
* @p_info: In/out.
*
* @param p_hwfn
* @param p_info in/out
*
* @return int
* Return: Int.
*/
int qed_cxt_get_cid_info(struct qed_hwfn *p_hwfn,
struct qed_cxt_info *p_info);
/**
* @brief qed_cxt_get_tid_mem_info
* qed_cxt_get_tid_mem_info(): Returns the tid mem info.
*
* @param p_hwfn
* @param p_info
* @p_hwfn: HW device data.
* @p_info: in/out.
*
* @return int
* Return: int.
*/
int qed_cxt_get_tid_mem_info(struct qed_hwfn *p_hwfn,
struct qed_tid_mem *p_info);
......@@ -64,142 +63,155 @@ u32 qed_cxt_get_proto_cid_count(struct qed_hwfn *p_hwfn,
enum protocol_type type, u32 *vf_cid);
/**
* @brief qed_cxt_set_pf_params - Set the PF params for cxt init
* qed_cxt_set_pf_params(): Set the PF params for cxt init.
*
* @p_hwfn: HW device data.
* @rdma_tasks: Requested maximum.
*
* @param p_hwfn
* @param rdma_tasks - requested maximum
* @return int
* Return: int.
*/
int qed_cxt_set_pf_params(struct qed_hwfn *p_hwfn, u32 rdma_tasks);
/**
* @brief qed_cxt_cfg_ilt_compute - compute ILT init parameters
* qed_cxt_cfg_ilt_compute(): Compute ILT init parameters.
*
* @param p_hwfn
* @param last_line
* @p_hwfn: HW device data.
* @last_line: Last_line.
*
* @return int
* Return: Int
*/
int qed_cxt_cfg_ilt_compute(struct qed_hwfn *p_hwfn, u32 *last_line);
/**
* @brief qed_cxt_cfg_ilt_compute_excess - how many lines can be decreased
* qed_cxt_cfg_ilt_compute_excess(): How many lines can be decreased.
*
* @p_hwfn: HW device data.
* @used_lines: Used lines.
*
* @param p_hwfn
* @param used_lines
* Return: Int.
*/
u32 qed_cxt_cfg_ilt_compute_excess(struct qed_hwfn *p_hwfn, u32 used_lines);
/**
* @brief qed_cxt_mngr_alloc - Allocate and init the context manager struct
* qed_cxt_mngr_alloc(): Allocate and init the context manager struct.
*
* @param p_hwfn
* @p_hwfn: HW device data.
*
* @return int
* Return: Int.
*/
int qed_cxt_mngr_alloc(struct qed_hwfn *p_hwfn);
/**
* @brief qed_cxt_mngr_free
* qed_cxt_mngr_free() - Context manager free.
*
* @param p_hwfn
* @p_hwfn: HW device data.
*
* Return: Void.
*/
void qed_cxt_mngr_free(struct qed_hwfn *p_hwfn);
/**
* @brief qed_cxt_tables_alloc - Allocate ILT shadow, Searcher T2, acquired map
* qed_cxt_tables_alloc(): Allocate ILT shadow, Searcher T2, acquired map.
*
* @param p_hwfn
* @p_hwfn: HW device data.
*
* @return int
* Return: Int.
*/
int qed_cxt_tables_alloc(struct qed_hwfn *p_hwfn);
/**
* @brief qed_cxt_mngr_setup - Reset the acquired CIDs
* qed_cxt_mngr_setup(): Reset the acquired CIDs.
*
* @param p_hwfn
* @p_hwfn: HW device data.
*/
void qed_cxt_mngr_setup(struct qed_hwfn *p_hwfn);
/**
* @brief qed_cxt_hw_init_common - Initailze ILT and DQ, common phase, per path.
*
* qed_cxt_hw_init_common(): Initailze ILT and DQ, common phase, per path.
*
* @p_hwfn: HW device data.
*
* @param p_hwfn
* Return: Void.
*/
void qed_cxt_hw_init_common(struct qed_hwfn *p_hwfn);
/**
* @brief qed_cxt_hw_init_pf - Initailze ILT and DQ, PF phase, per path.
* qed_cxt_hw_init_pf(): Initailze ILT and DQ, PF phase, per path.
*
* @param p_hwfn
* @param p_ptt
* @p_hwfn: HW device data.
* @p_ptt: P_ptt.
*
* Return: Void.
*/
void qed_cxt_hw_init_pf(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
/**
* @brief qed_qm_init_pf - Initailze the QM PF phase, per path
* qed_qm_init_pf(): Initailze the QM PF phase, per path.
*
* @p_hwfn: HW device data.
* @p_ptt: P_ptt.
* @is_pf_loading: Is pf pending.
*
* @param p_hwfn
* @param p_ptt
* @param is_pf_loading
* Return: Void.
*/
void qed_qm_init_pf(struct qed_hwfn *p_hwfn,
struct qed_ptt *p_ptt, bool is_pf_loading);
/**
* @brief Reconfigures QM pf on the fly
* qed_qm_reconf(): Reconfigures QM pf on the fly.
*
* @param p_hwfn
* @param p_ptt
* @p_hwfn: HW device data.
* @p_ptt: P_ptt.
*
* @return int
* Return: Int.
*/
int qed_qm_reconf(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
#define QED_CXT_PF_CID (0xff)
/**
* @brief qed_cxt_release - Release a cid
* qed_cxt_release_cid(): Release a cid.
*
* @param p_hwfn
* @param cid
* @p_hwfn: HW device data.
* @cid: Cid.
*
* Return: Void.
*/
void qed_cxt_release_cid(struct qed_hwfn *p_hwfn, u32 cid);
/**
* @brief qed_cxt_release - Release a cid belonging to a vf-queue
* _qed_cxt_release_cid(): Release a cid belonging to a vf-queue.
*
* @p_hwfn: HW device data.
* @cid: Cid.
* @vfid: Engine relative index. QED_CXT_PF_CID if belongs to PF.
*
* @param p_hwfn
* @param cid
* @param vfid - engine relative index. QED_CXT_PF_CID if belongs to PF
* Return: Void.
*/
void _qed_cxt_release_cid(struct qed_hwfn *p_hwfn, u32 cid, u8 vfid);
/**
* @brief qed_cxt_acquire - Acquire a new cid of a specific protocol type
* qed_cxt_acquire_cid(): Acquire a new cid of a specific protocol type.
*
* @param p_hwfn
* @param type
* @param p_cid
* @p_hwfn: HW device data.
* @type: Type.
* @p_cid: Pointer cid.
*
* @return int
* Return: Int.
*/
int qed_cxt_acquire_cid(struct qed_hwfn *p_hwfn,
enum protocol_type type, u32 *p_cid);
/**
* @brief _qed_cxt_acquire - Acquire a new cid of a specific protocol type
* for a vf-queue
* _qed_cxt_acquire_cid(): Acquire a new cid of a specific protocol type
* for a vf-queue.
*
* @param p_hwfn
* @param type
* @param p_cid
* @param vfid - engine relative index. QED_CXT_PF_CID if belongs to PF
* @p_hwfn: HW device data.
* @type: Type.
* @p_cid: Pointer cid.
* @vfid: Engine relative index. QED_CXT_PF_CID if belongs to PF.
*
* @return int
* Return: Int.
*/
int _qed_cxt_acquire_cid(struct qed_hwfn *p_hwfn,
enum protocol_type type, u32 *p_cid, u8 vfid);
......
This diff is collapsed.
......@@ -53,85 +53,94 @@ enum _dmae_cmd_crc_mask {
#define DMAE_MAX_CLIENTS 32
/**
* @brief qed_gtt_init - Initialize GTT windows
* qed_gtt_init(): Initialize GTT windows.
*
* @param p_hwfn
* @p_hwfn: HW device data.
*
* Return: Void.
*/
void qed_gtt_init(struct qed_hwfn *p_hwfn);
/**
* @brief qed_ptt_invalidate - Forces all ptt entries to be re-configured
* qed_ptt_invalidate(): Forces all ptt entries to be re-configured
*
* @p_hwfn: HW device data.
*
* @param p_hwfn
* Return: Void.
*/
void qed_ptt_invalidate(struct qed_hwfn *p_hwfn);
/**
* @brief qed_ptt_pool_alloc - Allocate and initialize PTT pool
* qed_ptt_pool_alloc(): Allocate and initialize PTT pool.
*
* @param p_hwfn
* @p_hwfn: HW device data.
*
* @return struct _qed_status - success (0), negative - error.
* Return: struct _qed_status - success (0), negative - error.
*/
int qed_ptt_pool_alloc(struct qed_hwfn *p_hwfn);
/**
* @brief qed_ptt_pool_free -
* qed_ptt_pool_free(): Free PTT pool.
*
* @p_hwfn: HW device data.
*
* @param p_hwfn
* Return: Void.
*/
void qed_ptt_pool_free(struct qed_hwfn *p_hwfn);
/**
* @brief qed_ptt_get_hw_addr - Get PTT's GRC/HW address
* qed_ptt_get_hw_addr(): Get PTT's GRC/HW address.
*
* @param p_hwfn
* @param p_ptt
* @p_hwfn: HW device data.
* @p_ptt: P_ptt
*
* @return u32
* Return: u32.
*/
u32 qed_ptt_get_hw_addr(struct qed_hwfn *p_hwfn,
struct qed_ptt *p_ptt);
/**
* @brief qed_ptt_get_bar_addr - Get PPT's external BAR address
* qed_ptt_get_bar_addr(): Get PPT's external BAR address.
*
* @param p_hwfn
* @param p_ptt
* @p_ptt: P_ptt
*
* @return u32
* Return: u32.
*/
u32 qed_ptt_get_bar_addr(struct qed_ptt *p_ptt);
/**
* @brief qed_ptt_set_win - Set PTT Window's GRC BAR address
* qed_ptt_set_win(): Set PTT Window's GRC BAR address
*
* @param p_hwfn
* @param new_hw_addr
* @param p_ptt
* @p_hwfn: HW device data.
* @new_hw_addr: New HW address.
* @p_ptt: P_Ptt
*
* Return: Void.
*/
void qed_ptt_set_win(struct qed_hwfn *p_hwfn,
struct qed_ptt *p_ptt,
u32 new_hw_addr);
/**
* @brief qed_get_reserved_ptt - Get a specific reserved PTT
* qed_get_reserved_ptt(): Get a specific reserved PTT.
*
* @param p_hwfn
* @param ptt_idx
* @p_hwfn: HW device data.
* @ptt_idx: Ptt Index.
*
* @return struct qed_ptt *
* Return: struct qed_ptt *.
*/
struct qed_ptt *qed_get_reserved_ptt(struct qed_hwfn *p_hwfn,
enum reserved_ptts ptt_idx);
/**
* @brief qed_wr - Write value to BAR using the given ptt
* qed_wr(): Write value to BAR using the given ptt.
*
* @p_hwfn: HW device data.
* @p_ptt: P_ptt.
* @val: Val.
* @hw_addr: HW address
*
* @param p_hwfn
* @param p_ptt
* @param val
* @param hw_addr
* Return: Void.
*/
void qed_wr(struct qed_hwfn *p_hwfn,
struct qed_ptt *p_ptt,
......@@ -139,26 +148,28 @@ void qed_wr(struct qed_hwfn *p_hwfn,
u32 val);
/**
* @brief qed_rd - Read value from BAR using the given ptt
* qed_rd(): Read value from BAR using the given ptt.
*
* @p_hwfn: HW device data.
* @p_ptt: P_ptt.
* @hw_addr: HW address
*
* @param p_hwfn
* @param p_ptt
* @param val
* @param hw_addr
* Return: Void.
*/
u32 qed_rd(struct qed_hwfn *p_hwfn,
struct qed_ptt *p_ptt,
u32 hw_addr);
/**
* @brief qed_memcpy_from - copy n bytes from BAR using the given
* ptt
*
* @param p_hwfn
* @param p_ptt
* @param dest
* @param hw_addr
* @param n
* qed_memcpy_from(): Copy n bytes from BAR using the given ptt.
*
* @p_hwfn: HW device data.
* @p_ptt: P_ptt.
* @dest: Destination.
* @hw_addr: HW address.
* @n: N
*
* Return: Void.
*/
void qed_memcpy_from(struct qed_hwfn *p_hwfn,
struct qed_ptt *p_ptt,
......@@ -167,14 +178,15 @@ void qed_memcpy_from(struct qed_hwfn *p_hwfn,
size_t n);
/**
* @brief qed_memcpy_to - copy n bytes to BAR using the given
* ptt
*
* @param p_hwfn
* @param p_ptt
* @param hw_addr
* @param src
* @param n
* qed_memcpy_to(): Copy n bytes to BAR using the given ptt
*
* @p_hwfn: HW device data.
* @p_ptt: P_ptt.
* @hw_addr: HW address.
* @src: Source.
* @n: N
*
* Return: Void.
*/
void qed_memcpy_to(struct qed_hwfn *p_hwfn,
struct qed_ptt *p_ptt,
......@@ -182,83 +194,97 @@ void qed_memcpy_to(struct qed_hwfn *p_hwfn,
void *src,
size_t n);
/**
* @brief qed_fid_pretend - pretend to another function when
* qed_fid_pretend(): pretend to another function when
* accessing the ptt window. There is no way to unpretend
* a function. The only way to cancel a pretend is to
* pretend back to the original function.
*
* @param p_hwfn
* @param p_ptt
* @param fid - fid field of pxp_pretend structure. Can contain
* @p_hwfn: HW device data.
* @p_ptt: P_ptt.
* @fid: fid field of pxp_pretend structure. Can contain
* either pf / vf, port/path fields are don't care.
*
* Return: Void.
*/
void qed_fid_pretend(struct qed_hwfn *p_hwfn,
struct qed_ptt *p_ptt,
u16 fid);
/**
* @brief qed_port_pretend - pretend to another port when
* accessing the ptt window
* qed_port_pretend(): Pretend to another port when accessing the ptt window
*
* @param p_hwfn
* @param p_ptt
* @param port_id - the port to pretend to
* @p_hwfn: HW device data.
* @p_ptt: P_ptt.
* @port_id: The port to pretend to
*
* Return: Void.
*/
void qed_port_pretend(struct qed_hwfn *p_hwfn,
struct qed_ptt *p_ptt,
u8 port_id);
/**
* @brief qed_port_unpretend - cancel any previously set port
* pretend
* qed_port_unpretend(): Cancel any previously set port pretend
*
* @p_hwfn: HW device data.
* @p_ptt: P_ptt.
*
* @param p_hwfn
* @param p_ptt
* Return: Void.
*/
void qed_port_unpretend(struct qed_hwfn *p_hwfn,
struct qed_ptt *p_ptt);
/**
* @brief qed_port_fid_pretend - pretend to another port and another function
* qed_port_fid_pretend(): Pretend to another port and another function
* when accessing the ptt window
*
* @param p_hwfn
* @param p_ptt
* @param port_id - the port to pretend to
* @param fid - fid field of pxp_pretend structure. Can contain either pf / vf.
* @p_hwfn: HW device data.
* @p_ptt: P_ptt.
* @port_id: The port to pretend to
* @fid: fid field of pxp_pretend structure. Can contain either pf / vf.
*
* Return: Void.
*/
void qed_port_fid_pretend(struct qed_hwfn *p_hwfn,
struct qed_ptt *p_ptt, u8 port_id, u16 fid);
/**
* @brief qed_vfid_to_concrete - build a concrete FID for a
* given VF ID
* qed_vfid_to_concrete(): Build a concrete FID for a given VF ID
*
* @param p_hwfn
* @param p_ptt
* @param vfid
* @p_hwfn: HW device data.
* @vfid: VFID.
*
* Return: Void.
*/
u32 qed_vfid_to_concrete(struct qed_hwfn *p_hwfn, u8 vfid);
/**
* @brief qed_dmae_idx_to_go_cmd - map the idx to dmae cmd
* qed_dmae_idx_to_go_cmd(): Map the idx to dmae cmd
* this is declared here since other files will require it.
* @param idx
*
* @idx: Index
*
* Return: Void.
*/
u32 qed_dmae_idx_to_go_cmd(u8 idx);
/**
* @brief qed_dmae_info_alloc - Init the dmae_info structure
* qed_dmae_info_alloc(): Init the dmae_info structure
* which is part of p_hwfn.
* @param p_hwfn
*
* @p_hwfn: HW device data.
*
* Return: Int.
*/
int qed_dmae_info_alloc(struct qed_hwfn *p_hwfn);
/**
* @brief qed_dmae_info_free - Free the dmae_info structure
* which is part of p_hwfn
* qed_dmae_info_free(): Free the dmae_info structure
* which is part of p_hwfn.
*
* @param p_hwfn
* @p_hwfn: HW device data.
*
* Return: Void.
*/
void qed_dmae_info_free(struct qed_hwfn *p_hwfn);
......@@ -292,14 +318,16 @@ int qed_dmae_sanity(struct qed_hwfn *p_hwfn,
#define QED_HW_ERR_MAX_STR_SIZE 256
/**
* @brief qed_hw_err_notify - Notify upper layer driver and management FW
* qed_hw_err_notify(): Notify upper layer driver and management FW
* about a HW error.
*
* @param p_hwfn
* @param p_ptt
* @param err_type
* @param fmt - debug data buffer to send to the MFW
* @param ... - buffer format args
* @p_hwfn: HW device data.
* @p_ptt: P_ptt.
* @err_type: Err Type.
* @fmt: Debug data buffer to send to the MFW
* @...: buffer format args
*
* Return void.
*/
void __printf(4, 5) __cold qed_hw_err_notify(struct qed_hwfn *p_hwfn,
struct qed_ptt *p_ptt,
......
......@@ -12,23 +12,24 @@
#include "qed.h"
/**
* @brief qed_init_iro_array - init iro_arr.
* qed_init_iro_array(): init iro_arr.
*
* @cdev: Qed dev pointer.
*
* @param cdev
* Return: Void.
*/
void qed_init_iro_array(struct qed_dev *cdev);
/**
* @brief qed_init_run - Run the init-sequence.
* qed_init_run(): Run the init-sequence.
*
* @p_hwfn: HW device data.
* @p_ptt: P_ptt.
* @phase: Phase.
* @phase_id: Phase ID.
* @modes: Mode.
*
* @param p_hwfn
* @param p_ptt
* @param phase
* @param phase_id
* @param modes
* @return _qed_status_t
* Return: _qed_status_t
*/
int qed_init_run(struct qed_hwfn *p_hwfn,
struct qed_ptt *p_ptt,
......@@ -37,30 +38,31 @@ int qed_init_run(struct qed_hwfn *p_hwfn,
int modes);
/**
* @brief qed_init_hwfn_allocate - Allocate RT array, Store 'values' ptrs.
* qed_init_alloc(): Allocate RT array, Store 'values' ptrs.
*
* @p_hwfn: HW device data.
*
* @param p_hwfn
*
* @return _qed_status_t
* Return: _qed_status_t.
*/
int qed_init_alloc(struct qed_hwfn *p_hwfn);
/**
* @brief qed_init_hwfn_deallocate
* qed_init_free(): Init HW function deallocate.
*
* @p_hwfn: HW device data.
*
* @param p_hwfn
* Return: Void.
*/
void qed_init_free(struct qed_hwfn *p_hwfn);
/**
* @brief qed_init_store_rt_reg - Store a configuration value in the RT array.
* qed_init_store_rt_reg(): Store a configuration value in the RT array.
*
* @p_hwfn: HW device data.
* @rt_offset: RT offset.
* @val: Val.
*
* @param p_hwfn
* @param rt_offset
* @param val
* Return: Void.
*/
void qed_init_store_rt_reg(struct qed_hwfn *p_hwfn,
u32 rt_offset,
......@@ -72,15 +74,6 @@ void qed_init_store_rt_reg(struct qed_hwfn *p_hwfn,
#define OVERWRITE_RT_REG(hwfn, offset, val) \
qed_init_store_rt_reg(hwfn, offset, val)
/**
* @brief
*
*
* @param p_hwfn
* @param rt_offset
* @param val
* @param size
*/
void qed_init_store_rt_agg(struct qed_hwfn *p_hwfn,
u32 rt_offset,
u32 *val,
......@@ -90,11 +83,12 @@ void qed_init_store_rt_agg(struct qed_hwfn *p_hwfn,
qed_init_store_rt_agg(hwfn, offset, (u32 *)&val, sizeof(val))
/**
* @brief
* Initialize GTT global windows and set admin window
* qed_gtt_init(): Initialize GTT global windows and set admin window
* related params of GTT/PTT to default values.
*
* @param p_hwfn
* @p_hwfn: HW device data.
*
* Return Void.
*/
void qed_gtt_init(struct qed_hwfn *p_hwfn);
#endif
This diff is collapsed.
......@@ -34,10 +34,13 @@ void qed_iscsi_setup(struct qed_hwfn *p_hwfn);
void qed_iscsi_free(struct qed_hwfn *p_hwfn);
/**
* @brief - Fills provided statistics struct with statistics.
* qed_get_protocol_stats_iscsi(): Fills provided statistics
* struct with statistics.
*
* @param cdev
* @param stats - points to struct that will be filled with statistics.
* @cdev: Qed dev pointer.
* @stats: Points to struct that will be filled with statistics.
*
* Return: Void.
*/
void qed_get_protocol_stats_iscsi(struct qed_dev *cdev,
struct qed_mcp_iscsi_stats *stats);
......
......@@ -92,18 +92,18 @@ struct qed_filter_mcast {
};
/**
* @brief qed_eth_rx_queue_stop - This ramrod closes an Rx queue
* qed_eth_rx_queue_stop(): This ramrod closes an Rx queue.
*
* @param p_hwfn
* @param p_rxq Handler of queue to close
* @param eq_completion_only If True completion will be on
* @p_hwfn: HW device data.
* @p_rxq: Handler of queue to close
* @eq_completion_only: If True completion will be on
* EQe, if False completion will be
* on EQe if p_hwfn opaque
* different from the RXQ opaque
* otherwise on CQe.
* @param cqe_completion If True completion will be
* receive on CQe.
* @return int
* @cqe_completion: If True completion will be receive on CQe.
*
* Return: Int.
*/
int
qed_eth_rx_queue_stop(struct qed_hwfn *p_hwfn,
......@@ -111,12 +111,12 @@ qed_eth_rx_queue_stop(struct qed_hwfn *p_hwfn,
bool eq_completion_only, bool cqe_completion);
/**
* @brief qed_eth_tx_queue_stop - closes a Tx queue
* qed_eth_tx_queue_stop(): Closes a Tx queue.
*
* @param p_hwfn
* @param p_txq - handle to Tx queue needed to be closed
* @p_hwfn: HW device data.
* @p_txq: handle to Tx queue needed to be closed.
*
* @return int
* Return: Int.
*/
int qed_eth_tx_queue_stop(struct qed_hwfn *p_hwfn, void *p_txq);
......@@ -205,16 +205,15 @@ int qed_sp_vport_update(struct qed_hwfn *p_hwfn,
struct qed_spq_comp_cb *p_comp_data);
/**
* @brief qed_sp_vport_stop -
*
* This ramrod closes a VPort after all its RX and TX queues are terminated.
* qed_sp_vport_stop: This ramrod closes a VPort after all its
* RX and TX queues are terminated.
* An Assert is generated if any queues are left open.
*
* @param p_hwfn
* @param opaque_fid
* @param vport_id VPort ID
* @p_hwfn: HW device data.
* @opaque_fid: Opaque FID
* @vport_id: VPort ID.
*
* @return int
* Return: Int.
*/
int qed_sp_vport_stop(struct qed_hwfn *p_hwfn, u16 opaque_fid, u8 vport_id);
......@@ -225,22 +224,21 @@ int qed_sp_eth_filter_ucast(struct qed_hwfn *p_hwfn,
struct qed_spq_comp_cb *p_comp_data);
/**
* @brief qed_sp_rx_eth_queues_update -
*
* This ramrod updates an RX queue. It is used for setting the active state
* of the queue and updating the TPA and SGE parameters.
*
* @note At the moment - only used by non-linux VFs.
* qed_sp_eth_rx_queues_update(): This ramrod updates an RX queue.
* It is used for setting the active state
* of the queue and updating the TPA and
* SGE parameters.
* @p_hwfn: HW device data.
* @pp_rxq_handlers: An array of queue handlers to be updated.
* @num_rxqs: number of queues to update.
* @complete_cqe_flg: Post completion to the CQE Ring if set.
* @complete_event_flg: Post completion to the Event Ring if set.
* @comp_mode: Comp mode.
* @p_comp_data: Pointer Comp data.
*
* @param p_hwfn
* @param pp_rxq_handlers An array of queue handlers to be updated.
* @param num_rxqs number of queues to update.
* @param complete_cqe_flg Post completion to the CQE Ring if set
* @param complete_event_flg Post completion to the Event Ring if set
* @param comp_mode
* @param p_comp_data
* Return: Int.
*
* @return int
* Note At the moment - only used by non-linux VFs.
*/
int
......@@ -257,30 +255,32 @@ void qed_get_vport_stats(struct qed_dev *cdev, struct qed_eth_stats *stats);
void qed_reset_vport_stats(struct qed_dev *cdev);
/**
* *@brief qed_arfs_mode_configure -
* qed_arfs_mode_configure(): Enable or disable rfs mode.
* It must accept at least one of tcp or udp true
* and at least one of ipv4 or ipv6 true to enable
* rfs mode.
*
**Enable or disable rfs mode. It must accept atleast one of tcp or udp true
**and atleast one of ipv4 or ipv6 true to enable rfs mode.
*
**@param p_hwfn
**@param p_ptt
**@param p_cfg_params - arfs mode configuration parameters.
* @p_hwfn: HW device data.
* @p_ptt: P_ptt.
* @p_cfg_params: arfs mode configuration parameters.
*
* Return. Void.
*/
void qed_arfs_mode_configure(struct qed_hwfn *p_hwfn,
struct qed_ptt *p_ptt,
struct qed_arfs_config_params *p_cfg_params);
/**
* @brief - qed_configure_rfs_ntuple_filter
*
* This ramrod should be used to add or remove arfs hw filter
* qed_configure_rfs_ntuple_filter(): This ramrod should be used to add
* or remove arfs hw filter
*
* @params p_hwfn
* @params p_cb - Used for QED_SPQ_MODE_CB,where client would initialize
* @p_hwfn: HW device data.
* @p_cb: Used for QED_SPQ_MODE_CB,where client would initialize
* it with cookie and callback function address, if not
* using this mode then client must pass NULL.
* @params p_params
* @p_params: Pointer to params.
*
* Return: Void.
*/
int
qed_configure_rfs_ntuple_filter(struct qed_hwfn *p_hwfn,
......@@ -374,16 +374,17 @@ qed_sp_eth_vport_start(struct qed_hwfn *p_hwfn,
struct qed_sp_vport_start_params *p_params);
/**
* @brief - Starts an Rx queue, when queue_cid is already prepared
* qed_eth_rxq_start_ramrod(): Starts an Rx queue, when queue_cid is
* already prepared
*
* @param p_hwfn
* @param p_cid
* @param bd_max_bytes
* @param bd_chain_phys_addr
* @param cqe_pbl_addr
* @param cqe_pbl_size
* @p_hwfn: HW device data.
* @p_cid: Pointer CID.
* @bd_max_bytes: Max bytes.
* @bd_chain_phys_addr: Chain physcial address.
* @cqe_pbl_addr: PBL address.
* @cqe_pbl_size: PBL size.
*
* @return int
* Return: Int.
*/
int
qed_eth_rxq_start_ramrod(struct qed_hwfn *p_hwfn,
......@@ -393,15 +394,16 @@ qed_eth_rxq_start_ramrod(struct qed_hwfn *p_hwfn,
dma_addr_t cqe_pbl_addr, u16 cqe_pbl_size);
/**
* @brief - Starts a Tx queue, where queue_cid is already prepared
* qed_eth_txq_start_ramrod(): Starts a Tx queue, where queue_cid is
* already prepared
*
* @param p_hwfn
* @param p_cid
* @param pbl_addr
* @param pbl_size
* @param p_pq_params - parameters for choosing the PQ for this Tx queue
* @p_hwfn: HW device data.
* @p_cid: Pointer CID.
* @pbl_addr: PBL address.
* @pbl_size: PBL size.
* @pq_id: Parameters for choosing the PQ for this Tx queue.
*
* @return int
* Return: Int.
*/
int
qed_eth_txq_start_ramrod(struct qed_hwfn *p_hwfn,
......
......@@ -119,41 +119,41 @@ struct qed_ll2_info {
extern const struct qed_ll2_ops qed_ll2_ops_pass;
/**
* @brief qed_ll2_acquire_connection - allocate resources,
* starts rx & tx (if relevant) queues pair. Provides
* connecion handler as output parameter.
* qed_ll2_acquire_connection(): Allocate resources,
* starts rx & tx (if relevant) queues pair.
* Provides connecion handler as output
* parameter.
*
* @cxt: Pointer to the hw-function [opaque to some].
* @data: Describes connection parameters.
*
* @param cxt - pointer to the hw-function [opaque to some]
* @param data - describes connection parameters
* @return int
* Return: Int.
*/
int qed_ll2_acquire_connection(void *cxt, struct qed_ll2_acquire_data *data);
/**
* @brief qed_ll2_establish_connection - start previously
* allocated LL2 queues pair
* qed_ll2_establish_connection(): start previously allocated LL2 queues pair
*
* @param cxt - pointer to the hw-function [opaque to some]
* @param p_ptt
* @param connection_handle LL2 connection's handle obtained from
* qed_ll2_require_connection
* @cxt: Pointer to the hw-function [opaque to some].
* @connection_handle: LL2 connection's handle obtained from
* qed_ll2_require_connection.
*
* @return 0 on success, failure otherwise
* Return: 0 on success, failure otherwise.
*/
int qed_ll2_establish_connection(void *cxt, u8 connection_handle);
/**
* @brief qed_ll2_post_rx_buffers - submit buffers to LL2 Rx queue.
* qed_ll2_post_rx_buffer(): Submit buffers to LL2 Rx queue.
*
* @param cxt - pointer to the hw-function [opaque to some]
* @param connection_handle LL2 connection's handle obtained from
* qed_ll2_require_connection
* @param addr rx (physical address) buffers to submit
* @param cookie
* @param notify_fw produce corresponding Rx BD immediately
* @cxt: Pointer to the hw-function [opaque to some].
* @connection_handle: LL2 connection's handle obtained from
* qed_ll2_require_connection.
* @addr: RX (physical address) buffers to submit.
* @buf_len: Buffer Len.
* @cookie: Cookie.
* @notify_fw: Produce corresponding Rx BD immediately.
*
* @return 0 on success, failure otherwise
* Return: 0 on success, failure otherwise.
*/
int qed_ll2_post_rx_buffer(void *cxt,
u8 connection_handle,
......@@ -161,15 +161,15 @@ int qed_ll2_post_rx_buffer(void *cxt,
u16 buf_len, void *cookie, u8 notify_fw);
/**
* @brief qed_ll2_prepare_tx_packet - request for start Tx BD
* qed_ll2_prepare_tx_packet(): Request for start Tx BD
* to prepare Tx packet submission to FW.
*
* @param cxt - pointer to the hw-function [opaque to some]
* @param connection_handle
* @param pkt - info regarding the tx packet
* @param notify_fw - issue doorbell to fw for this packet
* @cxt: Pointer to the hw-function [opaque to some].
* @connection_handle: Connection handle.
* @pkt: Info regarding the tx packet.
* @notify_fw: Issue doorbell to fw for this packet.
*
* @return 0 on success, failure otherwise
* Return: 0 on success, failure otherwise.
*/
int qed_ll2_prepare_tx_packet(void *cxt,
u8 connection_handle,
......@@ -177,81 +177,83 @@ int qed_ll2_prepare_tx_packet(void *cxt,
bool notify_fw);
/**
* @brief qed_ll2_release_connection - releases resources
* allocated for LL2 connection
* qed_ll2_release_connection(): Releases resources allocated for LL2
* connection.
*
* @param cxt - pointer to the hw-function [opaque to some]
* @param connection_handle LL2 connection's handle obtained from
* qed_ll2_require_connection
* @cxt: Pointer to the hw-function [opaque to some].
* @connection_handle: LL2 connection's handle obtained from
* qed_ll2_require_connection.
*
* Return: Void.
*/
void qed_ll2_release_connection(void *cxt, u8 connection_handle);
/**
* @brief qed_ll2_set_fragment_of_tx_packet - provides fragments to fill
* qed_ll2_set_fragment_of_tx_packet(): Provides fragments to fill
* Tx BD of BDs requested by
* qed_ll2_prepare_tx_packet
*
* @param cxt - pointer to the hw-function [opaque to some]
* @param connection_handle LL2 connection's handle
* obtained from
* qed_ll2_require_connection
* @param addr
* @param nbytes
* @cxt: Pointer to the hw-function [opaque to some].
* @connection_handle: LL2 connection's handle obtained from
* qed_ll2_require_connection.
* @addr: Address.
* @nbytes: Number of bytes.
*
* @return 0 on success, failure otherwise
* Return: 0 on success, failure otherwise.
*/
int qed_ll2_set_fragment_of_tx_packet(void *cxt,
u8 connection_handle,
dma_addr_t addr, u16 nbytes);
/**
* @brief qed_ll2_terminate_connection - stops Tx/Rx queues
*
* qed_ll2_terminate_connection(): Stops Tx/Rx queues
*
* @param cxt - pointer to the hw-function [opaque to some]
* @param connection_handle LL2 connection's handle
* obtained from
* qed_ll2_require_connection
* @cxt: Pointer to the hw-function [opaque to some].
* @connection_handle: LL2 connection's handle obtained from
* qed_ll2_require_connection.
*
* @return 0 on success, failure otherwise
* Return: 0 on success, failure otherwise.
*/
int qed_ll2_terminate_connection(void *cxt, u8 connection_handle);
/**
* @brief qed_ll2_get_stats - get LL2 queue's statistics
*
* qed_ll2_get_stats(): Get LL2 queue's statistics
*
* @param cxt - pointer to the hw-function [opaque to some]
* @param connection_handle LL2 connection's handle obtained from
* qed_ll2_require_connection
* @param p_stats
* @cxt: Pointer to the hw-function [opaque to some].
* @connection_handle: LL2 connection's handle obtained from
* qed_ll2_require_connection.
* @p_stats: Pointer Status.
*
* @return 0 on success, failure otherwise
* Return: 0 on success, failure otherwise.
*/
int qed_ll2_get_stats(void *cxt,
u8 connection_handle, struct qed_ll2_stats *p_stats);
/**
* @brief qed_ll2_alloc - Allocates LL2 connections set
* qed_ll2_alloc(): Allocates LL2 connections set.
*
* @param p_hwfn
* @p_hwfn: HW device data.
*
* @return int
* Return: Int.
*/
int qed_ll2_alloc(struct qed_hwfn *p_hwfn);
/**
* @brief qed_ll2_setup - Inits LL2 connections set
* qed_ll2_setup(): Inits LL2 connections set.
*
* @param p_hwfn
* @p_hwfn: HW device data.
*
* Return: Void.
*
*/
void qed_ll2_setup(struct qed_hwfn *p_hwfn);
/**
* @brief qed_ll2_free - Releases LL2 connections set
* qed_ll2_free(): Releases LL2 connections set
*
* @p_hwfn: HW device data.
*
* @param p_hwfn
* Return: Void.
*
*/
void qed_ll2_free(struct qed_hwfn *p_hwfn);
......
This diff is collapsed.
......@@ -6,47 +6,47 @@
#include <linux/types.h>
/**
* @brief qed_selftest_memory - Perform memory test
* qed_selftest_memory(): Perform memory test.
*
* @param cdev
* @cdev: Qed dev pointer.
*
* @return int
* Return: Int.
*/
int qed_selftest_memory(struct qed_dev *cdev);
/**
* @brief qed_selftest_interrupt - Perform interrupt test
* qed_selftest_interrupt(): Perform interrupt test.
*
* @param cdev
* @cdev: Qed dev pointer.
*
* @return int
* Return: Int.
*/
int qed_selftest_interrupt(struct qed_dev *cdev);
/**
* @brief qed_selftest_register - Perform register test
* qed_selftest_register(): Perform register test.
*
* @param cdev
* @cdev: Qed dev pointer.
*
* @return int
* Return: Int.
*/
int qed_selftest_register(struct qed_dev *cdev);
/**
* @brief qed_selftest_clock - Perform clock test
* qed_selftest_clock(): Perform clock test.
*
* @param cdev
* @cdev: Qed dev pointer.
*
* @return int
* Return: Int.
*/
int qed_selftest_clock(struct qed_dev *cdev);
/**
* @brief qed_selftest_nvram - Perform nvram test
* qed_selftest_nvram(): Perform nvram test.
*
* @param cdev
* @cdev: Qed dev pointer.
*
* @return int
* Return: Int.
*/
int qed_selftest_nvram(struct qed_dev *cdev);
......
This diff is collapsed.
......@@ -250,29 +250,31 @@ extern const struct qed_iov_hv_ops qed_iov_ops_pass;
#ifdef CONFIG_QED_SRIOV
/**
* @brief Check if given VF ID @vfid is valid
* qed_iov_is_valid_vfid(): Check if given VF ID @vfid is valid
* w.r.t. @b_enabled_only value
* if b_enabled_only = true - only enabled VF id is valid
* else any VF id less than max_vfs is valid
* if b_enabled_only = true - only enabled
* VF id is valid.
* else any VF id less than max_vfs is valid.
*
* @param p_hwfn
* @param rel_vf_id - Relative VF ID
* @param b_enabled_only - consider only enabled VF
* @param b_non_malicious - true iff we want to validate vf isn't malicious.
* @p_hwfn: HW device data.
* @rel_vf_id: Relative VF ID.
* @b_enabled_only: consider only enabled VF.
* @b_non_malicious: true iff we want to validate vf isn't malicious.
*
* @return bool - true for valid VF ID
* Return: bool - true for valid VF ID
*/
bool qed_iov_is_valid_vfid(struct qed_hwfn *p_hwfn,
int rel_vf_id,
bool b_enabled_only, bool b_non_malicious);
/**
* @brief - Given a VF index, return index of next [including that] active VF.
* qed_iov_get_next_active_vf(): Given a VF index, return index of
* next [including that] active VF.
*
* @param p_hwfn
* @param rel_vf_id
* @p_hwfn: HW device data.
* @rel_vf_id: VF ID.
*
* @return MAX_NUM_VFS in case no further active VFs, otherwise index.
* Return: MAX_NUM_VFS in case no further active VFs, otherwise index.
*/
u16 qed_iov_get_next_active_vf(struct qed_hwfn *p_hwfn, u16 rel_vf_id);
......@@ -280,83 +282,92 @@ void qed_iov_bulletin_set_udp_ports(struct qed_hwfn *p_hwfn,
int vfid, u16 vxlan_port, u16 geneve_port);
/**
* @brief Read sriov related information and allocated resources
* qed_iov_hw_info(): Read sriov related information and allocated resources
* reads from configuration space, shmem, etc.
*
* @param p_hwfn
* @p_hwfn: HW device data.
*
* @return int
* Return: Int.
*/
int qed_iov_hw_info(struct qed_hwfn *p_hwfn);
/**
* @brief qed_add_tlv - place a given tlv on the tlv buffer at next offset
* qed_add_tlv(): place a given tlv on the tlv buffer at next offset
*
* @param p_hwfn
* @param p_iov
* @param type
* @param length
* @p_hwfn: HW device data.
* @offset: offset.
* @type: Type
* @length: Length.
*
* @return pointer to the newly placed tlv
* Return: pointer to the newly placed tlv
*/
void *qed_add_tlv(struct qed_hwfn *p_hwfn, u8 **offset, u16 type, u16 length);
/**
* @brief list the types and lengths of the tlvs on the buffer
* qed_dp_tlv_list(): list the types and lengths of the tlvs on the buffer
*
* @param p_hwfn
* @param tlvs_list
* @p_hwfn: HW device data.
* @tlvs_list: Tlvs_list.
*
* Return: Void.
*/
void qed_dp_tlv_list(struct qed_hwfn *p_hwfn, void *tlvs_list);
/**
* @brief qed_iov_alloc - allocate sriov related resources
* qed_iov_alloc(): allocate sriov related resources
*
* @param p_hwfn
* @p_hwfn: HW device data.
*
* @return int
* Return: Int.
*/
int qed_iov_alloc(struct qed_hwfn *p_hwfn);
/**
* @brief qed_iov_setup - setup sriov related resources
* qed_iov_setup(): setup sriov related resources
*
* @p_hwfn: HW device data.
*
* @param p_hwfn
* Return: Void.
*/
void qed_iov_setup(struct qed_hwfn *p_hwfn);
/**
* @brief qed_iov_free - free sriov related resources
* qed_iov_free(): free sriov related resources
*
* @param p_hwfn
* @p_hwfn: HW device data.
*
* Return: Void.
*/
void qed_iov_free(struct qed_hwfn *p_hwfn);
/**
* @brief free sriov related memory that was allocated during hw_prepare
* qed_iov_free_hw_info(): free sriov related memory that was
* allocated during hw_prepare
*
* @cdev: Qed dev pointer.
*
* @param cdev
* Return: Void.
*/
void qed_iov_free_hw_info(struct qed_dev *cdev);
/**
* @brief Mark structs of vfs that have been FLR-ed.
* qed_iov_mark_vf_flr(): Mark structs of vfs that have been FLR-ed.
*
* @param p_hwfn
* @param disabled_vfs - bitmask of all VFs on path that were FLRed
* @p_hwfn: HW device data.
* @disabled_vfs: bitmask of all VFs on path that were FLRed
*
* @return true iff one of the PF's vfs got FLRed. false otherwise.
* Return: true iff one of the PF's vfs got FLRed. false otherwise.
*/
bool qed_iov_mark_vf_flr(struct qed_hwfn *p_hwfn, u32 *disabled_vfs);
/**
* @brief Search extended TLVs in request/reply buffer.
* qed_iov_search_list_tlvs(): Search extended TLVs in request/reply buffer.
*
* @param p_hwfn
* @param p_tlvs_list - Pointer to tlvs list
* @param req_type - Type of TLV
* @p_hwfn: HW device data.
* @p_tlvs_list: Pointer to tlvs list
* @req_type: Type of TLV
*
* @return pointer to tlv type if found, otherwise returns NULL.
* Return: pointer to tlv type if found, otherwise returns NULL.
*/
void *qed_iov_search_list_tlvs(struct qed_hwfn *p_hwfn,
void *p_tlvs_list, u16 req_type);
......
This diff is collapsed.
......@@ -2800,10 +2800,13 @@ static void qede_get_eth_tlv_data(void *dev, void *data)
}
/**
* qede_io_error_detected - called when PCI error is detected
* qede_io_error_detected(): Called when PCI error is detected
*
* @pdev: Pointer to PCI device
* @state: The current pci connection state
*
*Return: pci_ers_result_t.
*
* This function is called after a PCI bus error affecting
* this device has been detected.
*/
......
This diff is collapsed.
This diff is collapsed.
......@@ -182,7 +182,7 @@ struct qed_iscsi_cb_ops {
* @param stats - pointer to struck that would be filled
* we stats
* @return 0 on success, error otherwise.
* @change_mac Change MAC of interface
* @change_mac: Change MAC of interface
* @param cdev
* @param handle - the connection handle.
* @param mac - new MAC to configure.
......
......@@ -208,57 +208,57 @@ enum qed_ll2_xmit_flags {
struct qed_ll2_ops {
/**
* @brief start - initializes ll2
* start(): Initializes ll2.
*
* @param cdev
* @param params - protocol driver configuration for the ll2.
* @cdev: Qed dev pointer.
* @params: Protocol driver configuration for the ll2.
*
* @return 0 on success, otherwise error value.
* Return: 0 on success, otherwise error value.
*/
int (*start)(struct qed_dev *cdev, struct qed_ll2_params *params);
/**
* @brief stop - stops the ll2
* stop(): Stops the ll2
*
* @param cdev
* @cdev: Qed dev pointer.
*
* @return 0 on success, otherwise error value.
* Return: 0 on success, otherwise error value.
*/
int (*stop)(struct qed_dev *cdev);
/**
* @brief start_xmit - transmits an skb over the ll2 interface
* start_xmit(): Transmits an skb over the ll2 interface
*
* @param cdev
* @param skb
* @param xmit_flags - Transmit options defined by the enum qed_ll2_xmit_flags.
* @cdev: Qed dev pointer.
* @skb: SKB.
* @xmit_flags: Transmit options defined by the enum qed_ll2_xmit_flags.
*
* @return 0 on success, otherwise error value.
* Return: 0 on success, otherwise error value.
*/
int (*start_xmit)(struct qed_dev *cdev, struct sk_buff *skb,
unsigned long xmit_flags);
/**
* @brief register_cb_ops - protocol driver register the callback for Rx/Tx
* register_cb_ops(): Protocol driver register the callback for Rx/Tx
* packets. Should be called before `start'.
*
* @param cdev
* @param cookie - to be passed to the callback functions.
* @param ops - the callback functions to register for Rx / Tx.
* @cdev: Qed dev pointer.
* @cookie: to be passed to the callback functions.
* @ops: the callback functions to register for Rx / Tx.
*
* @return 0 on success, otherwise error value.
* Return: 0 on success, otherwise error value.
*/
void (*register_cb_ops)(struct qed_dev *cdev,
const struct qed_ll2_cb_ops *ops,
void *cookie);
/**
* @brief get LL2 related statistics
* get_stats(): Get LL2 related statistics.
*
* @param cdev
* @param stats - pointer to struct that would be filled with stats
* @cdev: Qed dev pointer.
* @stats: Pointer to struct that would be filled with stats.
*
* @return 0 on success, error otherwise.
* Return: 0 on success, error otherwise.
*/
int (*get_stats)(struct qed_dev *cdev, struct qed_ll2_stats *stats);
};
......
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment