smbus_phy.h

#ifndef __SMBUS_PHY_H__
#define __SMBUS_PHY_H__

//*****************************************************************************
//
//! \addtogroup smbus_MSP430G2xxx_phy MSP430 PHY layer
//! @{
//
//*****************************************************************************

//*****************************************************************************
//
// 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"

//! R/W state when write is received
#define I2C_WRITE      0
//! R/W state when read is received
#define I2C_READ       1

// Define Timer to use for Timeout detection
//! Timer control register
#define TAxCTL          TA0CTL
//! Timer Capture/Compare 0 reg
#define TAxCCR0         TA0CCR0
//! Timer cap/comp control 0 reg
#define TAxCCTL0        TA0CCTL0
//! Timeout Count for Clock low detection based on ACLK counts (VLO/(VLO/33) = ~30ms)
#define TAxSCLTIMEOUT   (12000 / 33)

//*****************************************************************************
//
//! \brief   Disables the PHY and Data Link layer
//
//! \param smbus      Pointer to SMBus structure
//
//! \return  None
//
//*****************************************************************************
extern void SMBus_PHY_disable(SMBus *smbus);

//*****************************************************************************
//
//! \brief   Enables the PHY and Data Link layer
//
//! \param smbus      Pointer to SMBus structure
//
//! \return  None
//
//*****************************************************************************
extern void SMBus_PHY_enable(SMBus *smbus);

//*****************************************************************************
//
//! \brief   Enables the PHY and Data Link layer for slave operation
//
//! \param smbus      Pointer to SMBus structure
//
//! \return  None
//
//*****************************************************************************
extern void SMBus_PHY_slaveEnable(SMBus *smbus);

//*****************************************************************************
//
//! \brief   Enables the I2C interrupts
//
//!  This function enables the USCI Start,Stop, RX,TX, Timeout interrupts.
//
//! \param smbus      Pointer to SMBus structure
//
//! \return  None
//
//*****************************************************************************
extern void SMBus_PHY_slaveEnableInt(SMBus *smbus);

//*****************************************************************************
//
//! \brief   Initializes the I2C Slave module supporting SMBus functionality
//
//!  - Resets and then configures the I2C for SMBus support
//!  - I2C is enabled using Automatic ACK and Slave address is initialized to 0x00
//!  - Call SMBus_slaveSetAddress() in order to set the Slave address
//
//! \param smbus      Pointer to SMBus structure
//! \param unused     This parameter is unused
//
// \return  None
//
//*****************************************************************************
extern void SMBus_PHY_slaveInit(SMBus *smbus,
                                uint16_t unused);

//*****************************************************************************
//
//! \brief   I2C Interrupt Service routine
//
//!  Handles the interrupts from USCI module and passes the information to
//!  the network layer. Should be called by application when an USCI
//!  interrupt is detected.
//
//! \param smbus     Pointer to SMBus structure
//
//! \return  The new state of Slave (see SMBus_slaveProcessInt())
//
//*****************************************************************************
extern SMBus_State SMBus_PHY_slaveProcessInt(SMBus *smbus);

//*****************************************************************************
//
//! \brief   Timer interrupt service routine
//
//! Handles the timeout interrupts from the Timer module and passes the
//! information to the network layer. Should be callsed by the application
//! when a timer interrupt is detected
//
//*****************************************************************************
extern SMBus_State SMBus_PHY_slaveProcessTimeoutInt(SMBus *smbus);

//*****************************************************************************
//
//! \brief   Enables the PHY and Data Link layer
//
//! \param smbus      Pointer to SMBus structure
//
//! \return  None
//
//*****************************************************************************
extern void SMBus_PHY_masterEnable(SMBus *smbus);

//*****************************************************************************
//
//! \brief   Enables the I2C interrupts
//
//!  This function enables the USCI Start,Stop, RX,TX interrupts.
//!  SMBus_PHY_slaveInit() must be called before this function.
//
//! \param smbus      Pointer to SMBus structure
//
//! \return  None
//
//*****************************************************************************
extern void SMBus_PHY_masterEnableInt(SMBus *smbus);

//*****************************************************************************
//
//! \brief   Initializes the I2C Master module supporting SMBus functionality
//
//! - Resets and then configures the I2C for SMBus support
//! - I2C is enabled using Automatic ACK and Slave address is initialized to 0x00
//
//! \param smbus      Pointer to SMBus structure
//! \param unused     This parameter is unused
//! \param busClk     SMCLK Frequency (used for USCI baud rate)
//
//! \return  None
//
//*****************************************************************************
extern void SMBus_PHY_masterInit(SMBus *smbus,
                                 uint16_t unused,
                                 uint32_t busClk);

//*****************************************************************************
//
//! \brief   Generate Stop condition if it hasn't been sent
//
//! \param smbus     Pointer to SMBus structure
//! \return  None
//
//*****************************************************************************
extern void SMBus_PHY_masterSendStop(SMBus *smbus);

//*****************************************************************************
//
//! \brief   Prepare to send stop at next byte
//
//! \param smbus     Pointer to SMBus structure
//! \return  None
//
//*****************************************************************************
extern void SMBus_PHY_masterSendPreStop(SMBus *smbus);

//*****************************************************************************
//
//! \brief   Start a TX transfer
//
//! \param smbus      Pointer to SMBus structure
//! \param targetaddr Slave target address
//! \param stopFlag   Indicates the stop condition
//
//! \return  None
//
//*****************************************************************************
extern void SMBus_PHY_masterStartTx(SMBus *smbus,
                                    uint8_t targetaddr,
                                    SMBus_Stop stopFlag);

//*****************************************************************************
//
//! \brief   Start a RX transfer
//! \param smbus     Pointer to SMBus structure
//! \param targetaddr Slave target address
//! \param stopFlag   Indicates the stop condition
//
//! \return  None
//
//*****************************************************************************
extern void SMBus_PHY_masterStartRx(SMBus *smbus,
                                    uint8_t targetaddr,
                                    SMBus_Stop stopFlag);

//*****************************************************************************
//
//! \brief   I2C Interrupt Service routine
//
//!  Handles the interrupts from USCI module and passes the information to
//!  the network layer. Should be called by application when an USCI
//!  interrupt is detected.
//
//! \param smbus     Pointer to SMBus structure
//
//! \return  The new state of master (see SMBus_masterProcessInt())
//
//*****************************************************************************
extern SMBus_State SMBus_PHY_masterProcessInt(SMBus *smbus);

//*****************************************************************************
//
//! \brief   Timer interrupt service routine
//
//! Handles the timeout interrupts from the Timer module and passes the
//! information to the network layer. Should be callsed by the application
//! when a timer interrupt is detected
//
//! \param smbus     Pointer to SMBus structure
//
//*****************************************************************************
extern SMBus_State SMBus_PHY_masterProcessTimeoutInt(SMBus *smbus);

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

//*****************************************************************************
//
// Close the Doxygen group.
//! @}
//
//*****************************************************************************

#endif //__SMBUS_PHY_H__