Martin Johnson / STM32F3-Discovery

Dependents:   Space_Invaders_Demo neopixels gpio_test_stm32f3_discovery gpio_test_systimer ... more

Embed: (wiki syntax)

« Back to documentation index

Peripheral State methods

Peripheral State methods
[HRTIM_Private_Functions]

Peripheral State functions. More...

Functions

uint32_t HRTIM_GetCapturedValue (HRTIM_TypeDef *HRTIMx, uint32_t TimerIdx, uint32_t CaptureUnit)
 Returns actual value of the capture register of the designated capture unit.
uint32_t HRTIM_WaveformGetOutputLevel (HRTIM_TypeDef *HRTIMx, uint32_t TimerIdx, uint32_t Output)
 Returns actual level (active or inactive) of the designated output.
uint32_t HRTIM_WaveformGetOutputState (HRTIM_TypeDef *HRTIMx, uint32_t TimerIdx, uint32_t Output)
 Returns actual state (RUN, IDLE, FAULT) of the designated output.
uint32_t HRTIM_GetDelayedProtectionStatus (HRTIM_TypeDef *HRTIMx, uint32_t TimerIdx, uint32_t Output)
 Returns the level (active or inactive) of the designated output when the delayed protection was triggered.
uint32_t HRTIM_GetBurstStatus (HRTIM_TypeDef *HRTIMx)
 Returns the actual status (active or inactive) of the burst mode controller.
uint32_t HRTIM_GetCurrentPushPullStatus (HRTIM_TypeDef *HRTIMx, uint32_t TimerIdx)
 Indicates on which output the signal is currently active (when the push pull mode is enabled)
uint32_t HRTIM_GetIdlePushPullStatus (HRTIM_TypeDef *HRTIMx, uint32_t TimerIdx)
 Indicates on which output the signal was applied, in push-pull mode balanced fault mode or delayed idle mode, when the protection was triggered.
static void HRTIM_MasterBase_Config (HRTIM_TypeDef *HRTIMx, HRTIM_BaseInitTypeDef *HRTIM_BaseInitStruct)
 Configures the master timer time base.
static void HRTIM_TimingUnitBase_Config (HRTIM_TypeDef *HRTIMx, uint32_t TimerIdx, HRTIM_BaseInitTypeDef *HRTIM_BaseInitStruct)
 Configures timing unit (timer A to timer E) time base.
static void HRTIM_MasterWaveform_Config (HRTIM_TypeDef *HRTIMx, HRTIM_TimerInitTypeDef *pTimerInit)
 Configures the master timer in waveform mode.
static void HRTIM_TimingUnitWaveform_Config (HRTIM_TypeDef *HRTIMx, uint32_t TimerIdx, HRTIM_TimerInitTypeDef *pTimerInit)
 Configures timing unit (timer A to timer E) in waveform mode.
static void HRTIM_CompareUnitConfig (HRTIM_TypeDef *HRTIMx, uint32_t TimerIdx, uint32_t CompareUnit, HRTIM_CompareCfgTypeDef *pCompareCfg)
 Configures a compare unit.
static void HRTIM_CaptureUnitConfig (HRTIM_TypeDef *HRTIMx, uint32_t TimerIdx, uint32_t CaptureUnit, uint32_t Event)
 Configures a capture unit.
static void HRTIM_OutputConfig (HRTIM_TypeDef *HRTIMx, uint32_t TimerIdx, uint32_t Output, HRTIM_OutputCfgTypeDef *pOutputCfg)
 Configures the output of a timing unit.
static void HRTIM_ExternalEventConfig (HRTIM_TypeDef *HRTIMx, uint32_t Event, HRTIM_EventCfgTypeDef *pEventCfg)
 Configures an external event channel.
static void HRTIM_TIM_ResetConfig (HRTIM_TypeDef *HRTIMx, uint32_t TimerIdx, uint32_t Event)
 Configures the timer counter reset.

Detailed Description

Peripheral State functions.

 ===============================================================================
                      ##### Peripheral State methods #####
 ===============================================================================  
    [..]
    This subsection permit to get in run-time the status of the peripheral 
    and the data flow.


Function Documentation

void HRTIM_CaptureUnitConfig ( HRTIM_TypeDef *  HRTIMx,
uint32_t  TimerIdx,
uint32_t  CaptureUnit,
uint32_t  Event 
) [static]

Configures a capture unit.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
TimerIdx,:Timer index
CaptureUnit,:Capture unit identifier
pCaptureCfg,:pointer to the compare unit configuration data structure
Return values:
None

Definition at line 3705 of file stm32f30x_hrtim.c.

void HRTIM_CompareUnitConfig ( HRTIM_TypeDef *  HRTIMx,
uint32_t  TimerIdx,
uint32_t  CompareUnit,
HRTIM_CompareCfgTypeDef *  pCompareCfg 
) [static]

Configures a compare unit.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
TimerIdx,:Timer index
CompareUnit,:Compare unit identifier
pCompareCfg,:pointer to the compare unit configuration data structure
Return values:
None

Definition at line 3632 of file stm32f30x_hrtim.c.

static void HRTIM_ExternalEventConfig ( HRTIM_TypeDef *  HRTIMx,
uint32_t  Event,
HRTIM_EventCfgTypeDef *  pEventCfg 
) [static]

Configures an external event channel.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
Event,:Event channel identifier
pEventCfg,:pointer to the event channel configuration data structure
Return values:
None

Definition at line 3872 of file stm32f30x_hrtim.c.

uint32_t HRTIM_GetBurstStatus ( HRTIM_TypeDef *  HRTIMx )

Returns the actual status (active or inactive) of the burst mode controller.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
Return values:
Burstmode controller status

Definition at line 3380 of file stm32f30x_hrtim.c.

uint32_t HRTIM_GetCapturedValue ( HRTIM_TypeDef *  HRTIMx,
uint32_t  TimerIdx,
uint32_t  CaptureUnit 
)

Returns actual value of the capture register of the designated capture unit.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
TimerIdx,:Timer index This parameter can be one of the following values:

  • 0x0 to 0x4 for timers A to E
CaptureUnit,:Capture unit to trig This parameter can be one of the following values:

  • HRTIM_CAPTUREUNIT_1: Capture unit 1
  • HRTIM_CAPTUREUNIT_2: Capture unit 2
Return values:
Capturedvalue

Definition at line 3087 of file stm32f30x_hrtim.c.

uint32_t HRTIM_GetCurrentPushPullStatus ( HRTIM_TypeDef *  HRTIMx,
uint32_t  TimerIdx 
)

Indicates on which output the signal is currently active (when the push pull mode is enabled)

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
TimerIdx,:Timer index This parameter can be one of the following values:

  • 0x0 to 0x4 for timers A to E
Return values:
Burstmode controller status

Definition at line 3399 of file stm32f30x_hrtim.c.

uint32_t HRTIM_GetDelayedProtectionStatus ( HRTIM_TypeDef *  HRTIMx,
uint32_t  TimerIdx,
uint32_t  Output 
)

Returns the level (active or inactive) of the designated output when the delayed protection was triggered.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
TimerIdx,:Timer index This parameter can be one of the following values:

  • 0x0 to 0x4 for timers A to E
Output,:Timer output This parameter can be one of the following values:

  • HRTIM_OUTPUT_TA1: Timer A - Output 1
  • HRTIM_OUTPUT_TA2: Timer A - Output 2
  • HRTIM_OUTPUT_TB1: Timer B - Output 1
  • HRTIM_OUTPUT_TB2: Timer B - Output 2
  • HRTIM_OUTPUT_TC1: Timer C - Output 1
  • HRTIM_OUTPUT_TC2: Timer C - Output 2
  • HRTIM_OUTPUT_TD1: Timer D - Output 1
  • HRTIM_OUTPUT_TD2: Timer D - Output 2
  • HRTIM_OUTPUT_TD1: Timer E - Output 1
  • HRTIM_OUTPUT_TD2: Timer E - Output 2
Return values:
Delayedprotection status

Definition at line 3320 of file stm32f30x_hrtim.c.

uint32_t HRTIM_GetIdlePushPullStatus ( HRTIM_TypeDef *  HRTIMx,
uint32_t  TimerIdx 
)

Indicates on which output the signal was applied, in push-pull mode balanced fault mode or delayed idle mode, when the protection was triggered.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
TimerIdx,:Timer index This parameter can be one of the following values:

  • 0x0 to 0x4 for timers A to E
Return values:
IdlePush Pull Status

Definition at line 3423 of file stm32f30x_hrtim.c.

void HRTIM_MasterBase_Config ( HRTIM_TypeDef *  HRTIMx,
HRTIM_BaseInitTypeDef *  HRTIM_BaseInitStruct 
) [static]

Configures the master timer time base.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
Return values:
None

Definition at line 3442 of file stm32f30x_hrtim.c.

void HRTIM_MasterWaveform_Config ( HRTIM_TypeDef *  HRTIMx,
HRTIM_TimerInitTypeDef *  pTimerInit 
) [static]

Configures the master timer in waveform mode.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
TimerIdx,:Timer index
pTimerInit,:pointer to the timer initialization data structure
Return values:
None

Definition at line 3485 of file stm32f30x_hrtim.c.

void HRTIM_OutputConfig ( HRTIM_TypeDef *  HRTIMx,
uint32_t  TimerIdx,
uint32_t  Output,
HRTIM_OutputCfgTypeDef *  pOutputCfg 
) [static]

Configures the output of a timing unit.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
TimerIdx,:Timer index
Output,:timing unit output identifier
pOutputCfg,:pointer to the output configuration data structure
Return values:
None

Definition at line 3793 of file stm32f30x_hrtim.c.

void HRTIM_TIM_ResetConfig ( HRTIM_TypeDef *  HRTIMx,
uint32_t  TimerIdx,
uint32_t  Event 
) [static]

Configures the timer counter reset.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
TimerIdx,:Timer index
Event,:Event channel identifier
Return values:
None

Definition at line 4029 of file stm32f30x_hrtim.c.

void HRTIM_TimingUnitBase_Config ( HRTIM_TypeDef *  HRTIMx,
uint32_t  TimerIdx,
HRTIM_BaseInitTypeDef *  HRTIM_BaseInitStruct 
) [static]

Configures timing unit (timer A to timer E) time base.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
TimerIdx,:Timer index
Return values:
None

Definition at line 3463 of file stm32f30x_hrtim.c.

void HRTIM_TimingUnitWaveform_Config ( HRTIM_TypeDef *  HRTIMx,
uint32_t  TimerIdx,
HRTIM_TimerInitTypeDef *  pTimerInit 
) [static]

Configures timing unit (timer A to timer E) in waveform mode.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
TimerIdx,:Timer index
pTimerInit,:pointer to the timer initialization data structure
Return values:
None

Definition at line 3540 of file stm32f30x_hrtim.c.

uint32_t HRTIM_WaveformGetOutputLevel ( HRTIM_TypeDef *  HRTIMx,
uint32_t  TimerIdx,
uint32_t  Output 
)

Returns actual level (active or inactive) of the designated output.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
TimerIdx,:Timer index This parameter can be one of the following values:

  • 0x0 to 0x4 for timers A to E
Output,:Timer output This parameter can be one of the following values:

  • HRTIM_OUTPUT_TA1: Timer A - Output 1
  • HRTIM_OUTPUT_TA2: Timer A - Output 2
  • HRTIM_OUTPUT_TB1: Timer B - Output 1
  • HRTIM_OUTPUT_TB2: Timer B - Output 2
  • HRTIM_OUTPUT_TC1: Timer C - Output 1
  • HRTIM_OUTPUT_TC2: Timer C - Output 2
  • HRTIM_OUTPUT_TD1: Timer D - Output 1
  • HRTIM_OUTPUT_TD2: Timer D - Output 2
  • HRTIM_OUTPUT_TE1: Timer E - Output 1
  • HRTIM_OUTPUT_TE2: Timer E - Output 2
Return values:
Outputlevel
Note:
Returned output level is taken before the output stage (chopper, polarity).

Definition at line 3139 of file stm32f30x_hrtim.c.

uint32_t HRTIM_WaveformGetOutputState ( HRTIM_TypeDef *  HRTIMx,
uint32_t  TimerIdx,
uint32_t  Output 
)

Returns actual state (RUN, IDLE, FAULT) of the designated output.

Parameters:
HRTIMx,:pointer to HRTIMx peripheral
TimerIdx,:Timer index This parameter can be one of the following values:

  • 0x0 to 0x4 for timers A to E
Output,:Timer output This parameter can be one of the following values:

  • HRTIM_OUTPUT_TA1: Timer A - Output 1
  • HRTIM_OUTPUT_TA2: Timer A - Output 2
  • HRTIM_OUTPUT_TB1: Timer B - Output 1
  • HRTIM_OUTPUT_TB2: Timer B - Output 2
  • HRTIM_OUTPUT_TC1: Timer C - Output 1
  • HRTIM_OUTPUT_TC2: Timer C - Output 2
  • HRTIM_OUTPUT_TD1: Timer D - Output 1
  • HRTIM_OUTPUT_TD2: Timer D - Output 2
  • HRTIM_OUTPUT_TE1: Timer E - Output 1
  • HRTIM_OUTPUT_TE2: Timer E - Output 2
Return values:
Outputstate

Definition at line 3210 of file stm32f30x_hrtim.c.