keyboard/qmk-keychron-q3-colemak-dh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove SERIAL_LINK feature (#14727)

Browse Source 
* Remove SERIAL_LINK

* more stale paths in doxygen-todo

* Fix

* More refs

* Update testing docs

* Update doxygen-todo

Co-authored-by: Ryan <fauxpark@gmail.com>

Co-authored-by: Ryan <fauxpark@gmail.com>
This commit is contained in:
Joel Challis 2021-10-07 02:32:05 +01:00 committed by GitHub
parent 60297a1099
commit 1c0347b8b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
36 changed files with 7 additions and 2252 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
build_test.mk
View File

@ -55,7 +55,6 @@ include common_features.mk
include $(TMK_PATH)/common.mk
include $(QUANTUM_PATH)/debounce/tests/rules.mk
include $(QUANTUM_PATH)/sequencer/tests/rules.mk
include $(QUANTUM_PATH)/serial_link/tests/rules.mk
include $(TMK_PATH)/common/test/rules.mk
ifneq ($(filter $(FULL_TESTS),$(TEST)),)
include build_full_test.mk

13
common_features.mk
View File

@ -13,8 +13,6 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
SERIAL_PATH := $(QUANTUM_PATH)/serial_link
QUANTUM_SRC += \
$(QUANTUM_DIR)/quantum.c \
$(QUANTUM_DIR)/send_string.c \
@ -363,17 +361,6 @@ ifeq ($(strip $(PRINTING_ENABLE)), yes)
SRC += $(TMK_DIR)/protocol/serial_uart.c
endif
ifeq ($(strip $(SERIAL_LINK_ENABLE)), yes)
SERIAL_SRC := $(wildcard $(SERIAL_PATH)/protocol/*.c)
SERIAL_SRC += $(wildcard $(SERIAL_PATH)/system/*.c)
SERIAL_DEFS += -DSERIAL_LINK_ENABLE
COMMON_VPATH += $(SERIAL_PATH)
SRC += $(patsubst $(QUANTUM_PATH)/%,%,$(SERIAL_SRC))
OPT_DEFS += $(SERIAL_DEFS)
VAPTH += $(SERIAL_PATH)
endif
VARIABLE_TRACE ?= no
ifneq ($(strip $(VARIABLE_TRACE)),no)
SRC += $(QUANTUM_DIR)/variable_trace.c

1
disable_features.mk
View File

@ -19,7 +19,6 @@ FEATURE_NAMES += PS2_MOUSE
FEATURE_NAMES += RGBLIGHT
FEATURE_NAMES += RGB_MATRIX
FEATURE_NAMES += SLEEP_LED
FEATURE_NAMES += SERIAL_LINK
FEATURE_NAMES += STENO
FEATURE_NAMES += SWAP_HANDS
FEATURE_NAMES += WATCHDOG

4
docs/unit_testing.md
View File

@ -20,12 +20,12 @@ One thing to remember, is that you have to append `extern "C"` around all of you
## Adding Tests for New or Existing Features
If you want to unit test some feature, then take a look at the existing serial_link tests, in the `quantum/serial_link/tests folder`, and follow the steps below to create a similar structure.
If you want to unit test a feature, take a look at some of the existing tests, for example those in the `quantum/sequencer/tests` folder. Then follow the steps below to create a similar structure.
1. If it doesn't already exist, add a test subfolder to the folder containing the feature.
2. Create a `testlist.mk` and a `rules.mk` file in that folder.
3. Include those files from the root folder `testlist.mk`and `build_test.mk` respectively.
4. Add a new name for your testgroup to the `testlist.mk` file. Each group defined there will be a separate executable. And that's how you can support mocking out different parts. Note that it's worth adding some common prefix, just like it's done for the serial_link tests. The reason for that is that the make command allows substring filtering, so this way you can easily run a subset of the tests.
4. Add a new name for your testgroup to the `testlist.mk` file. Each group defined there will be a separate executable. And that's how you can support mocking out different parts. Note that it's worth adding some common prefix, just like it's done for the existing tests. The reason for that is that the make command allows substring filtering, so this way you can easily run a subset of the tests.
5. Define the source files and required options in the `rules.mk` file.
* `_SRC` for source files
* `_DEFS` for additional defines

8
doxygen-todo
View File

@ -6,16 +6,8 @@ tmk_core/protocol/midi/bytequeue
tmk_core/protocol/midi/Config
tmk_core/protocol/usb_hid
tmk_core/protocol/vusb
tmk_core/tool
tmk_core/tool/chibios
quantum
quantum/api
quantum/audio
quantum/keymap_extras
quantum/process_keycode
quantum/serial_link
quantum/serial_link/protocol
quantum/serial_link/system
quantum/serial_link/tests
quantum/tools
drivers

1
keyboards/ergodox_infinity/ergodox_infinity.c
View File

@ -3,7 +3,6 @@
#include <hal.h>
#include <string.h>
#include "eeconfig.h"
#include "serial_link/system/serial_link.h"
#define RED_PIN 1
#define GREEN_PIN 2

7
quantum/keyboard.c
View File

@ -61,9 +61,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#ifdef STENO_ENABLE
# include "process_steno.h"
#endif
#ifdef SERIAL_LINK_ENABLE
# include "serial_link/system/serial_link.h"
#endif
#ifdef POINTING_DEVICE_ENABLE
# include "pointing_device.h"
#endif
@ -511,10 +508,6 @@ MATRIX_LOOP_END:
adb_mouse_task();
#endif
#ifdef SERIAL_LINK_ENABLE
serial_link_update();
#endif
#ifdef POINTING_DEVICE_ENABLE
pointing_device_task();
#endif

2
quantum/sequencer/tests/rules.mk
View File

@ -1,5 +1,5 @@
# The letter case of these variables might seem odd. However:
# - it is consistent with the serial_link example that is used as a reference in the Unit Testing article (https://docs.qmk.fm/#/unit_testing?id=adding-tests-for-new-or-existing-features)
# - it is consistent with the example that is used as a reference in the Unit Testing article (https://docs.qmk.fm/#/unit_testing?id=adding-tests-for-new-or-existing-features)
# - Neither `make test:sequencer` or `make test:SEQUENCER` work when using SCREAMING_SNAKE_CASE
sequencer_DEFS := -DNO_DEBUG -DMIDI_MOCKED

19
quantum/serial_link/LICENSE
View File

@ -1,19 +0,0 @@
The MIT License (MIT)
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.

1
quantum/serial_link/README.md
View File

@ -1 +0,0 @@
# qmk_serial_link

135
quantum/serial_link/protocol/byte_stuffer.c
View File

@ -1,135 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 "serial_link/protocol/byte_stuffer.h"
#include "serial_link/protocol/frame_validator.h"
#include "serial_link/protocol/physical.h"
#include <stdbool.h>
// This implements the "Consistent overhead byte stuffing protocol"
// https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing
// http://www.stuartcheshire.org/papers/COBSforToN.pdf
typedef struct byte_stuffer_state {
uint16_t next_zero;
uint16_t data_pos;
bool long_frame;
uint8_t data[MAX_FRAME_SIZE];
} byte_stuffer_state_t;
static byte_stuffer_state_t states[NUM_LINKS];
void init_byte_stuffer_state(byte_stuffer_state_t* state) {
state->next_zero = 0;
state->data_pos = 0;
state->long_frame = false;
}
void init_byte_stuffer(void) {
int i;
for (i = 0; i < NUM_LINKS; i++) {
init_byte_stuffer_state(&states[i]);
}
}
void byte_stuffer_recv_byte(uint8_t link, uint8_t data) {
byte_stuffer_state_t* state = &states[link];
// Start of a new frame
if (state->next_zero == 0) {
state->next_zero = data;
state->long_frame = data == 0xFF;
state->data_pos = 0;
return;
}
state->next_zero--;
if (data == 0) {
if (state->next_zero == 0) {
// The frame is completed
if (state->data_pos > 0) {
validator_recv_frame(link, state->data, state->data_pos);
}
} else {
// The frame is invalid, so reset
init_byte_stuffer_state(state);
}
} else {
if (state->data_pos == MAX_FRAME_SIZE) {
// We exceeded our maximum frame size
// therefore there's nothing else to do than reset to a new frame
state->next_zero = data;
state->long_frame = data == 0xFF;
state->data_pos = 0;
} else if (state->next_zero == 0) {
if (state->long_frame) {
// This is part of a long frame, so continue
state->next_zero = data;
state->long_frame = data == 0xFF;
} else {
// Special case for zeroes
state->next_zero = data;
state->data[state->data_pos++] = 0;
}
} else {
state->data[state->data_pos++] = data;
}
}
}
static void send_block(uint8_t link, uint8_t* start, uint8_t* end, uint8_t num_non_zero) {
send_data(link, &num_non_zero, 1);
if (end > start) {
send_data(link, start, end - start);
}
}
void byte_stuffer_send_frame(uint8_t link, uint8_t* data, uint16_t size) {
const uint8_t zero = 0;
if (size > 0) {
uint16_t num_non_zero = 1;
uint8_t* end = data + size;
uint8_t* start = data;
while (data < end) {
if (num_non_zero == 0xFF) {
// There's more data after big non-zero block
// So send it, and start a new block
send_block(link, start, data, num_non_zero);
start = data;
num_non_zero = 1;
} else {
if (*data == 0) {
// A zero encountered, so send the block
send_block(link, start, data, num_non_zero);
start = data + 1;
num_non_zero = 1;
} else {
num_non_zero++;
}
++data;
}
}
send_block(link, start, data, num_non_zero);
send_data(link, &zero, 1);
}
}

34
quantum/serial_link/protocol/byte_stuffer.h
View File

@ -1,34 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 <stdint.h>
#define MAX_FRAME_SIZE 1024
#define NUM_LINKS 2
void init_byte_stuffer(void);
void byte_stuffer_recv_byte(uint8_t link, uint8_t data);
void byte_stuffer_send_frame(uint8_t link, uint8_t* data, uint16_t size);

64
quantum/serial_link/protocol/frame_router.c
View File

@ -1,64 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 "serial_link/protocol/frame_router.h"
#include "serial_link/protocol/transport.h"
#include "serial_link/protocol/frame_validator.h"
static bool is_master;
void router_set_master(bool master) { is_master = master; }
void route_incoming_frame(uint8_t link, uint8_t* data, uint16_t size) {
if (is_master) {
if (link == DOWN_LINK) {
transport_recv_frame(data[size - 1], data, size - 1);
}
} else {
if (link == UP_LINK) {
if (data[size - 1] & 1) {
transport_recv_frame(0, data, size - 1);
}
data[size - 1] >>= 1;
validator_send_frame(DOWN_LINK, data, size);
} else {
data[size - 1]++;
validator_send_frame(UP_LINK, data, size);
}
}
}
void router_send_frame(uint8_t destination, uint8_t* data, uint16_t size) {
if (destination == 0) {
if (!is_master) {
data[size] = 1;
validator_send_frame(UP_LINK, data, size + 1);
}
} else {
if (is_master) {
data[size] = destination;
validator_send_frame(DOWN_LINK, data, size + 1);
}
}
}

35
quantum/serial_link/protocol/frame_router.h
View File

@ -1,35 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 <stdint.h>
#include <stdbool.h>
#define UP_LINK 0
#define DOWN_LINK 1
void router_set_master(bool master);
void route_incoming_frame(uint8_t link, uint8_t* data, uint16_t size);
void router_send_frame(uint8_t destination, uint8_t* data, uint16_t size);

57
quantum/serial_link/protocol/frame_validator.c
View File

@ -1,57 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 "serial_link/protocol/frame_validator.h"
#include "serial_link/protocol/frame_router.h"
#include "serial_link/protocol/byte_stuffer.h"
#include <string.h>
const uint32_t poly8_lookup[256] = {0, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419, 0x706AF48F, 0xE963A535, 0x9E6495A3, 0x0EDB8832, 0x79DCB8A4, 0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07, 0x90BF1D91, 0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE, 0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7, 0x136C9856, 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC, 0x14015C4F, 0x63066CD9, 0xFA0F3D63, 0x8D080DF5, 0x3B6E20C8, 0x4C69105E, 0xD56041E4, 0xA2677172, 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B, 0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940, 0x32D86CE3, 0x45DF5C75, 0xDCD60DCF, 0xABD13D59, 0x26D930AC, 0x51DE003A, 0xC8D75180, 0xBFD06116, 0x21B4F4B5, 0x56B3C423, 0xCFBA9599, 0xB8BDA50F, 0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924, 0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D,
0x76DC4190, 0x01DB7106, 0x98D220BC, 0xEFD5102A, 0x71B18589, 0x06B6B51F, 0x9FBFE4A5, 0xE8B8D433, 0x7807C9A2, 0x0F00F934, 0x9609A88E, 0xE10E9818, 0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01, 0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E, 0x6C0695ED, 0x1B01A57B, 0x8208F4C1, 0xF50FC457, 0x65B0D9C6, 0x12B7E950, 0x8BBEB8EA, 0xFCB9887C, 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3, 0xFBD44C65, 0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2, 0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB, 0x4369E96A, 0x346ED9FC, 0xAD678846, 0xDA60B8D0, 0x44042D73, 0x33031DE5, 0xAA0A4C5F, 0xDD0D7CC9, 0x5005713C, 0x270241AA, 0xBE0B1010, 0xC90C2086, 0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F, 0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, 0x59B33D17, 0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD,
0xEDB88320, 0x9ABFB3B6, 0x03B6E20C, 0x74B1D29A, 0xEAD54739, 0x9DD277AF, 0x04DB2615, 0x73DC1683, 0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8, 0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1, 0xF00F9344, 0x8708A3D2, 0x1E01F268, 0x6906C2FE, 0xF762575D, 0x806567CB, 0x196C3671, 0x6E6B06E7, 0xFED41B76, 0x89D32BE0, 0x10DA7A5A, 0x67DD4ACC, 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5, 0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, 0xD1BB67F1, 0xA6BC5767, 0x3FB506DD, 0x48B2364B, 0xD80D2BDA, 0xAF0A1B4C, 0x36034AF6, 0x41047A60, 0xDF60EFC3, 0xA867DF55, 0x316E8EEF, 0x4669BE79, 0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236, 0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F, 0xC5BA3BBE, 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, 0xC2D7FFA7, 0xB5D0CF31, 0x2CD99E8B, 0x5BDEAE1D,
0x9B64C2B0, 0xEC63F226, 0x756AA39C, 0x026D930A, 0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713, 0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38, 0x92D28E9B, 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21, 0x86D3D2D4, 0xF1D4E242, 0x68DDB3F8, 0x1FDA836E, 0x81BE16CD, 0xF6B9265B, 0x6FB077E1, 0x18B74777, 0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C, 0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45, 0xA00AE278, 0xD70DD2EE, 0x4E048354, 0x3903B3C2, 0xA7672661, 0xD06016F7, 0x4969474D, 0x3E6E77DB, 0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, 0x37D83BF0, 0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9, 0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, 0xBAD03605, 0xCDD70693, 0x54DE5729, 0x23D967BF, 0xB3667A2E, 0xC4614AB8, 0x5D681B02, 0x2A6F2B94, 0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B, 0x2D02EF8D};
static uint32_t crc32_byte(uint8_t* p, uint32_t bytelength) {
uint32_t crc = 0xffffffff;
while (bytelength-- != 0) crc = poly8_lookup[((uint8_t)crc ^ *(p++))] ^ (crc >> 8);
// return (~crc); also works
return (crc ^ 0xffffffff);
}
void validator_recv_frame(uint8_t link, uint8_t* data, uint16_t size) {
if (size > 4) {
uint32_t frame_crc;
memcpy(&frame_crc, data + size - 4, 4);
uint32_t expected_crc = crc32_byte(data, size - 4);
if (frame_crc == expected_crc) {
route_incoming_frame(link, data, size - 4);
}
}
}
void validator_send_frame(uint8_t link, uint8_t* data, uint16_t size) {
uint32_t crc = crc32_byte(data, size);
memcpy(data + size, &crc, 4);
byte_stuffer_send_frame(link, data, size + 4);
}

31
quantum/serial_link/protocol/frame_validator.h
View File

@ -1,31 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 <stdint.h>
void validator_recv_frame(uint8_t link, uint8_t* data, uint16_t size);
// The buffer pointed to by the data needs 4 additional bytes
void validator_send_frame(uint8_t link, uint8_t* data, uint16_t size);

27
quantum/serial_link/protocol/physical.h
View File

@ -1,27 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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
void send_data(uint8_t link, const uint8_t* data, uint16_t size);

121
quantum/serial_link/protocol/transport.c
View File

@ -1,121 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 "serial_link/protocol/transport.h"
#include "serial_link/protocol/frame_router.h"
#include "serial_link/protocol/triple_buffered_object.h"
#include <string.h>
#define MAX_REMOTE_OBJECTS 16
static remote_object_t* remote_objects[MAX_REMOTE_OBJECTS];
static uint32_t num_remote_objects = 0;
void reinitialize_serial_link_transport(void) { num_remote_objects = 0; }
void add_remote_objects(remote_object_t** _remote_objects, uint32_t _num_remote_objects) {
unsigned int i;
for (i = 0; i < _num_remote_objects; i++) {
remote_object_t* obj = _remote_objects[i];
remote_objects[num_remote_objects++] = obj;
if (obj->object_type == MASTER_TO_ALL_SLAVES) {
triple_buffer_object_t* tb = (triple_buffer_object_t*)obj->buffer;
triple_buffer_init(tb);
uint8_t* start = obj->buffer + LOCAL_OBJECT_SIZE(obj->object_size);
tb = (triple_buffer_object_t*)start;
triple_buffer_init(tb);
} else if (obj->object_type == MASTER_TO_SINGLE_SLAVE) {
uint8_t* start = obj->buffer;
unsigned int j;
for (j = 0; j < NUM_SLAVES; j++) {
triple_buffer_object_t* tb = (triple_buffer_object_t*)start;
triple_buffer_init(tb);
start += LOCAL_OBJECT_SIZE(obj->object_size);
}
triple_buffer_object_t* tb = (triple_buffer_object_t*)start;
triple_buffer_init(tb);
} else {
uint8_t* start = obj->buffer;
triple_buffer_object_t* tb = (triple_buffer_object_t*)start;
triple_buffer_init(tb);
start += LOCAL_OBJECT_SIZE(obj->object_size);
unsigned int j;
for (j = 0; j < NUM_SLAVES; j++) {
tb = (triple_buffer_object_t*)start;
triple_buffer_init(tb);
start += REMOTE_OBJECT_SIZE(obj->object_size);
}
}
}
}
void transport_recv_frame(uint8_t from, uint8_t* data, uint16_t size) {
uint8_t id = data[size - 1];
if (id < num_remote_objects) {
remote_object_t* obj = remote_objects[id];
if (obj->object_size == size - 1) {
uint8_t* start;
if (obj->object_type == MASTER_TO_ALL_SLAVES) {
start = obj->buffer + LOCAL_OBJECT_SIZE(obj->object_size);
} else if (obj->object_type == SLAVE_TO_MASTER) {
start = obj->buffer + LOCAL_OBJECT_SIZE(obj->object_size);
start += (from - 1) * REMOTE_OBJECT_SIZE(obj->object_size);
} else {
start = obj->buffer + NUM_SLAVES * LOCAL_OBJECT_SIZE(obj->object_size);
}
triple_buffer_object_t* tb = (triple_buffer_object_t*)start;
void* ptr = triple_buffer_begin_write_internal(obj->object_size, tb);
memcpy(ptr, data, size - 1);
triple_buffer_end_write_internal(tb);
}
}
}
void update_transport(void) {
unsigned int i;
for (i = 0; i < num_remote_objects; i++) {
remote_object_t* obj = remote_objects[i];
if (obj->object_type == MASTER_TO_ALL_SLAVES || obj->object_type == SLAVE_TO_MASTER) {
triple_buffer_object_t* tb = (triple_buffer_object_t*)obj->buffer;
uint8_t* ptr = (uint8_t*)triple_buffer_read_internal(obj->object_size + LOCAL_OBJECT_EXTRA, tb);
if (ptr) {
ptr[obj->object_size] = i;
uint8_t dest = obj->object_type == MASTER_TO_ALL_SLAVES ? 0xFF : 0;
router_send_frame(dest, ptr, obj->object_size + 1);
}
} else {
uint8_t* start = obj->buffer;
unsigned int j;
for (j = 0; j < NUM_SLAVES; j++) {
triple_buffer_object_t* tb = (triple_buffer_object_t*)start;
uint8_t* ptr = (uint8_t*)triple_buffer_read_internal(obj->object_size + LOCAL_OBJECT_EXTRA, tb);
if (ptr) {
ptr[obj->object_size] = i;
uint8_t dest = j + 1;
router_send_frame(dest, ptr, obj->object_size + 1);
}
start += LOCAL_OBJECT_SIZE(obj->object_size);
}
}
}
}

139
quantum/serial_link/protocol/transport.h
View File

@ -1,139 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 "serial_link/protocol/triple_buffered_object.h"
#include "serial_link/system/serial_link.h"
#define NUM_SLAVES 8
#define LOCAL_OBJECT_EXTRA 16
// master -> slave = 1 local(target all), 1 remote object
// slave -> master = 1 local(target 0), multiple remote objects
// master -> single slave (multiple local, target id), 1 remote object
typedef enum {
MASTER_TO_ALL_SLAVES,
MASTER_TO_SINGLE_SLAVE,
SLAVE_TO_MASTER,
} remote_object_type;
typedef struct {
remote_object_type object_type;
uint16_t object_size;
uint8_t buffer[] __attribute__((aligned(4)));
} remote_object_t;
#define REMOTE_OBJECT_SIZE(objectsize) (sizeof(triple_buffer_object_t) + objectsize * 3)
#define LOCAL_OBJECT_SIZE(objectsize) (sizeof(triple_buffer_object_t) + (objectsize + LOCAL_OBJECT_EXTRA) * 3)
#define REMOTE_OBJECT_HELPER(name, type, num_local, num_remote) \
typedef struct { \
remote_object_t object; \
uint8_t buffer[num_remote * REMOTE_OBJECT_SIZE(sizeof(type)) + num_local * LOCAL_OBJECT_SIZE(sizeof(type))]; \
} remote_object_##name##_t;
#define MASTER_TO_ALL_SLAVES_OBJECT(name, type) \
REMOTE_OBJECT_HELPER(name, type, 1, 1) \
remote_object_##name##_t remote_object_##name = {.object = { \
.object_type = MASTER_TO_ALL_SLAVES, \
.object_size = sizeof(type), \
}}; \
type* begin_write_##name(void) { \
remote_object_t* obj = (remote_object_t*)&remote_object_##name; \
triple_buffer_object_t* tb = (triple_buffer_object_t*)obj->buffer; \
return (type*)triple_buffer_begin_write_internal(sizeof(type) + LOCAL_OBJECT_EXTRA, tb); \
} \
void end_write_##name(void) { \
remote_object_t* obj = (remote_object_t*)&remote_object_##name; \
triple_buffer_object_t* tb = (triple_buffer_object_t*)obj->buffer; \
triple_buffer_end_write_internal(tb); \
signal_data_written(); \
} \
type* read_##name(void) { \
remote_object_t* obj = (remote_object_t*)&remote_object_##name; \
uint8_t* start = obj->buffer + LOCAL_OBJECT_SIZE(obj->object_size); \
triple_buffer_object_t* tb = (triple_buffer_object_t*)start; \
return (type*)triple_buffer_read_internal(obj->object_size, tb); \
}
#define MASTER_TO_SINGLE_SLAVE_OBJECT(name, type) \
REMOTE_OBJECT_HELPER(name, type, NUM_SLAVES, 1) \
remote_object_##name##_t remote_object_##name = {.object = { \
.object_type = MASTER_TO_SINGLE_SLAVE, \
.object_size = sizeof(type), \
}}; \
type* begin_write_##name(uint8_t slave) { \
remote_object_t* obj = (remote_object_t*)&remote_object_##name; \
uint8_t* start = obj->buffer; \
start += slave * LOCAL_OBJECT_SIZE(obj->object_size); \
triple_buffer_object_t* tb = (triple_buffer_object_t*)start; \
return (type*)triple_buffer_begin_write_internal(sizeof(type) + LOCAL_OBJECT_EXTRA, tb); \
} \
void end_write_##name(uint8_t slave) { \
remote_object_t* obj = (remote_object_t*)&remote_object_##name; \
uint8_t* start = obj->buffer; \
start += slave * LOCAL_OBJECT_SIZE(obj->object_size); \
triple_buffer_object_t* tb = (triple_buffer_object_t*)start; \
triple_buffer_end_write_internal(tb); \
signal_data_written(); \
} \
type* read_##name() { \
remote_object_t* obj = (remote_object_t*)&remote_object_##name; \
uint8_t* start = obj->buffer + NUM_SLAVES * LOCAL_OBJECT_SIZE(obj->object_size); \
triple_buffer_object_t* tb = (triple_buffer_object_t*)start; \
return (type*)triple_buffer_read_internal(obj->object_size, tb); \
}
#define SLAVE_TO_MASTER_OBJECT(name, type) \
REMOTE_OBJECT_HELPER(name, type, 1, NUM_SLAVES) \
remote_object_##name##_t remote_object_##name = {.object = { \
.object_type = SLAVE_TO_MASTER, \
.object_size = sizeof(type), \
}}; \
type* begin_write_##name(void) { \
remote_object_t* obj = (remote_object_t*)&remote_object_##name; \
triple_buffer_object_t* tb = (triple_buffer_object_t*)obj->buffer; \
return (type*)triple_buffer_begin_write_internal(sizeof(type) + LOCAL_OBJECT_EXTRA, tb); \
} \
void end_write_##name(void) { \
remote_object_t* obj = (remote_object_t*)&remote_object_##name; \
triple_buffer_object_t* tb = (triple_buffer_object_t*)obj->buffer; \
triple_buffer_end_write_internal(tb); \
signal_data_written(); \
} \
type* read_##name(uint8_t slave) { \
remote_object_t* obj = (remote_object_t*)&remote_object_##name; \
uint8_t* start = obj->buffer + LOCAL_OBJECT_SIZE(obj->object_size); \
start += slave * REMOTE_OBJECT_SIZE(obj->object_size); \
triple_buffer_object_t* tb = (triple_buffer_object_t*)start; \
return (type*)triple_buffer_read_internal(obj->object_size, tb); \
}
#define REMOTE_OBJECT(name) (remote_object_t*)&remote_object_##name
void add_remote_objects(remote_object_t** remote_objects, uint32_t num_remote_objects);
void reinitialize_serial_link_transport(void);
void transport_recv_frame(uint8_t from, uint8_t* data, uint16_t size);
void update_transport(void);

77
quantum/serial_link/protocol/triple_buffered_object.c
View File

@ -1,77 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 "serial_link/protocol/triple_buffered_object.h"
#include "serial_link/system/serial_link.h"
#include <stdbool.h>
#include <stddef.h>
#define GET_READ_INDEX() object->state & 3
#define GET_WRITE_INDEX() (object->state >> 2) & 3
#define GET_SHARED_INDEX() (object->state >> 4) & 3
#define GET_DATA_AVAILABLE() (object->state >> 6) & 1
#define SET_READ_INDEX(i) object->state = ((object->state & ~3) | i)
#define SET_WRITE_INDEX(i) object->state = ((object->state & ~(3 << 2)) | (i << 2))
#define SET_SHARED_INDEX(i) object->state = ((object->state & ~(3 << 4)) | (i << 4))
#define SET_DATA_AVAILABLE(i) object->state = ((object->state & ~(1 << 6)) | (i << 6))
void triple_buffer_init(triple_buffer_object_t* object) {
object->state = 0;
SET_WRITE_INDEX(0);
SET_READ_INDEX(1);
SET_SHARED_INDEX(2);
SET_DATA_AVAILABLE(0);
}
void* triple_buffer_read_internal(uint16_t object_size, triple_buffer_object_t* object) {
serial_link_lock();
if (GET_DATA_AVAILABLE()) {
uint8_t shared_index = GET_SHARED_INDEX();
uint8_t read_index = GET_READ_INDEX();
SET_READ_INDEX(shared_index);
SET_SHARED_INDEX(read_index);
SET_DATA_AVAILABLE(false);
serial_link_unlock();
return object->buffer + object_size * shared_index;
} else {
serial_link_unlock();
return NULL;
}
}
void* triple_buffer_begin_write_internal(uint16_t object_size, triple_buffer_object_t* object) {
uint8_t write_index = GET_WRITE_INDEX();
return object->buffer + object_size * write_index;
}
void triple_buffer_end_write_internal(triple_buffer_object_t* object) {
serial_link_lock();
uint8_t shared_index = GET_SHARED_INDEX();
uint8_t write_index = GET_WRITE_INDEX();
SET_SHARED_INDEX(write_index);
SET_WRITE_INDEX(shared_index);
SET_DATA_AVAILABLE(true);
serial_link_unlock();
}

44
quantum/serial_link/protocol/triple_buffered_object.h
View File

@ -1,44 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 <stdint.h>
typedef struct {
uint8_t state;
uint8_t buffer[] __attribute__((aligned(4)));
} triple_buffer_object_t;
void triple_buffer_init(triple_buffer_object_t* object);
#define triple_buffer_begin_write(object) (typeof(*object.buffer[0])*)triple_buffer_begin_write_internal(sizeof(*object.buffer[0]), (triple_buffer_object_t*)object)
#define triple_buffer_end_write(object) triple_buffer_end_write_internal((triple_buffer_object_t*)object)
#define triple_buffer_read(object) (typeof(*object.buffer[0])*)triple_buffer_read_internal(sizeof(*object.buffer[0]), (triple_buffer_object_t*)object)
void* triple_buffer_begin_write_internal(uint16_t object_size, triple_buffer_object_t* object);
void triple_buffer_end_write_internal(triple_buffer_object_t* object);
void* triple_buffer_read_internal(uint16_t object_size, triple_buffer_object_t* object);

250
quantum/serial_link/system/serial_link.c
View File

@ -1,250 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 "report.h"
#include "host_driver.h"
#include "serial_link/system/serial_link.h"
#include <hal.h>
#include "serial_link/protocol/byte_stuffer.h"
#include "serial_link/protocol/transport.h"
#include "serial_link/protocol/frame_router.h"
#include "matrix.h"
#include "sync_timer.h"
#include <stdbool.h>
#include "print.h"
#include "config.h"
#define SYNC_TIMER_OFFSET 2
static event_source_t new_data_event;
static bool serial_link_connected;
static bool is_master = false;
static uint8_t keyboard_leds(void);
static void send_keyboard(report_keyboard_t* report);
static void send_mouse(report_mouse_t* report);
static void send_system(uint16_t data);
static void send_consumer(uint16_t data);
host_driver_t serial_driver = {keyboard_leds, send_keyboard, send_mouse, send_system, send_consumer};
// Define these in your Config.h file
#ifndef SERIAL_LINK_BAUD
# error "Serial link baud is not set"
#endif
#ifndef SERIAL_LINK_THREAD_PRIORITY
# error "Serial link thread priority not set"
#endif
static SerialConfig config = {.sc_speed = SERIAL_LINK_BAUD};
//#define DEBUG_LINK_ERRORS
static uint32_t read_from_serial(SerialDriver* driver, uint8_t link) {
const uint32_t buffer_size = 16;
uint8_t buffer[buffer_size];
uint32_t bytes_read = sdAsynchronousRead(driver, buffer, buffer_size);
uint8_t* current = buffer;
uint8_t* end = current + bytes_read;
while (current < end) {
byte_stuffer_recv_byte(link, *current);
current++;
}
return bytes_read;
}
static void print_error(char* str, eventflags_t flags, SerialDriver* driver) {
#ifdef DEBUG_LINK_ERRORS
if (flags & SD_PARITY_ERROR) {
print(str);
print(" Parity error\n");
}
if (flags & SD_FRAMING_ERROR) {
print(str);
print(" Framing error\n");
}
if (flags & SD_OVERRUN_ERROR) {
print(str);
uint32_t size = qSpaceI(&(driver->iqueue));
xprintf(" Overrun error, queue size %d\n", size);
}
if (flags & SD_NOISE_ERROR) {
print(str);
print(" Noise error\n");
}
if (flags & SD_BREAK_DETECTED) {
print(str);
print(" Break detected\n");
}
#else
(void)str;
(void)flags;
(void)driver;
#endif
}
bool is_serial_link_master(void) { return is_master; }
// TODO: Optimize the stack size, this is probably way too big
static THD_WORKING_AREA(serialThreadStack, 1024);
static THD_FUNCTION(serialThread, arg) {
(void)arg;
event_listener_t new_data_listener;
event_listener_t sd1_listener;
event_listener_t sd2_listener;
chEvtRegister(&new_data_event, &new_data_listener, 0);
eventflags_t events = CHN_INPUT_AVAILABLE | SD_PARITY_ERROR | SD_FRAMING_ERROR | SD_OVERRUN_ERROR | SD_NOISE_ERROR | SD_BREAK_DETECTED;
chEvtRegisterMaskWithFlags(chnGetEventSource(&SD1), &sd1_listener, EVENT_MASK(1), events);
chEvtRegisterMaskWithFlags(chnGetEventSource(&SD2), &sd2_listener, EVENT_MASK(2), events);
bool need_wait = false;
while (true) {
eventflags_t flags1 = 0;
eventflags_t flags2 = 0;
if (need_wait) {
eventmask_t mask = chEvtWaitAnyTimeout(ALL_EVENTS, TIME_MS2I(1000));
if (mask & EVENT_MASK(1)) {
flags1 = chEvtGetAndClearFlags(&sd1_listener);
print_error("DOWNLINK", flags1, &SD1);
}
if (mask & EVENT_MASK(2)) {
flags2 = chEvtGetAndClearFlags(&sd2_listener);
print_error("UPLINK", flags2, &SD2);
}
}
// Always stay as master, even if the USB goes into sleep mode
is_master |= usbGetDriverStateI(&USBD1) == USB_ACTIVE;
router_set_master(is_master);
need_wait = true;
need_wait &= read_from_serial(&SD2, UP_LINK) == 0;
need_wait &= read_from_serial(&SD1, DOWN_LINK) == 0;
update_transport();
}
}
void send_data(uint8_t link, const uint8_t* data, uint16_t size) {
if (link == DOWN_LINK) {
sdWrite(&SD1, data, size);
} else {
sdWrite(&SD2, data, size);
}
}
static systime_t last_update = 0;
typedef struct {
matrix_row_t rows[MATRIX_ROWS];
} matrix_object_t;
static matrix_object_t last_matrix = {};
SLAVE_TO_MASTER_OBJECT(keyboard_matrix, matrix_object_t);
MASTER_TO_ALL_SLAVES_OBJECT(serial_link_connected, bool);
#ifndef DISABLE_SYNC_TIMER
MASTER_TO_ALL_SLAVES_OBJECT(sync_timer, uint32_t);
#endif
static remote_object_t* remote_objects[] = {
REMOTE_OBJECT(serial_link_connected),
REMOTE_OBJECT(keyboard_matrix),
#ifndef DISABLE_SYNC_TIMER
REMOTE_OBJECT(sync_timer),
#endif
};
void init_serial_link(void) {
serial_link_connected = false;
init_serial_link_hal();
add_remote_objects(remote_objects, sizeof(remote_objects) / sizeof(remote_object_t*));
init_byte_stuffer();
sdStart(&SD1, &config);
sdStart(&SD2, &config);
chEvtObjectInit(&new_data_event);
(void)chThdCreateStatic(serialThreadStack, sizeof(serialThreadStack), SERIAL_LINK_THREAD_PRIORITY, serialThread, NULL);
}
void matrix_set_remote(matrix_row_t* rows, uint8_t index);
void serial_link_update(void) {
if (read_serial_link_connected()) {
serial_link_connected = true;
}
matrix_object_t matrix;
bool changed = false;
for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
matrix.rows[i] = matrix_get_row(i);
changed |= matrix.rows[i] != last_matrix.rows[i];
}
systime_t current_time = chVTGetSystemTimeX();
systime_t delta = current_time - last_update;
if (changed || delta > TIME_US2I(5000)) {
last_update = current_time;
last_matrix = matrix;
matrix_object_t* m = begin_write_keyboard_matrix();
for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
m->rows[i] = matrix.rows[i];
}
end_write_keyboard_matrix();
*begin_write_serial_link_connected() = true;
end_write_serial_link_connected();
#ifndef DISABLE_SYNC_TIMER
*begin_write_sync_timer() = sync_timer_read32() + SYNC_TIMER_OFFSET;
end_write_sync_timer();
#endif
}
matrix_object_t* m = read_keyboard_matrix(0);
if (m) {
matrix_set_remote(m->rows, 0);
}
#ifndef DISABLE_SYNC_TIMER
uint32_t* t = read_sync_timer();
if (t) {
sync_timer_update(*t);
}
#endif
}
void signal_data_written(void) { chEvtBroadcast(&new_data_event); }
bool is_serial_link_connected(void) { return serial_link_connected; }
host_driver_t* get_serial_link_driver(void) { return &serial_driver; }
// NOTE: The driver does nothing, because the master handles everything
uint8_t keyboard_leds(void) { return 0; }
void send_keyboard(report_keyboard_t* report) { (void)report; }
void send_mouse(report_mouse_t* report) { (void)report; }
void send_system(uint16_t data) { (void)data; }
void send_consumer(uint16_t data) { (void)data; }

54
quantum/serial_link/system/serial_link.h
View File

@ -1,54 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 "host_driver.h"
#include <stdbool.h>
void init_serial_link(void);
void init_serial_link_hal(void);
bool is_serial_link_connected(void);
bool is_serial_link_master(void);
host_driver_t* get_serial_link_driver(void);
void serial_link_update(void);
#if defined(PROTOCOL_CHIBIOS)
# include <ch.h>
static inline void serial_link_lock(void) { chSysLock(); }
static inline void serial_link_unlock(void) { chSysUnlock(); }
void signal_data_written(void);
#else
inline void serial_link_lock(void) {}
inline void serial_link_unlock(void) {}
void signal_data_written(void);
#endif

61
quantum/serial_link/tests/Makefile
View File

@ -1,61 +0,0 @@
# The MIT License (MIT)
#
# Copyright (c) 2016 Fred Sundvik
#
# 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.
CC = gcc
CFLAGS =
INCLUDES = -I. -I../../
LDFLAGS = -L$(BUILDDIR)/cgreen/build-c/src -shared
LDLIBS = -lcgreen
UNITOBJ = $(BUILDDIR)/serialtest/unitobj
DEPDIR = $(BUILDDIR)/serialtest/unit.d
UNITTESTS = $(BUILDDIR)/serialtest/unittests
DEPFLAGS = -MT $@ -MMD -MP -MF $(DEPDIR)/$*.Td
EXT = .so
UNAME := $(shell uname)
ifneq (, $(findstring MINGW, $(UNAME)))
EXT = .dll
endif
ifneq (, $(findstring CYGWIN, $(UNAME)))
EXT = .dll
endif
SRC = $(wildcard *.c)
TESTFILES = $(patsubst %.c, $(UNITTESTS)/%$(EXT), $(SRC))
$(shell mkdir -p $(DEPDIR) >/dev/null)
test: $(TESTFILES)
@$(BUILDDIR)/cgreen/build-c/tools/cgreen-runner --color $(TESTFILES)
$(UNITTESTS)/%$(EXT): $(UNITOBJ)/%.o
@mkdir -p $(UNITTESTS)
$(CC) $(LDFLAGS) -o $@ $^ $(LDLIBS)
$(UNITOBJ)/%.o : %.c
$(UNITOBJ)/%.o: %.c $(DEPDIR)/%.d
@mkdir -p $(UNITOBJ)
$(CC) $(CFLAGS) $(DEPFLAGS) $(INCLUDES) -c $< -o $@
@mv -f $(DEPDIR)/$*.Td $(DEPDIR)/$*.d
$(DEPDIR)/%.d: ;
.PRECIOUS: $(DEPDIR)/%.d
-include $(patsubst %,$(DEPDIR)/%.d,$(basename $(SRC)))

450
quantum/serial_link/tests/byte_stuffer_tests.cpp
View File

@ -1,450 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 "gtest/gtest.h"
#include "gmock/gmock.h"
#include <vector>
#include <algorithm>
extern "C" {
#include "serial_link/protocol/byte_stuffer.h"
#include "serial_link/protocol/frame_validator.h"
#include "serial_link/protocol/physical.h"
}
using testing::_;
using testing::Args;
using testing::ElementsAreArray;
class ByteStuffer : public ::testing::Test {
public:
ByteStuffer() {
Instance = this;
init_byte_stuffer();
}
~ByteStuffer() { Instance = nullptr; }
MOCK_METHOD3(validator_recv_frame, void(uint8_t link, uint8_t* data, uint16_t size));
void send_data(uint8_t link, const uint8_t* data, uint16_t size) { std::copy(data, data + size, std::back_inserter(sent_data)); }
std::vector<uint8_t> sent_data;
static ByteStuffer* Instance;
};
ByteStuffer* ByteStuffer::Instance = nullptr;
extern "C" {
void validator_recv_frame(uint8_t link, uint8_t* data, uint16_t size) { ByteStuffer::Instance->validator_recv_frame(link, data, size); }
void send_data(uint8_t link, const uint8_t* data, uint16_t size) { ByteStuffer::Instance->send_data(link, data, size); }
}
TEST_F(ByteStuffer, receives_no_frame_for_a_single_zero_byte) {
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).Times(0);
byte_stuffer_recv_byte(0, 0);
}
TEST_F(ByteStuffer, receives_no_frame_for_a_single_FF_byte) {
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).Times(0);
byte_stuffer_recv_byte(0, 0xFF);
}
TEST_F(ByteStuffer, receives_no_frame_for_a_single_random_byte) {
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).Times(0);
byte_stuffer_recv_byte(0, 0x4A);
}
TEST_F(ByteStuffer, receives_no_frame_for_a_zero_length_frame) {
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).Times(0);
byte_stuffer_recv_byte(0, 1);
byte_stuffer_recv_byte(0, 0);
}
TEST_F(ByteStuffer, receives_single_byte_valid_frame) {
uint8_t expected[] = {0x37};
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected)));
byte_stuffer_recv_byte(0, 2);
byte_stuffer_recv_byte(0, 0x37);
byte_stuffer_recv_byte(0, 0);
}
TEST_F(ByteStuffer, receives_three_bytes_valid_frame) {
uint8_t expected[] = {0x37, 0x99, 0xFF};
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected)));
byte_stuffer_recv_byte(0, 4);
byte_stuffer_recv_byte(0, 0x37);
byte_stuffer_recv_byte(0, 0x99);
byte_stuffer_recv_byte(0, 0xFF);
byte_stuffer_recv_byte(0, 0);
}
TEST_F(ByteStuffer, receives_single_zero_valid_frame) {
uint8_t expected[] = {0};
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected)));
byte_stuffer_recv_byte(0, 1);
byte_stuffer_recv_byte(0, 1);
byte_stuffer_recv_byte(0, 0);
}
TEST_F(ByteStuffer, receives_valid_frame_with_zeroes) {
uint8_t expected[] = {5, 0, 3, 0};
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected)));
byte_stuffer_recv_byte(0, 2);
byte_stuffer_recv_byte(0, 5);
byte_stuffer_recv_byte(0, 2);
byte_stuffer_recv_byte(0, 3);
byte_stuffer_recv_byte(0, 1);
byte_stuffer_recv_byte(0, 0);
}
TEST_F(ByteStuffer, receives_two_valid_frames) {
uint8_t expected1[] = {5, 0};
uint8_t expected2[] = {3};
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected1)));
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected2)));
byte_stuffer_recv_byte(1, 2);
byte_stuffer_recv_byte(1, 5);
byte_stuffer_recv_byte(1, 1);
byte_stuffer_recv_byte(1, 0);
byte_stuffer_recv_byte(1, 2);
byte_stuffer_recv_byte(1, 3);
byte_stuffer_recv_byte(1, 0);
}
TEST_F(ByteStuffer, receives_valid_frame_after_unexpected_zero) {
uint8_t expected[] = {5, 7};
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected)));
byte_stuffer_recv_byte(1, 3);
byte_stuffer_recv_byte(1, 1);
byte_stuffer_recv_byte(1, 0);
byte_stuffer_recv_byte(1, 3);
byte_stuffer_recv_byte(1, 5);
byte_stuffer_recv_byte(1, 7);
byte_stuffer_recv_byte(1, 0);
}
TEST_F(ByteStuffer, receives_valid_frame_after_unexpected_non_zero) {
uint8_t expected[] = {5, 7};
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected)));
byte_stuffer_recv_byte(0, 2);
byte_stuffer_recv_byte(0, 9);
byte_stuffer_recv_byte(0, 4); // This should have been zero
byte_stuffer_recv_byte(0, 0);
byte_stuffer_recv_byte(0, 3);
byte_stuffer_recv_byte(0, 5);
byte_stuffer_recv_byte(0, 7);
byte_stuffer_recv_byte(0, 0);
}
TEST_F(ByteStuffer, receives_a_valid_frame_with_over254_non_zeroes_and_then_end_of_frame) {
uint8_t expected[254];
int i;
for (i = 0; i < 254; i++) {
expected[i] = i + 1;
}
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected)));
byte_stuffer_recv_byte(0, 0xFF);
for (i = 0; i < 254; i++) {
byte_stuffer_recv_byte(0, i + 1);
}
byte_stuffer_recv_byte(0, 0);
}
TEST_F(ByteStuffer, receives_a_valid_frame_with_over254_non_zeroes_next_byte_is_non_zero) {
uint8_t expected[255];
int i;
for (i = 0; i < 254; i++) {
expected[i] = i + 1;
}
expected[254] = 7;
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected)));
byte_stuffer_recv_byte(0, 0xFF);
for (i = 0; i < 254; i++) {
byte_stuffer_recv_byte(0, i + 1);
}
byte_stuffer_recv_byte(0, 2);
byte_stuffer_recv_byte(0, 7);
byte_stuffer_recv_byte(0, 0);
}
TEST_F(ByteStuffer, receives_a_valid_frame_with_over254_non_zeroes_next_byte_is_zero) {
uint8_t expected[255];
int i;
for (i = 0; i < 254; i++) {
expected[i] = i + 1;
}
expected[254] = 0;
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected)));
byte_stuffer_recv_byte(0, 0xFF);
for (i = 0; i < 254; i++) {
byte_stuffer_recv_byte(0, i + 1);
}
byte_stuffer_recv_byte(0, 1);
byte_stuffer_recv_byte(0, 1);
byte_stuffer_recv_byte(0, 0);
}
TEST_F(ByteStuffer, receives_two_long_frames_and_some_more) {
uint8_t expected[515];
int i;
int j;
for (j = 0; j < 2; j++) {
for (i = 0; i < 254; i++) {
expected[i + 254 * j] = i + 1;
}
}
for (i = 0; i < 7; i++) {
expected[254 * 2 + i] = i + 1;
}
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected)));
byte_stuffer_recv_byte(0, 0xFF);
for (i = 0; i < 254; i++) {
byte_stuffer_recv_byte(0, i + 1);
}
byte_stuffer_recv_byte(0, 0xFF);
for (i = 0; i < 254; i++) {
byte_stuffer_recv_byte(0, i + 1);
}
byte_stuffer_recv_byte(0, 8);
byte_stuffer_recv_byte(0, 1);
byte_stuffer_recv_byte(0, 2);
byte_stuffer_recv_byte(0, 3);
byte_stuffer_recv_byte(0, 4);
byte_stuffer_recv_byte(0, 5);
byte_stuffer_recv_byte(0, 6);
byte_stuffer_recv_byte(0, 7);
byte_stuffer_recv_byte(0, 0);
}
TEST_F(ByteStuffer, receives_an_all_zeros_frame_that_is_maximum_size) {
uint8_t expected[MAX_FRAME_SIZE] = {};
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected)));
int i;
byte_stuffer_recv_byte(0, 1);
for (i = 0; i < MAX_FRAME_SIZE; i++) {
byte_stuffer_recv_byte(0, 1);
}
byte_stuffer_recv_byte(0, 0);
}
TEST_F(ByteStuffer, doesnt_recv_a_frame_thats_too_long_all_zeroes) {
uint8_t expected[1] = {0};
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).Times(0);
int i;
byte_stuffer_recv_byte(0, 1);
for (i = 0; i < MAX_FRAME_SIZE; i++) {
byte_stuffer_recv_byte(0, 1);
}
byte_stuffer_recv_byte(0, 1);
byte_stuffer_recv_byte(0, 0);
}
TEST_F(ByteStuffer, received_frame_is_aborted_when_its_too_long) {
uint8_t expected[1] = {1};
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected)));
int i;
byte_stuffer_recv_byte(0, 1);
for (i = 0; i < MAX_FRAME_SIZE; i++) {
byte_stuffer_recv_byte(0, 1);
}
byte_stuffer_recv_byte(0, 2);
byte_stuffer_recv_byte(0, 1);
byte_stuffer_recv_byte(0, 0);
}
TEST_F(ByteStuffer, does_nothing_when_sending_zero_size_frame) {
EXPECT_EQ(sent_data.size(), 0);
byte_stuffer_send_frame(0, NULL, 0);
}
TEST_F(ByteStuffer, send_one_byte_frame) {
uint8_t data[] = {5};
byte_stuffer_send_frame(1, data, 1);
uint8_t expected[] = {2, 5, 0};
EXPECT_THAT(sent_data, ElementsAreArray(expected));
}
TEST_F(ByteStuffer, sends_two_byte_frame) {
uint8_t data[] = {5, 0x77};
byte_stuffer_send_frame(0, data, 2);
uint8_t expected[] = {3, 5, 0x77, 0};
EXPECT_THAT(sent_data, ElementsAreArray(expected));
}
TEST_F(ByteStuffer, sends_one_byte_frame_with_zero) {
uint8_t data[] = {0};
byte_stuffer_send_frame(0, data, 1);
uint8_t expected[] = {1, 1, 0};
EXPECT_THAT(sent_data, ElementsAreArray(expected));
}
TEST_F(ByteStuffer, sends_two_byte_frame_starting_with_zero) {
uint8_t data[] = {0, 9};
byte_stuffer_send_frame(1, data, 2);
uint8_t expected[] = {1, 2, 9, 0};
EXPECT_THAT(sent_data, ElementsAreArray(expected));
}
TEST_F(ByteStuffer, sends_two_byte_frame_starting_with_non_zero) {
uint8_t data[] = {9, 0};
byte_stuffer_send_frame(1, data, 2);
uint8_t expected[] = {2, 9, 1, 0};
EXPECT_THAT(sent_data, ElementsAreArray(expected));
}
TEST_F(ByteStuffer, sends_three_byte_frame_zero_in_the_middle) {
uint8_t data[] = {9, 0, 0x68};
byte_stuffer_send_frame(0, data, 3);
uint8_t expected[] = {2, 9, 2, 0x68, 0};
EXPECT_THAT(sent_data, ElementsAreArray(expected));
}
TEST_F(ByteStuffer, sends_three_byte_frame_data_in_the_middle) {
uint8_t data[] = {0, 0x55, 0};
byte_stuffer_send_frame(0, data, 3);
uint8_t expected[] = {1, 2, 0x55, 1, 0};
EXPECT_THAT(sent_data, ElementsAreArray(expected));
}
TEST_F(ByteStuffer, sends_three_byte_frame_with_all_zeroes) {
uint8_t data[] = {0, 0, 0};
byte_stuffer_send_frame(0, data, 3);
uint8_t expected[] = {1, 1, 1, 1, 0};
EXPECT_THAT(sent_data, ElementsAreArray(expected));
}
TEST_F(ByteStuffer, sends_frame_with_254_non_zeroes) {
uint8_t data[254];
int i;
for (i = 0; i < 254; i++) {
data[i] = i + 1;
}
byte_stuffer_send_frame(0, data, 254);
uint8_t expected[256];
expected[0] = 0xFF;
for (i = 1; i < 255; i++) {
expected[i] = i;
}
expected[255] = 0;
EXPECT_THAT(sent_data, ElementsAreArray(expected));
}
TEST_F(ByteStuffer, sends_frame_with_255_non_zeroes) {
uint8_t data[255];
int i;
for (i = 0; i < 255; i++) {
data[i] = i + 1;
}
byte_stuffer_send_frame(0, data, 255);
uint8_t expected[258];
expected[0] = 0xFF;
for (i = 1; i < 255; i++) {
expected[i] = i;
}
expected[255] = 2;
expected[256] = 255;
expected[257] = 0;
EXPECT_THAT(sent_data, ElementsAreArray(expected));
}
TEST_F(ByteStuffer, sends_frame_with_254_non_zeroes_followed_by_zero) {
uint8_t data[255];
int i;
for (i = 0; i < 254; i++) {
data[i] = i + 1;
}
data[254] = 0;
byte_stuffer_send_frame(0, data, 255);
uint8_t expected[258];
expected[0] = 0xFF;
for (i = 1; i < 255; i++) {
expected[i] = i;
}
expected[255] = 1;
expected[256] = 1;
expected[257] = 0;
EXPECT_THAT(sent_data, ElementsAreArray(expected));
}
TEST_F(ByteStuffer, sends_and_receives_full_roundtrip_small_packet) {
uint8_t original_data[] = {1, 2, 3};
byte_stuffer_send_frame(0, original_data, sizeof(original_data));
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(original_data)));
int i;
for (auto& d : sent_data) {
byte_stuffer_recv_byte(1, d);
}
}
TEST_F(ByteStuffer, sends_and_receives_full_roundtrip_small_packet_with_zeros) {
uint8_t original_data[] = {1, 0, 3, 0, 0, 9};
byte_stuffer_send_frame(1, original_data, sizeof(original_data));
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(original_data)));
int i;
for (auto& d : sent_data) {
byte_stuffer_recv_byte(1, d);
}
}
TEST_F(ByteStuffer, sends_and_receives_full_roundtrip_254_bytes) {
uint8_t original_data[254];
int i;
for (i = 0; i < 254; i++) {
original_data[i] = i + 1;
}
byte_stuffer_send_frame(0, original_data, sizeof(original_data));
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(original_data)));
for (auto& d : sent_data) {
byte_stuffer_recv_byte(1, d);
}
}
TEST_F(ByteStuffer, sends_and_receives_full_roundtrip_256_bytes) {
uint8_t original_data[256];
int i;
for (i = 0; i < 254; i++) {
original_data[i] = i + 1;
}
original_data[254] = 22;
original_data[255] = 23;
byte_stuffer_send_frame(0, original_data, sizeof(original_data));
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(original_data)));
for (auto& d : sent_data) {
byte_stuffer_recv_byte(1, d);
}
}
TEST_F(ByteStuffer, sends_and_receives_full_roundtrip_254_bytes_and_then_zero) {
uint8_t original_data[255];
int i;
for (i = 0; i < 254; i++) {
original_data[i] = i + 1;
}
original_data[254] = 0;
byte_stuffer_send_frame(0, original_data, sizeof(original_data));
EXPECT_CALL(*this, validator_recv_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(original_data)));
for (auto& d : sent_data) {
byte_stuffer_recv_byte(1, d);
}
}

204
quantum/serial_link/tests/frame_router_tests.cpp
View File

@ -1,204 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 "gtest/gtest.h"
#include "gmock/gmock.h"
#include <array>
extern "C" {
#include "serial_link/protocol/transport.h"
#include "serial_link/protocol/byte_stuffer.h"
#include "serial_link/protocol/frame_router.h"
}
using testing::_;
using testing::Args;
using testing::ElementsAreArray;
class FrameRouter : public testing::Test {
public:
FrameRouter() : current_router_buffer(nullptr) {
Instance = this;
init_byte_stuffer();
}
~FrameRouter() { Instance = nullptr; }
void send_data(uint8_t link, const uint8_t* data, uint16_t size) {
auto& buffer = current_router_buffer->send_buffers[link];
std::copy(data, data + size, std::back_inserter(buffer));
}
void receive_data(uint8_t link, uint8_t* data, uint16_t size) {
int i;
for (i = 0; i < size; i++) {
byte_stuffer_recv_byte(link, data[i]);
}
}
void activate_router(uint8_t num) {
current_router_buffer = router_buffers + num;
router_set_master(num == 0);
}
void simulate_transport(uint8_t from, uint8_t to) {
activate_router(to);
if (from > to) {
receive_data(DOWN_LINK, router_buffers[from].send_buffers[UP_LINK].data(), router_buffers[from].send_buffers[UP_LINK].size());
} else if (to > from) {
receive_data(UP_LINK, router_buffers[from].send_buffers[DOWN_LINK].data(), router_buffers[from].send_buffers[DOWN_LINK].size());
}
}
MOCK_METHOD3(transport_recv_frame, void(uint8_t from, uint8_t* data, uint16_t size));
std::vector<uint8_t> received_data;
struct router_buffer {
std::vector<uint8_t> send_buffers[2];
};
router_buffer router_buffers[8];
router_buffer* current_router_buffer;
static FrameRouter* Instance;
};
FrameRouter* FrameRouter::Instance = nullptr;
typedef struct {
std::array<uint8_t, 4> data;
uint8_t extra[16];
} frame_buffer_t;
extern "C" {
void send_data(uint8_t link, const uint8_t* data, uint16_t size) { FrameRouter::Instance->send_data(link, data, size); }
void transport_recv_frame(uint8_t from, uint8_t* data, uint16_t size) { FrameRouter::Instance->transport_recv_frame(from, data, size); }
}
TEST_F(FrameRouter, master_broadcast_is_received_by_everyone) {
frame_buffer_t data;
data.data = {0xAB, 0x70, 0x55, 0xBB};
activate_router(0);
router_send_frame(0xFF, (uint8_t*)&data, 4);
EXPECT_GT(router_buffers[0].send_buffers[DOWN_LINK].size(), 0);
EXPECT_EQ(router_buffers[0].send_buffers[UP_LINK].size(), 0);
EXPECT_CALL(*this, transport_recv_frame(0, _, _)).With(Args<1, 2>(ElementsAreArray(data.data)));
simulate_transport(0, 1);
EXPECT_GT(router_buffers[1].send_buffers[DOWN_LINK].size(), 0);
EXPECT_EQ(router_buffers[1].send_buffers[UP_LINK].size(), 0);
EXPECT_CALL(*this, transport_recv_frame(0, _, _)).With(Args<1, 2>(ElementsAreArray(data.data)));
simulate_transport(1, 2);
EXPECT_GT(router_buffers[2].send_buffers[DOWN_LINK].size(), 0);
EXPECT_EQ(router_buffers[2].send_buffers[UP_LINK].size(), 0);
}
TEST_F(FrameRouter, master_send_is_received_by_targets) {
frame_buffer_t data;
data.data = {0xAB, 0x70, 0x55, 0xBB};
activate_router(0);
router_send_frame((1 << 1) | (1 << 2), (uint8_t*)&data, 4);
EXPECT_GT(router_buffers[0].send_buffers[DOWN_LINK].size(), 0);
EXPECT_EQ(router_buffers[0].send_buffers[UP_LINK].size(), 0);
simulate_transport(0, 1);
EXPECT_GT(router_buffers[1].send_buffers[DOWN_LINK].size(), 0);
EXPECT_EQ(router_buffers[1].send_buffers[UP_LINK].size(), 0);
EXPECT_CALL(*this, transport_recv_frame(0, _, _)).With(Args<1, 2>(ElementsAreArray(data.data)));
simulate_transport(1, 2);
EXPECT_GT(router_buffers[2].send_buffers[DOWN_LINK].size(), 0);
EXPECT_EQ(router_buffers[2].send_buffers[UP_LINK].size(), 0);
EXPECT_CALL(*this, transport_recv_frame(0, _, _)).With(Args<1, 2>(ElementsAreArray(data.data)));
simulate_transport(2, 3);
EXPECT_GT(router_buffers[3].send_buffers[DOWN_LINK].size(), 0);
EXPECT_EQ(router_buffers[3].send_buffers[UP_LINK].size(), 0);
}
TEST_F(FrameRouter, first_link_sends_to_master) {
frame_buffer_t data;
data.data = {0xAB, 0x70, 0x55, 0xBB};
activate_router(1);
router_send_frame(0, (uint8_t*)&data, 4);
EXPECT_GT(router_buffers[1].send_buffers[UP_LINK].size(), 0);
EXPECT_EQ(router_buffers[1].send_buffers[DOWN_LINK].size(), 0);
EXPECT_CALL(*this, transport_recv_frame(1, _, _)).With(Args<1, 2>(ElementsAreArray(data.data)));
simulate_transport(1, 0);
EXPECT_EQ(router_buffers[0].send_buffers[DOWN_LINK].size(), 0);
EXPECT_EQ(router_buffers[0].send_buffers[UP_LINK].size(), 0);
}
TEST_F(FrameRouter, second_link_sends_to_master) {
frame_buffer_t data;
data.data = {0xAB, 0x70, 0x55, 0xBB};
activate_router(2);
router_send_frame(0, (uint8_t*)&data, 4);
EXPECT_GT(router_buffers[2].send_buffers[UP_LINK].size(), 0);
EXPECT_EQ(router_buffers[2].send_buffers[DOWN_LINK].size(), 0);
simulate_transport(2, 1);
EXPECT_GT(router_buffers[1].send_buffers[UP_LINK].size(), 0);
EXPECT_EQ(router_buffers[1].send_buffers[DOWN_LINK].size(), 0);
EXPECT_CALL(*this, transport_recv_frame(2, _, _)).With(Args<1, 2>(ElementsAreArray(data.data)));
simulate_transport(1, 0);
EXPECT_EQ(router_buffers[0].send_buffers[DOWN_LINK].size(), 0);
EXPECT_EQ(router_buffers[0].send_buffers[UP_LINK].size(), 0);
}
TEST_F(FrameRouter, master_sends_to_master_does_nothing) {
frame_buffer_t data;
data.data = {0xAB, 0x70, 0x55, 0xBB};
activate_router(0);
router_send_frame(0, (uint8_t*)&data, 4);
EXPECT_EQ(router_buffers[0].send_buffers[UP_LINK].size(), 0);
EXPECT_EQ(router_buffers[0].send_buffers[DOWN_LINK].size(), 0);
}
TEST_F(FrameRouter, link_sends_to_other_link_does_nothing) {
frame_buffer_t data;
data.data = {0xAB, 0x70, 0x55, 0xBB};
activate_router(1);
router_send_frame(2, (uint8_t*)&data, 4);
EXPECT_EQ(router_buffers[1].send_buffers[UP_LINK].size(), 0);
EXPECT_EQ(router_buffers[1].send_buffers[DOWN_LINK].size(), 0);
}
TEST_F(FrameRouter, master_receives_on_uplink_does_nothing) {
frame_buffer_t data;
data.data = {0xAB, 0x70, 0x55, 0xBB};
activate_router(1);
router_send_frame(0, (uint8_t*)&data, 4);
EXPECT_GT(router_buffers[1].send_buffers[UP_LINK].size(), 0);
EXPECT_EQ(router_buffers[1].send_buffers[DOWN_LINK].size(), 0);
EXPECT_CALL(*this, transport_recv_frame(_, _, _)).Times(0);
activate_router(0);
receive_data(UP_LINK, router_buffers[1].send_buffers[UP_LINK].data(), router_buffers[1].send_buffers[UP_LINK].size());
EXPECT_EQ(router_buffers[0].send_buffers[UP_LINK].size(), 0);
EXPECT_EQ(router_buffers[0].send_buffers[DOWN_LINK].size(), 0);
}

100
quantum/serial_link/tests/frame_validator_tests.cpp
View File

@ -1,100 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 "gtest/gtest.h"
#include "gmock/gmock.h"
extern "C" {
#include "serial_link/protocol/frame_validator.h"
}
using testing::_;
using testing::Args;
using testing::ElementsAreArray;
class FrameValidator : public testing::Test {
public:
FrameValidator() { Instance = this; }
~FrameValidator() { Instance = nullptr; }
MOCK_METHOD3(route_incoming_frame, void(uint8_t link, uint8_t* data, uint16_t size));
MOCK_METHOD3(byte_stuffer_send_frame, void(uint8_t link, uint8_t* data, uint16_t size));
static FrameValidator* Instance;
};
FrameValidator* FrameValidator::Instance = nullptr;
extern "C" {
void route_incoming_frame(uint8_t link, uint8_t* data, uint16_t size) { FrameValidator::Instance->route_incoming_frame(link, data, size); }
void byte_stuffer_send_frame(uint8_t link, uint8_t* data, uint16_t size) { FrameValidator::Instance->byte_stuffer_send_frame(link, data, size); }
}
TEST_F(FrameValidator, doesnt_validate_frames_under_5_bytes) {
EXPECT_CALL(*this, route_incoming_frame(_, _, _)).Times(0);
uint8_t data[] = {1, 2};
validator_recv_frame(0, 0, 1);
validator_recv_frame(0, data, 2);
validator_recv_frame(0, data, 3);
validator_recv_frame(0, data, 4);
}
TEST_F(FrameValidator, validates_one_byte_frame_with_correct_crc) {
uint8_t data[] = {0x44, 0x04, 0x6A, 0xB3, 0xA3};
EXPECT_CALL(*this, route_incoming_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(data, 1)));
validator_recv_frame(0, data, 5);
}
TEST_F(FrameValidator, does_not_validate_one_byte_frame_with_incorrect_crc) {
uint8_t data[] = {0x44, 0, 0, 0, 0};
EXPECT_CALL(*this, route_incoming_frame(_, _, _)).Times(0);
validator_recv_frame(1, data, 5);
}
TEST_F(FrameValidator, validates_four_byte_frame_with_correct_crc) {
uint8_t data[] = {0x44, 0x10, 0xFF, 0x00, 0x74, 0x4E, 0x30, 0xBA};
EXPECT_CALL(*this, route_incoming_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(data, 4)));
validator_recv_frame(1, data, 8);
}
TEST_F(FrameValidator, validates_five_byte_frame_with_correct_crc) {
uint8_t data[] = {1, 2, 3, 4, 5, 0xF4, 0x99, 0x0B, 0x47};
EXPECT_CALL(*this, route_incoming_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(data, 5)));
validator_recv_frame(0, data, 9);
}
TEST_F(FrameValidator, sends_one_byte_with_correct_crc) {
uint8_t original[] = {0x44, 0, 0, 0, 0};
uint8_t expected[] = {0x44, 0x04, 0x6A, 0xB3, 0xA3};
EXPECT_CALL(*this, byte_stuffer_send_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected)));
validator_send_frame(0, original, 1);
}
TEST_F(FrameValidator, sends_five_bytes_with_correct_crc) {
uint8_t original[] = {1, 2, 3, 4, 5, 0, 0, 0, 0};
uint8_t expected[] = {1, 2, 3, 4, 5, 0xF4, 0x99, 0x0B, 0x47};
EXPECT_CALL(*this, byte_stuffer_send_frame(_, _, _)).With(Args<1, 2>(ElementsAreArray(expected)));
validator_send_frame(0, original, 5);
}

22
quantum/serial_link/tests/rules.mk
View File

@ -1,22 +0,0 @@
serial_link_byte_stuffer_SRC :=\
$(SERIAL_PATH)/tests/byte_stuffer_tests.cpp \
$(SERIAL_PATH)/protocol/byte_stuffer.c
serial_link_frame_validator_SRC := \
$(SERIAL_PATH)/tests/frame_validator_tests.cpp \
$(SERIAL_PATH)/protocol/frame_validator.c
serial_link_frame_router_SRC := \
$(SERIAL_PATH)/tests/frame_router_tests.cpp \
$(SERIAL_PATH)/protocol/byte_stuffer.c \
$(SERIAL_PATH)/protocol/frame_validator.c \
$(SERIAL_PATH)/protocol/frame_router.c
serial_link_triple_buffered_object_SRC := \
$(SERIAL_PATH)/tests/triple_buffered_object_tests.cpp \
$(SERIAL_PATH)/protocol/triple_buffered_object.c
serial_link_transport_SRC := \
$(SERIAL_PATH)/tests/transport_tests.cpp \
$(SERIAL_PATH)/protocol/transport.c \
$(SERIAL_PATH)/protocol/triple_buffered_object.c

6
quantum/serial_link/tests/testlist.mk
View File

@ -1,6 +0,0 @@
TEST_LIST +=\
serial_link_byte_stuffer\
serial_link_frame_validator\
serial_link_frame_router\
serial_link_triple_buffered_object\
serial_link_transport

184
quantum/serial_link/tests/transport_tests.cpp
View File

@ -1,184 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 "gtest/gtest.h"
#include "gmock/gmock.h"
using testing::_;
using testing::Args;
using testing::ElementsAreArray;
extern "C" {
#include "serial_link/protocol/transport.h"
}
struct test_object1 {
uint32_t test;
};
struct test_object2 {
uint32_t test1;
uint32_t test2;
};
MASTER_TO_ALL_SLAVES_OBJECT(master_to_slave, test_object1);
MASTER_TO_SINGLE_SLAVE_OBJECT(master_to_single_slave, test_object1);
SLAVE_TO_MASTER_OBJECT(slave_to_master, test_object1);
static remote_object_t* test_remote_objects[] = {
REMOTE_OBJECT(master_to_slave),
REMOTE_OBJECT(master_to_single_slave),
REMOTE_OBJECT(slave_to_master),
};
class Transport : public testing::Test {
public:
Transport() {
Instance = this;
add_remote_objects(test_remote_objects, sizeof(test_remote_objects) / sizeof(remote_object_t*));
}
~Transport() {
Instance = nullptr;
reinitialize_serial_link_transport();
}
MOCK_METHOD0(signal_data_written, void());
MOCK_METHOD1(router_send_frame, void(uint8_t destination));
void router_send_frame(uint8_t destination, uint8_t* data, uint16_t size) {
router_send_frame(destination);
std::copy(data, data + size, std::back_inserter(sent_data));
}
static Transport* Instance;
std::vector<uint8_t> sent_data;
};
Transport* Transport::Instance = nullptr;
extern "C" {
void signal_data_written(void) { Transport::Instance->signal_data_written(); }
void router_send_frame(uint8_t destination, uint8_t* data, uint16_t size) { Transport::Instance->router_send_frame(destination, data, size); }
}
TEST_F(Transport, write_to_local_signals_an_event) {
begin_write_master_to_slave();
EXPECT_CALL(*this, signal_data_written());
end_write_master_to_slave();
begin_write_slave_to_master();
EXPECT_CALL(*this, signal_data_written());
end_write_slave_to_master();
begin_write_master_to_single_slave(1);
EXPECT_CALL(*this, signal_data_written());
end_write_master_to_single_slave(1);
}
TEST_F(Transport, writes_from_master_to_all_slaves) {
update_transport();
test_object1* obj = begin_write_master_to_slave();
obj->test = 5;
EXPECT_CALL(*this, signal_data_written());
end_write_master_to_slave();
EXPECT_CALL(*this, router_send_frame(0xFF));
update_transport();
transport_recv_frame(0, sent_data.data(), sent_data.size());
test_object1* obj2 = read_master_to_slave();
EXPECT_NE(obj2, nullptr);
EXPECT_EQ(obj2->test, 5);
}
TEST_F(Transport, writes_from_slave_to_master) {
update_transport();
test_object1* obj = begin_write_slave_to_master();
obj->test = 7;
EXPECT_CALL(*this, signal_data_written());
end_write_slave_to_master();
EXPECT_CALL(*this, router_send_frame(0));
update_transport();
transport_recv_frame(3, sent_data.data(), sent_data.size());
test_object1* obj2 = read_slave_to_master(2);
EXPECT_EQ(read_slave_to_master(0), nullptr);
EXPECT_NE(obj2, nullptr);
EXPECT_EQ(obj2->test, 7);
}
TEST_F(Transport, writes_from_master_to_single_slave) {
update_transport();
test_object1* obj = begin_write_master_to_single_slave(3);
obj->test = 7;
EXPECT_CALL(*this, signal_data_written());
end_write_master_to_single_slave(3);
EXPECT_CALL(*this, router_send_frame(4));
update_transport();
transport_recv_frame(0, sent_data.data(), sent_data.size());
test_object1* obj2 = read_master_to_single_slave();
EXPECT_NE(obj2, nullptr);
EXPECT_EQ(obj2->test, 7);
}
TEST_F(Transport, ignores_object_with_invalid_id) {
update_transport();
test_object1* obj = begin_write_master_to_single_slave(3);
obj->test = 7;
EXPECT_CALL(*this, signal_data_written());
end_write_master_to_single_slave(3);
EXPECT_CALL(*this, router_send_frame(4));
update_transport();
sent_data[sent_data.size() - 1] = 44;
transport_recv_frame(0, sent_data.data(), sent_data.size());
test_object1* obj2 = read_master_to_single_slave();
EXPECT_EQ(obj2, nullptr);
}
TEST_F(Transport, ignores_object_with_size_too_small) {
update_transport();
test_object1* obj = begin_write_master_to_slave();
obj->test = 7;
EXPECT_CALL(*this, signal_data_written());
end_write_master_to_slave();
EXPECT_CALL(*this, router_send_frame(_));
update_transport();
sent_data[sent_data.size() - 2] = 0;
transport_recv_frame(0, sent_data.data(), sent_data.size() - 1);
test_object1* obj2 = read_master_to_slave();
EXPECT_EQ(obj2, nullptr);
}
TEST_F(Transport, ignores_object_with_size_too_big) {
update_transport();
test_object1* obj = begin_write_master_to_slave();
obj->test = 7;
EXPECT_CALL(*this, signal_data_written());
end_write_master_to_slave();
EXPECT_CALL(*this, router_send_frame(_));
update_transport();
sent_data.resize(sent_data.size() + 22);
sent_data[sent_data.size() - 1] = 0;
transport_recv_frame(0, sent_data.data(), sent_data.size());
test_object1* obj2 = read_master_to_slave();
EXPECT_EQ(obj2, nullptr);
}

80
quantum/serial_link/tests/triple_buffered_object_tests.cpp
View File

@ -1,80 +0,0 @@
/*
The MIT License (MIT)
Copyright (c) 2016 Fred Sundvik
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 "gtest/gtest.h"
extern "C" {
#include "serial_link/protocol/triple_buffered_object.h"
}
struct test_object {
uint8_t state;
uint32_t buffer[3];
};
test_object test_object;
class TripleBufferedObject : public testing::Test {
public:
TripleBufferedObject() { triple_buffer_init((triple_buffer_object_t*)&test_object); }
};
TEST_F(TripleBufferedObject, writes_and_reads_object) {
*triple_buffer_begin_write(&test_object) = 0x3456ABCC;
triple_buffer_end_write(&test_object);
EXPECT_EQ(*triple_buffer_read(&test_object), 0x3456ABCC);
}
TEST_F(TripleBufferedObject, does_not_read_empty) { EXPECT_EQ(triple_buffer_read(&test_object), nullptr); }
TEST_F(TripleBufferedObject, writes_twice_and_reads_object) {
*triple_buffer_begin_write(&test_object) = 0x3456ABCC;
triple_buffer_end_write(&test_object);
*triple_buffer_begin_write(&test_object) = 0x44778899;
triple_buffer_end_write(&test_object);
EXPECT_EQ(*triple_buffer_read(&test_object), 0x44778899);
}
TEST_F(TripleBufferedObject, performs_another_write_in_the_middle_of_read) {
*triple_buffer_begin_write(&test_object) = 1;
triple_buffer_end_write(&test_object);
uint32_t* read = triple_buffer_read(&test_object);
*triple_buffer_begin_write(&test_object) = 2;
triple_buffer_end_write(&test_object);
EXPECT_EQ(*read, 1);
EXPECT_EQ(*triple_buffer_read(&test_object), 2);
EXPECT_EQ(triple_buffer_read(&test_object), nullptr);
}
TEST_F(TripleBufferedObject, performs_two_writes_in_the_middle_of_read) {
*triple_buffer_begin_write(&test_object) = 1;
triple_buffer_end_write(&test_object);
uint32_t* read = triple_buffer_read(&test_object);
*triple_buffer_begin_write(&test_object) = 2;
triple_buffer_end_write(&test_object);
*triple_buffer_begin_write(&test_object) = 3;
triple_buffer_end_write(&test_object);
EXPECT_EQ(*read, 1);
EXPECT_EQ(*triple_buffer_read(&test_object), 3);
EXPECT_EQ(triple_buffer_read(&test_object), nullptr);
}

1
show_options.mk
View File

@ -21,7 +21,6 @@ HARDWARE_OPTION_NAMES = \
RGBLIGHT_CUSTOM_DRIVER \
RGB_MATRIX_ENABLE \
RGB_MATRIX_DRIVER \
SERIAL_LINK_ENABLE \
CIE1931_CURVE \
MIDI_ENABLE \
BLUETOOTH_ENABLE \

1
testlist.mk
View File

@ -3,7 +3,6 @@ FULL_TESTS := $(TEST_LIST)
include $(ROOT_DIR)/quantum/debounce/tests/testlist.mk
include $(ROOT_DIR)/quantum/sequencer/tests/testlist.mk
include $(ROOT_DIR)/quantum/serial_link/tests/testlist.mk
include $(ROOT_DIR)/tmk_core/common/test/testlist.mk
define VALIDATE_TEST_LIST

2
tmk_core/common/sync_timer.c
View File

@ -26,7 +26,7 @@ SOFTWARE.
#include "sync_timer.h"
#include "keyboard.h"
#if (defined(SPLIT_KEYBOARD) || defined(SERIAL_LINK_ENABLE)) && !defined(DISABLE_SYNC_TIMER)
#if defined(SPLIT_KEYBOARD) && !defined(DISABLE_SYNC_TIMER)
volatile int32_t sync_timer_ms;
void sync_timer_init(void) { sync_timer_ms = 0; }

2
tmk_core/common/sync_timer.h
View File

@ -32,7 +32,7 @@ SOFTWARE.
extern "C" {
#endif
#if (defined(SPLIT_KEYBOARD) || defined(SERIAL_LINK_ENABLE)) && !defined(DISABLE_SYNC_TIMER)
#if defined(SPLIT_KEYBOARD) && !defined(DISABLE_SYNC_TIMER)
void sync_timer_init(void);
void sync_timer_update(uint32_t time);
uint16_t sync_timer_read(void);

21
tmk_core/protocol/chibios/chibios.c
View File

@ -43,9 +43,6 @@
#ifdef SLEEP_LED_ENABLE
# include "sleep_led.h"
#endif
#ifdef SERIAL_LINK_ENABLE
# include "serial_link/system/serial_link.h"
#endif
#ifdef MIDI_ENABLE
# include "qmk_midi.h"
#endif
@ -154,15 +151,11 @@ void protocol_init(void) {
setup_midi();
#endif
#ifdef SERIAL_LINK_ENABLE
init_serial_link();
#endif
host_driver_t *driver = NULL;
/* Wait until the USB or serial link is active */
/* Wait until USB is active */
while (true) {
#if defined(WAIT_FOR_USB) || defined(SERIAL_LINK_ENABLE)
#if defined(WAIT_FOR_USB)
if (USB_DRIVER.state == USB_ACTIVE) {
driver = &chibios_driver;
break;
@ -170,13 +163,6 @@ void protocol_init(void) {
#else
driver = &chibios_driver;
break;
#endif
#ifdef SERIAL_LINK_ENABLE
if (is_serial_link_connected()) {
driver = get_serial_link_driver();
break;
}
serial_link_update();
#endif
wait_ms(50);
}
@ -209,9 +195,6 @@ void protocol_task(void) {
print("[s]");
while (USB_DRIVER.state == USB_SUSPENDED) {
/* Do this in the suspended state */
# ifdef SERIAL_LINK_ENABLE
serial_link_update();
# endif
suspend_power_down(); // on AVR this deep sleeps for 15ms
/* Remote wakeup */
if (suspend_wakeup_condition()) {