add tusbd_cdc_is_busy

enhance cdc serial device demo
refractor fifo.c

2 files changed, 98 insertions, 122 deletions

diff --git a/tinyusb/common/fifo.c b/tinyusb/common/fifo.c
index d488d4821..c6b6dc449 100644
--- a/tinyusb/common/fifo.c
+++ b/tinyusb/common/fifo.c
@@ -35,68 +35,13 @@
 	This file is part of the tinyusb stack.
 */
 /**************************************************************************/
-
+#include <string.h>
 #include "fifo.h"
 
-/**************************************************************************/
-/*!
-    @brief Disables the IRQ specified in the FIFO's 'irq' field
-           to prevent reads/write issues with interrupts
-
-    @param[in]  f
-                Pointer to the FIFO that should be protected
-*/
-/**************************************************************************/
-static inline void mutex_lock (fifo_t* f)
-{
-//  if (f->irq > 0)
-//    NVIC_DisableIRQ(f->irq);
-}
-
-/**************************************************************************/
-/*!
-    @brief Re-enables the IRQ specified in the FIFO's 'irq' field
-
-    @param[in]  f
-                Pointer to the FIFO that should be protected
-*/
-/**************************************************************************/
-static inline void mutex_unlock (fifo_t* f)
-{
-//  if (f->irq > 0)
-//    NVIC_EnableIRQ(f->irq);
-}
-
-/**************************************************************************/
-/*!
-    @brief Initialises the FIFO buffer
+static inline void mutex_lock   (fifo_t* f) ATTR_ALWAYS_INLINE;
+static inline void mutex_unlock (fifo_t* f) ATTR_ALWAYS_INLINE;
+static inline bool is_fifo_initalized(fifo_t* f) ATTR_ALWAYS_INLINE;
 
-    @param[in]  f
-                Pointer to the fifo_t object to intiialize
-    @param[in]  buffer
-                Pointer to the buffer's location in memory
-    @param[in]  size
-                The buffer size in bytes
-    @param[in]  overwritable
-                Set to TRUE is the FIFO is overwritable when the FIFO
-                is full (the first element will be overwritten)
-    @param[in]  irq
-                The IRQ number to disable for MUTEX protection.
-                Set the -1 if not required.
-*/
-/**************************************************************************/
-bool fifo_init(fifo_t* f, uint8_t* buffer, uint16_t size, bool overwritable) //, IRQn_Type irq)
-{
-  ASSERT(size > 0, false);
-
-  f->buf = buffer;
-  f->size = size;
-  f->rd_ptr = f->wr_ptr = f->len = 0;
-  f->overwritable = overwritable;
-//  f->irq = irq;
-
-  return true;
-}
 
 /**************************************************************************/
 /*!
@@ -114,16 +59,20 @@ bool fifo_init(fifo_t* f, uint8_t* buffer, uint16_t size, bool overwritable) //,
     @returns TRUE if the queue is not empty
 */
 /**************************************************************************/
-bool fifo_read(fifo_t* f, uint8_t *data)
+bool fifo_read(fifo_t* f, void * p_buffer)
 {
-  if (fifo_is_empty(f))
+  if( !is_fifo_initalized(f) || fifo_is_empty(f) )
+  {
     return false;
+  }
 
   mutex_lock(f);
 
-  *data = f->buf[f->rd_ptr];
-  f->rd_ptr = (f->rd_ptr + 1) % f->size;
-  f->len--;
+  memcpy(p_buffer,
+         f->buffer + (f->rd_idx * f->item_size),
+         f->item_size);
+  f->rd_idx = (f->rd_idx + 1) % f->depth;
+  f->count--;
 
   mutex_unlock(f);
 
@@ -132,33 +81,6 @@ bool fifo_read(fifo_t* f, uint8_t *data)
 
 /**************************************************************************/
 /*!
-    @brief Read a byte array from FIFO
-
-    @param[in]  f
-                Pointer to the FIFO buffer to manipulate
-    @param[in]  rx
-                Pointer to the place holder for data read from the buffer
-    @param[in]  maxlen
-                The maximum number of bytes to read from the FIFO
-
-    @returns The actual number of bytes read from the FIFO
- */
-/**************************************************************************/
-uint16_t fifo_read_n(fifo_t* f, uint8_t* rx, uint16_t maxlen)
-{
-  uint16_t len = 0;
-  
-  while ( len < maxlen && fifo_read(f, rx) )
-  {
-    len++;
-    rx++;
-  }
-  
-  return len;
-}
-
-/**************************************************************************/
-/*!
     @brief Write one byte into the RX buffer.
 
     This function will write one byte into the array index specified by
@@ -174,22 +96,27 @@ uint16_t fifo_read_n(fifo_t* f, uint8_t* rx, uint16_t maxlen)
              FIFO will always return TRUE)
 */
 /**************************************************************************/
-bool fifo_write(fifo_t* f, uint8_t data)
+bool fifo_write(fifo_t* f, void const * p_data)
 {
-  if ( fifo_is_full(f) && f->overwritable == false)
-      return false;
+  if ( !is_fifo_initalized(f) || (fifo_is_full(f) && !f->overwritable) )
+  {
+    return false;
+  }
 
   mutex_lock(f);
 
-  f->buf[f->wr_ptr] = data;
-  f->wr_ptr = (f->wr_ptr + 1) % f->size;
+  memcpy( f->buffer + (f->wr_idx * f->item_size),
+          p_data,
+          f->item_size);
+
+  f->wr_idx = (f->wr_idx + 1) % f->depth;
 
   if (fifo_is_full(f))
   {
-    f->rd_ptr = f->wr_ptr; // keep the full state (rd == wr && len = size)
+    f->rd_idx = f->wr_idx; // keep the full state (rd == wr && len = size)
   }else
   {
-    f->len++;
+    f->count++;
   }
 
   mutex_unlock(f);
@@ -209,9 +136,53 @@ void fifo_clear(fifo_t *f)
 {
   mutex_lock(f);
 
-  f->rd_ptr = 0;
-  f->wr_ptr = 0;
-  f->len = 0;
+  f->rd_idx = f->wr_idx = f->count = 0;
 
   mutex_unlock(f);
 }
+
+//--------------------------------------------------------------------+
+// HELPER FUNCTIONS
+//--------------------------------------------------------------------+
+
+/**************************************************************************/
+/*!
+    @brief Disables the IRQ specified in the FIFO's 'irq' field
+           to prevent reads/write issues with interrupts
+
+    @param[in]  f
+                Pointer to the FIFO that should be protected
+*/
+/**************************************************************************/
+static inline void mutex_lock (fifo_t* f)
+{
+//  if (f->irq > 0)
+//  {
+//    #if !defined (_TEST_)
+//    NVIC_DisableIRQ(f->irq);
+//    #endif
+//  }
+}
+
+/**************************************************************************/
+/*!
+    @brief Re-enables the IRQ specified in the FIFO's 'irq' field
+
+    @param[in]  f
+                Pointer to the FIFO that should be protected
+*/
+/**************************************************************************/
+static inline void mutex_unlock (fifo_t* f)
+{
+//  if (f->irq > 0)
+//  {
+//    #if !defined (_TEST_)
+//    NVIC_EnableIRQ(f->irq);
+//    #endif
+//  }
+}
+
+static inline bool is_fifo_initalized(fifo_t* f)
+{
+  return !( f->buffer == NULL || f->depth == 0 || f->item_size == 0);
+}
diff --git a/tinyusb/common/fifo.h b/tinyusb/common/fifo.h
index ef33bb956..daef4a84a 100644
--- a/tinyusb/common/fifo.h
+++ b/tinyusb/common/fifo.h
@@ -36,12 +36,6 @@
 */
 /**************************************************************************/
 
-/** \file
- *  \brief Error Header
- *
- *  \note TBD
- */
-
 /** \ingroup Group_Common
  *
  *  @{
@@ -59,36 +53,47 @@
 /** \struct fifo_t
  * \brief Simple Circular FIFO
  */
-typedef struct _fifo_t
+typedef struct
 {
-           uint8_t* buf          ; ///< buffer pointer
-           uint16_t size         ; ///< buffer size
-  volatile uint16_t len          ; ///< bytes in fifo
-  volatile uint16_t wr_ptr       ; ///< write pointer
-  volatile uint16_t rd_ptr       ; ///< read pointer
-           bool     overwritable ; ///< allow overwrite data when full
-//           IRQn_Type irq         ; ///< TODO (abstract later) interrupt used to lock fifo
+           uint16_t const depth     ; ///< max items
+           uint16_t const item_size ; ///< size of each item
+  volatile uint16_t count           ; ///< number of items in queue
+  volatile uint16_t wr_idx          ; ///< write pointer
+  volatile uint16_t rd_idx          ; ///< read pointer
+           bool overwritable        ;
+           uint8_t buffer[]         ; ///< buffer pointer
+  // IRQn_Type irq;
 } fifo_t;
 
-bool fifo_init(fifo_t* f, uint8_t* buffer, uint16_t size, bool overwritable); //, IRQn_Type irq);
-bool fifo_write(fifo_t* f, uint8_t data);
-bool fifo_read(fifo_t* f, uint8_t *data);
-uint16_t fifo_read_n(fifo_t* f, uint8_t * rx, uint16_t maxlen);
+#define FIFO_DEF(name, ff_depth, type, is_overwritable) /*, irq_mutex)*/ \
+  fifo_t name = {\
+      .depth        = ff_depth,\
+      .item_size    = sizeof(type),\
+      .overwritable = is_overwritable,\
+      /*.irq          = irq_mutex*/\
+      .buffer       = { [ff_depth*sizeof(type) - 1] = 0 },\
+  }
+
+bool fifo_write(fifo_t* f, void const * p_data);
+bool fifo_read(fifo_t* f, void * p_buffer);
 void fifo_clear(fifo_t *f);
 
+static inline bool fifo_is_empty(fifo_t* f) ATTR_PURE ATTR_ALWAYS_INLINE;
 static inline bool fifo_is_empty(fifo_t* f)
 {
-  return (f->len == 0);
+  return (f->count == 0);
 }
 
+static inline bool fifo_is_full(fifo_t* f) ATTR_PURE ATTR_ALWAYS_INLINE;
 static inline bool fifo_is_full(fifo_t* f)
 {
-  return (f->len == f->size);
+  return (f->count == f->depth);
 }
 
+static inline uint16_t fifo_get_length(fifo_t* f) ATTR_PURE ATTR_ALWAYS_INLINE;
 static inline uint16_t fifo_get_length(fifo_t* f)
 {
-  return f->len;
+  return f->count;
 }
 
 #ifdef __cplusplus