include/mraa_internal_types.h

   1 /*
   2  * Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
   3  * Author: Brendan Le Foll <brendan.le.foll@intel.com>
   4  * Copyright (c) 2014 Intel Corporation.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining
   7  * a copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sublicense, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be
  15  * included in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  20  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  21  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  22  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  23  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  24  */
  25
  26 #pragma once
  27
  28 #include "common.h"
  29 #include "mraa.h"
  30
  31 // general status failures for internal functions
  32 #define MRAA_PLATFORM_NO_INIT -3
  33 #define MRAA_IO_SETUP_FAILURE -2
  34 #define MRAA_NO_SUCH_IO -1
  35
  36 /**
  37  * A structure representing a gpio pin.
  38  */
  39 struct _gpio {
  40     /*@{*/
  41     int pin; /**< the pin number, as known to the os. */
  42     int phy_pin; /**< pin passed to clean init. -1 none and raw*/
  43     int value_fp; /**< the file pointer to the value of the gpio */
  44     void (* isr)(void *); /**< the interupt service request */
  45     void *isr_args; /**< args return when interupt service request triggered */
  46     pthread_t thread_id; /**< the isr handler thread id */
  47     int isr_value_fp; /**< the isr file pointer on the value */
  48     mraa_boolean_t owner; /**< If this context originally exported the pin */
  49     mraa_result_t (*mmap_write) (mraa_gpio_context dev, int value);
  50     int (*mmap_read) (mraa_gpio_context dev);
  51     /*@}*/
  52 };
  53
  54 /**
  55  * A structure representing a I2C bus
  56  */
  57 struct _i2c {
  58     /*@{*/
  59     int busnum; /**< the bus number of the /dev/i2c-* device */
  60     int fh; /**< the file handle to the /dev/i2c-* device */
  61     int addr; /**< the address of the i2c slave */
  62     unsigned long funcs;
  63     /*@}*/
  64 };
  65
  66 /**
  67  * A structure representing a PWM pin
  68  */
  69 struct _pwm {
  70     /*@{*/
  71     int pin; /**< the pin number, as known to the os. */
  72     int chipid; /**< the chip id, which the pwm resides */
  73     int duty_fp; /**< File pointer to duty file */
  74     int period;  /**< Cache the period to speed up setting duty */
  75     mraa_boolean_t owner; /**< Owner of pwm context*/
  76     /*@}*/
  77 };
  78
  79 /**
  80  * A structure representing a Analog Input Channel
  81  */
  82 struct _aio {
  83     unsigned int channel; /**< the channel as on board and ADC module */
  84     int adc_in_fp; /**< File Pointer to raw sysfs */
  85     int value_bit; /**< 10 bits by default. Can be increased if board */
  86 };
  87
  88 /**
  89  * A structure representing a UART device
  90  */
  91 struct _uart {
  92     /*@{*/
  93     int index; /**< the uart index, as known to the os. */
  94     const char* path; /**< the uart device path. */
  95     int fd; /**< file descriptor for device. */
  96     /*@}*/
  97 };
  98
  99 /**
 100  * A bitfield representing the capabilities of a pin.
 101  */
 102 typedef struct {
 103     /*@{*/
 104     mraa_boolean_t valid:1;     /**< Is the pin valid at all */
 105     mraa_boolean_t gpio:1;      /**< Is the pin gpio capable */
 106     mraa_boolean_t pwm:1;       /**< Is the pin pwm capable */
 107     mraa_boolean_t fast_gpio:1; /**< Is the pin fast gpio capable */
 108     mraa_boolean_t spi:1;       /**< Is the pin spi capable */
 109     mraa_boolean_t i2c:1;       /**< Is the pin i2c capable */
 110     mraa_boolean_t aio:1;       /**< Is the pin analog input capable */
 111     mraa_boolean_t uart:1;       /**< Is the pin uart capable */
 112     /*@}*/
 113 } mraa_pincapabilities_t;
 114
 115 /**
 116  * A Structure representing a multiplexer and the required value
 117  */
 118 typedef struct {
 119     /*@{*/
 120     unsigned int pin;   /**< Raw GPIO pin id */
 121     unsigned int value; /**< Raw GPIO value */
 122     /*@}*/
 123 } mraa_mux_t;
 124
 125 typedef struct {
 126     mraa_boolean_t complex_pin:1;
 127     mraa_boolean_t output_en:1;
 128     mraa_boolean_t output_en_high:1;
 129     mraa_boolean_t pullup_en:1;
 130     mraa_boolean_t pullup_en_hiz:1;
 131 } mraa_pin_cap_complex_t;
 132
 133 typedef struct {
 134     /*@{*/
 135     unsigned int pinmap; /**< sysfs pin */
 136     unsigned int parent_id; /** parent chip id */
 137     unsigned int mux_total; /** Numfer of muxes needed for operation of pin */
 138     mraa_mux_t mux[6]; /** Array holding information about mux */
 139     unsigned int output_enable; /** Output Enable GPIO, for level shifting */
 140     unsigned int pullup_enable; /** Pull-Up enable GPIO, inputs */
 141     mraa_pin_cap_complex_t complex_cap;
 142     /*@}*/
 143 } mraa_pin_t;
 144
 145 typedef struct {
 146     /*@{*/
 147     char mem_dev[32]; /**< Memory device to use /dev/uio0 etc */
 148     unsigned int mem_sz; /** Size of memory to map */
 149     unsigned int bit_pos; /** Position of value bit */
 150     mraa_pin_t gpio; /** GPio context containing none mmap info */
 151     /*@}*/
 152 } mraa_mmap_pin_t;
 153
 154 /**
 155  * A Structure representing a physical Pin.
 156  */
 157 typedef struct {
 158     /*@{*/
 159     char name[MRAA_PIN_NAME_SIZE]; /**< Pin's real world name */
 160     mraa_pincapabilities_t capabilites; /**< Pin Capabiliites */
 161     mraa_pin_t gpio; /**< GPIO structure */
 162     mraa_pin_t pwm;  /**< PWM structure */
 163     mraa_pin_t aio;  /**< Anaglog Pin */
 164     mraa_mmap_pin_t mmap; /**< GPIO through memory */
 165     mraa_pin_t i2c;  /**< i2c bus/pin */
 166     mraa_pin_t spi;  /**< spi bus/pin */
 167     mraa_pin_t uart;  /**< uart module/pin */
 168     /*@}*/
 169 } mraa_pininfo_t;
 170
 171 /**
 172  * A Structure representing the physical properties of a i2c bus.
 173  */
 174 typedef struct {
 175     /*@{*/
 176     unsigned int bus_id; /**< ID as exposed in the system */
 177     unsigned int scl; /**< i2c SCL */
 178     unsigned int sda; /**< i2c SDA */
 179     /*@}*/
 180 } mraa_i2c_bus_t;
 181
 182 /**
 183  * A Structure representing the physical properties of a spi bus.
 184  */
 185 typedef struct {
 186     /*@{*/
 187     unsigned int bus_id; /**< The Bus ID as exposed to the system. */
 188     unsigned int slave_s; /**< Slave select */
 189     mraa_boolean_t three_wire; /**< Is the bus only a three wire system */
 190     unsigned int sclk; /**< Serial Clock */
 191     unsigned int mosi; /**< Master Out, Slave In. */
 192     unsigned int miso; /**< Master In, Slave Out. */
 193     unsigned int cs; /**< Chip Select, used when the board is a spi slave */
 194     /*@}*/
 195 } mraa_spi_bus_t;
 196
 197 /**
 198  * A Structure representing a uart device.
 199  */
 200 typedef struct {
 201     /*@{*/
 202     unsigned int index; /**< ID as exposed in the system */
 203     int rx; /**< uart rx */
 204     int tx; /**< uart tx */
 205     const char* device_path; /**< To store "/dev/ttyS1" for example */
 206     /*@}*/
 207 } mraa_uart_dev_t;
 208
 209 /**
 210  * A Structure representing a platform/board.
 211  */
 212 typedef struct {
 213     /*@{*/
 214     unsigned int phy_pin_count; /**< The Total IO pins on board */
 215     unsigned int gpio_count; /**< GPIO Count */
 216     unsigned int aio_count;  /**< Analog side Count */
 217     unsigned int i2c_bus_count; /**< Usable i2c Count */
 218     mraa_i2c_bus_t  i2c_bus[12]; /**< Array of i2c */
 219     unsigned int def_i2c_bus; /**< Position in array of default i2c bus */
 220     unsigned int spi_bus_count; /**< Usable spi Count */
 221     mraa_spi_bus_t spi_bus[12];       /**< Array of spi */
 222     unsigned int def_spi_bus; /**< Position in array of defult spi bus */
 223     unsigned int adc_raw; /**< ADC raw bit value */
 224     unsigned int adc_supported; /**< ADC supported bit value */
 225     unsigned int def_uart_dev; /**< Position in array of defult uart */
 226     unsigned int uart_dev_count; /**< Usable spi Count */
 227     mraa_uart_dev_t uart_dev[6]; /**< Array of UARTs */
 228     int pwm_default_period; /**< The default PWM period is US */
 229     int pwm_max_period; /**< Maximum period in us */
 230     int pwm_min_period; /**< Minimum period in us */
 231     const char* platform_name; /**< Platform Name pointer */
 232     mraa_pininfo_t* pins;     /**< Pointer to pin array */
 233     /*@}*/
 234 } mraa_board_t;