1 /* QLogic qed NIC Driver
2 * Copyright (c) 2015-2017 QLogic Corporation
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:
10 * Redistribution and use in source and binary forms, with or
11 * without modification, are permitted provided that the following
14 * - Redistributions of source code must retain the above
15 * copyright notice, this list of conditions and the following
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.
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
36 #include <linux/types.h>
37 #include <linux/delay.h>
38 #include <linux/slab.h>
39 #include <linux/spinlock.h>
42 struct qed_mcp_link_speed_params
{
44 u32 advertised_speeds
; /* bitmask of DRV_SPEED_CAPABILITY */
45 u32 forced_speed
; /* In Mb/s */
48 struct qed_mcp_link_pause_params
{
54 struct qed_mcp_link_params
{
55 struct qed_mcp_link_speed_params speed
;
56 struct qed_mcp_link_pause_params pause
;
60 struct qed_mcp_link_capabilities
{
61 u32 speed_capabilities
;
64 struct qed_mcp_link_state
{
69 /* Actual link speed in Mb/s */
72 /* PF max speed in Mb/s, deduced from line_speed
73 * according to PF max bandwidth configuration.
80 bool parallel_detection
;
83 #define QED_LINK_PARTNER_SPEED_1G_HD BIT(0)
84 #define QED_LINK_PARTNER_SPEED_1G_FD BIT(1)
85 #define QED_LINK_PARTNER_SPEED_10G BIT(2)
86 #define QED_LINK_PARTNER_SPEED_20G BIT(3)
87 #define QED_LINK_PARTNER_SPEED_25G BIT(4)
88 #define QED_LINK_PARTNER_SPEED_40G BIT(5)
89 #define QED_LINK_PARTNER_SPEED_50G BIT(6)
90 #define QED_LINK_PARTNER_SPEED_100G BIT(7)
91 u32 partner_adv_speed
;
93 bool partner_tx_flow_ctrl_en
;
94 bool partner_rx_flow_ctrl_en
;
96 #define QED_LINK_PARTNER_SYMMETRIC_PAUSE (1)
97 #define QED_LINK_PARTNER_ASYMMETRIC_PAUSE (2)
98 #define QED_LINK_PARTNER_BOTH_PAUSE (3)
104 struct qed_mcp_function_info
{
107 enum qed_pci_personality protocol
;
117 #define QED_MCP_VLAN_UNSET (0xffff)
123 struct qed_mcp_nvm_common
{
130 struct qed_mcp_drv_version
{
132 u8 name
[MCP_DRV_VER_STR_SIZE
- 4];
135 struct qed_mcp_lan_stats
{
141 struct qed_mcp_fcoe_stats
{
148 struct qed_mcp_iscsi_stats
{
155 struct qed_mcp_rdma_stats
{
162 enum qed_mcp_protocol_type
{
169 union qed_mcp_protocol_stats
{
170 struct qed_mcp_lan_stats lan_stats
;
171 struct qed_mcp_fcoe_stats fcoe_stats
;
172 struct qed_mcp_iscsi_stats iscsi_stats
;
173 struct qed_mcp_rdma_stats rdma_stats
;
176 enum qed_ov_eswitch
{
185 QED_OV_CLIENT_VENDOR_SPEC
188 enum qed_ov_driver_state
{
189 QED_OV_DRIVER_STATE_NOT_LOADED
,
190 QED_OV_DRIVER_STATE_DISABLED
,
191 QED_OV_DRIVER_STATE_ACTIVE
201 * @brief - returns the link params of the hw function
205 * @returns pointer to link params
207 struct qed_mcp_link_params
*qed_mcp_get_link_params(struct qed_hwfn
*);
210 * @brief - return the link state of the hw function
214 * @returns pointer to link state
216 struct qed_mcp_link_state
*qed_mcp_get_link_state(struct qed_hwfn
*);
219 * @brief - return the link capabilities of the hw function
223 * @returns pointer to link capabilities
225 struct qed_mcp_link_capabilities
226 *qed_mcp_get_link_capabilities(struct qed_hwfn
*p_hwfn
);
229 * @brief Request the MFW to set the the link according to 'link_input'.
233 * @param b_up - raise link if `true'. Reset link if `false'.
237 int qed_mcp_set_link(struct qed_hwfn
*p_hwfn
,
238 struct qed_ptt
*p_ptt
,
242 * @brief Get the management firmware version value
246 * @param p_mfw_ver - mfw version value
247 * @param p_running_bundle_id - image id in nvram; Optional.
249 * @return int - 0 - operation was successful.
251 int qed_mcp_get_mfw_ver(struct qed_hwfn
*p_hwfn
,
252 struct qed_ptt
*p_ptt
,
253 u32
*p_mfw_ver
, u32
*p_running_bundle_id
);
256 * @brief Get media type value of the port.
258 * @param cdev - qed dev pointer
259 * @param mfw_ver - media type value
262 * 0 - Operation was successul.
263 * -EBUSY - Operation failed
265 int qed_mcp_get_media_type(struct qed_dev
*cdev
,
269 * @brief General function for sending commands to the MCP
270 * mailbox. It acquire mutex lock for the entire
271 * operation, from sending the request until the MCP
272 * response. Waiting for MCP response will be checked up
273 * to 5 seconds every 5ms.
275 * @param p_hwfn - hw function
276 * @param p_ptt - PTT required for register access
277 * @param cmd - command to be sent to the MCP.
278 * @param param - Optional param
279 * @param o_mcp_resp - The MCP response code (exclude sequence).
280 * @param o_mcp_param- Optional parameter provided by the MCP
282 * @return int - 0 - operation
285 int qed_mcp_cmd(struct qed_hwfn
*p_hwfn
,
286 struct qed_ptt
*p_ptt
,
293 * @brief - drains the nig, allowing completion to pass in case of pauses.
294 * (Should be called only from sleepable context)
299 int qed_mcp_drain(struct qed_hwfn
*p_hwfn
,
300 struct qed_ptt
*p_ptt
);
303 * @brief Get the flash size value
307 * @param p_flash_size - flash size in bytes to be filled.
309 * @return int - 0 - operation was successul.
311 int qed_mcp_get_flash_size(struct qed_hwfn
*p_hwfn
,
312 struct qed_ptt
*p_ptt
,
316 * @brief Send driver version to MFW
320 * @param version - Version value
321 * @param name - Protocol driver name
323 * @return int - 0 - operation was successul.
326 qed_mcp_send_drv_version(struct qed_hwfn
*p_hwfn
,
327 struct qed_ptt
*p_ptt
,
328 struct qed_mcp_drv_version
*p_ver
);
331 * @brief Notify MFW about the change in base device properties
335 * @param client - qed client type
337 * @return int - 0 - operation was successful.
339 int qed_mcp_ov_update_current_config(struct qed_hwfn
*p_hwfn
,
340 struct qed_ptt
*p_ptt
,
341 enum qed_ov_client client
);
344 * @brief Notify MFW about the driver state
348 * @param drv_state - Driver state
350 * @return int - 0 - operation was successful.
352 int qed_mcp_ov_update_driver_state(struct qed_hwfn
*p_hwfn
,
353 struct qed_ptt
*p_ptt
,
354 enum qed_ov_driver_state drv_state
);
357 * @brief Send MTU size to MFW
361 * @param mtu - MTU size
363 * @return int - 0 - operation was successful.
365 int qed_mcp_ov_update_mtu(struct qed_hwfn
*p_hwfn
,
366 struct qed_ptt
*p_ptt
, u16 mtu
);
369 * @brief Send MAC address to MFW
373 * @param mac - MAC address
375 * @return int - 0 - operation was successful.
377 int qed_mcp_ov_update_mac(struct qed_hwfn
*p_hwfn
,
378 struct qed_ptt
*p_ptt
, u8
*mac
);
381 * @brief Send WOL mode to MFW
385 * @param wol - WOL mode
387 * @return int - 0 - operation was successful.
389 int qed_mcp_ov_update_wol(struct qed_hwfn
*p_hwfn
,
390 struct qed_ptt
*p_ptt
,
391 enum qed_ov_wol wol
);
394 * @brief Set LED status
398 * @param mode - LED mode
400 * @return int - 0 - operation was successful.
402 int qed_mcp_set_led(struct qed_hwfn
*p_hwfn
,
403 struct qed_ptt
*p_ptt
,
404 enum qed_led_mode mode
);
407 * @brief Read from nvm
410 * @param addr - nvm offset
411 * @param p_buf - nvm read buffer
412 * @param len - buffer len
414 * @return int - 0 - operation was successful.
416 int qed_mcp_nvm_read(struct qed_dev
*cdev
, u32 addr
, u8
*p_buf
, u32 len
);
419 * @brief Bist register test
421 * @param p_hwfn - hw function
422 * @param p_ptt - PTT required for register access
424 * @return int - 0 - operation was successful.
426 int qed_mcp_bist_register_test(struct qed_hwfn
*p_hwfn
,
427 struct qed_ptt
*p_ptt
);
430 * @brief Bist clock test
432 * @param p_hwfn - hw function
433 * @param p_ptt - PTT required for register access
435 * @return int - 0 - operation was successful.
437 int qed_mcp_bist_clock_test(struct qed_hwfn
*p_hwfn
,
438 struct qed_ptt
*p_ptt
);
441 * @brief Bist nvm test - get number of images
443 * @param p_hwfn - hw function
444 * @param p_ptt - PTT required for register access
445 * @param num_images - number of images if operation was
446 * successful. 0 if not.
448 * @return int - 0 - operation was successful.
450 int qed_mcp_bist_nvm_test_get_num_images(struct qed_hwfn
*p_hwfn
,
451 struct qed_ptt
*p_ptt
,
455 * @brief Bist nvm test - get image attributes by index
457 * @param p_hwfn - hw function
458 * @param p_ptt - PTT required for register access
459 * @param p_image_att - Attributes of image
460 * @param image_index - Index of image to get information for
462 * @return int - 0 - operation was successful.
464 int qed_mcp_bist_nvm_test_get_image_att(struct qed_hwfn
*p_hwfn
,
465 struct qed_ptt
*p_ptt
,
466 struct bist_nvm_image_att
*p_image_att
,
469 /* Using hwfn number (and not pf_num) is required since in CMT mode,
470 * same pf_num may be used by two different hwfn
471 * TODO - this shouldn't really be in .h file, but until all fields
472 * required during hw-init will be placed in their correct place in shmem
473 * we need it in qed_dev.c [for readin the nvram reflection in shmem].
475 #define MCP_PF_ID_BY_REL(p_hwfn, rel_pfid) (QED_IS_BB((p_hwfn)->cdev) ? \
477 ((p_hwfn)->abs_pf_id & 1) << 3) : \
479 #define MCP_PF_ID(p_hwfn) MCP_PF_ID_BY_REL(p_hwfn, (p_hwfn)->rel_pf_id)
481 /* TODO - this is only correct as long as only BB is supported, and
482 * no port-swapping is implemented; Afterwards we'll need to fix it.
484 #define MFW_PORT(_p_hwfn) ((_p_hwfn)->abs_pf_id % \
485 ((_p_hwfn)->cdev->num_ports_in_engines * 2))
486 struct qed_mcp_info
{
488 bool block_mb_sending
;
495 struct qed_mcp_link_params link_input
;
496 struct qed_mcp_link_state link_output
;
497 struct qed_mcp_link_capabilities link_capabilities
;
498 struct qed_mcp_function_info func_info
;
505 struct qed_mcp_mb_params
{
508 union drv_union_data
*p_data_src
;
509 union drv_union_data
*p_data_dst
;
515 * @brief Initialize the interface with the MCP
517 * @param p_hwfn - HW func
518 * @param p_ptt - PTT required for register access
522 int qed_mcp_cmd_init(struct qed_hwfn
*p_hwfn
,
523 struct qed_ptt
*p_ptt
);
526 * @brief Initialize the port interface with the MCP
530 * Can only be called after `num_ports_in_engines' is set
532 void qed_mcp_cmd_port_init(struct qed_hwfn
*p_hwfn
,
533 struct qed_ptt
*p_ptt
);
535 * @brief Releases resources allocated during the init process.
537 * @param p_hwfn - HW func
538 * @param p_ptt - PTT required for register access
543 int qed_mcp_free(struct qed_hwfn
*p_hwfn
);
546 * @brief This function is called from the DPC context. After
547 * pointing PTT to the mfw mb, check for events sent by the MCP
548 * to the driver and ack them. In case a critical event
549 * detected, it will be handled here, otherwise the work will be
550 * queued to a sleepable work-queue.
552 * @param p_hwfn - HW function
553 * @param p_ptt - PTT required for register access
554 * @return int - 0 - operation
557 int qed_mcp_handle_events(struct qed_hwfn
*p_hwfn
,
558 struct qed_ptt
*p_ptt
);
561 * @brief Sends a LOAD_REQ to the MFW, and in case operation
562 * succeed, returns whether this PF is the first on the
563 * chip/engine/port or function. This function should be
564 * called when driver is ready to accept MFW events after
565 * Storms initializations are done.
567 * @param p_hwfn - hw function
568 * @param p_ptt - PTT required for register access
569 * @param p_load_code - The MCP response param containing one
571 * FW_MSG_CODE_DRV_LOAD_ENGINE
572 * FW_MSG_CODE_DRV_LOAD_PORT
573 * FW_MSG_CODE_DRV_LOAD_FUNCTION
575 * 0 - Operation was successul.
576 * -EBUSY - Operation failed
578 int qed_mcp_load_req(struct qed_hwfn
*p_hwfn
,
579 struct qed_ptt
*p_ptt
,
583 * @brief Read the MFW mailbox into Current buffer.
588 void qed_mcp_read_mb(struct qed_hwfn
*p_hwfn
,
589 struct qed_ptt
*p_ptt
);
592 * @brief Ack to mfw that driver finished FLR process for VFs
596 * @param vfs_to_ack - bit mask of all engine VFs for which the PF acks.
598 * @param return int - 0 upon success.
600 int qed_mcp_ack_vf_flr(struct qed_hwfn
*p_hwfn
,
601 struct qed_ptt
*p_ptt
, u32
*vfs_to_ack
);
604 * @brief - calls during init to read shmem of all function-related info.
608 * @param return 0 upon success.
610 int qed_mcp_fill_shmem_func_info(struct qed_hwfn
*p_hwfn
,
611 struct qed_ptt
*p_ptt
);
614 * @brief - Reset the MCP using mailbox command.
619 * @param return 0 upon success.
621 int qed_mcp_reset(struct qed_hwfn
*p_hwfn
,
622 struct qed_ptt
*p_ptt
);
625 * @brief - Sends an NVM read command request to the MFW to get
630 * @param cmd - Command: DRV_MSG_CODE_NVM_GET_FILE_DATA or
631 * DRV_MSG_CODE_NVM_READ_NVRAM commands
632 * @param param - [0:23] - Offset [24:31] - Size
633 * @param o_mcp_resp - MCP response
634 * @param o_mcp_param - MCP response param
635 * @param o_txn_size - Buffer size output
636 * @param o_buf - Pointer to the buffer returned by the MFW.
638 * @param return 0 upon success.
640 int qed_mcp_nvm_rd_cmd(struct qed_hwfn
*p_hwfn
,
641 struct qed_ptt
*p_ptt
,
645 u32
*o_mcp_param
, u32
*o_txn_size
, u32
*o_buf
);
648 * @brief indicates whether the MFW objects [under mcp_info] are accessible
652 * @return true iff MFW is running and mcp_info is initialized
654 bool qed_mcp_is_init(struct qed_hwfn
*p_hwfn
);
657 * @brief request MFW to configure MSI-X for a VF
661 * @param vf_id - absolute inside engine
662 * @param num_sbs - number of entries to request
666 int qed_mcp_config_vf_msix(struct qed_hwfn
*p_hwfn
,
667 struct qed_ptt
*p_ptt
, u8 vf_id
, u8 num
);
670 * @brief - Halt the MCP.
675 * @param return 0 upon success.
677 int qed_mcp_halt(struct qed_hwfn
*p_hwfn
, struct qed_ptt
*p_ptt
);
680 * @brief - Wake up the MCP.
685 * @param return 0 upon success.
687 int qed_mcp_resume(struct qed_hwfn
*p_hwfn
, struct qed_ptt
*p_ptt
);
689 int qed_configure_pf_min_bandwidth(struct qed_dev
*cdev
, u8 min_bw
);
690 int qed_configure_pf_max_bandwidth(struct qed_dev
*cdev
, u8 max_bw
);
691 int __qed_configure_pf_max_bandwidth(struct qed_hwfn
*p_hwfn
,
692 struct qed_ptt
*p_ptt
,
693 struct qed_mcp_link_state
*p_link
,
695 int __qed_configure_pf_min_bandwidth(struct qed_hwfn
*p_hwfn
,
696 struct qed_ptt
*p_ptt
,
697 struct qed_mcp_link_state
*p_link
,
700 int qed_mcp_mask_parities(struct qed_hwfn
*p_hwfn
,
701 struct qed_ptt
*p_ptt
, u32 mask_parities
);
704 * @brief Send eswitch mode to MFW
708 * @param eswitch - eswitch mode
710 * @return int - 0 - operation was successful.
712 int qed_mcp_ov_update_eswitch(struct qed_hwfn
*p_hwfn
,
713 struct qed_ptt
*p_ptt
,
714 enum qed_ov_eswitch eswitch
);
717 * @brief - Gets the MFW allocation info for the given resource
721 * @param p_resc_info - descriptor of requested resource
725 * @return int - 0 - operation was successful.
727 int qed_mcp_get_resc_info(struct qed_hwfn
*p_hwfn
,
728 struct qed_ptt
*p_ptt
,
729 struct resource_info
*p_resc_info
,
730 u32
*p_mcp_resp
, u32
*p_mcp_param
);