ad7980.h File Reference

Header file of AD7980 Driver. More...

#include <stdint.h>
#include "no_os_gpio.h"
#include "no_os_spi.h"

Include dependency graph for ad7980.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	ad7980_dev
struct	ad7980_init_param

Macros
#define	AD7980_CS_LOW
#define	AD7980_CS_HIGH

Functions
int8_t	ad7980_init (struct ad7980_dev **device, struct ad7980_init_param init_param)
	Initializes the communication peripheral. More...
int32_t	ad7980_remove (struct ad7980_dev *dev)
	Free the resources allocated by ad7980_init(). More...
uint16_t	ad7980_conversion (struct ad7980_dev *dev)
	Initiates conversion and reads data. More...
float	ad7980_convert_to_volts (uint16_t raw_sample, float v_ref)
	Converts a 16-bit raw sample to volts. More...

Detailed Description

Header file of AD7980 Driver.

Author

Bancisor Mihai(Banci.nosp@m.sor..nosp@m.Mihai.nosp@m.@ana.nosp@m.log.c.nosp@m.om)

Copyright 2012(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:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
• The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
• Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.

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.

Macro Definition Documentation

AD7980_CS_HIGH

#define AD7980_CS_HIGH

Value:

                    no_os_gpio_set_value(dev->gpio_cs,  \
                    NO_OS_GPIO_HIGH)

AD7980_CS_LOW

#define AD7980_CS_LOW

Value:

                    no_os_gpio_set_value(dev->gpio_cs,  \
                    NO_OS_GPIO_LOW)

Function Documentation

ad7980_conversion()

uint16_t ad7980_conversion

(

struct ad7980_dev *

dev

)

Initiates conversion and reads data.

Initiates conversion and reads data.

Parameters

dev	- The device structure.

Returns

receivedData - Data read from the ADC.

ad7980_convert_to_volts()

float ad7980_convert_to_volts	(	uint16_t	raw_sample,
		float	v_ref
	)

Converts a 16-bit raw sample to volts.

Converts a 16-bit raw sample to volts.

Parameters

raw_sample	- 16-bit data sample.
v_ref	- The value of the voltage reference used by the device.

Returns

voltage - The result of the conversion expressed as volts.

ad7980_init()

int8_t ad7980_init	(	struct ad7980_dev **	device,
		struct ad7980_init_param	init_param
	)

Initializes the communication peripheral.

Initializes the communication peripheral.

Parameters

device	- The device structure.
init_param	- The structure that contains the device initial parameters.

Returns

status - Initialization status. Example: -1 - Initialization failed; 0 - Initialization succeeded.

ad7980_remove()

int32_t ad7980_remove

(

struct ad7980_dev *

dev

)

Free the resources allocated by ad7980_init().

Free the resources allocated by ad7980_init().

Parameters

dev	- The device structure.

Returns

0 in case of success, negative error code otherwise.