no-OS
Functions
admv8818.c File Reference

Implementation of admv8818 Driver. More...

#include <malloc.h>
#include "admv8818.h"
#include "no_os_error.h"
Include dependency graph for admv8818.c:

Functions

int admv8818_spi_write (struct admv8818_dev *dev, uint8_t reg_addr, uint8_t data)
 Writes data to ADMV8818 over SPI. More...
 
int admv8818_spi_read (struct admv8818_dev *dev, uint8_t reg_addr, uint8_t *data)
 Reads data from ADMV8818 over SPI. More...
 
int admv8818_spi_update_bits (struct admv8818_dev *dev, uint8_t reg_addr, uint8_t mask, uint8_t data)
 Update ADMV8818 register. More...
 
int admv8818_hpf_select (struct admv8818_dev *dev, unsigned long long freq)
 Set the HPF Frequency. More...
 
int admv8818_read_hpf_freq (struct admv8818_dev *dev, unsigned long long *freq)
 Get the HPF Frequency. More...
 
int admv8818_lpf_select (struct admv8818_dev *dev, unsigned long long freq)
 Set the LPF Frequency. More...
 
int admv8818_read_lpf_freq (struct admv8818_dev *dev, unsigned long long *freq)
 Get the HPF Frequency. More...
 
int admv8818_rfin_select (struct admv8818_dev *dev)
 Set the RF Input Band Select. More...
 
int admv8818_init (struct admv8818_dev **device, struct admv8818_init_param *init_param)
 Initializes the admv8818. More...
 
int admv8818_remove (struct admv8818_dev *dev)
 ADMV8818 Resources Deallocation. More...
 

Detailed Description

Implementation of admv8818 Driver.

Author
Antoniu Miclaus (anton.nosp@m.iu.m.nosp@m.iclau.nosp@m.s@an.nosp@m.alog..nosp@m.com)

Copyright 2022(c) Analog Devices, Inc.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Function Documentation

◆ admv8818_hpf_select()

int admv8818_hpf_select ( struct admv8818_dev dev,
unsigned long long  freq 
)

Set the HPF Frequency.

Parameters
dev- The device structure.
freq- The HPF Frequency to be set.
Returns
Returns 0 in case of success or negative error code.
Here is the caller graph for this function:

◆ admv8818_init()

int admv8818_init ( struct admv8818_dev **  device,
struct admv8818_init_param init_param 
)

Initializes the admv8818.

Parameters
device- The device structure.
init_param- The structure containing the device initial parameters.
Returns
Returns 0 in case of success or negative error code.

◆ admv8818_lpf_select()

int admv8818_lpf_select ( struct admv8818_dev dev,
unsigned long long  freq 
)

Set the LPF Frequency.

Parameters
dev- The device structure.
freq- The LPF Frequency to be set.
Returns
Returns 0 in case of success or negative error code.
Here is the caller graph for this function:

◆ admv8818_read_hpf_freq()

int admv8818_read_hpf_freq ( struct admv8818_dev dev,
unsigned long long *  freq 
)

Get the HPF Frequency.

Parameters
dev- The device structure.
freq- The HPF Frequency.
Returns
Returns 0 in case of success or negative error code.

◆ admv8818_read_lpf_freq()

int admv8818_read_lpf_freq ( struct admv8818_dev dev,
unsigned long long *  freq 
)

Get the HPF Frequency.

Parameters
dev- The device structure.
freq- The HPF Frequency.
Returns
Returns 0 in case of success or negative error code.

◆ admv8818_remove()

int admv8818_remove ( struct admv8818_dev dev)

ADMV8818 Resources Deallocation.

Parameters
dev- The device structure.
Returns
Returns 0 in case of success or negative error code otherwise.

◆ admv8818_rfin_select()

int admv8818_rfin_select ( struct admv8818_dev dev)

Set the RF Input Band Select.

Parameters
dev- The device structure.
Returns
Returns 0 in case of success or negative error code.
Here is the caller graph for this function:

◆ admv8818_spi_read()

int admv8818_spi_read ( struct admv8818_dev dev,
uint8_t  reg_addr,
uint8_t *  data 
)

Reads data from ADMV8818 over SPI.

Parameters
dev- The device structure.
reg_addr- The register address.
data- Data read from the device.
Returns
Returns 0 in case of success or negative error code otherwise.
Here is the caller graph for this function:

◆ admv8818_spi_update_bits()

int admv8818_spi_update_bits ( struct admv8818_dev dev,
uint8_t  reg_addr,
uint8_t  mask,
uint8_t  data 
)

Update ADMV8818 register.

Parameters
dev- The device structure.
reg_addr- The register address.
mask- Mask for specific register bits to be updated.
data- Data written to the device (requires prior bit shifting).
Returns
Returns 0 in case of success or negative error code otherwise.
Here is the caller graph for this function:

◆ admv8818_spi_write()

int admv8818_spi_write ( struct admv8818_dev dev,
uint8_t  reg_addr,
uint8_t  data 
)

Writes data to ADMV8818 over SPI.

Parameters
dev- The device structure.
reg_addr- The register address.
data- Data value to write.
Returns
Returns 0 in case of success or negative error code otherwise.
Here is the caller graph for this function: