no-OS
Classes | Functions
ad9083.h File Reference

Header file of ad9083 Driver. More...

#include "no_os_gpio.h"
#include "no_os_spi.h"
#include "adi_ad9083.h"
Include dependency graph for ad9083.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  ad9083_init_param
 Structure holding the parameters for ad9083 initialization. More...
 
struct  ad9083_phy
 Structure holding ad9083 descriptor. More...
 

Functions

int32_t ad9083_init (struct ad9083_phy **device, struct ad9083_init_param *init_param)
 
int32_t ad9083_remove (struct ad9083_phy *device)
 Free the resources allocated by ad9083_init(). More...
 
int32_t ad9083_reg_get (struct ad9083_phy *device, uint32_t reg, uint8_t *readval)
 Read register. More...
 
int32_t ad9083_reg_set (struct ad9083_phy *device, uint32_t reg, uint8_t writeval)
 Write register. More...
 

Detailed Description

Header file of ad9083 Driver.

Author
Cristian Pop (crist.nosp@m.ian..nosp@m.pop@a.nosp@m.nalo.nosp@m.g.com)

Copyright 2021(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

◆ ad9083_init()

int32_t ad9083_init ( struct ad9083_phy **  device,
struct ad9083_init_param init_param 
)

Initialize the device.

Parameters
device- The device structure.
init_param- The structure that contains the device initial parameters.
Returns
0 in case of success, negative error code otherwise.
Here is the caller graph for this function:

◆ ad9083_reg_get()

int32_t ad9083_reg_get ( struct ad9083_phy device,
uint32_t  reg,
uint8_t *  readval 
)

Read register.

Parameters
device- ad9083 device.
reg- Address of the register.
readval- Value of the register.
Returns
0 in case of success, -1 otherwise.
Here is the caller graph for this function:

◆ ad9083_reg_set()

int32_t ad9083_reg_set ( struct ad9083_phy device,
uint32_t  reg,
uint8_t  writeval 
)

Write register.

Parameters
device- ad9083 device.
reg- Address of the register.
writeval- Value of the register.
Returns
0 in case of success, -1 otherwise.

◆ ad9083_remove()

int32_t ad9083_remove ( struct ad9083_phy dev)

Free the resources allocated by ad9083_init().

Parameters
dev- Device descriptor.
Returns
0 in case of success, -1 otherwise.