Class TimerPAL
Defined in File hss-pal-timer.hpp
Inheritance Relationships
Derived Type
public hss::TimerIno(Class TimerIno)
Class Documentation
-
class TimerPAL
Timer abstract API.
Subclassed by hss::TimerIno
Public Functions
-
virtual Error_t init() = 0
Initialize the timer.
- Return values:
OK – If success
INIT_ERROR – If hardware interface error
- Returns:
High-side switch error code
-
virtual Error_t deinit() = 0
Deinitialize the timer.
- Return values:
OK – If success
INIT_ERROR – If hardware interface error
- Returns:
High-side switch error code
-
virtual Error_t start() = 0
Starts the timer.
- Return values:
OK – If success
INIT_ERROR – If hardware interface error
- Returns:
High-side switch error code
-
virtual Error_t elapsed(uint32_t &elapsed) = 0
Elapsed time since the timer was started.
- Parameters:
elapsed – [out] Time in milliseconds
- Return values:
OK – If success
INIT_ERROR – If hardware interface error
- Returns:
High-side switch error code
-
virtual Error_t stop() = 0
Stops the timer.
- Return values:
OK – If success
INIT_ERROR – If hardware interface error
- Returns:
High-side switch error code
-
virtual Error_t delayMilli(uint32_t timeout) = 0
Introduces a delay during the specified time.
- Parameters:
timeout – [in] Delay time in milliseconds
- Return values:
OK – If success
INIT_ERROR – If hardware interface error
- Returns:
High-side switch error code
-
virtual Error_t delayMicro(uint32_t timeout) = 0
Introduces a delay during the specified time.
- Parameters:
timeout – [in] Delay time in microseconds
- Return values:
OK – If success
INIT_ERROR – If hardware interface error
- Returns:
High-side switch error code
-
virtual Error_t init() = 0