/*******************************************************************************
Copyright (C) Marvell International Ltd. and its affiliates

This software file (the "File") is owned and distributed by Marvell
International Ltd. and/or its affiliates ("Marvell") under the following
alternative licensing terms.  Once you have made an election to distribute the
File under one of the following license alternatives, please (i) delete this
introductory statement regarding license alternatives, (ii) delete the two
license alternatives that you have not elected to use and (iii) preserve the
Marvell copyright notice above.

********************************************************************************
Marvell Commercial License Option

If you received this File from Marvell and you have entered into a commercial
license agreement (a "Commercial License") with Marvell, the File is licensed
to you under the terms of the applicable Commercial License.

********************************************************************************
Marvell GPL License Option

If you received this File from Marvell, you may opt to use, redistribute and/or
modify this File in accordance with the terms and conditions of the General
Public License Version 2, June 1991 (the "GPL License"), a copy of which is
available along with the File in the license.txt file or by writing to the Free
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 or
on the worldwide web at http://www.gnu.org/licenses/gpl.txt.

THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY
DISCLAIMED.  The GPL License provides additional details about this warranty
disclaimer.
********************************************************************************
Marvell BSD License Option

If you received this File from Marvell, you may opt to use, redistribute and/or
modify this File under the following licensing terms.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

    *   Redistributions of source code must retain the above copyright notice,
	this list of conditions and the following disclaimer.

    *   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.

    *   Neither the name of Marvell 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 __INCETHPHYH
#define __INCETHPHYH

#ifdef __cplusplus
extern "C" {
#endif

#include "ctrlEnv/mvCtrlEnvSpec.h"
#include "mvSysEthPhyConfig.h"
#define MV_PHY_88F6601_INTERNAL 0x0
#define MV_PHY_88E3061  0x1      /* E3061, E3081 */
#define MV_PHY_88E104X  0x2      /* E1040, E1041, E1042 */
#define MV_PHY_88E10X0  0x4      /* E1000, E1010, E1020 */
#define MV_PHY_88E10X0S 0x5      /* E1000S, E1010S, E1020S */
#define MV_PHY_88E1011  0x6      /* E1011, E1011S */
#define MV_PHY_88E3082  0x8
#define MV_PHY_88E1112  0x9
#define MV_PHY_88E1149  0xA
#define MV_PHY_88E1121  0xB
#define MV_PHY_88E1111  0xC      /* E1111, E1115 */
#define MV_PHY_88E114X  0xD
#define MV_PHY_88E1181  0xE
#define MV_PHY_88E1340S 0x1C    /* 88E1340S */
#define MV_PHY_88E1512  0x1D
#define MV_PHY_88E1340  0x1E    /* 88E1340/x0a */
#define MV_PHY_88E154X  0x2B     /* 88E1545M */
#define MV_PHY_88E154X_Z1 0x2A   /* 88E1545M-Z1 */
#define MV_PHY_88E1340M 0x1F    /* 88E1340M/x0a */
#define MV_PHY_88E1116R 0x24
#define MV_PHY_88E1116  0x21     /* E1116, E1116R */
#define MV_PHY_88E3016_88E3019  0x22     /* E3015, E3016, E3018, 88E3019 */
#define MV_PHY_88E1240  0x23
#define MV_PHY_88E1149R 0x25
#define MV_PHY_88E1119R 0x28    /* 88E1119R */
#define MV_PHY_88E1310  0x29    /* 88E1310 */
#define MV_PHY_KW2_INTERNAL_GE  0x2b
#define MV_PHY_KW2_INTERNAL_3FE 0x26

#define MV_IS_MARVELL_OUI(_reg2, _reg3)		\
	(((_reg2) == 0x0141) && (((_reg3)&0xFC00) == 0x0C00))

/* PHY nego mode macro */
#define PHY_AUTO_NEGO_MODE_HALF_10 0x1
#define PHY_AUTO_NEGO_MODE_FULL_10 0x2
#define PHY_AUTO_NEGO_MODE_HALF_100 0x4
#define PHY_AUTO_NEGO_MODE_FULL_100 0x8
#define PHY_AUTO_NEGO_MODE_HALF_1000 0x10
#define PHY_AUTO_NEGO_MODE_FULL_1000 0x20

/* PHY reset expire time */
#define MV_PHY_RESET_EXPIRE_COUNT 1000

typedef struct {
	MV_U8		ctrlRevId;
	MV_U32		phyAddr[MV_ETH_MAX_PORTS];
	MV_U32		quadPhyStartAddr;
	MV_BOOL		boardSpecInit;		/* Special board phy init */
	MV_U32		specRegOff;		/* Board specific register offset, Valid if boardSpecInit == TRUE */
	MV_U32		specData;  		/* Board specific data to write, Valid if boardSpecInit == TRUE */
	MV_U32		ethPhySmiReg;		/* Ethernet unit PHY SMI register offset */
	/* Below functions are needed for initializing Quad PHYs through an
	** external switch SMI bus.
	** These are optional parameters.
	*/
	MV_STATUS	(*mvExtPhyWriteFunc)(MV_U32 phyAddr, MV_U32 regAddr, MV_U16 val);
	MV_STATUS	(*mvExtPhyReadFunc)(MV_U32 phyAddr, MV_U32 regAddr, MV_U16 *data);
} MV_ETHPHY_HAL_DATA;

/*
* typedef: enum MV_ETHPHY_PAUSE_MODE
*
* Description: Enumeration of Pause Mode in the Phy.
*
* Enumerations:
*	MV_ETHPHY_NO_PAUSE		- disable pause
*	MV_ETHPHY_PAUSE		- support pause
*	MV_ETHPHY_ASYMMETRIC_PAUSE	- support asymmetric pause
*	MV_ETHPHY_BOTH_PAUSE	- support both pause and asymmetric pause
*/
typedef enum
{
	MV_ETHPHY_NO_PAUSE = 0,
	MV_ETHPHY_PAUSE,
	MV_ETHPHY_ASYMMETRIC_PAUSE,
	MV_ETHPHY_BOTH_PAUSE
} MV_ETHPHY_PAUSE_MODE;

/*
* typedef: enum MV_ETHPHY_SPEED
*
* Description: Enumeration of Phy Speed
*
* Enumerations:
*	MV_ETHPHY_SPEED_10_MBPS   - 10Mbps
*	MV_ETHPHY_SPEED_100_MBPS  - 100Mbps
*	MV_ETHPHY_SPEED_1000_MBPS - 1000Mbps
*	MV_ETHPHY_SPEED_UNKNOWN   - Unknown speed
*/
typedef enum
{
	MV_ETHPHY_SPEED_10_MBPS,
	MV_ETHPHY_SPEED_100_MBPS,
	MV_ETHPHY_SPEED_1000_MBPS,
	MV_ETHPHY_SPEED_UNKNOWN
} MV_ETHPHY_SPEED;


MV_STATUS 	mvEthPhyHalInit(MV_ETHPHY_HAL_DATA *halData);
MV_STATUS	mvEthPhyInit(MV_U32 ethPortNum, MV_BOOL eeeEnable);
MV_STATUS	mvEthPhyRegRead(MV_U32 phyAddr, MV_U32 regOffs, MV_U16 *data);
MV_STATUS 	mvEthPhyRegWrite(MV_U32 phyAddr, MV_U32 regOffs, MV_U16 data);
MV_STATUS 	mvEthPhyReset(MV_U32 phyAddr, MV_U16 data, int timeout);
MV_STATUS 	mvEthPhyRestartAN(MV_U32 phyAddr, int timeout);
MV_STATUS 	mvEthPhyDisableAN(MV_U32 phyAddr, int speed, int duplex);
MV_STATUS   	mvEthPhyLoopback(MV_U32 phyAddr, MV_BOOL isEnable);
MV_BOOL     	mvEthPhyCheckLink(MV_U32 phyAddr);
MV_STATUS	mvEthPhyPrintStatus(MV_U32 phyAddr);
MV_STATUS	mvEthPhyAdvertiseSet(MV_U32 phyAddr, MV_U16 advertise);
MV_STATUS	mvEthPhyAdvertiseGet(MV_U32 phyAddr, MV_U16 *advertise);

MV_VOID		mvEthE1111PhyBasicInit(MV_U32 phyAddr);
MV_VOID		mvEthE1112PhyBasicInit(MV_U32 phyAddr);
MV_VOID		mvEthE1112PhyPowerDown(MV_U32 phyAddr);
MV_VOID		mvEthE1112PhyPowerUp(MV_U32 phyAddr);
MV_VOID		mvEthE1116PhyPower(MV_U32 phyAddr, MV_BOOL enable);
MV_VOID		mvEthE1116PhyBasicInit(MV_U32 phyAddr);
MV_VOID		mvEthE3016PhyBasicInit(MV_U32 phyAddr);
MV_VOID		mvEthE1011PhyBasicInit(MV_U32 phyAddr);
MV_VOID 	mvEthSgmiiToCopperPhyBasicInit(MV_U32 phyAddr);
MV_VOID		mvEth1145PhyBasicInit(MV_U32 phyAddr);
MV_VOID		mvEth1121PhyBasicInit(MV_U32 phyAddr);
MV_VOID		mvEthInternalGEPhyBasicInit(MV_U32 phyAddr, MV_BOOL eeeEnable);
MV_VOID		mvEth1540PhyBasicInit(MV_BOOL eeeEnable);
MV_VOID		mvEth1340PhyBasicInit(void);
MV_VOID		mvEth131xPhyBasicInit(MV_U32 phyAddr);
MV_VOID 	mvEthE1512PhyBasicInit(MV_U32 ethPortNum, MV_BOOL eeeEnable);
/* MV_VOID		mvEthInternal3FEPhyBasicInit(MV_U32 port); */
MV_STATUS	mvEthPhySetAdminState(MV_U32 phyAddr, MV_BOOL phy_state);
MV_STATUS	mvEthPhyGetAdminState(MV_U32 phyAddr, MV_BOOL *phy_state);
MV_STATUS	mvEthPhyGetLinkStatus(MV_U32 phyAddr, MV_BOOL *link_state);
MV_STATUS	mvEthPhyDuplexOperGet(MV_U32 phyAddr, MV_BOOL *state_valid, MV_BOOL *duplex_state);
MV_STATUS	mvEthPhyPauseSet(MV_U32 phyAddr, MV_U32 pause_state);
MV_STATUS	mvEthPhyPauseAdminGet(MV_U32 phyAddr, MV_U32 *pause_state);
MV_STATUS	mvEthPhyLoopbackSet(MV_U32 phyAddr, MV_BOOL isEnable);
MV_STATUS	mvEthPhyLoopbackGet(MV_U32 phyAddr, MV_BOOL *isEnable);
MV_STATUS	mvEthPhyLineLoopbackSet(MV_U32 phyAddr, MV_BOOL isEnable);
MV_STATUS	mvEthPhyLineLoopbackGet(MV_U32 phyAddr, MV_BOOL *isEnable);
MV_STATUS	mvEthPhyDuplexModeSet(MV_U32 phyAddr, MV_BOOL isEnable);
MV_STATUS	mvEthPhyDuplexModeAdminGet(MV_U32 phyAddr, MV_BOOL *isEnable);
MV_STATUS	mvEthPhySpeedSet(MV_U32 phyAddr, MV_U32 speed);
MV_STATUS	mvEthPhySpeedOperGet(MV_U32 phyAddr, MV_U32 *speed);
MV_STATUS	mvEthPhySpeedAdminGet(MV_U32 phyAddr, MV_U32 *speed);
MV_STATUS	mvEthPhySpeedDuplexModeSet(MV_U32 phyAddr, MV_U32 speed, MV_BOOL isEnable);
MV_STATUS	mvEthPhyAutoNegoSet(MV_U32 phyAddr, MV_BOOL isEnable);
MV_STATUS	mvEthPhyAutoNegoGet(MV_U32 phyAddr, MV_BOOL *isEnable);

#ifdef __cplusplus
}
#endif

#endif /* #ifndef __INCETHPHYH */