include/mraa_adv_func.h

   1 /*
   2  * Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
   3  * Copyright (c) 2014 Intel Corporation.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 #pragma once
  26
  27 #include "common.h"
  28 #include "mraa.h"
  29 #include "types.h"
  30
  31 // FIXME: Nasty macro to test for presence of function in context structure function table
  32 #define IS_FUNC_DEFINED(dev, func)   (dev != NULL && dev->advance_func != NULL && dev->advance_func->func != NULL)
  33
  34 typedef struct {
  35     mraa_result_t (*gpio_init_internal_replace) (int pin);
  36     mraa_result_t (*gpio_init_pre) (int pin);
  37     mraa_result_t (*gpio_init_post) (mraa_gpio_context dev);
  38
  39     mraa_result_t (*gpio_close_pre) (mraa_gpio_context dev);
  40
  41     mraa_result_t (*gpio_mode_replace) (mraa_gpio_context dev, mraa_gpio_mode_t mode);
  42     mraa_result_t (*gpio_mode_pre) (mraa_gpio_context dev, mraa_gpio_mode_t mode);
  43     mraa_result_t (*gpio_mode_post) (mraa_gpio_context dev, mraa_gpio_mode_t mode);
  44
  45     mraa_result_t (*gpio_edge_mode_replace) (mraa_gpio_context dev, mraa_gpio_edge_t mode);
  46
  47     mraa_result_t (*gpio_dir_replace) (mraa_gpio_context dev, mraa_gpio_dir_t dir);
  48     mraa_result_t (*gpio_dir_pre) (mraa_gpio_context dev, mraa_gpio_dir_t dir);
  49     mraa_result_t (*gpio_dir_post) (mraa_gpio_context dev, mraa_gpio_dir_t dir);
  50
  51     int (*gpio_read_replace) (mraa_gpio_context dev);
  52     mraa_result_t (*gpio_write_replace) (mraa_gpio_context dev, int value);
  53     mraa_result_t (*gpio_write_pre) (mraa_gpio_context dev, int value);
  54     mraa_result_t (*gpio_write_post) (mraa_gpio_context dev, int value);
  55     mraa_result_t (*gpio_mmap_setup) (mraa_gpio_context dev, mraa_boolean_t en);
  56     void* (*gpio_interrupt_handler_replace) (mraa_gpio_context dev);
  57
  58     mraa_result_t (*i2c_init_pre) (unsigned int bus);
  59     mraa_result_t (*i2c_init_bus_replace) (mraa_i2c_context dev);
  60     mraa_i2c_context (*i2c_init_raw_replace) (unsigned int bus);
  61     mraa_result_t (*i2c_init_post) (mraa_i2c_context dev);
  62     mraa_result_t (*i2c_set_frequency_replace) (mraa_i2c_context dev, mraa_i2c_mode_t mode);
  63     mraa_result_t (*i2c_address_replace) (mraa_i2c_context dev, uint8_t addr);
  64     int (*i2c_read_replace) (mraa_i2c_context dev, uint8_t* data, int length);
  65     uint8_t (*i2c_read_byte_replace) (mraa_i2c_context dev);
  66     uint8_t (*i2c_read_byte_data_replace) (mraa_i2c_context dev, const uint8_t command);
  67     uint16_t (*i2c_read_word_data_replace) (mraa_i2c_context dev, const uint8_t command);
  68     int (*i2c_read_bytes_data_replace) (mraa_i2c_context dev, uint8_t command, uint8_t* data, int length);
  69     mraa_result_t (*i2c_write_replace) (mraa_i2c_context dev, const uint8_t* data, int length);
  70     mraa_result_t (*i2c_write_byte_replace) (mraa_i2c_context dev, uint8_t data);
  71     mraa_result_t (*i2c_write_byte_data_replace) (mraa_i2c_context dev, const uint8_t data, const uint8_t command);
  72     mraa_result_t (*i2c_write_word_data_replace) (mraa_i2c_context dev, const uint16_t data, const uint8_t command);
  73     mraa_result_t (*i2c_stop_replace) (mraa_i2c_context dev);
  74
  75     mraa_result_t (*aio_get_valid_fp) (mraa_aio_context dev);
  76     mraa_result_t (*aio_init_pre) (unsigned int aio);
  77     mraa_result_t (*aio_init_post) (mraa_aio_context dev);
  78
  79     mraa_pwm_context (*pwm_init_replace) (int pin);
  80     mraa_result_t (*pwm_init_pre) (int pin);
  81     mraa_result_t (*pwm_init_post) (mraa_pwm_context pwm);
  82     mraa_result_t (*pwm_period_replace) (mraa_pwm_context dev, int period);
  83
  84     mraa_result_t (*spi_init_pre) (int bus);
  85     mraa_result_t (*spi_init_post) (mraa_spi_context spi);
  86     mraa_result_t (*spi_lsbmode_replace) (mraa_spi_context dev, mraa_boolean_t lsb);
  87
  88     mraa_result_t (*uart_init_pre) (int index);
  89     mraa_result_t (*uart_init_post) (mraa_uart_context uart);
  90 } mraa_adv_func_t;