drivers/net/qede/base/ecore_sp_commands.h

   1 /*
   2  * Copyright (c) 2016 QLogic Corporation.
   3  * All rights reserved.
   4  * www.qlogic.com
   5  *
   6  * See LICENSE.qede_pmd for copyright and licensing details.
   7  */
   8
   9 #ifndef __ECORE_SP_COMMANDS_H__
  10 #define __ECORE_SP_COMMANDS_H__
  11
  12 #include "ecore.h"
  13 #include "ecore_spq.h"
  14 #include "ecore_sp_api.h"
  15
  16 #define ECORE_SP_EQ_COMPLETION  0x01
  17 #define ECORE_SP_CQE_COMPLETION 0x02
  18
  19 struct ecore_sp_init_data {
  20         /* The CID and FID aren't necessarily derived from hwfn,
  21          * e.g., in IOV scenarios. CID might defer between SPQ and
  22          * other elements.
  23          */
  24         u32                             cid;
  25         u16                             opaque_fid;
  26
  27         /* Information regarding operation upon sending & completion */
  28         enum spq_mode                   comp_mode;
  29         struct ecore_spq_comp_cb        *p_comp_data;
  30
  31 };
  32
  33 /**
  34  * @brief Acquire and initialize and SPQ entry for a given ramrod.
  35  *
  36  * @param p_hwfn
  37  * @param pp_ent - will be filled with a pointer to an entry upon success
  38  * @param cmd - dependent upon protocol
  39  * @param protocol
  40  * @param p_data - various configuration required for ramrod
  41  *
  42  * @return ECORE_SUCCESS upon success, otherwise failure.
  43  */
  44 enum _ecore_status_t ecore_sp_init_request(struct ecore_hwfn *p_hwfn,
  45                                            struct ecore_spq_entry **pp_ent,
  46                                            u8 cmd,
  47                                            u8 protocol,
  48                                            struct ecore_sp_init_data *p_data);
  49
  50 /**
  51  * @brief ecore_sp_pf_start - PF Function Start Ramrod
  52  *
  53  * This ramrod is sent to initialize a physical function (PF). It will
  54  * configure the function related parameters and write its completion to the
  55  * event ring specified in the parameters.
  56  *
  57  * Ramrods complete on the common event ring for the PF. This ring is
  58  * allocated by the driver on host memory and its parameters are written
  59  * to the internal RAM of the UStorm by the Function Start Ramrod.
  60  *
  61  * @param p_hwfn
  62  * @param p_ptt
  63  * @param p_tunn - pf start tunneling configuration
  64  * @param mode
  65  * @param allow_npar_tx_switch - npar tx switching to be used
  66  *        for vports configured for tx-switching.
  67  *
  68  * @return enum _ecore_status_t
  69  */
  70
  71 enum _ecore_status_t ecore_sp_pf_start(struct ecore_hwfn *p_hwfn,
  72                                        struct ecore_ptt *p_ptt,
  73                                        struct ecore_tunnel_info *p_tunn,
  74                                        enum ecore_mf_mode mode,
  75                                        bool allow_npar_tx_switch);
  76
  77 /**
  78  * @brief ecore_sp_pf_update - PF Function Update Ramrod
  79  *
  80  * This ramrod updates function-related parameters. Every parameter can be
  81  * updated independently, according to configuration flags.
  82  *
  83  * @note Final phase API.
  84  *
  85  * @param p_hwfn
  86  *
  87  * @return enum _ecore_status_t
  88  */
  89
  90 enum _ecore_status_t ecore_sp_pf_update_dcbx(struct ecore_hwfn *p_hwfn);
  91
  92 /**
  93  * @brief ecore_sp_pf_stop - PF Function Stop Ramrod
  94  *
  95  * This ramrod is sent to close a Physical Function (PF). It is the last ramrod
  96  * sent and the last completion written to the PFs Event Ring. This ramrod also
  97  * deletes the context for the Slowhwfn connection on this PF.
  98  *
  99  * @note Not required for first packet.
 100  *
 101  * @param p_hwfn
 102  *
 103  * @return enum _ecore_status_t
 104  */
 105
 106 enum _ecore_status_t ecore_sp_pf_stop(struct ecore_hwfn *p_hwfn);
 107
 108 /**
 109  * @brief ecore_sp_heartbeat_ramrod - Send empty Ramrod
 110  *
 111  * @param p_hwfn
 112  *
 113  * @return enum _ecore_status_t
 114  */
 115
 116 enum _ecore_status_t ecore_sp_heartbeat_ramrod(struct ecore_hwfn *p_hwfn);
 117
 118 struct ecore_rl_update_params {
 119         u8 qcn_update_param_flg;
 120         u8 dcqcn_update_param_flg;
 121         u8 rl_init_flg;
 122         u8 rl_start_flg;
 123         u8 rl_stop_flg;
 124         u8 rl_id_first;
 125         u8 rl_id_last;
 126         u8 rl_dc_qcn_flg; /* If set, RL will used for DCQCN */
 127         u32 rl_bc_rate; /* Byte Counter Limit */
 128         u32 rl_max_rate; /* Maximum rate in Mbps resolution */
 129         u32 rl_r_ai; /* Active increase rate */
 130         u32 rl_r_hai; /* Hyper active increase rate */
 131         u32 dcqcn_gd; /* DCQCN Alpha update gain */
 132         u32 dcqcn_k_us; /* DCQCN Alpha update interval */
 133         u32 dcqcn_timeuot_us;
 134         u32 qcn_timeuot_us;
 135 };
 136
 137 /**
 138  * @brief ecore_sp_rl_update - Update rate limiters
 139  *
 140  * @param p_hwfn
 141  * @param params
 142  *
 143  * @return enum _ecore_status_t
 144  */
 145 enum _ecore_status_t ecore_sp_rl_update(struct ecore_hwfn *p_hwfn,
 146                                         struct ecore_rl_update_params *params);
 147
 148 /**
 149  * @brief ecore_sp_pf_update_stag - PF STAG value update Ramrod
 150  *
 151  * @param p_hwfn
 152  *
 153  * @return enum _ecore_status_t
 154  */
 155
 156 enum _ecore_status_t ecore_sp_pf_update_stag(struct ecore_hwfn *p_hwfn);
 157
 158 #endif /*__ECORE_SP_COMMANDS_H__*/