drivers/mdio/v0/mdio.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 MDIO_H_
#define MDIO_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <drivers/hw_include/cslr_mdio.h>
#include <kernel/dpl/SystemP.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define MDIO_LINKSEL_MDIO_MODE      (0)
 
#define MDIO_LINKSEL_MLINK_MODE     (1)
 
/* ========================================================================== */
/*                       Function Declarations                                */
/* ========================================================================== */
 
int32_t MDIO_initClock(uint32_t baseAddr);
 
int32_t MDIO_phyRegRead(uint32_t baseAddr,
                        void     *pUserGroup,
                        uint32_t phyAddr,
                        uint32_t regNum,
                        uint16_t *pData);
 
int32_t MDIO_phyRegWrite(uint32_t baseAddr,
                         void     *pUserGroup,
                         uint32_t phyAddr,
                         uint32_t regNum,
                         uint16_t wrVal);
int32_t MDIO_phyExtRegRead(uint32_t baseAddr,
                           void     *pUserGroup,
                           uint32_t phyAddr,
                           uint32_t regNum,
                           uint16_t *pData);
 
int32_t MDIO_phyExtRegWrite(uint32_t baseAddr,
                            void     *pUserGroup,
                            uint32_t phyAddr,
                            uint32_t regNum,
                            uint16_t wrVal);
 
int32_t MDIO_phyLinkStatus(uint32_t baseAddr, uint32_t phyAddr);
 
int32_t MDIO_enableLinkInterrupt(uint32_t mdioBaseAddress,
                                 uint32_t regInst,
                                 uint32_t phyAddr,
                                 uint8_t linkSel);
 
/* ========================================================================== */
/*                            Global Variables                                */
/* ========================================================================== */
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef MDIO_H_ */