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 #include "mraa_func.h"
  31 #include "mraa_adv_func.h"
  32
  33 // general status failures for internal functions
  34 #define MRAA_PLATFORM_NO_INIT -3
  35 #define MRAA_IO_SETUP_FAILURE -2
  36 #define MRAA_NO_SUCH_IO -1
  37
  38 /**
  39  * A structure representing a gpio pin.
  40  */
  41 struct _gpio {
  42     /*@{*/
  43     int pin; /**< the pin number, as known to the os. */
  44     int phy_pin; /**< pin passed to clean init. -1 none and raw*/
  45     int value_fp; /**< the file pointer to the value of the gpio */
  46     void (* isr)(void *); /**< the interupt service request */
  47     void *isr_args; /**< args return when interupt service request triggered */
  48     pthread_t thread_id; /**< the isr handler thread id */
  49     int isr_value_fp; /**< the isr file pointer on the value */
  50     mraa_boolean_t isr_thread_terminating; /**< is the isr thread being terminated? */
  51     mraa_boolean_t owner; /**< If this context originally exported the pin */
  52     mraa_result_t (*mmap_write) (mraa_gpio_context dev, int value);
  53     int (*mmap_read) (mraa_gpio_context dev);
  54     mraa_adv_func_t* advance_func; /**< override function table */
  55     /*@}*/
  56 };
  57
  58 /**
  59  * A structure representing a I2C bus
  60  */
  61 struct _i2c {
  62     /*@{*/
  63     int busnum; /**< the bus number of the /dev/i2c-* device */
  64     int fh; /**< the file handle to the /dev/i2c-* device */
  65     int addr; /**< the address of the i2c slave */
  66     unsigned long funcs; /**< /dev/i2c-* device capabilities as per https://www.kernel.org/doc/Documentation/i2c/functionality */
  67     void *handle; /**< generic handle for non-standard drivers that don't use file descriptors  */
  68     mraa_adv_func_t* advance_func; /**< override function table */
  69     /*@}*/
  70 };
  71
  72 /**
  73  * A structure representing the SPI device
  74  */
  75 struct _spi {
  76     /*@{*/
  77     int devfd;          /**< File descriptor to SPI Device */
  78     uint32_t mode;      /**< Spi mode see spidev.h */
  79     int clock;          /**< clock to run transactions at */
  80     mraa_boolean_t lsb; /**< least significant bit mode */
  81     unsigned int bpw;   /**< Bits per word */
  82     mraa_adv_func_t* advance_func; /**< override function table */
  83     /*@}*/
  84 };
  85
  86 /**
  87  * A structure representing a PWM pin
  88  */
  89 struct _pwm {
  90     /*@{*/
  91     int pin; /**< the pin number, as known to the os. */
  92     int chipid; /**< the chip id, which the pwm resides */
  93     int duty_fp; /**< File pointer to duty file */
  94     int period;  /**< Cache the period to speed up setting duty */
  95     mraa_boolean_t owner; /**< Owner of pwm context*/
  96     mraa_adv_func_t* advance_func; /**< override function table */
  97     /*@}*/
  98 };
  99
 100 /**
 101  * A structure representing a Analog Input Channel
 102  */
 103 struct _aio {
 104     /*@{*/
 105     unsigned int channel; /**< the channel as on board and ADC module */
 106     int adc_in_fp; /**< File Pointer to raw sysfs */
 107     int value_bit; /**< 10 bits by default. Can be increased if board */
 108     mraa_adv_func_t* advance_func; /**< override function table */
 109     /*@}*/
 110 };
 111
 112 /**
 113  * A structure representing a UART device
 114  */
 115 struct _uart {
 116     /*@{*/
 117     int index; /**< the uart index, as known to the os. */
 118     const char* path; /**< the uart device path. */
 119     int fd; /**< file descriptor for device. */
 120     mraa_adv_func_t* advance_func; /**< override function table */
 121     /*@}*/
 122 };
 123
 124 /**
 125  * A bitfield representing the capabilities of a pin.
 126  */
 127 typedef struct {
 128     /*@{*/
 129     mraa_boolean_t valid:1;     /**< Is the pin valid at all */
 130     mraa_boolean_t gpio:1;      /**< Is the pin gpio capable */
 131     mraa_boolean_t pwm:1;       /**< Is the pin pwm capable */
 132     mraa_boolean_t fast_gpio:1; /**< Is the pin fast gpio capable */
 133     mraa_boolean_t spi:1;       /**< Is the pin spi capable */
 134     mraa_boolean_t i2c:1;       /**< Is the pin i2c capable */
 135     mraa_boolean_t aio:1;       /**< Is the pin analog input capable */
 136     mraa_boolean_t uart:1;       /**< Is the pin uart capable */
 137     /*@}*/
 138 } mraa_pincapabilities_t;
 139
 140 /**
 141  * A Structure representing a multiplexer and the required value
 142  */
 143 typedef struct {
 144     /*@{*/
 145     unsigned int pin;   /**< Raw GPIO pin id */
 146     unsigned int value; /**< Raw GPIO value */
 147     /*@}*/
 148 } mraa_mux_t;
 149
 150 typedef struct {
 151     mraa_boolean_t complex_pin:1;
 152     mraa_boolean_t output_en:1;
 153     mraa_boolean_t output_en_high:1;
 154     mraa_boolean_t pullup_en:1;
 155     mraa_boolean_t pullup_en_hiz:1;
 156 } mraa_pin_cap_complex_t;
 157
 158 typedef struct {
 159     /*@{*/
 160     unsigned int pinmap; /**< sysfs pin */
 161     unsigned int parent_id; /** parent chip id */
 162     unsigned int mux_total; /** Numfer of muxes needed for operation of pin */
 163     mraa_mux_t mux[6]; /** Array holding information about mux */
 164     unsigned int output_enable; /** Output Enable GPIO, for level shifting */
 165     unsigned int pullup_enable; /** Pull-Up enable GPIO, inputs */
 166     mraa_pin_cap_complex_t complex_cap;
 167     /*@}*/
 168 } mraa_pin_t;
 169
 170 typedef struct {
 171     /*@{*/
 172     char mem_dev[32]; /**< Memory device to use /dev/uio0 etc */
 173     unsigned int mem_sz; /** Size of memory to map */
 174     unsigned int bit_pos; /** Position of value bit */
 175     mraa_pin_t gpio; /** GPio context containing none mmap info */
 176     /*@}*/
 177 } mraa_mmap_pin_t;
 178
 179 /**
 180  * A Structure representing a physical Pin.
 181  */
 182 typedef struct {
 183     /*@{*/
 184     char name[MRAA_PIN_NAME_SIZE]; /**< Pin's real world name */
 185     mraa_pincapabilities_t capabilites; /**< Pin Capabiliites */
 186     mraa_pin_t gpio; /**< GPIO structure */
 187     mraa_pin_t pwm;  /**< PWM structure */
 188     mraa_pin_t aio;  /**< Anaglog Pin */
 189     mraa_mmap_pin_t mmap; /**< GPIO through memory */
 190     mraa_pin_t i2c;  /**< i2c bus/pin */
 191     mraa_pin_t spi;  /**< spi bus/pin */
 192     mraa_pin_t uart;  /**< uart module/pin */
 193     /*@}*/
 194 } mraa_pininfo_t;
 195
 196 /**
 197  * A Structure representing the physical properties of a i2c bus.
 198  */
 199 typedef struct {
 200     /*@{*/
 201     unsigned int bus_id; /**< ID as exposed in the system */
 202     unsigned int scl; /**< i2c SCL */
 203     unsigned int sda; /**< i2c SDA */
 204     // mraa_drv_api_t drv_type; /**< Driver type */
 205     /*@}*/
 206 } mraa_i2c_bus_t;
 207
 208 /**
 209  * A Structure representing the physical properties of a spi bus.
 210  */
 211 typedef struct {
 212     /*@{*/
 213     unsigned int bus_id; /**< The Bus ID as exposed to the system. */
 214     unsigned int slave_s; /**< Slave select */
 215     mraa_boolean_t three_wire; /**< Is the bus only a three wire system */
 216     unsigned int sclk; /**< Serial Clock */
 217     unsigned int mosi; /**< Master Out, Slave In. */
 218     unsigned int miso; /**< Master In, Slave Out. */
 219     unsigned int cs; /**< Chip Select, used when the board is a spi slave */
 220     /*@}*/
 221 } mraa_spi_bus_t;
 222
 223 /**
 224  * A Structure representing a uart device.
 225  */
 226 typedef struct {
 227     /*@{*/
 228     unsigned int index; /**< ID as exposed in the system */
 229     int rx; /**< uart rx */
 230     int tx; /**< uart tx */
 231     const char* device_path; /**< To store "/dev/ttyS1" for example */
 232     /*@}*/
 233 } mraa_uart_dev_t;
 234
 235 /**
 236  * A Structure representing a platform/board.
 237  */
 238
 239 typedef struct _board_t {
 240     /*@{*/
 241     unsigned int phy_pin_count; /**< The Total IO pins on board */
 242     unsigned int gpio_count; /**< GPIO Count */
 243     unsigned int aio_count;  /**< Analog side Count */
 244     unsigned int i2c_bus_count; /**< Usable i2c Count */
 245     mraa_i2c_bus_t  i2c_bus[12]; /**< Array of i2c */
 246     unsigned int def_i2c_bus; /**< Position in array of default i2c bus */
 247     unsigned int spi_bus_count; /**< Usable spi Count */
 248     mraa_spi_bus_t spi_bus[12];       /**< Array of spi */
 249     unsigned int def_spi_bus; /**< Position in array of defult spi bus */
 250     unsigned int adc_raw; /**< ADC raw bit value */
 251     unsigned int adc_supported; /**< ADC supported bit value */
 252     unsigned int def_uart_dev; /**< Position in array of defult uart */
 253     unsigned int uart_dev_count; /**< Usable spi Count */
 254     mraa_uart_dev_t uart_dev[6]; /**< Array of UARTs */
 255     int pwm_default_period; /**< The default PWM period is US */
 256     int pwm_max_period; /**< Maximum period in us */
 257     int pwm_min_period; /**< Minimum period in us */
 258     mraa_platform_t platform_type; /**< Platform type */
 259     const char* platform_name; /**< Platform Name pointer */
 260     mraa_pininfo_t* pins;     /**< Pointer to pin array */
 261     mraa_adv_func_t* adv_func;    /**< Pointer to advanced function disptach table */
 262     struct _board_t* sub_platform;     /**< Pointer to sub platform */
 263     /*@}*/
 264 } mraa_board_t;
 265
 266