drv8311.h

Go to the documentation of this file.

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

/*!****************************************************************************
 *  @file       drv8311.h
 *  @brief      drv8311_MODULE Module
 *
 *  @anchor drv8311_h
 *  # Overview
 *  
 *  API's releated to drv8311
 * 
 *  <hr>
 ******************************************************************************/
#ifndef _drv8311_H_
#define _drv8311_H_

//*****************************************************************************
// the includes
//*****************************************************************************
#include "hal.h"

#ifdef __cplusplus
extern "C" {
#endif

//*****************************************************************************
//defines
//*****************************************************************************
#define drv8311_MAXIMUM_RESET_TIME          (40)

#define drv8311_MAXIMUM_WAKEUP_TIME         (2000)

#define drv8311_VOLTAGE_CONV_CONST          _IQ20(8.143)

#define drv8311_CSA_REF_VOLTAGE             (3000)

#define drv8311_CSAGAIN_0P25VA_IQ           _IQ20(0.25)

#define drv8311_CSAGAIN_0P5VA_IQ            _IQ20(0.5)

#define drv8311_CSAGAIN_1P0VA_IQ            _IQ20(1.0)

#define drv8311_CSAGAIN_2P0VA_IQ            _IQ20(2.0)

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


typedef enum
{
    drv8311_CSAGAIN_0P25VA = 0x00 << 0,
    drv8311_CSAGAIN_0P5VA = 0x01 << 0,
    drv8311_CSAGAIN_1P0VA = 0x02 << 0,
    drv8311_CSAGAIN_2P0VA = 0x03 << 0
}drv8311_CSAGAIN;

typedef enum
{
    drv8311_DRVOFF_PIN_LOW = HAL_GPIO_PIN_LOW,
    drv8311_DRVOFF_PIN_HIGH = HAL_GPIO_PIN_HIGH
}drv8311_DRVOFF_PIN_STAT;

typedef enum
{
    drv8311_DRV_NSLEEP_SLEEP = HAL_GPIO_PIN_LOW,
    drv8311_DRV_NSLEEP_AWAKE = HAL_GPIO_PIN_HIGH
}drv8311_DRV_NSLEEP_STAT;

typedef struct
{
    HAL_GPIO_OUT    nsleep;
    HAL_GPIO_OUT    drvoff;
    HAL_GPIO_IN     nfault;
    HAL_SPI_CHAN    spiChan;
    HAL_SPI_CS      spiCs;
    _iq20           csa_sf;
    _iq20           csaVRef;
    HAL_ADC_CHAN    Vsen;
    HAL_ADC_CHAN    VsenA;
    HAL_ADC_CHAN    VsenB;
    HAL_ADC_CHAN    VsenC;
    HAL_ADC_CHAN    IsenA;
    HAL_ADC_CHAN    IsenB;
    HAL_ADC_CHAN    IsenC;
    HAL_FAULT_INPUT faultIn;

}drv8311_Instance;

//*****************************************************************************
// the function prototypes
//*****************************************************************************
__STATIC_INLINE void drv8311_setDrvoff(
        drv8311_Instance *drvHandle, drv8311_DRVOFF_PIN_STAT value)
{
  if(value == drv8311_DRVOFF_PIN_HIGH)
  {
      HAL_writeGPIOPin(drvHandle->drvoff, HAL_GPIO_PIN_HIGH);
  }
  else if(value == drv8311_DRVOFF_PIN_LOW)
  {
      HAL_writeGPIOPin(drvHandle->drvoff, HAL_GPIO_PIN_LOW);
  }
  else
  {
      /* This is expected to be empty */
  }
}

__STATIC_INLINE void drv8311_setnSleep(
        drv8311_Instance *drvHandle, drv8311_DRV_NSLEEP_STAT value)
{
  if(value == drv8311_DRV_NSLEEP_AWAKE)
  {
      HAL_writeGPIOPin(drvHandle->nsleep, HAL_GPIO_PIN_HIGH);
  }
  else if(value == drv8311_DRV_NSLEEP_SLEEP)
  {
      HAL_writeGPIOPin(drvHandle->nsleep, HAL_GPIO_PIN_LOW);
  }
  else
  {
      /* This is expected to be empty */
  }
    /* tWake - Turnon time = 1ms
     * tSleep - Turnoff time = 1ms
     * So not matter what you set sleep pin to just wait 1 ms
     */
  HAL_delayMicroSeconds(drv8311_MAXIMUM_WAKEUP_TIME);
}

void drv8311_init(drv8311_Instance *drvHandle);

void drv8311_enable(drv8311_Instance *drvHandle);

void drv8311_updateCSAScaleFactor(
        drv8311_Instance *drvHandle, drv8311_CSAGAIN csa);

_iq20 drv8311_getVoltage(HAL_ADC_CHAN chan);

_iq20 drv8311_getCurrent(HAL_ADC_CHAN chan,
        drv8311_Instance *drvHandle, _iq20 vRef);

void drv8311_ADCVRefSel(HAL_ADC_VREF adcRef, HAL_ADC_CHAN chan,
                        HAL_ADC_INT_VREF internalVRef, uint16_t externalVRef);

__STATIC_INLINE _iq20 drv8311_getcsaVref(uint16_t vRef)
{
    _iq13 temp = _IQ13div(_IQ13(vRef),_IQ13(1000));
    return _IQ13toIQ20(temp);
}

#ifdef __cplusplus
}
#endif
#endif /* _drv8311_H_ */