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.
34 #include "mraa_internal_types.h"
35 #include "mraa_adv_func.h"
37 extern mraa_adv_func_t* advance_func;
38 extern mraa_board_t* plat;
41 * Takes in pin information and sets up the multiplexors.
44 * @return mraa result type indicating success of actions.
46 mraa_result_t mraa_setup_mux_mapped(mraa_pin_t meta);
49 * Will check input is valid for gpio and will also setup required multiplexers.
50 * @param pin the pin as read from the board surface. i.e IO3 would be 3/
51 * @return the pin as found in the pinmap
53 unsigned int mraa_setup_gpio(int pin);
56 * Will check input is valid for aio and will also setup required multiplexers.
57 * @param pin the pin as read from the board surface. i.e A3 would be 3/
58 * @return the pin as found in the pinmap
60 unsigned int mraa_setup_aio(int pin);
63 * Setup i2c interface, sets up multiplexer on device.
65 * @return unsigned int if using /dev/i2c-2 returned would be 2
67 unsigned int mraa_setup_i2c(int* bus);
69 /** Setup spi interface, sets up multiplexer on device.
71 * @return spi bus type
73 mraa_spi_bus_t* mraa_setup_spi(int bus);
76 * Will check input is valid for pwm and will also setup required multiplexers.
77 * IF the pin also does gpio (strong chance), DO NOTHING, REV D quirk
78 * @param pin the pin as read from the board surface.
79 * @return the pwm pin_info_t of that IO pin
81 mraa_pin_t* mraa_setup_pwm(int pin);
84 * Setup gpio mux to go straight to SoC, galileo.
86 * @param pin physical pin to use
87 * @return mraa_mmap_pin_t
89 mraa_mmap_pin_t* mraa_setup_mmap_gpio(int pin);
92 * Swap Directional mode.
94 * @param pin physical pin to operate on
95 * @return out direction to setup. 1 for output 0 for input
97 mraa_result_t mraa_swap_complex_gpio(int pin, int out);
100 * Setup uart muxes to exposes the pins physically.
102 * @param index of the uart in the board definition to expose physically
103 * @return mraa_result_t of operation
105 mraa_result_t mraa_setup_uart(int index);