mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-11-24 20:32:58 +00:00
Add first version of triple buffered object
This commit is contained in:
parent
c78eefba49
commit
50edb3d90c
33
serial_link/protocol/triple_buffered_object.c
Normal file
33
serial_link/protocol/triple_buffered_object.c
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
/*
|
||||||
|
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 "protocol/triple_buffered_object.h"
|
||||||
|
|
||||||
|
void triple_buffer_write(uint16_t object_size, triple_buffer_object_t* object, void* src) {
|
||||||
|
memcpy(object->buffer, src, object_size);
|
||||||
|
}
|
||||||
|
|
||||||
|
void triple_buffer_read(uint16_t object_size, triple_buffer_object_t* object, void* dst) {
|
||||||
|
memcpy(dst, object->buffer, object_size);
|
||||||
|
}
|
37
serial_link/protocol/triple_buffered_object.h
Normal file
37
serial_link/protocol/triple_buffered_object.h
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
/*
|
||||||
|
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.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef SERIAL_LINK_TRIPLE_BUFFERED_OBJECT_H
|
||||||
|
#define SERIAL_LINK_TRIPLE_BUFFERED_OBJECT_H
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
uint8_t state;
|
||||||
|
uint8_t buffer[];
|
||||||
|
}triple_buffer_object_t;
|
||||||
|
|
||||||
|
void triple_buffer_write(uint16_t object_size, triple_buffer_object_t* object, void* src);
|
||||||
|
void triple_buffer_read(uint16_t object_size, triple_buffer_object_t* object, void* dst);
|
||||||
|
|
||||||
|
|
||||||
|
#endif
|
44
serial_link/tests/triple_buffered_object_tests.c
Normal file
44
serial_link/tests/triple_buffered_object_tests.c
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
/*
|
||||||
|
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 <cgreen/cgreen.h>
|
||||||
|
#include "protocol/triple_buffered_object.c"
|
||||||
|
|
||||||
|
Describe(TripleBufferedObject);
|
||||||
|
BeforeEach(TripleBufferedObject) {}
|
||||||
|
AfterEach(TripleBufferedObject) {}
|
||||||
|
|
||||||
|
typedef struct {
|
||||||
|
uint8_t state;
|
||||||
|
uint32_t buffer[3];
|
||||||
|
}test_object_t;
|
||||||
|
|
||||||
|
Ensure(TripleBufferedObject, writes_and_and_reads_object) {
|
||||||
|
test_object_t test_object;
|
||||||
|
uint32_t src = 0x3456ABCC;
|
||||||
|
uint32_t dst;
|
||||||
|
triple_buffer_write(4, (triple_buffer_object_t*)&test_object, &src);
|
||||||
|
triple_buffer_read(4, (triple_buffer_object_t*)&test_object, &dst);
|
||||||
|
assert_that(dst, is_equal_to(src));
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user