Linux: Add support for SPIDEV (#734)

RPi and Linux refactor. Add GPIO Sysfs for GPIO operations. Update configure script. Fix some cppcheck warnings. Add serial emulation that prints to stdout. Fix some file headers.
2017-01-14 23:50:21 +01:00
parent aa5cecfca1
commit 2e0f6b6229
43 changed files with 1574 additions and 593 deletions
@@ -0,0 +1,107 @@
+/*
+ * The MySensors Arduino library handles the wireless radio link and protocol
+ * between your home built sensors/actuators and HA controller of choice.
+ * The sensors forms a self healing radio network with optional repeaters. Each
+ * repeater and gateway builds a routing tables in EEPROM which keeps track of the
+ * network topology allowing messages to be routed to nodes.
+ *
+ * Created by Henrik Ekblad <henrik.ekblad@mysensors.org>
+ * Copyright (C) 2013-2017 Sensnology AB
+ * Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
+ *
+ * Documentation: http://www.mysensors.org
+ * Support Forum: http://forum.mysensors.org
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * version 2 as published by the Free Software Foundation.
+ *
+ * Based on TMRh20 RF24 library, Copyright (c) 2015 Charles-Henri Hallard <tmrh20@gmail.com>
+ */
+
+#include "SPI.h"
+#include <pthread.h>
+#include <stdlib.h>
+#include "log.h"
+
+static pthread_mutex_t spiMutex = PTHREAD_MUTEX_INITIALIZER;
+
+// Declare a single default instance
+SPIClass SPI = SPIClass();
+
+uint8_t SPIClass::initialized = 0;
+
+void SPIClass::begin()
+{
+	if (!initialized) {
+		if (!bcm2835_spi_begin()) {
+			logError("You need root privilege to use SPI.\n");
+			exit(1);
+		}
+	}
+
+	initialized++; // reference count
+}
+
+void SPIClass::end()
+{
+	if (initialized) {
+		initialized--;
+	}
+
+	if (!initialized) {
+		// End the SPI
+		bcm2835_spi_end();
+	}
+}
+
+void SPIClass::setBitOrder(uint8_t bit_order)
+{
+	bcm2835_spi_setBitOrder(bit_order);
+}
+
+void SPIClass::setDataMode(uint8_t data_mode)
+{
+	bcm2835_spi_setDataMode(data_mode);
+}
+
+void SPIClass::setClockDivider(uint16_t divider)
+{
+	bcm2835_spi_setClockDivider(divider);
+}
+
+void SPIClass::chipSelect(int csn_pin)
+{
+	if (csn_pin == RPI_GPIO_P1_26) {
+		csn_pin = BCM2835_SPI_CS1;
+	} else if (csn_pin == RPI_GPIO_P1_24) {
+		csn_pin = BCM2835_SPI_CS0;
+	} else {
+		csn_pin = BCM2835_SPI_CS0;
+	}
+	bcm2835_spi_chipSelect(csn_pin);
+	delayMicroseconds(5);
+}
+
+void SPIClass::beginTransaction(SPISettings settings)
+{
+	pthread_mutex_lock(&spiMutex);
+	setBitOrder(settings.border);
+	setDataMode(settings.dmode);
+	setClockDivider(settings.cdiv);
+}
+
+void SPIClass::endTransaction()
+{
+	pthread_mutex_unlock(&spiMutex);
+}
+
+void SPIClass::usingInterrupt(uint8_t interruptNumber)
+{
+	(void)interruptNumber;
+}
+
+void SPIClass::notUsingInterrupt(uint8_t interruptNumber)
+{
+	(void)interruptNumber;
+}
@@ -0,0 +1,262 @@
+/*
+ * The MySensors Arduino library handles the wireless radio link and protocol
+ * between your home built sensors/actuators and HA controller of choice.
+ * The sensors forms a self healing radio network with optional repeaters. Each
+ * repeater and gateway builds a routing tables in EEPROM which keeps track of the
+ * network topology allowing messages to be routed to nodes.
+ *
+ * Created by Henrik Ekblad <henrik.ekblad@mysensors.org>
+ * Copyright (C) 2013-2017 Sensnology AB
+ * Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
+ *
+ * Documentation: http://www.mysensors.org
+ * Support Forum: http://forum.mysensors.org
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * version 2 as published by the Free Software Foundation.
+ *
+ * Based on TMRh20 RF24 library, Copyright (c) 2015 Charles-Henri Hallard <tmrh20@gmail.com>
+ */
+
+#ifndef _SPI_H_
+#define _SPI_H_
+
+#include <stdio.h>
+#include "bcm2835.h"
+#include "RPi.h"
+
+#define SPI_HAS_TRANSACTION
+
+#define SPI_CLOCK_BASE 256000000
+
+// SPI Clock divider
+#define SPI_CLOCK_DIV1 BCM2835_SPI_CLOCK_DIVIDER_1
+#define SPI_CLOCK_DIV2 BCM2835_SPI_CLOCK_DIVIDER_2
+#define SPI_CLOCK_DIV4 BCM2835_SPI_CLOCK_DIVIDER_4
+#define SPI_CLOCK_DIV8 BCM2835_SPI_CLOCK_DIVIDER_8
+#define SPI_CLOCK_DIV16 BCM2835_SPI_CLOCK_DIVIDER_16
+#define SPI_CLOCK_DIV32 BCM2835_SPI_CLOCK_DIVIDER_32
+#define SPI_CLOCK_DIV64 BCM2835_SPI_CLOCK_DIVIDER_64
+#define SPI_CLOCK_DIV128 BCM2835_SPI_CLOCK_DIVIDER_128
+#define SPI_CLOCK_DIV256 BCM2835_SPI_CLOCK_DIVIDER_256
+#define SPI_CLOCK_DIV512 BCM2835_SPI_CLOCK_DIVIDER_512
+#define SPI_CLOCK_DIV1024 BCM2835_SPI_CLOCK_DIVIDER_1024
+#define SPI_CLOCK_DIV2048 BCM2835_SPI_CLOCK_DIVIDER_2048
+#define SPI_CLOCK_DIV4096 BCM2835_SPI_CLOCK_DIVIDER_4096
+#define SPI_CLOCK_DIV8192 BCM2835_SPI_CLOCK_DIVIDER_8192
+#define SPI_CLOCK_DIV16384 BCM2835_SPI_CLOCK_DIVIDER_16384
+#define SPI_CLOCK_DIV32768 BCM2835_SPI_CLOCK_DIVIDER_32768
+#define SPI_CLOCK_DIV65536 BCM2835_SPI_CLOCK_DIVIDER_65536
+
+// SPI Data mode
+#define SPI_MODE0 BCM2835_SPI_MODE0
+#define SPI_MODE1 BCM2835_SPI_MODE1
+#define SPI_MODE2 BCM2835_SPI_MODE2
+#define SPI_MODE3 BCM2835_SPI_MODE3
+
+#define LSBFIRST BCM2835_SPI_BIT_ORDER_LSBFIRST
+#define MSBFIRST BCM2835_SPI_BIT_ORDER_MSBFIRST
+
+const uint8_t SS   = 24;
+const uint8_t MOSI = 19;
+const uint8_t MISO = 21;
+const uint8_t SCK  = 23;
+
+/**
+ * SPISettings class
+ */
+class SPISettings
+{
+
+public:
+	/**
+	 * @brief SPISettings constructor.
+	 *
+	 * Default clock speed is 8Mhz.
+	 */
+	SPISettings()
+	{
+		init(SPI_CLOCK_DIV32, MSBFIRST, SPI_MODE0);
+	}
+	/**
+	 * @brief SPISettings constructor.
+	 *
+	 * @param clock SPI clock speed in Hz.
+	 * @param bitOrder SPI bit order.
+	 * @param dataMode SPI data mode.
+	 */
+	SPISettings(uint32_t clock, uint8_t bitOrder, uint8_t dataMode)
+	{
+		uint16_t divider;
+
+		if (clock >= SPI_CLOCK_BASE) {
+			divider = SPI_CLOCK_DIV1;
+		} else if (clock >= SPI_CLOCK_BASE / 2) {
+			divider = SPI_CLOCK_DIV2;
+		} else if (clock >= SPI_CLOCK_BASE / 4) {
+			divider = SPI_CLOCK_DIV4;
+		} else if (clock >= SPI_CLOCK_BASE / 8) {
+			divider = SPI_CLOCK_DIV8;
+		} else if (clock >= SPI_CLOCK_BASE / 16) {
+			divider = SPI_CLOCK_DIV16;
+		} else if (clock >= SPI_CLOCK_BASE / 32) {
+			divider = SPI_CLOCK_DIV32;
+		} else if (clock >= SPI_CLOCK_BASE / 64) {
+			divider = SPI_CLOCK_DIV64;
+		} else if (clock >= SPI_CLOCK_BASE / 128) {
+			divider = SPI_CLOCK_DIV128;
+		} else if (clock >= SPI_CLOCK_BASE / 256) {
+			divider = SPI_CLOCK_DIV256;
+		} else if (clock >= SPI_CLOCK_BASE / 512) {
+			divider = SPI_CLOCK_DIV512;
+		} else if (clock >= SPI_CLOCK_BASE / 1024) {
+			divider = SPI_CLOCK_DIV1024;
+		} else if (clock >= SPI_CLOCK_BASE / 2048) {
+			divider = SPI_CLOCK_DIV2048;
+		} else if (clock >= SPI_CLOCK_BASE / 4096) {
+			divider = SPI_CLOCK_DIV4096;
+		} else if (clock >= SPI_CLOCK_BASE / 8192) {
+			divider = SPI_CLOCK_DIV8192;
+		} else if (clock >= SPI_CLOCK_BASE / 16384) {
+			divider = SPI_CLOCK_DIV16384;
+		} else if (clock >= SPI_CLOCK_BASE / 32768) {
+			divider = SPI_CLOCK_DIV32768;
+		} else if (clock >= SPI_CLOCK_BASE / 65536) {
+			divider = SPI_CLOCK_DIV65536;
+		} else {
+			// Default to 8Mhz
+			divider = SPI_CLOCK_DIV32;
+		}
+
+		init(divider, bitOrder, dataMode);
+	}
+
+	uint16_t cdiv; //!< @brief SPI clock divider.
+	uint8_t border; //!< @brief SPI bit order.
+	uint8_t dmode; //!< @brief SPI data mode.
+
+private:
+	/**
+	 * @brief Initialized class members.
+	 *
+	 * @param divider SPI clock divider.
+	 * @param bitOrder SPI bit order.
+	 * @param dataMode SPI data mode.
+	 */
+	void init(uint16_t divider, uint8_t bitOrder, uint8_t dataMode)
+	{
+		cdiv = divider;
+		border = bitOrder;
+		dmode = dataMode;
+	}
+
+	friend class SPIClass;
+};
+
+/**
+ * SPIClass class
+ */
+class SPIClass
+{
+
+public:
+	/**
+	 * @brief Send and receive a byte.
+	 *
+	 * @param data to send.
+	 * @return byte received.
+	 */
+	inline static uint8_t transfer(uint8_t data);
+	/**
+	 * @brief Send and receive a number of bytes.
+	 *
+	 * @param tbuf Sending buffer.
+	 * @param rbuf Receive buffer.
+	 * @param len Buffer length.
+	 */
+	inline static void transfernb(char* tbuf, char* rbuf, uint32_t len);
+	/**
+	 * @brief Send and receive a number of bytes.
+	 *
+	 * @param buf Buffer to read from and write to.
+	 * @param len Buffer length.
+	 */
+	inline static void transfern(char* buf, uint32_t len);
+	/**
+	 * @brief Start SPI operations.
+	 */
+	static void begin();
+	/**
+	 * @brief End SPI operations.
+	 */
+	static void end();
+	/**
+	 * @brief Sets the SPI bit order.
+	 *
+	 * @param bit_order The desired bit order.
+	 */
+	static void setBitOrder(uint8_t bit_order);
+	/**
+	 * @brief Sets the SPI data mode.
+	 *
+	 * @param data_mode The desired data mode.
+	 */
+	static void setDataMode(uint8_t data_mode);
+	/**
+	 * @brief Sets the SPI clock divider and therefore the SPI clock speed.
+	 *
+	 * @param divider The desired SPI clock divider.
+	 */
+	static void setClockDivider(uint16_t divider);
+	/**
+	 * @brief Sets the chip select pin.
+	 *
+	 * @param csn_pin Specifies the CS pin.
+	 */
+	static void chipSelect(int csn_pin);
+	/**
+	 * @brief Start SPI transaction.
+	 *
+	 * @param settings for SPI.
+	 */
+	static void beginTransaction(SPISettings settings);
+	/**
+	 * @brief End SPI transaction.
+	 */
+	static void endTransaction();
+	/**
+	 * @brief Not implemented.
+	 *
+	 * @param interruptNumber ignored parameter.
+	 */
+	static void usingInterrupt(uint8_t interruptNumber);
+	/**
+	 * @brief Not implemented.
+	 *
+	 * @param interruptNumber ignored parameter.
+	 */
+	static void notUsingInterrupt(uint8_t interruptNumber);
+
+private:
+	static uint8_t initialized; //!< @brief SPI initialized flag.
+};
+
+uint8_t SPIClass::transfer(uint8_t data)
+{
+	return bcm2835_spi_transfer(data);
+}
+
+void SPIClass::transfernb(char* tbuf, char* rbuf, uint32_t len)
+{
+	bcm2835_spi_transfernb( tbuf, rbuf, len);
+}
+
+void SPIClass::transfern(char* buf, uint32_t len)
+{
+	transfernb(buf, buf, len);
+}
+
+extern SPIClass SPI;
+
+#endif
@@ -0,0 +1,213 @@
+/*
+  TwoWire.h - TWI/I2C library for Arduino & Wiring
+  Copyright (c) 2006 Nicholas Zambetti.  All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+  Modified 2012 by Todd Krein (todd@krein.org) to implement repeated starts
+  Modified December 2014 by Ivan Grokhotkov (ivan@esp8266.com) - esp8266 support
+  Modified April 2015 by Hrsto Gochkov (ficeto@ficeto.com) - alternative esp8266 support
+  Modified October 2016 by Marcelo Aquino <marceloaqno@gmail.org> for Raspberry Pi
+*/
+
+#include "Wire.h"
+#include <stdlib.h>
+#include <pthread.h>
+#include "bcm2835.h"
+#include "log.h"
+
+static pthread_mutex_t i2cMutex = PTHREAD_MUTEX_INITIALIZER;
+
+uint8_t TwoWire::rxBuffer[BUFFER_LENGTH];
+uint8_t TwoWire::rxBufferIndex = 0;
+uint8_t TwoWire::rxBufferLength = 0;
+
+uint8_t TwoWire::txAddress = 0;
+uint8_t TwoWire::txBuffer[BUFFER_LENGTH];
+uint8_t TwoWire::txBufferIndex = 0;
+uint8_t TwoWire::txBufferLength = 0;
+
+uint8_t TwoWire::transmitting = 0;
+
+void TwoWire::begin()
+{
+	if (!bcm2835_i2c_begin()) {
+		logError("You need root privilege to use I2C.\n");
+		exit(1);
+	}
+}
+
+void TwoWire::begin(uint8_t address)
+{
+	begin();
+	bcm2835_i2c_setSlaveAddress(address);
+}
+
+void TwoWire::begin(int address)
+{
+	begin(static_cast<uint8_t>(address));
+}
+
+void TwoWire::end()
+{
+	bcm2835_i2c_end();
+}
+
+void TwoWire::setClock(uint32_t clock)
+{
+	bcm2835_i2c_set_baudrate(clock);
+}
+
+void TwoWire::beginTransmission(uint8_t address)
+{
+	pthread_mutex_lock(&i2cMutex);
+	// indicate that we are transmitting
+	transmitting = 1;
+	// set address of targeted slave
+	txAddress = address;
+	// reset tx buffer iterator vars
+	txBufferIndex = 0;
+	txBufferLength = 0;
+}
+
+void TwoWire::beginTransmission(int address)
+{
+	beginTransmission(static_cast<uint8_t>(address));
+}
+
+uint8_t TwoWire::endTransmission(void)
+{
+	// transmit buffer
+	bcm2835_i2c_setSlaveAddress(txAddress);
+	uint8_t ret = bcm2835_i2c_write(reinterpret_cast<const char *>(txBuffer), txBufferLength);
+
+	// reset tx buffer iterator vars
+	txBufferIndex = 0;
+	txBufferLength = 0;
+	// indicate that we are done transmitting
+	transmitting = 0;
+
+	pthread_mutex_unlock(&i2cMutex);
+
+	if (ret == BCM2835_I2C_REASON_OK) {
+		return 0;	// success
+	} else if (ret == BCM2835_I2C_REASON_ERROR_NACK) {
+		return 3;	// error: data send, nack received
+	}
+	return 4;	// other error
+}
+
+size_t TwoWire::requestFrom(uint8_t address, size_t quantity)
+{
+	// clamp to buffer length
+	if (quantity > BUFFER_LENGTH) {
+		quantity = BUFFER_LENGTH;
+	}
+
+	rxBufferIndex = 0;
+	rxBufferLength = 0;
+
+	bcm2835_i2c_setSlaveAddress(address);
+	uint8_t ret = bcm2835_i2c_read(reinterpret_cast<char *>(rxBuffer), quantity);
+	if (ret == BCM2835_I2C_REASON_OK) {
+		rxBufferLength = quantity;
+	}
+
+	return rxBufferLength;
+}
+
+uint8_t TwoWire::requestFrom(uint8_t address, uint8_t quantity)
+{
+	return requestFrom(address, static_cast<size_t>(quantity));
+}
+
+uint8_t TwoWire::requestFrom(int address, int quantity)
+{
+	return requestFrom(static_cast<uint8_t>(address), static_cast<size_t>(quantity));
+}
+
+size_t TwoWire::write(uint8_t data)
+{
+	if (transmitting) {
+		// in master transmitter mode
+		// don't bother if buffer is full
+		if (txBufferLength >= BUFFER_LENGTH) {
+			setWriteError();
+			return 0;
+		}
+		// put byte in tx buffer
+		txBuffer[txBufferIndex] = data;
+		++txBufferIndex;
+		// update amount in buffer
+		txBufferLength = txBufferIndex;
+
+		return 1;
+	} else {
+		return write(&data, 1);
+	}
+}
+
+size_t TwoWire::write(const uint8_t *data, size_t quantity)
+{
+	if (transmitting) {
+		// in master transmitter mode
+		for (size_t i = 0; i < quantity; ++i) {
+			write(data[i]);
+		}
+	} else {
+		uint8_t rc = bcm2835_i2c_write(reinterpret_cast<const char *>(data), quantity);
+		if (rc != BCM2835_I2C_REASON_OK) {
+			return 0;
+		}
+	}
+
+	return quantity;
+}
+
+int TwoWire::available()
+{
+	return rxBufferLength - rxBufferIndex;
+}
+
+int TwoWire::read()
+{
+	int value = -1;
+
+	if (rxBufferIndex < rxBufferLength) {
+		value = rxBuffer[rxBufferIndex];
+		++rxBufferIndex;
+	}
+
+	return value;
+}
+
+int TwoWire::peek()
+{
+	if (rxBufferIndex < rxBufferLength) {
+		return rxBuffer[rxBufferIndex];
+	}
+
+	return -1;
+}
+
+void TwoWire::flush()
+{
+	rxBufferIndex = 0;
+	rxBufferLength = 0;
+	txBufferIndex = 0;
+	txBufferLength = 0;
+}
+
+TwoWire Wire = TwoWire();
@@ -0,0 +1,94 @@
+/*
+  TwoWire.h - TWI/I2C library for Arduino & Wiring
+  Copyright (c) 2006 Nicholas Zambetti.  All right reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+  Modified 2012 by Todd Krein (todd@krein.org) to implement repeated starts
+  Modified December 2014 by Ivan Grokhotkov (ivan@esp8266.com) - esp8266 support
+  Modified April 2015 by Hrsto Gochkov (ficeto@ficeto.com) - alternative esp8266 support
+  Modified October 2016 by Marcelo Aquino <marceloaqno@gmail.org> for Raspberry Pi
+*/
+
+#ifndef Wire_h
+#define Wire_h
+
+#if !DOXYGEN
+#include <stdint.h>
+#include "Stream.h"
+#include "RPi.h"
+
+#define BUFFER_LENGTH 32
+
+class TwoWire : public Stream
+{
+
+private:
+	static uint8_t rxBuffer[];
+	static uint8_t rxBufferIndex;
+	static uint8_t rxBufferLength;
+
+	static uint8_t txAddress;
+	static uint8_t txBuffer[];
+	static uint8_t txBufferIndex;
+	static uint8_t txBufferLength;
+
+	static uint8_t transmitting;
+
+public:
+	void begin();
+	void begin(uint8_t address);
+	void begin(int address);
+	void end();
+	void setClock(uint32_t clock);
+
+	void beginTransmission(uint8_t address);
+	void beginTransmission(int address);
+	uint8_t endTransmission(void);
+
+	size_t requestFrom(uint8_t address, size_t size);
+	uint8_t requestFrom(uint8_t address, uint8_t quantity);
+	uint8_t requestFrom(int address, int quantity);
+
+	size_t write(uint8_t data);
+	size_t write(const uint8_t *data, size_t quantity);
+	int available();
+	int read();
+	int peek();
+	void flush();
+
+	inline size_t write(unsigned long n)
+	{
+		return write((uint8_t)n);
+	}
+	inline size_t write(long n)
+	{
+		return write((uint8_t)n);
+	}
+	inline size_t write(unsigned int n)
+	{
+		return write((uint8_t)n);
+	}
+	inline size_t write(int n)
+	{
+		return write((uint8_t)n);
+	}
+	using Print::write;
+};
+
+extern TwoWire Wire;
+
+#endif
+#endif