api/gpio.h

   1 /*
   2  * Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
   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  *
  29  * This file defines the gpio interface for libmaa
  30  *
  31  */
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 #ifdef SWIGPYTHON
  38 #include <Python.h>
  39 #endif
  40
  41 #include <stdio.h>
  42 #include <pthread.h>
  43
  44 #include "maa.h"
  45 /**
  46  * A strucutre representing a gpio pin.
  47  */
  48
  49 typedef struct {
  50     /*@{*/
  51     int pin; /**< the pin number, as known to the os. */
  52     int value_fp; /**< the file pointer to the value of the gpio */
  53 #ifdef SWIGPYTHON
  54     PyObject *isr; /**< the interupt service request */
  55 #else
  56     void (* isr)(); /**< the interupt service request */
  57 #endif
  58     pthread_t thread_id; /**< the isr handler thread id */
  59     int isr_value_fp; /**< the isr file pointer on the value */
  60     /*@}*/
  61 } maa_gpio_context;
  62
  63 /**
  64  * GPIO Output modes
  65  */
  66 typedef enum {
  67     MAA_GPIO_STRONG     = 0, /**< Default. Strong high and low */
  68     MAA_GPIO_PULLUP     = 1, /**< Resistive High */
  69     MAA_GPIO_PULLDOWN   = 2, /**< Resistive Low */
  70     MAA_GPIO_HIZ        = 3  /**< High Z State */
  71 } gpio_mode_t;
  72
  73 /**
  74  * GPIO Direction options.
  75  */
  76 typedef enum {
  77     MAA_GPIO_OUT    = 0, /**< Output. A Mode can also be set */
  78     MAA_GPIO_IN     = 1  /**< Input. */
  79 } gpio_dir_t;
  80
  81 typedef enum {
  82     MAA_GPIO_EDGE_NONE    = 0, /**< No interrupt on GPIO */
  83     MAA_GPIO_EDGE_BOTH    = 1, /**< Interupt on rising & falling */
  84     MAA_GPIO_EDGE_RISING  = 2, /**< Interupt on rising only */
  85     MAA_GPIO_EDGE_FALLING = 3  /**< Interupt on falling only */
  86 } gpio_edge_t;
  87
  88 /** Initialise gpio_context, based on board number
  89  *
  90  *  @param pin pin number read from the board, i.e IO3 is 3.
  91  *
  92  *  @returns maa_gpio_context based on the IO pin
  93  */
  94 maa_gpio_context* maa_gpio_init(int pin);
  95
  96 /** Initialise gpio context without any mapping to a pin.
  97  * - For more expert users
  98  *
  99  * @param gpiopin gpio pin as listed in SYSFS
 100  *
 101  * @return gpio context
 102  */
 103 maa_gpio_context* maa_gpio_init_raw(int gpiopin);
 104
 105 /** Set the edge mode on the gpio
 106  *
 107  * @param dev The GPIO context
 108  * @param mode The edge mode to set the gpio into
 109  *
 110  * @return maa result type.
 111  */
 112 maa_result_t maa_gpio_edge_mode(maa_gpio_context *dev, gpio_edge_t mode);
 113
 114 /** Set an interupt on pin
 115  *
 116  * @param dev The GPIO context
 117  * @param mode The edge mode to set the gpio into
 118  * @param fptr Function pointer to function to be called when interupt is
 119  * triggered
 120  *
 121  * @return maa result type.
 122  */
 123 maa_result_t
 124 maa_gpio_isr(maa_gpio_context *dev, gpio_edge_t edge, void (*fptr)(void));
 125
 126 /** Stop the current interupt watcher on this GPIO, and set the GPIO edge mode
 127  * to MAA_GPIO_EDGE_NONE.
 128  *
 129  * @param dev The GPIO context.
 130  *
 131  * @return maa result type.
 132  */
 133 maa_result_t
 134 maa_gpio_isr_exit(maa_gpio_context *dev);
 135
 136 /** Set GPIO Output Mode,
 137  *
 138  * @param dev The GPIO context
 139  * @param mode The GPIO Output Mode.
 140  *
 141  * @return maa result type.
 142  */
 143 maa_result_t maa_gpio_mode(maa_gpio_context *dev, gpio_mode_t mode);
 144
 145 /** Set GPIO direction
 146  *
 147  * @param dev The GPIO context.
 148  * @param dir The direction of the GPIO.
 149  *
 150  * @return maa result type.
 151  */
 152 maa_result_t maa_gpio_dir(maa_gpio_context *dev, gpio_dir_t dir);
 153
 154 /** Close the GPIO context
 155  * - Will free the memory for the context and unexport the GPIO
 156  *
 157  * @param dev the GPIO context
 158  *
 159  * @return maa result type.
 160  */
 161 maa_result_t maa_gpio_close(maa_gpio_context *dev);
 162
 163 /** Unexport the GPIO context (maa_gpio_close() will call this function)
 164  *
 165  * @param dev The GPIO context.
 166  *
 167  * @return maa result type.
 168  */
 169 maa_result_t maa_gpio_unexport(maa_gpio_context *dev);
 170
 171 /** Read the GPIO value.
 172  *
 173  * @param dev The GPIO context.
 174  *
 175  * @return the integer value of the GPIO
 176  */
 177 int maa_gpio_read(maa_gpio_context *dev);
 178
 179 /** Write to the GPIO Value.
 180  *
 181  * @param dev The GPIO context.
 182  * @param value Integer value to write.
 183  *
 184  * @return maa result type
 185  */
 186 maa_result_t maa_gpio_write(maa_gpio_context *dev, int value);
 187
 188 #ifdef __cplusplus
 189 }
 190 #endif