Private
Public Access
2
0

spi.hpp: Add C++ wrapper around Spi

* maa_spi_context becomes an opaque pointer
* C++ wrapper class Spi created
* swig now uses C++ wrapper Gpio to generate API

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll
2014-05-16 14:10:29 +01:00
parent 41f619048d
commit d0240cd50a
6 changed files with 94 additions and 61 deletions

View File

@@ -40,20 +40,13 @@ extern "C" {
#include "maa.h"
/**
* A strucutre representing the SPI device
*/
typedef struct {
/*@{*/
int spifd; /**< File descriptor to SPI Device */
/*@}*/
} maa_spi_context;
typedef struct _spi* 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();
maa_spi_context maa_spi_init();
/** Set the SPI device mode. see spidev
*
@@ -62,7 +55,7 @@ maa_spi_context* maa_spi_init();
*
* @return maa_spi_context The returned initialised SPI context
*/
maa_result_t maa_spi_mode(maa_spi_context* spi,unsigned short mode);
maa_result_t maa_spi_mode(maa_spi_context dev,unsigned short mode);
/** Set the SPI device operating clock frequency.
*
@@ -71,7 +64,7 @@ maa_result_t maa_spi_mode(maa_spi_context* spi,unsigned short mode);
*
* @return maa_spi_context The returned initialised SPI context
*/
maa_result_t maa_spi_frequency(maa_spi_context* spi, int hz);
maa_result_t maa_spi_frequency(maa_spi_context dev, int hz);
/** Write Single Byte to the SPI device.
*
@@ -80,7 +73,7 @@ maa_result_t maa_spi_frequency(maa_spi_context* spi, int hz);
*
* @return data received on the miso line.
*/
uint8_t maa_spi_write(maa_spi_context* spi, uint8_t data);
uint8_t maa_spi_write(maa_spi_context dev, uint8_t data);
/** Write Buffer of bytes to the SPI device.
*
@@ -90,7 +83,7 @@ uint8_t maa_spi_write(maa_spi_context* spi, uint8_t data);
*
* @return data received on the miso line. Same length as passed in.
*/
uint8_t* maa_spi_write_buf(maa_spi_context* spi, uint8_t data[], int length);
uint8_t* maa_spi_write_buf(maa_spi_context dev, uint8_t* data, int length);
/** De-inits an maa_spi_context device
@@ -99,7 +92,7 @@ uint8_t* maa_spi_write_buf(maa_spi_context* spi, uint8_t data[], int length);
*
* @return maa_result_t the maa result.
*/
maa_result_t maa_spi_stop(maa_spi_context* spi);
maa_result_t maa_spi_stop(maa_spi_context dev);
#ifdef __cplusplus
}

60
api/spi.hpp Normal file
View File

@@ -0,0 +1,60 @@
/*
* Author: Brendan Le Foll <brendan.le.foll@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 C++ interface for libmaa
*/
#include "spi.h"
namespace maa {
class Spi {
public:
Spi() {
m_spi = maa_spi_init();
}
~Spi() {
maa_spi_stop(m_spi);
}
maa_result_t mode(unsigned short mode) {
return maa_spi_mode(m_spi, mode);
}
maa_result_t frequency(int hz) {
return maa_spi_frequency(m_spi, hz);
}
uint8_t write(uint8_t data) {
return maa_spi_write(m_spi, data);
}
uint8_t* write_buf(uint8_t* data, int length) {
return maa_spi_write_buf(m_spi, data, length);
}
private:
maa_spi_context m_spi;
};
}