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"
16 #include "ecore_dev_api.h"
18 /* Using hwfn number (and not pf_num) is required since in CMT mode,
19 * same pf_num may be used by two different hwfn
20 * TODO - this shouldn't really be in .h file, but until all fields
21 * required during hw-init will be placed in their correct place in shmem
22 * we need it in ecore_dev.c [for readin the nvram reflection in shmem].
24 #define MCP_PF_ID_BY_REL(p_hwfn, rel_pfid) (ECORE_IS_BB((p_hwfn)->p_dev) ? \
26 ((p_hwfn)->abs_pf_id & 1) << 3) : \
28 #define MCP_PF_ID(p_hwfn) MCP_PF_ID_BY_REL(p_hwfn, (p_hwfn)->rel_pf_id)
30 #define MFW_PORT(_p_hwfn) ((_p_hwfn)->abs_pf_id % \
31 ((_p_hwfn)->p_dev->num_ports_in_engines * \
32 ecore_device_num_engines((_p_hwfn)->p_dev)))
34 struct ecore_mcp_info {
35 /* Spinlock used for protecting the access to the MFW mailbox */
37 /* Flag to indicate whether sending a MFW mailbox is forbidden */
38 bool block_mb_sending;
40 /* Address of the MCP public area */
42 /* Address of the driver mailbox */
44 /* Address of the MFW mailbox */
46 /* Address of the port configuration (link) */
49 /* Current driver mailbox sequence */
51 /* Current driver pulse sequence */
54 struct ecore_mcp_link_params link_input;
55 struct ecore_mcp_link_state link_output;
56 struct ecore_mcp_link_capabilities link_capabilities;
58 struct ecore_mcp_function_info func_info;
65 /* Capabilties negotiated with the MFW */
69 struct ecore_mcp_mb_params {
80 struct ecore_drv_tlv_hdr {
81 u8 tlv_type; /* According to the enum below */
82 u8 tlv_length; /* In dwords - not including this header */
84 #define ECORE_DRV_TLV_FLAGS_CHANGED 0x01
89 * @brief Initialize the interface with the MCP
91 * @param p_hwfn - HW func
92 * @param p_ptt - PTT required for register access
94 * @return enum _ecore_status_t
96 enum _ecore_status_t ecore_mcp_cmd_init(struct ecore_hwfn *p_hwfn,
97 struct ecore_ptt *p_ptt);
100 * @brief Initialize the port interface with the MCP
104 * Can only be called after `num_ports_in_engines' is set
106 void ecore_mcp_cmd_port_init(struct ecore_hwfn *p_hwfn,
107 struct ecore_ptt *p_ptt);
109 * @brief Releases resources allocated during the init process.
111 * @param p_hwfn - HW func
112 * @param p_ptt - PTT required for register access
114 * @return enum _ecore_status_t
117 enum _ecore_status_t ecore_mcp_free(struct ecore_hwfn *p_hwfn);
120 * @brief This function is called from the DPC context. After
121 * pointing PTT to the mfw mb, check for events sent by the MCP
122 * to the driver and ack them. In case a critical event
123 * detected, it will be handled here, otherwise the work will be
124 * queued to a sleepable work-queue.
126 * @param p_hwfn - HW function
127 * @param p_ptt - PTT required for register access
128 * @return enum _ecore_status_t - ECORE_SUCCESS - operation
131 enum _ecore_status_t ecore_mcp_handle_events(struct ecore_hwfn *p_hwfn,
132 struct ecore_ptt *p_ptt);
135 * @brief When MFW doesn't get driver pulse for couple of seconds, at some
136 * threshold before timeout expires, it will generate interrupt
137 * through a dedicated status block (DPSB - Driver Pulse Status
138 * Block), which the driver should respond immediately, by
139 * providing keepalive indication after setting the PTT to the
140 * driver-MFW mailbox. This function is called directly from the
141 * DPC upon receiving the DPSB attention.
143 * @param p_hwfn - hw function
144 * @param p_ptt - PTT required for register access
145 * @return enum _ecore_status_t - ECORE_SUCCESS - operation
148 enum _ecore_status_t ecore_issue_pulse(struct ecore_hwfn *p_hwfn,
149 struct ecore_ptt *p_ptt);
151 enum ecore_drv_role {
153 ECORE_DRV_ROLE_KDUMP,
156 struct ecore_load_req_params {
158 enum ecore_drv_role drv_role;
159 u8 timeout_val; /* 1..254, '0' - default value, '255' - no timeout */
160 bool avoid_eng_reset;
161 enum ecore_override_force_load override_force_load;
168 * @brief Sends a LOAD_REQ to the MFW, and in case the operation succeeds,
169 * returns whether this PF is the first on the engine/port or function.
175 * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful.
177 enum _ecore_status_t ecore_mcp_load_req(struct ecore_hwfn *p_hwfn,
178 struct ecore_ptt *p_ptt,
179 struct ecore_load_req_params *p_params);
182 * @brief Sends a LOAD_DONE message to the MFW
187 * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful.
189 enum _ecore_status_t ecore_mcp_load_done(struct ecore_hwfn *p_hwfn,
190 struct ecore_ptt *p_ptt);
193 * @brief Sends a UNLOAD_REQ message to the MFW
198 * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful.
200 enum _ecore_status_t ecore_mcp_unload_req(struct ecore_hwfn *p_hwfn,
201 struct ecore_ptt *p_ptt);
204 * @brief Sends a UNLOAD_DONE message to the MFW
209 * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful.
211 enum _ecore_status_t ecore_mcp_unload_done(struct ecore_hwfn *p_hwfn,
212 struct ecore_ptt *p_ptt);
215 * @brief Read the MFW mailbox into Current buffer.
220 void ecore_mcp_read_mb(struct ecore_hwfn *p_hwfn,
221 struct ecore_ptt *p_ptt);
224 * @brief Ack to mfw that driver finished FLR process for VFs
228 * @param vfs_to_ack - bit mask of all engine VFs for which the PF acks.
230 * @param return enum _ecore_status_t - ECORE_SUCCESS upon success.
232 enum _ecore_status_t ecore_mcp_ack_vf_flr(struct ecore_hwfn *p_hwfn,
233 struct ecore_ptt *p_ptt,
237 * @brief - calls during init to read shmem of all function-related info.
241 * @param return ECORE_SUCCESS upon success.
243 enum _ecore_status_t ecore_mcp_fill_shmem_func_info(struct ecore_hwfn *p_hwfn,
244 struct ecore_ptt *p_ptt);
247 * @brief - Reset the MCP using mailbox command.
252 * @param return ECORE_SUCCESS upon success.
254 enum _ecore_status_t ecore_mcp_reset(struct ecore_hwfn *p_hwfn,
255 struct ecore_ptt *p_ptt);
258 * @brief - Sends an NVM write command request to the MFW with
263 * @param cmd - Command: Either DRV_MSG_CODE_NVM_WRITE_NVRAM or
264 * DRV_MSG_CODE_NVM_PUT_FILE_DATA
265 * @param param - [0:23] - Offset [24:31] - Size
266 * @param o_mcp_resp - MCP response
267 * @param o_mcp_param - MCP response param
268 * @param i_txn_size - Buffer size
269 * @param i_buf - Pointer to the buffer
271 * @param return ECORE_SUCCESS upon success.
273 enum _ecore_status_t ecore_mcp_nvm_wr_cmd(struct ecore_hwfn *p_hwfn,
274 struct ecore_ptt *p_ptt,
283 * @brief - Sends an NVM read command request to the MFW to get
288 * @param cmd - Command: DRV_MSG_CODE_NVM_GET_FILE_DATA or
289 * DRV_MSG_CODE_NVM_READ_NVRAM commands
290 * @param param - [0:23] - Offset [24:31] - Size
291 * @param o_mcp_resp - MCP response
292 * @param o_mcp_param - MCP response param
293 * @param o_txn_size - Buffer size output
294 * @param o_buf - Pointer to the buffer returned by the MFW.
296 * @param return ECORE_SUCCESS upon success.
298 enum _ecore_status_t ecore_mcp_nvm_rd_cmd(struct ecore_hwfn *p_hwfn,
299 struct ecore_ptt *p_ptt,
308 * @brief indicates whether the MFW objects [under mcp_info] are accessible
312 * @return true iff MFW is running and mcp_info is initialized
314 bool ecore_mcp_is_init(struct ecore_hwfn *p_hwfn);
317 * @brief request MFW to configure MSI-X for a VF
321 * @param vf_id - absolute inside engine
322 * @param num_sbs - number of entries to request
324 * @return enum _ecore_status_t
326 enum _ecore_status_t ecore_mcp_config_vf_msix(struct ecore_hwfn *p_hwfn,
327 struct ecore_ptt *p_ptt,
331 * @brief - Halt the MCP.
336 * @param return ECORE_SUCCESS upon success.
338 enum _ecore_status_t ecore_mcp_halt(struct ecore_hwfn *p_hwfn,
339 struct ecore_ptt *p_ptt);
342 * @brief - Wake up the MCP.
347 * @param return ECORE_SUCCESS upon success.
349 enum _ecore_status_t ecore_mcp_resume(struct ecore_hwfn *p_hwfn,
350 struct ecore_ptt *p_ptt);
351 int __ecore_configure_pf_max_bandwidth(struct ecore_hwfn *p_hwfn,
352 struct ecore_ptt *p_ptt,
353 struct ecore_mcp_link_state *p_link,
355 int __ecore_configure_pf_min_bandwidth(struct ecore_hwfn *p_hwfn,
356 struct ecore_ptt *p_ptt,
357 struct ecore_mcp_link_state *p_link,
359 enum _ecore_status_t ecore_mcp_mask_parities(struct ecore_hwfn *p_hwfn,
360 struct ecore_ptt *p_ptt,
363 * @brief - Sends crash mdump related info to the MFW.
368 * @param return ECORE_SUCCESS upon success.
370 enum _ecore_status_t ecore_mcp_mdump_set_values(struct ecore_hwfn *p_hwfn,
371 struct ecore_ptt *p_ptt,
375 * @brief - Triggers a MFW crash dump procedure.
381 * @param return ECORE_SUCCESS upon success.
383 enum _ecore_status_t ecore_mcp_mdump_trigger(struct ecore_hwfn *p_hwfn,
384 struct ecore_ptt *p_ptt);
386 struct ecore_mdump_retain_data {
394 * @brief - Gets the mdump retained data from the MFW.
398 * @param p_mdump_retain
400 * @param return ECORE_SUCCESS upon success.
403 ecore_mcp_mdump_get_retain(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
404 struct ecore_mdump_retain_data *p_mdump_retain);
407 * @brief - Sets the MFW's max value for the given resource
412 * @param resc_max_val
415 * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
418 ecore_mcp_set_resc_max_val(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
419 enum ecore_resources res_id, u32 resc_max_val,
423 * @brief - Gets the MFW allocation info for the given resource
430 * @param p_resc_start
432 * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
435 ecore_mcp_get_resc_info(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
436 enum ecore_resources res_id, u32 *p_mcp_resp,
437 u32 *p_resc_num, u32 *p_resc_start);
440 * @brief - Initiates PF FLR
445 * @param return ECORE_SUCCESS upon success.
447 enum _ecore_status_t ecore_mcp_initiate_pf_flr(struct ecore_hwfn *p_hwfn,
448 struct ecore_ptt *p_ptt);
450 #define ECORE_MCP_RESC_LOCK_MIN_VAL RESOURCE_DUMP /* 0 */
451 #define ECORE_MCP_RESC_LOCK_MAX_VAL 31
453 enum ecore_resc_lock {
454 ECORE_RESC_LOCK_DBG_DUMP = ECORE_MCP_RESC_LOCK_MIN_VAL,
455 /* Locks that the MFW is aware of should be added here downwards */
457 /* Ecore only locks should be added here upwards */
458 ECORE_RESC_LOCK_RESC_ALLOC = ECORE_MCP_RESC_LOCK_MAX_VAL
461 struct ecore_resc_lock_params {
462 /* Resource number [valid values are 0..31] */
465 /* Lock timeout value in seconds [default, none or 1..254] */
467 #define ECORE_MCP_RESC_LOCK_TO_DEFAULT 0
468 #define ECORE_MCP_RESC_LOCK_TO_NONE 255
470 /* Number of times to retry locking */
473 /* The interval in usec between retries */
476 /* Use sleep or delay between retries */
479 /* Will be set as true if the resource is free and granted */
482 /* Will be filled with the resource owner.
483 * [0..15 = PF0-15, 16 = MFW, 17 = diag over serial]
489 * @brief Acquires MFW generic resource lock
495 * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
498 ecore_mcp_resc_lock(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
499 struct ecore_resc_lock_params *p_params);
501 struct ecore_resc_unlock_params {
502 /* Resource number [valid values are 0..31] */
505 /* Allow to release a resource even if belongs to another PF */
508 /* Will be set as true if the resource is released */
513 * @brief Releases MFW generic resource lock
519 * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
522 ecore_mcp_resc_unlock(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
523 struct ecore_resc_unlock_params *p_params);
526 * @brief Learn of supported MFW features; To be done during early init
531 enum _ecore_status_t ecore_mcp_get_capabilities(struct ecore_hwfn *p_hwfn,
532 struct ecore_ptt *p_ptt);
535 * @brief Inform MFW of set of features supported by driver. Should be done
536 * inside the contet of the LOAD_REQ.
541 enum _ecore_status_t ecore_mcp_set_capabilities(struct ecore_hwfn *p_hwfn,
542 struct ecore_ptt *p_ptt);
544 #endif /* __ECORE_MCP_H__ */