MotorWare f2806x Driver API Documentation
Functions
drv8301.c File Reference

Contains the various functions related to the DRV8301 object. More...

#include <math.h>
#include "sw/drivers/drvic/drv8301/src/32b/f28x/f2806x/drv8301.h"

Go to the source code of this file.

Functions

void DRV8301_enable (DRV8301_Handle handle)
 Enables the DRV8301. More...
 
DRV8301_DcCalMode_e DRV8301_getDcCalMode (DRV8301_Handle handle, const DRV8301_ShuntAmpNumber_e ampNumber)
 Gets the DC calibration mode. More...
 
DRV8301_FaultType_e DRV8301_getFaultType (DRV8301_Handle handle)
 Gets the fault type. More...
 
uint16_t DRV8301_getId (DRV8301_Handle handle)
 Gets the device ID. More...
 
DRV8301_VdsLevel_e DRV8301_getOcLevel (DRV8301_Handle handle)
 Gets the over current level. More...
 
DRV8301_OcMode_e DRV8301_getOcMode (DRV8301_Handle handle)
 Gets the over current mode. More...
 
DRV8301_OcOffTimeMode_e DRV8301_getOcOffTimeMode (DRV8301_Handle handle)
 Gets the over current off time mode. More...
 
DRV8301_OcTwMode_e DRV8301_getOcTwMode (DRV8301_Handle handle)
 Gets the over current, temperature warning mode. More...
 
DRV8301_PeakCurrent_e DRV8301_getPeakCurrent (DRV8301_Handle handle)
 Gets the peak current value. More...
 
DRV8301_PwmMode_e DRV8301_getPwmMode (DRV8301_Handle handle)
 Gets the PWM mode. More...
 
DRV8301_ShuntAmpGain_e DRV8301_getShuntAmpGain (DRV8301_Handle handle)
 Gets the shunt amplifier gain value. More...
 
DRV8301_Handle DRV8301_init (void *pMemory, const size_t numBytes)
 Initializes the DRV8301 object. More...
 
void DRV8301_setGpioHandle (DRV8301_Handle handle, GPIO_Handle gpioHandle)
 Sets the GPIO handle in the DRV8301. More...
 
void DRV8301_setGpioNumber (DRV8301_Handle handle, GPIO_Number_e gpioNumber)
 Sets the GPIO number in the DRV8301. More...
 
void DRV8301_setSpiHandle (DRV8301_Handle handle, SPI_Handle spiHandle)
 Sets the SPI handle in the DRV8301. More...
 
bool DRV8301_isFault (DRV8301_Handle handle)
 Determines if DRV8301 fault has occurred. More...
 
bool DRV8301_isReset (DRV8301_Handle handle)
 Determines if DRV8301 is in reset. More...
 
uint16_t DRV8301_readSpi (DRV8301_Handle handle, const DRV8301_RegName_e regName)
 Reads data from the DRV8301 register. More...
 
void DRV8301_reset (DRV8301_Handle handle)
 Resets the DRV8301. More...
 
void DRV8301_setDcCalMode (DRV8301_Handle handle, const DRV8301_ShuntAmpNumber_e ampNumber, const DRV8301_DcCalMode_e mode)
 Sets the DC calibration mode. More...
 
void DRV8301_setOcLevel (DRV8301_Handle handle, const DRV8301_VdsLevel_e VdsLevel)
 Sets the over current level in terms of Vds. More...
 
void DRV8301_setOcMode (DRV8301_Handle handle, const DRV8301_OcMode_e mode)
 Sets the over current mode. More...
 
void DRV8301_setOcOffTimeMode (DRV8301_Handle handle, const DRV8301_OcOffTimeMode_e mode)
 Sets the over current off time mode. More...
 
void DRV8301_setOcTwMode (DRV8301_Handle handle, const DRV8301_OcTwMode_e mode)
 Sets the over current, temperature warning mode. More...
 
void DRV8301_setPeakCurrent (DRV8301_Handle handle, const DRV8301_PeakCurrent_e peakCurrent)
 Sets the peak current value. More...
 
void DRV8301_setPwmMode (DRV8301_Handle handle, const DRV8301_PwmMode_e mode)
 Sets the PWM mode. More...
 
void DRV8301_setShuntAmpGain (DRV8301_Handle handle, const DRV8301_ShuntAmpGain_e gain)
 Sets the shunt amplifier gain value. More...
 
void DRV8301_writeSpi (DRV8301_Handle handle, const DRV8301_RegName_e regName, const uint16_t data)
 Writes data to the DRV8301 register. More...
 
void DRV8301_writeData (DRV8301_Handle handle, DRV_SPI_8301_Vars_t *Spi_8301_Vars)
 Interface to all 8301 SPI variables. More...
 
void DRV8301_readData (DRV8301_Handle handle, DRV_SPI_8301_Vars_t *Spi_8301_Vars)
 
void DRV8301_setupSpi (DRV8301_Handle handle, DRV_SPI_8301_Vars_t *Spi_8301_Vars)
 Initialize the interface to all 8301 SPI variables. More...
 

Detailed Description

Contains the various functions related to the DRV8301 object.

(C) Copyright 2015, Texas Instruments, Inc.

Definition in file drv8301.c.