api/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 /** @file
  27  *
  28  * This file defines the aio (analog in) interface for libmaa
  29  *
  30  */
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 #include <stdio.h>
  37 #include <unistd.h>
  38 #include <stdint.h>
  39
  40 #include "maa.h"
  41 #include "gpio.h"
  42
  43 #define ADC_RAW_RESOLUTION_BITS         (12)
  44 #define ADC_SUPPORTED_RESOLUTION_BITS   (10)
  45
  46 /**
  47  * Opaque pointer definition to the internal struct _aio
  48  */
  49 typedef struct _aio* maa_aio_context;
  50
  51 /** Initialise an Analog input device, connected to the specified pin
  52  *
  53  * @param aio_channel channel number to read ADC inputs
  54  *
  55  * @returns pointer to maa_aio_context structure after initialisation of Analog
  56  * input pin successfully, else returns null.
  57  */
  58 maa_aio_context maa_aio_init(unsigned int aio_channel);
  59
  60 /** Read the input voltage, represented as an unsigned short in the range [0x0,
  61  * 0xFFFF]
  62  *
  63  * @param dev -  pointer to maa_aio_context structure  initialised by
  64  * maa_aio_init()
  65  *
  66  * @returns 16-bit unsigned integer representing the current input voltage,
  67  * normalised to a 16-bit value
  68  */
  69 uint16_t maa_aio_read(maa_aio_context dev);
  70
  71 /** Close the analog input context
  72  * - Will free the memory for the context.
  73  *
  74  * @param dev -  pointer to maa_aio_context structure  initialised by
  75  * maa_aio_init()
  76  *
  77  * @return maa_result_t - result type.
  78  */
  79 maa_result_t maa_aio_close(maa_aio_context dev);
  80
  81 #ifdef __cplusplus
  82 }
  83 #endif