ethphy.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021 Texas Instruments Incorporated
 *
 *  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.
 */
 
#ifndef ETHPHY_H_
#define ETHPHY_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define ETHPHY_CMD_ENABLE_MII                           (0U)
 
#define ETHPHY_CMD_SOFT_RESTART                         (1U)
 
#define ETHPHY_CMD_ENABLE_AUTO_MDIX                     (2U)
 
#define ETHPHY_CMD_VERIFY_IDENTIFIER_REGISTER           (3U)
 
#define ETHPHY_CMD_DISABLE_1000M_ADVERTISEMENT          (4U)
 
#define ETHPHY_CMD_ENABLE_FAST_LINK_DOWN_DETECTION      (5U)
 
#define ETHPHY_CMD_CONFIGURE_LED_SOURCE                 (6U)
 
#define ETHPHY_CMD_CONFIGURE_LED_BLINK_RATE             (7U)
 
#define ETHPHY_CMD_ENABLE_EXTENDED_FD_ABILITY           (8U)
 
#define ETHPHY_CMD_ENABLE_ODD_NIBBLE_DETECTION          (9U)
 
#define ETHPHY_CMD_ENABLE_ENHANCED_IPG_DETECTION        (10U)
 
#define ETHPHY_CMD_GET_LINK_STATUS                      (11U)
 
#define ETHPHY_CMD_GET_SPEED_AND_DUPLEX_CONFIG          (12U)
 
#define ETHPHY_CMD_SET_SPEED_AND_DUPLEX_CONFIG          (13U)
 
#define ETHPHY_CMD_ENABLE_LOW_LATENCY_10M_100M_RGMII    (14U)
 
#define ETHPHY_CMD_SET_RX_HALF_FULL_THRESHOLD_RGMII     (15U)
 
#define ETHPHY_CMD_SET_TX_HALF_FULL_THRESHOLD_RGMII     (16U)
 
#define ETHPHY_CMD_GET_AUTONEG_COMPLETE_STATUS          (17U)
 
#define ETHPHY_CMD_GET_LINK_PARTNER_AUTONEG_ABILITY     (18U)
 
#define ETHPHY_CMD_ENABLE_IEEE_POWER_DOWN               (19U)
 
#define ETHPHY_CMD_DISABLE_IEEE_POWER_DOWN              (20U)
 
#define ETHPHY_SPEED_DUPLEX_CONFIG_AUTONEG       (0U)
#define ETHPHY_SPEED_DUPLEX_CONFIG_10FD          (1U)
#define ETHPHY_SPEED_DUPLEX_CONFIG_100FD         (2U)
#define ETHPHY_SPEED_DUPLEX_CONFIG_1000FD        (3U)
#define ETHPHY_SPEED_DUPLEX_CONFIG_10HD          (4U)
#define ETHPHY_SPEED_DUPLEX_CONFIG_100HD         (5U)
#define ETHPHY_SPEED_DUPLEX_CONFIG_1000HD        (6U)
#define ETHPHY_SPEED_DUPLEX_CONFIG_INVALID       (7U)
 
typedef void *ETHPHY_Handle;
typedef struct ETHPHY_Config_s ETHPHY_Config;
typedef struct ETHPHY_Params_s ETHPHY_Params;
 
typedef int32_t (*ETHPHY_OpenFxn)(ETHPHY_Config *config, const ETHPHY_Params *params);
 
typedef void (*ETHPHY_CloseFxn)(ETHPHY_Config *config);
 
typedef int32_t (*ETHPHY_CommandFxn)(ETHPHY_Config  *config,
                                     uint32_t       command,
                                     void           *data,
                                     uint32_t       dataSize);
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct ETHPHY_Params_s
{
    uint32_t reserved; 
} ETHPHY_Params;
 
typedef struct ETHPHY_Fxns_s
{
    ETHPHY_OpenFxn     openFxn;    
    ETHPHY_CloseFxn    closeFxn;   
    ETHPHY_CommandFxn  commandFxn; 
} ETHPHY_Fxns;
 
typedef struct ETHPHY_Attrs_s
{
    uint32_t mdioBaseAddress; 
    uint32_t phyAddress;      
} ETHPHY_Attrs;
 
typedef struct ETHPHY_Config_s
{
    ETHPHY_Attrs *attrs;     
    ETHPHY_Fxns  *fxns;      
    void         *object;    
} ETHPHY_Config;
 
typedef struct ETHPHY_SpeedDuplexConfig_s
{
    uint32_t config; 
} ETHPHY_SpeedDuplexConfig;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
void ETHPHY_Params_init(ETHPHY_Params *params);
 
ETHPHY_Handle ETHPHY_open(uint32_t instanceId, const ETHPHY_Params *params);
 
void ETHPHY_close(ETHPHY_Handle handle);
 
int32_t ETHPHY_command(ETHPHY_Handle handle,
                       uint32_t command,
                       void *data,
                       uint32_t dataSize);
 
const ETHPHY_Attrs *ETHPHY_getAttrs(uint32_t instanceId);
 
/* ========================================================================== */
/*                  Internal/Private Structure Declarations                   */
/* ========================================================================== */
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef ETHPHY_H_ */