Raspberries/mraa
Private
Public Access
2
0
Fork 0
Code Activity

gpio: Matured the GPIO API.

Browse Source 
* Greater use of return values.
* Uses defined enum instead of char arrays

Signed-off-by: Thomas Ingleby <thomas.c.ingleby@intel.com>
This commit is contained in:
Thomas Ingleby
2014-04-29 16:46:10 +01:00
parent 6ad98d23e7
commit 226c6bcb66
2 changed files with 121 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
api/gpio.h
View File

@@ -27,21 +27,92 @@
#include <stdio.h>
#include "maa.h"
/**
* A strucutre representing a gpio pin.
*/
typedef struct {
int pin;
int pinMap;
char path[64];
FILE *value_fp;
/*@{*/
int pin; /**< the pin number, as known to the os. */
FILE *value_fp; /**< the file pointer to the value of the gpio /*
/*@}*/
} maa_gpio_context;
typedef char gpio_mode_t[16];
typedef char gpio_dir_t[16];
/**
* GPIO Output modes
*/
typedef enum {
MAA_GPIO_STRONG = 0, /**< Default. Strong high and low */
MAA_GPIO_PULLUP = 1, /**< Resistive High */
MAA_GPIO_PULLDOWN = 2, /**< Resistive Low */
MAA_GPIO_HIZ = 3 /**< High Z State */
} gpio_mode_t;
/**
* GPIO Direction options.
*/
typedef enum {
MAA_GPIO_OUT = 0, /**< Output. A Mode can also be set */
MAA_GPIO_IN = 1 /**< Input. */
} gpio_dir_t;
/** Initialise gpio_context, based on board number
*
* @param pin pin number read from the board, i.e IO3 is 3.
*
* @returns
* maa_gpio_context based on the IO pin
*/
maa_gpio_context* maa_gpio_init(int pin);
void maa_gpio_mode(maa_gpio_context *dev, gpio_mode_t mode);
void maa_gpio_dir(maa_gpio_context *dev, gpio_dir_t dir);
void maa_gpio_close(maa_gpio_context *dev);
/** Initialise gpio context without any mapping to a pin.
* - For more expert users
*
* @param gpiopin gpio pin as listed in SYSFS
*
* @return gpio context
*/
maa_gpio_context* maa_gpio_init_raw(int gpiopin);
/** Set GPIO Output Mode,
*
* @param dev The GPIO context
* @param mode The GPIO Output Mode.
*
* @return maa result type.
*/
maa_result_t maa_gpio_mode(maa_gpio_context *dev, gpio_mode_t mode);
/** Set GPIO direction
*
* @param dev The GPIO context.
* @param dir The direction of the GPIO.
*
* @return maa result type.
*/
maa_result_t maa_gpio_dir(maa_gpio_context *dev, gpio_dir_t dir);
/** Close the GPIO context
* - Will free the memory for the context.
*
* @param dev the GPIO context
*
* @return maa result type.
*/
maa_result_t maa_gpio_close(maa_gpio_context *dev);
/** Read the GPIO value.
*
* @param dev The GPIO context.
*
* @return the integer value of the GPIO
*/
int maa_gpio_read(maa_gpio_context *dev);
void maa_gpio_write(maa_gpio_context *dev, int value);
/** Write to the GPIO Value.
*
* @param dev The GPIO context.
* @param value Integer value to write.
*
* @return maa result type
*/
maa_result_t maa_gpio_write(maa_gpio_context *dev, int value);