Merge branch 'tingleby-spi-new'

api/spi.h

@@ -0,0 +1,86 @@
+/*
+ * 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
+
+/** @file
+ *
+ * This file defines the spi interface for libmaa
+ *
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stdio.h>
+#include <fcntl.h>
+
+#include "maa.h"
+
+/**
+ * A strucutre representing the SPI device
+ */
+typedef struct {
+    /*@{*/
+    int spifd; /**< File descriptor to SPI Device */
+    /*@}*/
+} maa_spi_context;
+
+/** Initialise SPI_context, uses board mapping. Sets the muxes
+ *
+ * @return maa_spi_context The returned initialised SPI context
+ */
+maa_spi_context* maa_spi_init();
+
+/** Set the SPI device mode. see spidev
+ *
+ * @param spi the spi device context
+ * @param mode the mode. See Linux spidev
+ *
+ * @return maa_spi_context The returned initialised SPI context
+ */
+maa_result_t maa_spi_mode(maa_spi_context* spi,unsigned short mode);
+
+/** Set the SPI device operating clock frequency.
+ *
+ * @param spi the spid device clock frequency
+ * @param hz the frequency in hz
+ *
+ * @return maa_spi_context The returned initialised SPI context
+ */
+maa_result_t maa_spi_frequency(maa_spi_context* spi, int hz);
+
+/** Write to the SPI device.
+ *
+ * @param spi the spid device clock frequency
+ * @param data to send
+ *
+ * @return data recevied on the miso line.
+ */
+unsigned int maa_spi_write(maa_spi_context* spi, unsigned int data);
+
+#ifdef __cplusplus
+}
+#endif

src/CMakeLists.txt

@@ -8,6 +8,7 @@ set (maa_LIB_HEADERS
   ${PROJECT_SOURCE_DIR}/api/gpio.h
   ${PROJECT_SOURCE_DIR}/api/i2c.h
   ${PROJECT_SOURCE_DIR}/api/pwm.h
+  ${PROJECT_SOURCE_DIR}/api/spi.h
   ${PROJECT_SOURCE_DIR}/include/smbus.h
   ${PROJECT_SOURCE_DIR}/include/version.h
 )
@@ -25,6 +26,7 @@ set (maa_LIB_SRCS
   ${PROJECT_SOURCE_DIR}/src/i2c/i2c.c
   ${PROJECT_SOURCE_DIR}/src/i2c/smbus.c
   ${PROJECT_SOURCE_DIR}/src/pwm/pwm.c
+  ${PROJECT_SOURCE_DIR}/src/spi/spi.c
 # autogenerated version file
   ${CMAKE_CURRENT_BINARY_DIR}/version.c
 )

src/maa.i

@@ -3,9 +3,11 @@
     #include "gpio.h"
     #include "pwm.h"
     #include "i2c.h"
+    #include "spi.h"
 %}
 
 %include "maa.h"
 %include "gpio.h"
 %include "pwm.h"
 %include "i2c.h"
+%include "spi.h"

src/spi/spi.c

@@ -0,0 +1,51 @@
+/*
+ * 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.
+ */
+
+#include <stdlib.h>
+
+#include "spi.h"
+
+maa_spi_context*
+maa_spi_init()
+{
+    return NULL;
+}
+
+maa_result_t
+maa_spi_mode(maa_spi_context* spi, unsigned short mode)
+{
+    return MAA_ERROR_FEATURE_NOT_IMPLEMENTED;
+}
+
+maa_result_t
+maa_spi_frequency(maa_spi_context* spi, int hz)
+{
+    return MAA_ERROR_FEATURE_NOT_IMPLEMENTED;
+}
+
+unsigned int
+maa_spi_write(maa_spi_context* spi, unsigned int data)
+{
+    return 0;
+}