include/mraa_internal.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_adv_func.h"
  29 #include "mraa_internal_types.h"
  30
  31 /** Setup gpio
  32  *
  33  * Will check input is valid for gpio and will also setup required multiplexers.
  34  * @param pin the pin as read from the board surface. i.e IO3 would be 3/
  35  * @return the pin as found in the pinmap
  36  */
  37 unsigned int mraa_setup_gpio(int pin);
  38
  39 /** Setup Analog interface
  40  *
  41  * Will check input is valid for aio and will also setup required multiplexers.
  42  * @param pin the pin as read from the board surface. i.e A3 would be 3/
  43  * @return the pin as found in the pinmap
  44  */
  45 unsigned int mraa_setup_aio(int pin);
  46
  47 /** Setup i2c interface, sets up multiplexer on device.
  48  *
  49  * @return unsigned int if using /dev/i2c-2 returned would be 2
  50  */
  51 unsigned int mraa_setup_i2c(int bus);
  52
  53 /** Setup spi interface, sets up multiplexer on device.
  54  *
  55  * @return spi bus type
  56  */
  57 mraa_spi_bus_t* mraa_setup_spi(int bus);
  58
  59 /** Setup PWM
  60  *
  61  * Will check input is valid for pwm and will also setup required multiplexers.
  62  * IF the pin also does gpio (strong chance), DO NOTHING, REV D quirk
  63  * @param pin the pin as read from the board surface.
  64  * @return the pwm pin_info_t of that IO pin
  65  */
  66 mraa_pin_t* mraa_setup_pwm(int pin);
  67
  68 /** Setup gpio mux to go straight to SoC, galileo.
  69  *
  70  * @param pin physical pin to use
  71  * @return mraa_mmap_pin_t
  72  */
  73 mraa_mmap_pin_t* mraa_setup_mmap_gpio(int pin);
  74
  75 /** Swap Directional mode.
  76  *
  77  * @param pin physical pin to operate on
  78  * @return out direction to setup. 1 for output 0 for input
  79  */
  80 mraa_result_t mraa_swap_complex_gpio(int pin, int out);
  81
  82 /** Get the advance structure.
  83  *
  84  * @return struct containing internal advance information for hooks
  85  */
  86 mraa_adv_func* mraa_get_advance();