e1000: whitespace changes
[dpdk.git] / lib / librte_pmd_e1000 / e1000 / e1000_vf.c
1 /*******************************************************************************
2
3 Copyright (c) 2001-2012, 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
35 #include "e1000_api.h"
36
37
38 STATIC s32 e1000_init_phy_params_vf(struct e1000_hw *hw);
39 STATIC s32 e1000_init_nvm_params_vf(struct e1000_hw *hw);
40 STATIC void e1000_release_vf(struct e1000_hw *hw);
41 STATIC s32 e1000_acquire_vf(struct e1000_hw *hw);
42 STATIC s32 e1000_setup_link_vf(struct e1000_hw *hw);
43 STATIC s32 e1000_get_bus_info_pcie_vf(struct e1000_hw *hw);
44 STATIC s32 e1000_init_mac_params_vf(struct e1000_hw *hw);
45 STATIC s32 e1000_check_for_link_vf(struct e1000_hw *hw);
46 STATIC s32 e1000_get_link_up_info_vf(struct e1000_hw *hw, u16 *speed,
47                                      u16 *duplex);
48 STATIC s32 e1000_init_hw_vf(struct e1000_hw *hw);
49 STATIC s32 e1000_reset_hw_vf(struct e1000_hw *hw);
50 STATIC void e1000_update_mc_addr_list_vf(struct e1000_hw *hw, u8 *, u32);
51 STATIC void e1000_rar_set_vf(struct e1000_hw *, u8 *, u32);
52 STATIC s32 e1000_read_mac_addr_vf(struct e1000_hw *);
53
54 /**
55  *  e1000_init_phy_params_vf - Inits PHY params
56  *  @hw: pointer to the HW structure
57  *
58  *  Doesn't do much - there's no PHY available to the VF.
59  **/
60 STATIC s32 e1000_init_phy_params_vf(struct e1000_hw *hw)
61 {
62         DEBUGFUNC("e1000_init_phy_params_vf");
63         hw->phy.type = e1000_phy_vf;
64         hw->phy.ops.acquire = e1000_acquire_vf;
65         hw->phy.ops.release = e1000_release_vf;
66
67         return E1000_SUCCESS;
68 }
69
70 /**
71  *  e1000_init_nvm_params_vf - Inits NVM params
72  *  @hw: pointer to the HW structure
73  *
74  *  Doesn't do much - there's no NVM available to the VF.
75  **/
76 STATIC s32 e1000_init_nvm_params_vf(struct e1000_hw *hw)
77 {
78         DEBUGFUNC("e1000_init_nvm_params_vf");
79         hw->nvm.type = e1000_nvm_none;
80         hw->nvm.ops.acquire = e1000_acquire_vf;
81         hw->nvm.ops.release = e1000_release_vf;
82
83         return E1000_SUCCESS;
84 }
85
86 /**
87  *  e1000_init_mac_params_vf - Inits MAC params
88  *  @hw: pointer to the HW structure
89  **/
90 STATIC s32 e1000_init_mac_params_vf(struct e1000_hw *hw)
91 {
92         struct e1000_mac_info *mac = &hw->mac;
93
94         DEBUGFUNC("e1000_init_mac_params_vf");
95
96         /* Set media type */
97         /*
98          * Virtual functions don't care what they're media type is as they
99          * have no direct access to the PHY, or the media.  That is handled
100          * by the physical function driver.
101          */
102         hw->phy.media_type = e1000_media_type_unknown;
103
104         /* No ASF features for the VF driver */
105         mac->asf_firmware_present = false;
106         /* ARC subsystem not supported */
107         mac->arc_subsystem_valid = false;
108         /* Disable adaptive IFS mode so the generic funcs don't do anything */
109         mac->adaptive_ifs = false;
110         /* VF's have no MTA Registers - PF feature only */
111         mac->mta_reg_count = 128;
112         /* VF's have no access to RAR entries  */
113         mac->rar_entry_count = 1;
114
115         /* Function pointers */
116         /* link setup */
117         mac->ops.setup_link = e1000_setup_link_vf;
118         /* bus type/speed/width */
119         mac->ops.get_bus_info = e1000_get_bus_info_pcie_vf;
120         /* reset */
121         mac->ops.reset_hw = e1000_reset_hw_vf;
122         /* hw initialization */
123         mac->ops.init_hw = e1000_init_hw_vf;
124         /* check for link */
125         mac->ops.check_for_link = e1000_check_for_link_vf;
126         /* link info */
127         mac->ops.get_link_up_info = e1000_get_link_up_info_vf;
128         /* multicast address update */
129         mac->ops.update_mc_addr_list = e1000_update_mc_addr_list_vf;
130         /* set mac address */
131         mac->ops.rar_set = e1000_rar_set_vf;
132         /* read mac address */
133         mac->ops.read_mac_addr = e1000_read_mac_addr_vf;
134
135
136         return E1000_SUCCESS;
137 }
138
139 /**
140  *  e1000_init_function_pointers_vf - Inits function pointers
141  *  @hw: pointer to the HW structure
142  **/
143 void e1000_init_function_pointers_vf(struct e1000_hw *hw)
144 {
145         DEBUGFUNC("e1000_init_function_pointers_vf");
146
147         hw->mac.ops.init_params = e1000_init_mac_params_vf;
148         hw->nvm.ops.init_params = e1000_init_nvm_params_vf;
149         hw->phy.ops.init_params = e1000_init_phy_params_vf;
150         hw->mbx.ops.init_params = e1000_init_mbx_params_vf;
151 }
152
153 /**
154  *  e1000_acquire_vf - Acquire rights to access PHY or NVM.
155  *  @hw: pointer to the HW structure
156  *
157  *  There is no PHY or NVM so we want all attempts to acquire these to fail.
158  *  In addition, the MAC registers to access PHY/NVM don't exist so we don't
159  *  even want any SW to attempt to use them.
160  **/
161 STATIC s32 e1000_acquire_vf(struct e1000_hw *hw)
162 {
163         return -E1000_ERR_PHY;
164 }
165
166 /**
167  *  e1000_release_vf - Release PHY or NVM
168  *  @hw: pointer to the HW structure
169  *
170  *  There is no PHY or NVM so we want all attempts to acquire these to fail.
171  *  In addition, the MAC registers to access PHY/NVM don't exist so we don't
172  *  even want any SW to attempt to use them.
173  **/
174 STATIC void e1000_release_vf(struct e1000_hw *hw)
175 {
176         return;
177 }
178
179 /**
180  *  e1000_setup_link_vf - Sets up link.
181  *  @hw: pointer to the HW structure
182  *
183  *  Virtual functions cannot change link.
184  **/
185 STATIC s32 e1000_setup_link_vf(struct e1000_hw *hw)
186 {
187         DEBUGFUNC("e1000_setup_link_vf");
188
189         return E1000_SUCCESS;
190 }
191
192 /**
193  *  e1000_get_bus_info_pcie_vf - Gets the bus info.
194  *  @hw: pointer to the HW structure
195  *
196  *  Virtual functions are not really on their own bus.
197  **/
198 STATIC s32 e1000_get_bus_info_pcie_vf(struct e1000_hw *hw)
199 {
200         struct e1000_bus_info *bus = &hw->bus;
201
202         DEBUGFUNC("e1000_get_bus_info_pcie_vf");
203
204         /* Do not set type PCI-E because we don't want disable master to run */
205         bus->type = e1000_bus_type_reserved;
206         bus->speed = e1000_bus_speed_2500;
207
208         return 0;
209 }
210
211 /**
212  *  e1000_get_link_up_info_vf - Gets link info.
213  *  @hw: pointer to the HW structure
214  *  @speed: pointer to 16 bit value to store link speed.
215  *  @duplex: pointer to 16 bit value to store duplex.
216  *
217  *  Since we cannot read the PHY and get accurate link info, we must rely upon
218  *  the status register's data which is often stale and inaccurate.
219  **/
220 STATIC s32 e1000_get_link_up_info_vf(struct e1000_hw *hw, u16 *speed,
221                                      u16 *duplex)
222 {
223         s32 status;
224
225         DEBUGFUNC("e1000_get_link_up_info_vf");
226
227         status = E1000_READ_REG(hw, E1000_STATUS);
228         if (status & E1000_STATUS_SPEED_1000) {
229                 *speed = SPEED_1000;
230                 DEBUGOUT("1000 Mbs, ");
231         } else if (status & E1000_STATUS_SPEED_100) {
232                 *speed = SPEED_100;
233                 DEBUGOUT("100 Mbs, ");
234         } else {
235                 *speed = SPEED_10;
236                 DEBUGOUT("10 Mbs, ");
237         }
238
239         if (status & E1000_STATUS_FD) {
240                 *duplex = FULL_DUPLEX;
241                 DEBUGOUT("Full Duplex\n");
242         } else {
243                 *duplex = HALF_DUPLEX;
244                 DEBUGOUT("Half Duplex\n");
245         }
246
247         return E1000_SUCCESS;
248 }
249
250 /**
251  *  e1000_reset_hw_vf - Resets the HW
252  *  @hw: pointer to the HW structure
253  *
254  *  VF's provide a function level reset. This is done using bit 26 of ctrl_reg.
255  *  This is all the reset we can perform on a VF.
256  **/
257 STATIC s32 e1000_reset_hw_vf(struct e1000_hw *hw)
258 {
259         struct e1000_mbx_info *mbx = &hw->mbx;
260         u32 timeout = E1000_VF_INIT_TIMEOUT;
261         s32 ret_val = -E1000_ERR_MAC_INIT;
262         u32 ctrl, msgbuf[3];
263         u8 *addr = (u8 *)(&msgbuf[1]);
264
265         DEBUGFUNC("e1000_reset_hw_vf");
266
267         DEBUGOUT("Issuing a function level reset to MAC\n");
268         ctrl = E1000_READ_REG(hw, E1000_CTRL);
269         E1000_WRITE_REG(hw, E1000_CTRL, ctrl | E1000_CTRL_RST);
270
271         /* we cannot reset while the RSTI / RSTD bits are asserted */
272         while (!mbx->ops.check_for_rst(hw, 0) && timeout) {
273                 timeout--;
274                 usec_delay(5);
275         }
276
277         if (timeout) {
278                 /* mailbox timeout can now become active */
279                 mbx->timeout = E1000_VF_MBX_INIT_TIMEOUT;
280
281                 msgbuf[0] = E1000_VF_RESET;
282                 mbx->ops.write_posted(hw, msgbuf, 1, 0);
283
284                 msec_delay(10);
285
286                 /* set our "perm_addr" based on info provided by PF */
287                 ret_val = mbx->ops.read_posted(hw, msgbuf, 3, 0);
288                 if (!ret_val) {
289                         if (msgbuf[0] == (E1000_VF_RESET |
290                             E1000_VT_MSGTYPE_ACK))
291                                 memcpy(hw->mac.perm_addr, addr, 6);
292                         else
293                                 ret_val = -E1000_ERR_MAC_INIT;
294                 }
295         }
296
297         return ret_val;
298 }
299
300 /**
301  *  e1000_init_hw_vf - Inits the HW
302  *  @hw: pointer to the HW structure
303  *
304  *  Not much to do here except clear the PF Reset indication if there is one.
305  **/
306 STATIC s32 e1000_init_hw_vf(struct e1000_hw *hw)
307 {
308         DEBUGFUNC("e1000_init_hw_vf");
309
310         /* attempt to set and restore our mac address */
311         e1000_rar_set_vf(hw, hw->mac.addr, 0);
312
313         return E1000_SUCCESS;
314 }
315
316 /**
317  *  e1000_rar_set_vf - set device MAC address
318  *  @hw: pointer to the HW structure
319  *  @addr: pointer to the receive address
320  *  @index receive address array register
321  **/
322 STATIC void e1000_rar_set_vf(struct e1000_hw *hw, u8 * addr, u32 index)
323 {
324         struct e1000_mbx_info *mbx = &hw->mbx;
325         u32 msgbuf[3];
326         u8 *msg_addr = (u8 *)(&msgbuf[1]);
327         s32 ret_val;
328
329         memset(msgbuf, 0, 12);
330         msgbuf[0] = E1000_VF_SET_MAC_ADDR;
331         memcpy(msg_addr, addr, 6);
332         ret_val = mbx->ops.write_posted(hw, msgbuf, 3, 0);
333
334         if (!ret_val)
335                 ret_val = mbx->ops.read_posted(hw, msgbuf, 3, 0);
336
337         msgbuf[0] &= ~E1000_VT_MSGTYPE_CTS;
338
339         /* if nacked the address was rejected, use "perm_addr" */
340         if (!ret_val &&
341             (msgbuf[0] == (E1000_VF_SET_MAC_ADDR | E1000_VT_MSGTYPE_NACK)))
342                 e1000_read_mac_addr_vf(hw);
343 }
344
345 /**
346  *  e1000_hash_mc_addr_vf - Generate a multicast hash value
347  *  @hw: pointer to the HW structure
348  *  @mc_addr: pointer to a multicast address
349  *
350  *  Generates a multicast address hash value which is used to determine
351  *  the multicast filter table array address and new table value.
352  **/
353 STATIC u32 e1000_hash_mc_addr_vf(struct e1000_hw *hw, u8 *mc_addr)
354 {
355         u32 hash_value, hash_mask;
356         u8 bit_shift = 0;
357
358         DEBUGFUNC("e1000_hash_mc_addr_generic");
359
360         /* Register count multiplied by bits per register */
361         hash_mask = (hw->mac.mta_reg_count * 32) - 1;
362
363         /*
364          * The bit_shift is the number of left-shifts
365          * where 0xFF would still fall within the hash mask.
366          */
367         while (hash_mask >> bit_shift != 0xFF)
368                 bit_shift++;
369
370         hash_value = hash_mask & (((mc_addr[4] >> (8 - bit_shift)) |
371                                   (((u16) mc_addr[5]) << bit_shift)));
372
373         return hash_value;
374 }
375
376 static void e1000_write_msg_read_ack(struct e1000_hw *hw,
377                                      u32 *msg, u16 size)
378 {
379         struct e1000_mbx_info *mbx = &hw->mbx;
380         u32 retmsg[E1000_VFMAILBOX_SIZE];
381         s32 retval = mbx->ops.write_posted(hw, msg, size, 0);
382
383         if (!retval)
384                 mbx->ops.read_posted(hw, retmsg, E1000_VFMAILBOX_SIZE, 0);
385 }
386
387 /**
388  *  e1000_update_mc_addr_list_vf - Update Multicast addresses
389  *  @hw: pointer to the HW structure
390  *  @mc_addr_list: array of multicast addresses to program
391  *  @mc_addr_count: number of multicast addresses to program
392  *
393  *  Updates the Multicast Table Array.
394  *  The caller must have a packed mc_addr_list of multicast addresses.
395  **/
396 void e1000_update_mc_addr_list_vf(struct e1000_hw *hw,
397                                   u8 *mc_addr_list, u32 mc_addr_count)
398 {
399         u32 msgbuf[E1000_VFMAILBOX_SIZE];
400         u16 *hash_list = (u16 *)&msgbuf[1];
401         u32 hash_value;
402         u32 i;
403
404         DEBUGFUNC("e1000_update_mc_addr_list_vf");
405
406         /* Each entry in the list uses 1 16 bit word.  We have 30
407          * 16 bit words available in our HW msg buffer (minus 1 for the
408          * msg type).  That's 30 hash values if we pack 'em right.  If
409          * there are more than 30 MC addresses to add then punt the
410          * extras for now and then add code to handle more than 30 later.
411          * It would be unusual for a server to request that many multi-cast
412          * addresses except for in large enterprise network environments.
413          */
414
415         DEBUGOUT1("MC Addr Count = %d\n", mc_addr_count);
416
417         if (mc_addr_count > 30) {
418                 msgbuf[0] |= E1000_VF_SET_MULTICAST_OVERFLOW;
419                 mc_addr_count = 30;
420         }
421
422         msgbuf[0] = E1000_VF_SET_MULTICAST;
423         msgbuf[0] |= mc_addr_count << E1000_VT_MSGINFO_SHIFT;
424
425         for (i = 0; i < mc_addr_count; i++) {
426                 hash_value = e1000_hash_mc_addr_vf(hw, mc_addr_list);
427                 DEBUGOUT1("Hash value = 0x%03X\n", hash_value);
428                 hash_list[i] = hash_value & 0x0FFF;
429                 mc_addr_list += ETH_ADDR_LEN;
430         }
431
432         e1000_write_msg_read_ack(hw, msgbuf, E1000_VFMAILBOX_SIZE);
433 }
434
435 /**
436  *  e1000_vfta_set_vf - Set/Unset vlan filter table address
437  *  @hw: pointer to the HW structure
438  *  @vid: determines the vfta register and bit to set/unset
439  *  @set: if true then set bit, else clear bit
440  **/
441 void e1000_vfta_set_vf(struct e1000_hw *hw, u16 vid, bool set)
442 {
443         u32 msgbuf[2];
444
445         msgbuf[0] = E1000_VF_SET_VLAN;
446         msgbuf[1] = vid;
447         /* Setting the 8 bit field MSG INFO to TRUE indicates "add" */
448         if (set)
449                 msgbuf[0] |= E1000_VF_SET_VLAN_ADD;
450
451         e1000_write_msg_read_ack(hw, msgbuf, 2);
452 }
453
454 /** e1000_rlpml_set_vf - Set the maximum receive packet length
455  *  @hw: pointer to the HW structure
456  *  @max_size: value to assign to max frame size
457  **/
458 void e1000_rlpml_set_vf(struct e1000_hw *hw, u16 max_size)
459 {
460         u32 msgbuf[2];
461
462         msgbuf[0] = E1000_VF_SET_LPE;
463         msgbuf[1] = max_size;
464
465         e1000_write_msg_read_ack(hw, msgbuf, 2);
466 }
467
468 /**
469  *  e1000_promisc_set_vf - Set flags for Unicast or Multicast promisc
470  *  @hw: pointer to the HW structure
471  *  @uni: boolean indicating unicast promisc status
472  *  @multi: boolean indicating multicast promisc status
473  **/
474 s32 e1000_promisc_set_vf(struct e1000_hw *hw, enum e1000_promisc_type type)
475 {
476         struct e1000_mbx_info *mbx = &hw->mbx;
477         u32 msgbuf = E1000_VF_SET_PROMISC;
478         s32 ret_val;
479
480         switch (type) {
481         case e1000_promisc_multicast:
482                 msgbuf |= E1000_VF_SET_PROMISC_MULTICAST;
483                 break;
484         case e1000_promisc_enabled:
485                 msgbuf |= E1000_VF_SET_PROMISC_MULTICAST;
486         case e1000_promisc_unicast:
487                 msgbuf |= E1000_VF_SET_PROMISC_UNICAST;
488         case e1000_promisc_disabled:
489                 break;
490         default:
491                 return -E1000_ERR_MAC_INIT;
492         }
493
494          ret_val = mbx->ops.write_posted(hw, &msgbuf, 1, 0);
495
496         if (!ret_val)
497                 ret_val = mbx->ops.read_posted(hw, &msgbuf, 1, 0);
498
499         if (!ret_val && !(msgbuf & E1000_VT_MSGTYPE_ACK))
500                 ret_val = -E1000_ERR_MAC_INIT;
501
502         return ret_val;
503 }
504
505 /**
506  *  e1000_read_mac_addr_vf - Read device MAC address
507  *  @hw: pointer to the HW structure
508  **/
509 STATIC s32 e1000_read_mac_addr_vf(struct e1000_hw *hw)
510 {
511         int i;
512
513         for (i = 0; i < ETH_ADDR_LEN; i++)
514                 hw->mac.addr[i] = hw->mac.perm_addr[i];
515
516         return E1000_SUCCESS;
517 }
518
519 /**
520  *  e1000_check_for_link_vf - Check for link for a virtual interface
521  *  @hw: pointer to the HW structure
522  *
523  *  Checks to see if the underlying PF is still talking to the VF and
524  *  if it is then it reports the link state to the hardware, otherwise
525  *  it reports link down and returns an error.
526  **/
527 STATIC s32 e1000_check_for_link_vf(struct e1000_hw *hw)
528 {
529         struct e1000_mbx_info *mbx = &hw->mbx;
530         struct e1000_mac_info *mac = &hw->mac;
531         s32 ret_val = E1000_SUCCESS;
532         u32 in_msg = 0;
533
534         DEBUGFUNC("e1000_check_for_link_vf");
535
536         /*
537          * We only want to run this if there has been a rst asserted.
538          * in this case that could mean a link change, device reset,
539          * or a virtual function reset
540          */
541
542         /* If we were hit with a reset or timeout drop the link */
543         if (!mbx->ops.check_for_rst(hw, 0) || !mbx->timeout)
544                 mac->get_link_status = true;
545
546         if (!mac->get_link_status)
547                 goto out;
548
549         /* if link status is down no point in checking to see if pf is up */
550         if (!(E1000_READ_REG(hw, E1000_STATUS) & E1000_STATUS_LU))
551                 goto out;
552
553         /* if the read failed it could just be a mailbox collision, best wait
554          * until we are called again and don't report an error */
555         if (mbx->ops.read(hw, &in_msg, 1, 0))
556                 goto out;
557
558         /* if incoming message isn't clear to send we are waiting on response */
559         if (!(in_msg & E1000_VT_MSGTYPE_CTS)) {
560                 /* message is not CTS and is NACK we have lost CTS status */
561                 if (in_msg & E1000_VT_MSGTYPE_NACK)
562                         ret_val = -E1000_ERR_MAC_INIT;
563                 goto out;
564         }
565
566         /* at this point we know the PF is talking to us, check and see if
567          * we are still accepting timeout or if we had a timeout failure.
568          * if we failed then we will need to reinit */
569         if (!mbx->timeout) {
570                 ret_val = -E1000_ERR_MAC_INIT;
571                 goto out;
572         }
573
574         /* if we passed all the tests above then the link is up and we no
575          * longer need to check for link */
576         mac->get_link_status = false;
577
578 out:
579         return ret_val;
580 }
581