drivers/net/qede/base/ecore_mcp_api.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright (c) 2016 - 2018 Cavium Inc.
   3  * All rights reserved.
   4  * www.cavium.com
   5  */
   6
   7 #ifndef __ECORE_MCP_API_H__
   8 #define __ECORE_MCP_API_H__
   9
  10 #include "ecore_status.h"
  11
  12 struct ecore_mcp_link_speed_params {
  13         bool autoneg;
  14         u32 advertised_speeds; /* bitmask of DRV_SPEED_CAPABILITY */
  15         u32 forced_speed; /* In Mb/s */
  16 };
  17
  18 struct ecore_mcp_link_pause_params {
  19         bool autoneg;
  20         bool forced_rx;
  21         bool forced_tx;
  22 };
  23
  24 enum ecore_mcp_eee_mode {
  25         ECORE_MCP_EEE_DISABLED,
  26         ECORE_MCP_EEE_ENABLED,
  27         ECORE_MCP_EEE_UNSUPPORTED
  28 };
  29
  30 struct ecore_link_eee_params {
  31         u32 tx_lpi_timer;
  32 #define ECORE_EEE_1G_ADV        (1 << 0)
  33 #define ECORE_EEE_10G_ADV       (1 << 1)
  34         /* Capabilities are represented using ECORE_EEE_*_ADV values */
  35         u8 adv_caps;
  36         u8 lp_adv_caps;
  37         bool enable;
  38         bool tx_lpi_enable;
  39 };
  40
  41 struct ecore_mcp_link_params {
  42         struct ecore_mcp_link_speed_params speed;
  43         struct ecore_mcp_link_pause_params pause;
  44         u32 loopback_mode; /* in PMM_LOOPBACK values */
  45         struct ecore_link_eee_params eee;
  46 };
  47
  48 struct ecore_mcp_link_capabilities {
  49         u32 speed_capabilities;
  50         bool default_speed_autoneg; /* In Mb/s */
  51         u32 default_speed; /* In Mb/s */
  52         enum ecore_mcp_eee_mode default_eee;
  53         u32 eee_lpi_timer;
  54         u8 eee_speed_caps;
  55 };
  56
  57 struct ecore_mcp_link_state {
  58         bool link_up;
  59
  60         u32 min_pf_rate; /* In Mb/s */
  61
  62         /* Actual link speed in Mb/s */
  63         u32 line_speed;
  64
  65         /* PF max speed in MB/s, deduced from line_speed
  66          * according to PF max bandwidth configuration.
  67          */
  68         u32 speed;
  69         bool full_duplex;
  70
  71         bool an;
  72         bool an_complete;
  73         bool parallel_detection;
  74         bool pfc_enabled;
  75
  76 #define ECORE_LINK_PARTNER_SPEED_1G_HD  (1 << 0)
  77 #define ECORE_LINK_PARTNER_SPEED_1G_FD  (1 << 1)
  78 #define ECORE_LINK_PARTNER_SPEED_10G    (1 << 2)
  79 #define ECORE_LINK_PARTNER_SPEED_20G    (1 << 3)
  80 #define ECORE_LINK_PARTNER_SPEED_25G    (1 << 4)
  81 #define ECORE_LINK_PARTNER_SPEED_40G    (1 << 5)
  82 #define ECORE_LINK_PARTNER_SPEED_50G    (1 << 6)
  83 #define ECORE_LINK_PARTNER_SPEED_100G   (1 << 7)
  84         u32 partner_adv_speed;
  85
  86         bool partner_tx_flow_ctrl_en;
  87         bool partner_rx_flow_ctrl_en;
  88
  89 #define ECORE_LINK_PARTNER_SYMMETRIC_PAUSE (1)
  90 #define ECORE_LINK_PARTNER_ASYMMETRIC_PAUSE (2)
  91 #define ECORE_LINK_PARTNER_BOTH_PAUSE (3)
  92         u8 partner_adv_pause;
  93
  94         bool sfp_tx_fault;
  95
  96         bool eee_active;
  97         u8 eee_adv_caps;
  98         u8 eee_lp_adv_caps;
  99 };
 100
 101 struct ecore_mcp_function_info {
 102         u8 pause_on_host;
 103
 104         enum ecore_pci_personality protocol;
 105
 106         u8 bandwidth_min;
 107         u8 bandwidth_max;
 108
 109         u8 mac[ETH_ALEN];
 110
 111         u64 wwn_port;
 112         u64 wwn_node;
 113
 114 #define ECORE_MCP_VLAN_UNSET            (0xffff)
 115         u16 ovlan;
 116
 117         u16 mtu;
 118 };
 119
 120 #ifndef __EXTRACT__LINUX__
 121 enum ecore_nvm_images {
 122         ECORE_NVM_IMAGE_ISCSI_CFG,
 123         ECORE_NVM_IMAGE_FCOE_CFG,
 124 };
 125 #endif
 126
 127 struct ecore_mcp_drv_version {
 128         u32 version;
 129         u8 name[MCP_DRV_VER_STR_SIZE - 4];
 130 };
 131
 132 struct ecore_mcp_lan_stats {
 133         u64 ucast_rx_pkts;
 134         u64 ucast_tx_pkts;
 135         u32 fcs_err;
 136 };
 137
 138 #ifndef ECORE_PROTO_STATS
 139 #define ECORE_PROTO_STATS
 140 struct ecore_mcp_fcoe_stats {
 141         u64 rx_pkts;
 142         u64 tx_pkts;
 143         u32 fcs_err;
 144         u32 login_failure;
 145 };
 146
 147 struct ecore_mcp_iscsi_stats {
 148         u64 rx_pdus;
 149         u64 tx_pdus;
 150         u64 rx_bytes;
 151         u64 tx_bytes;
 152 };
 153
 154 struct ecore_mcp_rdma_stats {
 155         u64 rx_pkts;
 156         u64 tx_pkts;
 157         u64 rx_bytes;
 158         u64 tx_byts;
 159 };
 160
 161 enum ecore_mcp_protocol_type {
 162         ECORE_MCP_LAN_STATS,
 163         ECORE_MCP_FCOE_STATS,
 164         ECORE_MCP_ISCSI_STATS,
 165         ECORE_MCP_RDMA_STATS
 166 };
 167
 168 union ecore_mcp_protocol_stats {
 169         struct ecore_mcp_lan_stats lan_stats;
 170         struct ecore_mcp_fcoe_stats fcoe_stats;
 171         struct ecore_mcp_iscsi_stats iscsi_stats;
 172         struct ecore_mcp_rdma_stats rdma_stats;
 173 };
 174 #endif
 175
 176 enum ecore_ov_client {
 177         ECORE_OV_CLIENT_DRV,
 178         ECORE_OV_CLIENT_USER,
 179         ECORE_OV_CLIENT_VENDOR_SPEC
 180 };
 181
 182 enum ecore_ov_driver_state {
 183         ECORE_OV_DRIVER_STATE_NOT_LOADED,
 184         ECORE_OV_DRIVER_STATE_DISABLED,
 185         ECORE_OV_DRIVER_STATE_ACTIVE
 186 };
 187
 188 enum ecore_ov_eswitch {
 189         ECORE_OV_ESWITCH_NONE,
 190         ECORE_OV_ESWITCH_VEB,
 191         ECORE_OV_ESWITCH_VEPA
 192 };
 193
 194 #define ECORE_MAX_NPIV_ENTRIES 128
 195 #define ECORE_WWN_SIZE 8
 196 struct ecore_fc_npiv_tbl {
 197         u32 count;
 198         u8 wwpn[ECORE_MAX_NPIV_ENTRIES][ECORE_WWN_SIZE];
 199         u8 wwnn[ECORE_MAX_NPIV_ENTRIES][ECORE_WWN_SIZE];
 200 };
 201
 202 #ifndef __EXTRACT__LINUX__
 203 enum ecore_led_mode {
 204         ECORE_LED_MODE_OFF,
 205         ECORE_LED_MODE_ON,
 206         ECORE_LED_MODE_RESTORE
 207 };
 208 #endif
 209
 210 struct ecore_temperature_sensor {
 211         u8 sensor_location;
 212         u8 threshold_high;
 213         u8 critical;
 214         u8 current_temp;
 215 };
 216
 217 #define ECORE_MAX_NUM_OF_SENSORS        7
 218 struct ecore_temperature_info {
 219         u32 num_sensors;
 220         struct ecore_temperature_sensor sensors[ECORE_MAX_NUM_OF_SENSORS];
 221 };
 222
 223 enum ecore_mba_img_idx {
 224         ECORE_MBA_LEGACY_IDX,
 225         ECORE_MBA_PCI3CLP_IDX,
 226         ECORE_MBA_PCI3_IDX,
 227         ECORE_MBA_FCODE_IDX,
 228         ECORE_EFI_X86_IDX,
 229         ECORE_EFI_IPF_IDX,
 230         ECORE_EFI_EBC_IDX,
 231         ECORE_EFI_X64_IDX,
 232         ECORE_MAX_NUM_OF_ROMIMG
 233 };
 234
 235 struct ecore_mba_vers {
 236         u32 mba_vers[ECORE_MAX_NUM_OF_ROMIMG];
 237 };
 238
 239 enum ecore_mfw_tlv_type {
 240         ECORE_MFW_TLV_GENERIC = 0x1, /* Core driver TLVs */
 241         ECORE_MFW_TLV_ETH = 0x2, /* L2 driver TLVs */
 242         ECORE_MFW_TLV_FCOE = 0x4, /* FCoE protocol TLVs */
 243         ECORE_MFW_TLV_ISCSI = 0x8, /* SCSI protocol TLVs */
 244         ECORE_MFW_TLV_MAX = 0x16,
 245 };
 246
 247 struct ecore_mfw_tlv_generic {
 248         u16 feat_flags;
 249         bool feat_flags_set;
 250         u64 local_mac;
 251         bool local_mac_set;
 252         u64 additional_mac1;
 253         bool additional_mac1_set;
 254         u64 additional_mac2;
 255         bool additional_mac2_set;
 256         u8 drv_state;
 257         bool drv_state_set;
 258         u8 pxe_progress;
 259         bool pxe_progress_set;
 260         u64 rx_frames;
 261         bool rx_frames_set;
 262         u64 rx_bytes;
 263         bool rx_bytes_set;
 264         u64 tx_frames;
 265         bool tx_frames_set;
 266         u64 tx_bytes;
 267         bool tx_bytes_set;
 268 };
 269
 270 struct ecore_mfw_tlv_eth {
 271         u16 lso_maxoff_size;
 272         bool lso_maxoff_size_set;
 273         u16 lso_minseg_size;
 274         bool lso_minseg_size_set;
 275         u8 prom_mode;
 276         bool prom_mode_set;
 277         u16 tx_descr_size;
 278         bool tx_descr_size_set;
 279         u16 rx_descr_size;
 280         bool rx_descr_size_set;
 281         u16 netq_count;
 282         bool netq_count_set;
 283         u32 tcp4_offloads;
 284         bool tcp4_offloads_set;
 285         u32 tcp6_offloads;
 286         bool tcp6_offloads_set;
 287         u16 tx_descr_qdepth;
 288         bool tx_descr_qdepth_set;
 289         u16 rx_descr_qdepth;
 290         bool rx_descr_qdepth_set;
 291         u8 iov_offload;
 292         bool iov_offload_set;
 293         u8 txqs_empty;
 294         bool txqs_empty_set;
 295         u8 rxqs_empty;
 296         bool rxqs_empty_set;
 297         u8 num_txqs_full;
 298         bool num_txqs_full_set;
 299         u8 num_rxqs_full;
 300         bool num_rxqs_full_set;
 301 };
 302
 303 struct ecore_mfw_tlv_fcoe {
 304         u8 scsi_timeout;
 305         bool scsi_timeout_set;
 306         u32 rt_tov;
 307         bool rt_tov_set;
 308         u32 ra_tov;
 309         bool ra_tov_set;
 310         u32 ed_tov;
 311         bool ed_tov_set;
 312         u32 cr_tov;
 313         bool cr_tov_set;
 314         u8 boot_type;
 315         bool boot_type_set;
 316         u8 npiv_state;
 317         bool npiv_state_set;
 318         u32 num_npiv_ids;
 319         bool num_npiv_ids_set;
 320         u8 switch_name[8];
 321         bool switch_name_set;
 322         u16 switch_portnum;
 323         bool switch_portnum_set;
 324         u8 switch_portid[3];
 325         bool switch_portid_set;
 326         u8 vendor_name[8];
 327         bool vendor_name_set;
 328         u8 switch_model[8];
 329         bool switch_model_set;
 330         u8 switch_fw_version[8];
 331         bool switch_fw_version_set;
 332         u8 qos_pri;
 333         bool qos_pri_set;
 334         u8 port_alias[3];
 335         bool port_alias_set;
 336         u8 port_state;
 337         bool port_state_set;
 338         u16 fip_tx_descr_size;
 339         bool fip_tx_descr_size_set;
 340         u16 fip_rx_descr_size;
 341         bool fip_rx_descr_size_set;
 342         u16 link_failures;
 343         bool link_failures_set;
 344         u8 fcoe_boot_progress;
 345         bool fcoe_boot_progress_set;
 346         u64 rx_bcast;
 347         bool rx_bcast_set;
 348         u64 tx_bcast;
 349         bool tx_bcast_set;
 350         u16 fcoe_txq_depth;
 351         bool fcoe_txq_depth_set;
 352         u16 fcoe_rxq_depth;
 353         bool fcoe_rxq_depth_set;
 354         u64 fcoe_rx_frames;
 355         bool fcoe_rx_frames_set;
 356         u64 fcoe_rx_bytes;
 357         bool fcoe_rx_bytes_set;
 358         u64 fcoe_tx_frames;
 359         bool fcoe_tx_frames_set;
 360         u64 fcoe_tx_bytes;
 361         bool fcoe_tx_bytes_set;
 362         u16 crc_count;
 363         bool crc_count_set;
 364         u32 crc_err_src_fcid[5];
 365         bool crc_err_src_fcid_set[5];
 366         u8 crc_err_tstamp[5][14];
 367         bool crc_err_tstamp_set[5];
 368         u16 losync_err;
 369         bool losync_err_set;
 370         u16 losig_err;
 371         bool losig_err_set;
 372         u16 primtive_err;
 373         bool primtive_err_set;
 374         u16 disparity_err;
 375         bool disparity_err_set;
 376         u16 code_violation_err;
 377         bool code_violation_err_set;
 378         u32 flogi_param[4];
 379         bool flogi_param_set[4];
 380         u8 flogi_tstamp[14];
 381         bool flogi_tstamp_set;
 382         u32 flogi_acc_param[4];
 383         bool flogi_acc_param_set[4];
 384         u8 flogi_acc_tstamp[14];
 385         bool flogi_acc_tstamp_set;
 386         u32 flogi_rjt;
 387         bool flogi_rjt_set;
 388         u8 flogi_rjt_tstamp[14];
 389         bool flogi_rjt_tstamp_set;
 390         u32 fdiscs;
 391         bool fdiscs_set;
 392         u8 fdisc_acc;
 393         bool fdisc_acc_set;
 394         u8 fdisc_rjt;
 395         bool fdisc_rjt_set;
 396         u8 plogi;
 397         bool plogi_set;
 398         u8 plogi_acc;
 399         bool plogi_acc_set;
 400         u8 plogi_rjt;
 401         bool plogi_rjt_set;
 402         u32 plogi_dst_fcid[5];
 403         bool plogi_dst_fcid_set[5];
 404         u8 plogi_tstamp[5][14];
 405         bool plogi_tstamp_set[5];
 406         u32 plogi_acc_src_fcid[5];
 407         bool plogi_acc_src_fcid_set[5];
 408         u8 plogi_acc_tstamp[5][14];
 409         bool plogi_acc_tstamp_set[5];
 410         u8 tx_plogos;
 411         bool tx_plogos_set;
 412         u8 plogo_acc;
 413         bool plogo_acc_set;
 414         u8 plogo_rjt;
 415         bool plogo_rjt_set;
 416         u32 plogo_src_fcid[5];
 417         bool plogo_src_fcid_set[5];
 418         u8 plogo_tstamp[5][14];
 419         bool plogo_tstamp_set[5];
 420         u8 rx_logos;
 421         bool rx_logos_set;
 422         u8 tx_accs;
 423         bool tx_accs_set;
 424         u8 tx_prlis;
 425         bool tx_prlis_set;
 426         u8 rx_accs;
 427         bool rx_accs_set;
 428         u8 tx_abts;
 429         bool tx_abts_set;
 430         u8 rx_abts_acc;
 431         bool rx_abts_acc_set;
 432         u8 rx_abts_rjt;
 433         bool rx_abts_rjt_set;
 434         u32 abts_dst_fcid[5];
 435         bool abts_dst_fcid_set[5];
 436         u8 abts_tstamp[5][14];
 437         bool abts_tstamp_set[5];
 438         u8 rx_rscn;
 439         bool rx_rscn_set;
 440         u32 rx_rscn_nport[4];
 441         bool rx_rscn_nport_set[4];
 442         u8 tx_lun_rst;
 443         bool tx_lun_rst_set;
 444         u8 abort_task_sets;
 445         bool abort_task_sets_set;
 446         u8 tx_tprlos;
 447         bool tx_tprlos_set;
 448         u8 tx_nos;
 449         bool tx_nos_set;
 450         u8 rx_nos;
 451         bool rx_nos_set;
 452         u8 ols;
 453         bool ols_set;
 454         u8 lr;
 455         bool lr_set;
 456         u8 lrr;
 457         bool lrr_set;
 458         u8 tx_lip;
 459         bool tx_lip_set;
 460         u8 rx_lip;
 461         bool rx_lip_set;
 462         u8 eofa;
 463         bool eofa_set;
 464         u8 eofni;
 465         bool eofni_set;
 466         u8 scsi_chks;
 467         bool scsi_chks_set;
 468         u8 scsi_cond_met;
 469         bool scsi_cond_met_set;
 470         u8 scsi_busy;
 471         bool scsi_busy_set;
 472         u8 scsi_inter;
 473         bool scsi_inter_set;
 474         u8 scsi_inter_cond_met;
 475         bool scsi_inter_cond_met_set;
 476         u8 scsi_rsv_conflicts;
 477         bool scsi_rsv_conflicts_set;
 478         u8 scsi_tsk_full;
 479         bool scsi_tsk_full_set;
 480         u8 scsi_aca_active;
 481         bool scsi_aca_active_set;
 482         u8 scsi_tsk_abort;
 483         bool scsi_tsk_abort_set;
 484         u32 scsi_rx_chk[5];
 485         bool scsi_rx_chk_set[5];
 486         u8 scsi_chk_tstamp[5][14];
 487         bool scsi_chk_tstamp_set[5];
 488 };
 489
 490 struct ecore_mfw_tlv_iscsi {
 491         u8 target_llmnr;
 492         bool target_llmnr_set;
 493         u8 header_digest;
 494         bool header_digest_set;
 495         u8 data_digest;
 496         bool data_digest_set;
 497         u8 auth_method;
 498         bool auth_method_set;
 499         u16 boot_taget_portal;
 500         bool boot_taget_portal_set;
 501         u16 frame_size;
 502         bool frame_size_set;
 503         u16 tx_desc_size;
 504         bool tx_desc_size_set;
 505         u16 rx_desc_size;
 506         bool rx_desc_size_set;
 507         u8 boot_progress;
 508         bool boot_progress_set;
 509         u16 tx_desc_qdepth;
 510         bool tx_desc_qdepth_set;
 511         u16 rx_desc_qdepth;
 512         bool rx_desc_qdepth_set;
 513         u64 rx_frames;
 514         bool rx_frames_set;
 515         u64 rx_bytes;
 516         bool rx_bytes_set;
 517         u64 tx_frames;
 518         bool tx_frames_set;
 519         u64 tx_bytes;
 520         bool tx_bytes_set;
 521 };
 522
 523 union ecore_mfw_tlv_data {
 524         struct ecore_mfw_tlv_generic generic;
 525         struct ecore_mfw_tlv_eth eth;
 526         struct ecore_mfw_tlv_fcoe fcoe;
 527         struct ecore_mfw_tlv_iscsi iscsi;
 528 };
 529
 530 enum ecore_hw_info_change {
 531         ECORE_HW_INFO_CHANGE_OVLAN,
 532 };
 533
 534 /**
 535  * @brief - returns the link params of the hw function
 536  *
 537  * @param p_hwfn
 538  *
 539  * @returns pointer to link params
 540  */
 541 struct ecore_mcp_link_params *ecore_mcp_get_link_params(struct ecore_hwfn *);
 542
 543 /**
 544  * @brief - return the link state of the hw function
 545  *
 546  * @param p_hwfn
 547  *
 548  * @returns pointer to link state
 549  */
 550 struct ecore_mcp_link_state *ecore_mcp_get_link_state(struct ecore_hwfn *);
 551
 552 /**
 553  * @brief - return the link capabilities of the hw function
 554  *
 555  * @param p_hwfn
 556  *
 557  * @returns pointer to link capabilities
 558  */
 559 struct ecore_mcp_link_capabilities
 560 *ecore_mcp_get_link_capabilities(struct ecore_hwfn *p_hwfn);
 561
 562 /**
 563  * @brief Request the MFW to set the link according to 'link_input'.
 564  *
 565  * @param p_hwfn
 566  * @param p_ptt
 567  * @param b_up - raise link if `true'. Reset link if `false'.
 568  *
 569  * @return enum _ecore_status_t
 570  */
 571 enum _ecore_status_t ecore_mcp_set_link(struct ecore_hwfn *p_hwfn,
 572                                         struct ecore_ptt *p_ptt,
 573                                         bool b_up);
 574
 575 /**
 576  * @brief Get the management firmware version value
 577  *
 578  * @param p_hwfn
 579  * @param p_ptt
 580  * @param p_mfw_ver    - mfw version value
 581  * @param p_running_bundle_id   - image id in nvram; Optional.
 582  *
 583  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 584  */
 585 enum _ecore_status_t ecore_mcp_get_mfw_ver(struct ecore_hwfn *p_hwfn,
 586                                            struct ecore_ptt *p_ptt,
 587                                            u32 *p_mfw_ver,
 588                                            u32 *p_running_bundle_id);
 589
 590 /**
 591  * @brief Get media type value of the port.
 592  *
 593  * @param p_dev      - ecore dev pointer
 594  * @param p_ptt
 595  * @param mfw_ver    - media type value
 596  *
 597  * @return enum _ecore_status_t -
 598  *      ECORE_SUCCESS - Operation was successful.
 599  *      ECORE_BUSY - Operation failed
 600  */
 601 enum _ecore_status_t ecore_mcp_get_media_type(struct ecore_hwfn *p_hwfn,
 602                                               struct ecore_ptt *p_ptt,
 603                                               u32 *media_type);
 604
 605 /**
 606  * @brief Get transceiver data of the port.
 607  *
 608  * @param p_dev      - ecore dev pointer
 609  * @param p_ptt
 610  * @param p_transceiver_type - media type value
 611  *
 612  * @return enum _ecore_status_t -
 613  *      ECORE_SUCCESS - Operation was successful.
 614  *      ECORE_BUSY - Operation failed
 615  */
 616 enum _ecore_status_t ecore_mcp_get_transceiver_data(struct ecore_hwfn *p_hwfn,
 617                                                     struct ecore_ptt *p_ptt,
 618                                                     u32 *p_tranceiver_type);
 619
 620 /**
 621  * @brief Get transceiver supported speed mask.
 622  *
 623  * @param p_dev      - ecore dev pointer
 624  * @param p_ptt
 625  * @param p_speed_mask - Bit mask of all supported speeds.
 626  *
 627  * @return enum _ecore_status_t -
 628  *      ECORE_SUCCESS - Operation was successful.
 629  *      ECORE_BUSY - Operation failed
 630  */
 631
 632 enum _ecore_status_t ecore_mcp_trans_speed_mask(struct ecore_hwfn *p_hwfn,
 633                                                 struct ecore_ptt *p_ptt,
 634                                                 u32 *p_speed_mask);
 635
 636 /**
 637  * @brief Get board configuration.
 638  *
 639  * @param p_dev      - ecore dev pointer
 640  * @param p_ptt
 641  * @param p_board_config - Board config.
 642  *
 643  * @return enum _ecore_status_t -
 644  *      ECORE_SUCCESS - Operation was successful.
 645  *      ECORE_BUSY - Operation failed
 646  */
 647 enum _ecore_status_t ecore_mcp_get_board_config(struct ecore_hwfn *p_hwfn,
 648                                                 struct ecore_ptt *p_ptt,
 649                                                 u32 *p_board_config);
 650
 651 /**
 652  * @brief - Sends a command to the MCP mailbox.
 653  *
 654  * @param p_hwfn      - hw function
 655  * @param p_ptt       - PTT required for register access
 656  * @param cmd         - command to be sent to the MCP
 657  * @param param       - Optional param
 658  * @param o_mcp_resp  - The MCP response code (exclude sequence)
 659  * @param o_mcp_param - Optional parameter provided by the MCP response
 660  *
 661  * @return enum _ecore_status_t -
 662  *      ECORE_SUCCESS - operation was successful
 663  *      ECORE_BUSY    - operation failed
 664  */
 665 enum _ecore_status_t ecore_mcp_cmd(struct ecore_hwfn *p_hwfn,
 666                                    struct ecore_ptt *p_ptt, u32 cmd, u32 param,
 667                                    u32 *o_mcp_resp, u32 *o_mcp_param);
 668
 669 /**
 670  * @brief - drains the nig, allowing completion to pass in case of pauses.
 671  *          (Should be called only from sleepable context)
 672  *
 673  * @param p_hwfn
 674  * @param p_ptt
 675  */
 676 enum _ecore_status_t ecore_mcp_drain(struct ecore_hwfn *p_hwfn,
 677                                      struct ecore_ptt *p_ptt);
 678
 679 #ifndef LINUX_REMOVE
 680 /**
 681  * @brief - return the mcp function info of the hw function
 682  *
 683  * @param p_hwfn
 684  *
 685  * @returns pointer to mcp function info
 686  */
 687 const struct ecore_mcp_function_info
 688 *ecore_mcp_get_function_info(struct ecore_hwfn *p_hwfn);
 689 #endif
 690
 691 #ifndef LINUX_REMOVE
 692 /**
 693  * @brief - count number of function with a matching personality on engine.
 694  *
 695  * @param p_hwfn
 696  * @param p_ptt
 697  * @param personalities - a bitmask of ecore_pci_personality values
 698  *
 699  * @returns the count of all devices on engine whose personality match one of
 700  *          the bitsmasks.
 701  */
 702 int ecore_mcp_get_personality_cnt(struct ecore_hwfn *p_hwfn,
 703                                   struct ecore_ptt *p_ptt,
 704                                   u32 personalities);
 705 #endif
 706
 707 /**
 708  * @brief Get the flash size value
 709  *
 710  * @param p_hwfn
 711  * @param p_ptt
 712  * @param p_flash_size  - flash size in bytes to be filled.
 713  *
 714  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 715  */
 716 enum _ecore_status_t ecore_mcp_get_flash_size(struct ecore_hwfn *p_hwfn,
 717                                               struct ecore_ptt *p_ptt,
 718                                               u32 *p_flash_size);
 719
 720 /**
 721  * @brief Send driver version to MFW
 722  *
 723  * @param p_hwfn
 724  * @param p_ptt
 725  * @param version - Version value
 726  * @param name - Protocol driver name
 727  *
 728  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 729  */
 730 enum _ecore_status_t
 731 ecore_mcp_send_drv_version(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
 732                            struct ecore_mcp_drv_version *p_ver);
 733
 734 /**
 735  * @brief Read the MFW process kill counter
 736  *
 737  * @param p_hwfn
 738  * @param p_ptt
 739  *
 740  * @return u32
 741  */
 742 u32 ecore_get_process_kill_counter(struct ecore_hwfn *p_hwfn,
 743                                    struct ecore_ptt *p_ptt);
 744
 745 /**
 746  * @brief Trigger a recovery process
 747  *
 748  *  @param p_hwfn
 749  *  @param p_ptt
 750  *
 751  * @return enum _ecore_status_t
 752  */
 753 enum _ecore_status_t ecore_start_recovery_process(struct ecore_hwfn *p_hwfn,
 754                                                   struct ecore_ptt *p_ptt);
 755
 756 /**
 757  * @brief A recovery handler must call this function as its first step.
 758  *        It is assumed that the handler is not run from an interrupt context.
 759  *
 760  *  @param p_dev
 761  *  @param p_ptt
 762  *
 763  * @return enum _ecore_status_t
 764  */
 765 enum _ecore_status_t ecore_recovery_prolog(struct ecore_dev *p_dev);
 766
 767 /**
 768  * @brief Notify MFW about the change in base device properties
 769  *
 770  *  @param p_hwfn
 771  *  @param p_ptt
 772  *  @param client - ecore client type
 773  *
 774  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 775  */
 776 enum _ecore_status_t
 777 ecore_mcp_ov_update_current_config(struct ecore_hwfn *p_hwfn,
 778                                    struct ecore_ptt *p_ptt,
 779                                    enum ecore_ov_client client);
 780
 781 /**
 782  * @brief Notify MFW about the driver state
 783  *
 784  *  @param p_hwfn
 785  *  @param p_ptt
 786  *  @param drv_state - Driver state
 787  *
 788  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 789  */
 790 enum _ecore_status_t
 791 ecore_mcp_ov_update_driver_state(struct ecore_hwfn *p_hwfn,
 792                                  struct ecore_ptt *p_ptt,
 793                                  enum ecore_ov_driver_state drv_state);
 794
 795 /**
 796  * @brief Read NPIV settings form the MFW
 797  *
 798  *  @param p_hwfn
 799  *  @param p_ptt
 800  *  @param p_table - Array to hold the FC NPIV data. Client need allocate the
 801  *                   required buffer. The field 'count' specifies number of NPIV
 802  *                   entries. A value of 0 means the table was not populated.
 803  *
 804  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 805  */
 806 enum _ecore_status_t
 807 ecore_mcp_ov_get_fc_npiv(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
 808                          struct ecore_fc_npiv_tbl *p_table);
 809
 810 /**
 811  * @brief Send MTU size to MFW
 812  *
 813  *  @param p_hwfn
 814  *  @param p_ptt
 815  *  @param mtu - MTU size
 816  *
 817  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 818  */
 819 enum _ecore_status_t ecore_mcp_ov_update_mtu(struct ecore_hwfn *p_hwfn,
 820                                              struct ecore_ptt *p_ptt, u16 mtu);
 821
 822 /**
 823  * @brief Send MAC address to MFW
 824  *
 825  *  @param p_hwfn
 826  *  @param p_ptt
 827  *  @param mac - MAC address
 828  *
 829  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 830  */
 831 enum _ecore_status_t
 832 ecore_mcp_ov_update_mac(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
 833                         u8 *mac);
 834
 835 /**
 836  * @brief Send eswitch mode to MFW
 837  *
 838  *  @param p_hwfn
 839  *  @param p_ptt
 840  *  @param eswitch - eswitch mode
 841  *
 842  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 843  */
 844 enum _ecore_status_t
 845 ecore_mcp_ov_update_eswitch(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
 846                             enum ecore_ov_eswitch eswitch);
 847
 848 /**
 849  * @brief Set LED status
 850  *
 851  *  @param p_hwfn
 852  *  @param p_ptt
 853  *  @param mode - LED mode
 854  *
 855  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 856  */
 857 enum _ecore_status_t ecore_mcp_set_led(struct ecore_hwfn *p_hwfn,
 858                                        struct ecore_ptt *p_ptt,
 859                                        enum ecore_led_mode mode);
 860
 861 /**
 862  * @brief Set secure mode
 863  *
 864  *  @param p_dev
 865  *  @param addr - nvm offset
 866  *
 867  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 868  */
 869 enum _ecore_status_t ecore_mcp_nvm_set_secure_mode(struct ecore_dev *p_dev,
 870                                                    u32 addr);
 871
 872 /**
 873  * @brief Write to phy
 874  *
 875  *  @param p_dev
 876  *  @param addr - nvm offset
 877  *  @param cmd - nvm command
 878  *  @param p_buf - nvm write buffer
 879  *  @param len - buffer len
 880  *
 881  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 882  */
 883 enum _ecore_status_t ecore_mcp_phy_write(struct ecore_dev *p_dev, u32 cmd,
 884                                          u32 addr, u8 *p_buf, u32 len);
 885
 886 /**
 887  * @brief Write to nvm
 888  *
 889  *  @param p_dev
 890  *  @param addr - nvm offset
 891  *  @param cmd - nvm command
 892  *  @param p_buf - nvm write buffer
 893  *  @param len - buffer len
 894  *
 895  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 896  */
 897 enum _ecore_status_t ecore_mcp_nvm_write(struct ecore_dev *p_dev, u32 cmd,
 898                                          u32 addr, u8 *p_buf, u32 len);
 899
 900 /**
 901  * @brief Put file begin
 902  *
 903  *  @param p_dev
 904  *  @param addr - nvm offset
 905  *
 906  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 907  */
 908 enum _ecore_status_t ecore_mcp_nvm_put_file_begin(struct ecore_dev *p_dev,
 909                                                   u32 addr);
 910
 911 /**
 912  * @brief Delete file
 913  *
 914  *  @param p_dev
 915  *  @param addr - nvm offset
 916  *
 917  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 918  */
 919 enum _ecore_status_t ecore_mcp_nvm_del_file(struct ecore_dev *p_dev,
 920                                             u32 addr);
 921
 922 /**
 923  * @brief Check latest response
 924  *
 925  *  @param p_dev
 926  *  @param p_buf - nvm write buffer
 927  *
 928  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 929  */
 930 enum _ecore_status_t ecore_mcp_nvm_resp(struct ecore_dev *p_dev, u8 *p_buf);
 931
 932 /**
 933  * @brief Read from phy
 934  *
 935  *  @param p_dev
 936  *  @param addr - nvm offset
 937  *  @param cmd - nvm command
 938  *  @param p_buf - nvm read buffer
 939  *  @param len - buffer len
 940  *
 941  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 942  */
 943 enum _ecore_status_t ecore_mcp_phy_read(struct ecore_dev *p_dev, u32 cmd,
 944                                         u32 addr, u8 *p_buf, u32 len);
 945
 946 /**
 947  * @brief Read from nvm
 948  *
 949  *  @param p_dev
 950  *  @param addr - nvm offset
 951  *  @param p_buf - nvm read buffer
 952  *  @param len - buffer len
 953  *
 954  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
 955  */
 956 enum _ecore_status_t ecore_mcp_nvm_read(struct ecore_dev *p_dev, u32 addr,
 957                            u8 *p_buf, u32 len);
 958
 959 /**
 960  * @brief - Sends an NVM write command request to the MFW with
 961  *          payload.
 962  *
 963  * @param p_hwfn
 964  * @param p_ptt
 965  * @param cmd - Command: Either DRV_MSG_CODE_NVM_WRITE_NVRAM or
 966  *            DRV_MSG_CODE_NVM_PUT_FILE_DATA
 967  * @param param - [0:23] - Offset [24:31] - Size
 968  * @param o_mcp_resp - MCP response
 969  * @param o_mcp_param - MCP response param
 970  * @param i_txn_size -  Buffer size
 971  * @param i_buf - Pointer to the buffer
 972  *
 973  * @param return ECORE_SUCCESS upon success.
 974  */
 975 enum _ecore_status_t ecore_mcp_nvm_wr_cmd(struct ecore_hwfn *p_hwfn,
 976                                           struct ecore_ptt *p_ptt,
 977                                           u32 cmd,
 978                                           u32 param,
 979                                           u32 *o_mcp_resp,
 980                                           u32 *o_mcp_param,
 981                                           u32 i_txn_size,
 982                                           u32 *i_buf);
 983
 984 /**
 985  * @brief - Sends an NVM read command request to the MFW to get
 986  *        a buffer.
 987  *
 988  * @param p_hwfn
 989  * @param p_ptt
 990  * @param cmd - Command: DRV_MSG_CODE_NVM_GET_FILE_DATA or
 991  *            DRV_MSG_CODE_NVM_READ_NVRAM commands
 992  * @param param - [0:23] - Offset [24:31] - Size
 993  * @param o_mcp_resp - MCP response
 994  * @param o_mcp_param - MCP response param
 995  * @param o_txn_size -  Buffer size output
 996  * @param o_buf - Pointer to the buffer returned by the MFW.
 997  *
 998  * @param return ECORE_SUCCESS upon success.
 999  */
1000 enum _ecore_status_t ecore_mcp_nvm_rd_cmd(struct ecore_hwfn *p_hwfn,
1001                                           struct ecore_ptt *p_ptt,
1002                                           u32 cmd,
1003                                           u32 param,
1004                                           u32 *o_mcp_resp,
1005                                           u32 *o_mcp_param,
1006                                           u32 *o_txn_size,
1007                                           u32 *o_buf);
1008
1009 /**
1010  * @brief Read from sfp
1011  *
1012  *  @param p_hwfn - hw function
1013  *  @param p_ptt  - PTT required for register access
1014  *  @param port   - transceiver port
1015  *  @param addr   - I2C address
1016  *  @param offset - offset in sfp
1017  *  @param len    - buffer length
1018  *  @param p_buf  - buffer to read into
1019  *
1020  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
1021  */
1022 enum _ecore_status_t ecore_mcp_phy_sfp_read(struct ecore_hwfn *p_hwfn,
1023                                             struct ecore_ptt *p_ptt,
1024                                             u32 port, u32 addr, u32 offset,
1025                                             u32 len, u8 *p_buf);
1026
1027 /**
1028  * @brief Write to sfp
1029  *
1030  *  @param p_hwfn - hw function
1031  *  @param p_ptt  - PTT required for register access
1032  *  @param port   - transceiver port
1033  *  @param addr   - I2C address
1034  *  @param offset - offset in sfp
1035  *  @param len    - buffer length
1036  *  @param p_buf  - buffer to write from
1037  *
1038  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
1039  */
1040 enum _ecore_status_t ecore_mcp_phy_sfp_write(struct ecore_hwfn *p_hwfn,
1041                                              struct ecore_ptt *p_ptt,
1042                                              u32 port, u32 addr, u32 offset,
1043                                              u32 len, u8 *p_buf);
1044
1045 /**
1046  * @brief Gpio read
1047  *
1048  *  @param p_hwfn    - hw function
1049  *  @param p_ptt     - PTT required for register access
1050  *  @param gpio      - gpio number
1051  *  @param gpio_val  - value read from gpio
1052  *
1053  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
1054  */
1055 enum _ecore_status_t ecore_mcp_gpio_read(struct ecore_hwfn *p_hwfn,
1056                                          struct ecore_ptt *p_ptt,
1057                                          u16 gpio, u32 *gpio_val);
1058
1059 /**
1060  * @brief Gpio write
1061  *
1062  *  @param p_hwfn    - hw function
1063  *  @param p_ptt     - PTT required for register access
1064  *  @param gpio      - gpio number
1065  *  @param gpio_val  - value to write to gpio
1066  *
1067  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
1068  */
1069 enum _ecore_status_t ecore_mcp_gpio_write(struct ecore_hwfn *p_hwfn,
1070                                           struct ecore_ptt *p_ptt,
1071                                           u16 gpio, u16 gpio_val);
1072
1073 /**
1074  * @brief Gpio get information
1075  *
1076  *  @param p_hwfn          - hw function
1077  *  @param p_ptt           - PTT required for register access
1078  *  @param gpio            - gpio number
1079  *  @param gpio_direction  - gpio is output (0) or input (1)
1080  *  @param gpio_ctrl       - gpio control is uninitialized (0),
1081  *                         path 0 (1), path 1 (2) or shared(3)
1082  *
1083  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
1084  */
1085 enum _ecore_status_t ecore_mcp_gpio_info(struct ecore_hwfn *p_hwfn,
1086                                          struct ecore_ptt *p_ptt,
1087                                          u16 gpio, u32 *gpio_direction,
1088                                          u32 *gpio_ctrl);
1089
1090 /**
1091  * @brief Bist register test
1092  *
1093  *  @param p_hwfn    - hw function
1094  *  @param p_ptt     - PTT required for register access
1095  *
1096  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
1097  */
1098 enum _ecore_status_t ecore_mcp_bist_register_test(struct ecore_hwfn *p_hwfn,
1099                                                    struct ecore_ptt *p_ptt);
1100
1101 /**
1102  * @brief Bist clock test
1103  *
1104  *  @param p_hwfn    - hw function
1105  *  @param p_ptt     - PTT required for register access
1106  *
1107  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
1108  */
1109 enum _ecore_status_t ecore_mcp_bist_clock_test(struct ecore_hwfn *p_hwfn,
1110                                                 struct ecore_ptt *p_ptt);
1111
1112 /**
1113  * @brief Bist nvm test - get number of images
1114  *
1115  *  @param p_hwfn       - hw function
1116  *  @param p_ptt        - PTT required for register access
1117  *  @param num_images   - number of images if operation was
1118  *                        successful. 0 if not.
1119  *
1120  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
1121  */
1122 enum _ecore_status_t ecore_mcp_bist_nvm_test_get_num_images(
1123                                                 struct ecore_hwfn *p_hwfn,
1124                                                 struct ecore_ptt *p_ptt,
1125                                                 u32 *num_images);
1126
1127 /**
1128  * @brief Bist nvm test - get image attributes by index
1129  *
1130  *  @param p_hwfn      - hw function
1131  *  @param p_ptt       - PTT required for register access
1132  *  @param p_image_att - Attributes of image
1133  *  @param image_index - Index of image to get information for
1134  *
1135  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
1136  */
1137 enum _ecore_status_t ecore_mcp_bist_nvm_test_get_image_att(
1138                                         struct ecore_hwfn *p_hwfn,
1139                                         struct ecore_ptt *p_ptt,
1140                                         struct bist_nvm_image_att *p_image_att,
1141                                         u32 image_index);
1142
1143 /**
1144  * @brief ecore_mcp_get_temperature_info - get the status of the temperature
1145  *                                         sensors
1146  *
1147  *  @param p_hwfn        - hw function
1148  *  @param p_ptt         - PTT required for register access
1149  *  @param p_temp_status - A pointer to an ecore_temperature_info structure to
1150  *                         be filled with the temperature data
1151  *
1152  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
1153  */
1154 enum _ecore_status_t
1155 ecore_mcp_get_temperature_info(struct ecore_hwfn *p_hwfn,
1156                                struct ecore_ptt *p_ptt,
1157                                struct ecore_temperature_info *p_temp_info);
1158
1159 /**
1160  * @brief Get MBA versions - get MBA sub images versions
1161  *
1162  *  @param p_hwfn      - hw function
1163  *  @param p_ptt       - PTT required for register access
1164  *  @param p_mba_vers  - MBA versions array to fill
1165  *
1166  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
1167  */
1168 enum _ecore_status_t ecore_mcp_get_mba_versions(
1169         struct ecore_hwfn *p_hwfn,
1170         struct ecore_ptt *p_ptt,
1171         struct ecore_mba_vers *p_mba_vers);
1172
1173 /**
1174  * @brief Count memory ecc events
1175  *
1176  *  @param p_hwfn      - hw function
1177  *  @param p_ptt       - PTT required for register access
1178  *  @param num_events  - number of memory ecc events
1179  *
1180  * @return enum _ecore_status_t - ECORE_SUCCESS - operation was successful.
1181  */
1182 enum _ecore_status_t ecore_mcp_mem_ecc_events(struct ecore_hwfn *p_hwfn,
1183                                               struct ecore_ptt *p_ptt,
1184                                               u64 *num_events);
1185
1186 struct ecore_mdump_info {
1187         u32 reason;
1188         u32 version;
1189         u32 config;
1190         u32 epoch;
1191         u32 num_of_logs;
1192         u32 valid_logs;
1193 };
1194
1195 /**
1196  * @brief - Gets the MFW crash dump configuration and logs info.
1197  *
1198  * @param p_hwfn
1199  * @param p_ptt
1200  * @param p_mdump_info
1201  *
1202  * @param return ECORE_SUCCESS upon success.
1203  */
1204 enum _ecore_status_t
1205 ecore_mcp_mdump_get_info(struct ecore_hwfn *p_hwfn, struct ecore_ptt *p_ptt,
1206                          struct ecore_mdump_info *p_mdump_info);
1207
1208 /**
1209  * @brief - Clears the MFW crash dump logs.
1210  *
1211  * @param p_hwfn
1212  * @param p_ptt
1213  *
1214  * @param return ECORE_SUCCESS upon success.
1215  */
1216 enum _ecore_status_t ecore_mcp_mdump_clear_logs(struct ecore_hwfn *p_hwfn,
1217                                                 struct ecore_ptt *p_ptt);
1218
1219 /**
1220  * @brief - Clear the mdump retained data.
1221  *
1222  * @param p_hwfn
1223  * @param p_ptt
1224  *
1225  * @param return ECORE_SUCCESS upon success.
1226  */
1227 enum _ecore_status_t ecore_mcp_mdump_clr_retain(struct ecore_hwfn *p_hwfn,
1228                                                 struct ecore_ptt *p_ptt);
1229
1230 /**
1231  * @brief - Processes the TLV request from MFW i.e., get the required TLV info
1232  *          from the ecore client and send it to the MFW.
1233  *
1234  * @param p_hwfn
1235  * @param p_ptt
1236  *
1237  * @param return ECORE_SUCCESS upon success.
1238  */
1239 enum _ecore_status_t ecore_mfw_process_tlv_req(struct ecore_hwfn *p_hwfn,
1240                                                struct ecore_ptt *p_ptt);
1241
1242
1243 /**
1244  * @brief - Return whether management firmware support smart AN
1245  *
1246  * @param p_hwfn
1247  *
1248  * @return bool - true iff feature is supported.
1249  */
1250 bool ecore_mcp_is_smart_an_supported(struct ecore_hwfn *p_hwfn);
1251 #endif