Merge branch 'develop'

Author: MaJerle

docs/conf.py

@@ -27,7 +27,7 @@
 author = 'Tilen MAJERLE'
 
 # The full version, including alpha/beta/rc tags
-version = '2.0.0'
+version = '2.0.1'
 
 # Try to get branch at which this is running
 # and try to determine which version to display in sphinx

docs/examples_src/example_advance_1.c

@@ -1,4 +1,4 @@
-/* Declare buffer variables */
+/* Declare rb instance & raw data */
 lwrb_t buff;
 uint8_t buff_data[8];
 

docs/examples_src/example_advance_2.c

@@ -1,11 +1,11 @@
 #include "lwrb/lwrb.h"
 
-/* Buffer variables */
-lwrb_t buff;                            /* Declare ring buffer structure */
-uint8_t buff_data[8];                       /* Declare raw buffer data array */
+/* Declare rb instance & raw data */
+lwrb_t buff;
+uint8_t buff_data[8];
 
-/* Application variables
-uint8_t data[2];                            /* Application working data */
+/* Application variables */
+uint8_t data[2];
 
 /* Application code ... */
 lwrb_init(&buff, buff_data, sizeof(buff_data)); /* Initialize buffer */

docs/examples_src/example_dma_skip.c

@@ -1,4 +1,4 @@
-/* Buffer */
+/* Declare rb instance & raw data */
 lwrb_t buff;
 uint8_t buff_data[8];
 

docs/examples_src/example_index.c

@@ -1,9 +1,9 @@
-/* Buffer variables */
-lwrb_t buff;                            /* Declare ring buffer structure */
-uint8_t buff_data[8];                       /* Declare raw buffer data array */
+/* Declare rb instance & raw data */
+lwrb_t buff;
+uint8_t buff_data[8];
 
 /* Application variables */
-uint8_t data[2];                            /* Application working data */
+uint8_t data[2];
 size_t len;
 
 /* Application code ... */

docs/examples_src/example_minimal.c

@@ -1,11 +1,11 @@
 #include "lwrb/lwrb.h"
 
-/* Buffer variables */
-lwrb_t buff;                            /* Declare ring buffer structure */
-uint8_t buff_data[8];                       /* Declare raw buffer data array */
+/* Declare rb instance & raw data */
+lwrb_t buff;
+uint8_t buff_data[8];
 
-/* Application variables
-uint8_t data[2];                            /* Application working data */
+/* Application variables */
+uint8_t data[2];     /* Application working data */
 
 /* Application code ... */
 lwrb_init(&buff, buff_data, sizeof(buff_data)); /* Initialize buffer */

docs/examples_src/example_skip_1.c

@@ -1,7 +1,6 @@
-
 #include "lwrb/lwrb.h"
 
-/* Declare buffer variables */
+/* Declare rb instance & raw data */
 lwrb_t buff;
 uint8_t buff_data[8];
 

docs/examples_src/example_skip_2.c

@@ -1,7 +1,8 @@
 /* Initialization part skipped */
 
 /* Get length of linear memory at read pointer */
-/* When function returns 0, there is no memory available in the buffer for read anymore */
+/* When function returns 0, there is no memory
+   available in the buffer for read anymore */
 while ((len = lwrb_get_linear_block_read_length(&buff)) > 0) {
     /* Get pointer to first element in linear block at read address */
     data = lwrb_get_linear_block_read_address(&buff);

docs/examples_src/example_thread_safety.c

@@ -0,0 +1,47 @@
+/* Declare variables */
+lwrb_t rb;
+
+/* 2 mutexes, one for write operations,
+    one for read operations */
+mutex_t m_w, m_r;
+
+/* 4 threads below, 2 for write, 2 for read */
+void
+thread_write_1(void* arg) {
+    /* Use write mutex */
+    while (1) {
+        mutex_get(&m_w);
+        lwrb_write(&rb, ...);
+        mutex_give(&m_w);
+    }
+}
+
+void
+thread_write_2(void* arg) {
+    /* Use write mutex */
+    while (1) {
+        mutex_get(&m_w);
+        lwrb_write(&rb, ...);
+        mutex_give(&m_w);
+    }
+}
+
+void
+thread_read_1(void* arg) {
+    /* Use read mutex */
+    while (1) {
+        mutex_get(&m_r);
+        lwrb_read(&rb, ...);
+        mutex_give(&m_r);
+    }
+}
+
+void
+thread_read_2(void* arg) {
+    /* Use read mutex */
+    while (1) {
+        mutex_get(&m_r);
+        lwrb_read(&rb, ...);
+        mutex_give(&m_r);
+    }
+}

docs/examples_src/example_tt_buff_size.c

@@ -11,7 +11,8 @@ uint32_t d[2];
 lwrb_t buff_1;
 lwrb_t buff_2;
 
-/* Create data for buffers. Use sizeof structure, multiplied by N (for N instances) */
+/* Create data for buffers. Use sizeof structure,
+   multiplied by N (for N instances) */
 /* Buffer with + 1 bytes bigger memory */
 uint8_t buff_data_1[sizeof(d) * N + 1];
 /* Buffer without + 1 at the end */