no-OS
Functions
admv1013.c File Reference

Implementation of admv1013 Driver. More...

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

Functions

int admv1013_spi_write (struct admv1013_dev *dev, uint8_t reg_addr, uint16_t data)
 Writes data to ADMV1013 over SPI. More...
 
int admv1013_spi_read (struct admv1013_dev *dev, uint8_t reg_addr, uint16_t *data)
 Reads data from ADMV1013 over SPI. More...
 
int admv1013_spi_update_bits (struct admv1013_dev *dev, uint8_t reg_addr, uint16_t mask, uint16_t data)
 Update ADMV1013 register. More...
 
int admv1013_set_iq_phase (struct admv1013_dev *dev, uint8_t i_phase, uint8_t q_phase)
 Set I/Q Phase Accuracy. More...
 
int admv1013_get_iq_phase (struct admv1013_dev *dev, uint8_t *i_phase, uint8_t *q_phase)
 Get I/Q Phase Accuracy. More...
 
int admv1013_set_iq_offset (struct admv1013_dev *dev, uint8_t i_offset_p, uint8_t i_offset_n, uint8_t q_offset_p, uint8_t q_offset_n)
 Set I/Q Offset Accuracy. More...
 
int admv1013_get_iq_offset (struct admv1013_dev *dev, uint8_t *i_offset_p, uint8_t *i_offset_n, uint8_t *q_offset_p, uint8_t *q_offset_n)
 Get I/Q Offset Accuracy. More...
 
int admv1013_init (struct admv1013_dev **device, struct admv1013_init_param *init_param)
 Initializes the admv1013. More...
 
int admv1013_remove (struct admv1013_dev *dev)
 ADMV1013 Resources Deallocation. More...
 

Detailed Description

Implementation of admv1013 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

◆ admv1013_get_iq_offset()

int admv1013_get_iq_offset ( struct admv1013_dev dev,
uint8_t *  i_offset_p,
uint8_t *  i_offset_n,
uint8_t *  q_offset_p,
uint8_t *  q_offset_n 
)

Get I/Q Offset Accuracy.

Parameters
dev- The device structure.
i_offset_p- The I Data Positive.
i_offset_n- The I Data Negative.
q_offset_p- The Q Data Positive.
q_offset_n- The Q Data Negative.
Returns
Returns 0 in case of success or negative error code.

◆ admv1013_get_iq_phase()

int admv1013_get_iq_phase ( struct admv1013_dev dev,
uint8_t *  i_phase,
uint8_t *  q_phase 
)

Get I/Q Phase Accuracy.

Parameters
dev- The device structure.
i_phase- The I Data.
q_phase- The Q Data.
Returns
Returns 0 in case of success or negative error code.

◆ admv1013_init()

int admv1013_init ( struct admv1013_dev **  device,
struct admv1013_init_param init_param 
)

Initializes the admv1013.

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.

◆ admv1013_remove()

int admv1013_remove ( struct admv1013_dev dev)

ADMV1013 Resources Deallocation.

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

◆ admv1013_set_iq_offset()

int admv1013_set_iq_offset ( struct admv1013_dev dev,
uint8_t  i_offset_p,
uint8_t  i_offset_n,
uint8_t  q_offset_p,
uint8_t  q_offset_n 
)

Set I/Q Offset Accuracy.

Parameters
dev- The device structure.
i_offset_p- The I Data Positive.
i_offset_n- The I Data Negative.
q_offset_p- The Q Data Positive.
q_offset_n- The Q Data Negative.
Returns
Returns 0 in case of success or negative error code.

◆ admv1013_set_iq_phase()

int admv1013_set_iq_phase ( struct admv1013_dev dev,
uint8_t  i_phase,
uint8_t  q_phase 
)

Set I/Q Phase Accuracy.

Parameters
dev- The device structure.
i_phase- The I Data.
q_phase- The Q Data.
Returns
Returns 0 in case of success or negative error code.

◆ admv1013_spi_read()

int admv1013_spi_read ( struct admv1013_dev dev,
uint8_t  reg_addr,
uint16_t *  data 
)

Reads data from ADMV1013 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:

◆ admv1013_spi_update_bits()

int admv1013_spi_update_bits ( struct admv1013_dev dev,
uint8_t  reg_addr,
uint16_t  mask,
uint16_t  data 
)

Update ADMV1013 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:

◆ admv1013_spi_write()

int admv1013_spi_write ( struct admv1013_dev dev,
uint8_t  reg_addr,
uint16_t  data 
)

Writes data to ADMV1013 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: