Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor #5

Merged
merged 1 commit into from
Nov 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,17 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).


## [0.1.2] - 2024-11-02
- refactor
- update readme.md



## [0.1.1] - 2024-11-01
- fix #2, data in
- fix transfer16() byte order
- add transfer24() and transfer32()
- add examples
- fix **transfer16()** byte order
- add **transfer24()** and **transfer32()**
- add **SWSPI_test_input.ino** and **SWSPI_performance.ino**
- minor edits

## [0.1.0] - 2024-10-29
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ The mode used is set in the **setTransaction()** call.

#### Could

- add **void suppressInteruupts(bool flag = false)**
- add **void suppressInterrupts(bool flag = false)**
- code to .cpp file?
- add transfer24()
- unit test?
Expand Down
156 changes: 100 additions & 56 deletions SWSPI.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
//
// FILE: SWSPI.h
// AUTHOR: Rob Tillaart
// VERSION: 0.1.1
// VERSION: 0.1.2
// DATE: 2024-10-29
// PURPOSE: Arduino library for SoftWare SPI.

Expand All @@ -11,7 +11,7 @@
#include "SPI.h"


#define SWSPI_LIB_VERSION (F("0.1.1"))
#define SWSPI_LIB_VERSION (F("0.1.2"))


class SWSPI
Expand Down Expand Up @@ -94,12 +94,83 @@ class SWSPI

uint8_t transfer(uint8_t data)
{
uint8_t rv = 0;
uint8_t _data = data;
if (_bitOrder == MSBFIRST)
{
_data = _bitReverse(data);
data = _bitReverse(data);
}
uint8_t value = _transfer(data);
return value;
};

uint16_t transfer16(uint16_t data)
{
if (_bitOrder == MSBFIRST)
{
data = _bitReverse(data);
}
uint16_t value = 0;
value += _transfer(data & 0xFF);
value <<= 8;
data >>= 8;
value += _transfer(data & 0xFF);
return value;
};


uint32_t transfer24(uint32_t data)
{
if (_bitOrder == MSBFIRST)
{
data = _bitReverse(data) >> 8;
}
uint32_t value = 0;
value += _transfer(data & 0xFF);
value <<= 8;
data >>= 8;
value += _transfer(data & 0xFF);
value <<= 8;
data >>= 8;
value += _transfer(data & 0xFF);
return value;
};


uint32_t transfer32(uint32_t data)
{
if (_bitOrder == MSBFIRST)
{
data = _bitReverse(data);
}
uint32_t value = 0;
value += _transfer(data & 0xFF);
value <<= 8;
data >>= 8;
value += _transfer(data & 0xFF);
value <<= 8;
data >>= 8;
value += _transfer(data & 0xFF);
value <<= 8;
data >>= 8;
value += _transfer(data & 0xFF);
return value;
};

void transfer(const void *buf, size_t count)
{
for (size_t i = 0; i < count; i++)
{
transfer(((uint8_t*)buf)[i]);
}
};


protected:


uint8_t _transfer(uint8_t data)
{
uint8_t rv = 0;
uint8_t _data = data;

if (_dataMode == 0)
{
Expand Down Expand Up @@ -165,57 +236,6 @@ class SWSPI
return rv;
};

uint16_t transfer16(uint16_t data)
{
uint16_t value = 0;
value += transfer(data & 0xFF);
value <<= 8;
data >>= 8;
value += transfer(data & 0xFF);
return value;
};


uint32_t transfer24(uint32_t data)
{
uint16_t value = 0;
value += transfer(data & 0xFF);
value <<= 8;
data >>= 8;
value += transfer(data & 0xFF);
value <<= 8;
data >>= 8;
value += transfer(data & 0xFF);
return value;
};


uint32_t transfer32(uint32_t data)
{
uint16_t value = 0;
value += transfer(data & 0xFF);
value <<= 8;
data >>= 8;
value += transfer(data & 0xFF);
value <<= 8;
data >>= 8;
value += transfer(data & 0xFF);
value <<= 8;
data >>= 8;
value += transfer(data & 0xFF);
return value;
};

void transfer(const void *buf, size_t count)
{
for (size_t i = 0; i < count; i++)
{
transfer(((uint8_t*)buf)[i]);
}
};


protected:

// from https://github.com/RobTillaart/bitHelpers
inline uint8_t _bitReverse(uint8_t value)
Expand All @@ -227,6 +247,30 @@ class SWSPI
return x;
}


uint16_t _bitReverse(uint16_t value)
{
uint16_t x = value;
x = (((x & 0xAAAA) >> 1) | ((x & 0x5555) << 1));
x = (((x & 0xCCCC) >> 2) | ((x & 0x3333) << 2));
x = (((x & 0xF0F0) >> 4) | ((x & 0x0F0F) << 4));
x = (x >> 8) | (x << 8);
return x;
}


uint32_t _bitReverse(uint32_t value)
{
uint32_t x = value;
x = (((x & 0xAAAAAAAA) >> 1) | ((x & 0x55555555) << 1));
x = (((x & 0xCCCCCCCC) >> 2) | ((x & 0x33333333) << 2));
x = (((x & 0xF0F0F0F0) >> 4) | ((x & 0x0F0F0F0F) << 4));
x = (((x & 0xFF00FF00) >> 8) | ((x & 0x00FF00FF) << 8));
x = (x >> 16) | (x << 16);
return x;
}


// SPI pins
uint8_t _dataIn;
uint8_t _dataOut;
Expand Down
29 changes: 29 additions & 0 deletions examples/SWSPI_test_input/output_0.1.1.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@


SWSPI_test_input\SWSPI_test_input.ino
SWSPI_LIB_VERSION: 0.1.1


MODE 0
AA

MODE 1
55

MODE 2
AA

MODE 3
55

MODE 0
F399

MODE 1
F9CC

MODE 2
F399

MODE 3
F9CC
2 changes: 1 addition & 1 deletion library.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"type": "git",
"url": "https://github.com/RobTillaart/SWSPI.git"
},
"version": "0.1.1",
"version": "0.1.2",
"license": "MIT",
"frameworks": "*",
"platforms": "*",
Expand Down
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=SWSPI
version=0.1.1
version=0.1.2
author=Rob Tillaart <[email protected]>
maintainer=Rob Tillaart <[email protected]>
sentence=Arduino library for software SPI. (Experimental).
Expand Down
Loading