iio.h File Reference

Header file of iio. More...

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

Include dependency graph for iio.h:

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.
int	iio_remove (struct iio_desc *desc)
	Free the resources allocated by "iio_init()".
int	iio_step (struct iio_desc *desc)
	Execute an iio step.
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).
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.

SPDX-License-Identifier: BSD-3-Clause

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 )

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 )

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 )

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.

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.

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.