blob: 40d824c8e9ff6117e8b1e7e59836f77a30fbe4b9 [file] [log] [blame]
/* SPDX-License-Identifier: BSD-3-Clause */
/**
* \file phy.h
*
* \brief Macros and function definitions for EMAC PHY
*/
/*
* Copyright (C) 2010 Texas Instruments Incorporated - http://www.ti.com/
*/
/*
* 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 Texas Instruments Incorporated 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.
*
*/
#pragma once
#ifdef __cplusplus
extern "C" {
#endif
/* PHY register offset definitions */
#define PHY_BCR (0u)
#define PHY_BSR (1u)
#define PHY_ID1 (2u)
#define PHY_ID2 (3u)
#define PHY_AUTONEG_ADV (4u)
#define PHY_LINK_PARTNER_ABLTY (5u)
#define PHY_1000BT_CONTROL (9u)
#define PHY_1000BT_STATUS (0x0A)
/* PHY status definitions */
#define PHY_ID_SHIFT (16u)
#define PHY_SOFTRESET (0x8000)
#define PHY_AUTONEG_ENABLE (0x1000u)
#define PHY_AUTONEG_RESTART (0x0200u)
#define PHY_AUTONEG_COMPLETE (0x0020u)
#define PHY_AUTONEG_INCOMPLETE (0x0000u)
#define PHY_AUTONEG_STATUS (0x0020u)
#define PHY_AUTONEG_ABLE (0x0008u)
#define PHY_LPBK_ENABLE (0x4000u)
#define PHY_LINK_STATUS (0x0004u)
/* PHY ID. The LSB nibble will vary between different phy revisions */
#define PHY_ID_REV_MASK (0x0000000Fu)
/* Pause operations */
#define PHY_PAUSE_NIL (0x0000u)
#define PHY_PAUSE_SYM (0x0400u)
#define PHY_PAUSE_ASYM (0x0800u)
#define PHY_PAUSE_BOTH_SYM_ASYM (0x0C00u)
/* 1000 Base-T capabilities */
#define PHY_NO_1000BT (0x0000u)
#define PHY_1000BT_HD (0x0100u)
#define PHY_1000BT_FD (0x0200u)
/* 100 Base TX Full Duplex capability */
#define PHY_100BTX_HD (0x0000u)
#define PHY_100BTX_FD (0x0100u)
/* 100 Base TX capability */
#define PHY_NO_100BTX (0x0000u)
#define PHY_100BTX (0x0080u)
/* 10 BaseT duplex capabilities */
#define PHY_10BT_HD (0x0000u)
#define PHY_10BT_FD (0x0040u)
/* 10 BaseT ability*/
#define PHY_NO_10BT (0x0000u)
#define PHY_10BT (0x0020u)
#define PHY_LINK_PARTNER_1000BT_FD (0x0800u)
#define PHY_LINK_PARTNER_1000BT_HD (0x0400u)
/* Speed settings for BCR register */
#define PHY_SPEED_MASK (0xDFFBu)
#define PHY_SPEED_10MBPS (0x0000u)
#define PHY_SPEED_100MBPS (0x2000u)
#define PHY_SPEED_1000MBPS (0x0004u)
/**************************************************************************
API function Prototypes
**************************************************************************/
extern unsigned int PhyIDGet(unsigned int mdioBaseAddr,
unsigned int phyAddr);
extern unsigned int PhyLoopBackEnable(unsigned int mdioBaseAddr,
unsigned int phyAddr);
extern unsigned int PhyLoopBackDisable(unsigned int mdioBaseAddr,
unsigned int phyAddr);
extern unsigned int PhyAutoNegotiate(unsigned int mdioBaseAddr,
unsigned int phyAddr,
unsigned short *advPtr,
unsigned short *gigAdvPtr);
extern unsigned int PhyRegRead(unsigned int mdioBaseAddr,
unsigned int phyAddr,
unsigned int regIdx,
unsigned short *regValAdr);
extern void PhyRegWrite(unsigned int mdioBaseAddr,
unsigned int phyAddr,
unsigned int regIdx,
unsigned short regVal);
extern unsigned int PhyPartnerAbilityGet(unsigned int mdioBaseAddr,
unsigned int phyAddr,
unsigned short *ptnerAblty,
unsigned short *gbpsPtnerAblty);
extern unsigned int PhyLinkStatusGet(unsigned int mdioBaseAddr,
unsigned int phyAddr,
volatile unsigned int retries);
extern unsigned int PhyAutoNegStatusGet(unsigned int mdioBaseAddr,
unsigned int phyAddr);
#ifdef __cplusplus
}
#endif