qed_sp.h | Explore in Territory

/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) */
/* QLogic qed NIC Driver
 * Copyright (c) 2015-2017  QLogic Corporation
 * Copyright (c) 2019-2020 Marvell International Ltd.
 */

#ifndef _QED_SP_H
#define _QED_SP_H

#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/list.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/qed/qed_chain.h>
#include "qed.h"
#include "qed_hsi.h"

enum spq_mode { … };

struct qed_spq_comp_cb { … };

/**
 * qed_eth_cqe_completion(): handles the completion of a
 *                           ramrod on the cqe ring.
 *
 * @p_hwfn: HW device data.
 * @cqe: CQE.
 *
 * Return: Int.
 */
int qed_eth_cqe_completion(struct qed_hwfn *p_hwfn,
			   struct eth_slow_path_rx_cqe *cqe);

 /*  QED Slow-hwfn queue interface */
ramrod_data;

#define EQ_MAX_CREDIT …

enum spq_priority { … };

qed_spq_req_comp;

struct qed_spq_comp_done { … };

struct qed_spq_entry { … };

struct qed_eq { … };

struct qed_consq { … };

qed_spq_async_comp_cb;

int
qed_spq_register_async_cb(struct qed_hwfn *p_hwfn,
			  enum protocol_type protocol_id,
			  qed_spq_async_comp_cb cb);

void
qed_spq_unregister_async_cb(struct qed_hwfn *p_hwfn,
			    enum protocol_type protocol_id);

struct qed_spq { … };

/**
 * qed_spq_post(): Posts a Slow hwfn request to FW, or lacking that
 *                 Pends it to the future list.
 *
 * @p_hwfn: HW device data.
 * @p_ent: Ent.
 * @fw_return_code: Return code from firmware.
 *
 * Return: Int.
 */
int qed_spq_post(struct qed_hwfn *p_hwfn,
		 struct qed_spq_entry *p_ent,
		 u8 *fw_return_code);

/**
 * qed_spq_alloc(): Alloocates & initializes the SPQ and EQ.
 *
 * @p_hwfn: HW device data.
 *
 * Return: Int.
 */
int qed_spq_alloc(struct qed_hwfn *p_hwfn);

/**
 * qed_spq_setup(): Reset the SPQ to its start state.
 *
 * @p_hwfn: HW device data.
 *
 * Return: Void.
 */
void qed_spq_setup(struct qed_hwfn *p_hwfn);

/**
 * qed_spq_free(): Deallocates the given SPQ struct.
 *
 * @p_hwfn: HW device data.
 *
 * Return: Void.
 */
void qed_spq_free(struct qed_hwfn *p_hwfn);

/**
 * qed_spq_get_entry(): Obtain an entrry from the spq
 *                      free pool list.
 *
 * @p_hwfn: HW device data.
 * @pp_ent: PP ENT.
 *
 * Return: Int.
 */
int
qed_spq_get_entry(struct qed_hwfn *p_hwfn,
		  struct qed_spq_entry **pp_ent);

/**
 * qed_spq_return_entry(): Return an entry to spq free pool list.
 *
 * @p_hwfn: HW device data.
 * @p_ent: P ENT.
 *
 * Return: Void.
 */
void qed_spq_return_entry(struct qed_hwfn *p_hwfn,
			  struct qed_spq_entry *p_ent);
/**
 * qed_eq_alloc(): Allocates & initializes an EQ struct.
 *
 * @p_hwfn: HW device data.
 * @num_elem: number of elements in the eq.
 *
 * Return: Int.
 */
int qed_eq_alloc(struct qed_hwfn *p_hwfn, u16 num_elem);

/**
 * qed_eq_setup(): Reset the EQ to its start state.
 *
 * @p_hwfn: HW device data.
 *
 * Return: Void.
 */
void qed_eq_setup(struct qed_hwfn *p_hwfn);

/**
 * qed_eq_free(): deallocates the given EQ struct.
 *
 * @p_hwfn: HW device data.
 *
 * Return: Void.
 */
void qed_eq_free(struct qed_hwfn *p_hwfn);

/**
 * qed_eq_prod_update(): update the FW with default EQ producer.
 *
 * @p_hwfn: HW device data.
 * @prod: Prod.
 *
 * Return: Void.
 */
void qed_eq_prod_update(struct qed_hwfn *p_hwfn,
			u16 prod);

/**
 * qed_eq_completion(): Completes currently pending EQ elements.
 *
 * @p_hwfn: HW device data.
 * @cookie: Cookie.
 *
 * Return: Int.
 */
int qed_eq_completion(struct qed_hwfn *p_hwfn,
		      void *cookie);

/**
 * qed_spq_completion(): Completes a single event.
 *
 * @p_hwfn: HW device data.
 * @echo: echo value from cookie (used for determining completion).
 * @fw_return_code: FW return code.
 * @p_data: data from cookie (used in callback function if applicable).
 *
 * Return: Int.
 */
int qed_spq_completion(struct qed_hwfn *p_hwfn,
		       __le16 echo,
		       u8 fw_return_code,
		       union event_ring_data *p_data);

/**
 * qed_spq_get_cid(): Given p_hwfn, return cid for the hwfn's SPQ.
 *
 * @p_hwfn: HW device data.
 *
 * Return: u32 - SPQ CID.
 */
u32 qed_spq_get_cid(struct qed_hwfn *p_hwfn);

/**
 * qed_consq_alloc(): Allocates & initializes an ConsQ struct.
 *
 * @p_hwfn: HW device data.
 *
 * Return: Int.
 */
int qed_consq_alloc(struct qed_hwfn *p_hwfn);

/**
 * qed_consq_setup(): Reset the ConsQ to its start state.
 *
 * @p_hwfn: HW device data.
 *
 * Return Void.
 */
void qed_consq_setup(struct qed_hwfn *p_hwfn);

/**
 * qed_consq_free(): deallocates the given ConsQ struct.
 *
 * @p_hwfn: HW device data.
 *
 * Return Void.
 */
void qed_consq_free(struct qed_hwfn *p_hwfn);
int qed_spq_pend_post(struct qed_hwfn *p_hwfn);

/* Slow-hwfn low-level commands (Ramrods) function definitions. */

#define QED_SP_EQ_COMPLETION …
#define QED_SP_CQE_COMPLETION …

struct qed_sp_init_data { … };

/**
 * qed_sp_destroy_request(): Returns a SPQ entry to the pool / frees the
 *                           entry if allocated. Should be called on in error
 *                           flows after initializing the SPQ entry
 *                           and before posting it.
 *
 * @p_hwfn: HW device data.
 * @p_ent: Ent.
 *
 * Return: Void.
 */
void qed_sp_destroy_request(struct qed_hwfn *p_hwfn,
			    struct qed_spq_entry *p_ent);

int qed_sp_init_request(struct qed_hwfn *p_hwfn,
			struct qed_spq_entry **pp_ent,
			u8 cmd,
			u8 protocol,
			struct qed_sp_init_data *p_data);

/**
 * qed_sp_pf_start(): PF Function Start Ramrod.
 *
 * @p_hwfn: HW device data.
 * @p_ptt: P_ptt.
 * @p_tunn: P_tunn.
 * @allow_npar_tx_switch: Allow NPAR TX Switch.
 *
 * Return: Int.
 *
 * This ramrod is sent to initialize a physical function (PF). It will
 * configure the function related parameters and write its completion to the
 * event ring specified in the parameters.
 *
 * Ramrods complete on the common event ring for the PF. This ring is
 * allocated by the driver on host memory and its parameters are written
 * to the internal RAM of the UStorm by the Function Start Ramrod.
 *
 */

int qed_sp_pf_start(struct qed_hwfn *p_hwfn,
		    struct qed_ptt *p_ptt,
		    struct qed_tunnel_info *p_tunn,
		    bool allow_npar_tx_switch);

/**
 * qed_sp_pf_update(): PF Function Update Ramrod.
 *
 * @p_hwfn: HW device data.
 *
 * Return: Int.
 *
 * This ramrod updates function-related parameters. Every parameter can be
 * updated independently, according to configuration flags.
 */

int qed_sp_pf_update(struct qed_hwfn *p_hwfn);

/**
 * qed_sp_pf_update_stag(): Update firmware of new outer tag.
 *
 * @p_hwfn: HW device data.
 *
 * Return: Int.
 */
int qed_sp_pf_update_stag(struct qed_hwfn *p_hwfn);

/**
 * qed_sp_pf_update_ufp(): PF ufp update Ramrod.
 *
 * @p_hwfn: HW device data.
 *
 * Return: Int.
 */
int qed_sp_pf_update_ufp(struct qed_hwfn *p_hwfn);

int qed_sp_pf_stop(struct qed_hwfn *p_hwfn);

int qed_sp_pf_update_tunn_cfg(struct qed_hwfn *p_hwfn,
			      struct qed_ptt *p_ptt,
			      struct qed_tunnel_info *p_tunn,
			      enum spq_mode comp_mode,
			      struct qed_spq_comp_cb *p_comp_data);
/**
 * qed_sp_heartbeat_ramrod(): Send empty Ramrod.
 *
 * @p_hwfn: HW device data.
 *
 * Return: Int.
 */

int qed_sp_heartbeat_ramrod(struct qed_hwfn *p_hwfn);

#endif
linux/drivers/net/ethernet/qlogic/qed/qed_sp.h
