2 * Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
3 * Copyright (c) 2014 Intel Corporation.
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:
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
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.
32 #include "mraa_internal_types.h"
33 #include "mraa_adv_func.h"
35 extern mraa_adv_func_t* advance_func;
39 * Will check input is valid for gpio and will also setup required multiplexers.
40 * @param pin the pin as read from the board surface. i.e IO3 would be 3/
41 * @return the pin as found in the pinmap
43 unsigned int mraa_setup_gpio(int pin);
45 /** Setup Analog interface
47 * Will check input is valid for aio and will also setup required multiplexers.
48 * @param pin the pin as read from the board surface. i.e A3 would be 3/
49 * @return the pin as found in the pinmap
51 unsigned int mraa_setup_aio(int pin);
53 /** Setup i2c interface, sets up multiplexer on device.
55 * @return unsigned int if using /dev/i2c-2 returned would be 2
57 unsigned int mraa_setup_i2c(int bus);
59 /** Setup spi interface, sets up multiplexer on device.
61 * @return spi bus type
63 mraa_spi_bus_t* mraa_setup_spi(int bus);
67 * Will check input is valid for pwm and will also setup required multiplexers.
68 * IF the pin also does gpio (strong chance), DO NOTHING, REV D quirk
69 * @param pin the pin as read from the board surface.
70 * @return the pwm pin_info_t of that IO pin
72 mraa_pin_t* mraa_setup_pwm(int pin);
74 /** Setup gpio mux to go straight to SoC, galileo.
76 * @param pin physical pin to use
77 * @return mraa_mmap_pin_t
79 mraa_mmap_pin_t* mraa_setup_mmap_gpio(int pin);
81 /** Swap Directional mode.
83 * @param pin physical pin to operate on
84 * @return out direction to setup. 1 for output 0 for input
86 mraa_result_t mraa_swap_complex_gpio(int pin, int out);
88 /** Setup uart muxes to exposes the pins physically.
90 * @param index of the uart in the board definition to expose physically
91 * @return mraa_result_t of operation
93 mraa_result_t mraa_setup_uart(int index);