i40e: base driver
[dpdk.git] / lib / librte_pmd_i40e / i40e / i40e_dcb.h
1 /*******************************************************************************
2
3 Copyright (c) 2013 - 2014, Intel Corporation
4 All rights reserved.
5
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions are met:
8
9  1. Redistributions of source code must retain the above copyright notice,
10     this list of conditions and the following disclaimer.
11
12  2. Redistributions in binary form must reproduce the above copyright
13     notice, this list of conditions and the following disclaimer in the
14     documentation and/or other materials provided with the distribution.
15
16  3. Neither the name of the Intel Corporation nor the names of its
17     contributors may be used to endorse or promote products derived from
18     this software without specific prior written permission.
19
20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 POSSIBILITY OF SUCH DAMAGE.
31
32 ***************************************************************************/
33
34 #ifndef _I40E_DCB_H_
35 #define _I40E_DCB_H_
36
37 #include "i40e_type.h"
38
39 #define I40E_DCBX_OFFLOAD_DISABLED      0
40 #define I40E_DCBX_OFFLOAD_ENABLED       1
41
42 #define I40E_DCBX_STATUS_NOT_STARTED    0
43 #define I40E_DCBX_STATUS_IN_PROGRESS    1
44 #define I40E_DCBX_STATUS_DONE           2
45 #define I40E_DCBX_STATUS_MULTIPLE_PEERS 3
46 #define I40E_DCBX_STATUS_DISABLED       7
47
48 #define I40E_TLV_TYPE_END               0
49 #define I40E_TLV_TYPE_ORG               127
50
51 #define I40E_IEEE_8021QAZ_OUI           0x0080C2
52 #define I40E_IEEE_SUBTYPE_ETS_CFG       9
53 #define I40E_IEEE_SUBTYPE_ETS_REC       10
54 #define I40E_IEEE_SUBTYPE_PFC_CFG       11
55 #define I40E_IEEE_SUBTYPE_APP_PRI       12
56
57 #define I40E_LLDP_ADMINSTATUS_DISABLED          0
58 #define I40E_LLDP_ADMINSTATUS_ENABLED_RX        1
59 #define I40E_LLDP_ADMINSTATUS_ENABLED_TX        2
60 #define I40E_LLDP_ADMINSTATUS_ENABLED_RXTX      3
61
62 /* Defines for LLDP TLV header */
63 #define I40E_LLDP_MIB_HLEN              14
64 #define I40E_LLDP_TLV_LEN_SHIFT         0
65 #define I40E_LLDP_TLV_LEN_MASK          (0x01FF << I40E_LLDP_TLV_LEN_SHIFT)
66 #define I40E_LLDP_TLV_TYPE_SHIFT        9
67 #define I40E_LLDP_TLV_TYPE_MASK         (0x7F << I40E_LLDP_TLV_TYPE_SHIFT)
68 #define I40E_LLDP_TLV_SUBTYPE_SHIFT     0
69 #define I40E_LLDP_TLV_SUBTYPE_MASK      (0xFF << I40E_LLDP_TLV_SUBTYPE_SHIFT)
70 #define I40E_LLDP_TLV_OUI_SHIFT         8
71 #define I40E_LLDP_TLV_OUI_MASK          (0xFFFFFF << I40E_LLDP_TLV_OUI_SHIFT)
72
73 /* Defines for IEEE ETS TLV */
74 #define I40E_IEEE_ETS_MAXTC_SHIFT       0
75 #define I40E_IEEE_ETS_MAXTC_MASK        (0x7 << I40E_IEEE_ETS_MAXTC_SHIFT)
76 #define I40E_IEEE_ETS_CBS_SHIFT         6
77 #define I40E_IEEE_ETS_CBS_MASK          (0x1 << I40E_IEEE_ETS_CBS_SHIFT)
78 #define I40E_IEEE_ETS_WILLING_SHIFT     7
79 #define I40E_IEEE_ETS_WILLING_MASK      (0x1 << I40E_IEEE_ETS_WILLING_SHIFT)
80 #define I40E_IEEE_ETS_PRIO_0_SHIFT      0
81 #define I40E_IEEE_ETS_PRIO_0_MASK       (0x7 << I40E_IEEE_ETS_PRIO_0_SHIFT)
82 #define I40E_IEEE_ETS_PRIO_1_SHIFT      4
83 #define I40E_IEEE_ETS_PRIO_1_MASK       (0x7 << I40E_IEEE_ETS_PRIO_1_SHIFT)
84
85 /* Defines for IEEE TSA types */
86 #define I40E_IEEE_TSA_STRICT            0
87 #define I40E_IEEE_TSA_CBS               1
88 #define I40E_IEEE_TSA_ETS               2
89 #define I40E_IEEE_TSA_VENDOR            255
90
91 /* Defines for IEEE PFC TLV */
92 #define I40E_IEEE_PFC_CAP_SHIFT         0
93 #define I40E_IEEE_PFC_CAP_MASK          (0xF << I40E_IEEE_PFC_CAP_SHIFT)
94 #define I40E_IEEE_PFC_MBC_SHIFT         6
95 #define I40E_IEEE_PFC_MBC_MASK          (0x1 << I40E_IEEE_PFC_MBC_SHIFT)
96 #define I40E_IEEE_PFC_WILLING_SHIFT     7
97 #define I40E_IEEE_PFC_WILLING_MASK      (0x1 << I40E_IEEE_PFC_WILLING_SHIFT)
98
99 /* Defines for IEEE APP TLV */
100 #define I40E_IEEE_APP_SEL_SHIFT         0
101 #define I40E_IEEE_APP_SEL_MASK          (0x7 << I40E_IEEE_APP_SEL_SHIFT)
102 #define I40E_IEEE_APP_PRIO_SHIFT        5
103 #define I40E_IEEE_APP_PRIO_MASK         (0x7 << I40E_IEEE_APP_PRIO_SHIFT)
104
105
106 #pragma pack(1)
107
108 /* IEEE 802.1AB LLDP TLV structure */
109 struct i40e_lldp_generic_tlv {
110         __be16 typelength;
111         u8 tlvinfo[1];
112 };
113
114 /* IEEE 802.1AB LLDP Organization specific TLV */
115 struct i40e_lldp_org_tlv {
116         __be16 typelength;
117         __be32 ouisubtype;
118         u8 tlvinfo[1];
119 };
120 #pragma pack()
121
122 /*
123  * TODO: The below structures related LLDP/DCBX variables
124  * and statistics are defined but need to find how to get
125  * the required information from the Firmware to use them
126  */
127
128 /* IEEE 802.1AB LLDP Agent Statistics */
129 struct i40e_lldp_stats {
130         u64 remtablelastchangetime;
131         u64 remtableinserts;
132         u64 remtabledeletes;
133         u64 remtabledrops;
134         u64 remtableageouts;
135         u64 txframestotal;
136         u64 rxframesdiscarded;
137         u64 rxportframeerrors;
138         u64 rxportframestotal;
139         u64 rxporttlvsdiscardedtotal;
140         u64 rxporttlvsunrecognizedtotal;
141         u64 remtoomanyneighbors;
142 };
143
144 /* IEEE 802.1Qaz DCBX variables */
145 struct i40e_dcbx_variables {
146         u32 defmaxtrafficclasses;
147         u32 defprioritytcmapping;
148         u32 deftcbandwidth;
149         u32 deftsaassignment;
150 };
151
152 #ifdef I40E_DCB_SW
153 /* Data structures to pass for SW DCBX */
154 struct i40e_rx_pb_config {
155         u32     shared_pool_size;
156         u32     shared_pool_high_wm;
157         u32     shared_pool_low_wm;
158         u32     shared_pool_high_thresh[I40E_MAX_TRAFFIC_CLASS];
159         u32     shared_pool_low_thresh[I40E_MAX_TRAFFIC_CLASS];
160         u32     tc_pool_size[I40E_MAX_TRAFFIC_CLASS];
161         u32     tc_pool_high_wm[I40E_MAX_TRAFFIC_CLASS];
162         u32     tc_pool_low_wm[I40E_MAX_TRAFFIC_CLASS];
163 };
164
165 enum i40e_dcb_arbiter_mode {
166         I40E_DCB_ARB_MODE_STRICT_PRIORITY = 0,
167         I40E_DCB_ARB_MODE_ROUND_ROBIN = 1
168 };
169
170 #define I40E_DEFAULT_PAUSE_TIME                 0xffff
171 #define I40E_MAX_FRAME_SIZE                     4608 /* 4.5 KB */
172
173 #define I40E_DEVICE_RPB_SIZE                    968000 /* 968 KB */
174
175 /* BitTimes (BT) conversion */
176 #define I40E_BT2KB(BT) ((BT + (8 * 1024 - 1)) / (8 * 1024))
177 #define I40E_B2BT(BT) (BT * 8)
178 #define I40E_BT2B(BT) ((BT + (8 - 1)) / (8))
179
180 /* Max Frame(TC) = MFS(max) + MFS(TC) */
181 #define I40E_MAX_FRAME_TC(mfs_max, mfs_tc)      I40E_B2BT(mfs_max + mfs_tc)
182
183 /* EEE Tx LPI Exit time in Bit Times */
184 #define I40E_EEE_TX_LPI_EXIT_TIME               142500
185
186 /* PCI Round Trip Time in Bit Times */
187 #define I40E_PCIRTT_LINK_SPEED_10G              20000
188 #define I40E_PCIRTT_BYTE_LINK_SPEED_20G         40000
189 #define I40E_PCIRTT_BYTE_LINK_SPEED_40G         80000
190
191 /* PFC Frame Delay Bit Times */
192 #define I40E_PFC_FRAME_DELAY                    672
193
194 /* Worst case Cable (10GBase-T) Delay Bit Times */
195 #define I40E_CABLE_DELAY                        5556
196
197 /* Higher Layer Delay @10G Bit Times */
198 #define I40E_HIGHER_LAYER_DELAY_10G             6144
199
200 /* Interface Delays in Bit Times */
201 /* TODO: Add for other link speeds 20G/40G/etc. */
202 #define I40E_INTERFACE_DELAY_10G_MAC_CONTROL    8192
203 #define I40E_INTERFACE_DELAY_10G_MAC            8192
204 #define I40E_INTERFACE_DELAY_10G_RS             8192
205
206 #define I40E_INTERFACE_DELAY_XGXS               2048
207 #define I40E_INTERFACE_DELAY_XAUI               2048
208
209 #define I40E_INTERFACE_DELAY_10G_BASEX_PCS      2048
210 #define I40E_INTERFACE_DELAY_10G_BASER_PCS      3584
211 #define I40E_INTERFACE_DELAY_LX4_PMD            512
212 #define I40E_INTERFACE_DELAY_CX4_PMD            512
213 #define I40E_INTERFACE_DELAY_SERIAL_PMA         512
214 #define I40E_INTERFACE_DELAY_PMD                512
215
216 #define I40E_INTERFACE_DELAY_10G_BASET          25600
217
218 /* delay values for with 10G BaseT in Bit Times */
219 #define I40E_INTERFACE_DELAY_10G_COPPER \
220         (I40E_INTERFACE_DELAY_10G_MAC + (2 * I40E_INTERFACE_DELAY_XAUI) \
221          + I40E_INTERFACE_DELAY_10G_BASET)
222 #define I40E_DV_TC(mfs_max, mfs_tc) \
223                 ((2 * I40E_MAX_FRAME_TC(mfs_max, mfs_tc)) \
224                   + I40E_PFC_FRAME_DELAY \
225                   + (2 * I40E_CABLE_DELAY) \
226                   + (2 * I40E_INTERFACE_DELAY_10G_COPPER) \
227                   + I40E_HIGHER_LAYER_DELAY_10G)
228 #define I40E_STD_DV_TC(mfs_max, mfs_tc) \
229                 (I40E_DV_TC(mfs_max, mfs_tc) + I40E_B2BT(mfs_max))
230
231 enum i40e_status_code i40e_process_lldp_event(struct i40e_hw *hw,
232                                               struct i40e_arq_event_info *e);
233 /* APIs for SW DCBX */
234 void i40e_dcb_hw_rx_fifo_config(struct i40e_hw *hw,
235                                 enum i40e_dcb_arbiter_mode ets_mode,
236                                 enum i40e_dcb_arbiter_mode non_ets_mode,
237                                 u32 max_exponent, u8 lltc_map);
238 void i40e_dcb_hw_rx_cmd_monitor_config(struct i40e_hw *hw,
239                                        u8 num_tc, u8 num_ports);
240 void i40e_dcb_hw_pfc_config(struct i40e_hw *hw,
241                             u8 pfc_en, u8 *prio_tc);
242 void i40e_dcb_hw_set_num_tc(struct i40e_hw *hw, u8 num_tc);
243 u8 i40e_dcb_hw_get_num_tc(struct i40e_hw *hw);
244 void i40e_dcb_hw_rx_ets_bw_config(struct i40e_hw *hw, u8 *bw_share,
245                                   u8 *mode, u8 *prio_type);
246 void i40e_dcb_hw_rx_up2tc_config(struct i40e_hw *hw, u8 *prio_tc);
247 void i40e_dcb_hw_calculate_pool_sizes(struct i40e_hw *hw,
248                                       u8 num_ports, bool eee_enabled,
249                                       u8 pfc_en, u32 *mfs_tc,
250                                       struct i40e_rx_pb_config *pb_cfg);
251 void i40e_dcb_hw_rx_pb_config(struct i40e_hw *hw,
252                               struct i40e_rx_pb_config *old_pb_cfg,
253                               struct i40e_rx_pb_config *new_pb_cfg);
254 #endif /* I40E_DCB_SW */
255 enum i40e_status_code i40e_get_dcbx_status(struct i40e_hw *hw,
256                                            u16 *status);
257 enum i40e_status_code i40e_lldp_to_dcb_config(u8 *lldpmib,
258                                               struct i40e_dcbx_config *dcbcfg);
259 enum i40e_status_code i40e_aq_get_dcb_config(struct i40e_hw *hw, u8 mib_type,
260                                              u8 bridgetype,
261                                              struct i40e_dcbx_config *dcbcfg);
262 enum i40e_status_code i40e_get_dcb_config(struct i40e_hw *hw);
263 enum i40e_status_code i40e_init_dcb(struct i40e_hw *hw);
264 #endif /* _I40E_DCB_H_ */