client/src/wiegand_formatutils.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 // Weigand card format packing/unpacking support functions
  17 //-----------------------------------------------------------------------------
  18
  19 #ifndef WIEGAND_FORMATUTILS_H__
  20 #define WIEGAND_FORMATUTILS_H__
  21
  22 #include <stdarg.h>
  23 #include <stdint.h>
  24 #include <stdbool.h>
  25
  26 // Structure for packed wiegand messages
  27 // Always align lowest value (last transmitted) bit to ordinal position 0 (lowest valued bit bottom)
  28 typedef struct {
  29     uint8_t Length;   // Number of encoded bits in wiegand message (excluding headers and preamble)
  30     uint32_t Top;     // Bits in x<<64 positions
  31     uint32_t Mid;     // Bits in x<<32 positions
  32     uint32_t Bot;     // Lowest ordinal positions
  33 } wiegand_message_t;
  34
  35 // Structure for unpacked wiegand card, like HID prox
  36 typedef struct {
  37     uint32_t FacilityCode;
  38     uint64_t CardNumber;
  39     uint32_t IssueLevel;
  40     uint32_t OEM;
  41     bool ParityValid; // Only valid for responses
  42 } wiegand_card_t;
  43
  44 uint8_t get_bit_by_position(wiegand_message_t *data, uint8_t pos);
  45 bool set_bit_by_position(wiegand_message_t *data, bool value, uint8_t pos);
  46
  47 uint64_t get_linear_field(wiegand_message_t *data, uint8_t firstBit, uint8_t length);
  48 bool set_linear_field(wiegand_message_t *data, uint64_t value, uint8_t firstBit, uint8_t length);
  49
  50 uint64_t get_nonlinear_field(wiegand_message_t *data, uint8_t numBits, uint8_t *bits);
  51 bool set_nonlinear_field(wiegand_message_t *data, uint64_t value, uint8_t numBits, uint8_t *bits);
  52
  53 wiegand_message_t initialize_message_object(uint32_t top, uint32_t mid, uint32_t bot, int n);
  54
  55 bool add_HID_header(wiegand_message_t *data);
  56
  57 #endif