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 <stdint.h>
#include "types.h"

#define MRAA_PLATFORM_NAME_MAX_SIZE 64
#define MRAA_PIN_NAME_SIZE 12

#define MRAA_SUB_PLATFORM_BIT_SHIFT 9
#define MRAA_SUB_PLATFORM_MASK (1<<MRAA_SUB_PLATFORM_BIT_SHIFT)

#define MRAA_MAIN_PLATFORM_OFFSET 0
#define MRAA_SUB_PLATFORM_OFFSET 1

#define MRAA_RETURN_FOR_ERROR(func) do { \
                                      mraa_result_t res; \
                                      res = func; \
                                      if (res != MRAA_SUCCESS) \
                                      return res;} while(0)

#ifdef __cplusplus
extern "C" {
#endif

typedef unsigned int mraa_boolean_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_get_platform_adc_raw_bits(uint8_t platform_offset);

unsigned int mraa_adc_supported_bits();

unsigned int mraa_get_platform_adc_supported_bits(int platform_offset);

mraa_result_t mraa_set_log_level(int level);

const char* mraa_get_platform_name();

const char* mraa_get_platform_version(int platform_offset);

int mraa_set_priority(const unsigned int priority);

const char* mraa_get_version();

void mraa_result_print(mraa_result_t result);

mraa_platform_t mraa_get_platform_type();

int mraa_get_platform_combined_type();

unsigned int mraa_get_pin_count();

int mraa_get_i2c_bus_count();

int mraa_get_i2c_bus_id(unsigned int i2c_bus);

unsigned int mraa_get_platform_pin_count(uint8_t platform_offset);

char* mraa_get_pin_name(int pin);

int mraa_get_default_i2c_bus(uint8_t platform_offset);

mraa_boolean_t mraa_has_sub_platform();


mraa_boolean_t mraa_is_sub_platform_id(int pin_or_bus_id);

int mraa_get_sub_platform_id(int pin_or_bus_index);

int mraa_get_sub_platform_index(int pin_or_bus_id);

mraa_result_t mraa_add_subplatform(mraa_platform_t subplatformtype, const char* uart_dev);

mraa_result_t mraa_remove_subplatform(mraa_platform_t subplatformtype);

#ifdef __cplusplus
}
#endif