mraa/api/mraa/iio.h

/*
 * Author: Brendan Le Foll <brendan.le.foll@intel.com>
 * Copyright (c) 2015 Intel Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#pragma once

#include "common.h"
#include "iio_kernel_headers.h"

/** Mraa Iio Channels */
typedef struct {
    /** Channel index */
    int index;
    /** Channel enabled/disabled */
    int enabled;
    /** Channel type */
    char* type;
    /** Channel endianes */
    mraa_boolean_t lendian;
    /** Channel signed */
    int signedd;
    /** Channel offset */
    unsigned int offset;
    /** Channel mask */
    uint64_t mask;
    /** Channel used bits */
    unsigned int bits_used;
    /** Channel bytes */
    unsigned int bytes;
    /** Channel shift */
    unsigned int shift;
    /** Channel location */
    unsigned int location;
} mraa_iio_channel;

/** Mraa Iio Event */
typedef struct {
    /** Event name */
    char* name;
    /** Event enabled/disabled */
    int enabled;
} mraa_iio_event;

/**
 * @file
 * @brief iio
 *
 * An iio context represents an IIO device
 *
 * @snippet iio.c Interesting
 */

#ifdef __cplusplus
extern "C" {
#endif

#include <stdlib.h>
#include <stdio.h>
#include <fcntl.h>
#include <stdint.h>

#include "common.h"

/**
 * Opaque pointer definition to the internal struct _iio
 */
typedef struct _iio* mraa_iio_context;

/**
 * Initialise iio context
 *
 * @param device iio device to use
 * @return i2c context or NULL
 */
mraa_iio_context mraa_iio_init(int device);

/**
 * Trigger buffer
 *
 * @param dev The iio context
 * @param fptr Callback
 * @param args Arguments
 * @return Result of operation
 */
mraa_result_t mraa_iio_trigger_buffer(mraa_iio_context dev, void (*fptr)(char*, void*), void* args);

/**
 * Get device name
 *
 * @param dev The iio context
 * @return Name of the device
 */
const char* mraa_iio_get_device_name(mraa_iio_context dev);

/**
 * Get device number
 *
 * @param name Name of the device
 * @return Device Number
 */
int mraa_iio_get_device_num_by_name(const char* name);

/**
 * Read size
 *
 * @param dev The iio context
 * @return Size
 */
int mraa_iio_read_size(mraa_iio_context dev);

/**
 * Get channels
 *
 * @param dev The iio context
 * @return Channels
 */
mraa_iio_channel* mraa_iio_get_channels(mraa_iio_context dev);

/**
 * Get channels count
 *
 * @param dev The iio context
 * @return Channels count
 */
int mraa_iio_get_channel_count(mraa_iio_context dev);

/**
 * Read float from file
 *
 * @param dev The iio context
 * @param filename Filename
 * @param data Data
 * @return Result of operation
 */
mraa_result_t mraa_iio_read_float(mraa_iio_context dev, const char* filename, float* data);

/**
 * Read int from file
 *
 * @param dev The iio context
 * @param filename Filename
 * @param data Data
 * @return Result of operation
 */
mraa_result_t mraa_iio_read_int(mraa_iio_context dev, const char* filename, int* data);

/**
 * Read String from file
 *
 * @param dev The iio context
 * @param filename Filename
 * @param data Data
 * @param max_len Max lenght to read
 * @return Result of operation
 */
mraa_result_t mraa_iio_read_string(mraa_iio_context dev, const char* filename, char* data, int max_len);

/**
 * Write float
 *
 * @param dev The iio context
 * @param attr_chan Channel attributes
 * @param data Float to write
 * @return Result of operation
 */
mraa_result_t mraa_iio_write_float(mraa_iio_context dev, const char* attr_chan, const float data);

/**
 * Write int
 *
 * @param dev The iio context
 * @param attr_chan Channel attributes
 * @param data Int to write
 * @return Result of operation
 */
mraa_result_t mraa_iio_write_int(mraa_iio_context dev, const char* attr_chan, const int data);

/**
 * Write string
 *
 * @param dev The iio context
 * @param attr_chan Channel attributes
 * @param data String to write
 * @return Result of operation
 */
mraa_result_t mraa_iio_write_string(mraa_iio_context dev, const char* attr_chan, const char* data);

/**
 * Get channel data
 *
 * @param dev The iio context
 * @return Result of operation
 */
mraa_result_t mraa_iio_get_channel_data(mraa_iio_context dev);

/**
 * Get event data
 *
 * @param dev The iio context
 * @return Result of operation
 */
mraa_result_t mraa_iio_get_event_data(mraa_iio_context dev);

/**
 * Event poll
 *
 * @param dev The iio context
 * @param data Data
 * @return Result of operation
 */
mraa_result_t mraa_iio_event_poll(mraa_iio_context dev, struct iio_event_data* data);

/**
 * Setup event callback
 *
 * @param dev The iio context
 * @param fptr Callback
 * @param args Arguments
 * @return Result of operation
 */
mraa_result_t
mraa_iio_event_setup_callback(mraa_iio_context dev, void (*fptr)(struct iio_event_data* data, void* args), void* args);

/**
 * Extract event
 *
 * @param event Event
 * @param chan_type Channel type
 * @param modifier Modifier
 * @param type Type
 * @param direction Direction
 * @param channel Channel
 * @param channel2 Channel2
 * @param different Different
 * @return Result of operation
 */
mraa_result_t mraa_iio_event_extract_event(struct iio_event_data* event,
                                           int* chan_type,
                                           int* modifier,
                                           int* type,
                                           int* direction,
                                           int* channel,
                                           int* channel2,
                                           int* different);

/**
 * Get mount matrix
 * @param dev The iio context
 * @param sysfs_name Sysfs name
 * @param mm Matrix
 * @return Result of operation
 */
mraa_result_t mraa_iio_get_mount_matrix(mraa_iio_context dev, const char *sysfs_name, float mm[9]);

/**
 * Create trigger
 *
 * @param dev The iio context
 * @param trigger Trigger name
 * @return Result of operation
 */
mraa_result_t mraa_iio_create_trigger(mraa_iio_context dev, const char* trigger);

/**
 * Update channels
 *
 * @param dev The iio context
 * @return Result of operation
 */
mraa_result_t mraa_iio_update_channels(mraa_iio_context dev);

/**
 * De-inits an mraa_iio_context device
 *
 * @param dev The iio context
 * @return Result of operation
 */
mraa_result_t mraa_iio_close(mraa_iio_context dev);

#ifdef __cplusplus
}
#endif