maa: add maa internal header.
authorThomas Ingleby <thomas.c.ingleby@intel.com>
Wed, 21 May 2014 11:52:38 +0000 (12:52 +0100)
committerThomas Ingleby <thomas.c.ingleby@intel.com>
Wed, 21 May 2014 11:52:38 +0000 (12:52 +0100)
For internal functions and data definitions.

Signed-off-by: Thomas Ingleby <thomas.c.ingleby@intel.com>
include/maa_internal.h [new file with mode: 0644]
src/CMakeLists.txt

diff --git a/include/maa_internal.h b/include/maa_internal.h
new file mode 100644 (file)
index 0000000..a3944ca
--- /dev/null
@@ -0,0 +1,64 @@
+/*
+ * 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 "maa.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 maa_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 maa_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 maa_setup_i2c();
+
+/** Setup spi interface, sets up multiplexer on device.
+ *
+ * @return spi bus type
+ */
+maa_spi_bus_t* maa_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
+ */
+maa_pin_t* maa_setup_pwm(int pin);
index 1de9c0e..ceba12c 100644 (file)
@@ -18,6 +18,7 @@ set (maa_LIB_HEADERS
   ${PROJECT_SOURCE_DIR}/include/smbus.h
   ${PROJECT_SOURCE_DIR}/include/version.h
   ${PROJECT_SOURCE_DIR}/include/intel_galileo_rev_d.h
+  ${PROJECT_SOURCE_DIR}/include/maa_internal.h
 )
 
 set (maa_LIB_KERNEL