1 /*******************************************************************************
3 Copyright (c) 2001-2015, Intel Corporation
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions are met:
9 1. Redistributions of source code must retain the above copyright notice,
10 this list of conditions and the following disclaimer.
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.
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.
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.
32 ***************************************************************************/
35 #include "e1000_api.h"
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,
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 int e1000_rar_set_vf(struct e1000_hw *, u8 *, u32);
52 STATIC s32 e1000_read_mac_addr_vf(struct e1000_hw *);
55 * e1000_init_phy_params_vf - Inits PHY params
56 * @hw: pointer to the HW structure
58 * Doesn't do much - there's no PHY available to the VF.
60 STATIC s32 e1000_init_phy_params_vf(struct e1000_hw *hw)
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;
71 * e1000_init_nvm_params_vf - Inits NVM params
72 * @hw: pointer to the HW structure
74 * Doesn't do much - there's no NVM available to the VF.
76 STATIC s32 e1000_init_nvm_params_vf(struct e1000_hw *hw)
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;
87 * e1000_init_mac_params_vf - Inits MAC params
88 * @hw: pointer to the HW structure
90 STATIC s32 e1000_init_mac_params_vf(struct e1000_hw *hw)
92 struct e1000_mac_info *mac = &hw->mac;
94 DEBUGFUNC("e1000_init_mac_params_vf");
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.
102 hw->phy.media_type = e1000_media_type_unknown;
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;
115 /* Function pointers */
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;
121 mac->ops.reset_hw = e1000_reset_hw_vf;
122 /* hw initialization */
123 mac->ops.init_hw = e1000_init_hw_vf;
125 mac->ops.check_for_link = e1000_check_for_link_vf;
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;
136 return E1000_SUCCESS;
140 * e1000_init_function_pointers_vf - Inits function pointers
141 * @hw: pointer to the HW structure
143 void e1000_init_function_pointers_vf(struct e1000_hw *hw)
145 DEBUGFUNC("e1000_init_function_pointers_vf");
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;
154 * e1000_acquire_vf - Acquire rights to access PHY or NVM.
155 * @hw: pointer to the HW structure
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.
161 STATIC s32 e1000_acquire_vf(struct e1000_hw E1000_UNUSEDARG *hw)
163 UNREFERENCED_1PARAMETER(hw);
164 return -E1000_ERR_PHY;
168 * e1000_release_vf - Release PHY or NVM
169 * @hw: pointer to the HW structure
171 * There is no PHY or NVM so we want all attempts to acquire these to fail.
172 * In addition, the MAC registers to access PHY/NVM don't exist so we don't
173 * even want any SW to attempt to use them.
175 STATIC void e1000_release_vf(struct e1000_hw E1000_UNUSEDARG *hw)
177 UNREFERENCED_1PARAMETER(hw);
182 * e1000_setup_link_vf - Sets up link.
183 * @hw: pointer to the HW structure
185 * Virtual functions cannot change link.
187 STATIC s32 e1000_setup_link_vf(struct e1000_hw E1000_UNUSEDARG *hw)
189 DEBUGFUNC("e1000_setup_link_vf");
190 UNREFERENCED_1PARAMETER(hw);
192 return E1000_SUCCESS;
196 * e1000_get_bus_info_pcie_vf - Gets the bus info.
197 * @hw: pointer to the HW structure
199 * Virtual functions are not really on their own bus.
201 STATIC s32 e1000_get_bus_info_pcie_vf(struct e1000_hw *hw)
203 struct e1000_bus_info *bus = &hw->bus;
205 DEBUGFUNC("e1000_get_bus_info_pcie_vf");
207 /* Do not set type PCI-E because we don't want disable master to run */
208 bus->type = e1000_bus_type_reserved;
209 bus->speed = e1000_bus_speed_2500;
215 * e1000_get_link_up_info_vf - Gets link info.
216 * @hw: pointer to the HW structure
217 * @speed: pointer to 16 bit value to store link speed.
218 * @duplex: pointer to 16 bit value to store duplex.
220 * Since we cannot read the PHY and get accurate link info, we must rely upon
221 * the status register's data which is often stale and inaccurate.
223 STATIC s32 e1000_get_link_up_info_vf(struct e1000_hw *hw, u16 *speed,
228 DEBUGFUNC("e1000_get_link_up_info_vf");
230 status = E1000_READ_REG(hw, E1000_STATUS);
231 if (status & E1000_STATUS_SPEED_1000) {
233 DEBUGOUT("1000 Mbs, ");
234 } else if (status & E1000_STATUS_SPEED_100) {
236 DEBUGOUT("100 Mbs, ");
239 DEBUGOUT("10 Mbs, ");
242 if (status & E1000_STATUS_FD) {
243 *duplex = FULL_DUPLEX;
244 DEBUGOUT("Full Duplex\n");
246 *duplex = HALF_DUPLEX;
247 DEBUGOUT("Half Duplex\n");
250 return E1000_SUCCESS;
254 * e1000_reset_hw_vf - Resets the HW
255 * @hw: pointer to the HW structure
257 * VF's provide a function level reset. This is done using bit 26 of ctrl_reg.
258 * This is all the reset we can perform on a VF.
260 STATIC s32 e1000_reset_hw_vf(struct e1000_hw *hw)
262 struct e1000_mbx_info *mbx = &hw->mbx;
263 u32 timeout = E1000_VF_INIT_TIMEOUT;
264 s32 ret_val = -E1000_ERR_MAC_INIT;
266 u8 *addr = (u8 *)(&msgbuf[1]);
268 DEBUGFUNC("e1000_reset_hw_vf");
270 DEBUGOUT("Issuing a function level reset to MAC\n");
271 ctrl = E1000_READ_REG(hw, E1000_CTRL);
272 E1000_WRITE_REG(hw, E1000_CTRL, ctrl | E1000_CTRL_RST);
274 /* we cannot reset while the RSTI / RSTD bits are asserted */
275 while (!mbx->ops.check_for_rst(hw, 0) && timeout) {
281 /* mailbox timeout can now become active */
282 mbx->timeout = E1000_VF_MBX_INIT_TIMEOUT;
284 msgbuf[0] = E1000_VF_RESET;
285 mbx->ops.write_posted(hw, msgbuf, 1, 0);
289 /* set our "perm_addr" based on info provided by PF */
290 ret_val = mbx->ops.read_posted(hw, msgbuf, 3, 0);
292 if (msgbuf[0] == (E1000_VF_RESET |
293 E1000_VT_MSGTYPE_ACK))
294 memcpy(hw->mac.perm_addr, addr, 6);
296 ret_val = -E1000_ERR_MAC_INIT;
304 * e1000_init_hw_vf - Inits the HW
305 * @hw: pointer to the HW structure
307 * Not much to do here except clear the PF Reset indication if there is one.
309 STATIC s32 e1000_init_hw_vf(struct e1000_hw *hw)
311 DEBUGFUNC("e1000_init_hw_vf");
313 /* attempt to set and restore our mac address */
314 e1000_rar_set_vf(hw, hw->mac.addr, 0);
316 return E1000_SUCCESS;
320 * e1000_rar_set_vf - set device MAC address
321 * @hw: pointer to the HW structure
322 * @addr: pointer to the receive address
323 * @index receive address array register
325 STATIC int e1000_rar_set_vf(struct e1000_hw *hw, u8 *addr,
326 u32 E1000_UNUSEDARG index)
328 struct e1000_mbx_info *mbx = &hw->mbx;
330 u8 *msg_addr = (u8 *)(&msgbuf[1]);
333 UNREFERENCED_1PARAMETER(index);
334 memset(msgbuf, 0, 12);
335 msgbuf[0] = E1000_VF_SET_MAC_ADDR;
336 memcpy(msg_addr, addr, 6);
337 ret_val = mbx->ops.write_posted(hw, msgbuf, 3, 0);
340 ret_val = mbx->ops.read_posted(hw, msgbuf, 3, 0);
342 msgbuf[0] &= ~E1000_VT_MSGTYPE_CTS;
344 /* if nacked the address was rejected, use "perm_addr" */
346 (msgbuf[0] == (E1000_VF_SET_MAC_ADDR | E1000_VT_MSGTYPE_NACK)))
347 e1000_read_mac_addr_vf(hw);
349 return E1000_SUCCESS;
353 * e1000_hash_mc_addr_vf - Generate a multicast hash value
354 * @hw: pointer to the HW structure
355 * @mc_addr: pointer to a multicast address
357 * Generates a multicast address hash value which is used to determine
358 * the multicast filter table array address and new table value.
360 STATIC u32 e1000_hash_mc_addr_vf(struct e1000_hw *hw, u8 *mc_addr)
362 u32 hash_value, hash_mask;
365 DEBUGFUNC("e1000_hash_mc_addr_generic");
367 /* Register count multiplied by bits per register */
368 hash_mask = (hw->mac.mta_reg_count * 32) - 1;
371 * The bit_shift is the number of left-shifts
372 * where 0xFF would still fall within the hash mask.
374 while (hash_mask >> bit_shift != 0xFF)
377 hash_value = hash_mask & (((mc_addr[4] >> (8 - bit_shift)) |
378 (((u16) mc_addr[5]) << bit_shift)));
383 STATIC void e1000_write_msg_read_ack(struct e1000_hw *hw,
386 struct e1000_mbx_info *mbx = &hw->mbx;
387 u32 retmsg[E1000_VFMAILBOX_SIZE];
388 s32 retval = mbx->ops.write_posted(hw, msg, size, 0);
391 mbx->ops.read_posted(hw, retmsg, E1000_VFMAILBOX_SIZE, 0);
395 * e1000_update_mc_addr_list_vf - Update Multicast addresses
396 * @hw: pointer to the HW structure
397 * @mc_addr_list: array of multicast addresses to program
398 * @mc_addr_count: number of multicast addresses to program
400 * Updates the Multicast Table Array.
401 * The caller must have a packed mc_addr_list of multicast addresses.
403 void e1000_update_mc_addr_list_vf(struct e1000_hw *hw,
404 u8 *mc_addr_list, u32 mc_addr_count)
406 u32 msgbuf[E1000_VFMAILBOX_SIZE];
407 u16 *hash_list = (u16 *)&msgbuf[1];
411 DEBUGFUNC("e1000_update_mc_addr_list_vf");
413 /* Each entry in the list uses 1 16 bit word. We have 30
414 * 16 bit words available in our HW msg buffer (minus 1 for the
415 * msg type). That's 30 hash values if we pack 'em right. If
416 * there are more than 30 MC addresses to add then punt the
417 * extras for now and then add code to handle more than 30 later.
418 * It would be unusual for a server to request that many multi-cast
419 * addresses except for in large enterprise network environments.
422 DEBUGOUT1("MC Addr Count = %d\n", mc_addr_count);
424 msgbuf[0] = E1000_VF_SET_MULTICAST;
426 if (mc_addr_count > 30) {
427 msgbuf[0] |= E1000_VF_SET_MULTICAST_OVERFLOW;
431 msgbuf[0] |= mc_addr_count << E1000_VT_MSGINFO_SHIFT;
433 for (i = 0; i < mc_addr_count; i++) {
434 hash_value = e1000_hash_mc_addr_vf(hw, mc_addr_list);
435 DEBUGOUT1("Hash value = 0x%03X\n", hash_value);
436 hash_list[i] = hash_value & 0x0FFF;
437 mc_addr_list += ETH_ADDR_LEN;
440 e1000_write_msg_read_ack(hw, msgbuf, E1000_VFMAILBOX_SIZE);
444 * e1000_vfta_set_vf - Set/Unset vlan filter table address
445 * @hw: pointer to the HW structure
446 * @vid: determines the vfta register and bit to set/unset
447 * @set: if true then set bit, else clear bit
449 void e1000_vfta_set_vf(struct e1000_hw *hw, u16 vid, bool set)
453 msgbuf[0] = E1000_VF_SET_VLAN;
455 /* Setting the 8 bit field MSG INFO to TRUE indicates "add" */
457 msgbuf[0] |= E1000_VF_SET_VLAN_ADD;
459 e1000_write_msg_read_ack(hw, msgbuf, 2);
462 /** e1000_rlpml_set_vf - Set the maximum receive packet length
463 * @hw: pointer to the HW structure
464 * @max_size: value to assign to max frame size
466 void e1000_rlpml_set_vf(struct e1000_hw *hw, u16 max_size)
470 msgbuf[0] = E1000_VF_SET_LPE;
471 msgbuf[1] = max_size;
473 e1000_write_msg_read_ack(hw, msgbuf, 2);
477 * e1000_promisc_set_vf - Set flags for Unicast or Multicast promisc
478 * @hw: pointer to the HW structure
479 * @uni: boolean indicating unicast promisc status
480 * @multi: boolean indicating multicast promisc status
482 s32 e1000_promisc_set_vf(struct e1000_hw *hw, enum e1000_promisc_type type)
484 struct e1000_mbx_info *mbx = &hw->mbx;
485 u32 msgbuf = E1000_VF_SET_PROMISC;
489 case e1000_promisc_multicast:
490 msgbuf |= E1000_VF_SET_PROMISC_MULTICAST;
492 case e1000_promisc_enabled:
493 msgbuf |= E1000_VF_SET_PROMISC_MULTICAST;
494 case e1000_promisc_unicast:
495 msgbuf |= E1000_VF_SET_PROMISC_UNICAST;
496 case e1000_promisc_disabled:
499 return -E1000_ERR_MAC_INIT;
502 ret_val = mbx->ops.write_posted(hw, &msgbuf, 1, 0);
505 ret_val = mbx->ops.read_posted(hw, &msgbuf, 1, 0);
507 if (!ret_val && !(msgbuf & E1000_VT_MSGTYPE_ACK))
508 ret_val = -E1000_ERR_MAC_INIT;
514 * e1000_read_mac_addr_vf - Read device MAC address
515 * @hw: pointer to the HW structure
517 STATIC s32 e1000_read_mac_addr_vf(struct e1000_hw *hw)
521 for (i = 0; i < ETH_ADDR_LEN; i++)
522 hw->mac.addr[i] = hw->mac.perm_addr[i];
524 return E1000_SUCCESS;
528 * e1000_check_for_link_vf - Check for link for a virtual interface
529 * @hw: pointer to the HW structure
531 * Checks to see if the underlying PF is still talking to the VF and
532 * if it is then it reports the link state to the hardware, otherwise
533 * it reports link down and returns an error.
535 STATIC s32 e1000_check_for_link_vf(struct e1000_hw *hw)
537 struct e1000_mbx_info *mbx = &hw->mbx;
538 struct e1000_mac_info *mac = &hw->mac;
539 s32 ret_val = E1000_SUCCESS;
542 DEBUGFUNC("e1000_check_for_link_vf");
545 * We only want to run this if there has been a rst asserted.
546 * in this case that could mean a link change, device reset,
547 * or a virtual function reset
550 /* If we were hit with a reset or timeout drop the link */
551 if (!mbx->ops.check_for_rst(hw, 0) || !mbx->timeout)
552 mac->get_link_status = true;
554 if (!mac->get_link_status)
557 /* if link status is down no point in checking to see if pf is up */
558 if (!(E1000_READ_REG(hw, E1000_STATUS) & E1000_STATUS_LU))
561 /* if the read failed it could just be a mailbox collision, best wait
562 * until we are called again and don't report an error */
563 if (mbx->ops.read(hw, &in_msg, 1, 0))
566 /* if incoming message isn't clear to send we are waiting on response */
567 if (!(in_msg & E1000_VT_MSGTYPE_CTS)) {
568 /* message is not CTS and is NACK we have lost CTS status */
569 if (in_msg & E1000_VT_MSGTYPE_NACK)
570 ret_val = -E1000_ERR_MAC_INIT;
574 /* at this point we know the PF is talking to us, check and see if
575 * we are still accepting timeout or if we had a timeout failure.
576 * if we failed then we will need to reinit */
578 ret_val = -E1000_ERR_MAC_INIT;
582 /* if we passed all the tests above then the link is up and we no
583 * longer need to check for link */
584 mac->get_link_status = false;