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
  29 typedef struct {
  30     int index;
  31     int enabled;
  32     char* type;
  33     mraa_boolean_t lendian;
  34     int signedd;
  35     unsigned int offset;
  36     uint64_t mask;
  37     unsigned int bits_used;
  38     unsigned int bytes;
  39     unsigned int shift;
  40     unsigned int location;
  41     float scale;
  42 } mraa_iio_channel;
  43
  44 /**
  45  * @file
  46  * @brief iio
  47  *
  48  * An iio context represents an IIO device
  49  *
  50  * @snippet iio_driver.c Interesting
  51  */
  52
  53 #ifdef __cplusplus
  54 extern "C" {
  55 #endif
  56
  57 #include <stdlib.h>
  58 #include <stdio.h>
  59 #include <fcntl.h>
  60 #include <stdint.h>
  61
  62 #include "common.h"
  63
  64 /**
  65  * Opaque pointer definition to the internal struct _iio
  66  */
  67 typedef struct _iio* mraa_iio_context;
  68
  69 /**
  70  * Initialise iio context
  71  *
  72  * @param bus iio device to use
  73  * @return i2c context or NULL
  74  */
  75 mraa_iio_context mraa_iio_init(int device);
  76
  77 mraa_result_t mraa_iio_trigger_buffer(mraa_iio_context dev, void (*fptr)(char* data), void* args);
  78
  79 const char* mraa_iio_get_device_name(mraa_iio_context dev);
  80
  81 int mraa_iio_read_size(mraa_iio_context dev);
  82
  83 mraa_iio_channel* mraa_iio_get_channels(mraa_iio_context dev);
  84
  85 int mraa_iio_get_channel_count(mraa_iio_context dev);
  86
  87 /**
  88  */
  89 mraa_result_t mraa_iio_read(mraa_iio_context dev, const char* attribute, float* data);
  90
  91 /**
  92  *
  93  */
  94 mraa_result_t mraa_iio_write(mraa_iio_context dev, const char* attribute);
  95
  96 mraa_result_t mraa_iio_get_channel_data(mraa_iio_context dev);
  97
  98 /**
  99  * De-inits an mraa_iio_context device
 100  *
 101  * @param dev The iio context
 102  * @return Result of operation
 103  */
 104 mraa_result_t mraa_iio_stop(mraa_iio_context dev);
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif