smbus.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_H__
#define __SMBUS_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 files
//
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>

#include <ti/devices/msp/msp.h>
#include <ti/driverlib/driverlib.h>
#include <ti/driverlib/m0p/dl_core.h>

//*****************************************************************************
// defines
//*****************************************************************************


//*****************************************************************************
// Configuration
//*****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************
#ifndef SMB_TARGET_SUPPORTS_HOST_NOTIFY
#define SMB_TARGET_SUPPORTS_HOST_NOTIFY         (true)
#endif

//*****************************************************************************
//
//
//*****************************************************************************
#ifndef SMB_CONTROLLER_SUPPORTS_HOST_NOTIFY
#define SMB_CONTROLLER_SUPPORTS_HOST_NOTIFY     (true)
#endif

//*****************************************************************************
// Constant definitions
//*****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************
#define SMB_MAX_PAYLOAD_SIZE                    (255)

//*****************************************************************************
//
//
//*****************************************************************************
#define SMB_MAX_PACKET_SIZE                     (SMB_MAX_PAYLOAD_SIZE + 3)

//*****************************************************************************
//
//
//*****************************************************************************
#define SMB_HOST_ALERT_PACKET_SIZE              (3)

//*****************************************************************************
//
//
//*****************************************************************************
#define SMB_HOST_DEFAULT_ADDRESS                (0x08)

//*****************************************************************************
//
//
//*****************************************************************************
#define RESPONSE_NTR                             0xFF

//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_RET_OK                            (1)
//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_RET_OK_FIXED                      (2)
//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_RET_OK_BLOCK                      (3)


//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_RET_ERROR                         (-1)

//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_BLOCK_LENGTH                      (0xFFFF)

//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_CMD_PREPARE_TO_ARP            0x01
//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_CMD_ARP_RESET_DEVICE          0x02
//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_CMD_ARP_GET_UDID              0x03
//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_CMD_ARP_ASSIGN_ADDRESS        0x04

//*****************************************************************************
//
// Fixed addresses defined by the SMBus specification.
//
//*****************************************************************************
//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_ADR_HOST                      0x08
//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_ADR_SMART_BATTERY_CHARGER     0x09
//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_ADR_SMART_BATTERY_SELECTOR    0x0A
//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_ADR_SMART_BATTERY             0x0B
//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_ADR_DEFAULT_DEVICE            0x61
//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_TARGET_OWN_ADDRESS            SMBUS_ADR_SMART_BATTERY_CHARGER
//*****************************************************************************
//
//
//*****************************************************************************
#define SMBUS_ARP_UDID_LEN                  0x11

//*****************************************************************************
//
//*****************************************************************************
#define ARP_ADD_RESOLVED                    0x00
//*****************************************************************************
//
//*****************************************************************************
#define ARP_ADD_VALID                       0x00
//*****************************************************************************
//
//*****************************************************************************
#define ARP_ADD_TYPE                        0x00

//*****************************************************************************
// typedefs
//*****************************************************************************

//*****************************************************************************
//
//
//*****************************************************************************
typedef enum
{
    SMBus_Stop_After_Transfer = 0,
    SMBus_No_Stop_After_Transfer
} SMBus_Stop;

//*****************************************************************************
//
//
//*****************************************************************************
typedef enum
{
    SMBus_Start_Before_Transfer = 0,
    SMBus_No_Start_Before_Transfer
} SMBus_Start;

//*****************************************************************************
//
//
//*****************************************************************************
typedef enum
{
    SMBus_Auto_Ack_Last_Byte = 0,
    SMBus_No_Auto_Ack_Last_Byte
} SMBus_Auto_Ack;

//*****************************************************************************
//
//
//*****************************************************************************
typedef union
{
    //*****************************************************************************
    //
    //
    //*****************************************************************************
    struct
    {
        uint8_t pecEn       : 1;
        uint8_t hostNotifyEn : 1;
        uint8_t swackEn     : 1;
        uint8_t intEn       : 1;
        uint8_t phyEn       : 1;
        uint8_t controller  : 1;
        uint8_t reserved2   : 2;
    } bits;
    //*****************************************************************************
    //
    //
    //*****************************************************************************
    struct
    {
        uint8_t writeBits  : 2;
        uint8_t reserved   : 6;
    } writeableBits;
    uint8_t u8byte;
} SMBus_Ctrl;

//*****************************************************************************
//
//
//*****************************************************************************
#ifdef __MSPM0_HAS_I2C__
typedef struct
{
    I2C_Regs*  SMBus_Phy_i2cBase;  
    SMBus_Stop SMBus_Phy_stop;     
    bool       SMBus_Phy_AckPending;
} SMBus_Phy;
#endif

#if defined(__MCU_HAS_UNICOMMI2CC__) && defined(__MCU_HAS_UNICOMMI2CT__)
typedef struct
{
    UNICOMM_Inst_Regs*  SMBus_Phy_i2cBase;
    SMBus_Stop SMBus_Phy_stop;
    bool       SMBus_Phy_AckPending;
} SMBus_Phy;
#endif

//*****************************************************************************
//
//
//*****************************************************************************
typedef enum
{
    SMBus_NwkState_Idle = 0,              
    SMBus_NwkState_RX,                    
    SMBus_NwkState_TX,
    SMBus_NwkState_TXHostAlert,
    SMBus_NwkState_TXQuickCMD,            
    SMBus_NwkState_TX_Resp,               
    SMBus_NwkState_TX_Block,              
    SMBus_NwkState_RX_Block_Byte_Count,   
    SMBus_NwkState_RX_Block_Payload,      
    SMBus_NwkState_Ending,                
    SMBus_NwkState_Error                  
} SMBus_NwkState;

//*****************************************************************************
//
//
//*****************************************************************************
typedef struct
{

    uint8_t ui8DeviceCapabilities;


    uint8_t ui8Version;


    uint16_t ui16VendorID;


    uint16_t ui16DeviceID;


    uint16_t ui16Interface;


    uint16_t ui16SubSystemVendorID;


    uint16_t ui16SubSystemDeviceID;


    uint32_t ui32VendorSpecificID;
}
tSMBusUDID;

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

//
//
//*****************************************************************************
typedef struct
{
    volatile SMBus_NwkState eState;       
    uint8_t currentAddr;                  
    uint8_t currentCmd;                   
    uint16_t rxIndex;
    uint16_t rxLen;
    uint16_t rxSize;
    uint8_t *rxBuffPtr;                   
    uint16_t txIndex;
    uint16_t txLen;
    uint8_t *txBuffPtr;                   
    uint8_t *recByteTxPtr;                
    uint16_t txSize;
    uint8_t pecBlockLenOverride;
    uint8_t *hostNotifyRxBuffPtr;

     tSMBusUDID *pUDID;

} SMBus_Nwk;

//*****************************************************************************
//
//
//*****************************************************************************
typedef enum
{
    SMBus_ErrorCode_NoError = 0,   
    SMBus_ErrorCode_Packet,        
    SMBus_ErrorCode_Cmd            
} SMBus_ErrorCode;

//*****************************************************************************
//
//
//*****************************************************************************
typedef enum
{
    SMBus_State_OK = 0,                 
    SMBus_State_DataSizeError,          
    SMBus_State_PECError,               
    SMBus_State_TimeOutError,           
    SMBus_State_Target_FirstByte, 
    SMBus_State_Target_ByteReceived,     
    SMBus_State_Target_QCMD,             
    SMBus_State_Target_CmdComplete,      
    SMBus_State_Target_Error,            
    SMBus_State_Target_NotReady,         
    SMBus_State_Target_NTR,              
    SMBus_State_Controller_ArbLost,         
    SMBus_State_Controller_NACK,            
    SMBus_State_Controller_Error,           
    SMBus_State_Controller_HostNotify,
    SMBus_State_Invalid_ARP_Cmd,
    SMBus_State_Unknown
} SMBus_State;

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

//
//
//*****************************************************************************
typedef union
{
    //*****************************************************************************
    //
    //
    //*****************************************************************************
    struct
    {
        uint8_t pecErr      : 1;    
        uint8_t toErr       : 1;    
        uint8_t packErr     : 1;    
        uint8_t packOvrErr  : 1;    
        uint8_t byteOvrErr  : 1;    
        uint8_t cmdErr      : 1;    
        uint8_t reserved    : 2;    
    } bits;
    uint8_t u8byte;
} SMBus_Status;

/****************************************************************************** */
//
//
//*****************************************************************************
typedef struct
{
        uint8_t arpAddResolved;
        uint8_t arpAddressValid;
        uint8_t arpInProgress;
        uint8_t arpCommand;
        uint16_t arpDataLength;
        uint8_t arpRxData;
        SMBus_State errorState;
        uint8_t arpUDIDNacked;
        uint8_t arpUDIDTransmit;
        uint32_t arpWriteState;
} SMBus_ARP_Status;
//*****************************************************************************
//
//
//*****************************************************************************
typedef struct
{
    SMBus_Phy phy;                  
    SMBus_Nwk nwk;                  
    SMBus_Ctrl ctrl;                
    SMBus_Status status;
    SMBus_ARP_Status arpStatus;
    SMBus_State state;
    uint8_t ownTargetAddr;
    uint8_t arpUDIDNacked;
} SMBus;

//*****************************************************************************
// globals
//*****************************************************************************

//*****************************************************************************
// Public functions called by applications
//*****************************************************************************
//*****************************************************************************
//
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_processDone(SMBus *smbus);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint16_t SMBus_getRxPayloadAvailable(SMBus *smbus);

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

//*****************************************************************************
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_enablePEC(SMBus *smbus);
//*****************************************************************************
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_disablePEC(SMBus *smbus);

#if defined(__MSPM0_HAS_I2C__)
//*****************************************************************************
//
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_targetInit(SMBus *smbus, I2C_Regs *i2cAddr);
#endif

#if defined(__MCU_HAS_UNICOMMI2CT__)
//*****************************************************************************
//
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_targetInit(SMBus *smbus, UNICOMM_Inst_Regs *i2cAddr);
#endif

//*****************************************************************************
//
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_targetEnableInt(SMBus *smbus);

//*****************************************************************************
//
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_targetDisableInt(SMBus *smbus);

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

//*****************************************************************************
//
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_controllerReset(SMBus *smbus);

//*****************************************************************************
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_targetSetAddress(SMBus *smbus,
                                  uint8_t targetAddr);

//*****************************************************************************
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_targetSetRxBuffer(SMBus *smbus,
                                   uint8_t *data,
                                   uint16_t size);

//*****************************************************************************
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_targetSetTxBuffer(SMBus *smbus,
                                   uint8_t *data,
                                   uint16_t size);

//*****************************************************************************
//
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_targetReportError(SMBus *smbus,
                                   SMBus_ErrorCode errorCode);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint8_t SMBus_targetGetCommand(SMBus *smbus);

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

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

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint8_t SMBus_targetClearStatusReg(SMBus *smbus,
                                         uint8_t val);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint8_t SMBus_targetWriteCtrlReg(SMBus *smbus,
                                       uint8_t val);

//*****************************************************************************
//
//
//
//
//
//*****************************************************************************
extern int8_t SMBus_targetHostAlert(SMBus *smbus,
                                 uint8_t deviceAddress,
                                 uint8_t *txData);


#if defined(__MSPM0_HAS_I2C__)
//*****************************************************************************
//
//
//
//
// \return  None
//
//*****************************************************************************
extern void SMBus_controllerInit(SMBus *smbus, I2C_Regs *i2cAddr, uint32_t busClk);
#endif

#if defined(__MCU_HAS_UNICOMMI2CC__)
//*****************************************************************************
//
//
//
//
// \return  None
//
//*****************************************************************************
extern void SMBus_controllerInit(SMBus *smbus, UNICOMM_Inst_Regs *i2cAddr, uint32_t busClk);
#endif

//*****************************************************************************
//
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_controllerEnableInt(SMBus *smbus);

//*****************************************************************************
//
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_controllerDisableInt(SMBus *smbus);


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


//*****************************************************************************
//
//
//
//
//
//*****************************************************************************
extern int8_t SMBus_controllerProcessCall(SMBus *smbus,
                                      uint8_t targetAddr,
                                      uint8_t command,
                                      uint8_t *txData,
                                      uint8_t *rxData);

//*****************************************************************************
//
//
//
//
//
//
//*****************************************************************************
extern int8_t SMBus_controllerProcessCallBlock(SMBus *smbus,
                                           uint8_t targetAddr,
                                           uint8_t command,
                                           uint8_t *txData,
                                           uint8_t txSize,
                                           uint8_t *rxData);

//*****************************************************************************
//
//
//
//
//
//*****************************************************************************
extern int8_t SMBus_controllerSendByte(SMBus *smbus,
                                   uint8_t targetAddr,
                                   uint8_t txData);

//*****************************************************************************
//
//
//
//
//
//*****************************************************************************
extern int8_t SMBus_controllerReceiveByte(SMBus *smbus,
                                      uint8_t targetAddr,
                                      uint8_t *rxData);

//*****************************************************************************
//
//
//
//
//
//
//*****************************************************************************
extern int8_t SMBus_controllerReadBlock(SMBus *smbus,
                                    uint8_t targetAddr,
                                    uint8_t command,
                                    uint8_t *rxData);

//*****************************************************************************
//
//
//
//
//
//
//*****************************************************************************
extern int8_t SMBus_controllerWriteBlock(SMBus *smbus,
                                     uint8_t targetAddr,
                                     uint8_t command,
                                     uint8_t *txData,
                                     uint16_t txSize);

//*****************************************************************************
//
//
//
//
//
//
//*****************************************************************************
extern int8_t SMBus_controllerReadByteWord(SMBus *smbus,
                                            uint8_t targetAddr,
                                            uint8_t command,
                                            uint8_t *rxData,
                                            uint8_t rxSize);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern int8_t SMBus_controllerWriteByteWord(SMBus *smbus,
                                        uint8_t targetAddr,
                                        uint8_t command,
                                        uint8_t *txData,
                                        uint8_t txSize);

//*****************************************************************************
//
//
//
//
//
//*****************************************************************************
extern int8_t SMBus_controllerQuickCommand(SMBus *smbus,
                                       uint8_t targetAddr,
                                       bool write);

//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern int8_t SMBus_controllerWaitUntilDone(SMBus *smbus,
                                        int32_t timeout);

//*****************************************************************************
//
//
//
//
//  \return  None
//
//*****************************************************************************
extern void SMBus_controllerEnableHostNotify(SMBus *smbus, uint8_t *hostAlertBuffer);

//*****************************************************************************
//
//
//
//
// \return  None
//
//*****************************************************************************
extern void SMBus_controllerDisableHostNotify(SMBus *smbus);
//*****************************************************************************
//
//
//
//
//*****************************************************************************
extern uint8_t SMBus_targetGetAddress(SMBus *smbus);
//*****************************************************************************
//
//
//
// \return None.
//
//*****************************************************************************
extern void SMBusARPAssignAddress(SMBus *smbus);
//*****************************************************************************
//
//
//*****************************************************************************
extern int8_t SMBusARPUDIDByteValidate(SMBus *smbus);

//*****************************************************************************
//
// \return None.
//
//*****************************************************************************
extern void SMBusARPGetUDIDPacket(SMBus *smbus);

//*****************************************************************************
//
// \return None.
//
//*****************************************************************************
extern void SMBusARPGetUDIDPacketDirect(SMBus *smbus);
//*****************************************************************************
//
// \return None.
//
//*****************************************************************************
extern void SMBusARP_RESET(SMBus *smbus);
//*****************************************************************************
//
// \return None.
//
//*****************************************************************************
extern void SMBusARPUDIDPacketDecode(tSMBusUDID *pUDID, uint8_t *pui8Data);
//*****************************************************************************
//
//
// *****************************************************************************
extern uint8_t SMBus_targetGetARPInProgress(SMBus *smbus);
//*****************************************************************************
//
//
// *****************************************************************************
extern uint8_t SMBus_targetGetARStatus(SMBus *smbus);
//*****************************************************************************
//
//  \return  None
//
// *****************************************************************************
extern void SMBus_targetSetARStatus(SMBus *smbus , uint8_t val);
//*****************************************************************************
//
//  \return  None
//
// *****************************************************************************
extern void SMBus_targetSetAVStatus(SMBus *smbus, uint8_t val);
//*****************************************************************************
//
//
// *****************************************************************************
extern uint8_t SMBus_targetGetAVStatus(SMBus *smbus);
//*****************************************************************************
//
//
// *****************************************************************************
extern uint8_t SMBus_targetGetAddressDirect(SMBus *smbus);

//*****************************************************************************
//
//
// *****************************************************************************
extern uint8_t SMBus_targetGetDirectCmd(SMBus *smbus);

//*****************************************************************************
//
//
// *****************************************************************************
extern int8_t ARP_UDIDValidate(SMBus *smbus);
//*****************************************************************************
//
// *****************************************************************************
extern void  ARP_invalidCMD(SMBus *smbus);

//*****************************************************************************
//
//
// *****************************************************************************
extern int8_t ARP_isCmdValid(SMBus *smbus);
//*****************************************************************************
//*****************************************************************************
//
//
// *****************************************************************************
extern int8_t ARP_CmdComplete(SMBus *smbus);
//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif

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

#endif //__SMBUS_H__