//*****************************************************************************
//
// KXTI9.h - Prototypes for the KXTI9 accelerometer 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_KXTI9_H__
#define __SENSORLIB_KXTI9_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 KXTI9 driver.
//
//*****************************************************************************
typedef struct
{
    //
    // The pointer to the I2C master interface instance used to communicate
    // with the KXTI9.
    //
    tI2CMInstance *psI2CInst;

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

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

    //
    // The ADC resolution of the KXTI9.
    //
    uint8_t ui8Resolution;

    uint8_t ui8NewResolution;

    //
    // The current operating range (g force) of the KXTI9.
    //
    uint8_t ui8Range;
    
    uint8_t ui8NewRange;

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

    //
    // 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, write and
    // read-modify-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[2];

        //
        // The write state used to write register values.
        //
        struct
        {
            //
            // The buffer that is being written to the KXTI9.
            //
            uint8_t *pui8Data;

            //
            // The number of bytes being written to the KXTI9.
            //
            uint16_t ui16Count;
        }
        sWriteState;

        //
        // The read-modify-write state used to modify register values.
        //
        tI2CMReadModifyWrite8 sReadModifyWriteState;
    }
    uCommand;
}
tKXTI9;

//*****************************************************************************
//
// Function prototypes.
//
//*****************************************************************************
extern uint_fast8_t KXTI9Init(tKXTI9 *psInst, tI2CMInstance *psI2CInst,
                              uint_fast8_t ui8I2CAddr,
                              tSensorCallback *pfnCallback,
                              void *pvCallbackData);
extern uint_fast8_t KXTI9Read(tKXTI9 *psInst, uint_fast8_t ui8Reg,
                              uint8_t *pui8Data, uint_fast16_t ui16Count,
                              tSensorCallback *pfnCallback,
                              void *pvCallbackData);
extern uint_fast8_t KXTI9Write(tKXTI9 *psInst, uint_fast8_t ui8Reg,
                               uint8_t *pui8Data, uint_fast16_t ui16Count,
                               tSensorCallback *pfnCallback,
                               void *pvCallbackData);
extern uint_fast8_t KXTI9ReadModifyWrite(tKXTI9 *psInst, uint_fast8_t ui8Reg,
                                         uint_fast8_t ui8Mask,
                                         uint_fast8_t ui8Value,
                                         tSensorCallback *pfnCallback,
                                         void *pvCallbackData);
extern uint_fast8_t KXTI9DataRead(tKXTI9 *psInst,
                                  tSensorCallback *pfnCallback,
                                  void *pvCallbackData);
extern void KXTI9DataAccelGetRaw(tKXTI9 *psInst, uint_fast16_t *pui16AccelX,
                                 uint_fast16_t *pui16AccelY,
                                 uint_fast16_t *pui16AccelZ);
extern void KXTI9DataAccelGetFloat(tKXTI9 *psInst, float *pfAccelX,
                                   float *pfAccelY, float *pfAccelZ);

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

#endif // __SENSORLIB_KXTI9_H__