/*
 * This file is provided under a CDDLv1 license.  When using or
 * redistributing this file, you may do so under this license.
 * In redistributing this file this license must be included
 * and no other modification of this header file is permitted.
 *
 * CDDL LICENSE SUMMARY
 *
 * Copyright(c) 1999 - 2009 Intel Corporation. All rights reserved.
 *
 * The contents of this file are subject to the terms of Version
 * 1.0 of the Common Development and Distribution License (the "License").
 *
 * You should have received a copy of the License with this software.
 * 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.
 */

/*
 * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms of the CDDLv1.
 */

/*
 * Copyright (c) 2001-2010, Intel Corporation
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 *  3. Neither the name of the Intel Corporation nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _E1000_ICH8LAN_H_
#define	_E1000_ICH8LAN_H_

#ifdef __cplusplus
extern "C" {
#endif

#define	ICH_FLASH_GFPREG		0x0000
#define	ICH_FLASH_HSFSTS		0x0004
#define	ICH_FLASH_HSFCTL		0x0006
#define	ICH_FLASH_FADDR			0x0008
#define	ICH_FLASH_FDATA0		0x0010

/* Requires up to 10 seconds when MNG might be accessing part. */
#define	ICH_FLASH_READ_COMMAND_TIMEOUT	10000000
#define	ICH_FLASH_WRITE_COMMAND_TIMEOUT	10000000
#define	ICH_FLASH_ERASE_COMMAND_TIMEOUT	10000000
#define	ICH_FLASH_LINEAR_ADDR_MASK	0x00FFFFFF
#define	ICH_FLASH_CYCLE_REPEAT_COUNT	10

#define	ICH_CYCLE_READ			0
#define	ICH_CYCLE_WRITE			2
#define	ICH_CYCLE_ERASE			3

#define	FLASH_GFPREG_BASE_MASK		0x1FFF
#define	FLASH_SECTOR_ADDR_SHIFT		12

#define	ICH_FLASH_SEG_SIZE_256		256
#define	ICH_FLASH_SEG_SIZE_4K		4096
#define	ICH_FLASH_SEG_SIZE_8K		8192
#define	ICH_FLASH_SEG_SIZE_64K		65536
#define	ICH_FLASH_SECTOR_SIZE		4096

#define	ICH_FLASH_REG_MAPSIZE		0x00A0

#define	E1000_ICH_FWSM_RSPCIPHY		0x00000040 /* Reset PHY on PCI Reset */
#define	E1000_ICH_FWSM_DISSW		0x10000000 /* FW Disables SW Writes */
/* FW established a valid mode */
#define	E1000_ICH_FWSM_FW_VALID		0x00008000

#define	E1000_ICH_MNG_IAMT_MODE		0x2

#define	ID_LED_DEFAULT_ICH8LAN	((ID_LED_DEF1_DEF2 << 12) | \
				(ID_LED_OFF1_OFF2 << 8) | \
				(ID_LED_OFF1_ON2 << 4) | \
				(ID_LED_DEF1_DEF2))

#define	E1000_ICH_NVM_SIG_WORD		0x13
#define	E1000_ICH_NVM_SIG_MASK		0xC000
#define	E1000_ICH_NVM_VALID_SIG_MASK	0xC0
#define	E1000_ICH_NVM_SIG_VALUE		0x80

#define	E1000_ICH8_LAN_INIT_TIMEOUT	1500

#define	E1000_FEXTNVM_SW_CONFIG		1
#define	E1000_FEXTNVM_SW_CONFIG_ICH8M	(1 << 27) /* Bit redefined for ICH8M */

#define	E1000_FEXTNVM4_BEACON_DURATION_MASK	0x7
#define	E1000_FEXTNVM4_BEACON_DURATION_8USEC	0x7
#define	E1000_FEXTNVM4_BEACON_DURATION_16USEC	0x3

#define	PCIE_ICH8_SNOOP_ALL	PCIE_NO_SNOOP_ALL

#define	E1000_ICH_RAR_ENTRIES		7
#define	E1000_PCH2_RAR_ENTRIES		5 /* RAR[0], SHRA[0-3] */

#define	PHY_PAGE_SHIFT	5
#define	PHY_REG(page, reg)	(((page) << PHY_PAGE_SHIFT) | \
				((reg) & MAX_PHY_REG_ADDRESS))
#define	IGP3_KMRN_DIAG	PHY_REG(770, 19) /* KMRN Diagnostic */
#define	IGP3_VR_CTRL	PHY_REG(776, 18) /* Voltage Regulator Control */
#define	IGP3_CAPABILITY	PHY_REG(776, 19) /* Capability */
#define	IGP3_PM_CTRL	PHY_REG(769, 20) /* Power Management Control */

#define	IGP3_KMRN_DIAG_PCS_LOCK_LOSS		0x0002
#define	IGP3_VR_CTRL_DEV_POWERDOWN_MODE_MASK	0x0300
#define	IGP3_VR_CTRL_MODE_SHUTDOWN		0x0200
#define	IGP3_PM_CTRL_FORCE_PWR_DOWN		0x0020

/* PHY Wakeup Registers and defines */
#define	BM_RCTL		PHY_REG(BM_WUC_PAGE, 0)
#define	BM_WUC		PHY_REG(BM_WUC_PAGE, 1)
#define	BM_WUFC		PHY_REG(BM_WUC_PAGE, 2)
#define	BM_WUS		PHY_REG(BM_WUC_PAGE, 3)
#define	BM_RAR_L(_i)	(BM_PHY_REG(BM_WUC_PAGE, 16 + ((_i) << 2)))
#define	BM_RAR_M(_i)    (BM_PHY_REG(BM_WUC_PAGE, 17 + ((_i) << 2)))
#define	BM_RAR_H(_i)    (BM_PHY_REG(BM_WUC_PAGE, 18 + ((_i) << 2)))
#define	BM_RAR_CTRL(_i) (BM_PHY_REG(BM_WUC_PAGE, 19 + ((_i) << 2)))
#define	BM_MTA(_i)	(BM_PHY_REG(BM_WUC_PAGE, 128 + ((_i) << 1)))

#define	BM_RCTL_UPE	0x0001	/* Unicast Promiscuous Mode */
#define	BM_RCTL_MPE	0x0002	/* Multicast Promiscuous Mode */
#define	BM_RCTL_MO_SHIFT	3	/* Multicast Offset Shift */
#define	BM_RCTL_MO_MASK	(3 << 3)	/* Multicast Offset Mask */
#define	BM_RCTL_BAM	0x0020	/* Broadcast Accept Mode */
#define	BM_RCTL_PMCF	0x0040	/* Pass MAC Control Frames */
#define	BM_RCTL_RFCE	0x0080	/* Rx Flow Control Enable */

#define	HV_LED_CONFIG		PHY_REG(768, 30) /* LED Configuration */
#define	HV_MUX_DATA_CTRL	PHY_REG(776, 16)
#define	HV_MUX_DATA_CTRL_GEN_TO_MAC	0x0400
#define	HV_MUX_DATA_CTRL_FORCE_SPEED	0x0004
#define	HV_SCC_UPPER		PHY_REG(778, 16) /* Single Collision Count */
#define	HV_SCC_LOWER		PHY_REG(778, 17)
#define	HV_ECOL_UPPER		PHY_REG(778, 18) /* Excessive Collision Count */
#define	HV_ECOL_LOWER		PHY_REG(778, 19)
#define	HV_MCC_UPPER		PHY_REG(778, 20) /* Multiple Collision Count */
#define	HV_MCC_LOWER		PHY_REG(778, 21)
#define	HV_LATECOL_UPPER	PHY_REG(778, 23) /* Late Collision Count */
#define	HV_LATECOL_LOWER	PHY_REG(778, 24)
#define	HV_COLC_UPPER		PHY_REG(778, 25) /* Collision Count */
#define	HV_COLC_LOWER		PHY_REG(778, 26)
#define	HV_DC_UPPER		PHY_REG(778, 27) /* Defer Count */
#define	HV_DC_LOWER		PHY_REG(778, 28)
#define	HV_TNCRS_UPPER		PHY_REG(778, 29) /* Transmit with no CRS */
#define	HV_TNCRS_LOWER		PHY_REG(778, 30)

/* PCH Flow Control Refresh Timer Value */
#define	E1000_FCRTV_PCH		0x05F40

#define	E1000_NVM_K1_CONFIG	0x1B	/* NVM K1 Config Word */
#define	E1000_NVM_K1_ENABLE	0x1	/* NVM Enable K1 bit */

/* SMBus Address Phy Register */
#define	HV_SMB_ADDR	PHY_REG(768, 26)
#define	HV_SMB_ADDR_MASK	0x007F
#define	HV_SMB_ADDR_PEC_EN	0x0200
#define	HV_SMB_ADDR_VALID	0x0080

/* Strapping Option Register - RO */
#define	E1000_STRAP	0x0000C
#define	E1000_STRAP_SMBUS_ADDRESS_MASK	0x00FE0000
#define	E1000_STRAP_SMBUS_ADDRESS_SHIFT	17

/* OEM Bits Phy Register */
#define	HV_OEM_BITS	PHY_REG(768, 25)
#define	HV_OEM_BITS_LPLU	0x0004	/* Low Power Link Up */
#define	HV_OEM_BITS_GBE_DIS	0x0040	/* Gigabit Disable */
#define	HV_OEM_BITS_RESTART_AN	0x0400	/* Restart Auto-negotiation */
/* Phy address bit from LCD Config word */
#define	LCD_CFG_PHY_ADDR_BIT	0x0020

/* KMRN Mode Control */
#define	HV_KMRN_MODE_CTRL	PHY_REG(769, 16)
#define	HV_KMRN_MDIO_SLOW	0x0400

/* KMRN FIFO Control and Status */
#define	HV_KMRN_FIFO_CTRLSTA			PHY_REG(770, 16)
#define	HV_KMRN_FIFO_CTRLSTA_PREAMBLE_MASK	0x7000
#define	HV_KMRN_FIFO_CTRLSTA_PREAMBLE_SHIFT	12

/* PHY Power Management Control */
#define	HV_PM_CTRL		PHY_REG(770, 17)

/* SW Semaphore flag timeout in milliseconds */
#define	SW_FLAG_TIMEOUT		400

/* PHY Low Power Idle Control */
#define	I82579_LPI_CTRL		PHY_REG(772, 20)
#define	I82579_LPI_CTRL_ENABLE_MASK	0x6000

/* EMI Registers */
#define	I82579_EMI_ADDR		0x10
#define	I82579_EMI_DATA		0x11
#define	I82579_LPI_UPDATE_TIMER	0x4805 /* in 40ns units + 40 ns base value */

/* PHY Low Power Idle Control */
#define	I82579_LPI_CTRL			PHY_REG(772, 20)
#define	I82579_LPI_CTRL_ENABLE_MASK	0x6000

/* EMI Registers */
#define	I82579_EMI_ADDR		0x10
#define	I82579_EMI_DATA		0x11
#define	I82579_LPI_UPDATE_TIMER	0x4805 /* in 40ns units + 40 ns base value */

/*
 * Additional interrupts need to be handled for ICH family:
 *  DSW = The FW changed the status of the DISSW bit in FWSM
 *  PHYINT = The LAN connected device generates an interrupt
 *  EPRST = Manageability reset event
 */
#define	IMS_ICH_ENABLE_MASK (\
    E1000_IMS_DSW   | \
    E1000_IMS_PHYINT | \
    E1000_IMS_EPRST)

/* Additional interrupt register bit definitions */
#define	E1000_ICR_LSECPNC	0x00004000	/* PN threshold - client */
#define	E1000_IMS_LSECPNC	E1000_ICR_LSECPNC /* PN threshold - client */
#define	E1000_ICS_LSECPNC	E1000_ICR_LSECPNC /* PN threshold - client */

/* Security Processing bit Indication */
#define	E1000_RXDEXT_LINKSEC_STATUS_LSECH	0x01000000
#define	E1000_RXDEXT_LINKSEC_ERROR_BIT_MASK	0x60000000
#define	E1000_RXDEXT_LINKSEC_ERROR_NO_SA_MATCH	0x20000000
#define	E1000_RXDEXT_LINKSEC_ERROR_REPLAY_ERROR	0x40000000
#define	E1000_RXDEXT_LINKSEC_ERROR_BAD_SIG	0x60000000

/* Receive Address Initial CRC Calculation */
#define	E1000_PCH_RAICC(_n)	(0x05F50 + ((_n) * 4))

void e1000_set_kmrn_lock_loss_workaround_ich8lan(struct e1000_hw *hw,
    bool state);
void e1000_igp3_phy_powerdown_workaround_ich8lan(struct e1000_hw *hw);
void e1000_gig_downshift_workaround_ich8lan(struct e1000_hw *hw);
void e1000_disable_gig_wol_ich8lan(struct e1000_hw *hw);
s32 e1000_configure_k1_ich8lan(struct e1000_hw *hw, bool k1_enable);
s32 e1000_oem_bits_config_ich8lan(struct e1000_hw *hw, bool d0_config);
s32 e1000_lv_jumbo_workaround_ich8lan(struct e1000_hw *hw, bool enable);

#ifdef __cplusplus
}
#endif

#endif	/* _E1000_ICH8LAN_H_ */