Merge commit '4a394d97f7b44fa729d3e928a67036de69952a82'

Author: ZiGaMi

CHANGE_LOG.md

@@ -4,6 +4,19 @@ All notable changes to this project/module will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project/module adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+---
+## V2.2.0 - 06.06.2025
+
+### Added
+ - New API functions for get full and empty state of buffers
+
+### Changed
+ - Fixing compiler warnigns on implicit type conversions
+
+### Fixed
+ - Possible compiler out of order execution (added compiler barriers)
+ - Race conditions (added atomic counter)
+
 ---
 ## V2.1.0 - 22.08.2023
 

LICENSE

@@ -51,19 +51,21 @@ Guidance for multi-entry usage:
 
 | API Functions | Description | Prototype |
 | --- | ----------- | ----- |
-| **ring_buffer_init** | Initialization of ring buffer | ring_buffer_status_t ring_buffer_init(p_ring_buffer_t * p_ring_buffer, const uint32_t size, const ring_buffer_attr_t * const p_attr) |
-| **ring_buffer_is_init** | Get initialization flag | ring_buffer_status_t ring_buffer_is_init(p_ring_buffer_t buf_inst, bool * const p_is_init) |
-| **ring_buffer_add** | Add element to ring buffer in FIFO form | ring_buffer_status_t ring_buffer_add(p_ring_buffer_t buf_inst, const void * const p_item) |
-| **ring_buffer_add_multi** | Add multiple elements to ring buffer in FIFO form | ring_buffer_status_t ring_buffer_add_many(p_ring_buffer_t buf_inst, const void * const p_item, const uint32_t size) |
-| **ring_buffer_get** | Get element from ring buffer in FIFO form | ring_buffer_status_t ring_buffer_get(p_ring_buffer_t buf_inst, void * const p_item) |
-| **ring_buffer_get_multi** | Get multiple elements from ring buffer in FIFO form | ring_buffer_status_t ring_buffer_get_multi(p_ring_buffer_t buf_inst, void * const p_item, const uint32_t size) |
-| **ring_buffer_get_by_index** | Get element from ring buffer without any side effects. Access by index. | ring_buffer_status_t	ring_buffer_get_by_index(p_ring_buffer_t buf_inst, void * const p_item, const int32_t idx) |
-| **ring_buffer_reset** | Reset ring buffer | ring_buffer_status_t	ring_buffer_reset(p_ring_buffer_t buf_inst) |
-| **ring_buffer_get_name** | Get ring buffer name | ring_buffer_status_t ring_buffer_get_name(p_ring_buffer_t buf_inst, char * const p_name)|
-| **ring_buffer_get_taken** | Get number of taken space of elements inside a buffer | ring_buffer_status_t	ring_buffer_get_taken(p_ring_buffer_t buf_inst, uint32_t * const p_taken)|
-| **ring_buffer_get_free** | Get number of free space of elements inside a buffer | ring_buffer_status_t ring_buffer_get_free(p_ring_buffer_t buf_inst, uint32_t * const p_free)|
-| **ring_buffer_get_size** | Get size of all items inside ring buffer | ring_buffer_status_t ring_buffer_get_size(p_ring_buffer_t buf_inst, uint32_t * const p_size)|
-| **ring_buffer_get_item_size** | Get item size in bytes | ring_buffer_status_t ring_buffer_get_item_size(p_ring_buffer_t buf_inst, uint32_t * const p_item_size)|
+| **ring_buffer_init** 				| Initialization of ring buffer | ring_buffer_status_t ring_buffer_init(p_ring_buffer_t * p_ring_buffer, const uint32_t size, const ring_buffer_attr_t * const p_attr) |
+| **ring_buffer_is_init** 			| Get initialization flag | ring_buffer_status_t ring_buffer_is_init(p_ring_buffer_t buf_inst, bool * const p_is_init) |
+| **ring_buffer_add** 				| Add element to ring buffer in FIFO form | ring_buffer_status_t ring_buffer_add(p_ring_buffer_t buf_inst, const void * const p_item) |
+| **ring_buffer_add_multi** 		| Add multiple elements to ring buffer in FIFO form | ring_buffer_status_t ring_buffer_add_many(p_ring_buffer_t buf_inst, const void * const p_item, const uint32_t size) |
+| **ring_buffer_get** 				| Get element from ring buffer in FIFO form | ring_buffer_status_t ring_buffer_get(p_ring_buffer_t buf_inst, void * const p_item) |
+| **ring_buffer_get_multi** 		| Get multiple elements from ring buffer in FIFO form | ring_buffer_status_t ring_buffer_get_multi(p_ring_buffer_t buf_inst, void * const p_item, const uint32_t size) |
+| **ring_buffer_get_by_index** 		| Get element from ring buffer without any side effects. Access by index. | ring_buffer_status_t	ring_buffer_get_by_index(p_ring_buffer_t buf_inst, void * const p_item, const int32_t idx) |
+| **ring_buffer_reset** 			| Reset ring buffer | ring_buffer_status_t	ring_buffer_reset(p_ring_buffer_t buf_inst) |
+| **ring_buffer_get_name** 			| Get ring buffer name | ring_buffer_status_t ring_buffer_get_name(p_ring_buffer_t buf_inst, char * const p_name)|
+| **ring_buffer_get_taken** 		| Get number of taken space of elements inside a buffer | ring_buffer_status_t	ring_buffer_get_taken(p_ring_buffer_t buf_inst, uint32_t * const p_taken)|
+| **ring_buffer_get_free** 			| Get number of free space of elements inside a buffer | ring_buffer_status_t ring_buffer_get_free(p_ring_buffer_t buf_inst, uint32_t * const p_free)|
+| **ring_buffer_get_size** 			| Get size of all items inside ring buffer | ring_buffer_status_t ring_buffer_get_size(p_ring_buffer_t buf_inst, uint32_t * const p_size)|
+| **ring_buffer_get_item_size** 	| Get item size in bytes | ring_buffer_status_t ring_buffer_get_item_size(p_ring_buffer_t buf_inst, uint32_t * const p_item_size)|
+| **ring_buffer_is_full** 			| Is buffer full | ring_buffer_status_t ring_buffer_is_full(p_ring_buffer_t buf_inst, bool * const p_full)|
+| **ring_buffer_is_empty** 			| Is buffer empty | ring_buffer_status_t ring_buffer_is_empty(p_ring_buffer_t buf_inst, bool * const p_empty)|
 
 ## **Usage**
 
@@ -142,7 +144,6 @@ while( eRING_BUFFER_EMPTY != ring_buffer_get( my_ring_buffer, &item ))
     // Do something with "item" value here...
 }
 
-
 // =============================================================
 //  GETTING VALUE BY INDEX 
 // =============================================================