2 * Copyright (c) 2016 QLogic Corporation.
6 * See LICENSE.qede_pmd for copyright and licensing details.
9 #ifndef __ECORE_MCP_H__
10 #define __ECORE_MCP_H__
13 #include "mcp_public.h"
14 #include "ecore_mcp_api.h"
16 /* Using hwfn number (and not pf_num) is required since in CMT mode,
17 * same pf_num may be used by two different hwfn
18 * TODO - this shouldn't really be in .h file, but until all fields
19 * required during hw-init will be placed in their correct place in shmem
20 * we need it in ecore_dev.c [for readin the nvram reflection in shmem].
22 #define MCP_PF_ID_BY_REL(p_hwfn, rel_pfid) (ECORE_IS_BB((p_hwfn)->p_dev) ? \
24 ((p_hwfn)->abs_pf_id & 1) << 3) : \
26 #define MCP_PF_ID(p_hwfn) MCP_PF_ID_BY_REL(p_hwfn, (p_hwfn)->rel_pf_id)
28 /* TODO - this is only correct as long as only BB is supported, and
29 * no port-swapping is implemented; Afterwards we'll need to fix it.
31 #define MFW_PORT(_p_hwfn) ((_p_hwfn)->abs_pf_id % \
32 ((_p_hwfn)->p_dev->num_ports_in_engines * 2))
33 struct ecore_mcp_info {
34 osal_spinlock_t lock; /* Spinlock used for accessing MCP mailbox */
35 u32 public_base; /* Address of the MCP public area */
36 u32 drv_mb_addr; /* Address of the driver mailbox */
37 u32 mfw_mb_addr; /* Address of the MFW mailbox */
38 u32 port_addr; /* Address of the port configuration (link) */
39 u16 drv_mb_seq; /* Current driver mailbox sequence */
40 u16 drv_pulse_seq; /* Current driver pulse sequence */
41 struct ecore_mcp_link_params link_input;
42 struct ecore_mcp_link_state link_output;
43 struct ecore_mcp_link_capabilities link_capabilities;
44 struct ecore_mcp_function_info func_info;
52 struct ecore_mcp_mb_params {
55 union drv_union_data *p_data_src;
56 union drv_union_data *p_data_dst;
62 * @brief Initialize the interface with the MCP
64 * @param p_hwfn - HW func
65 * @param p_ptt - PTT required for register access
67 * @return enum _ecore_status_t
69 enum _ecore_status_t ecore_mcp_cmd_init(struct ecore_hwfn *p_hwfn,
70 struct ecore_ptt *p_ptt);
73 * @brief Initialize the port interface with the MCP
77 * Can only be called after `num_ports_in_engines' is set
79 void ecore_mcp_cmd_port_init(struct ecore_hwfn *p_hwfn,
80 struct ecore_ptt *p_ptt);
82 * @brief Releases resources allocated during the init process.
84 * @param p_hwfn - HW func
85 * @param p_ptt - PTT required for register access
87 * @return enum _ecore_status_t
90 enum _ecore_status_t ecore_mcp_free(struct ecore_hwfn *p_hwfn);
93 * @brief This function is called from the DPC context. After
94 * pointing PTT to the mfw mb, check for events sent by the MCP
95 * to the driver and ack them. In case a critical event
96 * detected, it will be handled here, otherwise the work will be
97 * queued to a sleepable work-queue.
99 * @param p_hwfn - HW function
100 * @param p_ptt - PTT required for register access
101 * @return enum _ecore_status_t - ECORE_SUCCESS - operation
104 enum _ecore_status_t ecore_mcp_handle_events(struct ecore_hwfn *p_hwfn,
105 struct ecore_ptt *p_ptt);
108 * @brief When MFW doesn't get driver pulse for couple of seconds, at some
109 * threshold before timeout expires, it will generate interrupt
110 * through a dedicated status block (DPSB - Driver Pulse Status
111 * Block), which the driver should respond immediately, by
112 * providing keepalive indication after setting the PTT to the
113 * driver-MFW mailbox. This function is called directly from the
114 * DPC upon receiving the DPSB attention.
116 * @param p_hwfn - hw function
117 * @param p_ptt - PTT required for register access
118 * @return enum _ecore_status_t - ECORE_SUCCESS - operation
121 enum _ecore_status_t ecore_issue_pulse(struct ecore_hwfn *p_hwfn,
122 struct ecore_ptt *p_ptt);
125 * @brief Sends a LOAD_REQ to the MFW, and in case operation
126 * succeed, returns whether this PF is the first on the
127 * chip/engine/port or function. This function should be
128 * called when driver is ready to accept MFW events after
129 * Storms initializations are done.
131 * @param p_hwfn - hw function
132 * @param p_ptt - PTT required for register access
133 * @param p_load_code - The MCP response param containing one
135 * FW_MSG_CODE_DRV_LOAD_ENGINE
136 * FW_MSG_CODE_DRV_LOAD_PORT
137 * FW_MSG_CODE_DRV_LOAD_FUNCTION
138 * @return enum _ecore_status_t -
139 * ECORE_SUCCESS - Operation was successul.
140 * ECORE_BUSY - Operation failed
142 enum _ecore_status_t ecore_mcp_load_req(struct ecore_hwfn *p_hwfn,
143 struct ecore_ptt *p_ptt,
147 * @brief Read the MFW mailbox into Current buffer.
152 void ecore_mcp_read_mb(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt);
155 * @brief Ack to mfw that driver finished FLR process for VFs
159 * @param vfs_to_ack - bit mask of all engine VFs for which the PF acks.
161 * @param return enum _ecore_status_t - ECORE_SUCCESS upon success.
163 enum _ecore_status_t ecore_mcp_ack_vf_flr(struct ecore_hwfn *p_hwfn,
164 struct ecore_ptt *p_ptt,
168 * @brief - calls during init to read shmem of all function-related info.
172 * @param return ECORE_SUCCESS upon success.
174 enum _ecore_status_t ecore_mcp_fill_shmem_func_info(struct ecore_hwfn *p_hwfn,
175 struct ecore_ptt *p_ptt);
178 * @brief - Reset the MCP using mailbox command.
183 * @param return ECORE_SUCCESS upon success.
185 enum _ecore_status_t ecore_mcp_reset(struct ecore_hwfn *p_hwfn,
186 struct ecore_ptt *p_ptt);
189 * @brief - Sends an NVM write command request to the MFW with
194 * @param cmd - Command: Either DRV_MSG_CODE_NVM_WRITE_NVRAM or
195 * DRV_MSG_CODE_NVM_PUT_FILE_DATA
196 * @param param - [0:23] - Offset [24:31] - Size
197 * @param o_mcp_resp - MCP response
198 * @param o_mcp_param - MCP response param
199 * @param i_txn_size - Buffer size
200 * @param i_buf - Pointer to the buffer
202 * @param return ECORE_SUCCESS upon success.
204 enum _ecore_status_t ecore_mcp_nvm_wr_cmd(struct ecore_hwfn *p_hwfn,
205 struct ecore_ptt *p_ptt,
210 u32 i_txn_size, u32 *i_buf);
213 * @brief - Sends an NVM read command request to the MFW to get
218 * @param cmd - Command: DRV_MSG_CODE_NVM_GET_FILE_DATA or
219 * DRV_MSG_CODE_NVM_READ_NVRAM commands
220 * @param param - [0:23] - Offset [24:31] - Size
221 * @param o_mcp_resp - MCP response
222 * @param o_mcp_param - MCP response param
223 * @param o_txn_size - Buffer size output
224 * @param o_buf - Pointer to the buffer returned by the MFW.
226 * @param return ECORE_SUCCESS upon success.
228 enum _ecore_status_t ecore_mcp_nvm_rd_cmd(struct ecore_hwfn *p_hwfn,
229 struct ecore_ptt *p_ptt,
234 u32 *o_txn_size, u32 *o_buf);
237 * @brief indicates whether the MFW objects [under mcp_info] are accessible
241 * @return true iff MFW is running and mcp_info is initialized
243 bool ecore_mcp_is_init(struct ecore_hwfn *p_hwfn);
246 * @brief request MFW to configure MSI-X for a VF
250 * @param vf_id - absolute inside engine
251 * @param num_sbs - number of entries to request
253 * @return enum _ecore_status_t
255 enum _ecore_status_t ecore_mcp_config_vf_msix(struct ecore_hwfn *p_hwfn,
256 struct ecore_ptt *p_ptt,
260 * @brief - Halt the MCP.
265 * @param return ECORE_SUCCESS upon success.
267 enum _ecore_status_t ecore_mcp_halt(struct ecore_hwfn *p_hwfn,
268 struct ecore_ptt *p_ptt);
271 * @brief - Wake up the MCP.
276 * @param return ECORE_SUCCESS upon success.
278 enum _ecore_status_t ecore_mcp_resume(struct ecore_hwfn *p_hwfn,
279 struct ecore_ptt *p_ptt);
280 int __ecore_configure_pf_max_bandwidth(struct ecore_hwfn *p_hwfn,
281 struct ecore_ptt *p_ptt,
282 struct ecore_mcp_link_state *p_link,
284 int __ecore_configure_pf_min_bandwidth(struct ecore_hwfn *p_hwfn,
285 struct ecore_ptt *p_ptt,
286 struct ecore_mcp_link_state *p_link,
288 enum _ecore_status_t ecore_mcp_mask_parities(struct ecore_hwfn *p_hwfn,
289 struct ecore_ptt *p_ptt,
291 #endif /* __ECORE_MCP_H__ */