drv8323.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       drv8323.h
 *  @brief      DRV8323_MODULE Module
 *
 *  @anchor drv8323_h
 *  # Overview
 *  
 *  API's releated to DRV8323
 * 
 *  <hr>
 ******************************************************************************/
#ifndef _DRV8323_H_
#define _DRV8323_H_

#include "hal.h"

#ifdef __cplusplus
extern "C" {
#endif

#define DRV8323_MAXIMUM_WAKEUP_TIME                 (2000)

#define DRV8323_VOLTAGE_CONV_CONST                  _IQ20(17.433)

#define DRV8323_CSA_REF_VOLTAGE                     (3300)

#define DRV8323_CSAGAIN_5_IQ                        _IQ20(5)

#define DRV8323_CSAGAIN_10_IQ                       _IQ20(10)

#define DRV8323_CSAGAIN_20_IQ                       _IQ20(20)

#define DRV8323_CSAGAIN_40_IQ                       _IQ20(40)

typedef enum
{
    DRV8323_CSAGAIN_5 = 0 << 0,
    DRV8323_CSAGAIN_10 = 1 << 0,
    DRV8323_CSAGAIN_20 = 2 << 0,
    DRV8323_CSAGAIN_40 = 3 << 0
}DRV8323_CSAGAIN ;

typedef enum
{
  DRV8323_DRVOFF_PIN_LOW = HAL_GPIO_PIN_LOW,
  DRV8323_DRVOFF_PIN_HIGH = HAL_GPIO_PIN_HIGH
}DRV8323_DRVOFF_PIN_STAT ;

typedef enum
{
  DRV8323_DRV_NSLEEP_SLEEP = HAL_GPIO_PIN_LOW,
  DRV8323_DRV_NSLEEP_AWAKE = HAL_GPIO_PIN_HIGH
}DRV8323_DRV_NSLEEP_STAT;

typedef struct
{
    HAL_GPIO_OUT     nsleep;
    HAL_GPIO_OUT     led;
    HAL_GPIO_IN      nfault;
    _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;

}DRV8323_Instance;

__STATIC_INLINE void DRV8323_setnSleep(
        DRV8323_Instance *drvHandle, DRV8323_DRV_NSLEEP_STAT value)
{
  if(value == DRV8323_DRV_NSLEEP_AWAKE)
  {
      HAL_writeGPIOPin(drvHandle->nsleep, HAL_GPIO_PIN_HIGH);
  }
  else if(value == DRV8323_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(DRV8323_MAXIMUM_WAKEUP_TIME);
}

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

void DRV8323_init(DRV8323_Instance *drvHandle);

void DRV8323_enable(DRV8323_Instance *drvHandle);

void DRV8323_updateCSAScaleFactor(DRV8323_Instance *drvHandle,
                             DRV8323_CSAGAIN  csa, uint16_t rSense);

_iq20 DRV8323_getVoltage(HAL_ADC_CHAN  chan);

_iq20 DRV8323_getCurrent(
        HAL_ADC_CHAN  chan, DRV8323_Instance *drvHandle, _iq20 vRef);

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

#ifdef __cplusplus
}
#endif
#endif /* _DRV8323_H_ */