common.h

Go to the documentation of this file.

/*
 * Author: Brendan Le Foll <brendan.le.foll@intel.com>
 * Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
 * Copyright © 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

#include "types.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef unsigned int mraa_boolean_t;

typedef enum {
    MRAA_PIN_VALID       = 0, 
    MRAA_PIN_GPIO        = 1, 
    MRAA_PIN_PWM         = 2, 
    MRAA_PIN_FAST_GPIO   = 3, 
    MRAA_PIN_SPI         = 4, 
    MRAA_PIN_I2C         = 5, 
    MRAA_PIN_AIO         = 6, 
    MRAA_PIN_UART        = 7  
} mraa_pinmodes_t;

typedef struct {
    mraa_boolean_t valid:1;     
    mraa_boolean_t gpio:1;      
    mraa_boolean_t pwm:1;       
    mraa_boolean_t fast_gpio:1; 
    mraa_boolean_t spi:1;       
    mraa_boolean_t i2c:1;       
    mraa_boolean_t aio:1;       
    mraa_boolean_t uart:1;       
} mraa_pincapabilities_t;

typedef struct {
    unsigned int pin;   
    unsigned int value; 
} mraa_mux_t;

typedef struct {
    mraa_boolean_t complex_pin:1;
    mraa_boolean_t output_en:1;
    mraa_boolean_t output_en_high:1;
    mraa_boolean_t pullup_en:1;
    mraa_boolean_t pullup_en_hiz:1;
} mraa_pin_cap_complex_t;

typedef struct {
    unsigned int pinmap; 
    unsigned int parent_id; 
    unsigned int mux_total; 
    mraa_mux_t mux[6]; 
    unsigned int output_enable; 
    unsigned int pullup_enable; 
    mraa_pin_cap_complex_t complex_cap;
} mraa_pin_t;

typedef struct {
    char mem_dev[32]; 
    unsigned int mem_sz; 
    unsigned int bit_pos; 
    mraa_pin_t gpio; 
} mraa_mmap_pin_t;

typedef struct {
    char name[8];                      
    mraa_pincapabilities_t capabilites; 
    mraa_pin_t gpio; 
    mraa_pin_t pwm;  
    mraa_pin_t aio;  
    mraa_mmap_pin_t mmap; 
    mraa_pin_t i2c;  
    mraa_pin_t spi;  
    mraa_pin_t uart;  
} mraa_pininfo_t;

typedef struct {
    unsigned int bus_id; 
    unsigned int scl; 
    unsigned int sda; 
} mraa_i2c_bus_t;

typedef struct {
    unsigned int bus_id; 
    unsigned int slave_s; 
    mraa_boolean_t three_wire; 
    unsigned int sclk; 
    unsigned int mosi; 
    unsigned int miso; 
    unsigned int cs; 
} mraa_spi_bus_t;

typedef struct {
    unsigned int index; 
    int rx; 
    int tx; 
} mraa_uart_dev_t;

typedef struct {
    unsigned int phy_pin_count; 
    unsigned int gpio_count; 
    unsigned int aio_count;  
    unsigned int i2c_bus_count; 
    mraa_i2c_bus_t  i2c_bus[6]; 
    unsigned int def_i2c_bus; 
    unsigned int spi_bus_count; 
    mraa_spi_bus_t spi_bus[6];       
    unsigned int def_spi_bus; 
    unsigned int adc_raw; 
    unsigned int adc_supported; 
    unsigned int def_uart_dev; 
    unsigned int uart_dev_count; 
    mraa_uart_dev_t uart_dev[6]; 
    mraa_pininfo_t* pins;     
} mraa_board_t;

#if (defined SWIGPYTHON) || (defined SWIG)
mraa_result_t mraa_init();
#else
// this sets a compiler attribute (supported by GCC & clang) to have mraa_init()
// be called as a constructor make sure your libc supports this!  uclibc needs
// to be compiled with UCLIBC_CTOR_DTOR
mraa_result_t mraa_init() __attribute__((constructor));
#endif

void mraa_deinit();

mraa_boolean_t mraa_pin_mode_test(int pin, mraa_pinmodes_t mode);

unsigned int mraa_adc_raw_bits();

unsigned int mraa_adc_supported_bits();

#ifdef __cplusplus
}
#endif