common/crc.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 // Generic CRC calculation code.
  17 //-----------------------------------------------------------------------------
  18
  19 #ifndef __CRC_H
  20 #define __CRC_H
  21
  22 #include "common.h"
  23
  24 typedef struct crc_ctx {
  25     uint32_t state;
  26     int order;
  27     uint32_t polynom;
  28     uint32_t initial_value;
  29     uint32_t final_xor;
  30     uint32_t mask;
  31     int topbit;
  32     bool refin;    /* Parameter: Reflect input bytes?        */
  33     bool refout;   /* Parameter: Reflect output CRC?         */
  34 } crc_t;
  35
  36 /* Static initialization of a crc structure */
  37 #define CRC_INITIALIZER(_order, _polynom, _initial_value, _final_xor) { \
  38     .state = ((_initial_value) & ((1L<<(_order))-1)), \
  39     .order = (_order), \
  40     .polynom = (_polynom), \
  41     .initial_value = (_initial_value), \
  42     .final_xor = (_final_xor), \
  43     .mask = ((1L<<(_order))-1) \
  44     .refin = false, \
  45     .refout = false \
  46 }
  47
  48 /* Initialize a crc structure. order is the order of the polynom, e.g. 32 for a CRC-32
  49  * polynom is the CRC polynom. initial_value is the initial value of a clean state.
  50  * final_xor is XORed onto the state before returning it from crc_result().
  51  * refin is the setting for reversing (bitwise) the bytes during crc
  52  * refot is the setting for reversing (bitwise) the crc byte before returning it.
  53  */
  54 void crc_init_ref(crc_t *crc, int order, uint32_t polynom, uint32_t initial_value, uint32_t final_xor, bool refin, bool refout);
  55
  56 /* Initialize a crc structure. order is the order of the polynom, e.g. 32 for a CRC-32
  57  * polynom is the CRC polynom. initial_value is the initial value of a clean state.
  58  * final_xor is XORed onto the state before returning it from crc_result(). */
  59 void crc_init(crc_t *crc, int order, uint32_t polynom, uint32_t initial_value, uint32_t final_xor);
  60
  61
  62 /* Update the crc state. data is the data of length data_width bits (only the
  63  * data_width lower-most bits are used).
  64  */
  65 void crc_update(crc_t *crc, uint32_t data, int data_width);
  66 void crc_update2(crc_t *crc, uint32_t data, int data_width);
  67
  68 /* Clean the crc state, e.g. reset it to initial_value */
  69 void crc_clear(crc_t *crc);
  70
  71 /* Get the result of the crc calculation */
  72 uint32_t crc_finish(crc_t *crc);
  73
  74 // Calculate CRC-8/Maxim checksum
  75 uint32_t CRC8Maxim(uint8_t *buff, size_t size);
  76
  77 // Calculate CRC-8 Mifare MAD checksum
  78 uint32_t CRC8Mad(uint8_t *buff, size_t size);
  79
  80 // Calculate CRC-4/Legic checksum
  81 uint32_t CRC4Legic(uint8_t *buff, size_t size);
  82
  83 // Calculate CRC-8/Legic checksum
  84 uint32_t CRC8Legic(uint8_t *buff, size_t size);
  85
  86 // Calculate CRC-8/Cardx checksum
  87 uint32_t CRC8Cardx(uint8_t *buff, size_t size);
  88
  89 // Calculate CRC-8/Hitag1, ZX8211 checksum
  90 uint32_t CRC8Hitag1(uint8_t *buff, size_t size);
  91 uint32_t CRC8Hitag1Bits(const uint8_t *buff, size_t bitsize);
  92
  93 #endif /* __CRC_H */