2 * Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
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.
29 * This file defines the gpio interface for libmaa
41 * A strucutre representing a gpio pin.
45 int pin; /**< the pin number, as known to the os. */
46 FILE *value_fp; /**< the file pointer to the value of the gpio */
54 MAA_GPIO_STRONG = 0, /**< Default. Strong high and low */
55 MAA_GPIO_PULLUP = 1, /**< Resistive High */
56 MAA_GPIO_PULLDOWN = 2, /**< Resistive Low */
57 MAA_GPIO_HIZ = 3 /**< High Z State */
61 * GPIO Direction options.
64 MAA_GPIO_OUT = 0, /**< Output. A Mode can also be set */
65 MAA_GPIO_IN = 1 /**< Input. */
68 /** Initialise gpio_context, based on board number
70 * @param pin pin number read from the board, i.e IO3 is 3.
72 * @returns maa_gpio_context based on the IO pin
74 maa_gpio_context* maa_gpio_init(int pin);
76 /** Initialise gpio context without any mapping to a pin.
77 * - For more expert users
79 * @param gpiopin gpio pin as listed in SYSFS
81 * @return gpio context
83 maa_gpio_context* maa_gpio_init_raw(int gpiopin);
85 /** Set GPIO Output Mode,
87 * @param dev The GPIO context
88 * @param mode The GPIO Output Mode.
90 * @return maa result type.
92 maa_result_t maa_gpio_mode(maa_gpio_context *dev, gpio_mode_t mode);
94 /** Set GPIO direction
96 * @param dev The GPIO context.
97 * @param dir The direction of the GPIO.
99 * @return maa result type.
101 maa_result_t maa_gpio_dir(maa_gpio_context *dev, gpio_dir_t dir);
103 /** Close the GPIO context
104 * - Will free the memory for the context.
106 * @param dev the GPIO context
108 * @return maa result type.
110 maa_result_t maa_gpio_close(maa_gpio_context *dev);
112 /** Read the GPIO value.
114 * @param dev The GPIO context.
116 * @return the integer value of the GPIO
118 int maa_gpio_read(maa_gpio_context *dev);
120 /** Write to the GPIO Value.
122 * @param dev The GPIO context.
123 * @param value Integer value to write.
125 * @return maa result type
127 maa_result_t maa_gpio_write(maa_gpio_context *dev, int value);