gen2.h

Go to the documentation of this file.

/*
 *****************************************************************************
 * AS3993/ST25RU3993 Firmware   tech@eleckits.com   http://iot.eleckits.com  *
 * STMicroelectronics ST25RU3993 is an EPC Class 1 Gen 2 RFID reader IC      *
 *                                                                           *
 * IMPORTANT - PLEASE READ CAREFULLY BEFORE COPYING, INSTALLING OR USING     *
 * THE SOFTWARE.                                                             *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT         *
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS         *
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT  *
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,     *
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT          *
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,     *
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY     *
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT       *
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE     *
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.      *
 *****************************************************************************
 */
#ifndef __GEN2_H__
#define __GEN2_H__

#include "as3993_public.h"
#include "ams_types.h"
#include "errno_as3993.h"

/* Protocol configuration settings */
#define GEN2_LF_40  0   
#define GEN2_LF_160 6   
#define GEN2_LF_213 8   
#define GEN2_LF_256 9   
#define GEN2_LF_320 12  
#define GEN2_LF_640 15  
#define GEN2_COD_FM0      0 
#define GEN2_COD_MILLER2  1 
#define GEN2_COD_MILLER4  2 
#define GEN2_COD_MILLER8  3 
/* TrExt defines */
#define TREXT_OFF         0 
#define TREXT_ON          1 
/* Tari defines */
#define TARI_625          0 
#define TARI_125          1 
#define TARI_25           2 
/*EPC Mem Banks */

#define MEM_RES           0x00

#define MEM_EPC           0x01

#define MEM_TID           0x02

#define MEM_USER          0x03

/*EPC Wordpointer Addresses */
#define MEMADR_CRC        0x00

#define MEMADR_PC         0x01

#define MEMADR_EPC        0x02

#define MEMADR_KILLPWD    0x00

#define MEMADR_ACCESSPWD  0x02

#define MEMADR_TID        0x00

/*EPC SELECT TARGET */
#define GEN2_IINV_S0           0x00 /*Inventoried (S0) */

#define GEN2_IINV_S1           0x01 /*001: Inventoried (S1) */

#define GEN2_IINV_S2           0x02 /*010: Inventoried (S2) */

#define GEN2_IINV_S3           0x03 /*011: Inventoried (S3) */

#define GEN2_IINV_SL           0x04 /*100: SL */

#define GEN2_SESSION_S0           0x00
#define GEN2_SESSION_S1           0x01
#define GEN2_SESSION_S2           0x02
#define GEN2_SESSION_S3           0x03

#define GEN2_OK                  ERR_NONE 
#define GEN2_ERR_REQRN           ERR_GEN2_REQRN 
#define GEN2_ERR_ACCESS          ERR_GEN2_ACCESS 
#define GEN2_ERR_SELECT          ERR_GEN2_SELECT 
#define GEN2_ERR_CHANNEL_TIMEOUT ERR_GEN2_CHANNEL_TIMEOUT 
struct gen2Config{
    u8 tari;        /*< Tari setting */
    u8 linkFreq;    /*< GEN2_LF_40, ... */
    u8 miller;      /*< GEN2_COD_FM0, ... */
    u8 trext;       /*< 1 if the preamble is long, i.e. with pilot tone */
    u8 sel;         /*< For QUERY Sel field */
    u8 session;     /*< GEN2_SESSION_S0, ... */
    u8 target;      /*< For QUERY Target field */
};

struct gen2SelectParams{
    u8 target;
    u8 action;
    u8 mem_bank;
    u8 mask[32];
    u32 mask_address;
    u8 mask_len;
    u8 truncation;
};

/*------------------------------------------------------------------------- */
unsigned gen2SearchForTags(Tag *tags
                          , u8 maxtags
                          , u8 q
                          , u8 addRounds
                          , u8 queryAdjustUpTh
                          , u8 queryAdjustDownTh
                          , BOOL (*cbContinueScanning)(void)
                          , BOOL singulate
                          , BOOL toggleSession
                          , s8 (*followTagCommand)(Tag *tag)
                          );


unsigned gen2SearchForTagsAutoAck(Tag *tags_
                      , u8 maxtags
                      , u8 q
                      , BOOL (*cbContinueScanning)(void)
                      , BOOL singulate
                      , BOOL toggleSession
                      , s8 (*followTagCommand)(Tag *tag)
                      );
/*------------------------------------------------------------------------- */
s8 gen2AccessTag(Tag const * tag, u8 const * password);

/*------------------------------------------------------------------------- */
s8 gen2LockTag(Tag *tag, const u8 *mask_action, u8 *tag_reply);

/*------------------------------------------------------------------------- */
s8 gen2KillTag(Tag const * tag, u8 const * password, u8 rfu, u8 recom, u8 *tag_error);

/*------------------------------------------------------------------------- */
s8 gen2WriteWordToTag(Tag const * tag, u8 memBank, u32 wordPtr, u8 const * databuf, u8 * tag_error);

/*------------------------------------------------------------------------- */
s8 gen2ReadFromTag(Tag *tag, u8 memBank, u32 wordPtr,
                          u8 wordCount, u8 *destbuf);

/*------------------------------------------------------------------------- */
void gen2Select(struct gen2SelectParams *p);

/*------------------------------------------------------------------------------ */
/*Sends the tags EPC via the UART to the host */
/*The function needs the tags structure */
void gen2PrintEPC(Tag *tag);

/*------------------------------------------------------------------------- */
void gen2PrintTagInfo(Tag *tag, u8 epclen, u8 tagNr);

void gen2Configure(const struct gen2Config *config);

void gen2Open(const struct gen2Config * config);

void gen2Close(void);

s8 gen2QueryMeasureRSSI(u8 *agc, u8 *log_rssis, s8 *irssi, s8 *qrssi);

struct gen2Config *getGen2IntConfig();


#endif