-
-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
1,459 additions
and
246 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Packet protocol manager | ||
|
|
||
| ## Features | ||
|
|
||
| * Written in ANSI C99, compatible with ``size_t`` for size data types | ||
| * Implements simple protocol for (one target) RS-485 communication with multiple slaves | ||
| * Variable number of length bytes available to support packet longer than `255` bytes | ||
| * Supports CRC-8 integrity check | ||
| * Uses ringbuffers for TX and RX data, gives application full autonomy for data transmit or receive | ||
| * Supports manual packet state reset if timeout detected by application | ||
| * Operating system ready, thread-safe API | ||
| * User friendly MIT license | ||
|
|
||
| ## Contribute | ||
|
|
||
| Fresh contributions are always welcome. Simple instructions to proceed:: | ||
|
|
||
| 1. Fork Github repository | ||
| 2. Respect [C style & coding rules](https://github.com/MaJerle/c-code-style) used by the library | ||
| 3. Create a pull request to develop branch with new features or bug fixes | ||
|
|
||
| Alternatively you may: | ||
|
|
||
| 1. Report a bug | ||
| 2. Ask for a feature request |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /** | ||
| * \file lwpkt_opts_template.h | ||
| * \brief LwPKT configuration file | ||
| */ | ||
|
|
||
| /* | ||
| * Copyright (c) 2020 Tilen MAJERLE | ||
| * | ||
| * 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. | ||
| * | ||
| * This file is part of LwPKT - Lightweight packet protocol library. | ||
| * | ||
| * Author: Tilen MAJERLE <tilen@majerle.eu> | ||
| * Version: v1.0.0 | ||
| */ | ||
| #ifndef LWPKT_HDR_OPTS_H | ||
| #define LWPKT_HDR_OPTS_H | ||
|
|
||
| /* Rename this file to "lwpkt_opts.h" for your application */ | ||
|
|
||
| /* | ||
| * Open "include/lwpkt/lwpkt_opt.h" and | ||
| * copy & replace here settings you want to change values | ||
| */ | ||
|
|
||
| #endif /* LWPKT_HDR_OPTS_H */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| /** | ||
| * \file lwrb.h | ||
| * \brief LwRB - Lightweight ring buffer | ||
| */ | ||
|
|
||
| /* | ||
| * Copyright (c) 2020 Tilen MAJERLE | ||
| * | ||
| * 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. | ||
| * | ||
| * This file is part of LwRB - Lightweight ring buffer library. | ||
| * | ||
| * Author: Tilen MAJERLE <tilen@majerle.eu> | ||
| * Version: v1.3.1 | ||
| */ | ||
| #ifndef LWRB_HDR_H | ||
| #define LWRB_HDR_H | ||
|
|
||
| #include <string.h> | ||
| #include <stdint.h> | ||
|
|
||
| #ifdef __cplusplus | ||
| extern "C" { | ||
| #endif /* __cplusplus */ | ||
|
|
||
| /** | ||
| * \defgroup LWRB Lightweight ring buffer manager | ||
| * \brief Lightweight ring buffer manager | ||
| * \{ | ||
| */ | ||
|
|
||
| /** | ||
| * \brief Enable buffer structure pointer parameter as volatile | ||
| * To use this feature, uncomment keyword below | ||
| */ | ||
| #define LWRB_VOLATILE /* volatile */ | ||
|
|
||
| /** | ||
| * \brief Adds 2 magic words to make sure if memory is corrupted | ||
| * application can detect wrong data pointer and maximum size | ||
| */ | ||
| #define LWRB_USE_MAGIC 1 | ||
|
|
||
| /** | ||
| * \brief Event type for buffer operations | ||
| */ | ||
| typedef enum { | ||
| LWRB_EVT_READ, /*!< Read event */ | ||
| LWRB_EVT_WRITE, /*!< Write event */ | ||
| LWRB_EVT_RESET, /*!< Reset event */ | ||
| } lwrb_evt_type_t; | ||
|
|
||
| /** | ||
| * \brief Buffer structure forward declaration | ||
| */ | ||
| struct lwrb; | ||
|
|
||
| /** | ||
| * \brief Event callback function type | ||
| * \param[in] buff: Buffer handle for event | ||
| * \param[in] evt: Event type | ||
| * \param[in] bp: Number of bytes written or read (when used), depends on event type | ||
| */ | ||
| typedef void (*lwrb_evt_fn)(LWRB_VOLATILE struct lwrb* buff, lwrb_evt_type_t evt, size_t bp); | ||
|
|
||
| /** | ||
| * \brief Buffer structure | ||
| */ | ||
| typedef struct lwrb { | ||
| #if LWRB_USE_MAGIC | ||
| uint32_t magic1; /*!< Magic 1 word */ | ||
| #endif /* LWRB_USE_MAGIC */ | ||
| uint8_t* buff; /*!< Pointer to buffer data. | ||
| Buffer is considered initialized when `buff != NULL` and `size > 0` */ | ||
| size_t size; /*!< Size of buffer data. Size of actual buffer is `1` byte less than value holds */ | ||
| size_t r; /*!< Next read pointer. Buffer is considered empty when `r == w` and full when `w == r - 1` */ | ||
| size_t w; /*!< Next write pointer. Buffer is considered empty when `r == w` and full when `w == r - 1` */ | ||
| lwrb_evt_fn evt_fn; /*!< Pointer to event callback function */ | ||
| #if LWRB_USE_MAGIC | ||
| uint32_t magic2; /*!< Magic 2 word */ | ||
| #endif /* LWRB_USE_MAGIC */ | ||
| } lwrb_t; | ||
|
|
||
| uint8_t lwrb_init(LWRB_VOLATILE lwrb_t* buff, void* buffdata, size_t size); | ||
| uint8_t lwrb_is_ready(LWRB_VOLATILE lwrb_t* buff); | ||
| void lwrb_free(LWRB_VOLATILE lwrb_t* buff); | ||
| void lwrb_reset(LWRB_VOLATILE lwrb_t* buff); | ||
| void lwrb_set_evt_fn(LWRB_VOLATILE lwrb_t* buff, lwrb_evt_fn fn); | ||
|
|
||
| /* Read/Write functions */ | ||
| size_t lwrb_write(LWRB_VOLATILE lwrb_t* buff, const void* data, size_t btw); | ||
| size_t lwrb_read(LWRB_VOLATILE lwrb_t* buff, void* data, size_t btr); | ||
| size_t lwrb_peek(LWRB_VOLATILE lwrb_t* buff, size_t skip_count, void* data, size_t btp); | ||
|
|
||
| /* Buffer size information */ | ||
| size_t lwrb_get_free(LWRB_VOLATILE lwrb_t* buff); | ||
| size_t lwrb_get_full(LWRB_VOLATILE lwrb_t* buff); | ||
|
|
||
| /* Read data block management */ | ||
| void* lwrb_get_linear_block_read_address(LWRB_VOLATILE lwrb_t* buff); | ||
| size_t lwrb_get_linear_block_read_length(LWRB_VOLATILE lwrb_t* buff); | ||
| size_t lwrb_skip(LWRB_VOLATILE lwrb_t* buff, size_t len); | ||
|
|
||
| /* Write data block management */ | ||
| void* lwrb_get_linear_block_write_address(LWRB_VOLATILE lwrb_t* buff); | ||
| size_t lwrb_get_linear_block_write_length(LWRB_VOLATILE lwrb_t* buff); | ||
| size_t lwrb_advance(LWRB_VOLATILE lwrb_t* buff, size_t len); | ||
|
|
||
| /** | ||
| * \} | ||
| */ | ||
|
|
||
| #ifdef __cplusplus | ||
| } | ||
| #endif /* __cplusplus */ | ||
|
|
||
| #endif /* LWRB_HDR_H */ |
Oops, something went wrong.