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