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 /**
  28  * @file
  29  * @brief iio
  30  *
  31  * An iio context represents an IIO device
  32  *
  33  * @snippet iio_driver.c Interesting
  34  */
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 #include <stdlib.h>
  41 #include <stdio.h>
  42 #include <fcntl.h>
  43 #include <stdint.h>
  44
  45 #include "common.h"
  46
  47 /**
  48  * Opaque pointer definition to the internal struct _iio
  49  */
  50 typedef struct _iio* mraa_iio_context;
  51
  52 /**
  53  * Initialise iio context
  54  *
  55  * @param bus iio device to use
  56  * @return i2c context or NULL
  57  */
  58 mraa_iio_context mraa_iio_init(int device);
  59
  60 /**
  61  */
  62 mraa_result_t mraa_iio_read(mraa_iio_context dev, uint32_t *data, int length);
  63
  64 /**
  65  * De-inits an mraa_iio_context device
  66  *
  67  * @param dev The iio context
  68  * @return Result of operation
  69  */
  70 mraa_result_t mraa_iio_stop(mraa_iio_context dev);
  71
  72 #ifdef __cplusplus
  73 }
  74 #endif