common/commonutil.h

   1 //-----------------------------------------------------------------------------
   2 // Copyright (C) Proxmark3 contributors. See AUTHORS.md for details.
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // See LICENSE.txt for the text of the license.
  15 //-----------------------------------------------------------------------------
  16 // Utility functions used in many places, not specific to any piece of code.
  17 //-----------------------------------------------------------------------------
  18
  19 #ifndef __COMMONUTIL_H
  20 #define __COMMONUTIL_H
  21
  22 #include "common.h"
  23
  24 // endian change for 16bit
  25 #ifdef __GNUC__
  26 #ifndef BSWAP_16
  27 #define BSWAP_16(x) __builtin_bswap16(x)
  28 #endif
  29 #else
  30 #ifdef _MSC_VER
  31 #ifndef BSWAP_16
  32 #define BSWAP_16(x) _byteswap_ushort(x)
  33 #endif
  34 #else
  35 #ifndef BSWAP_16
  36 # define BSWAP_16(x) ((( ((x) & 0xFF00 ) >> 8))| ( (((x) & 0x00FF) << 8)))
  37 #endif
  38 #endif
  39 #endif
  40
  41 #ifndef BITMASK
  42 # define BITMASK(X) (1 << (X))
  43 #endif
  44 #ifndef ARRAYLEN
  45 # define ARRAYLEN(x) (sizeof(x)/sizeof((x)[0]))
  46 #endif
  47
  48 #ifndef NTIME
  49 # define NTIME(n) for (int _index = 0; _index < n; _index++)
  50 #endif
  51
  52 #ifndef REV8
  53 #define REV8(x) ((((x)>>7)&1)+((((x)>>6)&1)<<1)+((((x)>>5)&1)<<2)+((((x)>>4)&1)<<3)+((((x)>>3)&1)<<4)+((((x)>>2)&1)<<5)+((((x)>>1)&1)<<6)+(((x)&1)<<7))
  54 #endif
  55
  56 #ifndef REV16
  57 #define REV16(x)        (REV8(x) + (REV8 ((x) >> 8) << 8))
  58 #endif
  59
  60 #ifndef REV32
  61 #define REV32(x)        (REV16(x) + (REV16((x) >> 16) << 16))
  62 #endif
  63
  64 #ifndef REV64
  65 #define REV64(x)        (REV32(x) + ((uint64_t)(REV32((x) >> 32) << 32)))
  66 #endif
  67
  68
  69 extern struct version_information_t g_version_information;
  70 void FormatVersionInformation(char *dst, int len, const char *prefix, const void *version_info);
  71 void format_version_information_short(char *dst, int len, const void *version_info);
  72
  73 uint32_t reflect(uint32_t v, int b); // used in crc.c ...
  74 uint8_t reflect8(uint8_t b);         // dedicated 8bit reversal
  75 uint16_t reflect16(uint16_t b);      // dedicated 16bit reversal
  76 uint32_t reflect32(uint32_t b);      // dedicated 32bit reversal
  77 uint64_t reflect48(uint64_t b);      // dedicated 48bit reversal
  78 uint64_t reflect64(uint64_t b);      // dedicated 64bit reversal
  79
  80 void num_to_bytes(uint64_t n, size_t len, uint8_t *dest);
  81 uint64_t bytes_to_num(const uint8_t *src, size_t len);
  82
  83 // LE and BE to/from memory
  84 uint16_t MemLeToUint2byte(const uint8_t *data);
  85 uint32_t MemLeToUint3byte(const uint8_t *data);
  86 uint32_t MemLeToUint4byte(const uint8_t *data);
  87 uint64_t MemLeToUint5byte(const uint8_t *data);
  88 uint64_t MemLeToUint6byte(const uint8_t *data);
  89 uint64_t MemLeToUint7byte(const uint8_t *data);
  90 uint64_t MemLeToUint8byte(const uint8_t *data);
  91
  92 uint16_t MemBeToUint2byte(const uint8_t *data);
  93 uint32_t MemBeToUint3byte(const uint8_t *data);
  94 uint32_t MemBeToUint4byte(const uint8_t *data);
  95 uint64_t MemBeToUint5byte(const uint8_t *data);
  96 uint64_t MemBeToUint6byte(const uint8_t *data);
  97 uint64_t MemBeToUint7byte(const uint8_t *data);
  98 uint64_t MemBeToUint8byte(const uint8_t *data);
  99
 100 void Uint2byteToMemLe(uint8_t *data, uint16_t value);
 101 void Uint3byteToMemLe(uint8_t *data, uint32_t value);
 102 void Uint4byteToMemLe(uint8_t *data, uint32_t value);
 103 void Uint5byteToMemLe(uint8_t *data, uint64_t value);
 104 void Uint6byteToMemLe(uint8_t *data, uint64_t value);
 105 void Uint7byteToMemLe(uint8_t *data, uint64_t value);
 106 void Uint8byteToMemLe(uint8_t *data, uint64_t value);
 107
 108 void Uint2byteToMemBe(uint8_t *data, uint16_t value);
 109 void Uint3byteToMemBe(uint8_t *data, uint32_t value);
 110 void Uint4byteToMemBe(uint8_t *data, uint32_t value);
 111 void Uint5byteToMemBe(uint8_t *data, uint64_t value);
 112 void Uint6byteToMemBe(uint8_t *data, uint64_t value);
 113 void Uint7byteToMemBe(uint8_t *data, uint64_t value);
 114 void Uint8byteToMemBe(uint8_t *data, uint64_t value);
 115
 116 // rotate left byte array
 117 void rol(uint8_t *data, const size_t len);
 118 void ror(uint8_t *data, const size_t len);
 119
 120 void lsl(uint8_t *data, size_t len);
 121 uint32_t le24toh(const uint8_t data[3]);
 122 void htole24(uint32_t val, uint8_t data[3]);
 123
 124 // rol on a u32
 125 uint32_t rotl(uint32_t a, uint8_t n);
 126 uint32_t rotr(uint32_t a, uint8_t n);
 127
 128 uint16_t get_sw(const uint8_t *d, uint16_t n);
 129
 130 void reverse_array(uint8_t *d, size_t n);
 131 void reverse_array_copy(const uint8_t *src, int src_len, uint8_t *dest);
 132
 133 bool hexstr_to_byte_array(const char *hexstr, uint8_t *d, size_t *n);
 134
 135 void reverse_arraybytes(uint8_t *arr, size_t len);
 136 void reverse_arraybytes_copy(uint8_t *arr, uint8_t *dest, size_t len);
 137
 138 size_t concatbits(uint8_t *dest, int dest_offset, const uint8_t *src, int src_offset, size_t nbits);
 139 #endif