Dataflow Runtime API  3.0.3.0
Public Member Functions | Public Attributes | List of all members
imt::base::bsp::stm32f103::PinDefinition Struct Reference

Defines the properties of a single pin configuration of the CPU. More...

#include <Imt.Base.BSP.STM32F103/PinDefinition.h>

Public Member Functions

 PinDefinition (const uint8_t indexPort, const uint8_t indexPin, const GPIO_Mode mode)
 Constructor. More...
 
void configure ()
 Configure the Pin using the STM32 F103 MD HAL. More...
 
void configure (const GPIO_Mode mode) const
 Configure the Pin using the STM32 F103 MD HAL. More...
 
bool read (void) const
 
void registerIrq (const size_t indexModule, const size_t indexDriver, const size_t indexEndpoint, const imt::base::bsp::type::TriggerEdge::Id triggerEdge, imt::base::bsp::handler::HighLevelValueHandlerIfc *pHandler) const
 
void registerIrq (const size_t indexModule, const size_t indexDriver, const size_t indexEndpoint, const imt::base::bsp::type::TriggerEdge::Id triggerEdge, imt::base::bsp::handler::TriggerEdgeHandlerIfc *pHandler) const
 
void write (const bool state) const
 
void unregisterIrq (void) const
 

Public Attributes

const uint8_t m_indexPort
 Zero based index of the GPIO port (A = 0, B = 1, ...) More...
 
const uint8_t m_indexPin
 Zero based index of the pin in the port (A0 = 0, A1 = 1, ...) More...
 
const uint8_t m_mode
 Pin mode. More...
 

Detailed Description

Defines the properties of a single pin configuration of the CPU.

Constructor & Destructor Documentation

◆ PinDefinition()

imt::base::bsp::stm32f103::PinDefinition::PinDefinition ( const uint8_t  indexPort,
const uint8_t  indexPin,
const GPIO_Mode  mode 
)

Constructor.

Member Function Documentation

◆ configure() [1/2]

void imt::base::bsp::stm32f103::PinDefinition::configure ( )

Configure the Pin using the STM32 F103 MD HAL.

◆ configure() [2/2]

void imt::base::bsp::stm32f103::PinDefinition::configure ( const GPIO_Mode  mode) const

Configure the Pin using the STM32 F103 MD HAL.

◆ read()

bool imt::base::bsp::stm32f103::PinDefinition::read ( void  ) const

◆ registerIrq() [1/2]

void imt::base::bsp::stm32f103::PinDefinition::registerIrq ( const size_t  indexModule,
const size_t  indexDriver,
const size_t  indexEndpoint,
const imt::base::bsp::type::TriggerEdge::Id  triggerEdge,
imt::base::bsp::handler::HighLevelValueHandlerIfc pHandler 
) const

◆ registerIrq() [2/2]

void imt::base::bsp::stm32f103::PinDefinition::registerIrq ( const size_t  indexModule,
const size_t  indexDriver,
const size_t  indexEndpoint,
const imt::base::bsp::type::TriggerEdge::Id  triggerEdge,
imt::base::bsp::handler::TriggerEdgeHandlerIfc pHandler 
) const

◆ unregisterIrq()

void imt::base::bsp::stm32f103::PinDefinition::unregisterIrq ( void  ) const

◆ write()

void imt::base::bsp::stm32f103::PinDefinition::write ( const bool  state) const

Member Data Documentation

◆ m_indexPin

const uint8_t imt::base::bsp::stm32f103::PinDefinition::m_indexPin

Zero based index of the pin in the port (A0 = 0, A1 = 1, ...)

◆ m_indexPort

const uint8_t imt::base::bsp::stm32f103::PinDefinition::m_indexPort

Zero based index of the GPIO port (A = 0, B = 1, ...)

◆ m_mode

const uint8_t imt::base::bsp::stm32f103::PinDefinition::m_mode

Pin mode.


The documentation for this struct was generated from the following file: