drv8300.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       drv8300.h
 *  @brief      DRV8300_MODULE Module
 *
 *  @anchor drv8300_h
 *  # Overview
 *  
 *  API's releated to DRV8300
 * 
 *  <hr>
 ******************************************************************************/
#ifndef _DRV8300_H_
#define _DRV8300_H_

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

#ifdef __cplusplus
extern "C" {
#endif

//*****************************************************************************
//defines
//*****************************************************************************

#define DRV8300_VOLTAGE_CONV_CONST          _IQ20(33.425)

#define DRV8300_CSA_REF_VOLTAGE             (3300)

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

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

}DRV8300_Instance;

//*****************************************************************************
// the function prototypes
//*****************************************************************************
void DRV8300_init(DRV8300_Instance *drvHandle);

void DRV8300_enable(DRV8300_Instance *drvHandle);

void DRV8300_updateCSAScaleFactor(
        DRV8300_Instance *drvHandle, uint16_t csa);

_iq20 DRV8300_getVoltage(HAL_ADC_CHAN chan);

_iq20 DRV8300_getCurrent(HAL_ADC_CHAN chan,
        DRV8300_Instance *drvHandle, _iq20 vRef);

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

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

#ifdef __cplusplus
}
#endif
#endif /* _DRV8300_H_ */