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"
15 #include "ecore_mcp_api.h"
17 /* Using hwfn number (and not pf_num) is required since in CMT mode,
18 * same pf_num may be used by two different hwfn
19 * TODO - this shouldn't really be in .h file, but until all fields
20 * required during hw-init will be placed in their correct place in shmem
21 * we need it in ecore_dev.c [for readin the nvram reflection in shmem].
23 #define MCP_PF_ID_BY_REL(p_hwfn, rel_pfid) (ECORE_IS_BB((p_hwfn)->p_dev) ? \
25 ((p_hwfn)->abs_pf_id & 1) << 3) : \
27 #define MCP_PF_ID(p_hwfn) MCP_PF_ID_BY_REL(p_hwfn, (p_hwfn)->rel_pf_id)
29 #define MFW_PORT(_p_hwfn) ((_p_hwfn)->abs_pf_id % \
30 ((_p_hwfn)->p_dev->num_ports_in_engines * \
31 ecore_device_num_engines((_p_hwfn)->p_dev)))
33 struct ecore_mcp_info {
34 /* Spinlock used for protecting the access to the MFW mailbox */
36 /* Flag to indicate whether sending a MFW mailbox is forbidden */
37 bool block_mb_sending;
39 /* Address of the MCP public area */
41 /* Address of the driver mailbox */
43 /* Address of the MFW mailbox */
45 /* Address of the port configuration (link) */
48 /* Current driver mailbox sequence */
50 /* Current driver pulse sequence */
53 struct ecore_mcp_link_params link_input;
54 struct ecore_mcp_link_state link_output;
55 struct ecore_mcp_link_capabilities link_capabilities;
57 struct ecore_mcp_function_info func_info;
65 struct ecore_mcp_mb_params {
68 union drv_union_data *p_data_src;
69 union drv_union_data *p_data_dst;
74 struct ecore_drv_tlv_hdr {
75 u8 tlv_type; /* According to the enum below */
76 u8 tlv_length; /* In dwords - not including this header */
78 #define ECORE_DRV_TLV_FLAGS_CHANGED 0x01
83 * @brief Initialize the interface with the MCP
85 * @param p_hwfn - HW func
86 * @param p_ptt - PTT required for register access
88 * @return enum _ecore_status_t
90 enum _ecore_status_t ecore_mcp_cmd_init(struct ecore_hwfn *p_hwfn,
91 struct ecore_ptt *p_ptt);
94 * @brief Initialize the port interface with the MCP
98 * Can only be called after `num_ports_in_engines' is set
100 void ecore_mcp_cmd_port_init(struct ecore_hwfn *p_hwfn,
101 struct ecore_ptt *p_ptt);
103 * @brief Releases resources allocated during the init process.
105 * @param p_hwfn - HW func
106 * @param p_ptt - PTT required for register access
108 * @return enum _ecore_status_t
111 enum _ecore_status_t ecore_mcp_free(struct ecore_hwfn *p_hwfn);
114 * @brief This function is called from the DPC context. After
115 * pointing PTT to the mfw mb, check for events sent by the MCP
116 * to the driver and ack them. In case a critical event
117 * detected, it will be handled here, otherwise the work will be
118 * queued to a sleepable work-queue.
120 * @param p_hwfn - HW function
121 * @param p_ptt - PTT required for register access
122 * @return enum _ecore_status_t - ECORE_SUCCESS - operation
125 enum _ecore_status_t ecore_mcp_handle_events(struct ecore_hwfn *p_hwfn,
126 struct ecore_ptt *p_ptt);
129 * @brief When MFW doesn't get driver pulse for couple of seconds, at some
130 * threshold before timeout expires, it will generate interrupt
131 * through a dedicated status block (DPSB - Driver Pulse Status
132 * Block), which the driver should respond immediately, by
133 * providing keepalive indication after setting the PTT to the
134 * driver-MFW mailbox. This function is called directly from the
135 * DPC upon receiving the DPSB attention.
137 * @param p_hwfn - hw function
138 * @param p_ptt - PTT required for register access
139 * @return enum _ecore_status_t - ECORE_SUCCESS - operation
142 enum _ecore_status_t ecore_issue_pulse(struct ecore_hwfn *p_hwfn,
143 struct ecore_ptt *p_ptt);
145 enum ecore_drv_role {
147 ECORE_DRV_ROLE_KDUMP,
150 struct ecore_load_req_params {
151 enum ecore_drv_role drv_role;
152 u8 timeout_val; /* 1..254, '0' - default value, '255' - no timeout */
153 bool avoid_eng_reset;
158 * @brief Sends a LOAD_REQ to the MFW, and in case the operation succeeds,
159 * returns whether this PF is the first on the engine/port or function.
165 * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful.
167 enum _ecore_status_t ecore_mcp_load_req(struct ecore_hwfn *p_hwfn,
168 struct ecore_ptt *p_ptt,
169 struct ecore_load_req_params *p_params);
172 * @brief Read the MFW mailbox into Current buffer.
177 void ecore_mcp_read_mb(struct ecore_hwfn *p_hwfn,
178 struct ecore_ptt *p_ptt);
181 * @brief Ack to mfw that driver finished FLR process for VFs
185 * @param vfs_to_ack - bit mask of all engine VFs for which the PF acks.
187 * @param return enum _ecore_status_t - ECORE_SUCCESS upon success.
189 enum _ecore_status_t ecore_mcp_ack_vf_flr(struct ecore_hwfn *p_hwfn,
190 struct ecore_ptt *p_ptt,
194 * @brief - calls during init to read shmem of all function-related info.
198 * @param return ECORE_SUCCESS upon success.
200 enum _ecore_status_t ecore_mcp_fill_shmem_func_info(struct ecore_hwfn *p_hwfn,
201 struct ecore_ptt *p_ptt);
204 * @brief - Reset the MCP using mailbox command.
209 * @param return ECORE_SUCCESS upon success.
211 enum _ecore_status_t ecore_mcp_reset(struct ecore_hwfn *p_hwfn,
212 struct ecore_ptt *p_ptt);
215 * @brief - Sends an NVM write command request to the MFW with
220 * @param cmd - Command: Either DRV_MSG_CODE_NVM_WRITE_NVRAM or
221 * DRV_MSG_CODE_NVM_PUT_FILE_DATA
222 * @param param - [0:23] - Offset [24:31] - Size
223 * @param o_mcp_resp - MCP response
224 * @param o_mcp_param - MCP response param
225 * @param i_txn_size - Buffer size
226 * @param i_buf - Pointer to the buffer
228 * @param return ECORE_SUCCESS upon success.
230 enum _ecore_status_t ecore_mcp_nvm_wr_cmd(struct ecore_hwfn *p_hwfn,
231 struct ecore_ptt *p_ptt,
240 * @brief - Sends an NVM read command request to the MFW to get
245 * @param cmd - Command: DRV_MSG_CODE_NVM_GET_FILE_DATA or
246 * DRV_MSG_CODE_NVM_READ_NVRAM commands
247 * @param param - [0:23] - Offset [24:31] - Size
248 * @param o_mcp_resp - MCP response
249 * @param o_mcp_param - MCP response param
250 * @param o_txn_size - Buffer size output
251 * @param o_buf - Pointer to the buffer returned by the MFW.
253 * @param return ECORE_SUCCESS upon success.
255 enum _ecore_status_t ecore_mcp_nvm_rd_cmd(struct ecore_hwfn *p_hwfn,
256 struct ecore_ptt *p_ptt,
265 * @brief indicates whether the MFW objects [under mcp_info] are accessible
269 * @return true iff MFW is running and mcp_info is initialized
271 bool ecore_mcp_is_init(struct ecore_hwfn *p_hwfn);
274 * @brief request MFW to configure MSI-X for a VF
278 * @param vf_id - absolute inside engine
279 * @param num_sbs - number of entries to request
281 * @return enum _ecore_status_t
283 enum _ecore_status_t ecore_mcp_config_vf_msix(struct ecore_hwfn *p_hwfn,
284 struct ecore_ptt *p_ptt,
288 * @brief - Halt the MCP.
293 * @param return ECORE_SUCCESS upon success.
295 enum _ecore_status_t ecore_mcp_halt(struct ecore_hwfn *p_hwfn,
296 struct ecore_ptt *p_ptt);
299 * @brief - Wake up the MCP.
304 * @param return ECORE_SUCCESS upon success.
306 enum _ecore_status_t ecore_mcp_resume(struct ecore_hwfn *p_hwfn,
307 struct ecore_ptt *p_ptt);
308 int __ecore_configure_pf_max_bandwidth(struct ecore_hwfn *p_hwfn,
309 struct ecore_ptt *p_ptt,
310 struct ecore_mcp_link_state *p_link,
312 int __ecore_configure_pf_min_bandwidth(struct ecore_hwfn *p_hwfn,
313 struct ecore_ptt *p_ptt,
314 struct ecore_mcp_link_state *p_link,
316 enum _ecore_status_t ecore_mcp_mask_parities(struct ecore_hwfn *p_hwfn,
317 struct ecore_ptt *p_ptt,
320 * @brief - Sends crash mdump related info to the MFW.
325 * @param return ECORE_SUCCESS upon success.
327 enum _ecore_status_t ecore_mcp_mdump_set_values(struct ecore_hwfn *p_hwfn,
328 struct ecore_ptt *p_ptt,
332 * @brief - Triggers a MFW crash dump procedure.
337 * @param return ECORE_SUCCESS upon success.
339 enum _ecore_status_t ecore_mcp_mdump_trigger(struct ecore_hwfn *p_hwfn,
340 struct ecore_ptt *p_ptt);
343 * @brief - Sets the MFW's max value for the given resource
348 * @param resc_max_val
351 * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
354 ecore_mcp_set_resc_max_val(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
355 enum ecore_resources res_id, u32 resc_max_val,
359 * @brief - Gets the MFW allocation info for the given resource
366 * @param p_resc_start
368 * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
371 ecore_mcp_get_resc_info(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
372 enum ecore_resources res_id, u32 *p_mcp_resp,
373 u32 *p_resc_num, u32 *p_resc_start);
376 * @brief - Initiates PF FLR
381 * @param return ECORE_SUCCESS upon success.
383 enum _ecore_status_t ecore_mcp_initiate_pf_flr(struct ecore_hwfn *p_hwfn,
384 struct ecore_ptt *p_ptt);
386 #define ECORE_MCP_RESC_LOCK_MIN_VAL RESOURCE_DUMP /* 0 */
387 #define ECORE_MCP_RESC_LOCK_MAX_VAL 31
389 enum ecore_resc_lock {
390 ECORE_RESC_LOCK_DBG_DUMP = ECORE_MCP_RESC_LOCK_MIN_VAL,
391 /* Locks that the MFW is aware of should be added here downwards */
393 /* Ecore only locks should be added here upwards */
394 ECORE_RESC_LOCK_RESC_ALLOC = ECORE_MCP_RESC_LOCK_MAX_VAL
397 struct ecore_resc_lock_params {
398 /* Resource number [valid values are 0..31] */
401 /* Lock timeout value in seconds [default, none or 1..254] */
403 #define ECORE_MCP_RESC_LOCK_TO_DEFAULT 0
404 #define ECORE_MCP_RESC_LOCK_TO_NONE 255
406 /* Number of times to retry locking */
409 /* The interval in usec between retries */
412 /* Use sleep or delay between retries */
415 /* Will be set as true if the resource is free and granted */
418 /* Will be filled with the resource owner.
419 * [0..15 = PF0-15, 16 = MFW, 17 = diag over serial]
425 * @brief Acquires MFW generic resource lock
431 * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
434 ecore_mcp_resc_lock(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
435 struct ecore_resc_lock_params *p_params);
437 struct ecore_resc_unlock_params {
438 /* Resource number [valid values are 0..31] */
441 /* Allow to release a resource even if belongs to another PF */
444 /* Will be set as true if the resource is released */
449 * @brief Releases MFW generic resource lock
455 * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
458 ecore_mcp_resc_unlock(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
459 struct ecore_resc_unlock_params *p_params);
461 #endif /* __ECORE_MCP_H__ */