tmr_gen2.h

Go to the documentation of this file.

/* ex: set tabstop=2 shiftwidth=2 expandtab cindent: */
#ifndef _TMR_GEN2_H
#define _TMR_GEN2_H

/*
 * Copyright (c) 2009 ThingMagic, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifdef  __cplusplus
extern "C" {
#endif

typedef enum TMR_GEN2_LockBits
{
  TMR_GEN2_LOCK_BITS_USER_PERM    = (1 << 0),
  TMR_GEN2_LOCK_BITS_USER         = (1 << 1),
  TMR_GEN2_LOCK_BITS_TID_PERM     = (1 << 2),
  TMR_GEN2_LOCK_BITS_TID          = (1 << 3),
  TMR_GEN2_LOCK_BITS_EPC_PERM     = (1 << 4),
  TMR_GEN2_LOCK_BITS_EPC          = (1 << 5),
  TMR_GEN2_LOCK_BITS_ACCESS_PERM  = (1 << 6),
  TMR_GEN2_LOCK_BITS_ACCESS       = (1 << 7),
  TMR_GEN2_LOCK_BITS_KILL_PERM    = (1 << 8),
  TMR_GEN2_LOCK_BITS_KILL         = (1 << 9)
} TMR_GEN2_LockBits;

typedef struct TMR_GEN2_LockAction
{
  uint16_t mask;
  uint16_t action;
}TMR_GEN2_LockAction;

typedef uint32_t TMR_GEN2_Password;

typedef struct TMR_GEN2_DENATRAN_IAV_WriteCredentials
{
  uint8_t value[16];
  uint8_t tagId[8];
  uint8_t credentialLength;
  uint8_t tagIdLength;
}TMR_GEN2_DENATRAN_IAV_WriteCredentials;

typedef struct TMR_GEN2_DENATRAN_IAV_WriteSecCredentials
{
  uint8_t value[16];
  uint8_t data[6];
  uint8_t credentialLength;
  uint8_t dataLength;
}TMR_GEN2_DENATRAN_IAV_WriteSecCredentials;

typedef enum TMR_GEN2_Bank
{
  TMR_GEN2_BANK_RESERVED  = 0x0,
  TMR_GEN2_BANK_EPC       = 0x1,
  TMR_GEN2_BANK_TID       = 0x2,
  TMR_GEN2_BANK_USER      = 0x3,
  TMR_GEN2_BANK_RESERVED_ENABLED = 0x4,
  TMR_GEN2_EPC_LENGTH_FILTER = 0x6,
  TMR_GEN2_EPC_TRUNCATE = 0x7,
  TMR_GEN2_BANK_EPC_ENABLED = 0x8,
  TMR_GEN2_BANK_TID_ENABLED = 0x10,
  TMR_GEN2_BANK_USER_ENABLED = 0x20
} TMR_GEN2_Bank;

typedef struct TMR_GEN2_Select
{
  bool invert;
  TMR_GEN2_Bank bank;
  uint32_t bitPointer;
  uint16_t maskBitLength;
  uint8_t *mask;
} TMR_GEN2_Select;

typedef enum TMR_GEN2_Session
{
  TMR_GEN2_SESSION_MIN= 0x00,
  TMR_GEN2_SESSION_S0 = 0x00,
  TMR_GEN2_SESSION_S1 = 0x01,
  TMR_GEN2_SESSION_S2 = 0x02,
  TMR_GEN2_SESSION_S3 = 0x03,
  TMR_GEN2_SESSION_MAX     = TMR_GEN2_SESSION_S3,
  TMR_GEN2_SESSION_INVALID = TMR_GEN2_SESSION_MAX + 1
} TMR_GEN2_Session;

typedef enum TMR_GEN2_DivideRatio
{
  TMR_GEN2_DIVIDE_RATIO_8    = 0,
  TMR_GEN2_DIVIDE_RATIO_64_3 = 1
} TMR_GEN2_DivideRatio;

typedef enum TMR_GEN2_TrExt
{
  TMR_GEN2_TR_EXT_NO_PILOT_TONE = 0,
  TMR_GEN2_TR_EXT_PILOT_TONE    = 1
} TMR_GEN2_TrExt;

typedef enum TMR_GEN2_Target
{
  TMR_GEN2_TARGET_MIN= 0,
  TMR_GEN2_TARGET_A  = 0,
  TMR_GEN2_TARGET_B  = 1,
  TMR_GEN2_TARGET_AB = 2,
  TMR_GEN2_TARGET_BA = 3,
  TMR_GEN2_TARGET_MAX     = TMR_GEN2_TARGET_BA,
  TMR_GEN2_TARGET_INVALID = TMR_GEN2_TARGET_MAX+1
}TMR_GEN2_Target;

typedef enum TMR_GEN2_TagEncoding
{
  TMR_GEN2_FM0 = 0,

  TMR_GEN2_MILLER_MIN = 1,
  TMR_GEN2_MILLER_M_2 = 1,
  TMR_GEN2_MILLER_M_4 = 2,
  TMR_GEN2_MILLER_M_8 = 3,
  TMR_GEN2_MILLER_MAX     = TMR_GEN2_MILLER_M_8,
  TMR_GEN2_MILLER_INVALID = TMR_GEN2_MILLER_MAX+1
}TMR_GEN2_TagEncoding;

typedef enum TMR_GEN2_LinkFrequency
{
  TMR_GEN2_LINKFREQUENCY_250KHZ  = 250,
  TMR_GEN2_LINKFREQUENCY_320KHZ  = 320,
  TMR_GEN2_LINKFREQUENCY_640KHZ   = 640,
  TMR_GEN2_LINKFREQUENCY_MAX     = 640,
  TMR_GEN2_LINKFREQUENCY_INVALID = TMR_GEN2_LINKFREQUENCY_MAX + 1,
} TMR_GEN2_LinkFrequency;

typedef enum TMR_GEN2_ProtocolExtension
{
  TMR_GEN2_PROTOCOLEXTENSION_LICENSE_NONE                       = 0,
  TMR_GEN2_PROTOCOLEXTENSION_LICENSE_IAV_DENATRAN       = 1
}TMR_GEN2_ProtocolExtension;

typedef struct TMR_GEN2_Bap
{
  /* Default to 3000 us */
  int32_t powerUpDelayUs;
  /* Default to 20000 us */
  int32_t freqHopOfftimeUs;
}TMR_GEN2_Bap;

typedef enum TMR_GEN2_UNTRACEABLE_Epc
{
        /* Tag exposes EPC memory */
        EPC_SHOW = 0,
        /*Tag untraceably hides EPC memory above that*/
        EPC_HIDE = 1
}TMR_GEN2_UNTRACEABLE_Epc;

typedef enum TMR_GEN2_UNTRACEABLE_Tid
{
        /* Tag exposes TID memory. */
        HIDE_NONE = 0,
        /*Tag untraceably hides all of TID memory.*/
        HIDE_ALL = 1,
        /* Tag’s allocation class identifier is E0h then the 
        Tag untraceably hides TID memory above 10h,inclusive;
        if the Tag’s allocation class identifier is E2h then the
        Tag untraceably hides TID memory above 20h, inclusive. */
        HIDE_SOME = 2,
        /* RFU */
        TID_RFU = 3
}TMR_GEN2_UNTRACEABLE_Tid;

typedef enum TMR_GEN2_UNTRACEABLE_UserMemory
{
        /* Tag exposes User memory */
        SHOW = 0,
        /*Tag untraceably hides User memory*/
        HIDE = 1
}TMR_GEN2_UNTRACEABLE_UserMemory;

typedef enum TMR_GEN2_UNTRACEABLE_Range
{
        /* Tag persistently enables normal operating range */
        NORMAL = 0,
        /*Tag persistently enables reduced operating range.*/
        REDUCED = 1,
        /* Tag temporarily toggles its operating range*/
        TOGGLE_TEMPORARLY = 2,
        /* RFU */
        RFU = 3
}TMR_GEN2_UNTRACEABLE_Range;

typedef enum TMR_NXP_KeyId
{
        /* key0*/
        KEY0 = 0,
        /*Key1*/
        KEY1 = 1
}TMR_NXP_KeyId;

typedef enum TMR_NXP_Profile
{
        /* EPC memory bank */
        EPC = 0,
        /* TID memory bank */
        TID = 1,
        /* User memory bank */
        USER = 2
}TMR_NXP_Profile;

typedef enum TMR_GEN2_Tari
{
  TMR_GEN2_TARI_25US    = 0,
  TMR_GEN2_TARI_12_5US  = 1,
  TMR_GEN2_TARI_6_25US  = 2,
  TMR_GEN2_TARI_MAX     = 2,
  TMR_GEN2_TARI_INVALID = TMR_GEN2_TARI_MAX + 1,
} TMR_GEN2_Tari;

typedef enum TMR_GEN2_WriteMode
{
  TMR_GEN2_WORD_ONLY    = 0,
  TMR_GEN2_BLOCK_ONLY    = 1,
  TMR_GEN2_BLOCK_FALLBACK    = 2,

} TMR_GEN2_WriteMode;

typedef enum TMR_SR_GEN2_SiliconType
{
  TMR_SR_GEN2_SILICON_ANY             = 0x00,
  TMR_SR_GEN2_ALIEN_HIGGS_SILICON     = 0x01,
  TMR_SR_GEN2_NXP_G2X_SILICON         = 0x02,
  TMR_SR_GEN2_ALIEN_HIGGS3_SILICON    = 0x05,
  TMR_SR_GEN2_NXP_G2I_SILICON         = 0x07,
  TMR_SR_GEN2_IMPINJ_MONZA4_SILICON   = 0x08,
  TMR_SR_GEN2_IDS_SL900A_SILICON      = 0x0A,
  TMR_SR_GEN2_DENATRAN_IAV_SILICON    = 0x0B,
  TMR_SR_GEN2_NXP_AES_UCODE                       = 0x0C,
}TMR_SR_GEN2_SiliconType;

typedef union TMR_NXP_ConfigWord
{
  uint16_t data;
  /*
   * Since the bit-fields are used, The bits in configWord are shown from
   * Least significant bit to Most significant bit.
   */
  struct
  {
    unsigned psfAlarm:1;
    unsigned readProtectTID:1;
    unsigned readProtectEPC:1;
    unsigned readProtectUser:1;
    unsigned privacyMode:1;
    unsigned digitalOutput:1;
    unsigned maxBackscatterStrength:1;
    unsigned conditionalReadRangeReduction_openShort:1;
    unsigned conditionalReadRangeReduction_onOff:1;
    unsigned dataMode:1;
    unsigned transparentMode:1;
    unsigned invertDigitalOutput:1;
    unsigned RFU3:1;
    unsigned RFU2:1;
    unsigned externalSupply:1;
    unsigned tamperAlarm:1;    
  }bits;
}TMR_NXP_ConfigWord;

typedef union TMR_Monza4_ControlByte
{
  /* 8-bit control byte */
  uint8_t data;
  /*
   * Since bit-fields are used, The bits in control Byte are shown from
   * Least significant bit to Most significant bit.
   */
  struct 
  {
    unsigned RFU_TM0:1;
    unsigned RFU_TM1:1;
    unsigned RFU_TM2:1;
    unsigned RFU_TM3:1;
    unsigned RFU_Impinj4:1;
    unsigned RFU_Impinj5:1;
    unsigned persistence:1;
    unsigned readWrite:1;    
  }bits;
}TMR_Monza4_ControlByte;

typedef union TMR_Monza4_Payload
{
  uint16_t data;
  /*
   * Since bit-fields are used, The bits in payload are shown from
   * Least significant bit to Most significant bit.
   */
  struct
  {
    unsigned RFU0:1;
    unsigned RFU1:1;
    unsigned RFU2:1;
    unsigned RFU3:1;
    unsigned RFU4:1;
    unsigned RFU5:1;
    unsigned RFU6:1;
    unsigned RFU7:1;
    unsigned RFU8:1;
    unsigned RFU9:1;
    unsigned RFU10:1;
    unsigned RFU11:1;
    unsigned RFU12:1;
    unsigned RFU13:1;
    unsigned QT_MEM:1;
    unsigned QT_SR:1;
  }bits;
}TMR_Monza4_Payload;

typedef struct TMR_GEN2_HibikiSystemInformation
{
  uint16_t infoFlags;     /* Indicates whether the banks are present and Custom Commands are implemented*/ 
  uint8_t reservedMemory; /* Indicates the size of this memory bank in words*/
  uint8_t epcMemory;      /* Indicates the size of this memory bank in words*/
  uint8_t tidMemory;      /* Indicates the size of this memory bank in words*/
  uint8_t userMemory;     /* Indicates the size of this memory bank in words*/
  uint8_t setAttenuate;   
  uint16_t bankLock;      /* Indicates Lock state for this type of lock*/
  uint16_t blockReadLock; /* Indicates Lock state for this type of lock*/
  uint16_t blockRwLock;   /* Indicates Lock state for this type of lock*/
  uint16_t blockWriteLock;/* Indicates Lock state for this type of lock*/
} TMR_GEN2_HibikiSystemInformation;

#define TMR_GEN2_MAX_PC_BYTE_COUNT (6)

typedef struct TMR_GEN2_TagData
{ 
  uint8_t pcByteCount;
  uint8_t pc[TMR_GEN2_MAX_PC_BYTE_COUNT];
} TMR_GEN2_TagData;



#ifdef __cplusplus
}
#endif

#endif /*_TMR_GEN2_H*/