31bdee1f7caadc20c11d2f0c0a3b7de8bf1a5a05
[dpdk.git] / drivers / net / qede / base / ecore_sriov.h
1 /*
2  * Copyright (c) 2016 QLogic Corporation.
3  * All rights reserved.
4  * www.qlogic.com
5  *
6  * See LICENSE.qede_pmd for copyright and licensing details.
7  */
8
9 #ifndef __ECORE_SRIOV_H__
10 #define __ECORE_SRIOV_H__
11
12 #include "ecore_status.h"
13 #include "ecore_vfpf_if.h"
14 #include "ecore_iov_api.h"
15 #include "ecore_hsi_common.h"
16 #include "ecore_l2.h"
17
18 #define ECORE_ETH_MAX_VF_NUM_VLAN_FILTERS \
19         (E4_MAX_NUM_VFS * ECORE_ETH_VF_NUM_VLAN_FILTERS)
20
21 /* Represents a full message. Both the request filled by VF
22  * and the response filled by the PF. The VF needs one copy
23  * of this message, it fills the request part and sends it to
24  * the PF. The PF will copy the response to the response part for
25  * the VF to later read it. The PF needs to hold a message like this
26  * per VF, the request that is copied to the PF is placed in the
27  * request size, and the response is filled by the PF before sending
28  * it to the VF.
29  */
30 struct ecore_vf_mbx_msg {
31         union vfpf_tlvs req;
32         union pfvf_tlvs resp;
33 };
34
35 /* This mailbox is maintained per VF in its PF
36  * contains all information required for sending / receiving
37  * a message
38  */
39 struct ecore_iov_vf_mbx {
40         union vfpf_tlvs         *req_virt;
41         dma_addr_t              req_phys;
42         union pfvf_tlvs         *reply_virt;
43         dma_addr_t              reply_phys;
44
45         /* Address in VF where a pending message is located */
46         dma_addr_t              pending_req;
47
48         /* Message from VF awaits handling */
49         bool                    b_pending_msg;
50
51         u8 *offset;
52
53 #ifdef CONFIG_ECORE_SW_CHANNEL
54         struct ecore_iov_sw_mbx sw_mbx;
55 #endif
56
57         /* VF GPA address */
58         u32                     vf_addr_lo;
59         u32                     vf_addr_hi;
60
61         struct vfpf_first_tlv   first_tlv;      /* saved VF request header */
62
63         u8                      flags;
64 #define VF_MSG_INPROCESS        0x1     /* failsafe - the FW should prevent
65                                          * more then one pending msg
66                                          */
67 };
68
69 #define ECORE_IOV_LEGACY_QID_RX (0)
70 #define ECORE_IOV_LEGACY_QID_TX (1)
71 #define ECORE_IOV_QID_INVALID (0xFE)
72
73 struct ecore_vf_queue_cid {
74         bool b_is_tx;
75         struct ecore_queue_cid *p_cid;
76 };
77
78 /* Describes a qzone associated with the VF */
79 struct ecore_vf_queue {
80         /* Input from upper-layer, mapping relateive queue to queue-zone */
81         u16 fw_rx_qid;
82         u16 fw_tx_qid;
83
84         struct ecore_vf_queue_cid cids[MAX_QUEUES_PER_QZONE];
85 };
86
87 enum vf_state {
88         VF_FREE         = 0,    /* VF ready to be acquired holds no resc */
89         VF_ACQUIRED     = 1,    /* VF, acquired, but not initalized */
90         VF_ENABLED      = 2,    /* VF, Enabled */
91         VF_RESET        = 3,    /* VF, FLR'd, pending cleanup */
92         VF_STOPPED      = 4     /* VF, Stopped */
93 };
94
95 struct ecore_vf_vlan_shadow {
96         bool used;
97         u16 vid;
98 };
99
100 struct ecore_vf_shadow_config {
101         /* Shadow copy of all guest vlans */
102         struct ecore_vf_vlan_shadow vlans[ECORE_ETH_VF_NUM_VLAN_FILTERS + 1];
103
104         /* Shadow copy of all configured MACs; Empty if forcing MACs */
105         u8 macs[ECORE_ETH_VF_NUM_MAC_FILTERS][ETH_ALEN];
106         u8 inner_vlan_removal;
107 };
108
109 /* PFs maintain an array of this structure, per VF */
110 struct ecore_vf_info {
111         struct ecore_iov_vf_mbx vf_mbx;
112         enum vf_state state;
113         bool b_init;
114         bool b_malicious;
115         u8                      to_disable;
116
117         struct ecore_bulletin   bulletin;
118         dma_addr_t              vf_bulletin;
119
120         /* PF saves a copy of the last VF acquire message */
121         struct vfpf_acquire_tlv acquire;
122
123         u32                     concrete_fid;
124         u16                     opaque_fid;
125         u16                     mtu;
126
127         u8                      vport_id;
128         u8                      rss_eng_id;
129         u8                      relative_vf_id;
130         u8                      abs_vf_id;
131 #define ECORE_VF_ABS_ID(p_hwfn, p_vf)   (ECORE_PATH_ID(p_hwfn) ? \
132                                          (p_vf)->abs_vf_id + MAX_NUM_VFS_BB : \
133                                          (p_vf)->abs_vf_id)
134
135         u8                      vport_instance; /* Number of active vports */
136         u8                      num_rxqs;
137         u8                      num_txqs;
138
139         u16                     rx_coal;
140         u16                     tx_coal;
141
142         u8                      num_sbs;
143
144         u8                      num_mac_filters;
145         u8                      num_vlan_filters;
146
147         struct ecore_vf_queue   vf_queues[ECORE_MAX_VF_CHAINS_PER_PF];
148         u16                     igu_sbs[ECORE_MAX_VF_CHAINS_PER_PF];
149
150         /* TODO - Only windows is using it - should be removed */
151         u8 was_malicious;
152         u8 num_active_rxqs;
153         void *ctx;
154         struct ecore_public_vf_info p_vf_info;
155         bool spoof_chk;         /* Current configured on HW */
156         bool req_spoofchk_val;  /* Requested value */
157
158         /* Stores the configuration requested by VF */
159         struct ecore_vf_shadow_config shadow_config;
160
161         /* A bitfield using bulletin's valid-map bits, used to indicate
162          * which of the bulletin board features have been configured.
163          */
164         u64 configured_features;
165 #define ECORE_IOV_CONFIGURED_FEATURES_MASK      ((1 << MAC_ADDR_FORCED) | \
166                                                  (1 << VLAN_ADDR_FORCED))
167 };
168
169 /* This structure is part of ecore_hwfn and used only for PFs that have sriov
170  * capability enabled.
171  */
172 struct ecore_pf_iov {
173         struct ecore_vf_info    vfs_array[E4_MAX_NUM_VFS];
174         u64                     pending_flr[ECORE_VF_ARRAY_LENGTH];
175
176 #ifndef REMOVE_DBG
177         /* This doesn't serve anything functionally, but it makes windows
178          * debugging of IOV related issues easier.
179          */
180         u64                     active_vfs[ECORE_VF_ARRAY_LENGTH];
181 #endif
182
183         /* Allocate message address continuosuly and split to each VF */
184         void                    *mbx_msg_virt_addr;
185         dma_addr_t              mbx_msg_phys_addr;
186         u32                     mbx_msg_size;
187         void                    *mbx_reply_virt_addr;
188         dma_addr_t              mbx_reply_phys_addr;
189         u32                     mbx_reply_size;
190         void                    *p_bulletins;
191         dma_addr_t              bulletins_phys;
192         u32                     bulletins_size;
193 };
194
195 #ifdef CONFIG_ECORE_SRIOV
196 /**
197  * @brief Read sriov related information and allocated resources
198  *  reads from configuraiton space, shmem, etc.
199  *
200  * @param p_hwfn
201  *
202  * @return enum _ecore_status_t
203  */
204 enum _ecore_status_t ecore_iov_hw_info(struct ecore_hwfn *p_hwfn);
205
206 /**
207  * @brief ecore_add_tlv - place a given tlv on the tlv buffer at next offset
208  *
209  * @param offset
210  * @param type
211  * @param length
212  *
213  * @return pointer to the newly placed tlv
214  */
215 void *ecore_add_tlv(u8 **offset, u16 type, u16 length);
216
217 /**
218  * @brief list the types and lengths of the tlvs on the buffer
219  *
220  * @param p_hwfn
221  * @param tlvs_list
222  */
223 void ecore_dp_tlv_list(struct ecore_hwfn *p_hwfn,
224                        void *tlvs_list);
225
226 /**
227  * @brief ecore_iov_alloc - allocate sriov related resources
228  *
229  * @param p_hwfn
230  *
231  * @return enum _ecore_status_t
232  */
233 enum _ecore_status_t ecore_iov_alloc(struct ecore_hwfn *p_hwfn);
234
235 /**
236  * @brief ecore_iov_setup - setup sriov related resources
237  *
238  * @param p_hwfn
239  */
240 void ecore_iov_setup(struct ecore_hwfn  *p_hwfn);
241
242 /**
243  * @brief ecore_iov_free - free sriov related resources
244  *
245  * @param p_hwfn
246  */
247 void ecore_iov_free(struct ecore_hwfn *p_hwfn);
248
249 /**
250  * @brief free sriov related memory that was allocated during hw_prepare
251  *
252  * @param p_dev
253  */
254 void ecore_iov_free_hw_info(struct ecore_dev *p_dev);
255
256 /**
257  * @brief Mark structs of vfs that have been FLR-ed.
258  *
259  * @param p_hwfn
260  * @param disabled_vfs - bitmask of all VFs on path that were FLRed
261  *
262  * @return 1 iff one of the PF's vfs got FLRed. 0 otherwise.
263  */
264 bool ecore_iov_mark_vf_flr(struct ecore_hwfn *p_hwfn,
265                            u32 *disabled_vfs);
266
267 /**
268  * @brief Search extended TLVs in request/reply buffer.
269  *
270  * @param p_hwfn
271  * @param p_tlvs_list - Pointer to tlvs list
272  * @param req_type - Type of TLV
273  *
274  * @return pointer to tlv type if found, otherwise returns NULL.
275  */
276 void *ecore_iov_search_list_tlvs(struct ecore_hwfn *p_hwfn,
277                                  void *p_tlvs_list, u16 req_type);
278
279 /**
280  * @brief ecore_iov_get_vf_info - return the database of a
281  *        specific VF
282  *
283  * @param p_hwfn
284  * @param relative_vf_id - relative id of the VF for which info
285  *                       is requested
286  * @param b_enabled_only - false iff want to access even if vf is disabled
287  *
288  * @return struct ecore_vf_info*
289  */
290 struct ecore_vf_info *ecore_iov_get_vf_info(struct ecore_hwfn *p_hwfn,
291                                             u16 relative_vf_id,
292                                             bool b_enabled_only);
293 #endif
294 #endif /* __ECORE_SRIOV_H__ */