Add a bit-level transfer queue

[openocd.git] / src / helper / binarybuffer.h

diff --git a/src/helper/binarybuffer.h b/src/helper/binarybuffer.h
index 460d0178ad17a1ef8e9176e47818d81f7320508e..cc0be57dcfbac7dcda4160d3d3b468236c36f821 100644 (file)
--- a/src/helper/binarybuffer.h
+++ b/src/helper/binarybuffer.h
@@ -20,10 +20,11 @@
  *   Free Software Foundation, Inc.,                                       *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
+
 #ifndef BINARYBUFFER_H
 #define BINARYBUFFER_H
 
-#include "types.h"
+#include "list.h"
 
 /** @file
  * Support functions to access arbitrary bits in a byte array
@@ -39,17 +40,17 @@
  * @param value Up to 32 bits that will be copied to _buffer.
  */
 static inline void buf_set_u32(void *_buffer,
-               unsigned first, unsigned num, uint32_t value)
+       unsigned first, unsigned num, uint32_t value)
 {
-       char *buffer = (char *)_buffer;
+       uint8_t *buffer = (uint8_t *)_buffer;
+
        if ((num == 32) && (first == 0)) {
                buffer[3] = (value >> 24) & 0xff;
                buffer[2] = (value >> 16) & 0xff;
                buffer[1] = (value >> 8) & 0xff;
                buffer[0] = (value >> 0) & 0xff;
        } else {
-               for (unsigned i = first; i < first + num; i++)
-               {
+               for (unsigned i = first; i < first + num; i++) {
                        if (((value >> (i - first)) & 1) == 1)
                                buffer[i / 8] |= 1 << (i % 8);
                        else
@@ -67,18 +68,18 @@ static inline void buf_set_u32(void *_buffer,
  * @returns Up to 32-bits that were read from @c _buffer.
  */
 static inline uint32_t buf_get_u32(const void *_buffer,
-               unsigned first, unsigned num)
+       unsigned first, unsigned num)
 {
-       char *buffer = (char *)_buffer;
+       uint8_t *buffer = (uint8_t *)_buffer;
+
        if ((num == 32) && (first == 0)) {
                return (((uint32_t)buffer[3]) << 24) |
-                       (((uint32_t)buffer[2]) << 16) |
-                       (((uint32_t)buffer[1]) << 8) |
-                       (((uint32_t)buffer[0]) << 0);
+                               (((uint32_t)buffer[2]) << 16) |
+                               (((uint32_t)buffer[1]) << 8) |
+                               (((uint32_t)buffer[0]) << 0);
        } else {
                uint32_t result = 0;
-               for (unsigned i = first; i < first + num; i++)
-               {
+               for (unsigned i = first; i < first + num; i++) {
                        if (((buffer[i / 8] >> (i % 8)) & 1) == 1)
                                result |= 1 << (i - first);
                }
@@ -107,7 +108,7 @@ bool buf_cmp_mask(const void *buf1, const void *buf2,
  * @param to The buffer that will receive the copy of @c from.
  * @param size The number of bits to copy.
  */
-void* buf_cpy(const void *from, void *to, unsigned size);
+void *buf_cpy(const void *from, void *to, unsigned size);
 
 /**
  * Set the contents of @c buf with @c count bits, all set to 1.
@@ -115,14 +116,14 @@ void* buf_cpy(const void *from, void *to, unsigned size);
  * @param size The number of bits.
  * @returns The original buffer (@c buf).
  */
-void* buf_set_ones(void *buf, unsigned size);
+void *buf_set_ones(void *buf, unsigned size);
 
-void* buf_set_buf(const void *src, unsigned src_start,
-               void *dst, unsigned dst_start, unsigned len);
+void *buf_set_buf(const void *src, unsigned src_start,
+                 void *dst, unsigned dst_start, unsigned len);
 
 int str_to_buf(const char *str, unsigned len,
                void *bin_buf, unsigned buf_size, unsigned radix);
-char* buf_to_str(const void *buf, unsigned size, unsigned radix);
+char *buf_to_str(const void *buf, unsigned size, unsigned radix);
 
 /* read a uint32_t from a buffer in target memory endianness */
 static inline uint32_t fast_target_buffer_get_u32(const void *p, bool le)
@@ -130,4 +131,29 @@ static inline uint32_t fast_target_buffer_get_u32(const void *p, bool le)
        return le ? le_to_h_u32(p) : be_to_h_u32(p);
 }
 
+static inline void bit_copy(uint8_t *dst, unsigned dst_offset, const uint8_t *src,
+       unsigned src_offset, unsigned bit_count)
+{
+       buf_set_buf(src, src_offset, dst, dst_offset, bit_count);
+}
+
+struct bit_copy_queue {
+       struct list_head list;
+};
+
+struct bit_copy_queue_entry {
+       uint8_t *dst;
+       unsigned dst_offset;
+       const uint8_t *src;
+       unsigned src_offset;
+       unsigned bit_count;
+       struct list_head list;
+};
+
+void bit_copy_queue_init(struct bit_copy_queue *q);
+int bit_copy_queued(struct bit_copy_queue *q, uint8_t *dst, unsigned dst_offset, const uint8_t *src,
+                   unsigned src_offset, unsigned bit_count);
+void bit_copy_execute(struct bit_copy_queue *q);
+void bit_copy_discard(struct bit_copy_queue *q);
+
 #endif /* BINARYBUFFER_H */