no-OS
Macros | Functions
ad9208_signal_monitor_api.c File Reference

Contains AD9208 APIs for Signal Monitoring Features. More...

#include "ad9208_api.h"
#include "ad9208_reg.h"
#include "api_errors.h"
Include dependency graph for ad9208_signal_monitor_api.c:

Macros

#define FD_THRESHOLD_MAG_DBFS_MAX   0x1FFF
 
#define FD_DWELL_CLK_CYCLES_MAX   0xFFFF
 

Functions

int ad9208_adc_get_overange_status (ad9208_handle_t *h, uint8_t *status)
 Get ADC Over range Status. More...
 
int ad9208_adc_set_fd_thresholds (ad9208_handle_t *h, uint16_t upper_dbfs, uint16_t lower_dbfs, uint16_t dwell_time)
 Configure The Fast Detect Overange Signal Thresholds. More...
 

Detailed Description

Contains AD9208 APIs for Signal Monitoring Features.

Release 1.0.x

Copyright(c) 2017 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

◆ FD_DWELL_CLK_CYCLES_MAX

#define FD_DWELL_CLK_CYCLES_MAX   0xFFFF

◆ FD_THRESHOLD_MAG_DBFS_MAX

#define FD_THRESHOLD_MAG_DBFS_MAX   0x1FFF

Function Documentation

◆ ad9208_adc_get_overange_status()

int ad9208_adc_get_overange_status ( ad9208_handle_t h,
uint8_t *  status 
)

Get ADC Over range Status.

Returns overrange detection at input to the ADC. Clears the overange detection status signal.

Parameters
hPointer to the AD9208 device reference handle.
statusA bit wise representation of the overrange status of each virtual converter. A bit value of 1 represents overange detection. A bit value of 0 indicates no overange detected. For example Status[0] - Overrange Status for Virtual Converter 0 0 - ADC Input in Range 1 - ADC Input overrange Detected. Status[1] - Overrange Status for Virtual Converter 1 0 - ADC Input in Range 1 - ADC Input overrange Detected.
Return values
API_ERROR_OKAPI Completed Successfully
API_ERROR_INVALID_HANDLE_PTRInvalid reference handle.
API_ERROR_INVALID_XFER_PTRSPI Access Failed
API_ERROR_SPI_XFERSPI XFER Function Failed
API_ERROR_INVALID_PARAMInvalid Parameter

◆ ad9208_adc_set_fd_thresholds()

int ad9208_adc_set_fd_thresholds ( ad9208_handle_t h,
uint16_t  upper_dbfs,
uint16_t  lower_dbfs,
uint16_t  dwell_time 
)

Configure The Fast Detect Overange Signal Thresholds.

Configure the parameters, the upper and lower threshold levels and the dwell time, that govern the triggering of the fast overange detection signal.

Parameters
hPointer to the AD9208 device reference handle.
upper_dbfsA 13 bit value representing the Upper magnitude threshold level in DBFS.
lower_dbfsA 13 bit value representing the lower magnitude threshold level in DBFS.
dwell_timeA 13 bit value representing the Upper magnitude threshold level in DBFS.
Return values
API_ERROR_OKAPI Completed Successfully
API_ERROR_INVALID_HANDLE_PTRInvalid reference handle.
API_ERROR_INVALID_XFER_PTRSPI Access Failed
API_ERROR_SPI_XFERSPI XFER Function Failed
API_ERROR_INVALID_PARAMInvalid Parameter