drv8353.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       drv8353.h
 *  @brief      DRV8353_MODULE Module
 *
 *  @anchor drv8353_h
 *  # Overview
 *  
 *  API's releated to DRV8353
 * 
 *  <hr>
 ******************************************************************************/
#ifndef _DRV8353_H_
#define _DRV8353_H_

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

#ifdef __cplusplus
extern "C" {
#endif

//*****************************************************************************
//defines
//*****************************************************************************
#define DRV8353_ADDR_MASK                   (0x7E00)

#define DRV8353_DATA_MASK                   (0x00FF)

#define DRV8353_DATA_TRANSMIT_TO_READ       (0x00)

#define DRV8353_INITIAL_PARITY              (0x00)

#define DRV8353_PARITY_CHECK                (0x01)

#define DRV8353_RIGHT_SHIFT_REGISTER        (1)

#define DRV8353_PARITY_BIT_POSITION         (8)

#define DRV8353_ADDR_BIT_POSITION           (9)

#define DRV8353_SPICMD_BIT_POSITION         (15)

#define DRV8353_CLEAR_BIT_MASK              (0x01)

#define DRV8353_MAXIMUM_RESET_TIME          (40)

#define DRV8353_MAXIMUM_WAKEUP_TIME         (2000)

#define DRV8353_VOLTAGE_CONV_CONST          _IQ20(39.582)

#define DRV8353_CSA_REF_VOLTAGE             (3300)

//*****************************************************************************
// typedefs
//*****************************************************************************
typedef enum
{
    DRV8353_DRV_NSLEEP_SLEEP = HAL_GPIO_PIN_LOW,
    DRV8353_DRV_NSLEEP_AWAKE = HAL_GPIO_PIN_HIGH
}DRV8353_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;

}DRV8353_Instance;

//*****************************************************************************
// the function prototypes
//*****************************************************************************
__STATIC_INLINE void DRV8353_setnSleep(
        DRV8353_Instance *drvHandle, DRV8353_DRV_NSLEEP_STAT value)
{
  if(value == DRV8353_DRV_NSLEEP_AWAKE)
  {
      HAL_writeGPIOPin(drvHandle->nsleep, HAL_GPIO_PIN_HIGH);
  }
  else if(value == DRV8353_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(DRV8353_MAXIMUM_WAKEUP_TIME);
}

void DRV8353_init(DRV8353_Instance *drvHandle);

void DRV8353_enable(DRV8353_Instance *drvHandle);

void DRV8353_updateCSAScaleFactor(
        DRV8353_Instance *drvHandle, uint16_t csa);

_iq20 DRV8353_getVoltage(HAL_ADC_CHAN chan);

_iq20 DRV8353_getCurrent(HAL_ADC_CHAN chan,
        DRV8353_Instance *drvHandle, _iq20 vRef);

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

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

#ifdef __cplusplus
}
#endif
#endif /* _DRV8353_H_ */