Skip to content

Commit f933cef

Browse files
Updated Timer Init docs
Updated the supported timers for each board in the comments on the respective concrete implementations. Signed-off-by: Taylor Lineman <git@actuallytaylor.com>
1 parent 54a9524 commit f933cef

2 files changed

Lines changed: 11 additions & 11 deletions

File tree

include/core/dev/platform/f3xx/Timerf3xx.hpp

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,15 @@ class TimerF3xx : public Timer {
2727
/**
2828
* Will initialize the timer device on the STM with the given period and the given IRQ Handler
2929
* that triggers with the given period. Starts the timer
30-
* @param timerPeripheral[in] The timer peripheral to configure. Possible options for this board are
31-
* TIM2, TIM15, TIM16, TIM17. It is up to the user to verify that resource conflicts
32-
* do not occur.
3330
*
31+
* @param timerPeripheral[in] The timer peripheral to configure. Possible options for this board are
32+
* TIM1, TIM2, TIM15, TIM16, TIM17. It is up to the user to verify that resource conflicts do not occur.
3433
* @param[in] timerPeripheral The timer to use
35-
* @param[in] clockPeriod the clock period in ticks (ms when using AUTO_PRESCALER). An interrupt will be triggered
34+
* @param[in] clockPeriod The clock period in ticks (ms when using AUTO_PRESCALER). An interrupt will be triggered
3635
* at this frequency.
37-
* @param[in] configuration the configuration tells the timer how to configure itself. Defaults to @ref
36+
* @param[in] configuration The configuration tells the timer how to configure itself. Defaults to @ref
3837
* TimerF3xx::defaultConfig.
39-
* @param[in] clockPrescaler the prescaler that the clock will use. If clockPrescaler is set to @ref AUTO_PRESCALER,
38+
* @param[in] clockPrescaler The prescaler that the clock will use. If clockPrescaler is set to @ref AUTO_PRESCALER,
4039
* this function will calculate its own prescaler value.
4140
*/
4241
explicit TimerF3xx(TIM_TypeDef* timerPeripheral, uint32_t clockPeriod,
@@ -95,8 +94,10 @@ class TimerF3xx : public Timer {
9594

9695
/**
9796
* Handles the initialization of the timer module. Actually configures the device and enables it.
98-
* @param[in] timerPeripheral The timer peripheral to configure. Possible options for this board are
99-
* TIM2, TIM15, TIM16, TIM17. It is up to the user to verify that resource conflicts do not occur.
97+
*
98+
* @param timerPeripheral[in] The timer peripheral to configure. It is up to the user to verify that resource conflicts do not occur.
99+
* F334 Valid Options: TIM1, TIM2, TIM3, TIM15, TIM16, TIM17.
100+
* F3O2 Valid Options: TIM1, TIM2, TIM15, TIM16, TIM17.
100101
* @param[in] clockPeriod the clock period in ticks (ms when using AUTO_PRESCALER). An interrupt will be triggered
101102
* at that frequency.
102103
* @param[in] clockPrescaler the prescaler that the clock will use. If clockPrescaler is set to @ref AUTO_PRESCALER,

include/core/dev/platform/f4xx/Timerf4xx.hpp

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,9 @@ class TimerF4xx final : public Timer {
2929
/**
3030
* Will initialize the timer device on the STM with the given period and the given IRQ Handler
3131
* that triggers with the given period. Starts the timer
32-
* @param timerPeripheral[in] The timer peripheral to configure. Possible options for this board are
33-
* TIM1, TIM2, TIM3, TIM4, TIM5, TIM8, TIM9, TIM10, TIM11, TIM11, TIM13, TIM14.
34-
* It is up to the user to verify that resource conflicts do not occur.
3532
*
33+
* @param timerPeripheral[in] The timer peripheral to configure. It is up to the user to verify that resource conflicts do not occur.
34+
* F446xx Valid Options: TIM1, TIM2, TIM3, TIM4, TIM5, TIM8, TIM9, TIM10, TIM11, TIM12, TIM13, TIM14.
3635
* @param[in] timerPeripheral the timer peripheral to use.
3736
* @param[in] clockPeriod the clock period in ticks (ms when using AUTO_PRESCALER). An interrupt will be triggered
3837
* at this frequency.

0 commit comments

Comments
 (0)