modm API documentation
Public Typedefs | Public Types | Public Member Functions | Protected Member Functions | List of all members
modm::drv832xSpi< SpiMaster, Cs > Class Template Reference
External Device Drivers » DRV832xS: Three-Phase Smart Gate Driver

#include <modm/driver/motor/drv832x_spi.hpp>

Inheritance diagram for modm::drv832xSpi< SpiMaster, Cs >:
modm::SpiDevice< SpiMaster > modm::NestedResumable< 3 >

Public Typedefs

using PwmMode_t = Configuration< DriverControl_t, PwmMode, 0b11, 5 >
 
typedef Configuration< GateDriveHS_t, Lock, 0b111, 8 > Lock_t
 
typedef Configuration< GateDriveLS_t, TDrive, 0b11, 8 > TDrive_t
 
typedef Configuration< GateDriveLS_t, IDriveN, 0b1111, 0 > LS_IDriveN_t
 
typedef Configuration< GateDriveHS_t, IDriveN, 0b1111, 0 > HS_IDriveN_t
 
typedef Configuration< GateDriveLS_t, IDriveP, 0b1111, 4 > LS_IDriveP_t
 
typedef Configuration< GateDriveHS_t, IDriveP, 0b1111, 4 > HS_IDriveP_t
 
typedef Configuration< OcpControl_t, VdsLevel, 0b1111, 0 > VdsLevel_t
 
typedef Configuration< OcpControl_t, OcpDeglitch, 0b11, 4 > OcpDeglitch_t
 
typedef Configuration< OcpControl_t, OcpMode, 0b11, 6 > OcpMode_t
 
typedef Configuration< CsaControl_t, SenseOcpLevel, 0b11, 0 > SenseOcpLevel_t
 
typedef Configuration< CsaControl_t, CsaGain, 0b11, 6 > CsaGain_t
 

Public Types

enum  Register : uint16_t {
  FaultStatus1 = 0x0, VgsStatus2 = 0x1, DriverControl = 0x2, GateDriveHS = 0x3,
  GateDriveLS = 0x4, OcpControl = 0x5, CsaControl = 0x6
}
 
enum  FaultStatus1 : uint16_t {
  VdsOvercurrentLC = Bit0, VdsOvercurrentHC = Bit1, VdsOvercurrentLB = Bit2, VdsOvercurrentHB = Bit3,
  VdsOvercurrentLA = Bit4, VdsOvercurrentHA = Bit5, OvertemperatureShutdown = Bit6, UndervoltageLockout = Bit7,
  GateDriveFault = Bit8, VdsOvercurrentFault = Bit9, Fault = Bit10
}
 
enum  VgsStatus2 : uint16_t {
  VgsGateDriveFaultLC = Bit0, VgsGateDriveFaultHC = Bit1, VgsGateDriveFaultLB = Bit2, VgsGateDriveFaultHB = Bit3,
  VgsGateDriveFaultLA = Bit4, VgsGateDriveFaultHA = Bit5, ChargePumpUndervoltageFault = Bit6, OvertemperatureWarning = Bit7,
  SenseCOvercurrent = Bit8, SenseBOvercurrent = Bit9, SenseAOvercurrent = Bit10
}
 
enum  DriverControl : uint16_t {
  ClearFaultBits = Bit0, Brake = Bit1, Coast = Bit2, Pwm1Dir = Bit3,
  Pwm1Com = Bit4, PwmMode1 = Bit5, PwmMode2 = Bit6, OvertemperatureReport = Bit7,
  DisableGateDriveFault = Bit8, DisableChargePumpUVLO = Bit9
}
 
enum  PwmMode : uint16_t { PwmMode6x = 0b00, PwmMode3x = 0b01, PwmMode1x = 0b10, PwmModeIndependent = 0b11 }
 
enum  GateDriveHS : uint16_t {
  IDriveN0 = Bit0, IDriveN1 = Bit1, IDriveN2 = Bit2, IDriveN3 = Bit3,
  IDriveP0 = Bit4, IDriveP1 = Bit5, IDriveP2 = Bit6, IDriveP3 = Bit7,
  Lock0 = Bit8, Lock1 = Bit9, Lock2 = Bit10
}
 
enum  Lock : uint16_t { Lock = 0b110, Unlock = 0b011 }
 
enum  GateDriveLS : uint16_t {
  IDriveN0 = Bit0, IDriveN1 = Bit1, IDriveN2 = Bit2, IDriveN3 = Bit3,
  IDriveP0 = Bit4, IDriveP1 = Bit5, IDriveP2 = Bit6, IDriveP3 = Bit7,
  TDrive0 = Bit8, TDrive1 = Bit9, Cbc = Bit10
}
 
enum  TDrive : uint16_t { ns500 = 0b00, ns1000 = 0b01, ns2000 = 0b10, ns4000 = 0b11 }
 
enum  IDriveN : uint16_t {
  mA20 = 0b0000, mA60 = 0b0001, mA120 = 0b0010, mA160 = 0b0011,
  mA240 = 0b0100, mA280 = 0b0101, mA340 = 0b0110, mA380 = 0b0111,
  mA520 = 0b1000, mA660 = 0b1001, mA740 = 0b1010, mA880 = 0b1011,
  mA1140 = 0b1100, mA1360 = 0b1101, mA1640 = 0b1110, mA2000 = 0b1111
}
 
enum  IDriveP : uint16_t {
  mA10 = 0b0000, mA30 = 0b0001, mA60 = 0b0010, mA80 = 0b0011,
  mA120 = 0b0100, mA140 = 0b0101, mA170 = 0b0110, mA190 = 0b0111,
  mA260 = 0b1000, mA330 = 0b1001, mA370 = 0b1010, mA440 = 0b1011,
  mA570 = 0b1100, mA680 = 0b1101, mA820 = 0b1110, mA1000 = 0b1111
}
 
enum  OcpControl : uint16_t {
  VdsLevel0 = Bit0, VdsLevel1 = Bit1, VdsLevel2 = Bit2, VdsLevel3 = Bit3,
  OcpDeglitch0 = Bit4, OcpDeglitch1 = Bit5, OcpMode0 = Bit6, OcpMode1 = Bit7,
  Deadtime0 = Bit8, Deadtime1 = Bit9, TimeRetry = Bit10
}
 
enum  VdsLevel : uint16_t {
  mV60 = 0b0000, mV130 = 0b0001, mV200 = 0b0010, mV260 = 0b0011,
  mV310 = 0b0100, mV450 = 0b0101, mV530 = 0b0110, mV600 = 0b0111,
  mV680 = 0b1000, mV750 = 0b1001, VdsLevel::mV940 = 0b1010, mV1130 = 0b1011,
  mV1300 = 0b1100, mV1500 = 0b1101, mV1700 = 0b1110, mV1880 = 0b1111
}
 
enum  OcpDeglitch : uint16_t { us2 = 0b00, us4 = 0b01, us6 = 0b10, us8 = 0b11 }
 
enum  OcpMode : uint16_t { LatchedFault = 0b00, AutoRetryFault = 0b01, OnlyReport = 0b10, NoOcp = 0b11 }
 
enum  CsaControl : uint16_t {
  SenseOcpLevel0 = Bit0, SenseOcpLevel1 = Bit1, CsaCalibrationC = Bit2, CsaCalibrationB = Bit3,
  CsaCalibrationA = Bit4, DisableOvercurrentSense = Bit5, CsaGain0 = Bit6, CsaGain1 = Bit7,
  LowSideReference = Bit8, VrefDiv2 = Bit9, CsaFet = Bit10
}
 
enum  SenseOcpLevel : uint16_t { SenseOcp0V25 = 0b00, SenseOcp0V5 = 0b01, SenseOcp0V75 = 0b10, SenseOcp1V = 0b11 }
 
enum  CsaGain : uint16_t { Gain5 = 0b00, Gain10 = 0b01, Gain20 = 0b10, Gain40 = 0b11 }
 

Public Member Functions

 MODM_FLAGS16 (FaultStatus1)
 
 MODM_FLAGS16 (VgsStatus2)
 
 MODM_FLAGS16 (DriverControl)
 
 MODM_FLAGS16 (GateDriveHS)
 
 MODM_FLAGS16 (GateDriveLS)
 
 MODM_FLAGS16 (OcpControl)
 
 MODM_FLAGS16 (CsaControl)
 
 Drv832xSpi ()
 Initialize. More...
 
modm::ResumableResult< void > readFaultStatus1 ()
 
modm::ResumableResult< void > readVgsStatus2 ()
 
modm::ResumableResult< void > readDriverControl ()
 
modm::ResumableResult< void > readGateDriveHS ()
 
modm::ResumableResult< void > readGateDriveLS ()
 
modm::ResumableResult< void > readOcpControl ()
 
modm::ResumableResult< void > readCsaControl ()
 
modm::ResumableResult< void > readAll ()
 
modm::ResumableResult< void > initialize ()
 
const FaultStatus1_t & faultStatus1 ()
 
const VgsStatus2_t & vgsStatus2 ()
 
DriverControl_t & driverControl ()
 
GateDriveHS_t & gateDriveHS ()
 
GateDriveLS_t & gateDriveLS ()
 
OcpControl_t & ocpControl ()
 
CsaControl_t & csaControl ()
 
modm::ResumableResult< void > commit ()
 
void attachConfigurationHandler (Spi::ConfigurationHandler handler)
 

Protected Member Functions

modm::ResumableResult< void > writeData (Register address, uint16_t data)
 
modm::ResumableResult< uint16_t > readData (Register address)
 
modm::ResumableResult< void > readData (Register address, uint16_t &data)
 
bool acquireMaster ()
 
bool releaseMaster ()
 
modm::ResumableResult< ReturnType > resumable function (...)
 
int8_t getResumableDepth () const
 
bool isResumableRunning () const
 
void stopResumable ()
 Force all resumable functions to stop running at the current nesting level.
 

Detailed Description

template<class SpiMaster, class Cs>
class modm::drv832xSpi< SpiMaster, Cs >

Author
Raphael Lehmann

Member Enumeration Documentation

template<class SpiMaster , class Cs >
enum modm::drv832xSpi::VdsLevel : uint16_t
strong
Enum ValuesDocumentation
mV940 

default

Member Function Documentation

template<class SpiMaster , class Cs >
modm::drv832xSpi< SpiMaster, Cs >::Drv832xSpi ( )

Initialize.

Sets used pins as output. SPI must be initialized by the user!

modm::ResumableResult< ReturnType > resumable modm::NestedResumable< 1 >::function (   ...)
inherited

Run the resumable function.

You need to implement this method in you subclass yourself.

Returns
>NestingError if still running, <=NestingError if it has finished.
int8_t modm::NestedResumable< 1 >::getResumableDepth ( ) const
inheritedinline
Returns
the nesting depth in the current resumable function, or -1 if called outside any resumable function
bool modm::NestedResumable< 1 >::isResumableRunning ( ) const
inheritedinline
Returns
true if a resumable function is running at the current nesting level, else false
The documentation for this class was generated from the following file: