DRV_TIM_HANDLE_T Struct Reference

Timer Base Handle Structure definition. More...

#include <netx_drv_tim.h>

Collaboration diagram for DRV_TIM_HANDLE_T:

Public Member Functions
DRV_STATUS_E	DRV_TIM_Init (DRV_TIM_HANDLE_T *const ptTim)
	Initializes the TIM Base peripheral. More...
DRV_STATUS_E	DRV_TIM_DeInit (DRV_TIM_HANDLE_T *const ptTim)
	DeInitializes the TIM Base peripheral. More...
DRV_STATUS_E	DRV_TIM_Start (DRV_TIM_HANDLE_T *const ptTim)
	Starts the TIM generation. More...
DRV_STATUS_E	DRV_TIM_Stop (DRV_TIM_HANDLE_T *const ptTim)
	Stops the TIM generation. More...
DRV_STATUS_E	DRV_TIM_Pause (DRV_TIM_HANDLE_T *const ptTim)
	Pauses the TIM generation. More...
DRV_STATUS_E	DRV_TIM_Wait (DRV_TIM_HANDLE_T *const ptTim, uint32_t ulTickCnt)
	Waits at least until uSkipCnt events have occurred. More...
DRV_STATUS_E	DRV_TIM_ChannelSetThreshold (DRV_TIM_HANDLE_T *const ptTim, DRV_DIO_ID_T ulChannelID, uint32_t ulTC)
	This function sets the threshold used for the specified channel. More...
DRV_STATUS_E	DRV_TIM_ChannelGetCapture (DRV_TIM_HANDLE_T *const ptTim, DRV_DIO_ID_T ulChannelID, uint32_t *const ulValue)
	This function gets the captured value of the specified channel. More...
DRV_STATUS_E	DRV_TIM_IRQAttach (DRV_TIM_HANDLE_T *const ptTim, DRV_CALLBACK_F pfnUserClb, void *pvUser)
	Attaches a given callback to the counter. More...
DRV_STATUS_E	DRV_TIM_GetState (DRV_TIM_HANDLE_T *const ptTim, DRV_TIM_STATE_E *const peState)
	Stores the state of the given counter. More...
__STATIC_FORCEINLINE void	DRV_TIM_LatchSytimes (void)
	This function latches all system time counters. More...
DRV_STATUS_E	DRV_TIM_GetValue (DRV_TIM_HANDLE_T *const ptTim, uint32_t *const ptSoftwareValue, uint32_t *const ptHardwareValue)
	Stores the current counter value. More...
DRV_STATUS_E	DRV_TIM_SetPreload (DRV_TIM_HANDLE_T *const ptTim, DRV_TIM_PRELOAD_VALUE_E tCounterValue)
	Sets a new preload value. More...

Data Fields
DRV_TIM_CONFIGURATION_T	tConfiguration

Private Attributes
uint32_t	ulSubID
DRV_TIM_DEVICE_U	ptDevice
DRV_LOCK_T	tLock
DRV_TIM_STATE_E	eState

Detailed Description

Timer Base Handle Structure definition.

The configuration SHALL be changed before initializing the device and shall not be changed afterwards. The rest of it SHALL not be modified outside of the driver, even if it appears to be possible.

Definition at line 196 of file netx_drv_tim.h.

Field Documentation

DRV_TIM_STATE_E DRV_TIM_HANDLE_T::eState

private

The error variable used for return values

Definition at line 202 of file netx_drv_tim.h.

DRV_TIM_DEVICE_U DRV_TIM_HANDLE_T::ptDevice

private

Pointer to the device.

Definition at line 199 of file netx_drv_tim.h.

DRV_TIM_CONFIGURATION_T DRV_TIM_HANDLE_T::tConfiguration

TIM Base configuration parameters

Definition at line 200 of file netx_drv_tim.h.

DRV_LOCK_T DRV_TIM_HANDLE_T::tLock

private

The drivers locking variable used as internal mutex

Definition at line 201 of file netx_drv_tim.h.

uint32_t DRV_TIM_HANDLE_T::ulSubID

private

Which dimension element of the device is used.

Definition at line 198 of file netx_drv_tim.h.

---

The documentation for this struct was generated from the following files:

• netx_drv_tim.h
• netx_drv_tim.c