api/mraa/iio.h

   1 /*
   2  * Author: Brendan Le Foll <brendan.le.foll@intel.com>
   3  * Copyright (c) 2015 Intel Corporation.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 #pragma once
  26
  27 #include "common.h"
  28 #include "iio_kernel_headers.h"
  29
  30 typedef struct {
  31     int index;
  32     int enabled;
  33     char* type;
  34     mraa_boolean_t lendian;
  35     int signedd;
  36     unsigned int offset;
  37     uint64_t mask;
  38     unsigned int bits_used;
  39     unsigned int bytes;
  40     unsigned int shift;
  41     unsigned int location;
  42 } mraa_iio_channel;
  43
  44 typedef struct {
  45     char *name;
  46         int enabled;
  47 } mraa_iio_event;
  48
  49 /**
  50  * @file
  51  * @brief iio
  52  *
  53  * An iio context represents an IIO device
  54  *
  55  * @snippet iio_driver.c Interesting
  56  */
  57
  58 #ifdef __cplusplus
  59 extern "C" {
  60 #endif
  61
  62 #include <stdlib.h>
  63 #include <stdio.h>
  64 #include <fcntl.h>
  65 #include <stdint.h>
  66
  67 #include "common.h"
  68
  69 /**
  70  * Opaque pointer definition to the internal struct _iio
  71  */
  72 typedef struct _iio* mraa_iio_context;
  73
  74 /**
  75  * Initialise iio context
  76  *
  77  * @param bus iio device to use
  78  * @return i2c context or NULL
  79  */
  80 mraa_iio_context mraa_iio_init(int device);
  81
  82 mraa_result_t mraa_iio_trigger_buffer(mraa_iio_context dev, void (*fptr)(char* data), void* args);
  83
  84 const char* mraa_iio_get_device_name(mraa_iio_context dev);
  85
  86 int mraa_iio_get_device_num_by_name(const char* name);
  87
  88 int mraa_iio_read_size(mraa_iio_context dev);
  89
  90 mraa_iio_channel* mraa_iio_get_channels(mraa_iio_context dev);
  91
  92 int mraa_iio_get_channel_count(mraa_iio_context dev);
  93
  94 /**
  95  */
  96 mraa_result_t mraa_iio_read(mraa_iio_context dev, const char* attribute, float* data);
  97
  98 /**
  99  *
 100  */
 101 mraa_result_t mraa_iio_write(mraa_iio_context dev, const char* attr_chan, const char* data);
 102
 103 mraa_result_t mraa_iio_get_channel_data(mraa_iio_context dev);
 104
 105 mraa_result_t mraa_iio_get_event_data(mraa_iio_context dev);
 106
 107 mraa_result_t mraa_iio_event_read(mraa_iio_context dev, const char* attribute, float* data);
 108
 109 mraa_result_t mraa_iio_event_write(mraa_iio_context dev, const char* attribute, const char* data);
 110
 111 mraa_result_t mraa_iio_event_poll(mraa_iio_context dev, struct iio_event_data* data);
 112
 113 mraa_result_t mraa_iio_event_setup_callback(mraa_iio_context dev, void (*fptr)(struct iio_event_data* data), void* args);
 114
 115 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);
 116 /**
 117  * De-inits an mraa_iio_context device
 118  *
 119  * @param dev The iio context
 120  * @return Result of operation
 121  */
 122 mraa_result_t mraa_iio_stop(mraa_iio_context dev);
 123
 124 #ifdef __cplusplus
 125 }
 126 #endif