gpio.h

Go to the documentation of this file.

/*
 * Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
 * Copyright (c) 2014 Intel Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#pragma once

#ifdef __cplusplus
extern "C" {
#endif

#ifdef SWIGPYTHON
#include <Python.h>
#endif

#include <stdio.h>
#include <pthread.h>

#include "common.h"

typedef struct _gpio* mraa_gpio_context;

typedef enum {
    MRAA_GPIO_STRONG     = 0, 
    MRAA_GPIO_PULLUP     = 1, 
    MRAA_GPIO_PULLDOWN   = 2, 
    MRAA_GPIO_HIZ        = 3  
} gpio_mode_t;

typedef enum {
    MRAA_GPIO_OUT    = 0, 
    MRAA_GPIO_IN     = 1,  
    MRAA_GPIO_OUT_HIGH = 2, 
    MRAA_GPIO_OUT_LOW = 3 
} gpio_dir_t;

typedef enum {
    MRAA_GPIO_EDGE_NONE    = 0, 
    MRAA_GPIO_EDGE_BOTH    = 1, 
    MRAA_GPIO_EDGE_RISING  = 2, 
    MRAA_GPIO_EDGE_FALLING = 3  
} gpio_edge_t;

mraa_gpio_context mraa_gpio_init(int pin);

mraa_gpio_context mraa_gpio_init_raw(int gpiopin);

mraa_result_t mraa_gpio_edge_mode(mraa_gpio_context dev, gpio_edge_t mode);

mraa_result_t mraa_gpio_isr(mraa_gpio_context dev, gpio_edge_t edge, void (*fptr)(void *), void * args);

mraa_result_t mraa_gpio_isr_exit(mraa_gpio_context dev);

mraa_result_t mraa_gpio_mode(mraa_gpio_context dev, gpio_mode_t mode);

mraa_result_t mraa_gpio_dir(mraa_gpio_context dev, gpio_dir_t dir);

mraa_result_t mraa_gpio_close(mraa_gpio_context dev);

int mraa_gpio_read(mraa_gpio_context dev);

mraa_result_t mraa_gpio_write(mraa_gpio_context dev, int value);

mraa_result_t mraa_gpio_owner(mraa_gpio_context dev, mraa_boolean_t owner);

mraa_result_t mraa_gpio_use_mmaped(mraa_gpio_context dev, mraa_boolean_t mmap);

int mraa_gpio_get_pin(mraa_gpio_context dev);

int mraa_gpio_get_pin_raw(mraa_gpio_context dev);

#ifdef __cplusplus
}
#endif