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