EthTrcv.h

Go to the documentation of this file.

/*
*
* Copyright (c) 2019 Texas Instruments Incorporated
*
* All rights reserved not granted herein.
*
* Limited License.
*
* Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
* license under copyrights and patents it now or hereafter owns or controls to make,
* have made, use, import, offer to sell and sell ("Utilize") this software subject to the
* terms herein.  With respect to the foregoing patent license, such license is granted
* solely to the extent that any such patent is necessary to Utilize the software alone.
* The patent license shall not apply to any combinations which include this software,
* other than combinations with devices manufactured by or for TI ("TI Devices").
* No hardware patent is licensed hereunder.
*
* Redistributions must preserve existing copyright notices and reproduce this license
* (including the above copyright notice and the disclaimer and (if applicable) source
* code license limitations below) in the documentation and/or other materials provided
* with the distribution
*
* Redistribution and use in binary form, without modification, are permitted provided
* that the following conditions are met:
*
* *       No reverse engineering, decompilation, or disassembly of this software is
* permitted with respect to any software provided in binary form.
*
* *       any redistribution and use are licensed by TI for use only with TI Devices.
*
* *       Nothing shall obligate TI to provide you with source code for the software
* licensed and provided to you in object code.
*
* If software source code is provided to you, modification and redistribution of the
* source code are permitted provided that the following conditions are met:
*
* *       any redistribution and use of the source code, including any resulting derivative
* works, are licensed by TI for use only with TI Devices.
*
* *       any redistribution and use of any object code compiled from the source code
* and any resulting derivative works, are licensed by TI for use only with TI Devices.
*
* Neither the name of Texas Instruments Incorporated nor the names of its suppliers
*
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* DISCLAIMER.
*
* THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "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 TI AND TI'S LICENSORS 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.
*
*/

/*
 * Below are the global requirements which are met by this EthTrcv
 * driver which can't be mapped to a particular source ID
 */
/*
 * Requirements: MCAL-1751, MCAL-1754, MCAL-1755,
 *               MCAL-1756, MCAL-1757, MCAL-1818, MCAL-981
 */

#ifndef ETHTRCV_H_
#define ETHTRCV_H_

/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */

/* Requirements: MCAL-1825 */
#include <EthTrcv_Types.h>

#ifdef __cplusplus
extern "C" {
#endif

/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */

/*
 * Requirements: MCAL-1752
 */
#define ETHTRCV_SW_MAJOR_VERSION        (1U)

#define ETHTRCV_SW_MINOR_VERSION        (5U)

#define ETHTRCV_SW_PATCH_VERSION        (0U)
/* @} */

/*
 * Requirements: MCAL-1752
 */
#define ETHTRCV_AR_RELEASE_MAJOR_VERSION      (4U)

#define ETHTRCV_AR_RELEASE_MINOR_VERSION      (2U)

#define ETHTRCV_AR_RELEASE_REVISION_VERSION   (1U)
/* @} */

#define ETHTRCV_VENDOR_ID               (44U)

#define ETHTRCV_MODULE_ID               (73U)

#define ETHTRCV_INSTANCE_ID             (0U)
/* @} */

#define ETHTRCV_INIT_ID                 ((uint8) 0x01U)

#define ETHTRCV_SETTRCVMODE_ID          ((uint8) 0x03U)

#define ETHTRCV_GETTRCVMODE_ID          ((uint8) 0x04U)

#define ETHTRCV_SRTAUTONEGOTIA_ID       ((uint8) 0x05U)

#define ETHTRCV_GETLNKSTATE_ID          ((uint8) 0x06U)

#define ETHTRCV_GETBAUD_ID              ((uint8) 0x07U)

#define ETHTRCV_GETDPLXMODE_ID          ((uint8) 0x08U)

#define ETHTRCV_READMIIIND_ID           ((uint8) 0x09U)

#define ETHTRCV_WRITEMIIIND_ID          ((uint8) 0x0AU)

#define ETHTRCV_VERSION_ID              ((uint8) 0x0BU)

#define ETHTRCV_MAINFCT_WRITE_ID        ((uint8) 0x0CU)

#define ETHTRCV_GETTRCVWKUPMODE_ID      ((uint8) 0x0DU)

#define ETHTRCV_SETTRCVWKUPMODE_ID      ((uint8) 0x0EU)

#define ETHTRCV_CHKWKUP_ID              ((uint8) 0x0FU)

#define ETHTRCV_SETPHYTESTMODE_ID       ((uint8) 0x10U)

#define ETHTRCV_SETPHYLOOPBACKMODE_ID   ((uint8) 0x11U)

#define ETHTRCV_GETPHYSIGNALQUALITY_ID  ((uint8) 0x12U)

#define ETHTRCV_SETPHYTXMODE_ID         ((uint8) 0x13U)

#define ETHTRCV_GETCABLEDIAGNOSTICSRESULT_ID     ((uint8) 0x014U)

#define ETHTRCV_GETPHYIDENTIFIER_ID              ((uint8) 0x015U)

/* @} */
/* @} */

/*
 * Requirements: MCAL-1763
 */

#ifndef ETHTRCV_E_INV_TRCV_IDX

#define ETHTRCV_E_INV_TRCV_IDX          ((uint8) 0x01U)
#endif

#ifndef ETHTRCV_E_UNINIT

#define ETHTRCV_E_UNINIT       ((uint8) 0x02U)
#endif

#ifndef ETHTRCV_E_PARAM_POINTER

#define ETHTRCV_E_PARAM_POINTER         ((uint8) 0x03U)
#endif

#ifndef ETHTRCV_E_INIT_FAILED

#define ETHTRCV_E_INIT_FAILED           ((uint8) 0x04U)
#endif
/* @} */

/* Requirements: MCAL-1904 */
#define ETHTRCV_WAKEUP_BY_INTERRUPT     (0x0U)

#define ETHTRCV_WAKEUP_BY_POLLING       (0x1U)

#define ETHTRCV_WAKEUP_NOT_SUPPORTED    (0x2U)

/* @} */

/* ========================================================================== */
/*                         Structures and Enums                               */
/* ========================================================================== */

/* None */

/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */

FUNC(void, ETHTRCV_CODE)
EthTrcv_Init(P2CONST(EthTrcv_ConfigType, AUTOMATIC, ETHTRCV_PBCFG) CfgPtr);

#if (STD_ON == ETHTRCV_SETTRANSCEIVERMODE_API)

FUNC(Std_ReturnType, ETHTRCV_CODE)
EthTrcv_SetTransceiverMode(uint8 TrcvIdx,
                           EthTrcv_ModeType CtrlMode);
#endif

#if (STD_ON == ETHTRCV_GETTRANSCEIVERMODE_API)

FUNC(Std_ReturnType, ETHTRCV_CODE)
EthTrcv_GetTransceiverMode(uint8 TrcvIdx,
                           EthTrcv_ModeType *TrcvModePtr);
#endif

#if (ETHTRCV_WAKEUPSUPPORT_API != ETHTRCV_WAKEUP_NOT_SUPPORTED)

FUNC(Std_ReturnType, ETHTRCV_CODE)
EthTrcv_SetTransceiverWakeupMode(uint8 TrcvIdx,
                                 EthTrcv_WakeupModeType TrcvWakeupMode);
#endif

#if (ETHTRCV_WAKEUPSUPPORT_API != ETHTRCV_WAKEUP_NOT_SUPPORTED)

FUNC(Std_ReturnType, ETHTRCV_CODE)
EthTrcv_GetTransceiverWakeupMode(uint8 TrcvIdx,
                                 EthTrcv_WakeupModeType *TrcvWakeupModePtr);
#endif

#if (ETHTRCV_WAKEUPSUPPORT_API != ETHTRCV_WAKEUP_NOT_SUPPORTED)

FUNC(Std_ReturnType, ETHTRCV_CODE)
EthTrcv_CheckWakeup(uint8 TrcvIdx);
#endif

/* Requirements: MCAL-1820 */
/* The function is not required or called by an upper layer BSW software
 * component. So making internal */
#if (STD_ON == ETHTRCV_STARTAUTONEGOTIATION_API)

FUNC(Std_ReturnType, ETHTRCV_CODE)
EthTrcv_StartAutoNegotiation(uint8 TrcvIdx);
#endif

#if (STD_ON == ETHTRCV_GETLINKSTATE_API)

FUNC(Std_ReturnType, ETHTRCV_CODE)
EthTrcv_GetLinkState(uint8 TrcvIdx,
                     EthTrcv_LinkStateType *LinkStatePtr);
#endif

/*
 * Requirements: MCAL-1821
 */
/* The function is not required or called by an upper layer BSW software
 * component. So making internal */
#if (STD_ON == ETHTRCV_GETBAUDRATE_API)

FUNC(Std_ReturnType, ETHTRCV_CODE)
EthTrcv_GetBaudRate(uint8 TrcvIdx,
                    EthTrcv_BaudRateType *BaudRatePtr);
#endif

#if (STD_ON == ETHTRCV_GETDUPLEXMODE_API)

FUNC(Std_ReturnType, ETHTRCV_CODE)
EthTrcv_GetDuplexMode(uint8 TrcvIdx,
                      EthTrcv_DuplexModeType *DuplexModePtr);
#endif

#if (STD_ON == ETHTRCV_SETPHYTESTMODE_API)

FUNC(Std_ReturnType, ETHTRCV_CODE)
EthTrcv_SetPhyTestMode(uint8 TrcvIdx,
                      EthTrcv_PhyTestModeType Mode);
#endif

#if (STD_ON == ETHTRCV_SETPHYLOOPBACKMODE_API)

FUNC(Std_ReturnType, ETHTRCV_CODE)
EthTrcv_SetPhyLoopbackMode(uint8 TrcvIdx,
                      EthTrcv_PhyLoopbackModeType Mode);
#endif

#if (STD_ON == ETHTRCV_GETPHYSIGNALQUALITY_API)

FUNC(Std_ReturnType, ETHTRCV_CODE)
EthTrcv_GetPhySignalQuality(uint8 TrcvIdx,
                      uint32* SignalQualityPtr);
#endif

#if (STD_ON == ETHTRCV_SETPHYTXMODE_API)

FUNC(Std_ReturnType, ETHTRCV_CODE)
 EthTrcv_SetPhyTxMode(uint8 TrcvIdx,
                      EthTrcv_PhyTxModeType Mode);
#endif

#if (STD_ON == ETHTRCV_GETCABLEDIAGNOSTICSRESULT_API)

FUNC(Std_ReturnType, ETHTRCV_CODE)
 EthTrcv_GetCableDiagnosticsResult(uint8 TrcvIdx,
                      EthTrcv_CableDiagResultType * ResultPtr);
#endif

#if (STD_ON == ETHTRCV_GETPHYIDENTIFIER_API)

FUNC(Std_ReturnType, ETHTRCV_CODE)
Std_ReturnType EthTrcv_GetPhyIdentifier(uint8 TrcvIdx,
                                        uint32* OrgUniqueIdPtr,
                                        uint8* ModelNrPtr,
                                        uint8* RevisionNrPtr);
#endif

#if (STD_ON == ETHTRCV_VERSION_INFO_API)

FUNC(void, ETHTRCV_CODE)
EthTrcv_GetVersionInfo(P2VAR(Std_VersionInfoType, AUTOMATIC, ETHTRCV_APPL_DATA) VersionInfoPtr);
#endif

/* Important Note:
 * There is discrepancy in the Eth and EthTrcv specs. Data type for RegVal in
 * EthTrcv_ReadMiiIndication is uint8 as per Eth Trcv spec where as Eth_ReadMii
 * takes uint16 pointer RegValPtr. To avoid data loss we change RegVal data type
 * to uint16 */
FUNC(void, ETHTRCV_CODE)
EthTrcv_ReadMiiIndication(uint8 CtrlIdx,
                          uint8 TrcvIdx,
                          uint8 RegIdx,
                          uint16 RegVal);

FUNC(void, ETHTRCV_CODE)
EthTrcv_WriteMiiIndication(uint8 CtrlIdx,
                           uint8 TrcvIdx,
                           uint8 RegId);

FUNC(void, ETHTRCV_CODE)
EthTrcv_MainFunction(void);

#ifdef __cplusplus
}
#endif

#endif /* ETHTRCV_H_ */

/* @} */