1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright(c) 1999 - 2018 Intel Corporation. */
3 
4 #ifndef _IXGBE_MBX_H_
5 #define _IXGBE_MBX_H_
6 
7 #include "ixgbe_type.h"
8 
9 #define IXGBE_VFMAILBOX_SIZE        16 /* 16 32 bit words - 64 bytes */
10 #define IXGBE_ERR_MBX               -100
11 
12 #define IXGBE_VFMAILBOX             0x002FC
13 #define IXGBE_VFMBMEM               0x00200
14 
15 #define IXGBE_PFMAILBOX_STS   0x00000001 /* Initiate message send to VF */
16 #define IXGBE_PFMAILBOX_ACK   0x00000002 /* Ack message recv'd from VF */
17 #define IXGBE_PFMAILBOX_VFU   0x00000004 /* VF owns the mailbox buffer */
18 #define IXGBE_PFMAILBOX_PFU   0x00000008 /* PF owns the mailbox buffer */
19 #define IXGBE_PFMAILBOX_RVFU  0x00000010 /* Reset VFU - used when VF stuck */
20 
21 #define IXGBE_MBVFICR_VFREQ_MASK 0x0000FFFF /* bits for VF messages */
22 #define IXGBE_MBVFICR_VFREQ_VF1  0x00000001 /* bit for VF 1 message */
23 #define IXGBE_MBVFICR_VFACK_MASK 0xFFFF0000 /* bits for VF acks */
24 #define IXGBE_MBVFICR_VFACK_VF1  0x00010000 /* bit for VF 1 ack */
25 
26 
27 /* If it's a IXGBE_VF_* msg then it originates in the VF and is sent to the
28  * PF.  The reverse is true if it is IXGBE_PF_*.
29  * Message ACK's are the value or'd with 0xF0000000
30  */
31 #define IXGBE_VT_MSGTYPE_ACK      0x80000000  /* Messages below or'd with
32 					       * this are the ACK */
33 #define IXGBE_VT_MSGTYPE_NACK     0x40000000  /* Messages below or'd with
34 					       * this are the NACK */
35 #define IXGBE_VT_MSGTYPE_CTS      0x20000000  /* Indicates that VF is still
36 						 clear to send requests */
37 #define IXGBE_VT_MSGINFO_SHIFT    16
38 /* bits 23:16 are used for exra info for certain messages */
39 #define IXGBE_VT_MSGINFO_MASK     (0xFF << IXGBE_VT_MSGINFO_SHIFT)
40 
41 /* definitions to support mailbox API version negotiation */
42 
43 /*
44  * Each element denotes a version of the API; existing numbers may not
45  * change; any additions must go at the end
46  */
47 enum ixgbe_pfvf_api_rev {
48 	ixgbe_mbox_api_10,	/* API version 1.0, linux/freebsd VF driver */
49 	ixgbe_mbox_api_20,	/* API version 2.0, solaris Phase1 VF driver */
50 	ixgbe_mbox_api_11,	/* API version 1.1, linux/freebsd VF driver */
51 	ixgbe_mbox_api_12,	/* API version 1.2, linux/freebsd VF driver */
52 	ixgbe_mbox_api_13,	/* API version 1.3, linux/freebsd VF driver */
53 	ixgbe_mbox_api_14,	/* API version 1.4, linux/freebsd VF driver */
54 	/* This value should always be last */
55 	ixgbe_mbox_api_unknown,	/* indicates that API version is not known */
56 };
57 
58 /* mailbox API, legacy requests */
59 #define IXGBE_VF_RESET            0x01 /* VF requests reset */
60 #define IXGBE_VF_SET_MAC_ADDR     0x02 /* VF requests PF to set MAC addr */
61 #define IXGBE_VF_SET_MULTICAST    0x03 /* VF requests PF to set MC addr */
62 #define IXGBE_VF_SET_VLAN         0x04 /* VF requests PF to set VLAN */
63 
64 /* mailbox API, version 1.0 VF requests */
65 #define IXGBE_VF_SET_LPE	0x05 /* VF requests PF to set VMOLR.LPE */
66 #define IXGBE_VF_SET_MACVLAN	0x06 /* VF requests PF for unicast filter */
67 #define IXGBE_VF_API_NEGOTIATE	0x08 /* negotiate API version */
68 
69 /* mailbox API, version 1.1 VF requests */
70 #define IXGBE_VF_GET_QUEUES	0x09 /* get queue configuration */
71 
72 /* GET_QUEUES return data indices within the mailbox */
73 #define IXGBE_VF_TX_QUEUES	1	/* number of Tx queues supported */
74 #define IXGBE_VF_RX_QUEUES	2	/* number of Rx queues supported */
75 #define IXGBE_VF_TRANS_VLAN	3	/* Indication of port vlan */
76 #define IXGBE_VF_DEF_QUEUE	4	/* Default queue offset */
77 
78 /* mailbox API, version 1.2 VF requests */
79 #define IXGBE_VF_GET_RETA	0x0a	/* VF request for RETA */
80 #define IXGBE_VF_GET_RSS_KEY	0x0b	/* get RSS key */
81 
82 #define IXGBE_VF_UPDATE_XCAST_MODE	0x0c
83 
84 /* mailbox API, version 1.4 VF requests */
85 #define IXGBE_VF_IPSEC_ADD	0x0d
86 #define IXGBE_VF_IPSEC_DEL	0x0e
87 
88 /* length of permanent address message returned from PF */
89 #define IXGBE_VF_PERMADDR_MSG_LEN 4
90 /* word in permanent address message with the current multicast type */
91 #define IXGBE_VF_MC_TYPE_WORD     3
92 
93 #define IXGBE_PF_CONTROL_MSG      0x0100 /* PF control message */
94 
95 #define IXGBE_VF_MBX_INIT_TIMEOUT 2000 /* number of retries on mailbox */
96 #define IXGBE_VF_MBX_INIT_DELAY   500  /* microseconds between retries */
97 
98 s32 ixgbe_read_mbx(struct ixgbe_hw *, u32 *, u16, u16);
99 s32 ixgbe_write_mbx(struct ixgbe_hw *, u32 *, u16, u16);
100 s32 ixgbe_check_for_msg(struct ixgbe_hw *, u16);
101 s32 ixgbe_check_for_ack(struct ixgbe_hw *, u16);
102 s32 ixgbe_check_for_rst(struct ixgbe_hw *, u16);
103 #ifdef CONFIG_PCI_IOV
104 void ixgbe_init_mbx_params_pf(struct ixgbe_hw *);
105 #endif /* CONFIG_PCI_IOV */
106 
107 extern const struct ixgbe_mbx_operations mbx_ops_generic;
108 
109 #endif /* _IXGBE_MBX_H_ */
110