1 /* 2 * Copyright (c) 2017-2018 Cavium, Inc. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 25 * POSSIBILITY OF SUCH DAMAGE. 26 * 27 */ 28 29 #ifndef __ECORE_SP_COMMANDS_H__ 30 #define __ECORE_SP_COMMANDS_H__ 31 32 #include "ecore.h" 33 #include "ecore_spq.h" 34 #include "ecore_sp_api.h" 35 36 #define ECORE_SP_EQ_COMPLETION 0x01 37 #define ECORE_SP_CQE_COMPLETION 0x02 38 39 struct ecore_sp_init_data { 40 /* The CID and FID aren't necessarily derived from hwfn, 41 * e.g., in IOV scenarios. CID might defer between SPQ and 42 * other elements. 43 */ 44 u32 cid; 45 u16 opaque_fid; 46 47 /* Information regarding operation upon sending & completion */ 48 enum spq_mode comp_mode; 49 struct ecore_spq_comp_cb *p_comp_data; 50 51 }; 52 53 /** 54 * @brief Acquire and initialize and SPQ entry for a given ramrod. 55 * 56 * @param p_hwfn 57 * @param pp_ent - will be filled with a pointer to an entry upon success 58 * @param cmd - dependent upon protocol 59 * @param protocol 60 * @param p_data - various configuration required for ramrod 61 * 62 * @return ECORE_SUCCESS upon success, otherwise failure. 63 */ 64 enum _ecore_status_t ecore_sp_init_request(struct ecore_hwfn *p_hwfn, 65 struct ecore_spq_entry **pp_ent, 66 u8 cmd, 67 u8 protocol, 68 struct ecore_sp_init_data *p_data); 69 70 /** 71 * @brief ecore_sp_pf_start - PF Function Start Ramrod 72 * 73 * This ramrod is sent to initialize a physical function (PF). It will 74 * configure the function related parameters and write its completion to the 75 * event ring specified in the parameters. 76 * 77 * Ramrods complete on the common event ring for the PF. This ring is 78 * allocated by the driver on host memory and its parameters are written 79 * to the internal RAM of the UStorm by the Function Start Ramrod. 80 * 81 * @param p_hwfn 82 * @param p_ptt 83 * @param p_tunn - pf start tunneling configuration 84 * @param allow_npar_tx_switch - npar tx switching to be used 85 * for vports configured for tx-switching. 86 * 87 * @return enum _ecore_status_t 88 */ 89 90 enum _ecore_status_t ecore_sp_pf_start(struct ecore_hwfn *p_hwfn, 91 struct ecore_ptt *p_ptt, 92 struct ecore_tunnel_info *p_tunn, 93 bool allow_npar_tx_switch); 94 95 /** 96 * @brief ecore_sp_pf_update - PF Function Update Ramrod 97 * 98 * This ramrod updates function-related parameters. Every parameter can be 99 * updated independently, according to configuration flags. 100 * 101 * @note Final phase API. 102 * 103 * @param p_hwfn 104 * 105 * @return enum _ecore_status_t 106 */ 107 108 enum _ecore_status_t ecore_sp_pf_update_dcbx(struct ecore_hwfn *p_hwfn); 109 110 /** 111 * @brief ecore_sp_pf_stop - PF Function Stop Ramrod 112 * 113 * This ramrod is sent to close a Physical Function (PF). It is the last ramrod 114 * sent and the last completion written to the PFs Event Ring. This ramrod also 115 * deletes the context for the Slowhwfn connection on this PF. 116 * 117 * @note Not required for first packet. 118 * 119 * @param p_hwfn 120 * 121 * @return enum _ecore_status_t 122 */ 123 124 enum _ecore_status_t ecore_sp_pf_stop(struct ecore_hwfn *p_hwfn); 125 126 /** 127 * @brief ecore_sp_heartbeat_ramrod - Send empty Ramrod 128 * 129 * @param p_hwfn 130 * 131 * @return enum _ecore_status_t 132 */ 133 134 enum _ecore_status_t ecore_sp_heartbeat_ramrod(struct ecore_hwfn *p_hwfn); 135 136 struct ecore_rl_update_params { 137 u8 qcn_update_param_flg; 138 u8 dcqcn_update_param_flg; 139 u8 rl_init_flg; 140 u8 rl_start_flg; 141 u8 rl_stop_flg; 142 u8 rl_id_first; 143 u8 rl_id_last; 144 u8 rl_dc_qcn_flg; /* If set, RL will used for DCQCN */ 145 u32 rl_bc_rate; /* Byte Counter Limit */ 146 u32 rl_max_rate; /* Maximum rate in Mbps resolution */ 147 u32 rl_r_ai; /* Active increase rate */ 148 u32 rl_r_hai; /* Hyper active increase rate */ 149 u32 dcqcn_gd; /* DCQCN Alpha update gain */ 150 u32 dcqcn_k_us; /* DCQCN Alpha update interval */ 151 u32 dcqcn_timeuot_us; 152 u32 qcn_timeuot_us; 153 }; 154 155 /** 156 * @brief ecore_sp_rl_update - Update rate limiters 157 * 158 * @param p_hwfn 159 * @param params 160 * 161 * @return enum _ecore_status_t 162 */ 163 enum _ecore_status_t ecore_sp_rl_update(struct ecore_hwfn *p_hwfn, 164 struct ecore_rl_update_params *params); 165 166 /** 167 * @brief ecore_sp_pf_update_stag - PF STAG value update Ramrod 168 * 169 * @param p_hwfn 170 * 171 * @return enum _ecore_status_t 172 */ 173 174 enum _ecore_status_t ecore_sp_pf_update_stag(struct ecore_hwfn *p_hwfn); 175 176 /** 177 * @brief ecore_sp_pf_update_ufp - PF ufp update Ramrod 178 * 179 * @param p_hwfn 180 * 181 * @return enum _ecore_status_t 182 */ 183 enum _ecore_status_t ecore_sp_pf_update_ufp(struct ecore_hwfn *p_hwfn); 184 185 #endif /*__ECORE_SP_COMMANDS_H__*/ 186