mraa/include/mraa_internal.h

/*
 * Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
 * Copyright (c) 2014 Intel Corporation.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#pragma once

#include "common.h"
#include "mraa_adv_func.h"
#include "mraa_internal_types.h"

/** Setup gpio
 *
 * Will check input is valid for gpio and will also setup required multiplexers.
 * @param pin the pin as read from the board surface. i.e IO3 would be 3/
 * @return the pin as found in the pinmap
 */
unsigned int mraa_setup_gpio(int pin);

/** Setup Analog interface
 *
 * Will check input is valid for aio and will also setup required multiplexers.
 * @param pin the pin as read from the board surface. i.e A3 would be 3/
 * @return the pin as found in the pinmap
 */
unsigned int mraa_setup_aio(int pin);

/** Setup i2c interface, sets up multiplexer on device.
 *
 * @return unsigned int if using /dev/i2c-2 returned would be 2
 */
unsigned int mraa_setup_i2c(int bus);

/** Setup spi interface, sets up multiplexer on device.
 *
 * @return spi bus type
 */
mraa_spi_bus_t* mraa_setup_spi(int bus);

/** Setup PWM
 *
 * Will check input is valid for pwm and will also setup required multiplexers.
 * IF the pin also does gpio (strong chance), DO NOTHING, REV D quirk
 * @param pin the pin as read from the board surface.
 * @return the pwm pin_info_t of that IO pin
 */
mraa_pin_t* mraa_setup_pwm(int pin);

/** Setup gpio mux to go straight to SoC, galileo.
 *
 * @param pin physical pin to use
 * @return mraa_mmap_pin_t
 */
mraa_mmap_pin_t* mraa_setup_mmap_gpio(int pin);

/** Swap Directional mode.
 *
 * @param pin physical pin to operate on
 * @return out direction to setup. 1 for output 0 for input
 */
mraa_result_t mraa_swap_complex_gpio(int pin, int out);

/** Get the advance structure.
 *
 * @return struct containing internal advance information for hooks
 */
mraa_adv_func* mraa_get_advance();