cfn_hal_irq.h File Reference

Generic Interrupt Controller 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_irq_config_t
	IRQ configuration structure. More...
struct	cfn_hal_irq_phy_t
	IRQ hardware physical mapping. More...
struct	cfn_hal_irq_api_s
	IRQ Virtual Method Table (VMT). More...

Typedefs
typedef struct cfn_hal_irq_s	cfn_hal_irq_t
typedef struct cfn_hal_irq_api_s	cfn_hal_irq_api_t
typedef void(*	cfn_hal_irq_callback_t) (cfn_hal_irq_t *driver, uint32_t event_mask, uint32_t error_mask, void *user_arg)
	IRQ callback signature.

Enumerations
enum	cfn_hal_irq_event_t { CFN_HAL_IRQ_EVENT_NONE = 0 }
	IRQ nominal event flags. More...
enum	cfn_hal_irq_error_t { CFN_HAL_IRQ_ERROR_NONE = 0 , CFN_HAL_IRQ_ERROR_GENERAL = CFN_HAL_BIT(0) }
	IRQ exception error flags. More...

Functions
	CFN_HAL_VMT_CHECK (struct cfn_hal_irq_api_s)
	CFN_HAL_CREATE_DRIVER_TYPE (irq, cfn_hal_irq_config_t, cfn_hal_irq_api_t, cfn_hal_irq_phy_t, cfn_hal_irq_callback_t)
CFN_HAL_INLINE void	cfn_hal_irq_populate (cfn_hal_irq_t *driver, uint32_t peripheral_id, struct cfn_hal_clock_s *clock, void *dependency, const cfn_hal_irq_api_t *api, const cfn_hal_irq_phy_t *phy, const cfn_hal_irq_config_t *config, cfn_hal_irq_callback_t callback, void *user_arg)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_config_validate (const cfn_hal_irq_t *driver, const cfn_hal_irq_config_t *config)
	Validates the IRQ configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_init (cfn_hal_irq_t *driver)
	Initializes the IRQ controller driver.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_deinit (cfn_hal_irq_t *driver)
	Deinitializes the IRQ controller driver.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_config_set (cfn_hal_irq_t *driver, const cfn_hal_irq_config_t *config)
	Sets the IRQ configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_config_get (cfn_hal_irq_t *driver, cfn_hal_irq_config_t *config)
	Gets the current IRQ configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_callback_register (cfn_hal_irq_t *driver, const cfn_hal_irq_callback_t callback, void *user_arg)
	Registers a callback for IRQ events and errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_power_state_set (cfn_hal_irq_t *driver, cfn_hal_power_state_t state)
	Sets the IRQ power state.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_event_enable (cfn_hal_irq_t *driver, uint32_t event_mask)
	Enables one or more IRQ nominal events.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_event_disable (cfn_hal_irq_t *driver, uint32_t event_mask)
	Disables one or more IRQ nominal events.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_event_get (cfn_hal_irq_t *driver, uint32_t *event_mask)
	Retrieves the current IRQ nominal event status.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_error_enable (cfn_hal_irq_t *driver, uint32_t error_mask)
	Enables one or more IRQ exception errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_error_disable (cfn_hal_irq_t *driver, uint32_t error_mask)
	Disables one or more IRQ exception errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_error_get (cfn_hal_irq_t *driver, uint32_t *error_mask)
	Retrieves the current IRQ exception error status.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_global_enable (cfn_hal_irq_t *driver)
	Enables interrupts globally at the processor level.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_global_disable (cfn_hal_irq_t *driver)
	Disables interrupts globally at the processor level.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_enable_vector (cfn_hal_irq_t *driver, uint32_t irq_id)
	Enables a specific interrupt vector.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_disable_vector (cfn_hal_irq_t *driver, uint32_t irq_id)
	Disables a specific interrupt vector.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_set_priority (cfn_hal_irq_t *driver, uint32_t irq_id, uint32_t priority)
	Sets the priority level for a specific interrupt vector.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_irq_clear_pending (cfn_hal_irq_t *driver, uint32_t irq_id)
	Clears the pending status of a specific interrupt vector.
cfn_hal_error_code_t	cfn_hal_irq_construct (cfn_hal_irq_t *driver, const cfn_hal_irq_config_t *config, const cfn_hal_irq_phy_t *phy, struct cfn_hal_clock_s *clock, void *dependency, cfn_hal_irq_callback_t callback, void *user_arg)
cfn_hal_error_code_t	cfn_hal_irq_destruct (cfn_hal_irq_t *driver)

Detailed Description

Generic Interrupt Controller 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_irq_api_t

typedef struct cfn_hal_irq_api_s cfn_hal_irq_api_t

cfn_hal_irq_callback_t

typedef void(* cfn_hal_irq_callback_t) (cfn_hal_irq_t *driver, uint32_t event_mask, uint32_t error_mask, void *user_arg)

IRQ callback signature.

Parameters

driver	Pointer to the IRQ driver instance.
event_mask	Mask of triggered nominal events.
error_mask	Mask of triggered exception errors.
user_arg	User-defined argument passed during registration.

cfn_hal_irq_t

typedef struct cfn_hal_irq_s cfn_hal_irq_t

Enumeration Type Documentation

cfn_hal_irq_error_t

enum cfn_hal_irq_error_t

IRQ exception error flags.

Enumerator
CFN_HAL_IRQ_ERROR_NONE
CFN_HAL_IRQ_ERROR_GENERAL	Controller fault or access error

cfn_hal_irq_event_t

enum cfn_hal_irq_event_t

IRQ nominal event flags.

Enumerator
CFN_HAL_IRQ_EVENT_NONE

Function Documentation

CFN_HAL_CREATE_DRIVER_TYPE()

CFN_HAL_CREATE_DRIVER_TYPE	(	irq	,
		cfn_hal_irq_config_t	,
		cfn_hal_irq_api_t	,
		cfn_hal_irq_phy_t	,
		cfn_hal_irq_callback_t
	)

cfn_hal_irq_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_callback_register	(	cfn_hal_irq_t *	driver,
		const cfn_hal_irq_callback_t	callback,
		void *	user_arg
	)

Registers a callback for IRQ events and errors.

Parameters

driver	Pointer to the IRQ 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_irq_clear_pending()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_clear_pending	(	cfn_hal_irq_t *	driver,
		uint32_t	irq_id
	)

Clears the pending status of a specific interrupt vector.

Parameters

driver	Pointer to the IRQ driver instance.
irq_id	Numeric identifier of the target interrupt.

Returns

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

cfn_hal_irq_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_config_get	(	cfn_hal_irq_t *	driver,
		cfn_hal_irq_config_t *	config
	)

Gets the current IRQ configuration.

Parameters

driver	Pointer to the IRQ 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_irq_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_config_set	(	cfn_hal_irq_t *	driver,
		const cfn_hal_irq_config_t *	config
	)

Sets the IRQ configuration.

Parameters

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

Returns

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

cfn_hal_irq_config_validate()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_config_validate	(	const cfn_hal_irq_t *	driver,
		const cfn_hal_irq_config_t *	config
	)

Validates the IRQ configuration.

Parameters

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

Returns

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

cfn_hal_irq_construct()

cfn_hal_error_code_t cfn_hal_irq_construct	(	cfn_hal_irq_t *	driver,
		const cfn_hal_irq_config_t *	config,
		const cfn_hal_irq_phy_t *	phy,
		struct cfn_hal_clock_s *	clock,
		void *	dependency,
		cfn_hal_irq_callback_t	callback,
		void *	user_arg
	)

cfn_hal_irq_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_deinit

(

cfn_hal_irq_t *

driver

)

Deinitializes the IRQ controller driver.

Parameters

driver

Pointer to the IRQ driver instance.

Returns

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

cfn_hal_irq_destruct()

cfn_hal_error_code_t cfn_hal_irq_destruct

(

cfn_hal_irq_t *

driver

)

cfn_hal_irq_disable_vector()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_disable_vector	(	cfn_hal_irq_t *	driver,
		uint32_t	irq_id
	)

Disables a specific interrupt vector.

Parameters

driver	Pointer to the IRQ driver instance.
irq_id	Numeric identifier of the target interrupt.

Returns

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

cfn_hal_irq_enable_vector()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_enable_vector	(	cfn_hal_irq_t *	driver,
		uint32_t	irq_id
	)

Enables a specific interrupt vector.

Parameters

driver	Pointer to the IRQ driver instance.
irq_id	Numeric identifier of the target interrupt.

Returns

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

cfn_hal_irq_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_error_disable	(	cfn_hal_irq_t *	driver,
		uint32_t	error_mask
	)

Disables one or more IRQ exception errors.

Parameters

driver	Pointer to the IRQ 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_irq_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_error_enable	(	cfn_hal_irq_t *	driver,
		uint32_t	error_mask
	)

Enables one or more IRQ exception errors.

Parameters

driver	Pointer to the IRQ 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_irq_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_error_get	(	cfn_hal_irq_t *	driver,
		uint32_t *	error_mask
	)

Retrieves the current IRQ exception error status.

Parameters

driver	Pointer to the IRQ 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_irq_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_event_disable	(	cfn_hal_irq_t *	driver,
		uint32_t	event_mask
	)

Disables one or more IRQ nominal events.

Parameters

driver	Pointer to the IRQ 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_irq_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_event_enable	(	cfn_hal_irq_t *	driver,
		uint32_t	event_mask
	)

Enables one or more IRQ nominal events.

Parameters

driver	Pointer to the IRQ 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_irq_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_event_get	(	cfn_hal_irq_t *	driver,
		uint32_t *	event_mask
	)

Retrieves the current IRQ nominal event status.

Parameters

driver	Pointer to the IRQ 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_irq_global_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_global_disable

(

cfn_hal_irq_t *

driver

)

Disables interrupts globally at the processor level.

Parameters

driver

Pointer to the IRQ driver instance.

Returns

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

cfn_hal_irq_global_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_global_enable

(

cfn_hal_irq_t *

driver

)

Enables interrupts globally at the processor level.

Parameters

driver

Pointer to the IRQ driver instance.

Returns

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

cfn_hal_irq_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_init

(

cfn_hal_irq_t *

driver

)

Initializes the IRQ controller driver.

Parameters

driver

Pointer to the IRQ driver instance.

Returns

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

cfn_hal_irq_populate()

CFN_HAL_INLINE void cfn_hal_irq_populate	(	cfn_hal_irq_t *	driver,
		uint32_t	peripheral_id,
		struct cfn_hal_clock_s *	clock,
		void *	dependency,
		const cfn_hal_irq_api_t *	api,
		const cfn_hal_irq_phy_t *	phy,
		const cfn_hal_irq_config_t *	config,
		cfn_hal_irq_callback_t	callback,
		void *	user_arg
	)

cfn_hal_irq_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_power_state_set	(	cfn_hal_irq_t *	driver,
		cfn_hal_power_state_t	state
	)

Sets the IRQ power state.

Parameters

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

Returns

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

cfn_hal_irq_set_priority()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_irq_set_priority	(	cfn_hal_irq_t *	driver,
		uint32_t	irq_id,
		uint32_t	priority
	)

Sets the priority level for a specific interrupt vector.

Parameters

driver	Pointer to the IRQ driver instance.
irq_id	Numeric identifier of the target interrupt.
priority	Target priority level (architecture dependent).

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_irq_api_s

)