api/mraa/common.h

   1 /*
   2  * Author: Brendan Le Foll <brendan.le.foll@intel.com>
   3  * Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
   4  * Copyright © 2014 Intel Corporation
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to
   8  * deal in the Software without restriction, including without limitation the
   9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  10  * sell copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  22  * IN THE SOFTWARE.
  23  */
  24
  25 #pragma once
  26
  27 #include "types.h"
  28
  29 /** @file
  30  *
  31  * This file defines the basic shared values for libmraa
  32  */
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /**
  39  * MRAA boolean type
  40  * 1 For TRUE
  41  */
  42 typedef unsigned int mraa_boolean_t;
  43
  44 /**
  45  * Enum representing different possible modes for a pin.
  46  */
  47 typedef enum {
  48     MRAA_PIN_VALID       = 0, /**< Pin Valid */
  49     MRAA_PIN_GPIO        = 1, /**< General Purpose IO */
  50     MRAA_PIN_PWM         = 2, /**< Pulse Width Modulation */
  51     MRAA_PIN_FAST_GPIO   = 3, /**< Faster GPIO */
  52     MRAA_PIN_SPI         = 4, /**< SPI */
  53     MRAA_PIN_I2C         = 5, /**< I2C */
  54     MRAA_PIN_AIO         = 6  /**< Analog in */
  55 } mraa_pinmodes_t;
  56
  57 /**
  58  * A bitfield representing the capabilities of a pin.
  59  */
  60 typedef struct {
  61     /*@{*/
  62     mraa_boolean_t valid:1;     /**< Is the pin valid at all */
  63     mraa_boolean_t gpio:1;      /**< Is the pin gpio capable */
  64     mraa_boolean_t pwm:1;       /**< Is the pin pwm capable */
  65     mraa_boolean_t fast_gpio:1; /**< Is the pin fast gpio capable */
  66     mraa_boolean_t spi:1;       /**< Is the pin spi capable */
  67     mraa_boolean_t i2c:1;       /**< Is the pin i2c capable */
  68     mraa_boolean_t aio:1;       /**< Is the pin analog input capable */
  69     /*@}*/
  70 } mraa_pincapabilities_t;
  71
  72 /**
  73  * A Structure representing a multiplexer and the required value
  74  */
  75 typedef struct {
  76     /*@{*/
  77     unsigned int pin;   /**< Raw GPIO pin id */
  78     unsigned int value; /**< Raw GPIO value */
  79     /*@}*/
  80 } mraa_mux_t;
  81
  82 typedef struct {
  83     mraa_boolean_t complex_pin:1;
  84     mraa_boolean_t output_en:1;
  85     mraa_boolean_t output_en_high:1;
  86     mraa_boolean_t pullup_en:1;
  87     mraa_boolean_t pullup_en_hiz:1;
  88 } mraa_pin_cap_complex_t;
  89
  90 typedef struct {
  91     /*@{*/
  92     unsigned int pinmap; /**< sysfs pin */
  93     unsigned int parent_id; /** parent chip id */
  94     unsigned int mux_total; /** Numfer of muxes needed for operation of pin */
  95     mraa_mux_t mux[6]; /** Array holding information about mux */
  96     unsigned int output_enable; /** Output Enable GPIO, for level shifting */
  97     unsigned int pullup_enable; /** Pull-Up enable GPIO, inputs */
  98     mraa_pin_cap_complex_t complex_cap;
  99     /*@}*/
 100 } mraa_pin_t;
 101
 102 typedef struct {
 103     /*@{*/
 104     char mem_dev[32]; /**< Memory device to use /dev/uio0 etc */
 105     unsigned int mem_sz; /** Size of memory to map */
 106     unsigned int bit_pos; /** Position of value bit */
 107     mraa_pin_t gpio; /** GPio context containing none mmap info */
 108     /*@}*/
 109 } mraa_mmap_pin_t;
 110
 111 /**
 112  * A Structure representing a physical Pin.
 113  */
 114 typedef struct {
 115     /*@{*/
 116     char name[8];                      /**< Pin's real world name */
 117     mraa_pincapabilities_t capabilites; /**< Pin Capabiliites */
 118     mraa_pin_t gpio; /**< GPIO structure */
 119     mraa_pin_t pwm;  /**< PWM structure */
 120     mraa_pin_t aio;  /**< Anaglog Pin */
 121     mraa_mmap_pin_t mmap; /**< GPIO through memory */
 122     mraa_pin_t i2c;  /**< i2c bus/pin */
 123     mraa_pin_t spi;  /**< spi bus/pin */
 124     /*@}*/
 125 } mraa_pininfo_t;
 126
 127 /**
 128  * A Structure representing the physical properties of a i2c bus.
 129  */
 130 typedef struct {
 131     /*@{*/
 132     unsigned int bus_id; /**< ID as exposed in the system */
 133     unsigned int scl; /**< i2c SCL */
 134     unsigned int sda; /**< i2c SDA */
 135     /*@}*/
 136 } mraa_i2c_bus_t;
 137
 138 /**
 139  * A Structure representing the physical properties of a spi bus.
 140  */
 141 typedef struct {
 142     /*@{*/
 143     unsigned int bus_id; /**< The Bus ID as exposed to the system. */
 144     unsigned int slave_s; /**< Slave select */
 145     mraa_boolean_t three_wire; /**< Is the bus only a three wire system */
 146     unsigned int sclk; /**< Serial Clock */
 147     unsigned int mosi; /**< Master Out, Slave In. */
 148     unsigned int miso; /**< Master In, Slave Out. */
 149     unsigned int cs; /**< Chip Select, used when the board is a spi slave */
 150     /*@}*/
 151 } mraa_spi_bus_t;
 152
 153 /**
 154  * A Structure representing a platform/board.
 155  */
 156 typedef struct {
 157     /*@{*/
 158     unsigned int phy_pin_count; /**< The Total IO pins on board */
 159     unsigned int gpio_count; /**< GPIO Count */
 160     unsigned int aio_count;  /**< Analog side Count */
 161     unsigned int i2c_bus_count; /**< Usable i2c Count */
 162     mraa_i2c_bus_t  i2c_bus[6]; /**< Array of i2c */
 163     unsigned int def_i2c_bus; /**< Position in array of default i2c bus */
 164     unsigned int spi_bus_count; /**< Usable spi Count */
 165     mraa_spi_bus_t spi_bus[6];       /**< Array of spi */
 166     unsigned int def_spi_bus; /**< Position in array of defult spi bus */
 167     unsigned int adc_raw; /**< ADC raw bit value */
 168     unsigned int adc_supported; /**< ADC supported bit value */
 169     mraa_pininfo_t* pins;     /**< Pointer to pin array */
 170     /*@}*/
 171 } mraa_board_t;
 172
 173 /**
 174  * Initialise MRAA
 175  *
 176  * Detects running platform and attempts to use included pinmap
 177  *
 178  * @return Result of operation
 179  */
 180 #ifndef SWIG
 181 // this sets a compiler attribute (supported by GCC & clang) to have mraa_init()
 182 // be called as a constructor make sure your libc supports this!  uclibc needs
 183 // to be compiled with UCLIBC_CTOR_DTOR
 184 mraa_result_t mraa_init() __attribute__((constructor));
 185 #else
 186 mraa_result_t mraa_init();
 187 #endif
 188
 189 /**
 190  * De-Initilise MRAA
 191  *
 192  * This is not a strict requirement but useful to test memory leaks and for
 193  * people who like super clean code.
 194  */
 195 void mraa_deinit();
 196
 197 /**
 198  * Checks if a pin is able to use the passed in mode.
 199  *
 200  * @param pin Physical Pin to be checked.
 201  * @param mode the mode to be tested.
 202  * @return boolean if the mode is supported, 0=false.
 203  */
 204 mraa_boolean_t mraa_pin_mode_test(int pin, mraa_pinmodes_t mode);
 205
 206 /**
 207  * Check the board's  bit size when reading the value
 208  *
 209  * @return raw bits being read from kernel module. zero if no ADC
 210  */
 211 unsigned int mraa_adc_raw_bits();
 212
 213 /**
 214  * Return value that the raw value should be shifted to. Zero if no ADC
 215  *
 216  * @return return actual bit size the adc value should be understood as.
 217  */
 218 unsigned int mraa_adc_supported_bits();
 219
 220 #ifdef __cplusplus
 221 }
 222 #endif