drivers/net/ethernet/qlogic/qed/qed_mcp.h

   1 /* QLogic qed NIC Driver
   2  * Copyright (c) 2015-2017  QLogic Corporation
   3  *
   4  * This software is available to you under a choice of one of two
   5  * licenses.  You may choose to be licensed under the terms of the GNU
   6  * General Public License (GPL) Version 2, available from the file
   7  * COPYING in the main directory of this source tree, or the
   8  * OpenIB.org BSD license below:
   9  *
  10  *     Redistribution and use in source and binary forms, with or
  11  *     without modification, are permitted provided that the following
  12  *     conditions are met:
  13  *
  14  *      - Redistributions of source code must retain the above
  15  *        copyright notice, this list of conditions and the following
  16  *        disclaimer.
  17  *
  18  *      - Redistributions in binary form must reproduce the above
  19  *        copyright notice, this list of conditions and the following
  20  *        disclaimer in the documentation and /or other materials
  21  *        provided with the distribution.
  22  *
  23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30  * SOFTWARE.
  31  */
  32
  33 #ifndef _QED_MCP_H
  34 #define _QED_MCP_H
  35
  36 #include <linux/types.h>
  37 #include <linux/delay.h>
  38 #include <linux/slab.h>
  39 #include <linux/spinlock.h>
  40 #include <linux/qed/qed_fcoe_if.h>
  41 #include "qed_hsi.h"
  42 #include "qed_dev_api.h"
  43
  44 struct qed_mcp_link_speed_params {
  45         bool    autoneg;
  46         u32     advertised_speeds;      /* bitmask of DRV_SPEED_CAPABILITY */
  47         u32     forced_speed;      /* In Mb/s */
  48 };
  49
  50 struct qed_mcp_link_pause_params {
  51         bool    autoneg;
  52         bool    forced_rx;
  53         bool    forced_tx;
  54 };
  55
  56 enum qed_mcp_eee_mode {
  57         QED_MCP_EEE_DISABLED,
  58         QED_MCP_EEE_ENABLED,
  59         QED_MCP_EEE_UNSUPPORTED
  60 };
  61
  62 struct qed_mcp_link_params {
  63         struct qed_mcp_link_speed_params speed;
  64         struct qed_mcp_link_pause_params pause;
  65         u32 loopback_mode;
  66         struct qed_link_eee_params eee;
  67 };
  68
  69 struct qed_mcp_link_capabilities {
  70         u32 speed_capabilities;
  71         bool default_speed_autoneg;
  72         enum qed_mcp_eee_mode default_eee;
  73         u32 eee_lpi_timer;
  74         u8 eee_speed_caps;
  75 };
  76
  77 struct qed_mcp_link_state {
  78         bool    link_up;
  79
  80         u32     min_pf_rate;
  81
  82         /* Actual link speed in Mb/s */
  83         u32     line_speed;
  84
  85         /* PF max speed in Mb/s, deduced from line_speed
  86          * according to PF max bandwidth configuration.
  87          */
  88         u32     speed;
  89         bool    full_duplex;
  90
  91         bool    an;
  92         bool    an_complete;
  93         bool    parallel_detection;
  94         bool    pfc_enabled;
  95
  96 #define QED_LINK_PARTNER_SPEED_1G_HD    BIT(0)
  97 #define QED_LINK_PARTNER_SPEED_1G_FD    BIT(1)
  98 #define QED_LINK_PARTNER_SPEED_10G      BIT(2)
  99 #define QED_LINK_PARTNER_SPEED_20G      BIT(3)
 100 #define QED_LINK_PARTNER_SPEED_25G      BIT(4)
 101 #define QED_LINK_PARTNER_SPEED_40G      BIT(5)
 102 #define QED_LINK_PARTNER_SPEED_50G      BIT(6)
 103 #define QED_LINK_PARTNER_SPEED_100G     BIT(7)
 104         u32     partner_adv_speed;
 105
 106         bool    partner_tx_flow_ctrl_en;
 107         bool    partner_rx_flow_ctrl_en;
 108
 109 #define QED_LINK_PARTNER_SYMMETRIC_PAUSE (1)
 110 #define QED_LINK_PARTNER_ASYMMETRIC_PAUSE (2)
 111 #define QED_LINK_PARTNER_BOTH_PAUSE (3)
 112         u8      partner_adv_pause;
 113
 114         bool    sfp_tx_fault;
 115         bool    eee_active;
 116         u8      eee_adv_caps;
 117         u8      eee_lp_adv_caps;
 118 };
 119
 120 struct qed_mcp_function_info {
 121         u8                              pause_on_host;
 122
 123         enum qed_pci_personality        protocol;
 124
 125         u8                              bandwidth_min;
 126         u8                              bandwidth_max;
 127
 128         u8                              mac[ETH_ALEN];
 129
 130         u64                             wwn_port;
 131         u64                             wwn_node;
 132
 133 #define QED_MCP_VLAN_UNSET              (0xffff)
 134         u16                             ovlan;
 135
 136         u16                             mtu;
 137 };
 138
 139 struct qed_mcp_nvm_common {
 140         u32     offset;
 141         u32     param;
 142         u32     resp;
 143         u32     cmd;
 144 };
 145
 146 struct qed_mcp_drv_version {
 147         u32     version;
 148         u8      name[MCP_DRV_VER_STR_SIZE - 4];
 149 };
 150
 151 struct qed_mcp_lan_stats {
 152         u64 ucast_rx_pkts;
 153         u64 ucast_tx_pkts;
 154         u32 fcs_err;
 155 };
 156
 157 struct qed_mcp_fcoe_stats {
 158         u64 rx_pkts;
 159         u64 tx_pkts;
 160         u32 fcs_err;
 161         u32 login_failure;
 162 };
 163
 164 struct qed_mcp_iscsi_stats {
 165         u64 rx_pdus;
 166         u64 tx_pdus;
 167         u64 rx_bytes;
 168         u64 tx_bytes;
 169 };
 170
 171 struct qed_mcp_rdma_stats {
 172         u64 rx_pkts;
 173         u64 tx_pkts;
 174         u64 rx_bytes;
 175         u64 tx_byts;
 176 };
 177
 178 enum qed_mcp_protocol_type {
 179         QED_MCP_LAN_STATS,
 180         QED_MCP_FCOE_STATS,
 181         QED_MCP_ISCSI_STATS,
 182         QED_MCP_RDMA_STATS
 183 };
 184
 185 union qed_mcp_protocol_stats {
 186         struct qed_mcp_lan_stats lan_stats;
 187         struct qed_mcp_fcoe_stats fcoe_stats;
 188         struct qed_mcp_iscsi_stats iscsi_stats;
 189         struct qed_mcp_rdma_stats rdma_stats;
 190 };
 191
 192 enum qed_ov_eswitch {
 193         QED_OV_ESWITCH_NONE,
 194         QED_OV_ESWITCH_VEB,
 195         QED_OV_ESWITCH_VEPA
 196 };
 197
 198 enum qed_ov_client {
 199         QED_OV_CLIENT_DRV,
 200         QED_OV_CLIENT_USER,
 201         QED_OV_CLIENT_VENDOR_SPEC
 202 };
 203
 204 enum qed_ov_driver_state {
 205         QED_OV_DRIVER_STATE_NOT_LOADED,
 206         QED_OV_DRIVER_STATE_DISABLED,
 207         QED_OV_DRIVER_STATE_ACTIVE
 208 };
 209
 210 enum qed_ov_wol {
 211         QED_OV_WOL_DEFAULT,
 212         QED_OV_WOL_DISABLED,
 213         QED_OV_WOL_ENABLED
 214 };
 215
 216 enum qed_mfw_tlv_type {
 217         QED_MFW_TLV_GENERIC = 0x1,      /* Core driver TLVs */
 218         QED_MFW_TLV_ETH = 0x2,          /* L2 driver TLVs */
 219         QED_MFW_TLV_FCOE = 0x4,         /* FCoE protocol TLVs */
 220         QED_MFW_TLV_ISCSI = 0x8,        /* SCSI protocol TLVs */
 221         QED_MFW_TLV_MAX = 0x16,
 222 };
 223
 224 struct qed_mfw_tlv_generic {
 225 #define QED_MFW_TLV_FLAGS_SIZE  2
 226         struct {
 227                 u8 ipv4_csum_offload;
 228                 u8 lso_supported;
 229                 bool b_set;
 230         } flags;
 231
 232 #define QED_MFW_TLV_MAC_COUNT 3
 233         /* First entry for primary MAC, 2 secondary MACs possible */
 234         u8 mac[QED_MFW_TLV_MAC_COUNT][6];
 235         bool mac_set[QED_MFW_TLV_MAC_COUNT];
 236
 237         u64 rx_frames;
 238         bool rx_frames_set;
 239         u64 rx_bytes;
 240         bool rx_bytes_set;
 241         u64 tx_frames;
 242         bool tx_frames_set;
 243         u64 tx_bytes;
 244         bool tx_bytes_set;
 245 };
 246
 247 union qed_mfw_tlv_data {
 248         struct qed_mfw_tlv_generic generic;
 249         struct qed_mfw_tlv_eth eth;
 250         struct qed_mfw_tlv_fcoe fcoe;
 251         struct qed_mfw_tlv_iscsi iscsi;
 252 };
 253
 254 /**
 255  * @brief - returns the link params of the hw function
 256  *
 257  * @param p_hwfn
 258  *
 259  * @returns pointer to link params
 260  */
 261 struct qed_mcp_link_params *qed_mcp_get_link_params(struct qed_hwfn *);
 262
 263 /**
 264  * @brief - return the link state of the hw function
 265  *
 266  * @param p_hwfn
 267  *
 268  * @returns pointer to link state
 269  */
 270 struct qed_mcp_link_state *qed_mcp_get_link_state(struct qed_hwfn *);
 271
 272 /**
 273  * @brief - return the link capabilities of the hw function
 274  *
 275  * @param p_hwfn
 276  *
 277  * @returns pointer to link capabilities
 278  */
 279 struct qed_mcp_link_capabilities
 280         *qed_mcp_get_link_capabilities(struct qed_hwfn *p_hwfn);
 281
 282 /**
 283  * @brief Request the MFW to set the the link according to 'link_input'.
 284  *
 285  * @param p_hwfn
 286  * @param p_ptt
 287  * @param b_up - raise link if `true'. Reset link if `false'.
 288  *
 289  * @return int
 290  */
 291 int qed_mcp_set_link(struct qed_hwfn   *p_hwfn,
 292                      struct qed_ptt     *p_ptt,
 293                      bool               b_up);
 294
 295 /**
 296  * @brief Get the management firmware version value
 297  *
 298  * @param p_hwfn
 299  * @param p_ptt
 300  * @param p_mfw_ver    - mfw version value
 301  * @param p_running_bundle_id   - image id in nvram; Optional.
 302  *
 303  * @return int - 0 - operation was successful.
 304  */
 305 int qed_mcp_get_mfw_ver(struct qed_hwfn *p_hwfn,
 306                         struct qed_ptt *p_ptt,
 307                         u32 *p_mfw_ver, u32 *p_running_bundle_id);
 308
 309 /**
 310  * @brief Get the MBI version value
 311  *
 312  * @param p_hwfn
 313  * @param p_ptt
 314  * @param p_mbi_ver - A pointer to a variable to be filled with the MBI version.
 315  *
 316  * @return int - 0 - operation was successful.
 317  */
 318 int qed_mcp_get_mbi_ver(struct qed_hwfn *p_hwfn,
 319                         struct qed_ptt *p_ptt, u32 *p_mbi_ver);
 320
 321 /**
 322  * @brief Get media type value of the port.
 323  *
 324  * @param cdev      - qed dev pointer
 325  * @param p_ptt
 326  * @param mfw_ver    - media type value
 327  *
 328  * @return int -
 329  *      0 - Operation was successul.
 330  *      -EBUSY - Operation failed
 331  */
 332 int qed_mcp_get_media_type(struct qed_hwfn *p_hwfn,
 333                            struct qed_ptt *p_ptt, u32 *media_type);
 334
 335 /**
 336  * @brief General function for sending commands to the MCP
 337  *        mailbox. It acquire mutex lock for the entire
 338  *        operation, from sending the request until the MCP
 339  *        response. Waiting for MCP response will be checked up
 340  *        to 5 seconds every 5ms.
 341  *
 342  * @param p_hwfn     - hw function
 343  * @param p_ptt      - PTT required for register access
 344  * @param cmd        - command to be sent to the MCP.
 345  * @param param      - Optional param
 346  * @param o_mcp_resp - The MCP response code (exclude sequence).
 347  * @param o_mcp_param- Optional parameter provided by the MCP
 348  *                     response
 349  * @return int - 0 - operation
 350  * was successul.
 351  */
 352 int qed_mcp_cmd(struct qed_hwfn *p_hwfn,
 353                 struct qed_ptt *p_ptt,
 354                 u32 cmd,
 355                 u32 param,
 356                 u32 *o_mcp_resp,
 357                 u32 *o_mcp_param);
 358
 359 /**
 360  * @brief - drains the nig, allowing completion to pass in case of pauses.
 361  *          (Should be called only from sleepable context)
 362  *
 363  * @param p_hwfn
 364  * @param p_ptt
 365  */
 366 int qed_mcp_drain(struct qed_hwfn *p_hwfn,
 367                   struct qed_ptt *p_ptt);
 368
 369 /**
 370  * @brief Get the flash size value
 371  *
 372  * @param p_hwfn
 373  * @param p_ptt
 374  * @param p_flash_size  - flash size in bytes to be filled.
 375  *
 376  * @return int - 0 - operation was successul.
 377  */
 378 int qed_mcp_get_flash_size(struct qed_hwfn     *p_hwfn,
 379                            struct qed_ptt       *p_ptt,
 380                            u32 *p_flash_size);
 381
 382 /**
 383  * @brief Send driver version to MFW
 384  *
 385  * @param p_hwfn
 386  * @param p_ptt
 387  * @param version - Version value
 388  * @param name - Protocol driver name
 389  *
 390  * @return int - 0 - operation was successul.
 391  */
 392 int
 393 qed_mcp_send_drv_version(struct qed_hwfn *p_hwfn,
 394                          struct qed_ptt *p_ptt,
 395                          struct qed_mcp_drv_version *p_ver);
 396
 397 /**
 398  * @brief Notify MFW about the change in base device properties
 399  *
 400  *  @param p_hwfn
 401  *  @param p_ptt
 402  *  @param client - qed client type
 403  *
 404  * @return int - 0 - operation was successful.
 405  */
 406 int qed_mcp_ov_update_current_config(struct qed_hwfn *p_hwfn,
 407                                      struct qed_ptt *p_ptt,
 408                                      enum qed_ov_client client);
 409
 410 /**
 411  * @brief Notify MFW about the driver state
 412  *
 413  *  @param p_hwfn
 414  *  @param p_ptt
 415  *  @param drv_state - Driver state
 416  *
 417  * @return int - 0 - operation was successful.
 418  */
 419 int qed_mcp_ov_update_driver_state(struct qed_hwfn *p_hwfn,
 420                                    struct qed_ptt *p_ptt,
 421                                    enum qed_ov_driver_state drv_state);
 422
 423 /**
 424  * @brief Send MTU size to MFW
 425  *
 426  *  @param p_hwfn
 427  *  @param p_ptt
 428  *  @param mtu - MTU size
 429  *
 430  * @return int - 0 - operation was successful.
 431  */
 432 int qed_mcp_ov_update_mtu(struct qed_hwfn *p_hwfn,
 433                           struct qed_ptt *p_ptt, u16 mtu);
 434
 435 /**
 436  * @brief Send MAC address to MFW
 437  *
 438  *  @param p_hwfn
 439  *  @param p_ptt
 440  *  @param mac - MAC address
 441  *
 442  * @return int - 0 - operation was successful.
 443  */
 444 int qed_mcp_ov_update_mac(struct qed_hwfn *p_hwfn,
 445                           struct qed_ptt *p_ptt, u8 *mac);
 446
 447 /**
 448  * @brief Send WOL mode to MFW
 449  *
 450  *  @param p_hwfn
 451  *  @param p_ptt
 452  *  @param wol - WOL mode
 453  *
 454  * @return int - 0 - operation was successful.
 455  */
 456 int qed_mcp_ov_update_wol(struct qed_hwfn *p_hwfn,
 457                           struct qed_ptt *p_ptt,
 458                           enum qed_ov_wol wol);
 459
 460 /**
 461  * @brief Set LED status
 462  *
 463  *  @param p_hwfn
 464  *  @param p_ptt
 465  *  @param mode - LED mode
 466  *
 467  * @return int - 0 - operation was successful.
 468  */
 469 int qed_mcp_set_led(struct qed_hwfn *p_hwfn,
 470                     struct qed_ptt *p_ptt,
 471                     enum qed_led_mode mode);
 472
 473 /**
 474  * @brief Read from nvm
 475  *
 476  *  @param cdev
 477  *  @param addr - nvm offset
 478  *  @param p_buf - nvm read buffer
 479  *  @param len - buffer len
 480  *
 481  * @return int - 0 - operation was successful.
 482  */
 483 int qed_mcp_nvm_read(struct qed_dev *cdev, u32 addr, u8 *p_buf, u32 len);
 484
 485 /**
 486  * @brief Write to nvm
 487  *
 488  *  @param cdev
 489  *  @param addr - nvm offset
 490  *  @param cmd - nvm command
 491  *  @param p_buf - nvm write buffer
 492  *  @param len - buffer len
 493  *
 494  * @return int - 0 - operation was successful.
 495  */
 496 int qed_mcp_nvm_write(struct qed_dev *cdev,
 497                       u32 cmd, u32 addr, u8 *p_buf, u32 len);
 498
 499 /**
 500  * @brief Put file begin
 501  *
 502  *  @param cdev
 503  *  @param addr - nvm offset
 504  *
 505  * @return int - 0 - operation was successful.
 506  */
 507 int qed_mcp_nvm_put_file_begin(struct qed_dev *cdev, u32 addr);
 508
 509 /**
 510  * @brief Check latest response
 511  *
 512  *  @param cdev
 513  *  @param p_buf - nvm write buffer
 514  *
 515  * @return int - 0 - operation was successful.
 516  */
 517 int qed_mcp_nvm_resp(struct qed_dev *cdev, u8 *p_buf);
 518
 519 struct qed_nvm_image_att {
 520         u32 start_addr;
 521         u32 length;
 522 };
 523
 524 /**
 525  * @brief Allows reading a whole nvram image
 526  *
 527  * @param p_hwfn
 528  * @param image_id - image to get attributes for
 529  * @param p_image_att - image attributes structure into which to fill data
 530  *
 531  * @return int - 0 - operation was successful.
 532  */
 533 int
 534 qed_mcp_get_nvm_image_att(struct qed_hwfn *p_hwfn,
 535                           enum qed_nvm_images image_id,
 536                           struct qed_nvm_image_att *p_image_att);
 537
 538 /**
 539  * @brief Allows reading a whole nvram image
 540  *
 541  * @param p_hwfn
 542  * @param image_id - image requested for reading
 543  * @param p_buffer - allocated buffer into which to fill data
 544  * @param buffer_len - length of the allocated buffer.
 545  *
 546  * @return 0 iff p_buffer now contains the nvram image.
 547  */
 548 int qed_mcp_get_nvm_image(struct qed_hwfn *p_hwfn,
 549                           enum qed_nvm_images image_id,
 550                           u8 *p_buffer, u32 buffer_len);
 551
 552 /**
 553  * @brief Bist register test
 554  *
 555  *  @param p_hwfn    - hw function
 556  *  @param p_ptt     - PTT required for register access
 557  *
 558  * @return int - 0 - operation was successful.
 559  */
 560 int qed_mcp_bist_register_test(struct qed_hwfn *p_hwfn,
 561                                struct qed_ptt *p_ptt);
 562
 563 /**
 564  * @brief Bist clock test
 565  *
 566  *  @param p_hwfn    - hw function
 567  *  @param p_ptt     - PTT required for register access
 568  *
 569  * @return int - 0 - operation was successful.
 570  */
 571 int qed_mcp_bist_clock_test(struct qed_hwfn *p_hwfn,
 572                             struct qed_ptt *p_ptt);
 573
 574 /**
 575  * @brief Bist nvm test - get number of images
 576  *
 577  *  @param p_hwfn       - hw function
 578  *  @param p_ptt        - PTT required for register access
 579  *  @param num_images   - number of images if operation was
 580  *                        successful. 0 if not.
 581  *
 582  * @return int - 0 - operation was successful.
 583  */
 584 int qed_mcp_bist_nvm_get_num_images(struct qed_hwfn *p_hwfn,
 585                                     struct qed_ptt *p_ptt,
 586                                     u32 *num_images);
 587
 588 /**
 589  * @brief Bist nvm test - get image attributes by index
 590  *
 591  *  @param p_hwfn      - hw function
 592  *  @param p_ptt       - PTT required for register access
 593  *  @param p_image_att - Attributes of image
 594  *  @param image_index - Index of image to get information for
 595  *
 596  * @return int - 0 - operation was successful.
 597  */
 598 int qed_mcp_bist_nvm_get_image_att(struct qed_hwfn *p_hwfn,
 599                                    struct qed_ptt *p_ptt,
 600                                    struct bist_nvm_image_att *p_image_att,
 601                                    u32 image_index);
 602
 603 /**
 604  * @brief - Processes the TLV request from MFW i.e., get the required TLV info
 605  *          from the qed client and send it to the MFW.
 606  *
 607  * @param p_hwfn
 608  * @param p_ptt
 609  *
 610  * @param return 0 upon success.
 611  */
 612 int qed_mfw_process_tlv_req(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
 613
 614 /* Using hwfn number (and not pf_num) is required since in CMT mode,
 615  * same pf_num may be used by two different hwfn
 616  * TODO - this shouldn't really be in .h file, but until all fields
 617  * required during hw-init will be placed in their correct place in shmem
 618  * we need it in qed_dev.c [for readin the nvram reflection in shmem].
 619  */
 620 #define MCP_PF_ID_BY_REL(p_hwfn, rel_pfid) (QED_IS_BB((p_hwfn)->cdev) ?        \
 621                                             ((rel_pfid) |                      \
 622                                              ((p_hwfn)->abs_pf_id & 1) << 3) : \
 623                                             rel_pfid)
 624 #define MCP_PF_ID(p_hwfn) MCP_PF_ID_BY_REL(p_hwfn, (p_hwfn)->rel_pf_id)
 625
 626 #define MFW_PORT(_p_hwfn)       ((_p_hwfn)->abs_pf_id %                   \
 627                                  ((_p_hwfn)->cdev->num_ports_in_engine * \
 628                                   qed_device_num_engines((_p_hwfn)->cdev)))
 629
 630 struct qed_mcp_info {
 631         /* List for mailbox commands which were sent and wait for a response */
 632         struct list_head                        cmd_list;
 633
 634         /* Spinlock used for protecting the access to the mailbox commands list
 635          * and the sending of the commands.
 636          */
 637         spinlock_t                              cmd_lock;
 638
 639         /* Flag to indicate whether sending a MFW mailbox command is blocked */
 640         bool                                    b_block_cmd;
 641
 642         /* Spinlock used for syncing SW link-changes and link-changes
 643          * originating from attention context.
 644          */
 645         spinlock_t                              link_lock;
 646
 647         u32                                     public_base;
 648         u32                                     drv_mb_addr;
 649         u32                                     mfw_mb_addr;
 650         u32                                     port_addr;
 651         u16                                     drv_mb_seq;
 652         u16                                     drv_pulse_seq;
 653         struct qed_mcp_link_params              link_input;
 654         struct qed_mcp_link_state               link_output;
 655         struct qed_mcp_link_capabilities        link_capabilities;
 656         struct qed_mcp_function_info            func_info;
 657         u8                                      *mfw_mb_cur;
 658         u8                                      *mfw_mb_shadow;
 659         u16                                     mfw_mb_length;
 660         u32                                     mcp_hist;
 661
 662         /* Capabilties negotiated with the MFW */
 663         u32                                     capabilities;
 664 };
 665
 666 struct qed_mcp_mb_params {
 667         u32 cmd;
 668         u32 param;
 669         void *p_data_src;
 670         void *p_data_dst;
 671         u8 data_src_size;
 672         u8 data_dst_size;
 673         u32 mcp_resp;
 674         u32 mcp_param;
 675         u32 flags;
 676 #define QED_MB_FLAG_CAN_SLEEP   (0x1 << 0)
 677 #define QED_MB_FLAG_AVOID_BLOCK (0x1 << 1)
 678 #define QED_MB_FLAGS_IS_SET(params, flag) \
 679         ({ typeof(params) __params = (params); \
 680            (__params && (__params->flags & QED_MB_FLAG_ ## flag)); })
 681 };
 682
 683 struct qed_drv_tlv_hdr {
 684         u8 tlv_type;
 685         u8 tlv_length;  /* In dwords - not including this header */
 686         u8 tlv_reserved;
 687 #define QED_DRV_TLV_FLAGS_CHANGED 0x01
 688         u8 tlv_flags;
 689 };
 690
 691 /**
 692  * @brief Initialize the interface with the MCP
 693  *
 694  * @param p_hwfn - HW func
 695  * @param p_ptt - PTT required for register access
 696  *
 697  * @return int
 698  */
 699 int qed_mcp_cmd_init(struct qed_hwfn *p_hwfn,
 700                      struct qed_ptt *p_ptt);
 701
 702 /**
 703  * @brief Initialize the port interface with the MCP
 704  *
 705  * @param p_hwfn
 706  * @param p_ptt
 707  * Can only be called after `num_ports_in_engines' is set
 708  */
 709 void qed_mcp_cmd_port_init(struct qed_hwfn *p_hwfn,
 710                            struct qed_ptt *p_ptt);
 711 /**
 712  * @brief Releases resources allocated during the init process.
 713  *
 714  * @param p_hwfn - HW func
 715  * @param p_ptt - PTT required for register access
 716  *
 717  * @return int
 718  */
 719
 720 int qed_mcp_free(struct qed_hwfn *p_hwfn);
 721
 722 /**
 723  * @brief This function is called from the DPC context. After
 724  * pointing PTT to the mfw mb, check for events sent by the MCP
 725  * to the driver and ack them. In case a critical event
 726  * detected, it will be handled here, otherwise the work will be
 727  * queued to a sleepable work-queue.
 728  *
 729  * @param p_hwfn - HW function
 730  * @param p_ptt - PTT required for register access
 731  * @return int - 0 - operation
 732  * was successul.
 733  */
 734 int qed_mcp_handle_events(struct qed_hwfn *p_hwfn,
 735                           struct qed_ptt *p_ptt);
 736
 737 enum qed_drv_role {
 738         QED_DRV_ROLE_OS,
 739         QED_DRV_ROLE_KDUMP,
 740 };
 741
 742 struct qed_load_req_params {
 743         /* Input params */
 744         enum qed_drv_role drv_role;
 745         u8 timeout_val;
 746         bool avoid_eng_reset;
 747         enum qed_override_force_load override_force_load;
 748
 749         /* Output params */
 750         u32 load_code;
 751 };
 752
 753 /**
 754  * @brief Sends a LOAD_REQ to the MFW, and in case the operation succeeds,
 755  *        returns whether this PF is the first on the engine/port or function.
 756  *
 757  * @param p_hwfn
 758  * @param p_ptt
 759  * @param p_params
 760  *
 761  * @return int - 0 - Operation was successful.
 762  */
 763 int qed_mcp_load_req(struct qed_hwfn *p_hwfn,
 764                      struct qed_ptt *p_ptt,
 765                      struct qed_load_req_params *p_params);
 766
 767 /**
 768  * @brief Sends a UNLOAD_REQ message to the MFW
 769  *
 770  * @param p_hwfn
 771  * @param p_ptt
 772  *
 773  * @return int - 0 - Operation was successful.
 774  */
 775 int qed_mcp_unload_req(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
 776
 777 /**
 778  * @brief Sends a UNLOAD_DONE message to the MFW
 779  *
 780  * @param p_hwfn
 781  * @param p_ptt
 782  *
 783  * @return int - 0 - Operation was successful.
 784  */
 785 int qed_mcp_unload_done(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
 786
 787 /**
 788  * @brief Read the MFW mailbox into Current buffer.
 789  *
 790  * @param p_hwfn
 791  * @param p_ptt
 792  */
 793 void qed_mcp_read_mb(struct qed_hwfn *p_hwfn,
 794                      struct qed_ptt *p_ptt);
 795
 796 /**
 797  * @brief Ack to mfw that driver finished FLR process for VFs
 798  *
 799  * @param p_hwfn
 800  * @param p_ptt
 801  * @param vfs_to_ack - bit mask of all engine VFs for which the PF acks.
 802  *
 803  * @param return int - 0 upon success.
 804  */
 805 int qed_mcp_ack_vf_flr(struct qed_hwfn *p_hwfn,
 806                        struct qed_ptt *p_ptt, u32 *vfs_to_ack);
 807
 808 /**
 809  * @brief - calls during init to read shmem of all function-related info.
 810  *
 811  * @param p_hwfn
 812  *
 813  * @param return 0 upon success.
 814  */
 815 int qed_mcp_fill_shmem_func_info(struct qed_hwfn *p_hwfn,
 816                                  struct qed_ptt *p_ptt);
 817
 818 /**
 819  * @brief - Reset the MCP using mailbox command.
 820  *
 821  * @param p_hwfn
 822  * @param p_ptt
 823  *
 824  * @param return 0 upon success.
 825  */
 826 int qed_mcp_reset(struct qed_hwfn *p_hwfn,
 827                   struct qed_ptt *p_ptt);
 828
 829 /**
 830  * @brief - Sends an NVM read command request to the MFW to get
 831  *        a buffer.
 832  *
 833  * @param p_hwfn
 834  * @param p_ptt
 835  * @param cmd - Command: DRV_MSG_CODE_NVM_GET_FILE_DATA or
 836  *            DRV_MSG_CODE_NVM_READ_NVRAM commands
 837  * @param param - [0:23] - Offset [24:31] - Size
 838  * @param o_mcp_resp - MCP response
 839  * @param o_mcp_param - MCP response param
 840  * @param o_txn_size -  Buffer size output
 841  * @param o_buf - Pointer to the buffer returned by the MFW.
 842  *
 843  * @param return 0 upon success.
 844  */
 845 int qed_mcp_nvm_rd_cmd(struct qed_hwfn *p_hwfn,
 846                        struct qed_ptt *p_ptt,
 847                        u32 cmd,
 848                        u32 param,
 849                        u32 *o_mcp_resp,
 850                        u32 *o_mcp_param, u32 *o_txn_size, u32 *o_buf);
 851
 852 /**
 853  * @brief Read from sfp
 854  *
 855  *  @param p_hwfn - hw function
 856  *  @param p_ptt  - PTT required for register access
 857  *  @param port   - transceiver port
 858  *  @param addr   - I2C address
 859  *  @param offset - offset in sfp
 860  *  @param len    - buffer length
 861  *  @param p_buf  - buffer to read into
 862  *
 863  * @return int - 0 - operation was successful.
 864  */
 865 int qed_mcp_phy_sfp_read(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt,
 866                          u32 port, u32 addr, u32 offset, u32 len, u8 *p_buf);
 867
 868 /**
 869  * @brief indicates whether the MFW objects [under mcp_info] are accessible
 870  *
 871  * @param p_hwfn
 872  *
 873  * @return true iff MFW is running and mcp_info is initialized
 874  */
 875 bool qed_mcp_is_init(struct qed_hwfn *p_hwfn);
 876
 877 /**
 878  * @brief request MFW to configure MSI-X for a VF
 879  *
 880  * @param p_hwfn
 881  * @param p_ptt
 882  * @param vf_id - absolute inside engine
 883  * @param num_sbs - number of entries to request
 884  *
 885  * @return int
 886  */
 887 int qed_mcp_config_vf_msix(struct qed_hwfn *p_hwfn,
 888                            struct qed_ptt *p_ptt, u8 vf_id, u8 num);
 889
 890 /**
 891  * @brief - Halt the MCP.
 892  *
 893  * @param p_hwfn
 894  * @param p_ptt
 895  *
 896  * @param return 0 upon success.
 897  */
 898 int qed_mcp_halt(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
 899
 900 /**
 901  * @brief - Wake up the MCP.
 902  *
 903  * @param p_hwfn
 904  * @param p_ptt
 905  *
 906  * @param return 0 upon success.
 907  */
 908 int qed_mcp_resume(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
 909
 910 int qed_configure_pf_min_bandwidth(struct qed_dev *cdev, u8 min_bw);
 911 int qed_configure_pf_max_bandwidth(struct qed_dev *cdev, u8 max_bw);
 912 int __qed_configure_pf_max_bandwidth(struct qed_hwfn *p_hwfn,
 913                                      struct qed_ptt *p_ptt,
 914                                      struct qed_mcp_link_state *p_link,
 915                                      u8 max_bw);
 916 int __qed_configure_pf_min_bandwidth(struct qed_hwfn *p_hwfn,
 917                                      struct qed_ptt *p_ptt,
 918                                      struct qed_mcp_link_state *p_link,
 919                                      u8 min_bw);
 920
 921 int qed_mcp_mask_parities(struct qed_hwfn *p_hwfn,
 922                           struct qed_ptt *p_ptt, u32 mask_parities);
 923
 924 /**
 925  * @brief - Sets the MFW's max value for the given resource
 926  *
 927  *  @param p_hwfn
 928  *  @param p_ptt
 929  *  @param res_id
 930  *  @param resc_max_val
 931  *  @param p_mcp_resp
 932  *
 933  * @return int - 0 - operation was successful.
 934  */
 935 int
 936 qed_mcp_set_resc_max_val(struct qed_hwfn *p_hwfn,
 937                          struct qed_ptt *p_ptt,
 938                          enum qed_resources res_id,
 939                          u32 resc_max_val, u32 *p_mcp_resp);
 940
 941 /**
 942  * @brief - Gets the MFW allocation info for the given resource
 943  *
 944  *  @param p_hwfn
 945  *  @param p_ptt
 946  *  @param res_id
 947  *  @param p_mcp_resp
 948  *  @param p_resc_num
 949  *  @param p_resc_start
 950  *
 951  * @return int - 0 - operation was successful.
 952  */
 953 int
 954 qed_mcp_get_resc_info(struct qed_hwfn *p_hwfn,
 955                       struct qed_ptt *p_ptt,
 956                       enum qed_resources res_id,
 957                       u32 *p_mcp_resp, u32 *p_resc_num, u32 *p_resc_start);
 958
 959 /**
 960  * @brief Send eswitch mode to MFW
 961  *
 962  *  @param p_hwfn
 963  *  @param p_ptt
 964  *  @param eswitch - eswitch mode
 965  *
 966  * @return int - 0 - operation was successful.
 967  */
 968 int qed_mcp_ov_update_eswitch(struct qed_hwfn *p_hwfn,
 969                               struct qed_ptt *p_ptt,
 970                               enum qed_ov_eswitch eswitch);
 971
 972 #define QED_MCP_RESC_LOCK_MIN_VAL       RESOURCE_DUMP
 973 #define QED_MCP_RESC_LOCK_MAX_VAL       31
 974
 975 enum qed_resc_lock {
 976         QED_RESC_LOCK_DBG_DUMP = QED_MCP_RESC_LOCK_MIN_VAL,
 977         QED_RESC_LOCK_PTP_PORT0,
 978         QED_RESC_LOCK_PTP_PORT1,
 979         QED_RESC_LOCK_PTP_PORT2,
 980         QED_RESC_LOCK_PTP_PORT3,
 981         QED_RESC_LOCK_RESC_ALLOC = QED_MCP_RESC_LOCK_MAX_VAL,
 982         QED_RESC_LOCK_RESC_INVALID
 983 };
 984
 985 /**
 986  * @brief - Initiates PF FLR
 987  *
 988  *  @param p_hwfn
 989  *  @param p_ptt
 990  *
 991  * @return int - 0 - operation was successful.
 992  */
 993 int qed_mcp_initiate_pf_flr(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
 994 struct qed_resc_lock_params {
 995         /* Resource number [valid values are 0..31] */
 996         u8 resource;
 997
 998         /* Lock timeout value in seconds [default, none or 1..254] */
 999         u8 timeout;
1000 #define QED_MCP_RESC_LOCK_TO_DEFAULT    0
1001 #define QED_MCP_RESC_LOCK_TO_NONE       255
1002
1003         /* Number of times to retry locking */
1004         u8 retry_num;
1005 #define QED_MCP_RESC_LOCK_RETRY_CNT_DFLT        10
1006
1007         /* The interval in usec between retries */
1008         u16 retry_interval;
1009 #define QED_MCP_RESC_LOCK_RETRY_VAL_DFLT        10000
1010
1011         /* Use sleep or delay between retries */
1012         bool sleep_b4_retry;
1013
1014         /* Will be set as true if the resource is free and granted */
1015         bool b_granted;
1016
1017         /* Will be filled with the resource owner.
1018          * [0..15 = PF0-15, 16 = MFW]
1019          */
1020         u8 owner;
1021 };
1022
1023 /**
1024  * @brief Acquires MFW generic resource lock
1025  *
1026  *  @param p_hwfn
1027  *  @param p_ptt
1028  *  @param p_params
1029  *
1030  * @return int - 0 - operation was successful.
1031  */
1032 int
1033 qed_mcp_resc_lock(struct qed_hwfn *p_hwfn,
1034                   struct qed_ptt *p_ptt, struct qed_resc_lock_params *p_params);
1035
1036 struct qed_resc_unlock_params {
1037         /* Resource number [valid values are 0..31] */
1038         u8 resource;
1039
1040         /* Allow to release a resource even if belongs to another PF */
1041         bool b_force;
1042
1043         /* Will be set as true if the resource is released */
1044         bool b_released;
1045 };
1046
1047 /**
1048  * @brief Releases MFW generic resource lock
1049  *
1050  *  @param p_hwfn
1051  *  @param p_ptt
1052  *  @param p_params
1053  *
1054  * @return int - 0 - operation was successful.
1055  */
1056 int
1057 qed_mcp_resc_unlock(struct qed_hwfn *p_hwfn,
1058                     struct qed_ptt *p_ptt,
1059                     struct qed_resc_unlock_params *p_params);
1060
1061 /**
1062  * @brief - default initialization for lock/unlock resource structs
1063  *
1064  * @param p_lock - lock params struct to be initialized; Can be NULL
1065  * @param p_unlock - unlock params struct to be initialized; Can be NULL
1066  * @param resource - the requested resource
1067  * @paral b_is_permanent - disable retries & aging when set
1068  */
1069 void qed_mcp_resc_lock_default_init(struct qed_resc_lock_params *p_lock,
1070                                     struct qed_resc_unlock_params *p_unlock,
1071                                     enum qed_resc_lock
1072                                     resource, bool b_is_permanent);
1073 /**
1074  * @brief Learn of supported MFW features; To be done during early init
1075  *
1076  * @param p_hwfn
1077  * @param p_ptt
1078  */
1079 int qed_mcp_get_capabilities(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
1080
1081 /**
1082  * @brief Inform MFW of set of features supported by driver. Should be done
1083  * inside the content of the LOAD_REQ.
1084  *
1085  * @param p_hwfn
1086  * @param p_ptt
1087  */
1088 int qed_mcp_set_capabilities(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
1089
1090 /**
1091  * @brief Read ufp config from the shared memory.
1092  *
1093  * @param p_hwfn
1094  * @param p_ptt
1095  */
1096 void qed_mcp_read_ufp_config(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
1097
1098 /**
1099  * @brief Populate the nvm info shadow in the given hardware function
1100  *
1101  * @param p_hwfn
1102  */
1103 int qed_mcp_nvm_info_populate(struct qed_hwfn *p_hwfn);
1104
1105 #endif