1316485Sdavidcs/* 2316485Sdavidcs * Copyright (c) 2017-2018 Cavium, Inc. 3316485Sdavidcs * All rights reserved. 4316485Sdavidcs * 5316485Sdavidcs * Redistribution and use in source and binary forms, with or without 6316485Sdavidcs * modification, are permitted provided that the following conditions 7316485Sdavidcs * are met: 8316485Sdavidcs * 9316485Sdavidcs * 1. Redistributions of source code must retain the above copyright 10316485Sdavidcs * notice, this list of conditions and the following disclaimer. 11316485Sdavidcs * 2. Redistributions in binary form must reproduce the above copyright 12316485Sdavidcs * notice, this list of conditions and the following disclaimer in the 13316485Sdavidcs * documentation and/or other materials provided with the distribution. 14316485Sdavidcs * 15316485Sdavidcs * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 16316485Sdavidcs * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17316485Sdavidcs * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18316485Sdavidcs * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 19316485Sdavidcs * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 20316485Sdavidcs * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 21316485Sdavidcs * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 22316485Sdavidcs * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 23316485Sdavidcs * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 24316485Sdavidcs * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 25316485Sdavidcs * POSSIBILITY OF SUCH DAMAGE. 26316485Sdavidcs * 27316485Sdavidcs * $FreeBSD: stable/10/sys/dev/qlnx/qlnxe/ecore_mcp.h 337519 2018-08-09 01:39:47Z davidcs $ 28316485Sdavidcs * 29316485Sdavidcs */ 30316485Sdavidcs 31316485Sdavidcs 32316485Sdavidcs#ifndef __ECORE_MCP_H__ 33316485Sdavidcs#define __ECORE_MCP_H__ 34316485Sdavidcs 35316485Sdavidcs#include "bcm_osal.h" 36316485Sdavidcs#include "mcp_public.h" 37316485Sdavidcs#include "ecore.h" 38316485Sdavidcs#include "ecore_mcp_api.h" 39316485Sdavidcs#include "ecore_dev_api.h" 40316485Sdavidcs 41316485Sdavidcs/* Using hwfn number (and not pf_num) is required since in CMT mode, 42316485Sdavidcs * same pf_num may be used by two different hwfn 43316485Sdavidcs * TODO - this shouldn't really be in .h file, but until all fields 44316485Sdavidcs * required during hw-init will be placed in their correct place in shmem 45316485Sdavidcs * we need it in ecore_dev.c [for readin the nvram reflection in shmem]. 46316485Sdavidcs */ 47316485Sdavidcs#define MCP_PF_ID_BY_REL(p_hwfn, rel_pfid) (ECORE_IS_BB((p_hwfn)->p_dev) ? \ 48316485Sdavidcs ((rel_pfid) | \ 49316485Sdavidcs ((p_hwfn)->abs_pf_id & 1) << 3) : \ 50316485Sdavidcs rel_pfid) 51337519Sdavidcs#define MCP_PF_ID(p_hwfn) MCP_PF_ID_BY_REL(p_hwfn, (p_hwfn)->rel_pf_id) 52316485Sdavidcs 53316485Sdavidcsstruct ecore_mcp_info { 54320162Sdavidcs /* List for mailbox commands which were sent and wait for a response */ 55320162Sdavidcs osal_list_t cmd_list; 56316485Sdavidcs 57320162Sdavidcs /* Spinlock used for protecting the access to the mailbox commands list 58320162Sdavidcs * and the sending of the commands. 59320162Sdavidcs */ 60320162Sdavidcs osal_spinlock_t cmd_lock; 61320162Sdavidcs 62320162Sdavidcs /* Flag to indicate whether sending a MFW mailbox command is blocked */ 63320162Sdavidcs bool b_block_cmd; 64320162Sdavidcs 65320162Sdavidcs /* Spinlock used for syncing SW link-changes and link-changes 66316485Sdavidcs * originating from attention context. 67316485Sdavidcs */ 68316485Sdavidcs osal_spinlock_t link_lock; 69316485Sdavidcs 70316485Sdavidcs /* Address of the MCP public area */ 71316485Sdavidcs u32 public_base; 72316485Sdavidcs /* Address of the driver mailbox */ 73316485Sdavidcs u32 drv_mb_addr; 74316485Sdavidcs /* Address of the MFW mailbox */ 75316485Sdavidcs u32 mfw_mb_addr; 76316485Sdavidcs /* Address of the port configuration (link) */ 77316485Sdavidcs u32 port_addr; 78316485Sdavidcs 79316485Sdavidcs /* Current driver mailbox sequence */ 80316485Sdavidcs u16 drv_mb_seq; 81316485Sdavidcs /* Current driver pulse sequence */ 82316485Sdavidcs u16 drv_pulse_seq; 83316485Sdavidcs 84316485Sdavidcs struct ecore_mcp_link_params link_input; 85316485Sdavidcs struct ecore_mcp_link_state link_output; 86316485Sdavidcs struct ecore_mcp_link_capabilities link_capabilities; 87316485Sdavidcs 88316485Sdavidcs struct ecore_mcp_function_info func_info; 89316485Sdavidcs 90316485Sdavidcs u8 *mfw_mb_cur; 91316485Sdavidcs u8 *mfw_mb_shadow; 92316485Sdavidcs u16 mfw_mb_length; 93320162Sdavidcs u32 mcp_hist; 94316485Sdavidcs 95316485Sdavidcs /* Capabilties negotiated with the MFW */ 96316485Sdavidcs u32 capabilities; 97316485Sdavidcs}; 98316485Sdavidcs 99316485Sdavidcsstruct ecore_mcp_mb_params { 100316485Sdavidcs u32 cmd; 101316485Sdavidcs u32 param; 102316485Sdavidcs void *p_data_src; 103316485Sdavidcs void *p_data_dst; 104316485Sdavidcs u32 mcp_resp; 105316485Sdavidcs u32 mcp_param; 106337519Sdavidcs u8 data_src_size; 107337519Sdavidcs u8 data_dst_size; 108337519Sdavidcs u32 flags; 109337519Sdavidcs#define ECORE_MB_FLAG_CAN_SLEEP (0x1 << 0) 110337519Sdavidcs#define ECORE_MB_FLAG_AVOID_BLOCK (0x1 << 1) 111337519Sdavidcs#define ECORE_MB_FLAGS_IS_SET(params, flag) \ 112337519Sdavidcs ((params) != OSAL_NULL && ((params)->flags & ECORE_MB_FLAG_##flag)) 113316485Sdavidcs}; 114316485Sdavidcs 115316485Sdavidcsenum ecore_ov_eswitch { 116316485Sdavidcs ECORE_OV_ESWITCH_NONE, 117316485Sdavidcs ECORE_OV_ESWITCH_VEB, 118316485Sdavidcs ECORE_OV_ESWITCH_VEPA 119316485Sdavidcs}; 120316485Sdavidcs 121316485Sdavidcsstruct ecore_drv_tlv_hdr { 122316485Sdavidcs u8 tlv_type; /* According to the enum below */ 123316485Sdavidcs u8 tlv_length; /* In dwords - not including this header */ 124316485Sdavidcs u8 tlv_reserved; 125316485Sdavidcs#define ECORE_DRV_TLV_FLAGS_CHANGED 0x01 126316485Sdavidcs u8 tlv_flags; 127316485Sdavidcs}; 128316485Sdavidcs 129316485Sdavidcs/** 130316485Sdavidcs * @brief Initialize the interface with the MCP 131316485Sdavidcs * 132316485Sdavidcs * @param p_hwfn - HW func 133316485Sdavidcs * @param p_ptt - PTT required for register access 134316485Sdavidcs * 135316485Sdavidcs * @return enum _ecore_status_t 136316485Sdavidcs */ 137316485Sdavidcsenum _ecore_status_t ecore_mcp_cmd_init(struct ecore_hwfn *p_hwfn, 138316485Sdavidcs struct ecore_ptt *p_ptt); 139316485Sdavidcs 140316485Sdavidcs/** 141337519Sdavidcs * @brief Initialize the port interface with the MCP 142316485Sdavidcs * 143316485Sdavidcs * @param p_hwfn 144316485Sdavidcs * @param p_ptt 145320162Sdavidcs * Can only be called after `num_ports_in_engine' is set 146316485Sdavidcs */ 147316485Sdavidcsvoid ecore_mcp_cmd_port_init(struct ecore_hwfn *p_hwfn, 148316485Sdavidcs struct ecore_ptt *p_ptt); 149316485Sdavidcs/** 150316485Sdavidcs * @brief Releases resources allocated during the init process. 151316485Sdavidcs * 152316485Sdavidcs * @param p_hwfn - HW func 153316485Sdavidcs * @param p_ptt - PTT required for register access 154316485Sdavidcs * 155316485Sdavidcs * @return enum _ecore_status_t 156316485Sdavidcs */ 157316485Sdavidcs 158316485Sdavidcsenum _ecore_status_t ecore_mcp_free(struct ecore_hwfn *p_hwfn); 159316485Sdavidcs 160316485Sdavidcs/** 161316485Sdavidcs * @brief This function is called from the DPC context. After 162316485Sdavidcs * pointing PTT to the mfw mb, check for events sent by the MCP 163316485Sdavidcs * to the driver and ack them. In case a critical event 164316485Sdavidcs * detected, it will be handled here, otherwise the work will be 165316485Sdavidcs * queued to a sleepable work-queue. 166316485Sdavidcs * 167316485Sdavidcs * @param p_hwfn - HW function 168316485Sdavidcs * @param p_ptt - PTT required for register access 169316485Sdavidcs * @return enum _ecore_status_t - ECORE_SUCCESS - operation 170316485Sdavidcs * was successul. 171316485Sdavidcs */ 172316485Sdavidcsenum _ecore_status_t ecore_mcp_handle_events(struct ecore_hwfn *p_hwfn, 173316485Sdavidcs struct ecore_ptt *p_ptt); 174316485Sdavidcs 175316485Sdavidcs/** 176316485Sdavidcs * @brief When MFW doesn't get driver pulse for couple of seconds, at some 177316485Sdavidcs * threshold before timeout expires, it will generate interrupt 178316485Sdavidcs * through a dedicated status block (DPSB - Driver Pulse Status 179316485Sdavidcs * Block), which the driver should respond immediately, by 180316485Sdavidcs * providing keepalive indication after setting the PTT to the 181316485Sdavidcs * driver-MFW mailbox. This function is called directly from the 182316485Sdavidcs * DPC upon receiving the DPSB attention. 183316485Sdavidcs * 184316485Sdavidcs * @param p_hwfn - hw function 185316485Sdavidcs * @param p_ptt - PTT required for register access 186316485Sdavidcs * @return enum _ecore_status_t - ECORE_SUCCESS - operation 187316485Sdavidcs * was successful. 188316485Sdavidcs */ 189316485Sdavidcsenum _ecore_status_t ecore_issue_pulse(struct ecore_hwfn *p_hwfn, 190316485Sdavidcs struct ecore_ptt *p_ptt); 191316485Sdavidcs 192316485Sdavidcsenum ecore_drv_role { 193316485Sdavidcs ECORE_DRV_ROLE_OS, 194316485Sdavidcs ECORE_DRV_ROLE_KDUMP, 195316485Sdavidcs}; 196316485Sdavidcs 197316485Sdavidcsstruct ecore_load_req_params { 198316485Sdavidcs /* Input params */ 199316485Sdavidcs enum ecore_drv_role drv_role; 200316485Sdavidcs u8 timeout_val; /* 1..254, '0' - default value, '255' - no timeout */ 201316485Sdavidcs bool avoid_eng_reset; 202316485Sdavidcs enum ecore_override_force_load override_force_load; 203316485Sdavidcs 204316485Sdavidcs /* Output params */ 205316485Sdavidcs u32 load_code; 206316485Sdavidcs}; 207316485Sdavidcs 208316485Sdavidcs/** 209316485Sdavidcs * @brief Sends a LOAD_REQ to the MFW, and in case the operation succeeds, 210316485Sdavidcs * returns whether this PF is the first on the engine/port or function. 211316485Sdavidcs * 212316485Sdavidcs * @param p_hwfn 213316485Sdavidcs * @param p_ptt 214316485Sdavidcs * @param p_params 215316485Sdavidcs * 216316485Sdavidcs * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful. 217316485Sdavidcs */ 218316485Sdavidcsenum _ecore_status_t ecore_mcp_load_req(struct ecore_hwfn *p_hwfn, 219316485Sdavidcs struct ecore_ptt *p_ptt, 220316485Sdavidcs struct ecore_load_req_params *p_params); 221316485Sdavidcs 222316485Sdavidcs/** 223337519Sdavidcs * @brief Sends a LOAD_DONE message to the MFW 224337519Sdavidcs * 225337519Sdavidcs * @param p_hwfn 226337519Sdavidcs * @param p_ptt 227337519Sdavidcs * 228337519Sdavidcs * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful. 229337519Sdavidcs */ 230337519Sdavidcsenum _ecore_status_t ecore_mcp_load_done(struct ecore_hwfn *p_hwfn, 231337519Sdavidcs struct ecore_ptt *p_ptt); 232337519Sdavidcs 233337519Sdavidcs/** 234337519Sdavidcs * @brief Sends a CANCEL_LOAD_REQ message to the MFW 235337519Sdavidcs * 236337519Sdavidcs * @param p_hwfn 237337519Sdavidcs * @param p_ptt 238337519Sdavidcs * 239337519Sdavidcs * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful. 240337519Sdavidcs */ 241337519Sdavidcsenum _ecore_status_t ecore_mcp_cancel_load_req(struct ecore_hwfn *p_hwfn, 242337519Sdavidcs struct ecore_ptt *p_ptt); 243337519Sdavidcs 244337519Sdavidcs/** 245316485Sdavidcs * @brief Sends a UNLOAD_REQ message to the MFW 246316485Sdavidcs * 247316485Sdavidcs * @param p_hwfn 248316485Sdavidcs * @param p_ptt 249316485Sdavidcs * 250316485Sdavidcs * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful. 251316485Sdavidcs */ 252316485Sdavidcsenum _ecore_status_t ecore_mcp_unload_req(struct ecore_hwfn *p_hwfn, 253316485Sdavidcs struct ecore_ptt *p_ptt); 254316485Sdavidcs 255316485Sdavidcs/** 256316485Sdavidcs * @brief Sends a UNLOAD_DONE message to the MFW 257316485Sdavidcs * 258316485Sdavidcs * @param p_hwfn 259316485Sdavidcs * @param p_ptt 260316485Sdavidcs * 261316485Sdavidcs * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful. 262316485Sdavidcs */ 263316485Sdavidcsenum _ecore_status_t ecore_mcp_unload_done(struct ecore_hwfn *p_hwfn, 264316485Sdavidcs struct ecore_ptt *p_ptt); 265316485Sdavidcs 266316485Sdavidcs/** 267316485Sdavidcs * @brief Read the MFW mailbox into Current buffer. 268316485Sdavidcs * 269316485Sdavidcs * @param p_hwfn 270316485Sdavidcs * @param p_ptt 271316485Sdavidcs */ 272316485Sdavidcsvoid ecore_mcp_read_mb(struct ecore_hwfn *p_hwfn, 273316485Sdavidcs struct ecore_ptt *p_ptt); 274316485Sdavidcs 275316485Sdavidcs/** 276316485Sdavidcs * @brief Ack to mfw that driver finished FLR process for VFs 277316485Sdavidcs * 278316485Sdavidcs * @param p_hwfn 279316485Sdavidcs * @param p_ptt 280316485Sdavidcs * @param vfs_to_ack - bit mask of all engine VFs for which the PF acks. 281316485Sdavidcs * 282316485Sdavidcs * @param return enum _ecore_status_t - ECORE_SUCCESS upon success. 283316485Sdavidcs */ 284316485Sdavidcsenum _ecore_status_t ecore_mcp_ack_vf_flr(struct ecore_hwfn *p_hwfn, 285316485Sdavidcs struct ecore_ptt *p_ptt, 286316485Sdavidcs u32 *vfs_to_ack); 287316485Sdavidcs 288316485Sdavidcs/** 289316485Sdavidcs * @brief - calls during init to read shmem of all function-related info. 290316485Sdavidcs * 291316485Sdavidcs * @param p_hwfn 292316485Sdavidcs * 293316485Sdavidcs * @param return ECORE_SUCCESS upon success. 294316485Sdavidcs */ 295316485Sdavidcsenum _ecore_status_t ecore_mcp_fill_shmem_func_info(struct ecore_hwfn *p_hwfn, 296316485Sdavidcs struct ecore_ptt *p_ptt); 297316485Sdavidcs 298316485Sdavidcs/** 299316485Sdavidcs * @brief - Reset the MCP using mailbox command. 300316485Sdavidcs * 301316485Sdavidcs * @param p_hwfn 302316485Sdavidcs * @param p_ptt 303316485Sdavidcs * 304316485Sdavidcs * @param return ECORE_SUCCESS upon success. 305316485Sdavidcs */ 306316485Sdavidcsenum _ecore_status_t ecore_mcp_reset(struct ecore_hwfn *p_hwfn, 307316485Sdavidcs struct ecore_ptt *p_ptt); 308316485Sdavidcs 309316485Sdavidcs/** 310316485Sdavidcs * @brief indicates whether the MFW objects [under mcp_info] are accessible 311316485Sdavidcs * 312316485Sdavidcs * @param p_hwfn 313316485Sdavidcs * 314316485Sdavidcs * @return true iff MFW is running and mcp_info is initialized 315316485Sdavidcs */ 316316485Sdavidcsbool ecore_mcp_is_init(struct ecore_hwfn *p_hwfn); 317316485Sdavidcs 318316485Sdavidcs/** 319316485Sdavidcs * @brief request MFW to configure MSI-X for a VF 320316485Sdavidcs * 321316485Sdavidcs * @param p_hwfn 322316485Sdavidcs * @param p_ptt 323316485Sdavidcs * @param vf_id - absolute inside engine 324316485Sdavidcs * @param num_sbs - number of entries to request 325316485Sdavidcs * 326316485Sdavidcs * @return enum _ecore_status_t 327316485Sdavidcs */ 328316485Sdavidcsenum _ecore_status_t ecore_mcp_config_vf_msix(struct ecore_hwfn *p_hwfn, 329316485Sdavidcs struct ecore_ptt *p_ptt, 330316485Sdavidcs u8 vf_id, u8 num); 331316485Sdavidcs 332316485Sdavidcs/** 333316485Sdavidcs * @brief - Halt the MCP. 334316485Sdavidcs * 335316485Sdavidcs * @param p_hwfn 336316485Sdavidcs * @param p_ptt 337316485Sdavidcs * 338316485Sdavidcs * @param return ECORE_SUCCESS upon success. 339316485Sdavidcs */ 340316485Sdavidcsenum _ecore_status_t ecore_mcp_halt(struct ecore_hwfn *p_hwfn, 341316485Sdavidcs struct ecore_ptt *p_ptt); 342316485Sdavidcs 343316485Sdavidcs/** 344316485Sdavidcs * @brief - Wake up the MCP. 345316485Sdavidcs * 346316485Sdavidcs * @param p_hwfn 347316485Sdavidcs * @param p_ptt 348316485Sdavidcs * 349316485Sdavidcs * @param return ECORE_SUCCESS upon success. 350316485Sdavidcs */ 351316485Sdavidcsenum _ecore_status_t ecore_mcp_resume(struct ecore_hwfn *p_hwfn, 352316485Sdavidcs struct ecore_ptt *p_ptt); 353316485Sdavidcsint __ecore_configure_pf_max_bandwidth(struct ecore_hwfn *p_hwfn, 354316485Sdavidcs struct ecore_ptt *p_ptt, 355316485Sdavidcs struct ecore_mcp_link_state *p_link, 356316485Sdavidcs u8 max_bw); 357316485Sdavidcsint __ecore_configure_pf_min_bandwidth(struct ecore_hwfn *p_hwfn, 358316485Sdavidcs struct ecore_ptt *p_ptt, 359316485Sdavidcs struct ecore_mcp_link_state *p_link, 360316485Sdavidcs u8 min_bw); 361316485Sdavidcsenum _ecore_status_t ecore_mcp_mask_parities(struct ecore_hwfn *p_hwfn, 362316485Sdavidcs struct ecore_ptt *p_ptt, 363316485Sdavidcs u32 mask_parities); 364316485Sdavidcs#if 0 365316485Sdavidcsenum _ecore_status_t ecore_hw_init_first_eth(struct ecore_hwfn *p_hwfn, 366316485Sdavidcs struct ecore_ptt *p_ptt, 367316485Sdavidcs u8 *p_pf); 368316485Sdavidcs#endif 369316485Sdavidcs 370316485Sdavidcs/** 371316485Sdavidcs * @brief - Sends crash mdump related info to the MFW. 372316485Sdavidcs * 373316485Sdavidcs * @param p_hwfn 374316485Sdavidcs * @param p_ptt 375316485Sdavidcs * @param epoch 376316485Sdavidcs * 377316485Sdavidcs * @param return ECORE_SUCCESS upon success. 378316485Sdavidcs */ 379316485Sdavidcsenum _ecore_status_t ecore_mcp_mdump_set_values(struct ecore_hwfn *p_hwfn, 380316485Sdavidcs struct ecore_ptt *p_ptt, 381316485Sdavidcs u32 epoch); 382316485Sdavidcs 383316485Sdavidcs/** 384316485Sdavidcs * @brief - Triggers a MFW crash dump procedure. 385316485Sdavidcs * 386316485Sdavidcs * @param p_hwfn 387316485Sdavidcs * @param p_ptt 388316485Sdavidcs * 389316485Sdavidcs * @param return ECORE_SUCCESS upon success. 390316485Sdavidcs */ 391316485Sdavidcsenum _ecore_status_t ecore_mcp_mdump_trigger(struct ecore_hwfn *p_hwfn, 392316485Sdavidcs struct ecore_ptt *p_ptt); 393316485Sdavidcs 394316485Sdavidcsstruct ecore_mdump_retain_data { 395316485Sdavidcs u32 valid; 396316485Sdavidcs u32 epoch; 397316485Sdavidcs u32 pf; 398316485Sdavidcs u32 status; 399316485Sdavidcs}; 400316485Sdavidcs 401316485Sdavidcs/** 402316485Sdavidcs * @brief - Gets the mdump retained data from the MFW. 403316485Sdavidcs * 404316485Sdavidcs * @param p_hwfn 405316485Sdavidcs * @param p_ptt 406316485Sdavidcs * @param p_mdump_retain 407316485Sdavidcs * 408316485Sdavidcs * @param return ECORE_SUCCESS upon success. 409316485Sdavidcs */ 410316485Sdavidcsenum _ecore_status_t 411316485Sdavidcsecore_mcp_mdump_get_retain(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt, 412316485Sdavidcs struct ecore_mdump_retain_data *p_mdump_retain); 413316485Sdavidcs 414316485Sdavidcs/** 415316485Sdavidcs * @brief - Sets the MFW's max value for the given resource 416316485Sdavidcs * 417316485Sdavidcs * @param p_hwfn 418316485Sdavidcs * @param p_ptt 419316485Sdavidcs * @param res_id 420316485Sdavidcs * @param resc_max_val 421316485Sdavidcs * @param p_mcp_resp 422316485Sdavidcs * 423316485Sdavidcs * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful. 424316485Sdavidcs */ 425316485Sdavidcsenum _ecore_status_t 426316485Sdavidcsecore_mcp_set_resc_max_val(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt, 427316485Sdavidcs enum ecore_resources res_id, u32 resc_max_val, 428316485Sdavidcs u32 *p_mcp_resp); 429316485Sdavidcs 430316485Sdavidcs/** 431316485Sdavidcs * @brief - Gets the MFW allocation info for the given resource 432316485Sdavidcs * 433316485Sdavidcs * @param p_hwfn 434316485Sdavidcs * @param p_ptt 435316485Sdavidcs * @param res_id 436316485Sdavidcs * @param p_mcp_resp 437316485Sdavidcs * @param p_resc_num 438316485Sdavidcs * @param p_resc_start 439316485Sdavidcs * 440316485Sdavidcs * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful. 441316485Sdavidcs */ 442316485Sdavidcsenum _ecore_status_t 443316485Sdavidcsecore_mcp_get_resc_info(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt, 444316485Sdavidcs enum ecore_resources res_id, u32 *p_mcp_resp, 445316485Sdavidcs u32 *p_resc_num, u32 *p_resc_start); 446316485Sdavidcs 447316485Sdavidcs/** 448316485Sdavidcs * @brief - Initiates PF FLR 449316485Sdavidcs * 450316485Sdavidcs * @param p_hwfn 451316485Sdavidcs * @param p_ptt 452316485Sdavidcs * 453316485Sdavidcs * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful. 454316485Sdavidcs */ 455316485Sdavidcsenum _ecore_status_t ecore_mcp_initiate_pf_flr(struct ecore_hwfn *p_hwfn, 456316485Sdavidcs struct ecore_ptt *p_ptt); 457316485Sdavidcs 458316485Sdavidcs/** 459316485Sdavidcs * @brief Send eswitch mode to MFW 460316485Sdavidcs * 461316485Sdavidcs * @param p_hwfn 462316485Sdavidcs * @param p_ptt 463316485Sdavidcs * @param eswitch - eswitch mode 464316485Sdavidcs * 465316485Sdavidcs * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful. 466316485Sdavidcs */ 467316485Sdavidcsenum _ecore_status_t 468316485Sdavidcsecore_mcp_ov_update_eswitch(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt, 469316485Sdavidcs enum ecore_ov_eswitch eswitch); 470316485Sdavidcs 471316485Sdavidcs#define ECORE_MCP_RESC_LOCK_MIN_VAL RESOURCE_DUMP /* 0 */ 472316485Sdavidcs#define ECORE_MCP_RESC_LOCK_MAX_VAL 31 473316485Sdavidcs 474316485Sdavidcsenum ecore_resc_lock { 475316485Sdavidcs ECORE_RESC_LOCK_DBG_DUMP = ECORE_MCP_RESC_LOCK_MIN_VAL, 476316485Sdavidcs /* Locks that the MFW is aware of should be added here downwards */ 477316485Sdavidcs 478316485Sdavidcs /* Ecore only locks should be added here upwards */ 479337519Sdavidcs ECORE_RESC_LOCK_IND_TABLE = 26, 480337519Sdavidcs ECORE_RESC_LOCK_PTP_PORT0 = 27, 481337519Sdavidcs ECORE_RESC_LOCK_PTP_PORT1 = 28, 482337519Sdavidcs ECORE_RESC_LOCK_PTP_PORT2 = 29, 483337519Sdavidcs ECORE_RESC_LOCK_PTP_PORT3 = 30, 484320162Sdavidcs ECORE_RESC_LOCK_RESC_ALLOC = ECORE_MCP_RESC_LOCK_MAX_VAL, 485320162Sdavidcs 486320162Sdavidcs /* A dummy value to be used for auxillary functions in need of 487320162Sdavidcs * returning an 'error' value. 488320162Sdavidcs */ 489320162Sdavidcs ECORE_RESC_LOCK_RESC_INVALID, 490316485Sdavidcs}; 491316485Sdavidcs 492316485Sdavidcsstruct ecore_resc_lock_params { 493316485Sdavidcs /* Resource number [valid values are 0..31] */ 494316485Sdavidcs u8 resource; 495316485Sdavidcs 496316485Sdavidcs /* Lock timeout value in seconds [default, none or 1..254] */ 497316485Sdavidcs u8 timeout; 498316485Sdavidcs#define ECORE_MCP_RESC_LOCK_TO_DEFAULT 0 499316485Sdavidcs#define ECORE_MCP_RESC_LOCK_TO_NONE 255 500316485Sdavidcs 501316485Sdavidcs /* Number of times to retry locking */ 502316485Sdavidcs u8 retry_num; 503320162Sdavidcs#define ECORE_MCP_RESC_LOCK_RETRY_CNT_DFLT 10 504316485Sdavidcs 505316485Sdavidcs /* The interval in usec between retries */ 506337519Sdavidcs u32 retry_interval; 507320162Sdavidcs#define ECORE_MCP_RESC_LOCK_RETRY_VAL_DFLT 10000 508316485Sdavidcs 509316485Sdavidcs /* Use sleep or delay between retries */ 510316485Sdavidcs bool sleep_b4_retry; 511316485Sdavidcs 512316485Sdavidcs /* Will be set as true if the resource is free and granted */ 513316485Sdavidcs bool b_granted; 514316485Sdavidcs 515316485Sdavidcs /* Will be filled with the resource owner. 516316485Sdavidcs * [0..15 = PF0-15, 16 = MFW, 17 = diag over serial] 517316485Sdavidcs */ 518316485Sdavidcs u8 owner; 519316485Sdavidcs}; 520316485Sdavidcs 521316485Sdavidcs/** 522316485Sdavidcs * @brief Acquires MFW generic resource lock 523316485Sdavidcs * 524316485Sdavidcs * @param p_hwfn 525316485Sdavidcs * @param p_ptt 526316485Sdavidcs * @param p_params 527316485Sdavidcs * 528316485Sdavidcs * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful. 529316485Sdavidcs */ 530316485Sdavidcsenum _ecore_status_t 531316485Sdavidcsecore_mcp_resc_lock(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt, 532316485Sdavidcs struct ecore_resc_lock_params *p_params); 533316485Sdavidcs 534316485Sdavidcsstruct ecore_resc_unlock_params { 535316485Sdavidcs /* Resource number [valid values are 0..31] */ 536316485Sdavidcs u8 resource; 537316485Sdavidcs 538316485Sdavidcs /* Allow to release a resource even if belongs to another PF */ 539316485Sdavidcs bool b_force; 540316485Sdavidcs 541316485Sdavidcs /* Will be set as true if the resource is released */ 542316485Sdavidcs bool b_released; 543316485Sdavidcs}; 544316485Sdavidcs 545316485Sdavidcs/** 546316485Sdavidcs * @brief Releases MFW generic resource lock 547316485Sdavidcs * 548316485Sdavidcs * @param p_hwfn 549316485Sdavidcs * @param p_ptt 550316485Sdavidcs * @param p_params 551316485Sdavidcs * 552316485Sdavidcs * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful. 553316485Sdavidcs */ 554316485Sdavidcsenum _ecore_status_t 555316485Sdavidcsecore_mcp_resc_unlock(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt, 556316485Sdavidcs struct ecore_resc_unlock_params *p_params); 557316485Sdavidcs 558320162Sdavidcs/** 559320162Sdavidcs * @brief - default initialization for lock/unlock resource structs 560320162Sdavidcs * 561320162Sdavidcs * @param p_lock - lock params struct to be initialized; Can be OSAL_NULL 562320162Sdavidcs * @param p_unlock - unlock params struct to be initialized; Can be OSAL_NULL 563320162Sdavidcs * @param resource - the requested resource 564320162Sdavidcs * @paral b_is_permanent - disable retries & aging when set 565320162Sdavidcs */ 566320162Sdavidcsvoid ecore_mcp_resc_lock_default_init(struct ecore_resc_lock_params *p_lock, 567320162Sdavidcs struct ecore_resc_unlock_params *p_unlock, 568320162Sdavidcs enum ecore_resc_lock resource, 569320162Sdavidcs bool b_is_permanent); 570320162Sdavidcs 571316485Sdavidcsvoid ecore_mcp_wol_wr(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt, 572316485Sdavidcs u32 offset, u32 val); 573316485Sdavidcs 574316485Sdavidcs/** 575316485Sdavidcs * @brief Learn of supported MFW features; To be done during early init 576316485Sdavidcs * 577316485Sdavidcs * @param p_hwfn 578316485Sdavidcs * @param p_ptt 579316485Sdavidcs */ 580316485Sdavidcsenum _ecore_status_t ecore_mcp_get_capabilities(struct ecore_hwfn *p_hwfn, 581316485Sdavidcs struct ecore_ptt *p_ptt); 582316485Sdavidcs 583316485Sdavidcs/** 584316485Sdavidcs * @brief Inform MFW of set of features supported by driver. Should be done 585316485Sdavidcs * inside the contet of the LOAD_REQ. 586316485Sdavidcs * 587316485Sdavidcs * @param p_hwfn 588316485Sdavidcs * @param p_ptt 589316485Sdavidcs */ 590316485Sdavidcsenum _ecore_status_t ecore_mcp_set_capabilities(struct ecore_hwfn *p_hwfn, 591316485Sdavidcs struct ecore_ptt *p_ptt); 592316485Sdavidcs 593316485Sdavidcs/** 594316485Sdavidcs * @brief Initialize MFW mailbox and sequence values for driver interaction. 595316485Sdavidcs * 596316485Sdavidcs * @param p_hwfn 597316485Sdavidcs * @param p_ptt 598316485Sdavidcs */ 599316485Sdavidcsenum _ecore_status_t ecore_load_mcp_offsets(struct ecore_hwfn *p_hwfn, 600316485Sdavidcs struct ecore_ptt *p_ptt); 601316485Sdavidcs 602337519Sdavidcsenum ecore_mcp_drv_attr_cmd { 603337519Sdavidcs ECORE_MCP_DRV_ATTR_CMD_READ, 604337519Sdavidcs ECORE_MCP_DRV_ATTR_CMD_WRITE, 605337519Sdavidcs ECORE_MCP_DRV_ATTR_CMD_READ_CLEAR, 606337519Sdavidcs ECORE_MCP_DRV_ATTR_CMD_CLEAR, 607337519Sdavidcs}; 608337519Sdavidcs 609337519Sdavidcsstruct ecore_mcp_drv_attr { 610337519Sdavidcs enum ecore_mcp_drv_attr_cmd attr_cmd; 611337519Sdavidcs u32 attr_num; 612337519Sdavidcs 613337519Sdavidcs /* R/RC - will be set with the read value 614337519Sdavidcs * W - should hold the required value to be written 615337519Sdavidcs * C - DC 616337519Sdavidcs */ 617337519Sdavidcs u32 val; 618337519Sdavidcs 619337519Sdavidcs /* W - mask/offset to be applied on the given value 620337519Sdavidcs * R/RC/C - DC 621337519Sdavidcs */ 622337519Sdavidcs u32 mask; 623337519Sdavidcs u32 offset; 624337519Sdavidcs}; 625337519Sdavidcs 626337519Sdavidcs/** 627337519Sdavidcs * @brief Handle the drivers' attributes that are kept by the MFW. 628337519Sdavidcs * 629337519Sdavidcs * @param p_hwfn 630337519Sdavidcs * @param p_ptt 631337519Sdavidcs * @param p_drv_attr 632337519Sdavidcs */ 633337519Sdavidcsenum _ecore_status_t 634337519Sdavidcsecore_mcp_drv_attribute(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt, 635337519Sdavidcs struct ecore_mcp_drv_attr *p_drv_attr); 636337519Sdavidcs 637337519Sdavidcs/** 638337519Sdavidcs * @brief Read ufp config from the shared memory. 639337519Sdavidcs * 640337519Sdavidcs * @param p_hwfn 641337519Sdavidcs * @param p_ptt 642337519Sdavidcs */ 643337519Sdavidcsvoid 644337519Sdavidcsecore_mcp_read_ufp_config(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt); 645337519Sdavidcs 646337519Sdavidcs/** 647337519Sdavidcs * @brief Get the engine affinity configuration. 648337519Sdavidcs * 649337519Sdavidcs * @param p_hwfn 650337519Sdavidcs * @param p_ptt 651337519Sdavidcs */ 652337519Sdavidcsenum _ecore_status_t ecore_mcp_get_engine_config(struct ecore_hwfn *p_hwfn, 653337519Sdavidcs struct ecore_ptt *p_ptt); 654337519Sdavidcs 655337519Sdavidcs/** 656337519Sdavidcs * @brief Get the PPFID bitmap. 657337519Sdavidcs * 658337519Sdavidcs * @param p_hwfn 659337519Sdavidcs * @param p_ptt 660337519Sdavidcs */ 661337519Sdavidcsenum _ecore_status_t ecore_mcp_get_ppfid_bitmap(struct ecore_hwfn *p_hwfn, 662337519Sdavidcs struct ecore_ptt *p_ptt); 663337519Sdavidcs 664337519Sdavidcs/** 665337519Sdavidcs * @brief Acquire MCP lock to access to HW indirection table entries 666337519Sdavidcs * 667337519Sdavidcs * @param p_hwfn 668337519Sdavidcs * @param p_ptt 669337519Sdavidcs * @param retry_num 670337519Sdavidcs * @param retry_interval 671337519Sdavidcs */ 672337519Sdavidcsenum _ecore_status_t 673337519Sdavidcsecore_mcp_ind_table_lock(struct ecore_hwfn *p_hwfn, 674337519Sdavidcs struct ecore_ptt *p_ptt, 675337519Sdavidcs u8 retry_num, 676337519Sdavidcs u32 retry_interval); 677337519Sdavidcs 678337519Sdavidcs/** 679337519Sdavidcs * @brief Release MCP lock of access to HW indirection table entries 680337519Sdavidcs * 681337519Sdavidcs * @param p_hwfn 682337519Sdavidcs * @param p_ptt 683337519Sdavidcs */ 684337519Sdavidcsenum _ecore_status_t 685337519Sdavidcsecore_mcp_ind_table_unlock(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt); 686337519Sdavidcs 687316485Sdavidcs#endif /* __ECORE_MCP_H__ */ 688