caffeine-hal 0.6.6
A Header-Defined Interface c library, it provides the hal layer for the Caffeine framework
Loading...
Searching...
No Matches
Data Structures | Typedefs | Enumerations | Functions
cfn_hal_dac.h File Reference

Digital-to-Analog Converter (DAC) HAL API. More...

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

Go to the source code of this file.

Data Structures

struct  cfn_hal_dac_phy_t
 DAC hardware physical mapping. More...
 
struct  cfn_hal_dac_config_t
 DAC configuration structure. More...
 
struct  cfn_hal_dac_api_s
 DAC Virtual Method Table (VMT). More...
 

Typedefs

typedef struct cfn_hal_dac_s cfn_hal_dac_t
 
typedef struct cfn_hal_dac_api_s cfn_hal_dac_api_t
 
typedef void(* cfn_hal_dac_callback_t) (cfn_hal_dac_t *driver, uint32_t event_mask, uint32_t error_mask, void *user_arg)
 DAC callback signature.
 

Enumerations

enum  cfn_hal_dac_event_t { CFN_HAL_DAC_EVENT_NONE = 0 , CFN_HAL_DAC_EVENT_DMA_HALF = CFN_HAL_BIT(0) , CFN_HAL_DAC_EVENT_DMA_COMPLETE = CFN_HAL_BIT(1) }
 DAC nominal event flags. More...
 
enum  cfn_hal_dac_error_t { CFN_HAL_DAC_ERROR_NONE = 0 , CFN_HAL_DAC_ERROR_UNDERRUN = CFN_HAL_BIT(0) , CFN_HAL_DAC_ERROR_GENERAL = CFN_HAL_BIT(1) }
 DAC exception error flags. More...
 
enum  cfn_hal_dac_resolution_t {
  CFN_HAL_DAC_RESOLUTION_BIT_4 = 0 , CFN_HAL_DAC_RESOLUTION_BIT_6 , CFN_HAL_DAC_RESOLUTION_BIT_8 , CFN_HAL_DAC_RESOLUTION_BIT_10 ,
  CFN_HAL_DAC_RESOLUTION_BIT_12 , CFN_HAL_DAC_RESOLUTION_BIT_14 , CFN_HAL_DAC_RESOLUTION_BIT_16 , CFN_HAL_DAC_RESOLUTION_BIT_24 ,
  CFN_HAL_DAC_RESOLUTION_BIT_MAX
}
 
enum  cfn_hal_dac_align_t { CFN_HAL_DAC_ALIGN_RIGHT = 0 , CFN_HAL_DAC_ALIGN_LEFT , CFN_HAL_DAC_ALIGN_MAX }
 

Functions

 CFN_HAL_VMT_CHECK (struct cfn_hal_dac_api_s)
 
 CFN_HAL_CREATE_DRIVER_TYPE (dac, cfn_hal_dac_config_t, cfn_hal_dac_api_t, cfn_hal_dac_phy_t, cfn_hal_dac_callback_t)
 
CFN_HAL_INLINE void cfn_hal_dac_populate (cfn_hal_dac_t *driver, uint32_t peripheral_id, struct cfn_hal_clock_s *clock, void *dependency, const cfn_hal_dac_api_t *api, const cfn_hal_dac_phy_t *phy, const cfn_hal_dac_config_t *config, cfn_hal_dac_callback_t callback, void *user_arg)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_config_validate (const cfn_hal_dac_t *driver, const cfn_hal_dac_config_t *config)
 Validates the DAC configuration.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_init (cfn_hal_dac_t *driver)
 Initializes the DAC driver.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_deinit (cfn_hal_dac_t *driver)
 Deinitializes the DAC driver.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_config_set (cfn_hal_dac_t *driver, const cfn_hal_dac_config_t *config)
 Sets the DAC configuration.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_config_get (cfn_hal_dac_t *driver, cfn_hal_dac_config_t *config)
 Gets the current DAC configuration.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_callback_register (cfn_hal_dac_t *driver, const cfn_hal_dac_callback_t callback, void *user_arg)
 Registers a callback for DAC events and errors.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_power_state_set (cfn_hal_dac_t *driver, cfn_hal_power_state_t state)
 Sets the DAC power state.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_event_enable (cfn_hal_dac_t *driver, uint32_t event_mask)
 Enables one or more DAC nominal events.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_event_disable (cfn_hal_dac_t *driver, uint32_t event_mask)
 Disables one or more DAC nominal events.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_event_get (cfn_hal_dac_t *driver, uint32_t *event_mask)
 Retrieves the current DAC nominal event status.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_error_enable (cfn_hal_dac_t *driver, uint32_t error_mask)
 Enables one or more DAC exception errors.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_error_disable (cfn_hal_dac_t *driver, uint32_t error_mask)
 Disables one or more DAC exception errors.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_error_get (cfn_hal_dac_t *driver, uint32_t *error_mask)
 Retrieves the current DAC exception error status.
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_set_value (cfn_hal_dac_t *driver, uint32_t value, uint32_t timeout)
 Sets the analog output value (blocking).
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_start (cfn_hal_dac_t *driver)
 Starts DAC conversion (e.g., enables output).
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_stop (cfn_hal_dac_t *driver)
 Stops DAC conversion (e.g., disables output).
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_write_dma (cfn_hal_dac_t *driver, const uint32_t *data, size_t nbr_of_samples)
 Starts continuous DAC output using DMA.
 
cfn_hal_error_code_t cfn_hal_dac_construct (cfn_hal_dac_t *driver, const cfn_hal_dac_config_t *config, const cfn_hal_dac_phy_t *phy, struct cfn_hal_clock_s *clock, void *dependency, cfn_hal_dac_callback_t callback, void *user_arg)
 
cfn_hal_error_code_t cfn_hal_dac_destruct (cfn_hal_dac_t *driver)
 

Detailed Description

Digital-to-Analog Converter (DAC) 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_dac_api_t

◆ cfn_hal_dac_callback_t

typedef void(* cfn_hal_dac_callback_t) (cfn_hal_dac_t *driver, uint32_t event_mask, uint32_t error_mask, void *user_arg)

DAC callback signature.

Parameters
driverPointer to the DAC driver instance.
event_maskMask of triggered nominal events.
error_maskMask of triggered exception errors.
user_argUser-defined argument passed during registration.

◆ cfn_hal_dac_t

typedef struct cfn_hal_dac_s cfn_hal_dac_t

Enumeration Type Documentation

◆ cfn_hal_dac_align_t

Enumerator
CFN_HAL_DAC_ALIGN_RIGHT 
CFN_HAL_DAC_ALIGN_LEFT 
CFN_HAL_DAC_ALIGN_MAX 

◆ cfn_hal_dac_error_t

DAC exception error flags.

Enumerator
CFN_HAL_DAC_ERROR_NONE 
CFN_HAL_DAC_ERROR_UNDERRUN 

Output buffer underrun

CFN_HAL_DAC_ERROR_GENERAL 

General hardware error

◆ cfn_hal_dac_event_t

DAC nominal event flags.

Enumerator
CFN_HAL_DAC_EVENT_NONE 
CFN_HAL_DAC_EVENT_DMA_HALF 

DMA half transfer complete

CFN_HAL_DAC_EVENT_DMA_COMPLETE 

DMA transfer complete

◆ cfn_hal_dac_resolution_t

Enumerator
CFN_HAL_DAC_RESOLUTION_BIT_4 
CFN_HAL_DAC_RESOLUTION_BIT_6 
CFN_HAL_DAC_RESOLUTION_BIT_8 
CFN_HAL_DAC_RESOLUTION_BIT_10 
CFN_HAL_DAC_RESOLUTION_BIT_12 
CFN_HAL_DAC_RESOLUTION_BIT_14 
CFN_HAL_DAC_RESOLUTION_BIT_16 
CFN_HAL_DAC_RESOLUTION_BIT_24 
CFN_HAL_DAC_RESOLUTION_BIT_MAX 

Function Documentation

◆ CFN_HAL_CREATE_DRIVER_TYPE()

CFN_HAL_CREATE_DRIVER_TYPE ( dac  ,
cfn_hal_dac_config_t  ,
cfn_hal_dac_api_t  ,
cfn_hal_dac_phy_t  ,
cfn_hal_dac_callback_t   
)

◆ cfn_hal_dac_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_callback_register ( cfn_hal_dac_t driver,
const cfn_hal_dac_callback_t  callback,
void *  user_arg 
)

Registers a callback for DAC events and errors.

Parameters
driverPointer to the DAC driver instance.
callbackThe callback function to register.
user_argUser-defined argument passed to the callback.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_dac_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_config_get ( cfn_hal_dac_t driver,
cfn_hal_dac_config_t config 
)

Gets the current DAC configuration.

Parameters
driverPointer to the DAC 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_dac_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_config_set ( cfn_hal_dac_t driver,
const cfn_hal_dac_config_t config 
)

Sets the DAC configuration.

Parameters
driverPointer to the DAC driver instance.
configPointer to the configuration structure.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_dac_config_validate()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_config_validate ( const cfn_hal_dac_t driver,
const cfn_hal_dac_config_t config 
)

Validates the DAC configuration.

Parameters
driverPointer to the DAC driver instance.
configPointer to the configuration structure.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_dac_construct()

cfn_hal_error_code_t cfn_hal_dac_construct ( cfn_hal_dac_t driver,
const cfn_hal_dac_config_t config,
const cfn_hal_dac_phy_t phy,
struct cfn_hal_clock_s *  clock,
void *  dependency,
cfn_hal_dac_callback_t  callback,
void *  user_arg 
)

◆ cfn_hal_dac_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_deinit ( cfn_hal_dac_t driver)

Deinitializes the DAC driver.

Parameters
driverPointer to the DAC driver instance.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_dac_destruct()

cfn_hal_error_code_t cfn_hal_dac_destruct ( cfn_hal_dac_t driver)

◆ cfn_hal_dac_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_error_disable ( cfn_hal_dac_t driver,
uint32_t  error_mask 
)

Disables one or more DAC exception errors.

Parameters
driverPointer to the DAC driver instance.
error_maskMask of errors to disable.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_dac_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_error_enable ( cfn_hal_dac_t driver,
uint32_t  error_mask 
)

Enables one or more DAC exception errors.

Parameters
driverPointer to the DAC driver instance.
error_maskMask of errors to enable.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_dac_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_error_get ( cfn_hal_dac_t driver,
uint32_t *  error_mask 
)

Retrieves the current DAC exception error status.

Parameters
driverPointer to the DAC 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_dac_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_event_disable ( cfn_hal_dac_t driver,
uint32_t  event_mask 
)

Disables one or more DAC nominal events.

Parameters
driverPointer to the DAC driver instance.
event_maskMask of events to disable.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_dac_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_event_enable ( cfn_hal_dac_t driver,
uint32_t  event_mask 
)

Enables one or more DAC nominal events.

Parameters
driverPointer to the DAC driver instance.
event_maskMask of events to enable.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_dac_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_event_get ( cfn_hal_dac_t driver,
uint32_t *  event_mask 
)

Retrieves the current DAC nominal event status.

Parameters
driverPointer to the DAC 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_dac_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_init ( cfn_hal_dac_t driver)

Initializes the DAC driver.

Parameters
driverPointer to the DAC driver instance.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_dac_populate()

CFN_HAL_INLINE void cfn_hal_dac_populate ( cfn_hal_dac_t driver,
uint32_t  peripheral_id,
struct cfn_hal_clock_s *  clock,
void *  dependency,
const cfn_hal_dac_api_t api,
const cfn_hal_dac_phy_t phy,
const cfn_hal_dac_config_t config,
cfn_hal_dac_callback_t  callback,
void *  user_arg 
)

◆ cfn_hal_dac_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_power_state_set ( cfn_hal_dac_t driver,
cfn_hal_power_state_t  state 
)

Sets the DAC power state.

Parameters
driverPointer to the DAC driver instance.
stateTarget power state.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_dac_set_value()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_set_value ( cfn_hal_dac_t driver,
uint32_t  value,
uint32_t  timeout 
)

Sets the analog output value (blocking).

Parameters
driverPointer to the DAC driver instance.
valueThe raw digital value to convert.
timeoutMaximum time to wait for completion in milliseconds.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_dac_start()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_start ( cfn_hal_dac_t driver)

Starts DAC conversion (e.g., enables output).

Parameters
driverPointer to the DAC driver instance.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_dac_stop()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_stop ( cfn_hal_dac_t driver)

Stops DAC conversion (e.g., disables output).

Parameters
driverPointer to the DAC driver instance.
Returns
CFN_HAL_ERROR_OK on success, or a specific error code on failure.

◆ cfn_hal_dac_write_dma()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_dac_write_dma ( cfn_hal_dac_t driver,
const uint32_t *  data,
size_t  nbr_of_samples 
)

Starts continuous DAC output using DMA.

Parameters
driverPointer to the DAC driver instance.
dataPointer to the buffer containing samples to write.
nbr_of_samplesNumber of samples to output.
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_dac_api_s  )