smbus_phy.h

/* --COPYRIGHT--,BSD
 * Copyright (c) 2023, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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.
 * --/COPYRIGHT--*/
#ifndef __SMBUS_PHY_H__
#define __SMBUS_PHY_H__

//*****************************************************************************
//
//
//*****************************************************************************

//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif

#include "smbus_phy.h"
#include "smbus.h"

#define I2C_WRITE      0

#define I2C_READ       1

#define SMB_SW_TIMEOUT              (10000)

#define SMB_TIMEOUT_WAIT_CYCLES     (200)

#define SMB_POWER_STARTUP_DELAY     (16)

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void SMBus_PHY_disable(SMBus *smbus);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void SMBus_PHY_targetEnable(SMBus *smbus);

//*****************************************************************************
//
//
//
//
// \return  None
//
//*****************************************************************************
extern void SMBus_PHY_targetInit(SMBus *smbus,
                                I2C_Regs *i2cAddr);

//*****************************************************************************
//
//
//
//
//
//*****************************************************************************
extern void SMBus_PHY_targetEnableInt(SMBus *smbus);

//*****************************************************************************
//
//
//
//
//
//*****************************************************************************
extern void SMBus_PHY_targetDisableInt(SMBus *smbus);

//*****************************************************************************
//
//
//
//
//
//*****************************************************************************
extern SMBus_State SMBus_PHY_targetProcessInt(SMBus *smbus);

//*****************************************************************************
//
//
//
//
//
//*****************************************************************************
extern void SMBus_PHY_targetSetPECCount(SMBus * smbus, uint16_t length);

//*****************************************************************************
//
//
//
//
//
//*****************************************************************************
extern void SMBus_PHY_targetManualACK(SMBus *smbus, bool ackVal);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void SMBus_Phy_ARP_TARGET_ADDR_Reset(SMBus *smbus);
//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void SMBus_PHY_controllerEnable(SMBus *smbus);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint8_t SMBus_Phy_ARP_Get_Write_Status(SMBus *smbus);
//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint8_t SMBus_Phy_ARP_Get_Read_Status(SMBus *smbus);
//*****************************************************************************
//
//
//
//
//
//*****************************************************************************
extern void SMBus_PHY_controllerInit(SMBus *smbus,
                                 I2C_Regs *i2cAddr,
                                 uint32_t busClk);

//*****************************************************************************
//
//
//
//
//
//*****************************************************************************
extern void SMBus_PHY_controllerEnableInt(SMBus *smbus);

//*****************************************************************************
//
//
//
//
//
//*****************************************************************************
extern void SMBus_PHY_controllerDisableInt(SMBus *smbus);

//*****************************************************************************
//
//
//
//*****************************************************************************
extern void SMBus_PHY_controllerSendStop(SMBus *smbus);


//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void SMBus_PHY_controllerStartTx(SMBus *smbus,
                                    uint8_t targetaddr,
                                    uint16_t length,
                                    SMBus_Stop stopFlag,
                                    uint8_t setPEC);

//*****************************************************************************
//
//
//
//*****************************************************************************
extern void SMBus_PHY_controllerStartRx(SMBus *smbus,
                                    uint8_t targetaddr,
                                    uint16_t length,
                                    SMBus_Start startFlag,
                                    SMBus_Stop stopFlag,
                                    SMBus_Auto_Ack ackFlag,
                                    uint8_t setPEC);

//*****************************************************************************
//
//
//
//
//
//*****************************************************************************
extern SMBus_State SMBus_PHY_controllerProcessInt(SMBus *smbus);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void SMBus_PHY_controllerEnableHostNotify(SMBus *smbus);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern void SMBus_PHY_controllerDisableHostNotify(SMBus *smbus);

//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif

//*****************************************************************************
//
// Close the Doxygen group.
//
//*****************************************************************************

#endif //__SMBUS_PHY_H__