2 * Author: Nandkishor Sonar
3 * Copyright (c) 2014 Intel Corporation.
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:
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
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.
28 * This file defines the aio (analog in) interface for libmaa
38 #define ADC_RAW_RESOLUTION_BITS (12)
39 #define ADC_SUPPORTED_RESOLUTION_BITS (10)
46 /** Initialise an Analog input device, connected to the specified pin
48 * @param aio_channel channel number to read ADC inputs
50 * @returns pointer to maa_aio_context structure after initialisation of Analog
51 * input pin successfully, else returns null.
53 maa_aio_context* maa_aio_init(unsigned int aio_channel);
55 /** Read the input voltage, represented as an unsigned short in the range [0x0,
58 * @param dev - pointer to maa_aio_context structure initialised by
61 * @returns 16-bit unsigned integer representing the current input voltage,
62 * normalised to a 16-bit value
64 unsigned int maa_aio_read_u16(maa_aio_context* dev);
66 /** Close the analog input context
67 * - Will free the memory for the context.
69 * @param dev - pointer to maa_aio_context structure initialised by
72 * @return maa_result_t - result type.
74 maa_result_t maa_aio_close(maa_aio_context* dev);