precision-converters-firmware
Loading...
Searching...
No Matches
Macros | Functions
ad717x_support.h File Reference

Header for AD717X support configurations. More...

#include "ad717x.h"
#include "no_os_util.h"
Include dependency graph for ad717x_support.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define AD717X_FILT_CONF_REG_ENHFILT_MSK   NO_OS_GENMASK(10,8)
 

Functions

int32_t ad717x_write_filter_order (ad717x_dev *device, enum ad717x_order filter_order, uint8_t setup_id)
 Write filter order to FILTCON register.
 
int32_t ad717x_write_post_filter (ad717x_dev *device, bool enable, enum ad717x_enhfilt post_filter, uint8_t setup_id)
 Write post filter (enhanced filter) settings to FILTCON register.
 
int32_t ad717x_enable_cont_read (ad717x_dev *device, bool cont_read_en)
 Enable/Disable continuous read mode.
 
int32_t ad717x_adc_read_converted_sample (uint32_t *adc_data)
 Read ADC raw data for recently sampled channel.
 

Detailed Description

Header for AD717X support configurations.

Copyright (c) 2022, 2026 Analog Devices, Inc.

All rights reserved.

This software is proprietary to Analog Devices, Inc. and its licensors. By using this software you agree to the terms of the associated Analog Devices Software License Agreement.

Macro Definition Documentation

◆ AD717X_FILT_CONF_REG_ENHFILT_MSK

#define AD717X_FILT_CONF_REG_ENHFILT_MSK   NO_OS_GENMASK(10,8)

Function Documentation

◆ ad717x_adc_read_converted_sample()

int32_t ad717x_adc_read_converted_sample ( uint32_t *  adc_data)

Read ADC raw data for recently sampled channel.

Parameters
adc_data[out]- Pointer to adc data read variable
Returns
0 in case of success, negative error code otherwise
Note
This function is intended to call from the conversion end trigger event. Therefore, this function should just read raw ADC data without further monitoring conversion end event
Here is the caller graph for this function:

◆ ad717x_enable_cont_read()

int32_t ad717x_enable_cont_read ( ad717x_dev *  device,
bool  cont_read_en 
)

Enable/Disable continuous read mode.

Parameters
device[in]- The AD717x Device descriptor
cont_read_en[in]- True in case of enable CONT_READ/ False in case of disable
Returns
0 in case of success, negative error code otherwise
Here is the caller graph for this function:

◆ ad717x_write_filter_order()

int32_t ad717x_write_filter_order ( ad717x_dev *  device,
enum ad717x_order  filter_order,
uint8_t  setup_id 
)

Write filter order to FILTCON register.

Parameters
device[in]- AD717x device instance
filter_order[in]- Filter order (sinc5_sinc1 or sinc3)
setup_id[in]- Setup ID (0-7)
Returns
0 in case of success, negative error code otherwise
Here is the caller graph for this function:

◆ ad717x_write_post_filter()

int32_t ad717x_write_post_filter ( ad717x_dev *  device,
bool  enable,
enum ad717x_enhfilt  post_filter,
uint8_t  setup_id 
)

Write post filter (enhanced filter) settings to FILTCON register.

Parameters
device[in]- AD717x device instance
enable[in]- Enable post filter
post_filter[in]- Post filter type
setup_id[in]- Setup ID (0-7)
Returns
0 in case of success, negative error code otherwise
Here is the caller graph for this function: