binarybuffer.h

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-2.0-or-later */
 
/***************************************************************************
 *   Copyright (C) 2004, 2005 by Dominic Rath                              *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
 *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
 *   oyvind.harboe@zylin.com                                               *
 ***************************************************************************/
 
#ifndef OPENOCD_HELPER_BINARYBUFFER_H
#define OPENOCD_HELPER_BINARYBUFFER_H
 
#include <helper/list.h>
#include <helper/types.h>
 
#define ERROR_INVALID_NUMBER         (-1700)
#define ERROR_NUMBER_EXCEEDS_BUFFER  (-1701)
 
static inline void buf_set_u32(uint8_t *_buffer,
    unsigned int first, unsigned int num, uint32_t value)
{
    assert(num >= 1 && num <= 32);
    uint8_t *buffer = _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 int i = first; i < first + num; i++) {
            if (((value >> (i - first)) & 1) == 1)
                buffer[i / 8] |= 1 << (i % 8);
            else
                buffer[i / 8] &= ~(1 << (i % 8));
        }
    }
}
 
static inline void buf_set_u64(uint8_t *_buffer,
    unsigned int first, unsigned int num, uint64_t value)
{
    assert(num >= 1 && num <= 64);
    uint8_t *buffer = _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 if ((num == 64) && (first == 0)) {
        buffer[7] = (value >> 56) & 0xff;
        buffer[6] = (value >> 48) & 0xff;
        buffer[5] = (value >> 40) & 0xff;
        buffer[4] = (value >> 32) & 0xff;
        buffer[3] = (value >> 24) & 0xff;
        buffer[2] = (value >> 16) & 0xff;
        buffer[1] = (value >> 8) & 0xff;
        buffer[0] = (value >> 0) & 0xff;
    } else {
        for (unsigned int i = first; i < first + num; i++) {
            if (((value >> (i - first)) & 1) == 1)
                buffer[i / 8] |= 1 << (i % 8);
            else
                buffer[i / 8] &= ~(1 << (i % 8));
        }
    }
}
 
static inline uint32_t buf_get_u32(const uint8_t *_buffer,
    unsigned int first, unsigned int num)
{
    assert(num >= 1 && num <= 32);
    const uint8_t *buffer = _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);
    } else {
        uint32_t result = 0;
        for (unsigned int i = first; i < first + num; i++) {
            if (((buffer[i / 8] >> (i % 8)) & 1) == 1)
                result |= 1U << (i - first);
        }
        return result;
    }
}
 
static inline uint64_t buf_get_u64(const uint8_t *_buffer,
    unsigned int first, unsigned int num)
{
    assert(num >= 1 && num <= 64);
    const uint8_t *buffer = _buffer;
 
    if ((num == 32) && (first == 0)) {
        return 0 + ((((uint32_t)buffer[3]) << 24) |   /* Note - zero plus is to avoid a checkpatch bug */
                (((uint32_t)buffer[2]) << 16) |
                (((uint32_t)buffer[1]) << 8)  |
                (((uint32_t)buffer[0]) << 0));
    } else if ((num == 64) && (first == 0)) {
        return 0 + ((((uint64_t)buffer[7]) << 56) |   /* Note - zero plus is to avoid a checkpatch bug */
                (((uint64_t)buffer[6]) << 48) |
                (((uint64_t)buffer[5]) << 40) |
                (((uint64_t)buffer[4]) << 32) |
                (((uint64_t)buffer[3]) << 24) |
                (((uint64_t)buffer[2]) << 16) |
                (((uint64_t)buffer[1]) << 8)  |
                (((uint64_t)buffer[0]) << 0));
    } else {
        uint64_t result = 0;
        for (unsigned int i = first; i < first + num; i++) {
            if (((buffer[i / 8] >> (i % 8)) & 1) == 1)
                result = result | ((uint64_t)1 << (uint64_t)(i - first));
        }
        return result;
    }
}
 
 
uint32_t flip_u32(uint32_t value, unsigned int width);
 
bool buf_eq(const void *buf1, const void *buf2, unsigned int size);
bool buf_eq_mask(const void *buf1, const void *buf2,
        const void *mask, unsigned int size);
 
void *buf_cpy(const void *from, void *to, unsigned int size);
 
void *buf_set_ones(void *buf, unsigned int size);
 
void *buf_set_buf(const void *src, unsigned int src_start,
          void *dst, unsigned int dst_start, unsigned int len);
 
int str_to_buf(const char *str, void *_buf, unsigned int buf_bitsize);
 
char *buf_to_hex_str(const void *buf, unsigned int size);
 
/* 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)
{
    return le ? le_to_h_u32(p) : be_to_h_u32(p);
}
 
static inline void bit_copy(uint8_t *dst, unsigned int dst_offset, const uint8_t *src,
    unsigned int src_offset, unsigned int 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 int dst_offset;
    const uint8_t *src;
    unsigned int src_offset;
    unsigned int 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 int dst_offset, const uint8_t *src,
            unsigned int src_offset, unsigned int bit_count);
void bit_copy_execute(struct bit_copy_queue *q);
void bit_copy_discard(struct bit_copy_queue *q);
 
/* functions to convert to/from hex encoded buffer
 * used in ti-icdi driver and gdb server */
size_t unhexify(uint8_t *bin, const char *hex, size_t count);
size_t hexify(char *hex, const uint8_t *bin, size_t count, size_t out_maxlen);
void buffer_shr(void *_buf, unsigned int buf_len, unsigned int count);
 
#endif /* OPENOCD_HELPER_BINARYBUFFER_H */