cfn_hal_timer.h File Reference

General Purpose Timer HAL API. More...

#include "cfn_hal.h"
#include "cfn_hal_base.h"
#include "cfn_hal_types.h"

Go to the source code of this file.

Data Structures
struct	cfn_hal_timer_config_t
	Timer configuration structure. More...
struct	cfn_hal_timer_phy_t
	Timer hardware physical mapping. More...
struct	cfn_hal_timer_period_t
	Timer period and channel mapping. More...
struct	cfn_hal_timer_api_s
	Timer Virtual Method Table (VMT). More...

Typedefs
typedef struct cfn_hal_timer_s	cfn_hal_timer_t
typedef struct cfn_hal_timer_api_s	cfn_hal_timer_api_t
typedef void(*	cfn_hal_timer_callback_t) (cfn_hal_timer_t *driver, uint32_t event_mask, uint32_t error_mask, uint32_t channel, void *user_arg)
	Timer callback signature.

Enumerations
enum	cfn_hal_timer_event_t {   CFN_HAL_TIMER_EVENT_NONE = 0 , CFN_HAL_TIMER_EVENT_UPDATE = CFN_HAL_BIT(0) , CFN_HAL_TIMER_EVENT_CC1 = CFN_HAL_BIT(1) , CFN_HAL_TIMER_EVENT_CC2 = CFN_HAL_BIT(2) ,   CFN_HAL_TIMER_EVENT_CC3 = CFN_HAL_BIT(3) , CFN_HAL_TIMER_EVENT_CC4 = CFN_HAL_BIT(4) , CFN_HAL_TIMER_EVENT_TRIGGER = CFN_HAL_BIT(5) }
	Timer nominal event flags. More...
enum	cfn_hal_timer_error_t { CFN_HAL_TIMER_ERROR_NONE = 0 , CFN_HAL_TIMER_ERROR_BREAK = CFN_HAL_BIT(0) , CFN_HAL_TIMER_ERROR_GENERAL = CFN_HAL_BIT(1) }
	Timer exception error flags. More...

Functions
	CFN_HAL_VMT_CHECK (struct cfn_hal_timer_api_s)
	CFN_HAL_CREATE_DRIVER_TYPE (timer, cfn_hal_timer_config_t, cfn_hal_timer_api_t, cfn_hal_timer_phy_t, cfn_hal_timer_callback_t)
CFN_HAL_INLINE void	cfn_hal_timer_populate (cfn_hal_timer_t *driver, uint32_t peripheral_id, struct cfn_hal_clock_s *clock, void *dependency, const cfn_hal_timer_api_t *api, const cfn_hal_timer_phy_t *phy, const cfn_hal_timer_config_t *config, cfn_hal_timer_callback_t callback, void *user_arg)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_config_validate (const cfn_hal_timer_t *driver, const cfn_hal_timer_config_t *config)
	Validates the Timer configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_init (cfn_hal_timer_t *driver)
	Initializes the Timer driver.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_deinit (cfn_hal_timer_t *driver)
	Deinitializes the Timer driver.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_config_set (cfn_hal_timer_t *driver, const cfn_hal_timer_config_t *config)
	Sets the Timer configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_config_get (cfn_hal_timer_t *driver, cfn_hal_timer_config_t *config)
	Gets the current Timer configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_callback_register (cfn_hal_timer_t *driver, const cfn_hal_timer_callback_t callback, void *user_arg)
	Registers a callback for Timer events and errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_power_state_set (cfn_hal_timer_t *driver, cfn_hal_power_state_t state)
	Sets the Timer power state.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_event_enable (cfn_hal_timer_t *driver, uint32_t event_mask)
	Enables one or more Timer nominal events.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_event_disable (cfn_hal_timer_t *driver, uint32_t event_mask)
	Disables one or more Timer nominal events.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_event_get (cfn_hal_timer_t *driver, uint32_t *event_mask)
	Retrieves the current Timer nominal event status.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_error_enable (cfn_hal_timer_t *driver, uint32_t error_mask)
	Enables one or more Timer exception errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_error_disable (cfn_hal_timer_t *driver, uint32_t error_mask)
	Disables one or more Timer exception errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_error_get (cfn_hal_timer_t *driver, uint32_t *error_mask)
	Retrieves the current Timer exception error status.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_start (cfn_hal_timer_t *driver)
	Starts the timer counter.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_stop (cfn_hal_timer_t *driver)
	Stops the timer counter.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_get_ticks (cfn_hal_timer_t *driver, uint32_t ch, uint32_t *ticks)
	Reads the current tick count for a specific channel (32-bit).
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_get_ticks_u64 (cfn_hal_timer_t *driver, uint32_t ch, uint64_t *ticks)
	Reads the current tick count for a specific channel (64-bit).
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_timer_set_period (cfn_hal_timer_t *driver, const cfn_hal_timer_period_t *period)
	Updates the timer period/reload value for a specific channel.
cfn_hal_error_code_t	cfn_hal_timer_construct (cfn_hal_timer_t *driver, const cfn_hal_timer_config_t *config, const cfn_hal_timer_phy_t *phy, struct cfn_hal_clock_s *clock, void *dependency, cfn_hal_timer_callback_t callback, void *user_arg)
cfn_hal_error_code_t	cfn_hal_timer_destruct (cfn_hal_timer_t *driver)

Detailed Description

General Purpose Timer HAL API.

Copyright (c) 2026 Hisham Moussa Daou https://www.whileone.me

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Typedef Documentation

cfn_hal_timer_api_t

typedef struct cfn_hal_timer_api_s cfn_hal_timer_api_t

cfn_hal_timer_callback_t

typedef void(* cfn_hal_timer_callback_t) (cfn_hal_timer_t *driver, uint32_t event_mask, uint32_t error_mask, uint32_t channel, void *user_arg)

Timer callback signature.

Parameters

driver	Pointer to the Timer driver instance.
event_mask	Mask of triggered nominal events.
error_mask	Mask of triggered exception errors.
channel	Source channel index (if applicable).
user_arg	User-defined argument passed during registration.

cfn_hal_timer_t

typedef struct cfn_hal_timer_s cfn_hal_timer_t

Enumeration Type Documentation

cfn_hal_timer_error_t

enum cfn_hal_timer_error_t

Timer exception error flags.

Enumerator
CFN_HAL_TIMER_ERROR_NONE
CFN_HAL_TIMER_ERROR_BREAK	Safety break input triggered
CFN_HAL_TIMER_ERROR_GENERAL	General hardware error

cfn_hal_timer_event_t

enum cfn_hal_timer_event_t

Timer nominal event flags.

Enumerator
CFN_HAL_TIMER_EVENT_NONE
CFN_HAL_TIMER_EVENT_UPDATE	Counter rollover/update
CFN_HAL_TIMER_EVENT_CC1	Capture/Compare channel 1
CFN_HAL_TIMER_EVENT_CC2	Capture/Compare channel 2
CFN_HAL_TIMER_EVENT_CC3	Capture/Compare channel 3
CFN_HAL_TIMER_EVENT_CC4	Capture/Compare channel 4
CFN_HAL_TIMER_EVENT_TRIGGER	Trigger input event

Function Documentation

CFN_HAL_CREATE_DRIVER_TYPE()

CFN_HAL_CREATE_DRIVER_TYPE	(	timer	,
		cfn_hal_timer_config_t	,
		cfn_hal_timer_api_t	,
		cfn_hal_timer_phy_t	,
		cfn_hal_timer_callback_t
	)

cfn_hal_timer_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_callback_register	(	cfn_hal_timer_t *	driver,
		const cfn_hal_timer_callback_t	callback,
		void *	user_arg
	)

Registers a callback for Timer events and errors.

Parameters

driver	Pointer to the Timer driver instance.
callback	The callback function to register.
user_arg	User-defined argument passed to the callback.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_config_get	(	cfn_hal_timer_t *	driver,
		cfn_hal_timer_config_t *	config
	)

Gets the current Timer configuration.

Parameters

driver	Pointer to the Timer driver instance.
config	[out] Pointer to store the configuration.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_config_set	(	cfn_hal_timer_t *	driver,
		const cfn_hal_timer_config_t *	config
	)

Sets the Timer configuration.

Parameters

driver	Pointer to the Timer driver instance.
config	Pointer to the configuration structure.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_config_validate()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_config_validate	(	const cfn_hal_timer_t *	driver,
		const cfn_hal_timer_config_t *	config
	)

Validates the Timer configuration.

Parameters

driver	Pointer to the TIMER driver instance.
config	Pointer to the configuration structure.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_construct()

cfn_hal_error_code_t cfn_hal_timer_construct	(	cfn_hal_timer_t *	driver,
		const cfn_hal_timer_config_t *	config,
		const cfn_hal_timer_phy_t *	phy,
		struct cfn_hal_clock_s *	clock,
		void *	dependency,
		cfn_hal_timer_callback_t	callback,
		void *	user_arg
	)

cfn_hal_timer_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_deinit

(

cfn_hal_timer_t *

driver

)

Deinitializes the Timer driver.

Parameters

driver

Pointer to the Timer driver instance.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_destruct()

cfn_hal_error_code_t cfn_hal_timer_destruct

(

cfn_hal_timer_t *

driver

)

cfn_hal_timer_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_error_disable	(	cfn_hal_timer_t *	driver,
		uint32_t	error_mask
	)

Disables one or more Timer exception errors.

Parameters

driver	Pointer to the Timer driver instance.
error_mask	Mask of errors to disable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_error_enable	(	cfn_hal_timer_t *	driver,
		uint32_t	error_mask
	)

Enables one or more Timer exception errors.

Parameters

driver	Pointer to the Timer driver instance.
error_mask	Mask of errors to enable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_error_get	(	cfn_hal_timer_t *	driver,
		uint32_t *	error_mask
	)

Retrieves the current Timer exception error status.

Parameters

driver	Pointer to the Timer driver instance.
error_mask	[out] Pointer to store the error mask.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_event_disable	(	cfn_hal_timer_t *	driver,
		uint32_t	event_mask
	)

Disables one or more Timer nominal events.

Parameters

driver	Pointer to the Timer driver instance.
event_mask	Mask of events to disable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_event_enable	(	cfn_hal_timer_t *	driver,
		uint32_t	event_mask
	)

Enables one or more Timer nominal events.

Parameters

driver	Pointer to the Timer driver instance.
event_mask	Mask of events to enable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_event_get	(	cfn_hal_timer_t *	driver,
		uint32_t *	event_mask
	)

Retrieves the current Timer nominal event status.

Parameters

driver	Pointer to the Timer driver instance.
event_mask	[out] Pointer to store the event mask.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_get_ticks()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_get_ticks	(	cfn_hal_timer_t *	driver,
		uint32_t	ch,
		uint32_t *	ticks
	)

Reads the current tick count for a specific channel (32-bit).

Parameters

driver	Pointer to the Timer driver instance.
ch	Channel index.
ticks	[out] Pointer to store the tick count.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_get_ticks_u64()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_get_ticks_u64	(	cfn_hal_timer_t *	driver,
		uint32_t	ch,
		uint64_t *	ticks
	)

Reads the current tick count for a specific channel (64-bit).

Parameters

driver	Pointer to the Timer driver instance.
ch	Channel index.
ticks	[out] Pointer to store the tick count.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_init

(

cfn_hal_timer_t *

driver

)

Initializes the Timer driver.

Parameters

driver

Pointer to the Timer driver instance.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_populate()

CFN_HAL_INLINE void cfn_hal_timer_populate	(	cfn_hal_timer_t *	driver,
		uint32_t	peripheral_id,
		struct cfn_hal_clock_s *	clock,
		void *	dependency,
		const cfn_hal_timer_api_t *	api,
		const cfn_hal_timer_phy_t *	phy,
		const cfn_hal_timer_config_t *	config,
		cfn_hal_timer_callback_t	callback,
		void *	user_arg
	)

cfn_hal_timer_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_power_state_set	(	cfn_hal_timer_t *	driver,
		cfn_hal_power_state_t	state
	)

Sets the Timer power state.

Parameters

driver	Pointer to the Timer driver instance.
state	Target power state.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_set_period()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_set_period	(	cfn_hal_timer_t *	driver,
		const cfn_hal_timer_period_t *	period
	)

Updates the timer period/reload value for a specific channel.

Parameters

driver	Pointer to the Timer driver instance.
period	Pointer to the structure defining channel and new tick value.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_start()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_start

(

cfn_hal_timer_t *

driver

)

Starts the timer counter.

Parameters

driver

Pointer to the Timer driver instance.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_timer_stop()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_timer_stop

(

cfn_hal_timer_t *

driver

)

Stops the timer counter.

Parameters

driver

Pointer to the Timer driver instance.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK

(

struct cfn_hal_timer_api_s

)