modm API documentation
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
modm::stusb4500< I2cMaster > Class Template Reference
External Device Drivers » STUSB4500 USB PD controller

#include <modm/driver/usb/stusb4500.hpp>

Inheritance diagram for modm::stusb4500< I2cMaster >:
modm::I2cDevice< I2cMaster, 4 > modm::NestedResumable< 10+1 >

Classes

struct  RdoRegStatusData
 

Public Types

enum  Register : uint8_t {
  RdoRegStatus = 0x91, DpmPdoNumb = 0x70, DpmSnkPdo1 = 0x85, DpmSnkPdo2 = 0x89,
  DpmSnkPdo3 = 0x8D
}
 

Public Member Functions

 Stusb4500 (uint8_t address=0x28)
 
modm::ResumableResult< bool > configurePdo (uint8_t pdoNumber, uint32_t voltage, uint32_t current)
 
modm::ResumableResult< bool > setValidPdo (uint8_t pdoNumber)
 
modm::ResumableResult< RdoRegStatusData > getRdoRegStatus ()
 
modm::ResumableResult< bool > readRegister (Register reg, uint8_t *output, size_t length)
 
modm::ResumableResult< bool > updateRegister (Register reg, const uint8_t *data, size_t length)
 
void attachConfigurationHandler (I2c::ConfigurationHandler handler)
 
modm::ResumableResult< bool > ping ()
 
void setAddress (uint8_t address)
 

Protected Member Functions

modm::ResumableResult< ReturnType > resumable function (...)
 
int8_t getResumableDepth () const
 
bool isResumableRunning () const
 
bool isTransactionRunning ()
 
modm::ResumableResult< bool > runTransaction ()
 Starts our own transaction and waits until finished.
 
bool startRead (uint8_t *buffer, std::size_t size)
 Configures the transaction with a read operation and starts it.
 
bool startTransaction ()
 Starts the transaction with our own transaction object.
 
bool startTransaction (modm::I2cTransaction *transaction)
 Starts the transaction with a seperate transaction object.
 
bool startWrite (const uint8_t *buffer, std::size_t size)
 Configures the transaction with a write operation and starts it.
 
bool startWriteRead (const uint8_t *writeBuffer, std::size_t writeSize, uint8_t *readBuffer, std::size_t readSize)
 Configures the transaction with a write/read operation and starts it.
 
void stopResumable ()
 Force all resumable functions to stop running at the current nesting level.
 
bool wasTransactionSuccessful ()
 

Protected Attributes

I2cWriteReadTransaction transaction
 

Detailed Description

template<class I2cMaster>
class modm::stusb4500< I2cMaster >

Author
Henrik Hose, Raphael Lehmann

Member Function Documentation

void modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::attachConfigurationHandler ( I2c::ConfigurationHandler  handler)
inheritedinline

Attaches a configuration handler, which is called before a transaction, whenever the configuration has to be changed.

template<class I2cMaster >
modm::ResumableResult<bool> modm::stusb4500< I2cMaster >::configurePdo ( uint8_t  pdoNumber,
uint32_t  voltage,
uint32_t  current 
)
inline

Configures a PDO.

Note: According to the USB standard the first PDO (1) always has to set voltage to 5000 [mV].

Parameters
pdoNumberWhich PDO to configure, range 1 to 3.
voltagein mV
currentin mA
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.
template<class I2cMaster >
modm::ResumableResult<RdoRegStatusData> modm::stusb4500< I2cMaster >::getRdoRegStatus ( )
inline

Retrieve RDO status from STUSB4500 chip.

Returns
RdoRegStatusData object. Typically only RdoRegStatusData::MaxCurrent [mA] is of interest.
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
bool modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::isTransactionRunning ( )
inheritedinlineprotected
Returns
true when transaction is busy.
modm::ResumableResult<bool> modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::ping ( )
inheritedinline
Return Values
truedevice responds to address
falseno device with address found
void modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::setAddress ( uint8_t  address)
inheritedinline

Sets a new address of the slave device.

Parameters
addressthe slave address not yet shifted left (address < 128).
template<class I2cMaster >
modm::ResumableResult<bool> modm::stusb4500< I2cMaster >::setValidPdo ( uint8_t  pdoNumber)
inline

Sets the valid PDO.

Parameters
pdoNumberWhich PDO to set valid, range 1 to 3.
bool modm::I2cDevice< I2cMaster, 10 , I2cWriteReadTransaction >::wasTransactionSuccessful ( )
inheritedinlineprotected
Returns
true when transaction did not return an error.
The documentation for this class was generated from the following file: