api/mraa/aio.h

   1 /*
   2  * Author: Nandkishor Sonar
   3  * Copyright (c) 2014 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  * @file
  28  * @brief Analog input/output
  29  *
  30  * AIO is the anlog input & output interface to libmraa. It is used to read or
  31  * set the voltage applied to an AIO pin.
  32  *
  33  * @snippet analogin_a0.c Interesting
  34  */
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 #include <stdio.h>
  41 #include <unistd.h>
  42 #include <stdint.h>
  43
  44 #include "common.h"
  45 #include "gpio.h"
  46
  47 #define ADC_RAW_RESOLUTION_BITS         (12)
  48 #define ADC_SUPPORTED_RESOLUTION_BITS   (10)
  49
  50 /**
  51  * Opaque pointer definition to the internal struct _aio. This context refers
  52  * to one single AIO pin on the board.
  53  */
  54 typedef struct _aio* mraa_aio_context;
  55
  56 /**
  57  * Initialise an Analog input device, connected to the specified pin
  58  *
  59  * @param pin Channel number to read ADC inputs
  60  * @returns aio context or NULL
  61  */
  62 mraa_aio_context mraa_aio_init(unsigned int pin);
  63
  64 /**
  65  * Read the input voltage
  66  *
  67  * @param dev The AIO context
  68  * @returns The current input voltage, normalised to a 16-bit value
  69  */
  70 uint16_t mraa_aio_read(mraa_aio_context dev);
  71
  72 /**
  73  * Close the analog input context, this will free the memory for the context
  74  *
  75  * @param dev The AIO context
  76  * @return Result of operation
  77  */
  78 mraa_result_t mraa_aio_close(mraa_aio_context dev);
  79
  80 #ifdef __cplusplus
  81 }
  82 #endif