io/ixgbe/ixgbe_api.c

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at:
 *      http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When using or redistributing this file, you may do so under the
 * License only. No other modification of this header is permitted.
 *
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright(c) 2007-2010 Intel Corporation. All rights reserved.
 */

/*
 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
 */

/* IntelVersion: 1.140 scm_061610_003709 */

#include "ixgbe_api.h"
#include "ixgbe_common.h"

extern s32 ixgbe_init_ops_82598(struct ixgbe_hw *hw);
extern s32 ixgbe_init_ops_82599(struct ixgbe_hw *hw);

/*
 * ixgbe_init_shared_code - Initialize the shared code
 * @hw: pointer to hardware structure
 *
 * This will assign function pointers and assign the MAC type and PHY code.
 * Does not touch the hardware. This function must be called prior to any
 * other function in the shared code. The ixgbe_hw structure should be
 * memset to 0 prior to calling this function.  The following fields in
 * hw structure should be filled in prior to calling this function:
 * hw_addr, back, device_id, vendor_id, subsystem_device_id,
 * subsystem_vendor_id, and revision_id
 */
s32
ixgbe_init_shared_code(struct ixgbe_hw *hw)
{
	s32 status;

	DEBUGFUNC("ixgbe_init_shared_code");

	/*
	 * Set the mac type
	 */
	(void) ixgbe_set_mac_type(hw);

	switch (hw->mac.type) {
	case ixgbe_mac_82598EB:
		status = ixgbe_init_ops_82598(hw);
		break;
	case ixgbe_mac_82599EB:
		status = ixgbe_init_ops_82599(hw);
		break;
	default:
		status = IXGBE_ERR_DEVICE_NOT_SUPPORTED;
		break;
	}

	return (status);
}

/*
 * ixgbe_set_mac_type - Sets MAC type
 * @hw: pointer to the HW structure
 *
 * This function sets the mac type of the adapter based on the
 * vendor ID and device ID stored in the hw structure.
 */
s32
ixgbe_set_mac_type(struct ixgbe_hw *hw)
{
	s32 ret_val = IXGBE_SUCCESS;

	DEBUGFUNC("ixgbe_set_mac_type\n");

	if (hw->vendor_id == IXGBE_INTEL_VENDOR_ID) {
		switch (hw->device_id) {
		case IXGBE_DEV_ID_82598:
		case IXGBE_DEV_ID_82598_BX:
		case IXGBE_DEV_ID_82598AF_SINGLE_PORT:
		case IXGBE_DEV_ID_82598AF_DUAL_PORT:
		case IXGBE_DEV_ID_82598AT:
		case IXGBE_DEV_ID_82598AT2:
		case IXGBE_DEV_ID_82598EB_CX4:
		case IXGBE_DEV_ID_82598_CX4_DUAL_PORT:
		case IXGBE_DEV_ID_82598_DA_DUAL_PORT:
		case IXGBE_DEV_ID_82598_SR_DUAL_PORT_EM:
		case IXGBE_DEV_ID_82598EB_XF_LR:
		case IXGBE_DEV_ID_82598EB_SFP_LOM:
			hw->mac.type = ixgbe_mac_82598EB;
			break;
		case IXGBE_DEV_ID_82599_KX4:
		case IXGBE_DEV_ID_82599_KX4_MEZZ:
		case IXGBE_DEV_ID_82599_XAUI_LOM:
		case IXGBE_DEV_ID_82599_COMBO_BACKPLANE:
		case IXGBE_DEV_ID_82599_KR:
		case IXGBE_DEV_ID_82599_SFP:
		case IXGBE_DEV_ID_82599_SFP_EM:
		case IXGBE_DEV_ID_82599_CX4:
		case IXGBE_DEV_ID_82599_T3_LOM:
			hw->mac.type = ixgbe_mac_82599EB;
			break;
		default:
			ret_val = IXGBE_ERR_DEVICE_NOT_SUPPORTED;
			break;
		}
	} else {
		ret_val = IXGBE_ERR_DEVICE_NOT_SUPPORTED;
	}

	DEBUGOUT2("ixgbe_set_mac_type found mac: %d, returns: %d\n",
	    hw->mac.type, ret_val);

	return (ret_val);
}

/*
 * ixgbe_init_hw - Initialize the hardware
 * @hw: pointer to hardware structure
 *
 * Initialize the hardware by resetting and then starting the hardware
 */
s32
ixgbe_init_hw(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->mac.ops.init_hw, (hw),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_reset_hw - Performs a hardware reset
 * @hw: pointer to hardware structure
 *
 * Resets the hardware by resetting the transmit and receive units, masks and
 * clears all interrupts, performs a PHY reset, and performs a MAC reset
 */
s32
ixgbe_reset_hw(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->mac.ops.reset_hw, (hw),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_start_hw - Prepares hardware for Rx/Tx
 * @hw: pointer to hardware structure
 *
 * Starts the hardware by filling the bus info structure and media type,
 * clears all on chip counters, initializes receive address registers,
 * multicast table, VLAN filter table, calls routine to setup link and
 * flow control settings, and leaves transmit and receive units disabled
 * and uninitialized.
 */
s32
ixgbe_start_hw(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->mac.ops.start_hw, (hw),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_enable_relaxed_ordering - Enables tx relaxed ordering,
 * which is disabled by default in ixgbe_start_hw();
 *
 * @hw: pointer to hardware structure
 *
 * Enable relaxed ordering;
 */
void
ixgbe_enable_relaxed_ordering(struct ixgbe_hw *hw)
{
	if (hw->mac.ops.enable_relaxed_ordering)
		hw->mac.ops.enable_relaxed_ordering(hw);
}

/*
 * ixgbe_clear_hw_cntrs - Clear hardware counters
 * @hw: pointer to hardware structure
 *
 * Clears all hardware statistics counters by reading them from the hardware
 * Statistics counters are clear on read.
 */
s32
ixgbe_clear_hw_cntrs(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->mac.ops.clear_hw_cntrs, (hw),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_get_media_type - Get media type
 * @hw: pointer to hardware structure
 *
 * Returns the media type (fiber, copper, backplane)
 */
enum ixgbe_media_type
ixgbe_get_media_type(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->mac.ops.get_media_type, (hw),
	    ixgbe_media_type_unknown);
}

/*
 * ixgbe_get_mac_addr - Get MAC address
 * @hw: pointer to hardware structure
 * @mac_addr: Adapter MAC address
 *
 * Reads the adapter's MAC address from the first Receive Address Register
 * (RAR0) A reset of the adapter must have been performed prior to calling
 * this function in order for the MAC address to have been loaded from the
 * EEPROM into RAR0
 */
s32
ixgbe_get_mac_addr(struct ixgbe_hw *hw, u8 *mac_addr)
{
	return ixgbe_call_func(hw, hw->mac.ops.get_mac_addr,
	    (hw, mac_addr), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_get_san_mac_addr - Get SAN MAC address
 * @hw: pointer to hardware structure
 * @san_mac_addr: SAN MAC address
 *
 * Reads the SAN MAC address from the EEPROM, if it's available.  This is
 * per-port, so set_lan_id() must be called before reading the addresses.
 */
s32
ixgbe_get_san_mac_addr(struct ixgbe_hw *hw, u8 *san_mac_addr)
{
	return ixgbe_call_func(hw, hw->mac.ops.get_san_mac_addr,
	    (hw, san_mac_addr), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_set_san_mac_addr - Write a SAN MAC address
 * @hw: pointer to hardware structure
 * @san_mac_addr: SAN MAC address
 *
 * Writes A SAN MAC address to the EEPROM.
 */
s32
ixgbe_set_san_mac_addr(struct ixgbe_hw *hw, u8 *san_mac_addr)
{
	return ixgbe_call_func(hw, hw->mac.ops.set_san_mac_addr,
	    (hw, san_mac_addr), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_get_device_caps - Get additional device capabilities
 * @hw: pointer to hardware structure
 * @device_caps: the EEPROM word for device capabilities
 *
 * Reads the extra device capabilities from the EEPROM
 */
s32
ixgbe_get_device_caps(struct ixgbe_hw *hw, u16 *device_caps)
{
	return ixgbe_call_func(hw, hw->mac.ops.get_device_caps,
	    (hw, device_caps), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_get_wwn_prefix - Get alternative WWNN/WWPN prefix from the EEPROM
 * @hw: pointer to hardware structure
 * @wwnn_prefix: the alternative WWNN prefix
 * @wwpn_prefix: the alternative WWPN prefix
 *
 * This function will read the EEPROM from the alternative SAN MAC address
 * block to check the support for the alternative WWNN/WWPN prefix support.
 */
s32
ixgbe_get_wwn_prefix(struct ixgbe_hw *hw, u16 *wwnn_prefix, u16 *wwpn_prefix)
{
	return ixgbe_call_func(hw, hw->mac.ops.get_wwn_prefix,
	    (hw, wwnn_prefix, wwpn_prefix), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_get_fcoe_boot_status -  Get FCOE boot status from EEPROM
 * @hw: pointer to hardware structure
 * @bs: the fcoe boot status
 *
 * This function will read the FCOE boot status from the iSCSI FCOE block
 */
s32
ixgbe_get_fcoe_boot_status(struct ixgbe_hw *hw, u16 *bs)
{
	return ixgbe_call_func(hw, hw->mac.ops.get_fcoe_boot_status,
	    (hw, bs), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_get_bus_info - Set PCI bus info
 * @hw: pointer to hardware structure
 *
 * Sets the PCI bus info (speed, width, type) within the ixgbe_hw structure
 */
s32
ixgbe_get_bus_info(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->mac.ops.get_bus_info, (hw),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_get_num_of_tx_queues - Get Tx queues
 * @hw: pointer to hardware structure
 *
 * Returns the number of transmit queues for the given adapter.
 */
u32
ixgbe_get_num_of_tx_queues(struct ixgbe_hw *hw)
{
	return (hw->mac.max_tx_queues);
}

/*
 * ixgbe_get_num_of_rx_queues - Get Rx queues
 * @hw: pointer to hardware structure
 *
 * Returns the number of receive queues for the given adapter.
 */
u32
ixgbe_get_num_of_rx_queues(struct ixgbe_hw *hw)
{
	return (hw->mac.max_rx_queues);
}

/*
 * ixgbe_stop_adapter - Disable Rx/Tx units
 * @hw: pointer to hardware structure
 *
 * Sets the adapter_stopped flag within ixgbe_hw struct. Clears interrupts,
 * disables transmit and receive units. The adapter_stopped flag is used by
 * the shared code and drivers to determine if the adapter is in a stopped
 * state and should not touch the hardware.
 */
s32
ixgbe_stop_adapter(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->mac.ops.stop_adapter, (hw),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_read_pba_num - Reads part number from EEPROM
 * @hw: pointer to hardware structure
 * @pba_num: stores the part number from the EEPROM
 *
 * Reads the part number from the EEPROM.
 */
s32
ixgbe_read_pba_num(struct ixgbe_hw *hw, u32 *pba_num)
{
	return (ixgbe_read_pba_num_generic(hw, pba_num));
}

/*
 * ixgbe_identify_phy - Get PHY type
 * @hw: pointer to hardware structure
 *
 * Determines the physical layer module found on the current adapter.
 */
s32
ixgbe_identify_phy(struct ixgbe_hw *hw)
{
	s32 status = IXGBE_SUCCESS;

	if (hw->phy.type == ixgbe_phy_unknown) {
		status = ixgbe_call_func(hw,
		    hw->phy.ops.identify,
		    (hw),
		    IXGBE_NOT_IMPLEMENTED);
	}

	return (status);
}

/*
 * ixgbe_reset_phy - Perform a PHY reset
 * @hw: pointer to hardware structure
 */
s32
ixgbe_reset_phy(struct ixgbe_hw *hw)
{
	s32 status = IXGBE_SUCCESS;

	if (hw->phy.type == ixgbe_phy_unknown) {
		if (ixgbe_identify_phy(hw) != IXGBE_SUCCESS) {
			status = IXGBE_ERR_PHY;
		}
	}

	if (status == IXGBE_SUCCESS) {
		status = ixgbe_call_func(hw, hw->phy.ops.reset, (hw),
		    IXGBE_NOT_IMPLEMENTED);
	}
	return (status);
}

/*
 * ixgbe_get_phy_firmware_version -
 * @hw: pointer to hardware structure
 * @firmware_version: pointer to firmware version
 */
s32
ixgbe_get_phy_firmware_version(struct ixgbe_hw *hw, u16 *firmware_version)
{
	s32 status = IXGBE_SUCCESS;

	status = ixgbe_call_func(hw, hw->phy.ops.get_firmware_version,
	    (hw, firmware_version), IXGBE_NOT_IMPLEMENTED);
	return (status);
}

/*
 * ixgbe_read_phy_reg - Read PHY register
 * @hw: pointer to hardware structure
 * @reg_addr: 32 bit address of PHY register to read
 * @phy_data: Pointer to read data from PHY register
 *
 * Reads a value from a specified PHY register
 */
s32
ixgbe_read_phy_reg(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
	u16 *phy_data)
{
	if (hw->phy.id == 0)
		(void) ixgbe_identify_phy(hw);

	return ixgbe_call_func(hw, hw->phy.ops.read_reg, (hw, reg_addr,
	    device_type, phy_data), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_write_phy_reg - Write PHY register
 * @hw: pointer to hardware structure
 * @reg_addr: 32 bit PHY register to write
 * @phy_data: Data to write to the PHY register
 *
 * Writes a value to specified PHY register
 */
s32 ixgbe_write_phy_reg(struct ixgbe_hw *hw, u32 reg_addr, u32 device_type,
    u16 phy_data)
{
	if (hw->phy.id == 0)
		(void) ixgbe_identify_phy(hw);

	return ixgbe_call_func(hw, hw->phy.ops.write_reg, (hw, reg_addr,
	    device_type, phy_data), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_setup_phy_link - Restart PHY autoneg
 * @hw: pointer to hardware structure
 *
 * Restart autonegotiation and PHY and waits for completion.
 */
s32
ixgbe_setup_phy_link(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->phy.ops.setup_link, (hw),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_check_phy_link - Determine link and speed status
 * @hw: pointer to hardware structure
 *
 * Reads a PHY register to determine if link is up and the current speed for
 * the PHY.
 */
s32 ixgbe_check_phy_link(struct ixgbe_hw *hw, ixgbe_link_speed *speed,
    bool *link_up)
{
	return ixgbe_call_func(hw, hw->phy.ops.check_link, (hw, speed,
	    link_up), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_setup_phy_link_speed - Set auto advertise
 * @hw: pointer to hardware structure
 * @speed: new link speed
 * @autoneg: true if autonegotiation enabled
 *
 * Sets the auto advertised capabilities
 */
s32
ixgbe_setup_phy_link_speed(struct ixgbe_hw *hw, ixgbe_link_speed speed,
    bool autoneg,
    bool autoneg_wait_to_complete)
{
	return ixgbe_call_func(hw, hw->phy.ops.setup_link_speed, (hw, speed,
	    autoneg, autoneg_wait_to_complete),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_check_link - Get link and speed status
 * @hw: pointer to hardware structure
 *
 * Reads the links register to determine if link is up and the current speed
 */
s32
ixgbe_check_link(struct ixgbe_hw *hw, ixgbe_link_speed *speed,
    bool *link_up, bool link_up_wait_to_complete)
{
	return ixgbe_call_func(hw, hw->mac.ops.check_link, (hw, speed,
	    link_up, link_up_wait_to_complete), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_disable_tx_laser - Disable Tx laser
 * @hw: pointer to hardware structure
 *
 * If the driver needs to disable the laser on SFI optics.
 */
void
ixgbe_disable_tx_laser(struct ixgbe_hw *hw)
{
	if (hw->mac.ops.disable_tx_laser)
		hw->mac.ops.disable_tx_laser(hw);
}

/*
 * ixgbe_enable_tx_laser - Enable Tx laser
 * @hw: pointer to hardware structure
 *
 * If the driver needs to enable the laser on SFI optics.
 */
void
ixgbe_enable_tx_laser(struct ixgbe_hw *hw)
{
	if (hw->mac.ops.enable_tx_laser)
		hw->mac.ops.enable_tx_laser(hw);
}

/*
 * ixgbe_flap_tx_laser - flap Tx laser to start autotry process
 * @hw: pointer to hardware structure
 *
 * When the driver changes the link speeds that it can support then
 * flap the tx laser to alert the link partner to start autotry
 * process on its end.
 */
void
ixgbe_flap_tx_laser(struct ixgbe_hw *hw)
{
	if (hw->mac.ops.flap_tx_laser)
		hw->mac.ops.flap_tx_laser(hw);
}

/*
 * ixgbe_setup_link - Set link speed
 * @hw: pointer to hardware structure
 * @speed: new link speed
 * @autoneg: true if autonegotiation enabled
 *
 * Configures link settings.  Restarts the link.
 * Performs autonegotiation if needed.
 */
s32 ixgbe_setup_link(struct ixgbe_hw *hw, ixgbe_link_speed speed,
    bool autoneg,
    bool autoneg_wait_to_complete)
{
	return ixgbe_call_func(hw, hw->mac.ops.setup_link, (hw, speed,
	    autoneg, autoneg_wait_to_complete),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_get_link_capabilities - Returns link capabilities
 * @hw: pointer to hardware structure
 *
 * Determines the link capabilities of the current configuration.
 */
s32
ixgbe_get_link_capabilities(struct ixgbe_hw *hw, ixgbe_link_speed *speed,
    bool *autoneg)
{
	return ixgbe_call_func(hw, hw->mac.ops.get_link_capabilities, (hw,
	    speed, autoneg), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_led_on - Turn on LEDs
 * @hw: pointer to hardware structure
 * @index: led number to turn on
 *
 * Turns on the software controllable LEDs.
 */
s32
ixgbe_led_on(struct ixgbe_hw *hw, u32 index)
{
	return ixgbe_call_func(hw, hw->mac.ops.led_on, (hw, index),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_led_off - Turn off LEDs
 * @hw: pointer to hardware structure
 * @index: led number to turn off
 *
 * Turns off the software controllable LEDs.
 */
s32
ixgbe_led_off(struct ixgbe_hw *hw, u32 index)
{
	return ixgbe_call_func(hw, hw->mac.ops.led_off, (hw, index),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_blink_led_start - Blink LEDs
 * @hw: pointer to hardware structure
 * @index: led number to blink
 *
 * Blink LED based on index.
 */
s32
ixgbe_blink_led_start(struct ixgbe_hw *hw, u32 index)
{
	return ixgbe_call_func(hw, hw->mac.ops.blink_led_start, (hw, index),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_blink_led_stop - Stop blinking LEDs
 * @hw: pointer to hardware structure
 *
 * Stop blinking LED based on index.
 */
s32
ixgbe_blink_led_stop(struct ixgbe_hw *hw, u32 index)
{
	return ixgbe_call_func(hw, hw->mac.ops.blink_led_stop, (hw, index),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_init_eeprom_params - Initialize EEPROM parameters
 * @hw: pointer to hardware structure
 *
 * Initializes the EEPROM parameters ixgbe_eeprom_info within the
 * ixgbe_hw struct in order to set up EEPROM access.
 */
s32
ixgbe_init_eeprom_params(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->eeprom.ops.init_params, (hw),
	    IXGBE_NOT_IMPLEMENTED);
}


/*
 * ixgbe_write_eeprom - Write word to EEPROM
 * @hw: pointer to hardware structure
 * @offset: offset within the EEPROM to be written to
 * @data: 16 bit word to be written to the EEPROM
 *
 * Writes 16 bit value to EEPROM. If ixgbe_eeprom_update_checksum is not
 * called after this function, the EEPROM will most likely contain an
 * invalid checksum.
 */
s32
ixgbe_write_eeprom(struct ixgbe_hw *hw, u16 offset, u16 data)
{
	return ixgbe_call_func(hw, hw->eeprom.ops.write, (hw, offset, data),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_read_eeprom - Read word from EEPROM
 * @hw: pointer to hardware structure
 * @offset: offset within the EEPROM to be read
 * @data: read 16 bit value from EEPROM
 *
 * Reads 16 bit value from EEPROM
 */
s32
ixgbe_read_eeprom(struct ixgbe_hw *hw, u16 offset, u16 *data)
{
	return ixgbe_call_func(hw, hw->eeprom.ops.read, (hw, offset, data),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_validate_eeprom_checksum - Validate EEPROM checksum
 * @hw: pointer to hardware structure
 * @checksum_val: calculated checksum
 *
 * Performs checksum calculation and validates the EEPROM checksum
 */
s32
ixgbe_validate_eeprom_checksum(struct ixgbe_hw *hw, u16 *checksum_val)
{
	return ixgbe_call_func(hw, hw->eeprom.ops.validate_checksum,
	    (hw, checksum_val), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_eeprom_update_checksum - Updates the EEPROM checksum
 * @hw: pointer to hardware structure
 */
s32
ixgbe_update_eeprom_checksum(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->eeprom.ops.update_checksum, (hw),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_insert_mac_addr - Find a RAR for this mac address
 * @hw: pointer to hardware structure
 * @addr: Address to put into receive address register
 * @vmdq: VMDq pool to assign
 *
 * Puts an ethernet address into a receive address register, or
 * finds the rar that it is aleady in; adds to the pool list
 */
s32
ixgbe_insert_mac_addr(struct ixgbe_hw *hw, u8 *addr, u32 vmdq)
{
	return ixgbe_call_func(hw, hw->mac.ops.insert_mac_addr,
	    (hw, addr, vmdq), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_set_rar - Set Rx address register
 * @hw: pointer to hardware structure
 * @index: Receive address register to write
 * @addr: Address to put into receive address register
 * @vmdq: VMDq "set"
 * @enable_addr: set flag that address is active
 *
 * Puts an ethernet address into a receive address register.
 */
s32
ixgbe_set_rar(struct ixgbe_hw *hw, u32 index, u8 *addr, u32 vmdq,
    u32 enable_addr)
{
	return ixgbe_call_func(hw, hw->mac.ops.set_rar, (hw, index, addr, vmdq,
	    enable_addr), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_clear_rar - Clear Rx address register
 * @hw: pointer to hardware structure
 * @index: Receive address register to write
 *
 * Puts an ethernet address into a receive address register.
 */
s32
ixgbe_clear_rar(struct ixgbe_hw *hw, u32 index)
{
	return ixgbe_call_func(hw, hw->mac.ops.clear_rar, (hw, index),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_set_vmdq - Associate a VMDq index with a receive address
 * @hw: pointer to hardware structure
 * @rar: receive address register index to associate with VMDq index
 * @vmdq: VMDq set or pool index
 */
s32
ixgbe_set_vmdq(struct ixgbe_hw *hw, u32 rar, u32 vmdq)
{
	return ixgbe_call_func(hw, hw->mac.ops.set_vmdq, (hw, rar, vmdq),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_clear_vmdq - Disassociate a VMDq index from a receive address
 * @hw: pointer to hardware structure
 * @rar: receive address register index to disassociate with VMDq index
 * @vmdq: VMDq set or pool index
 */
s32
ixgbe_clear_vmdq(struct ixgbe_hw *hw, u32 rar, u32 vmdq)
{
	return ixgbe_call_func(hw, hw->mac.ops.clear_vmdq, (hw, rar, vmdq),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_init_rx_addrs - Initializes receive address filters.
 * @hw: pointer to hardware structure
 *
 * Places the MAC address in receive address register 0 and clears the rest
 * of the receive address registers. Clears the multicast table. Assumes
 * the receiver is in reset when the routine is called.
 */
s32
ixgbe_init_rx_addrs(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->mac.ops.init_rx_addrs, (hw),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_get_num_rx_addrs - Returns the number of RAR entries.
 * @hw: pointer to hardware structure
 */
u32
ixgbe_get_num_rx_addrs(struct ixgbe_hw *hw)
{
	return (hw->mac.num_rar_entries);
}

/*
 * ixgbe_update_uc_addr_list - Updates the MAC's list of secondary addresses
 * @hw: pointer to hardware structure
 * @addr_list: the list of new multicast addresses
 * @addr_count: number of addresses
 * @func: iterator function to walk the multicast address list
 *
 * The given list replaces any existing list. Clears the secondary addrs from
 * receive address registers. Uses unused receive address registers for the
 * first secondary addresses, and falls back to promiscuous mode as needed.
 */
s32
ixgbe_update_uc_addr_list(struct ixgbe_hw *hw, u8 *addr_list,
    u32 addr_count, ixgbe_mc_addr_itr func)
{
	return ixgbe_call_func(hw, hw->mac.ops.update_uc_addr_list, (hw,
	    addr_list, addr_count, func),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_update_mc_addr_list - Updates the MAC's list of multicast addresses
 * @hw: pointer to hardware structure
 * @mc_addr_list: the list of new multicast addresses
 * @mc_addr_count: number of addresses
 * @func: iterator function to walk the multicast address list
 *
 * The given list replaces any existing list. Clears the MC addrs from receive
 * address registers and the multicast table. Uses unused receive address
 * registers for the first multicast addresses, and hashes the rest into the
 * multicast table.
 */
s32
ixgbe_update_mc_addr_list(struct ixgbe_hw *hw, u8 *mc_addr_list,
    u32 mc_addr_count, ixgbe_mc_addr_itr func)
{
	return ixgbe_call_func(hw, hw->mac.ops.update_mc_addr_list, (hw,
	    mc_addr_list, mc_addr_count, func),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_enable_mc - Enable multicast address in RAR
 * @hw: pointer to hardware structure
 *
 * Enables multicast address in RAR and the use of the multicast hash table.
 */
s32
ixgbe_enable_mc(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->mac.ops.enable_mc, (hw),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_disable_mc - Disable multicast address in RAR
 * @hw: pointer to hardware structure
 *
 * Disables multicast address in RAR and the use of the multicast hash table.
 */
s32
ixgbe_disable_mc(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->mac.ops.disable_mc, (hw),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_clear_vfta - Clear VLAN filter table
 * @hw: pointer to hardware structure
 *
 * Clears the VLAN filer table, and the VMDq index associated with the filter
 */
s32
ixgbe_clear_vfta(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->mac.ops.clear_vfta, (hw),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_set_vfta - Set VLAN filter table
 * @hw: pointer to hardware structure
 * @vlan: VLAN id to write to VLAN filter
 * @vind: VMDq output index that maps queue to VLAN id in VFTA
 * @vlan_on: boolean flag to turn on/off VLAN in VFTA
 *
 * Turn on/off specified VLAN in the VLAN filter table.
 */
s32
ixgbe_set_vfta(struct ixgbe_hw *hw, u32 vlan, u32 vind, bool vlan_on)
{
	return ixgbe_call_func(hw, hw->mac.ops.set_vfta, (hw, vlan, vind,
	    vlan_on), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_fc_enable - Enable flow control
 * @hw: pointer to hardware structure
 * @packetbuf_num: packet buffer number (0-7)
 *
 * Configures the flow control settings based on SW configuration.
 */
s32
ixgbe_fc_enable(struct ixgbe_hw *hw, s32 packetbuf_num)
{
	return ixgbe_call_func(hw, hw->mac.ops.fc_enable, (hw, packetbuf_num),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_read_analog_reg8 - Reads 8 bit analog register
 * @hw: pointer to hardware structure
 * @reg: analog register to read
 * @val: read value
 *
 * Performs write operation to analog register specified.
 */
s32
ixgbe_read_analog_reg8(struct ixgbe_hw *hw, u32 reg, u8 *val)
{
	return ixgbe_call_func(hw, hw->mac.ops.read_analog_reg8, (hw, reg,
	    val), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_write_analog_reg8 - Writes 8 bit analog register
 * @hw: pointer to hardware structure
 * @reg: analog register to write
 * @val: value to write
 *
 * Performs write operation to Atlas analog register specified.
 */
s32
ixgbe_write_analog_reg8(struct ixgbe_hw *hw, u32 reg, u8 val)
{
	return ixgbe_call_func(hw, hw->mac.ops.write_analog_reg8, (hw, reg,
	    val), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_init_uta_tables - Initializes Unicast Table Arrays.
 * @hw: pointer to hardware structure
 *
 * Initializes the Unicast Table Arrays to zero on device load.  This
 * is part of the Rx init addr execution path.
 */
s32
ixgbe_init_uta_tables(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->mac.ops.init_uta_tables, (hw),
	    IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_read_i2c_byte - Reads 8 bit word over I2C at specified device address
 * @hw: pointer to hardware structure
 * @byte_offset: byte offset to read
 * @data: value read
 *
 * Performs byte read operation to SFP module's EEPROM over I2C interface.
 */
s32
ixgbe_read_i2c_byte(struct ixgbe_hw *hw, u8 byte_offset, u8 dev_addr,
    u8 *data)
{
	return ixgbe_call_func(hw, hw->phy.ops.read_i2c_byte, (hw, byte_offset,
	    dev_addr, data), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_write_i2c_byte - Writes 8 bit word over I2C
 * @hw: pointer to hardware structure
 * @byte_offset: byte offset to write
 * @data: value to write
 *
 * Performs byte write operation to SFP module's EEPROM over I2C interface
 * at a specified device address.
 */
s32
ixgbe_write_i2c_byte(struct ixgbe_hw *hw, u8 byte_offset, u8 dev_addr,
    u8 data)
{
	return ixgbe_call_func(hw, hw->phy.ops.write_i2c_byte,
	    (hw, byte_offset, dev_addr, data), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_write_i2c_eeprom - Writes 8 bit EEPROM word over I2C interface
 * @hw: pointer to hardware structure
 * @byte_offset: EEPROM byte offset to write
 * @eeprom_data: value to write
 *
 * Performs byte write operation to SFP module's EEPROM over I2C interface.
 */
s32
ixgbe_write_i2c_eeprom(struct ixgbe_hw *hw, u8 byte_offset, u8 eeprom_data)
{
	return ixgbe_call_func(hw, hw->phy.ops.write_i2c_eeprom,
	    (hw, byte_offset, eeprom_data), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_read_i2c_eeprom - Reads 8 bit EEPROM word over I2C interface
 * @hw: pointer to hardware structure
 * @byte_offset: EEPROM byte offset to read
 * @eeprom_data: value read
 *
 * Performs byte read operation to SFP module's EEPROM over I2C interface.
 */
s32
ixgbe_read_i2c_eeprom(struct ixgbe_hw *hw, u8 byte_offset, u8 *eeprom_data)
{
	return ixgbe_call_func(hw, hw->phy.ops.read_i2c_eeprom,
	    (hw, byte_offset, eeprom_data), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_get_supported_physical_layer - Returns physical layer type
 * @hw: pointer to hardware structure
 *
 * Determines physical layer capabilities of the current configuration.
 */
u32
ixgbe_get_supported_physical_layer(struct ixgbe_hw *hw)
{
	return ixgbe_call_func(hw, hw->mac.ops.get_supported_physical_layer,
	    (hw), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_enable_rx_dma - Enables Rx DMA unit, dependant on device specifics
 * @hw: pointer to hardware structure
 * @regval: bitfield to write to the Rx DMA register
 *
 * Enables the Rx DMA unit of the device.
 */
s32
ixgbe_enable_rx_dma(struct ixgbe_hw *hw, u32 regval)
{
	return ixgbe_call_func(hw, hw->mac.ops.enable_rx_dma,
	    (hw, regval), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_acquire_swfw_semaphore - Acquire SWFW semaphore
 * @hw: pointer to hardware structure
 * @mask: Mask to specify which semaphore to acquire
 *
 * Acquires the SWFW semaphore through SW_FW_SYNC register for the specified
 * function (CSR, PHY0, PHY1, EEPROM, Flash)
 */
s32
ixgbe_acquire_swfw_semaphore(struct ixgbe_hw *hw, u16 mask)
{
	return ixgbe_call_func(hw, hw->mac.ops.acquire_swfw_sync,
	    (hw, mask), IXGBE_NOT_IMPLEMENTED);
}

/*
 * ixgbe_release_swfw_semaphore - Release SWFW semaphore
 * @hw: pointer to hardware structure
 * @mask: Mask to specify which semaphore to release
 *
 * Releases the SWFW semaphore through SW_FW_SYNC register for the specified
 * function (CSR, PHY0, PHY1, EEPROM, Flash)
 */
void
ixgbe_release_swfw_semaphore(struct ixgbe_hw *hw, u16 mask)
{
	if (hw->mac.ops.release_swfw_sync)
		hw->mac.ops.release_swfw_sync(hw, mask);
}