iio.h File Reference

Header file of iio. More...

#include "iio_types.h"
#include "no_os_uart.h"

Include dependency graph for iio.h:

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

Go to the source code of this file.

Classes
struct	iio_device_init
struct	iio_trigger_init
struct	iio_ctx_attr
	Structure holding the context attribute members. More...
struct	iio_local_backend
	Structure holding the local backend init parameters. More...
struct	iio_init_param

Enumerations
enum	physical_link_type {   USE_UART,   USE_LOCAL_BACKEND,   USE_NETWORK }

Functions
int	iio_init (struct iio_desc **desc, struct iio_init_param *init_param)
	Set communication ops and read/write ops. More...
int	iio_remove (struct iio_desc *desc)
	Free the resources allocated by "iio_init()". More...
int	iio_step (struct iio_desc *desc)
	Execute an iio step. More...
int	iio_process_trigger_type (struct iio_desc *desc, char *trigger_name)
	Searches for trigger name and processes the trigger based on its type (sync or async with the interrupt). More...
int32_t	iio_parse_value (char *buf, enum iio_val fmt, int32_t *val, int32_t *val2)
int	iio_format_value (char *buf, uint32_t len, enum iio_val fmt, int32_t size, int32_t *vals)
int	iio_buffer_get_block (struct iio_buffer *buffer, void **addr)
int	iio_buffer_block_done (struct iio_buffer *buffer)
int	iio_buffer_push_scan (struct iio_buffer *buffer, void *data)
int	iio_buffer_pop_scan (struct iio_buffer *buffer, void *data)

Detailed Description

Header file of iio.

Author

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

Mihail Chindris (mihai.nosp@m.l.ch.nosp@m.indri.nosp@m.s@an.nosp@m.alog..nosp@m.com)

Copyright 2013(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.

Enumeration Type Documentation

physical_link_type

enum physical_link_type

Enumerator
USE_UART
USE_LOCAL_BACKEND
USE_NETWORK

Function Documentation

iio_buffer_block_done()

int iio_buffer_block_done

(

struct iio_buffer *

buffer

)

iio_buffer_get_block()

int iio_buffer_get_block	(	struct iio_buffer *	buffer,
		void **	addr
	)

iio_buffer_pop_scan()

int iio_buffer_pop_scan	(	struct iio_buffer *	buffer,
		void *	data
	)

Here is the caller graph for this function:

iio_buffer_push_scan()

int iio_buffer_push_scan	(	struct iio_buffer *	buffer,
		void *	data
	)

iio_format_value()

int iio_format_value	(	char *	buf,
		uint32_t	len,
		enum iio_val	fmt,
		int32_t	size,
		int32_t *	vals
	)

Here is the caller graph for this function:

iio_init()

int iio_init	(	struct iio_desc **	desc,
		struct iio_init_param *	init_param
	)

Set communication ops and read/write ops.

Parameters

desc	- iio descriptor.
init_param	- appropriate init param.

Returns

0 in case of success or negative value otherwise.

iio_parse_value()

int32_t iio_parse_value	(	char *	buf,
		enum iio_val	fmt,
		int32_t *	val,
		int32_t *	val2
	)

Here is the caller graph for this function:

iio_process_trigger_type()

int iio_process_trigger_type	(	struct iio_desc *	desc,
		char *	trigger_name
	)

Searches for trigger name and processes the trigger based on its type (sync or async with the interrupt).

Parameters

desc	- IIO descriptor.
trigger_name	- Trigger name.

Returns

ret - Result of the processing procedure.

Here is the caller graph for this function:

iio_remove()

int iio_remove

(

struct iio_desc *

desc

)

Free the resources allocated by "iio_init()".

Parameters

desc	iio descriptor.

Returns

0 in case of success or negative value otherwise.

Here is the caller graph for this function:

iio_step()

int iio_step

(

struct iio_desc *

desc

)

Execute an iio step.

Parameters

desc	- IIo descriptor

Returns

0 in case of success or negative value otherwise.