//*****************************************************************************
//
// CM3218.h - Prototypes for the CM3218 light sensor
//            driver.
//
// Copyright (c) 2012-2020 Texas Instruments Incorporated.  All rights reserved.
// Software License Agreement
// 
// Texas Instruments (TI) is supplying this software for use solely and
// exclusively on TI's microcontroller products. The software is owned by
// TI and/or its suppliers, and is protected under applicable copyright
// laws. You may not combine this software with "viral" open-source
// software in order to form a larger program.
// 
// THIS SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS.
// NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT
// NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. TI SHALL NOT, UNDER ANY
// CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
// DAMAGES, FOR ANY REASON WHATSOEVER.
// 
// This is part of revision 2.2.0.295 of the Tiva Firmware Development Package.
//
//*****************************************************************************

#ifndef __SENSORLIB_CM3218_H__
#define __SENSORLIB_CM3218_H__

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

//*****************************************************************************
//
// The structure that defines the internal state of the CM3218 driver.
//
//*****************************************************************************
typedef struct
{
    //
    // The pointer to the I2C master interface instance used to communicate
    // with the CM3218.
    //
    tI2CMInstance *psI2CInst;

    //
    // The I2C address of the CM3218.
    //
    uint8_t ui8Addr;

    //
    // The state of the state machine used while accessing the CM3218.
    //
    uint8_t ui8State;

    //
    // The data buffer used for sending/receiving data to/from the CM3218.
    //
    uint8_t pui8Data[4];

    //
    // The integration time, which determines the sensitivity.
    //
    uint8_t ui8IntTime;

    //
    // The new integration time, which is used when a register write succeeds.
    //
    uint8_t ui8NewIntTime;

    //
    // The function that is called when the current request has completed
    // processing.
    //
    tSensorCallback *pfnCallback;

    //
    // The pointer provided to the callback function.
    //
    void *pvCallbackData;

    //
    // A union of structures that are used for read and write operations.
    // Since only one operation can be active at a time, it is safe to re-use
    // the memory in this manner.
    //
    union
    {
        //
        // A buffer used to store the write portion of a register read.
        //
        uint8_t pui8Buffer[4];

        //
        // The read state used to read register values.
        //
        tI2CMRead16BE sReadState;

        //
        // The write state used to write register values.
        //
        tI2CMWrite16BE sWriteState;
    }
    uCommand;
}
tCM3218;

//*****************************************************************************
//
// Function prototypes.
//
//*****************************************************************************
extern uint_fast8_t CM3218Init(tCM3218 *psInst, tI2CMInstance *psI2CInst,
                               uint_fast8_t ui8I2CAddr,
                               tSensorCallback *pfnCallback,
                               void *pvCallbackData);
extern uint_fast8_t CM3218Read(tCM3218 *psInst, uint_fast8_t ui8Reg,
                               uint16_t *pui16Data, uint_fast16_t ui16Count,
                               tSensorCallback *pfnCallback,
                               void *pvCallbackData);
extern uint_fast8_t CM3218Write(tCM3218 *psInst, uint_fast8_t ui8Reg,
                                const uint16_t *pui16Data,
                                uint_fast16_t ui16Count,
                                tSensorCallback *pfnCallback,
                                void *pvCallbackData);
extern uint_fast8_t CM3218InterruptAcknowledge(tCM3218 *psInst,
                                tSensorCallback *pfnCallback,
                                void *pvCallbackData);
extern uint_fast8_t CM3218DataRead(tCM3218 *psInst,
                                   tSensorCallback *pfnCallback,
                                   void *pvCallbackData);
extern void CM3218DataLightVisibleGetRaw(tCM3218 *psInst,
                                         uint16_t *pui16Visible);
extern void CM3218DataLightVisibleGetFloat(tCM3218 *psInst, float *pfVisible);

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

#endif // __SENSORLIB_CM3218_H__