iio_app.h File Reference

Header file of iio_app. More...

#include "iio.h"
#include "no_os_irq.h"
#include "no_os_uart.h"
#include "no_os_error.h"
#include "no_os_delay.h"

Include dependency graph for iio_app.h:

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

Go to the source code of this file.

Classes
struct	iio_data_buffer
struct	iio_app_device
struct	iio_app_desc
	IIO application descriptor. More...
struct	iio_app_init_param
	IIO application descriptor initialization parameters. More...

Macros
#define	IIO_APP_DEVICE(_name, _dev, _dev_descriptor, _read_buff, _write_buff, _default_trigger_id)
#define	IIO_APP_TRIGGER(_name, _trig, _trig_descriptor)

Functions
int	iio_app_init (struct iio_app_desc **app, struct iio_app_init_param app_init_param)
int	iio_app_run (struct iio_app_desc *app)
int	iio_app_remove (struct iio_app_desc *app)

Detailed Description

Header file of iio_app.

Author

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.

Macro Definition Documentation

IIO_APP_DEVICE

#define IIO_APP_DEVICE	(		_name,
			_dev,
			_dev_descriptor,
			_read_buff,
			_write_buff,
			_default_trigger_id
	)

Value:

    {\
    .name = _name,\
    .dev = _dev,\
    .dev_descriptor = _dev_descriptor,\
    .read_buff = _read_buff,\
    .write_buff = _write_buff,\
    .default_trigger_id = _default_trigger_id\
}

IIO_APP_TRIGGER

#define IIO_APP_TRIGGER	(		_name,
			_trig,
			_trig_descriptor
	)

Value:

    {\
    .name = _name,\
    .trig = _trig,\
    .descriptor = _trig_descriptor,\
}

Function Documentation

iio_app_init()

int iio_app_init	(	struct iio_app_desc **	app,
		struct iio_app_init_param	app_init_param
	)

Register devices for an IIO application

Here is the caller graph for this function:

iio_app_remove()

int iio_app_remove

(

struct iio_app_desc *

app

)

Remove resources allocated by the IIO application

Here is the caller graph for this function:

iio_app_run()

int iio_app_run

(

struct iio_app_desc *

app

)

Start an IIO application

Here is the caller graph for this function: