SwTSDriver.h File Reference

Software driver for the timestamp service. More...

#include "drivers/ITSDriver.h"
#include "drivers/ITSDriver_vtbl.h"
#include "tx_api.h"

Include dependency graph for SwTSDriver.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_SwTSDriver_t

Typedefs
typedef struct _SwTSDriverParams_t	SwTSDriverParams_t
typedef struct _SwTSDriver_t	SwTSDriver_t

Functions
IDriver *	SwTSDriverAlloc (void)

Detailed Description

Software driver for the timestamp service.

Author

STMicroelectronics - AIS - MCD Team

Version

4.0.0

Date

Mar 21, 2022

This driver reuses the RTOS tick, so the configuration parameter SYS_TS_CFG_TSDRIVER_FREQ_HZ must be set to onfigTICK_RATE_HZ for the FreeRTOS version of eLooM, and the SYS_TS_CFG_TSDRIVER_PARAMS parameter must be set to SYS_TS_USE_SW_TSDRIVER.

This driver has the advantage to do not use any dedicated hardware resource, but on the other side its resolution is limited to the 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

SwTSDriver_t

typedef struct _SwTSDriver_t SwTSDriver_t

Create type name for _SwTSDriver_t.

SwTSDriverParams_t

typedef struct _SwTSDriverParams_t SwTSDriverParams_t

Create type name for _HwTSDriver_t.

Function Documentation

SwTSDriverAlloc()

IDriver * SwTSDriverAlloc

(

void

)

Public API declaration Allocate an instance of SwTSDriver_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.