drivers/net/qede/base/ecore_mcp.h

   1 /*
   2  * Copyright (c) 2016 QLogic Corporation.
   3  * All rights reserved.
   4  * www.qlogic.com
   5  *
   6  * See LICENSE.qede_pmd for copyright and licensing details.
   7  */
   8
   9 #ifndef __ECORE_MCP_H__
  10 #define __ECORE_MCP_H__
  11
  12 #include "bcm_osal.h"
  13 #include "mcp_public.h"
  14 #include "ecore.h"
  15 #include "ecore_mcp_api.h"
  16 #include "ecore_dev_api.h"
  17
  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].
  23  */
  24 #define MCP_PF_ID_BY_REL(p_hwfn, rel_pfid) (ECORE_IS_BB((p_hwfn)->p_dev) ? \
  25                                             ((rel_pfid) | \
  26                                              ((p_hwfn)->abs_pf_id & 1) << 3) : \
  27                                              rel_pfid)
  28 #define MCP_PF_ID(p_hwfn) MCP_PF_ID_BY_REL(p_hwfn, (p_hwfn)->rel_pf_id)
  29
  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)))
  33
  34 struct ecore_mcp_info {
  35         /* List for mailbox commands which were sent and wait for a response */
  36         osal_list_t cmd_list;
  37
  38         /* Spinlock used for protecting the access to the mailbox commands list
  39          * and the sending of the commands.
  40          */
  41         osal_spinlock_t cmd_lock;
  42
  43         /* Spinlock used for syncing SW link-changes and link-changes
  44          * originating from attention context.
  45          */
  46         osal_spinlock_t link_lock;
  47
  48         /* Address of the MCP public area */
  49         u32 public_base;
  50         /* Address of the driver mailbox */
  51         u32 drv_mb_addr;
  52         /* Address of the MFW mailbox */
  53         u32 mfw_mb_addr;
  54         /* Address of the port configuration (link) */
  55         u32 port_addr;
  56
  57         /* Current driver mailbox sequence */
  58         u16 drv_mb_seq;
  59         /* Current driver pulse sequence */
  60         u16 drv_pulse_seq;
  61
  62         struct ecore_mcp_link_params       link_input;
  63         struct ecore_mcp_link_state        link_output;
  64         struct ecore_mcp_link_capabilities link_capabilities;
  65
  66         struct ecore_mcp_function_info     func_info;
  67
  68         u8 *mfw_mb_cur;
  69         u8 *mfw_mb_shadow;
  70         u16 mfw_mb_length;
  71         u32 mcp_hist;
  72
  73         /* Capabilties negotiated with the MFW */
  74         u32 capabilities;
  75 };
  76
  77 struct ecore_mcp_mb_params {
  78         u32 cmd;
  79         u32 param;
  80         void *p_data_src;
  81         u8 data_src_size;
  82         void *p_data_dst;
  83         u8 data_dst_size;
  84         u32 mcp_resp;
  85         u32 mcp_param;
  86 };
  87
  88 struct ecore_drv_tlv_hdr {
  89         u8 tlv_type;    /* According to the enum below */
  90         u8 tlv_length;  /* In dwords - not including this header */
  91         u8 tlv_reserved;
  92 #define ECORE_DRV_TLV_FLAGS_CHANGED 0x01
  93         u8 tlv_flags;
  94 };
  95
  96 /**
  97  * @brief Initialize the interface with the MCP
  98  *
  99  * @param p_hwfn - HW func
 100  * @param p_ptt - PTT required for register access
 101  *
 102  * @return enum _ecore_status_t
 103  */
 104 enum _ecore_status_t ecore_mcp_cmd_init(struct ecore_hwfn *p_hwfn,
 105                                         struct ecore_ptt *p_ptt);
 106
 107 /**
 108  * @brief Initialize the port interface with the MCP
 109  *
 110  * @param p_hwfn
 111  * @param p_ptt
 112  * Can only be called after `num_ports_in_engines' is set
 113  */
 114 void ecore_mcp_cmd_port_init(struct ecore_hwfn *p_hwfn,
 115                              struct ecore_ptt *p_ptt);
 116 /**
 117  * @brief Releases resources allocated during the init process.
 118  *
 119  * @param p_hwfn - HW func
 120  * @param p_ptt - PTT required for register access
 121  *
 122  * @return enum _ecore_status_t
 123  */
 124
 125 enum _ecore_status_t ecore_mcp_free(struct ecore_hwfn *p_hwfn);
 126
 127 /**
 128  * @brief This function is called from the DPC context. After
 129  * pointing PTT to the mfw mb, check for events sent by the MCP
 130  * to the driver and ack them. In case a critical event
 131  * detected, it will be handled here, otherwise the work will be
 132  * queued to a sleepable work-queue.
 133  *
 134  * @param p_hwfn - HW function
 135  * @param p_ptt - PTT required for register access
 136  * @return enum _ecore_status_t - ECORE_SUCCESS - operation
 137  * was successul.
 138  */
 139 enum _ecore_status_t ecore_mcp_handle_events(struct ecore_hwfn *p_hwfn,
 140                                              struct ecore_ptt *p_ptt);
 141
 142 /**
 143  * @brief When MFW doesn't get driver pulse for couple of seconds, at some
 144  * threshold before timeout expires, it will generate interrupt
 145  * through a dedicated status block (DPSB - Driver Pulse Status
 146  * Block), which the driver should respond immediately, by
 147  * providing keepalive indication after setting the PTT to the
 148  * driver-MFW mailbox. This function is called directly from the
 149  * DPC upon receiving the DPSB attention.
 150  *
 151  * @param p_hwfn - hw function
 152  * @param p_ptt - PTT required for register access
 153  * @return enum _ecore_status_t - ECORE_SUCCESS - operation
 154  * was successful.
 155  */
 156 enum _ecore_status_t ecore_issue_pulse(struct ecore_hwfn *p_hwfn,
 157                                        struct ecore_ptt *p_ptt);
 158
 159 enum ecore_drv_role {
 160         ECORE_DRV_ROLE_OS,
 161         ECORE_DRV_ROLE_KDUMP,
 162 };
 163
 164 struct ecore_load_req_params {
 165         /* Input params */
 166         enum ecore_drv_role drv_role;
 167         u8 timeout_val; /* 1..254, '0' - default value, '255' - no timeout */
 168         bool avoid_eng_reset;
 169         enum ecore_override_force_load override_force_load;
 170
 171         /* Output params */
 172         u32 load_code;
 173 };
 174
 175 /**
 176  * @brief Sends a LOAD_REQ to the MFW, and in case the operation succeeds,
 177  *        returns whether this PF is the first on the engine/port or function.
 178  *
 179  * @param p_hwfn
 180  * @param p_ptt
 181  * @param p_params
 182  *
 183  * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful.
 184  */
 185 enum _ecore_status_t ecore_mcp_load_req(struct ecore_hwfn *p_hwfn,
 186                                         struct ecore_ptt *p_ptt,
 187                                         struct ecore_load_req_params *p_params);
 188
 189 /**
 190  * @brief Sends a LOAD_DONE message to the MFW
 191  *
 192  * @param p_hwfn
 193  * @param p_ptt
 194  *
 195  * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful.
 196  */
 197 enum _ecore_status_t ecore_mcp_load_done(struct ecore_hwfn *p_hwfn,
 198                                          struct ecore_ptt *p_ptt);
 199
 200 /**
 201  * @brief Sends a UNLOAD_REQ message to the MFW
 202  *
 203  * @param p_hwfn
 204  * @param p_ptt
 205  *
 206  * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful.
 207  */
 208 enum _ecore_status_t ecore_mcp_unload_req(struct ecore_hwfn *p_hwfn,
 209                                           struct ecore_ptt *p_ptt);
 210
 211 /**
 212  * @brief Sends a UNLOAD_DONE message to the MFW
 213  *
 214  * @param p_hwfn
 215  * @param p_ptt
 216  *
 217  * @return enum _ecore_status_t - ECORE_SUCCESS - Operation was successful.
 218  */
 219 enum _ecore_status_t ecore_mcp_unload_done(struct ecore_hwfn *p_hwfn,
 220                                            struct ecore_ptt *p_ptt);
 221
 222 /**
 223  * @brief Read the MFW mailbox into Current buffer.
 224  *
 225  * @param p_hwfn
 226  * @param p_ptt
 227  */
 228 void ecore_mcp_read_mb(struct ecore_hwfn *p_hwfn,
 229                        struct ecore_ptt *p_ptt);
 230
 231 /**
 232  * @brief Ack to mfw that driver finished FLR process for VFs
 233  *
 234  * @param p_hwfn
 235  * @param p_ptt
 236  * @param vfs_to_ack - bit mask of all engine VFs for which the PF acks.
 237  *
 238  * @param return enum _ecore_status_t - ECORE_SUCCESS upon success.
 239  */
 240 enum _ecore_status_t ecore_mcp_ack_vf_flr(struct ecore_hwfn *p_hwfn,
 241                                           struct ecore_ptt *p_ptt,
 242                                           u32 *vfs_to_ack);
 243
 244 /**
 245  * @brief - calls during init to read shmem of all function-related info.
 246  *
 247  * @param p_hwfn
 248  *
 249  * @param return ECORE_SUCCESS upon success.
 250  */
 251 enum _ecore_status_t ecore_mcp_fill_shmem_func_info(struct ecore_hwfn *p_hwfn,
 252                                                     struct ecore_ptt *p_ptt);
 253
 254 /**
 255  * @brief - Reset the MCP using mailbox command.
 256  *
 257  * @param p_hwfn
 258  * @param p_ptt
 259  *
 260  * @param return ECORE_SUCCESS upon success.
 261  */
 262 enum _ecore_status_t ecore_mcp_reset(struct ecore_hwfn *p_hwfn,
 263                                      struct ecore_ptt *p_ptt);
 264
 265 /**
 266  * @brief - Sends an NVM write command request to the MFW with
 267  *          payload.
 268  *
 269  * @param p_hwfn
 270  * @param p_ptt
 271  * @param cmd - Command: Either DRV_MSG_CODE_NVM_WRITE_NVRAM or
 272  *            DRV_MSG_CODE_NVM_PUT_FILE_DATA
 273  * @param param - [0:23] - Offset [24:31] - Size
 274  * @param o_mcp_resp - MCP response
 275  * @param o_mcp_param - MCP response param
 276  * @param i_txn_size -  Buffer size
 277  * @param i_buf - Pointer to the buffer
 278  *
 279  * @param return ECORE_SUCCESS upon success.
 280  */
 281 enum _ecore_status_t ecore_mcp_nvm_wr_cmd(struct ecore_hwfn *p_hwfn,
 282                                           struct ecore_ptt *p_ptt,
 283                                           u32 cmd,
 284                                           u32 param,
 285                                           u32 *o_mcp_resp,
 286                                           u32 *o_mcp_param,
 287                                           u32 i_txn_size,
 288                                           u32 *i_buf);
 289
 290 /**
 291  * @brief - Sends an NVM read command request to the MFW to get
 292  *        a buffer.
 293  *
 294  * @param p_hwfn
 295  * @param p_ptt
 296  * @param cmd - Command: DRV_MSG_CODE_NVM_GET_FILE_DATA or
 297  *            DRV_MSG_CODE_NVM_READ_NVRAM commands
 298  * @param param - [0:23] - Offset [24:31] - Size
 299  * @param o_mcp_resp - MCP response
 300  * @param o_mcp_param - MCP response param
 301  * @param o_txn_size -  Buffer size output
 302  * @param o_buf - Pointer to the buffer returned by the MFW.
 303  *
 304  * @param return ECORE_SUCCESS upon success.
 305  */
 306 enum _ecore_status_t ecore_mcp_nvm_rd_cmd(struct ecore_hwfn *p_hwfn,
 307                                           struct ecore_ptt *p_ptt,
 308                                           u32 cmd,
 309                                           u32 param,
 310                                           u32 *o_mcp_resp,
 311                                           u32 *o_mcp_param,
 312                                           u32 *o_txn_size,
 313                                           u32 *o_buf);
 314
 315 /**
 316  * @brief indicates whether the MFW objects [under mcp_info] are accessible
 317  *
 318  * @param p_hwfn
 319  *
 320  * @return true iff MFW is running and mcp_info is initialized
 321  */
 322 bool ecore_mcp_is_init(struct ecore_hwfn *p_hwfn);
 323
 324 /**
 325  * @brief request MFW to configure MSI-X for a VF
 326  *
 327  * @param p_hwfn
 328  * @param p_ptt
 329  * @param vf_id - absolute inside engine
 330  * @param num_sbs - number of entries to request
 331  *
 332  * @return enum _ecore_status_t
 333  */
 334 enum _ecore_status_t ecore_mcp_config_vf_msix(struct ecore_hwfn *p_hwfn,
 335                                               struct ecore_ptt *p_ptt,
 336                                               u8 vf_id, u8 num);
 337
 338 /**
 339  * @brief - Halt the MCP.
 340  *
 341  * @param p_hwfn
 342  * @param p_ptt
 343  *
 344  * @param return ECORE_SUCCESS upon success.
 345  */
 346 enum _ecore_status_t ecore_mcp_halt(struct ecore_hwfn *p_hwfn,
 347                                     struct ecore_ptt *p_ptt);
 348
 349 /**
 350  * @brief - Wake up the MCP.
 351  *
 352  * @param p_hwfn
 353  * @param p_ptt
 354  *
 355  * @param return ECORE_SUCCESS upon success.
 356  */
 357 enum _ecore_status_t ecore_mcp_resume(struct ecore_hwfn *p_hwfn,
 358                                       struct ecore_ptt *p_ptt);
 359 int __ecore_configure_pf_max_bandwidth(struct ecore_hwfn *p_hwfn,
 360                                        struct ecore_ptt *p_ptt,
 361                                        struct ecore_mcp_link_state *p_link,
 362                                        u8 max_bw);
 363 int __ecore_configure_pf_min_bandwidth(struct ecore_hwfn *p_hwfn,
 364                                        struct ecore_ptt *p_ptt,
 365                                        struct ecore_mcp_link_state *p_link,
 366                                        u8 min_bw);
 367 enum _ecore_status_t ecore_mcp_mask_parities(struct ecore_hwfn *p_hwfn,
 368                                              struct ecore_ptt *p_ptt,
 369                                              u32 mask_parities);
 370 /**
 371  * @brief - Sends crash mdump related info to the MFW.
 372  *
 373  * @param p_hwfn
 374  * @param p_ptt
 375  *
 376  * @param return ECORE_SUCCESS upon success.
 377  */
 378 enum _ecore_status_t ecore_mcp_mdump_set_values(struct ecore_hwfn *p_hwfn,
 379                                                 struct ecore_ptt *p_ptt,
 380                                                 u32 epoch);
 381
 382 /**
 383  * @brief - Triggers a MFW crash dump procedure.
 384  *
 385  * @param p_hwfn
 386  * @param p_ptt
 387  * @param epoch
 388  *
 389  * @param return ECORE_SUCCESS upon success.
 390  */
 391 enum _ecore_status_t ecore_mcp_mdump_trigger(struct ecore_hwfn *p_hwfn,
 392                                              struct ecore_ptt *p_ptt);
 393
 394 struct ecore_mdump_retain_data {
 395         u32 valid;
 396         u32 epoch;
 397         u32 pf;
 398         u32 status;
 399 };
 400
 401 /**
 402  * @brief - Gets the mdump retained data from the MFW.
 403  *
 404  * @param p_hwfn
 405  * @param p_ptt
 406  * @param p_mdump_retain
 407  *
 408  * @param return ECORE_SUCCESS upon success.
 409  */
 410 enum _ecore_status_t
 411 ecore_mcp_mdump_get_retain(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
 412                            struct ecore_mdump_retain_data *p_mdump_retain);
 413
 414 /**
 415  * @brief - Sets the MFW's max value for the given resource
 416  *
 417  *  @param p_hwfn
 418  *  @param p_ptt
 419  *  @param res_id
 420  *  @param resc_max_val
 421  *  @param p_mcp_resp
 422  *
 423  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 424  */
 425 enum _ecore_status_t
 426 ecore_mcp_set_resc_max_val(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
 427                            enum ecore_resources res_id, u32 resc_max_val,
 428                            u32 *p_mcp_resp);
 429
 430 /**
 431  * @brief - Gets the MFW allocation info for the given resource
 432  *
 433  *  @param p_hwfn
 434  *  @param p_ptt
 435  *  @param res_id
 436  *  @param p_mcp_resp
 437  *  @param p_resc_num
 438  *  @param p_resc_start
 439  *
 440  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 441  */
 442 enum _ecore_status_t
 443 ecore_mcp_get_resc_info(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
 444                         enum ecore_resources res_id, u32 *p_mcp_resp,
 445                         u32 *p_resc_num, u32 *p_resc_start);
 446
 447 /**
 448  * @brief - Initiates PF FLR
 449  *
 450  * @param p_hwfn
 451  * @param p_ptt
 452  *
 453  * @param return ECORE_SUCCESS upon success.
 454  */
 455 enum _ecore_status_t ecore_mcp_initiate_pf_flr(struct ecore_hwfn *p_hwfn,
 456                                                struct ecore_ptt *p_ptt);
 457
 458 #define ECORE_MCP_RESC_LOCK_MIN_VAL     RESOURCE_DUMP /* 0 */
 459 #define ECORE_MCP_RESC_LOCK_MAX_VAL     31
 460
 461 enum ecore_resc_lock {
 462         ECORE_RESC_LOCK_DBG_DUMP = ECORE_MCP_RESC_LOCK_MIN_VAL,
 463         /* Locks that the MFW is aware of should be added here downwards */
 464
 465         /* Ecore only locks should be added here upwards */
 466         ECORE_RESC_LOCK_RESC_ALLOC = ECORE_MCP_RESC_LOCK_MAX_VAL
 467 };
 468
 469 struct ecore_resc_lock_params {
 470         /* Resource number [valid values are 0..31] */
 471         u8 resource;
 472
 473         /* Lock timeout value in seconds [default, none or 1..254] */
 474         u8 timeout;
 475 #define ECORE_MCP_RESC_LOCK_TO_DEFAULT  0
 476 #define ECORE_MCP_RESC_LOCK_TO_NONE     255
 477
 478         /* Number of times to retry locking */
 479         u8 retry_num;
 480
 481         /* The interval in usec between retries */
 482         u16 retry_interval;
 483
 484         /* Use sleep or delay between retries */
 485         bool sleep_b4_retry;
 486
 487         /* Will be set as true if the resource is free and granted */
 488         bool b_granted;
 489
 490         /* Will be filled with the resource owner.
 491          * [0..15 = PF0-15, 16 = MFW, 17 = diag over serial]
 492          */
 493         u8 owner;
 494 };
 495
 496 /**
 497  * @brief Acquires MFW generic resource lock
 498  *
 499  *  @param p_hwfn
 500  *  @param p_ptt
 501  *  @param p_params
 502  *
 503  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 504  */
 505 enum _ecore_status_t
 506 ecore_mcp_resc_lock(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
 507                     struct ecore_resc_lock_params *p_params);
 508
 509 struct ecore_resc_unlock_params {
 510         /* Resource number [valid values are 0..31] */
 511         u8 resource;
 512
 513         /* Allow to release a resource even if belongs to another PF */
 514         bool b_force;
 515
 516         /* Will be set as true if the resource is released */
 517         bool b_released;
 518 };
 519
 520 /**
 521  * @brief Releases MFW generic resource lock
 522  *
 523  *  @param p_hwfn
 524  *  @param p_ptt
 525  *  @param p_params
 526  *
 527  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 528  */
 529 enum _ecore_status_t
 530 ecore_mcp_resc_unlock(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
 531                       struct ecore_resc_unlock_params *p_params);
 532
 533 /**
 534  * @brief Learn of supported MFW features; To be done during early init
 535  *
 536  * @param p_hwfn
 537  * @param p_ptt
 538  */
 539 enum _ecore_status_t ecore_mcp_get_capabilities(struct ecore_hwfn *p_hwfn,
 540                                                 struct ecore_ptt *p_ptt);
 541
 542 /**
 543  * @brief Inform MFW of set of features supported by driver. Should be done
 544  * inside the contet of the LOAD_REQ.
 545  *
 546  * @param p_hwfn
 547  * @param p_ptt
 548  */
 549 enum _ecore_status_t ecore_mcp_set_capabilities(struct ecore_hwfn *p_hwfn,
 550                                                 struct ecore_ptt *p_ptt);
 551
 552 #endif /* __ECORE_MCP_H__ */