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_DEV_API_H__ 8 #define __ECORE_DEV_API_H__ 9 10 #include "ecore_status.h" 11 #include "ecore_chain.h" 12 #include "ecore_int_api.h" 13 14 /** 15 * @brief ecore_init_dp - initialize the debug level 16 * 17 * @param p_dev 18 * @param dp_module 19 * @param dp_level 20 * @param dp_ctx 21 */ 22 void ecore_init_dp(struct ecore_dev *p_dev, 23 u32 dp_module, 24 u8 dp_level, 25 void *dp_ctx); 26 27 /** 28 * @brief ecore_init_struct - initialize the device structure to 29 * its defaults 30 * 31 * @param p_dev 32 */ 33 enum _ecore_status_t ecore_init_struct(struct ecore_dev *p_dev); 34 35 /** 36 * @brief ecore_resc_free - 37 * 38 * @param p_dev 39 */ 40 void ecore_resc_free(struct ecore_dev *p_dev); 41 42 /** 43 * @brief ecore_resc_alloc - 44 * 45 * @param p_dev 46 * 47 * @return enum _ecore_status_t 48 */ 49 enum _ecore_status_t ecore_resc_alloc(struct ecore_dev *p_dev); 50 51 /** 52 * @brief ecore_resc_setup - 53 * 54 * @param p_dev 55 */ 56 void ecore_resc_setup(struct ecore_dev *p_dev); 57 58 enum ecore_mfw_timeout_fallback { 59 ECORE_TO_FALLBACK_TO_NONE, 60 ECORE_TO_FALLBACK_TO_DEFAULT, 61 ECORE_TO_FALLBACK_FAIL_LOAD, 62 }; 63 64 enum ecore_override_force_load { 65 ECORE_OVERRIDE_FORCE_LOAD_NONE, 66 ECORE_OVERRIDE_FORCE_LOAD_ALWAYS, 67 ECORE_OVERRIDE_FORCE_LOAD_NEVER, 68 }; 69 70 struct ecore_drv_load_params { 71 /* Indicates whether the driver is running over a crash kernel. 72 * As part of the load request, this will be used for providing the 73 * driver role to the MFW. 74 * In case of a crash kernel over PDA - this should be set to false. 75 */ 76 bool is_crash_kernel; 77 78 /* The timeout value that the MFW should use when locking the engine for 79 * the driver load process. 80 * A value of '0' means the default value, and '255' means no timeout. 81 */ 82 u8 mfw_timeout_val; 83 #define ECORE_LOAD_REQ_LOCK_TO_DEFAULT 0 84 #define ECORE_LOAD_REQ_LOCK_TO_NONE 255 85 86 /* Action to take in case the MFW doesn't support timeout values other 87 * than default and none. 88 */ 89 enum ecore_mfw_timeout_fallback mfw_timeout_fallback; 90 91 /* Avoid engine reset when first PF loads on it */ 92 bool avoid_eng_reset; 93 94 /* Allow overriding the default force load behavior */ 95 enum ecore_override_force_load override_force_load; 96 }; 97 98 struct ecore_hw_init_params { 99 /* Tunneling parameters */ 100 struct ecore_tunnel_info *p_tunn; 101 102 bool b_hw_start; 103 104 /* Interrupt mode [msix, inta, etc.] to use */ 105 enum ecore_int_mode int_mode; 106 107 /* NPAR tx switching to be used for vports configured for tx-switching 108 */ 109 bool allow_npar_tx_switch; 110 111 /* Binary fw data pointer in binary fw file */ 112 const u8 *bin_fw_data; 113 114 /* Driver load parameters */ 115 struct ecore_drv_load_params *p_drv_load_params; 116 117 /* SPQ block timeout in msec */ 118 u32 spq_timeout_ms; 119 }; 120 121 /** 122 * @brief ecore_hw_init - 123 * 124 * @param p_dev 125 * @param p_params 126 * 127 * @return enum _ecore_status_t 128 */ 129 enum _ecore_status_t ecore_hw_init(struct ecore_dev *p_dev, 130 struct ecore_hw_init_params *p_params); 131 132 /** 133 * @brief ecore_hw_timers_stop_all - 134 * 135 * @param p_dev 136 * 137 * @return void 138 */ 139 void ecore_hw_timers_stop_all(struct ecore_dev *p_dev); 140 141 /** 142 * @brief ecore_hw_stop - 143 * 144 * @param p_dev 145 * 146 * @return enum _ecore_status_t 147 */ 148 enum _ecore_status_t ecore_hw_stop(struct ecore_dev *p_dev); 149 150 /** 151 * @brief ecore_hw_stop_fastpath -should be called incase 152 * slowpath is still required for the device, 153 * but fastpath is not. 154 * 155 * @param p_dev 156 * 157 * @return enum _ecore_status_t 158 */ 159 enum _ecore_status_t ecore_hw_stop_fastpath(struct ecore_dev *p_dev); 160 161 #ifndef LINUX_REMOVE 162 /** 163 * @brief ecore_prepare_hibernate -should be called when 164 * the system is going into the hibernate state 165 * 166 * @param p_dev 167 * 168 */ 169 void ecore_prepare_hibernate(struct ecore_dev *p_dev); 170 171 enum ecore_db_rec_width { 172 DB_REC_WIDTH_32B, 173 DB_REC_WIDTH_64B, 174 }; 175 176 enum ecore_db_rec_space { 177 DB_REC_KERNEL, 178 DB_REC_USER, 179 }; 180 181 /** 182 * @brief db_recovery_add - add doorbell information to the doorbell 183 * recovery mechanism. 184 * 185 * @param p_dev 186 * @param db_addr - doorbell address 187 * @param db_data - address of where db_data is stored 188 * @param db_width - doorbell is 32b pr 64b 189 * @param db_space - doorbell recovery addresses are user or kernel space 190 */ 191 enum _ecore_status_t ecore_db_recovery_add(struct ecore_dev *p_dev, 192 void OSAL_IOMEM *db_addr, 193 void *db_data, 194 enum ecore_db_rec_width db_width, 195 enum ecore_db_rec_space db_space); 196 197 /** 198 * @brief db_recovery_del - remove doorbell information from the doorbell 199 * recovery mechanism. db_data serves as key (db_addr is not unique). 200 * 201 * @param cdev 202 * @param db_addr - doorbell address 203 * @param db_data - address where db_data is stored. Serves as key for the 204 * entry to delete. 205 */ 206 enum _ecore_status_t ecore_db_recovery_del(struct ecore_dev *p_dev, 207 void OSAL_IOMEM *db_addr, 208 void *db_data); 209 210 static OSAL_INLINE bool ecore_is_mf_ufp(struct ecore_hwfn *p_hwfn) 211 { 212 return !!OSAL_TEST_BIT(ECORE_MF_UFP_SPECIFIC, &p_hwfn->p_dev->mf_bits); 213 } 214 215 #endif 216 217 /** 218 * @brief ecore_hw_start_fastpath -restart fastpath traffic, 219 * only if hw_stop_fastpath was called 220 221 * @param p_hwfn 222 * 223 * @return enum _ecore_status_t 224 */ 225 enum _ecore_status_t ecore_hw_start_fastpath(struct ecore_hwfn *p_hwfn); 226 227 enum ecore_hw_prepare_result { 228 ECORE_HW_PREPARE_SUCCESS, 229 230 /* FAILED results indicate probe has failed & cleaned up */ 231 ECORE_HW_PREPARE_FAILED_ENG2, 232 ECORE_HW_PREPARE_FAILED_ME, 233 ECORE_HW_PREPARE_FAILED_MEM, 234 ECORE_HW_PREPARE_FAILED_DEV, 235 ECORE_HW_PREPARE_FAILED_NVM, 236 237 /* BAD results indicate probe is passed even though some wrongness 238 * has occurred; Trying to actually use [I.e., hw_init()] might have 239 * dire reprecautions. 240 */ 241 ECORE_HW_PREPARE_BAD_IOV, 242 ECORE_HW_PREPARE_BAD_MCP, 243 ECORE_HW_PREPARE_BAD_IGU, 244 }; 245 246 struct ecore_hw_prepare_params { 247 /* Personality to initialize */ 248 int personality; 249 250 /* Force the driver's default resource allocation */ 251 bool drv_resc_alloc; 252 253 /* Check the reg_fifo after any register access */ 254 bool chk_reg_fifo; 255 256 /* Request the MFW to initiate PF FLR */ 257 bool initiate_pf_flr; 258 259 /* The OS Epoch time in seconds */ 260 u32 epoch; 261 262 /* Allow the MFW to collect a crash dump */ 263 bool allow_mdump; 264 265 /* Allow prepare to pass even if some initializations are failing. 266 * If set, the `p_prepare_res' field would be set with the return, 267 * and might allow probe to pass even if there are certain issues. 268 */ 269 bool b_relaxed_probe; 270 enum ecore_hw_prepare_result p_relaxed_res; 271 272 /* Enable/disable request by ecore client for pacing */ 273 bool b_en_pacing; 274 }; 275 276 /** 277 * @brief ecore_hw_prepare - 278 * 279 * @param p_dev 280 * @param p_params 281 * 282 * @return enum _ecore_status_t 283 */ 284 enum _ecore_status_t ecore_hw_prepare(struct ecore_dev *p_dev, 285 struct ecore_hw_prepare_params *p_params); 286 287 /** 288 * @brief ecore_hw_remove - 289 * 290 * @param p_dev 291 */ 292 void ecore_hw_remove(struct ecore_dev *p_dev); 293 294 /** 295 * @brief ecore_ptt_acquire - Allocate a PTT window 296 * 297 * Should be called at the entry point to the driver (at the beginning of an 298 * exported function) 299 * 300 * @param p_hwfn 301 * 302 * @return struct ecore_ptt 303 */ 304 struct ecore_ptt *ecore_ptt_acquire(struct ecore_hwfn *p_hwfn); 305 306 /** 307 * @brief ecore_ptt_release - Release PTT Window 308 * 309 * Should be called at the end of a flow - at the end of the function that 310 * acquired the PTT. 311 * 312 * 313 * @param p_hwfn 314 * @param p_ptt 315 */ 316 void ecore_ptt_release(struct ecore_hwfn *p_hwfn, 317 struct ecore_ptt *p_ptt); 318 319 struct ecore_eth_stats_common { 320 u64 no_buff_discards; 321 u64 packet_too_big_discard; 322 u64 ttl0_discard; 323 u64 rx_ucast_bytes; 324 u64 rx_mcast_bytes; 325 u64 rx_bcast_bytes; 326 u64 rx_ucast_pkts; 327 u64 rx_mcast_pkts; 328 u64 rx_bcast_pkts; 329 u64 mftag_filter_discards; 330 u64 mac_filter_discards; 331 u64 tx_ucast_bytes; 332 u64 tx_mcast_bytes; 333 u64 tx_bcast_bytes; 334 u64 tx_ucast_pkts; 335 u64 tx_mcast_pkts; 336 u64 tx_bcast_pkts; 337 u64 tx_err_drop_pkts; 338 u64 tpa_coalesced_pkts; 339 u64 tpa_coalesced_events; 340 u64 tpa_aborts_num; 341 u64 tpa_not_coalesced_pkts; 342 u64 tpa_coalesced_bytes; 343 344 /* port */ 345 u64 rx_64_byte_packets; 346 u64 rx_65_to_127_byte_packets; 347 u64 rx_128_to_255_byte_packets; 348 u64 rx_256_to_511_byte_packets; 349 u64 rx_512_to_1023_byte_packets; 350 u64 rx_1024_to_1518_byte_packets; 351 u64 rx_crc_errors; 352 u64 rx_mac_crtl_frames; 353 u64 rx_pause_frames; 354 u64 rx_pfc_frames; 355 u64 rx_align_errors; 356 u64 rx_carrier_errors; 357 u64 rx_oversize_packets; 358 u64 rx_jabbers; 359 u64 rx_undersize_packets; 360 u64 rx_fragments; 361 u64 tx_64_byte_packets; 362 u64 tx_65_to_127_byte_packets; 363 u64 tx_128_to_255_byte_packets; 364 u64 tx_256_to_511_byte_packets; 365 u64 tx_512_to_1023_byte_packets; 366 u64 tx_1024_to_1518_byte_packets; 367 u64 tx_pause_frames; 368 u64 tx_pfc_frames; 369 u64 brb_truncates; 370 u64 brb_discards; 371 u64 rx_mac_bytes; 372 u64 rx_mac_uc_packets; 373 u64 rx_mac_mc_packets; 374 u64 rx_mac_bc_packets; 375 u64 rx_mac_frames_ok; 376 u64 tx_mac_bytes; 377 u64 tx_mac_uc_packets; 378 u64 tx_mac_mc_packets; 379 u64 tx_mac_bc_packets; 380 u64 tx_mac_ctrl_frames; 381 u64 link_change_count; 382 }; 383 384 struct ecore_eth_stats_bb { 385 u64 rx_1519_to_1522_byte_packets; 386 u64 rx_1519_to_2047_byte_packets; 387 u64 rx_2048_to_4095_byte_packets; 388 u64 rx_4096_to_9216_byte_packets; 389 u64 rx_9217_to_16383_byte_packets; 390 u64 tx_1519_to_2047_byte_packets; 391 u64 tx_2048_to_4095_byte_packets; 392 u64 tx_4096_to_9216_byte_packets; 393 u64 tx_9217_to_16383_byte_packets; 394 u64 tx_lpi_entry_count; 395 u64 tx_total_collisions; 396 }; 397 398 struct ecore_eth_stats_ah { 399 u64 rx_1519_to_max_byte_packets; 400 u64 tx_1519_to_max_byte_packets; 401 }; 402 403 struct ecore_eth_stats { 404 struct ecore_eth_stats_common common; 405 union { 406 struct ecore_eth_stats_bb bb; 407 struct ecore_eth_stats_ah ah; 408 }; 409 }; 410 411 enum ecore_dmae_address_type_t { 412 ECORE_DMAE_ADDRESS_HOST_VIRT, 413 ECORE_DMAE_ADDRESS_HOST_PHYS, 414 ECORE_DMAE_ADDRESS_GRC 415 }; 416 417 /* value of flags If ECORE_DMAE_FLAG_RW_REPL_SRC flag is set and the 418 * source is a block of length DMAE_MAX_RW_SIZE and the 419 * destination is larger, the source block will be duplicated as 420 * many times as required to fill the destination block. This is 421 * used mostly to write a zeroed buffer to destination address 422 * using DMA 423 */ 424 #define ECORE_DMAE_FLAG_RW_REPL_SRC 0x00000001 425 #define ECORE_DMAE_FLAG_VF_SRC 0x00000002 426 #define ECORE_DMAE_FLAG_VF_DST 0x00000004 427 #define ECORE_DMAE_FLAG_COMPLETION_DST 0x00000008 428 429 struct ecore_dmae_params { 430 u32 flags; /* consists of ECORE_DMAE_FLAG_* values */ 431 u8 src_vfid; 432 u8 dst_vfid; 433 }; 434 435 /** 436 * @brief ecore_dmae_host2grc - copy data from source addr to 437 * dmae registers using the given ptt 438 * 439 * @param p_hwfn 440 * @param p_ptt 441 * @param source_addr 442 * @param grc_addr (dmae_data_offset) 443 * @param size_in_dwords 444 * @param flags (one of the flags defined above) 445 */ 446 enum _ecore_status_t 447 ecore_dmae_host2grc(struct ecore_hwfn *p_hwfn, 448 struct ecore_ptt *p_ptt, 449 u64 source_addr, 450 u32 grc_addr, 451 u32 size_in_dwords, 452 u32 flags); 453 454 /** 455 * @brief ecore_dmae_grc2host - Read data from dmae data offset 456 * to source address using the given ptt 457 * 458 * @param p_ptt 459 * @param grc_addr (dmae_data_offset) 460 * @param dest_addr 461 * @param size_in_dwords 462 * @param flags - one of the flags defined above 463 */ 464 enum _ecore_status_t 465 ecore_dmae_grc2host(struct ecore_hwfn *p_hwfn, 466 struct ecore_ptt *p_ptt, 467 u32 grc_addr, 468 dma_addr_t dest_addr, 469 u32 size_in_dwords, 470 u32 flags); 471 472 /** 473 * @brief ecore_dmae_host2host - copy data from to source address 474 * to a destination address (for SRIOV) using the given ptt 475 * 476 * @param p_hwfn 477 * @param p_ptt 478 * @param source_addr 479 * @param dest_addr 480 * @param size_in_dwords 481 * @param params 482 */ 483 enum _ecore_status_t 484 ecore_dmae_host2host(struct ecore_hwfn *p_hwfn, 485 struct ecore_ptt *p_ptt, 486 dma_addr_t source_addr, 487 dma_addr_t dest_addr, 488 u32 size_in_dwords, 489 struct ecore_dmae_params *p_params); 490 491 /** 492 * @brief ecore_chain_alloc - Allocate and initialize a chain 493 * 494 * @param p_hwfn 495 * @param intended_use 496 * @param mode 497 * @param num_elems 498 * @param elem_size 499 * @param p_chain 500 * 501 * @return enum _ecore_status_t 502 */ 503 enum _ecore_status_t 504 ecore_chain_alloc(struct ecore_dev *p_dev, 505 enum ecore_chain_use_mode intended_use, 506 enum ecore_chain_mode mode, 507 enum ecore_chain_cnt_type cnt_type, 508 u32 num_elems, 509 osal_size_t elem_size, 510 struct ecore_chain *p_chain, 511 struct ecore_chain_ext_pbl *ext_pbl); 512 513 /** 514 * @brief ecore_chain_free - Free chain DMA memory 515 * 516 * @param p_hwfn 517 * @param p_chain 518 */ 519 void ecore_chain_free(struct ecore_dev *p_dev, 520 struct ecore_chain *p_chain); 521 522 /** 523 * @@brief ecore_fw_l2_queue - Get absolute L2 queue ID 524 * 525 * @param p_hwfn 526 * @param src_id - relative to p_hwfn 527 * @param dst_id - absolute per engine 528 * 529 * @return enum _ecore_status_t 530 */ 531 enum _ecore_status_t ecore_fw_l2_queue(struct ecore_hwfn *p_hwfn, 532 u16 src_id, 533 u16 *dst_id); 534 535 /** 536 * @@brief ecore_fw_vport - Get absolute vport ID 537 * 538 * @param p_hwfn 539 * @param src_id - relative to p_hwfn 540 * @param dst_id - absolute per engine 541 * 542 * @return enum _ecore_status_t 543 */ 544 enum _ecore_status_t ecore_fw_vport(struct ecore_hwfn *p_hwfn, 545 u8 src_id, 546 u8 *dst_id); 547 548 /** 549 * @@brief ecore_fw_rss_eng - Get absolute RSS engine ID 550 * 551 * @param p_hwfn 552 * @param src_id - relative to p_hwfn 553 * @param dst_id - absolute per engine 554 * 555 * @return enum _ecore_status_t 556 */ 557 enum _ecore_status_t ecore_fw_rss_eng(struct ecore_hwfn *p_hwfn, 558 u8 src_id, 559 u8 *dst_id); 560 561 /** 562 * @brief ecore_llh_add_mac_filter - configures a MAC filter in llh 563 * 564 * @param p_hwfn 565 * @param p_ptt 566 * @param p_filter - MAC to add 567 */ 568 enum _ecore_status_t ecore_llh_add_mac_filter(struct ecore_hwfn *p_hwfn, 569 struct ecore_ptt *p_ptt, 570 u8 *p_filter); 571 572 /** 573 * @brief ecore_llh_remove_mac_filter - removes a MAC filtre from llh 574 * 575 * @param p_hwfn 576 * @param p_ptt 577 * @param p_filter - MAC to remove 578 */ 579 void ecore_llh_remove_mac_filter(struct ecore_hwfn *p_hwfn, 580 struct ecore_ptt *p_ptt, 581 u8 *p_filter); 582 583 enum ecore_llh_port_filter_type_t { 584 ECORE_LLH_FILTER_ETHERTYPE, 585 ECORE_LLH_FILTER_TCP_SRC_PORT, 586 ECORE_LLH_FILTER_TCP_DEST_PORT, 587 ECORE_LLH_FILTER_TCP_SRC_AND_DEST_PORT, 588 ECORE_LLH_FILTER_UDP_SRC_PORT, 589 ECORE_LLH_FILTER_UDP_DEST_PORT, 590 ECORE_LLH_FILTER_UDP_SRC_AND_DEST_PORT 591 }; 592 593 /** 594 * @brief ecore_llh_add_protocol_filter - configures a protocol filter in llh 595 * 596 * @param p_hwfn 597 * @param p_ptt 598 * @param source_port_or_eth_type - source port or ethertype to add 599 * @param dest_port - destination port to add 600 * @param type - type of filters and comparing 601 */ 602 enum _ecore_status_t 603 ecore_llh_add_protocol_filter(struct ecore_hwfn *p_hwfn, 604 struct ecore_ptt *p_ptt, 605 u16 source_port_or_eth_type, 606 u16 dest_port, 607 enum ecore_llh_port_filter_type_t type); 608 609 /** 610 * @brief ecore_llh_remove_protocol_filter - remove a protocol filter in llh 611 * 612 * @param p_hwfn 613 * @param p_ptt 614 * @param source_port_or_eth_type - source port or ethertype to add 615 * @param dest_port - destination port to add 616 * @param type - type of filters and comparing 617 */ 618 void 619 ecore_llh_remove_protocol_filter(struct ecore_hwfn *p_hwfn, 620 struct ecore_ptt *p_ptt, 621 u16 source_port_or_eth_type, 622 u16 dest_port, 623 enum ecore_llh_port_filter_type_t type); 624 625 /** 626 * @brief ecore_llh_clear_all_filters - removes all MAC filters from llh 627 * 628 * @param p_hwfn 629 * @param p_ptt 630 */ 631 void ecore_llh_clear_all_filters(struct ecore_hwfn *p_hwfn, 632 struct ecore_ptt *p_ptt); 633 634 /** 635 * @brief ecore_llh_set_function_as_default - set function as default per port 636 * 637 * @param p_hwfn 638 * @param p_ptt 639 */ 640 enum _ecore_status_t 641 ecore_llh_set_function_as_default(struct ecore_hwfn *p_hwfn, 642 struct ecore_ptt *p_ptt); 643 644 /** 645 *@brief Cleanup of previous driver remains prior to load 646 * 647 * @param p_hwfn 648 * @param p_ptt 649 * @param id - For PF, engine-relative. For VF, PF-relative. 650 * @param is_vf - true iff cleanup is made for a VF. 651 * 652 * @return enum _ecore_status_t 653 */ 654 enum _ecore_status_t ecore_final_cleanup(struct ecore_hwfn *p_hwfn, 655 struct ecore_ptt *p_ptt, 656 u16 id, 657 bool is_vf); 658 659 /** 660 * @brief ecore_get_queue_coalesce - Retrieve coalesce value for a given queue. 661 * 662 * @param p_hwfn 663 * @param p_coal - store coalesce value read from the hardware. 664 * @param p_handle 665 * 666 * @return enum _ecore_status_t 667 **/ 668 enum _ecore_status_t 669 ecore_get_queue_coalesce(struct ecore_hwfn *p_hwfn, u16 *coal, 670 void *handle); 671 672 /** 673 * @brief ecore_set_queue_coalesce - Configure coalesce parameters for Rx and 674 * Tx queue. The fact that we can configure coalescing to up to 511, but on 675 * varying accuracy [the bigger the value the less accurate] up to a mistake 676 * of 3usec for the highest values. 677 * While the API allows setting coalescing per-qid, all queues sharing a SB 678 * should be in same range [i.e., either 0-0x7f, 0x80-0xff or 0x100-0x1ff] 679 * otherwise configuration would break. 680 * 681 * @param p_hwfn 682 * @param rx_coal - Rx Coalesce value in micro seconds. 683 * @param tx_coal - TX Coalesce value in micro seconds. 684 * @param p_handle 685 * 686 * @return enum _ecore_status_t 687 **/ 688 enum _ecore_status_t 689 ecore_set_queue_coalesce(struct ecore_hwfn *p_hwfn, u16 rx_coal, 690 u16 tx_coal, void *p_handle); 691 692 /** 693 * @brief ecore_pglueb_set_pfid_enable - Enable or disable PCI BUS MASTER 694 * 695 * @param p_hwfn 696 * @param p_ptt 697 * @param b_enable - true/false 698 * 699 * @return enum _ecore_status_t 700 */ 701 enum _ecore_status_t ecore_pglueb_set_pfid_enable(struct ecore_hwfn *p_hwfn, 702 struct ecore_ptt *p_ptt, 703 bool b_enable); 704 #endif 705