xref: /openbmc/linux/drivers/net/ethernet/qlogic/qed/qed_mcp.h (revision e33bbe69149b802c0c77bfb822685772f85388ca)
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 /**
217  * @brief - returns the link params of the hw function
218  *
219  * @param p_hwfn
220  *
221  * @returns pointer to link params
222  */
223 struct qed_mcp_link_params *qed_mcp_get_link_params(struct qed_hwfn *);
224 
225 /**
226  * @brief - return the link state of the hw function
227  *
228  * @param p_hwfn
229  *
230  * @returns pointer to link state
231  */
232 struct qed_mcp_link_state *qed_mcp_get_link_state(struct qed_hwfn *);
233 
234 /**
235  * @brief - return the link capabilities of the hw function
236  *
237  * @param p_hwfn
238  *
239  * @returns pointer to link capabilities
240  */
241 struct qed_mcp_link_capabilities
242 	*qed_mcp_get_link_capabilities(struct qed_hwfn *p_hwfn);
243 
244 /**
245  * @brief Request the MFW to set the the link according to 'link_input'.
246  *
247  * @param p_hwfn
248  * @param p_ptt
249  * @param b_up - raise link if `true'. Reset link if `false'.
250  *
251  * @return int
252  */
253 int qed_mcp_set_link(struct qed_hwfn   *p_hwfn,
254 		     struct qed_ptt     *p_ptt,
255 		     bool               b_up);
256 
257 /**
258  * @brief Get the management firmware version value
259  *
260  * @param p_hwfn
261  * @param p_ptt
262  * @param p_mfw_ver    - mfw version value
263  * @param p_running_bundle_id	- image id in nvram; Optional.
264  *
265  * @return int - 0 - operation was successful.
266  */
267 int qed_mcp_get_mfw_ver(struct qed_hwfn *p_hwfn,
268 			struct qed_ptt *p_ptt,
269 			u32 *p_mfw_ver, u32 *p_running_bundle_id);
270 
271 /**
272  * @brief Get the MBI version value
273  *
274  * @param p_hwfn
275  * @param p_ptt
276  * @param p_mbi_ver - A pointer to a variable to be filled with the MBI version.
277  *
278  * @return int - 0 - operation was successful.
279  */
280 int qed_mcp_get_mbi_ver(struct qed_hwfn *p_hwfn,
281 			struct qed_ptt *p_ptt, u32 *p_mbi_ver);
282 
283 /**
284  * @brief Get media type value of the port.
285  *
286  * @param cdev      - qed dev pointer
287  * @param mfw_ver    - media type value
288  *
289  * @return int -
290  *      0 - Operation was successul.
291  *      -EBUSY - Operation failed
292  */
293 int qed_mcp_get_media_type(struct qed_dev      *cdev,
294 			   u32                  *media_type);
295 
296 /**
297  * @brief General function for sending commands to the MCP
298  *        mailbox. It acquire mutex lock for the entire
299  *        operation, from sending the request until the MCP
300  *        response. Waiting for MCP response will be checked up
301  *        to 5 seconds every 5ms.
302  *
303  * @param p_hwfn     - hw function
304  * @param p_ptt      - PTT required for register access
305  * @param cmd        - command to be sent to the MCP.
306  * @param param      - Optional param
307  * @param o_mcp_resp - The MCP response code (exclude sequence).
308  * @param o_mcp_param- Optional parameter provided by the MCP
309  *                     response
310  * @return int - 0 - operation
311  * was successul.
312  */
313 int qed_mcp_cmd(struct qed_hwfn *p_hwfn,
314 		struct qed_ptt *p_ptt,
315 		u32 cmd,
316 		u32 param,
317 		u32 *o_mcp_resp,
318 		u32 *o_mcp_param);
319 
320 /**
321  * @brief - drains the nig, allowing completion to pass in case of pauses.
322  *          (Should be called only from sleepable context)
323  *
324  * @param p_hwfn
325  * @param p_ptt
326  */
327 int qed_mcp_drain(struct qed_hwfn *p_hwfn,
328 		  struct qed_ptt *p_ptt);
329 
330 /**
331  * @brief Get the flash size value
332  *
333  * @param p_hwfn
334  * @param p_ptt
335  * @param p_flash_size  - flash size in bytes to be filled.
336  *
337  * @return int - 0 - operation was successul.
338  */
339 int qed_mcp_get_flash_size(struct qed_hwfn     *p_hwfn,
340 			   struct qed_ptt       *p_ptt,
341 			   u32 *p_flash_size);
342 
343 /**
344  * @brief Send driver version to MFW
345  *
346  * @param p_hwfn
347  * @param p_ptt
348  * @param version - Version value
349  * @param name - Protocol driver name
350  *
351  * @return int - 0 - operation was successul.
352  */
353 int
354 qed_mcp_send_drv_version(struct qed_hwfn *p_hwfn,
355 			 struct qed_ptt *p_ptt,
356 			 struct qed_mcp_drv_version *p_ver);
357 
358 /**
359  * @brief Notify MFW about the change in base device properties
360  *
361  *  @param p_hwfn
362  *  @param p_ptt
363  *  @param client - qed client type
364  *
365  * @return int - 0 - operation was successful.
366  */
367 int qed_mcp_ov_update_current_config(struct qed_hwfn *p_hwfn,
368 				     struct qed_ptt *p_ptt,
369 				     enum qed_ov_client client);
370 
371 /**
372  * @brief Notify MFW about the driver state
373  *
374  *  @param p_hwfn
375  *  @param p_ptt
376  *  @param drv_state - Driver state
377  *
378  * @return int - 0 - operation was successful.
379  */
380 int qed_mcp_ov_update_driver_state(struct qed_hwfn *p_hwfn,
381 				   struct qed_ptt *p_ptt,
382 				   enum qed_ov_driver_state drv_state);
383 
384 /**
385  * @brief Send MTU size to MFW
386  *
387  *  @param p_hwfn
388  *  @param p_ptt
389  *  @param mtu - MTU size
390  *
391  * @return int - 0 - operation was successful.
392  */
393 int qed_mcp_ov_update_mtu(struct qed_hwfn *p_hwfn,
394 			  struct qed_ptt *p_ptt, u16 mtu);
395 
396 /**
397  * @brief Send MAC address to MFW
398  *
399  *  @param p_hwfn
400  *  @param p_ptt
401  *  @param mac - MAC address
402  *
403  * @return int - 0 - operation was successful.
404  */
405 int qed_mcp_ov_update_mac(struct qed_hwfn *p_hwfn,
406 			  struct qed_ptt *p_ptt, u8 *mac);
407 
408 /**
409  * @brief Send WOL mode to MFW
410  *
411  *  @param p_hwfn
412  *  @param p_ptt
413  *  @param wol - WOL mode
414  *
415  * @return int - 0 - operation was successful.
416  */
417 int qed_mcp_ov_update_wol(struct qed_hwfn *p_hwfn,
418 			  struct qed_ptt *p_ptt,
419 			  enum qed_ov_wol wol);
420 
421 /**
422  * @brief Set LED status
423  *
424  *  @param p_hwfn
425  *  @param p_ptt
426  *  @param mode - LED mode
427  *
428  * @return int - 0 - operation was successful.
429  */
430 int qed_mcp_set_led(struct qed_hwfn *p_hwfn,
431 		    struct qed_ptt *p_ptt,
432 		    enum qed_led_mode mode);
433 
434 /**
435  * @brief Read from nvm
436  *
437  *  @param cdev
438  *  @param addr - nvm offset
439  *  @param p_buf - nvm read buffer
440  *  @param len - buffer len
441  *
442  * @return int - 0 - operation was successful.
443  */
444 int qed_mcp_nvm_read(struct qed_dev *cdev, u32 addr, u8 *p_buf, u32 len);
445 
446 /**
447  * @brief Write to nvm
448  *
449  *  @param cdev
450  *  @param addr - nvm offset
451  *  @param cmd - nvm command
452  *  @param p_buf - nvm write buffer
453  *  @param len - buffer len
454  *
455  * @return int - 0 - operation was successful.
456  */
457 int qed_mcp_nvm_write(struct qed_dev *cdev,
458 		      u32 cmd, u32 addr, u8 *p_buf, u32 len);
459 
460 /**
461  * @brief Put file begin
462  *
463  *  @param cdev
464  *  @param addr - nvm offset
465  *
466  * @return int - 0 - operation was successful.
467  */
468 int qed_mcp_nvm_put_file_begin(struct qed_dev *cdev, u32 addr);
469 
470 /**
471  * @brief Check latest response
472  *
473  *  @param cdev
474  *  @param p_buf - nvm write buffer
475  *
476  * @return int - 0 - operation was successful.
477  */
478 int qed_mcp_nvm_resp(struct qed_dev *cdev, u8 *p_buf);
479 
480 struct qed_nvm_image_att {
481 	u32 start_addr;
482 	u32 length;
483 };
484 
485 /**
486  * @brief Allows reading a whole nvram image
487  *
488  * @param p_hwfn
489  * @param p_ptt
490  * @param image_id - image requested for reading
491  * @param p_buffer - allocated buffer into which to fill data
492  * @param buffer_len - length of the allocated buffer.
493  *
494  * @return 0 iff p_buffer now contains the nvram image.
495  */
496 int qed_mcp_get_nvm_image(struct qed_hwfn *p_hwfn,
497 			  struct qed_ptt *p_ptt,
498 			  enum qed_nvm_images image_id,
499 			  u8 *p_buffer, u32 buffer_len);
500 
501 /**
502  * @brief Bist register test
503  *
504  *  @param p_hwfn    - hw function
505  *  @param p_ptt     - PTT required for register access
506  *
507  * @return int - 0 - operation was successful.
508  */
509 int qed_mcp_bist_register_test(struct qed_hwfn *p_hwfn,
510 			       struct qed_ptt *p_ptt);
511 
512 /**
513  * @brief Bist clock test
514  *
515  *  @param p_hwfn    - hw function
516  *  @param p_ptt     - PTT required for register access
517  *
518  * @return int - 0 - operation was successful.
519  */
520 int qed_mcp_bist_clock_test(struct qed_hwfn *p_hwfn,
521 			    struct qed_ptt *p_ptt);
522 
523 /**
524  * @brief Bist nvm test - get number of images
525  *
526  *  @param p_hwfn       - hw function
527  *  @param p_ptt        - PTT required for register access
528  *  @param num_images   - number of images if operation was
529  *			  successful. 0 if not.
530  *
531  * @return int - 0 - operation was successful.
532  */
533 int qed_mcp_bist_nvm_get_num_images(struct qed_hwfn *p_hwfn,
534 				    struct qed_ptt *p_ptt,
535 				    u32 *num_images);
536 
537 /**
538  * @brief Bist nvm test - get image attributes by index
539  *
540  *  @param p_hwfn      - hw function
541  *  @param p_ptt       - PTT required for register access
542  *  @param p_image_att - Attributes of image
543  *  @param image_index - Index of image to get information for
544  *
545  * @return int - 0 - operation was successful.
546  */
547 int qed_mcp_bist_nvm_get_image_att(struct qed_hwfn *p_hwfn,
548 				   struct qed_ptt *p_ptt,
549 				   struct bist_nvm_image_att *p_image_att,
550 				   u32 image_index);
551 
552 /* Using hwfn number (and not pf_num) is required since in CMT mode,
553  * same pf_num may be used by two different hwfn
554  * TODO - this shouldn't really be in .h file, but until all fields
555  * required during hw-init will be placed in their correct place in shmem
556  * we need it in qed_dev.c [for readin the nvram reflection in shmem].
557  */
558 #define MCP_PF_ID_BY_REL(p_hwfn, rel_pfid) (QED_IS_BB((p_hwfn)->cdev) ?	       \
559 					    ((rel_pfid) |		       \
560 					     ((p_hwfn)->abs_pf_id & 1) << 3) : \
561 					    rel_pfid)
562 #define MCP_PF_ID(p_hwfn) MCP_PF_ID_BY_REL(p_hwfn, (p_hwfn)->rel_pf_id)
563 
564 #define MFW_PORT(_p_hwfn)       ((_p_hwfn)->abs_pf_id %			  \
565 				 ((_p_hwfn)->cdev->num_ports_in_engine * \
566 				  qed_device_num_engines((_p_hwfn)->cdev)))
567 
568 struct qed_mcp_info {
569 	/* List for mailbox commands which were sent and wait for a response */
570 	struct list_head			cmd_list;
571 
572 	/* Spinlock used for protecting the access to the mailbox commands list
573 	 * and the sending of the commands.
574 	 */
575 	spinlock_t				cmd_lock;
576 
577 	/* Spinlock used for syncing SW link-changes and link-changes
578 	 * originating from attention context.
579 	 */
580 	spinlock_t				link_lock;
581 	bool					block_mb_sending;
582 	u32					public_base;
583 	u32					drv_mb_addr;
584 	u32					mfw_mb_addr;
585 	u32					port_addr;
586 	u16					drv_mb_seq;
587 	u16					drv_pulse_seq;
588 	struct qed_mcp_link_params		link_input;
589 	struct qed_mcp_link_state		link_output;
590 	struct qed_mcp_link_capabilities	link_capabilities;
591 	struct qed_mcp_function_info		func_info;
592 	u8					*mfw_mb_cur;
593 	u8					*mfw_mb_shadow;
594 	u16					mfw_mb_length;
595 	u32					mcp_hist;
596 
597 	/* Capabilties negotiated with the MFW */
598 	u32					capabilities;
599 };
600 
601 struct qed_mcp_mb_params {
602 	u32			cmd;
603 	u32			param;
604 	void			*p_data_src;
605 	u8			data_src_size;
606 	void			*p_data_dst;
607 	u8			data_dst_size;
608 	u32			mcp_resp;
609 	u32			mcp_param;
610 };
611 
612 /**
613  * @brief Initialize the interface with the MCP
614  *
615  * @param p_hwfn - HW func
616  * @param p_ptt - PTT required for register access
617  *
618  * @return int
619  */
620 int qed_mcp_cmd_init(struct qed_hwfn *p_hwfn,
621 		     struct qed_ptt *p_ptt);
622 
623 /**
624  * @brief Initialize the port interface with the MCP
625  *
626  * @param p_hwfn
627  * @param p_ptt
628  * Can only be called after `num_ports_in_engines' is set
629  */
630 void qed_mcp_cmd_port_init(struct qed_hwfn *p_hwfn,
631 			   struct qed_ptt *p_ptt);
632 /**
633  * @brief Releases resources allocated during the init process.
634  *
635  * @param p_hwfn - HW func
636  * @param p_ptt - PTT required for register access
637  *
638  * @return int
639  */
640 
641 int qed_mcp_free(struct qed_hwfn *p_hwfn);
642 
643 /**
644  * @brief This function is called from the DPC context. After
645  * pointing PTT to the mfw mb, check for events sent by the MCP
646  * to the driver and ack them. In case a critical event
647  * detected, it will be handled here, otherwise the work will be
648  * queued to a sleepable work-queue.
649  *
650  * @param p_hwfn - HW function
651  * @param p_ptt - PTT required for register access
652  * @return int - 0 - operation
653  * was successul.
654  */
655 int qed_mcp_handle_events(struct qed_hwfn *p_hwfn,
656 			  struct qed_ptt *p_ptt);
657 
658 enum qed_drv_role {
659 	QED_DRV_ROLE_OS,
660 	QED_DRV_ROLE_KDUMP,
661 };
662 
663 struct qed_load_req_params {
664 	/* Input params */
665 	enum qed_drv_role drv_role;
666 	u8 timeout_val;
667 	bool avoid_eng_reset;
668 	enum qed_override_force_load override_force_load;
669 
670 	/* Output params */
671 	u32 load_code;
672 };
673 
674 /**
675  * @brief Sends a LOAD_REQ to the MFW, and in case the operation succeeds,
676  *        returns whether this PF is the first on the engine/port or function.
677  *
678  * @param p_hwfn
679  * @param p_ptt
680  * @param p_params
681  *
682  * @return int - 0 - Operation was successful.
683  */
684 int qed_mcp_load_req(struct qed_hwfn *p_hwfn,
685 		     struct qed_ptt *p_ptt,
686 		     struct qed_load_req_params *p_params);
687 
688 /**
689  * @brief Sends a UNLOAD_REQ message to the MFW
690  *
691  * @param p_hwfn
692  * @param p_ptt
693  *
694  * @return int - 0 - Operation was successful.
695  */
696 int qed_mcp_unload_req(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
697 
698 /**
699  * @brief Sends a UNLOAD_DONE message to the MFW
700  *
701  * @param p_hwfn
702  * @param p_ptt
703  *
704  * @return int - 0 - Operation was successful.
705  */
706 int qed_mcp_unload_done(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
707 
708 /**
709  * @brief Read the MFW mailbox into Current buffer.
710  *
711  * @param p_hwfn
712  * @param p_ptt
713  */
714 void qed_mcp_read_mb(struct qed_hwfn *p_hwfn,
715 		     struct qed_ptt *p_ptt);
716 
717 /**
718  * @brief Ack to mfw that driver finished FLR process for VFs
719  *
720  * @param p_hwfn
721  * @param p_ptt
722  * @param vfs_to_ack - bit mask of all engine VFs for which the PF acks.
723  *
724  * @param return int - 0 upon success.
725  */
726 int qed_mcp_ack_vf_flr(struct qed_hwfn *p_hwfn,
727 		       struct qed_ptt *p_ptt, u32 *vfs_to_ack);
728 
729 /**
730  * @brief - calls during init to read shmem of all function-related info.
731  *
732  * @param p_hwfn
733  *
734  * @param return 0 upon success.
735  */
736 int qed_mcp_fill_shmem_func_info(struct qed_hwfn *p_hwfn,
737 				 struct qed_ptt *p_ptt);
738 
739 /**
740  * @brief - Reset the MCP using mailbox command.
741  *
742  * @param p_hwfn
743  * @param p_ptt
744  *
745  * @param return 0 upon success.
746  */
747 int qed_mcp_reset(struct qed_hwfn *p_hwfn,
748 		  struct qed_ptt *p_ptt);
749 
750 /**
751  * @brief - Sends an NVM read command request to the MFW to get
752  *        a buffer.
753  *
754  * @param p_hwfn
755  * @param p_ptt
756  * @param cmd - Command: DRV_MSG_CODE_NVM_GET_FILE_DATA or
757  *            DRV_MSG_CODE_NVM_READ_NVRAM commands
758  * @param param - [0:23] - Offset [24:31] - Size
759  * @param o_mcp_resp - MCP response
760  * @param o_mcp_param - MCP response param
761  * @param o_txn_size -  Buffer size output
762  * @param o_buf - Pointer to the buffer returned by the MFW.
763  *
764  * @param return 0 upon success.
765  */
766 int qed_mcp_nvm_rd_cmd(struct qed_hwfn *p_hwfn,
767 		       struct qed_ptt *p_ptt,
768 		       u32 cmd,
769 		       u32 param,
770 		       u32 *o_mcp_resp,
771 		       u32 *o_mcp_param, u32 *o_txn_size, u32 *o_buf);
772 
773 /**
774  * @brief indicates whether the MFW objects [under mcp_info] are accessible
775  *
776  * @param p_hwfn
777  *
778  * @return true iff MFW is running and mcp_info is initialized
779  */
780 bool qed_mcp_is_init(struct qed_hwfn *p_hwfn);
781 
782 /**
783  * @brief request MFW to configure MSI-X for a VF
784  *
785  * @param p_hwfn
786  * @param p_ptt
787  * @param vf_id - absolute inside engine
788  * @param num_sbs - number of entries to request
789  *
790  * @return int
791  */
792 int qed_mcp_config_vf_msix(struct qed_hwfn *p_hwfn,
793 			   struct qed_ptt *p_ptt, u8 vf_id, u8 num);
794 
795 /**
796  * @brief - Halt the MCP.
797  *
798  * @param p_hwfn
799  * @param p_ptt
800  *
801  * @param return 0 upon success.
802  */
803 int qed_mcp_halt(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
804 
805 /**
806  * @brief - Wake up the MCP.
807  *
808  * @param p_hwfn
809  * @param p_ptt
810  *
811  * @param return 0 upon success.
812  */
813 int qed_mcp_resume(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
814 
815 int qed_configure_pf_min_bandwidth(struct qed_dev *cdev, u8 min_bw);
816 int qed_configure_pf_max_bandwidth(struct qed_dev *cdev, u8 max_bw);
817 int __qed_configure_pf_max_bandwidth(struct qed_hwfn *p_hwfn,
818 				     struct qed_ptt *p_ptt,
819 				     struct qed_mcp_link_state *p_link,
820 				     u8 max_bw);
821 int __qed_configure_pf_min_bandwidth(struct qed_hwfn *p_hwfn,
822 				     struct qed_ptt *p_ptt,
823 				     struct qed_mcp_link_state *p_link,
824 				     u8 min_bw);
825 
826 int qed_mcp_mask_parities(struct qed_hwfn *p_hwfn,
827 			  struct qed_ptt *p_ptt, u32 mask_parities);
828 
829 /**
830  * @brief - Sets the MFW's max value for the given resource
831  *
832  *  @param p_hwfn
833  *  @param p_ptt
834  *  @param res_id
835  *  @param resc_max_val
836  *  @param p_mcp_resp
837  *
838  * @return int - 0 - operation was successful.
839  */
840 int
841 qed_mcp_set_resc_max_val(struct qed_hwfn *p_hwfn,
842 			 struct qed_ptt *p_ptt,
843 			 enum qed_resources res_id,
844 			 u32 resc_max_val, u32 *p_mcp_resp);
845 
846 /**
847  * @brief - Gets the MFW allocation info for the given resource
848  *
849  *  @param p_hwfn
850  *  @param p_ptt
851  *  @param res_id
852  *  @param p_mcp_resp
853  *  @param p_resc_num
854  *  @param p_resc_start
855  *
856  * @return int - 0 - operation was successful.
857  */
858 int
859 qed_mcp_get_resc_info(struct qed_hwfn *p_hwfn,
860 		      struct qed_ptt *p_ptt,
861 		      enum qed_resources res_id,
862 		      u32 *p_mcp_resp, u32 *p_resc_num, u32 *p_resc_start);
863 
864 /**
865  * @brief Send eswitch mode to MFW
866  *
867  *  @param p_hwfn
868  *  @param p_ptt
869  *  @param eswitch - eswitch mode
870  *
871  * @return int - 0 - operation was successful.
872  */
873 int qed_mcp_ov_update_eswitch(struct qed_hwfn *p_hwfn,
874 			      struct qed_ptt *p_ptt,
875 			      enum qed_ov_eswitch eswitch);
876 
877 #define QED_MCP_RESC_LOCK_MIN_VAL       RESOURCE_DUMP
878 #define QED_MCP_RESC_LOCK_MAX_VAL       31
879 
880 enum qed_resc_lock {
881 	QED_RESC_LOCK_DBG_DUMP = QED_MCP_RESC_LOCK_MIN_VAL,
882 	QED_RESC_LOCK_PTP_PORT0,
883 	QED_RESC_LOCK_PTP_PORT1,
884 	QED_RESC_LOCK_PTP_PORT2,
885 	QED_RESC_LOCK_PTP_PORT3,
886 	QED_RESC_LOCK_RESC_ALLOC = QED_MCP_RESC_LOCK_MAX_VAL,
887 	QED_RESC_LOCK_RESC_INVALID
888 };
889 
890 /**
891  * @brief - Initiates PF FLR
892  *
893  *  @param p_hwfn
894  *  @param p_ptt
895  *
896  * @return int - 0 - operation was successful.
897  */
898 int qed_mcp_initiate_pf_flr(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
899 struct qed_resc_lock_params {
900 	/* Resource number [valid values are 0..31] */
901 	u8 resource;
902 
903 	/* Lock timeout value in seconds [default, none or 1..254] */
904 	u8 timeout;
905 #define QED_MCP_RESC_LOCK_TO_DEFAULT    0
906 #define QED_MCP_RESC_LOCK_TO_NONE       255
907 
908 	/* Number of times to retry locking */
909 	u8 retry_num;
910 #define QED_MCP_RESC_LOCK_RETRY_CNT_DFLT        10
911 
912 	/* The interval in usec between retries */
913 	u16 retry_interval;
914 #define QED_MCP_RESC_LOCK_RETRY_VAL_DFLT        10000
915 
916 	/* Use sleep or delay between retries */
917 	bool sleep_b4_retry;
918 
919 	/* Will be set as true if the resource is free and granted */
920 	bool b_granted;
921 
922 	/* Will be filled with the resource owner.
923 	 * [0..15 = PF0-15, 16 = MFW]
924 	 */
925 	u8 owner;
926 };
927 
928 /**
929  * @brief Acquires MFW generic resource lock
930  *
931  *  @param p_hwfn
932  *  @param p_ptt
933  *  @param p_params
934  *
935  * @return int - 0 - operation was successful.
936  */
937 int
938 qed_mcp_resc_lock(struct qed_hwfn *p_hwfn,
939 		  struct qed_ptt *p_ptt, struct qed_resc_lock_params *p_params);
940 
941 struct qed_resc_unlock_params {
942 	/* Resource number [valid values are 0..31] */
943 	u8 resource;
944 
945 	/* Allow to release a resource even if belongs to another PF */
946 	bool b_force;
947 
948 	/* Will be set as true if the resource is released */
949 	bool b_released;
950 };
951 
952 /**
953  * @brief Releases MFW generic resource lock
954  *
955  *  @param p_hwfn
956  *  @param p_ptt
957  *  @param p_params
958  *
959  * @return int - 0 - operation was successful.
960  */
961 int
962 qed_mcp_resc_unlock(struct qed_hwfn *p_hwfn,
963 		    struct qed_ptt *p_ptt,
964 		    struct qed_resc_unlock_params *p_params);
965 
966 /**
967  * @brief - default initialization for lock/unlock resource structs
968  *
969  * @param p_lock - lock params struct to be initialized; Can be NULL
970  * @param p_unlock - unlock params struct to be initialized; Can be NULL
971  * @param resource - the requested resource
972  * @paral b_is_permanent - disable retries & aging when set
973  */
974 void qed_mcp_resc_lock_default_init(struct qed_resc_lock_params *p_lock,
975 				    struct qed_resc_unlock_params *p_unlock,
976 				    enum qed_resc_lock
977 				    resource, bool b_is_permanent);
978 /**
979  * @brief Learn of supported MFW features; To be done during early init
980  *
981  * @param p_hwfn
982  * @param p_ptt
983  */
984 int qed_mcp_get_capabilities(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
985 
986 /**
987  * @brief Inform MFW of set of features supported by driver. Should be done
988  * inside the content of the LOAD_REQ.
989  *
990  * @param p_hwfn
991  * @param p_ptt
992  */
993 int qed_mcp_set_capabilities(struct qed_hwfn *p_hwfn, struct qed_ptt *p_ptt);
994 
995 /**
996  * @brief Populate the nvm info shadow in the given hardware function
997  *
998  * @param p_hwfn
999  */
1000 int qed_mcp_nvm_info_populate(struct qed_hwfn *p_hwfn);
1001 
1002 #endif
1003