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