eLooM for STM32 application  v3.3.0
Loading...
Searching...
No Matches
Data Structures | Typedefs | Functions
HwTSDriver.h File Reference

Driver for the timestamp service that use an hardware timer. More...

#include "drivers/ITSDriver.h"
#include "drivers/ITSDriver_vtbl.h"
+ Include dependency graph for HwTSDriver.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _SYS_TIMParams_t
 
struct  _HwTSDriverParams_t
 
struct  _HwTSDriver_t
 

Typedefs

typedef struct _HwTSDriverParams_t HwTSDriverParams_t
 
typedef struct _HwTSDriver_t HwTSDriver_t
 
typedef struct _SYS_TIMParams_t SYS_TIMParams_t
 

Functions

IDriverHwTSDriverAlloc (void)
 

Detailed Description

Driver for the timestamp service that use an hardware timer.

Author
STMicroelectronics - AIS - MCD Team
Version
4.0.0
Date
Mar 15, 2022

This driver uses an hardware timer to generate the tick for the timestamp service. To use this driver the configuration parameter SYS_TS_CFG_TSDRIVER_FREQ_HZ must be set to the address of a timer configuration structure compatible with SYS_TIMParams_t, and the SYS_TS_CFG_TSDRIVER_PARAMS parameter must be set to the clock frequency in Hz of the hardware timer.

This driver needs a dedicated hardware resource, but on the other side its resolution is not limited by the RTOS tick.

Attention

Copyright (c) 2022 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

Typedef Documentation

◆ HwTSDriver_t

typedef struct _HwTSDriver_t HwTSDriver_t

Create type name for _HwTSDriver_t.

◆ HwTSDriverParams_t

Create type name for _HwTSDriver_t.

◆ SYS_TIMParams_t

HW Timer configuration parameters.

Function Documentation

◆ HwTSDriverAlloc()

IDriver * HwTSDriverAlloc ( void  )

Public API declaration Allocate an instance of HwTSDriver_t. The driver is allocated in the FreeRTOS heap.

Returns
a pointer to the generic interface IDriver if success, or SYS_OUT_OF_MEMORY_ERROR_CODE otherwise.