1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright (c) 2016 - 2018 Cavium Inc.
7 #ifndef __ECORE_MCP_H__
8 #define __ECORE_MCP_H__
11 #include "mcp_public.h"
13 #include "ecore_mcp_api.h"
14 #include "ecore_dev_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 struct ecore_mcp_info {
29 /* List for mailbox commands which were sent and wait for a response */
32 /* Spinlock used for protecting the access to the mailbox commands list
33 * and the sending of the commands.
35 osal_spinlock_t cmd_lock;
37 /* Flag to indicate whether sending a MFW mailbox command is blocked */
40 /* Spinlock used for syncing SW link-changes and link-changes
41 * originating from attention context.
43 osal_spinlock_t link_lock;
45 /* Address of the MCP public area */
47 /* Address of the driver mailbox */
49 /* Address of the MFW mailbox */
51 /* Address of the port configuration (link) */
54 /* Current driver mailbox sequence */
56 /* Current driver pulse sequence */
59 struct ecore_mcp_link_params link_input;
60 struct ecore_mcp_link_state link_output;
61 struct ecore_mcp_link_capabilities link_capabilities;
63 struct ecore_mcp_function_info func_info;
70 /* Capabilties negotiated with the MFW */
74 struct ecore_mcp_mb_params {
85 struct ecore_drv_tlv_hdr {
86 u8 tlv_type; /* According to the enum below */
87 u8 tlv_length; /* In dwords - not including this header */
89 #define ECORE_DRV_TLV_FLAGS_CHANGED 0x01
94 * @brief Initialize the interface with the MCP
96 * @param p_hwfn - HW func
97 * @param p_ptt - PTT required for register access
99 * @return enum _ecore_status_t
101 enum _ecore_status_t ecore_mcp_cmd_init(struct ecore_hwfn *p_hwfn,
102 struct ecore_ptt *p_ptt);
105 * @brief Initialize the port interface with the MCP
109 * Can only be called after `num_ports_in_engine' is set
111 void ecore_mcp_cmd_port_init(struct ecore_hwfn *p_hwfn,
112 struct ecore_ptt *p_ptt);
114 * @brief Releases resources allocated during the init process.
116 * @param p_hwfn - HW func
117 * @param p_ptt - PTT required for register access
119 * @return enum _ecore_status_t
122 enum _ecore_status_t ecore_mcp_free(struct ecore_hwfn *p_hwfn);
125 * @brief This function is called from the DPC context. After
126 * pointing PTT to the mfw mb, check for events sent by the MCP
127 * to the driver and ack them. In case a critical event
128 * detected, it will be handled here, otherwise the work will be
129 * queued to a sleepable work-queue.
131 * @param p_hwfn - HW function
132 * @param p_ptt - PTT required for register access
133 * @return enum _ecore_status_t - ECORE_SUCCESS - operation
136 enum _ecore_status_t ecore_mcp_handle_events(struct ecore_hwfn *p_hwfn,
137 struct ecore_ptt *p_ptt);
140 * @brief When MFW doesn't get driver pulse for couple of seconds, at some
141 * threshold before timeout expires, it will generate interrupt
142 * through a dedicated status block (DPSB - Driver Pulse Status
143 * Block), which the driver should respond immediately, by
144 * providing keepalive indication after setting the PTT to the
145 * driver-MFW mailbox. This function is called directly from the
146 * DPC upon receiving the DPSB attention.
148 * @param p_hwfn - hw function
149 * @param p_ptt - PTT required for register access
150 * @return enum _ecore_status_t - ECORE_SUCCESS - operation
153 enum _ecore_status_t ecore_issue_pulse(struct ecore_hwfn *p_hwfn,
154 struct ecore_ptt *p_ptt);
156 enum ecore_drv_role {
158 ECORE_DRV_ROLE_KDUMP,
161 struct ecore_load_req_params {
163 enum ecore_drv_role drv_role;
164 u8 timeout_val; /* 1..254, '0' - default value, '255' - no timeout */
165 bool avoid_eng_reset;
166 enum ecore_override_force_load override_force_load;
173 * @brief Sends a LOAD_REQ to the MFW, and in case the operation succeeds,
174 * returns whether this PF is the first on the engine/port or function.
180 * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful.
182 enum _ecore_status_t ecore_mcp_load_req(struct ecore_hwfn *p_hwfn,
183 struct ecore_ptt *p_ptt,
184 struct ecore_load_req_params *p_params);
187 * @brief Sends a LOAD_DONE message to the MFW
192 * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful.
194 enum _ecore_status_t ecore_mcp_load_done(struct ecore_hwfn *p_hwfn,
195 struct ecore_ptt *p_ptt);
198 * @brief Sends a UNLOAD_REQ message to the MFW
203 * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful.
205 enum _ecore_status_t ecore_mcp_unload_req(struct ecore_hwfn *p_hwfn,
206 struct ecore_ptt *p_ptt);
209 * @brief Sends a UNLOAD_DONE message to the MFW
214 * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful.
216 enum _ecore_status_t ecore_mcp_unload_done(struct ecore_hwfn *p_hwfn,
217 struct ecore_ptt *p_ptt);
220 * @brief Read the MFW mailbox into Current buffer.
225 void ecore_mcp_read_mb(struct ecore_hwfn *p_hwfn,
226 struct ecore_ptt *p_ptt);
229 * @brief Ack to mfw that driver finished FLR process for VFs
233 * @param vfs_to_ack - bit mask of all engine VFs for which the PF acks.
235 * @param return enum _ecore_status_t - ECORE_SUCCESS upon success.
237 enum _ecore_status_t ecore_mcp_ack_vf_flr(struct ecore_hwfn *p_hwfn,
238 struct ecore_ptt *p_ptt,
242 * @brief - calls during init to read shmem of all function-related info.
246 * @param return ECORE_SUCCESS upon success.
248 enum _ecore_status_t ecore_mcp_fill_shmem_func_info(struct ecore_hwfn *p_hwfn,
249 struct ecore_ptt *p_ptt);
252 * @brief - Reset the MCP using mailbox command.
257 * @param return ECORE_SUCCESS upon success.
259 enum _ecore_status_t ecore_mcp_reset(struct ecore_hwfn *p_hwfn,
260 struct ecore_ptt *p_ptt);
263 * @brief indicates whether the MFW objects [under mcp_info] are accessible
267 * @return true iff MFW is running and mcp_info is initialized
269 bool ecore_mcp_is_init(struct ecore_hwfn *p_hwfn);
272 * @brief request MFW to configure MSI-X for a VF
276 * @param vf_id - absolute inside engine
277 * @param num_sbs - number of entries to request
279 * @return enum _ecore_status_t
281 enum _ecore_status_t ecore_mcp_config_vf_msix(struct ecore_hwfn *p_hwfn,
282 struct ecore_ptt *p_ptt,
286 * @brief - Halt the MCP.
291 * @param return ECORE_SUCCESS upon success.
293 enum _ecore_status_t ecore_mcp_halt(struct ecore_hwfn *p_hwfn,
294 struct ecore_ptt *p_ptt);
297 * @brief - Wake up the MCP.
302 * @param return ECORE_SUCCESS upon success.
304 enum _ecore_status_t ecore_mcp_resume(struct ecore_hwfn *p_hwfn,
305 struct ecore_ptt *p_ptt);
306 int __ecore_configure_pf_max_bandwidth(struct ecore_hwfn *p_hwfn,
307 struct ecore_ptt *p_ptt,
308 struct ecore_mcp_link_state *p_link,
310 int __ecore_configure_pf_min_bandwidth(struct ecore_hwfn *p_hwfn,
311 struct ecore_ptt *p_ptt,
312 struct ecore_mcp_link_state *p_link,
314 enum _ecore_status_t ecore_mcp_mask_parities(struct ecore_hwfn *p_hwfn,
315 struct ecore_ptt *p_ptt,
318 * @brief - Sends crash mdump related info to the MFW.
323 * @param return ECORE_SUCCESS upon success.
325 enum _ecore_status_t ecore_mcp_mdump_set_values(struct ecore_hwfn *p_hwfn,
326 struct ecore_ptt *p_ptt,
330 * @brief - Triggers a MFW crash dump procedure.
336 * @param return ECORE_SUCCESS upon success.
338 enum _ecore_status_t ecore_mcp_mdump_trigger(struct ecore_hwfn *p_hwfn,
339 struct ecore_ptt *p_ptt);
341 struct ecore_mdump_retain_data {
349 * @brief - Gets the mdump retained data from the MFW.
353 * @param p_mdump_retain
355 * @param return ECORE_SUCCESS upon success.
358 ecore_mcp_mdump_get_retain(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
359 struct ecore_mdump_retain_data *p_mdump_retain);
362 * @brief - Sets the MFW's max value for the given resource
367 * @param resc_max_val
370 * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
373 ecore_mcp_set_resc_max_val(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
374 enum ecore_resources res_id, u32 resc_max_val,
378 * @brief - Gets the MFW allocation info for the given resource
385 * @param p_resc_start
387 * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
390 ecore_mcp_get_resc_info(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
391 enum ecore_resources res_id, u32 *p_mcp_resp,
392 u32 *p_resc_num, u32 *p_resc_start);
395 * @brief - Initiates PF FLR
400 * @param return ECORE_SUCCESS upon success.
402 enum _ecore_status_t ecore_mcp_initiate_pf_flr(struct ecore_hwfn *p_hwfn,
403 struct ecore_ptt *p_ptt);
405 #define ECORE_MCP_RESC_LOCK_MIN_VAL RESOURCE_DUMP /* 0 */
406 #define ECORE_MCP_RESC_LOCK_MAX_VAL 31
408 enum ecore_resc_lock {
409 ECORE_RESC_LOCK_DBG_DUMP = ECORE_MCP_RESC_LOCK_MIN_VAL,
410 /* Locks that the MFW is aware of should be added here downwards */
412 /* Ecore only locks should be added here upwards */
413 ECORE_RESC_LOCK_RESC_ALLOC = ECORE_MCP_RESC_LOCK_MAX_VAL,
415 /* A dummy value to be used for auxiliary functions in need of
416 * returning an 'error' value.
418 ECORE_RESC_LOCK_RESC_INVALID,
421 struct ecore_resc_lock_params {
422 /* Resource number [valid values are 0..31] */
425 /* Lock timeout value in seconds [default, none or 1..254] */
427 #define ECORE_MCP_RESC_LOCK_TO_DEFAULT 0
428 #define ECORE_MCP_RESC_LOCK_TO_NONE 255
430 /* Number of times to retry locking */
432 #define ECORE_MCP_RESC_LOCK_RETRY_CNT_DFLT 10
434 /* The interval in usec between retries */
436 #define ECORE_MCP_RESC_LOCK_RETRY_VAL_DFLT 10000
438 /* Use sleep or delay between retries */
441 /* Will be set as true if the resource is free and granted */
444 /* Will be filled with the resource owner.
445 * [0..15 = PF0-15, 16 = MFW, 17 = diag over serial]
451 * @brief Acquires MFW generic resource lock
457 * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
460 ecore_mcp_resc_lock(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
461 struct ecore_resc_lock_params *p_params);
463 struct ecore_resc_unlock_params {
464 /* Resource number [valid values are 0..31] */
467 /* Allow to release a resource even if belongs to another PF */
470 /* Will be set as true if the resource is released */
475 * @brief Releases MFW generic resource lock
481 * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
484 ecore_mcp_resc_unlock(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
485 struct ecore_resc_unlock_params *p_params);
488 * @brief - default initialization for lock/unlock resource structs
490 * @param p_lock - lock params struct to be initialized; Can be OSAL_NULL
491 * @param p_unlock - unlock params struct to be initialized; Can be OSAL_NULL
492 * @param resource - the requested resource
493 * @paral b_is_permanent - disable retries & aging when set
495 void ecore_mcp_resc_lock_default_init(struct ecore_resc_lock_params *p_lock,
496 struct ecore_resc_unlock_params *p_unlock,
497 enum ecore_resc_lock resource,
498 bool b_is_permanent);
501 * @brief Learn of supported MFW features; To be done during early init
506 enum _ecore_status_t ecore_mcp_get_capabilities(struct ecore_hwfn *p_hwfn,
507 struct ecore_ptt *p_ptt);
510 * @brief Inform MFW of set of features supported by driver. Should be done
511 * inside the contet of the LOAD_REQ.
516 enum _ecore_status_t ecore_mcp_set_capabilities(struct ecore_hwfn *p_hwfn,
517 struct ecore_ptt *p_ptt);
519 enum ecore_mcp_drv_attr_cmd {
520 ECORE_MCP_DRV_ATTR_CMD_READ,
521 ECORE_MCP_DRV_ATTR_CMD_WRITE,
522 ECORE_MCP_DRV_ATTR_CMD_READ_CLEAR,
523 ECORE_MCP_DRV_ATTR_CMD_CLEAR,
526 struct ecore_mcp_drv_attr {
527 enum ecore_mcp_drv_attr_cmd attr_cmd;
530 /* R/RC - will be set with the read value
531 * W - should hold the required value to be written
536 /* W - mask/offset to be applied on the given value
544 * @brief Handle the drivers' attributes that are kept by the MFW.
551 ecore_mcp_drv_attribute(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
552 struct ecore_mcp_drv_attr *p_drv_attr);
555 * @brief Read ufp config from the shared memory.
561 ecore_mcp_read_ufp_config(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt);
563 void ecore_mcp_wol_wr(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
564 u32 offset, u32 val);
567 * @brief Get the engine affinity configuration.
572 enum _ecore_status_t ecore_mcp_get_engine_config(struct ecore_hwfn *p_hwfn,
573 struct ecore_ptt *p_ptt);
576 * @brief Get the PPFID bitmap.
581 enum _ecore_status_t ecore_mcp_get_ppfid_bitmap(struct ecore_hwfn *p_hwfn,
582 struct ecore_ptt *p_ptt);
584 #endif /* __ECORE_MCP_H__ */