as3993_public.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 _AS3993_PUBLIC_H_
#define _AS3993_PUBLIC_H_

#include "global.h"
#include "errno_as3993.h"

#define AS3993_ERR_NORES      ERR_CHIP_NORESP
#define AS3993_ERR_PREAMBLE   ERR_CHIP_PREAMBLE
#define AS3993_ERR_HEADER     ERR_CHIP_HEADER
#define AS3993_ERR_FIFO_OVER  ERR_CHIP_FIFO
#define AS3993_ERR_RXCOUNT    ERR_CHIP_RXCOUNT
#define AS3993_ERR_CRC        ERR_CHIP_CRCERROR
#define AS3993_ERR_RXERR      ERR_CHIP_RXERR

struct TagInfo_
{
    u8 rn16[2];

    u8 pc[2];
    u8 epc[EPCLENGTH]; /* epc must immediately follow pc */
    u8 epclen;  /*length in bytes */
    u8 handle[2];
    u8 rssi;
    u8 agc;
    u8 tidlength;  /*length in bytes */
    u8 tid[TIDLENGTH];
};

typedef struct TagInfo_ Tag;

typedef struct
{
    u8 numFreqs;

    u32 freq[MAXFREQ];
#ifdef TUNER

    u16 countFreqHop[MAXFREQ];
#endif
} Freq;

#ifdef TUNER

typedef struct
{
    u8 tableSize;
    u8 currentEntry;
    unsigned long freq[MAXTUNE];
    u8      tuneEnable[MAXTUNE];
    u8           cin[2][MAXTUNE];
    u8          clen[2][MAXTUNE];
    u8          cout[2][MAXTUNE];
    u16      tunedIQ[2][MAXTUNE];
} TuningTable;
#endif

u16 as3993Initialize(u32 baseFreq);

u8 as3993ReadChipVersion(void);

/*------------------------------------------------------------------------- */
void as3993SetBaseFrequency(u8 regs, u32 frequency);

/*------------------------------------------------------------------------- */
void as3993AntennaPower( u8 on);
#ifdef EXTPA
/*------------------------------------------------------------------------- */
void as3993GetRSSIMaxSensitive( u16 num_of_ms_to_scan, u8 *rawIQ);
/*------------------------------------------------------------------------- */
void as3993GetRSSI( u16 num_of_ms_to_scan, u8 *rawIQ);
/*------------------------------------------------------------------------- */
#endif
s8 as3993SetSensitivity( s8 minimumSignal );

/*------------------------------------------------------------------------- */
s8 as3993GetSensitivity( void );

/*------------------------------------------------------------------------- */
u16 as3993GetReflectedPower( void );

/*------------------------------------------------------------------------- */
u16 as3993GetReflectedPowerNoiseLevel( void );

/*------------------------------------------------------------------------- */
void as3993Reset(void);

/*------------------------------------------------------------------------- */
void as3993ResetDoNotPreserveRegisters(void);

/*------------------------------------------------------------------------- */
s8 as3993TxRxGen2Bytes(u8 cmd, u8 *txbuf, u16 txbits, 
                               u8 *rxbuf, u16 *rxbits,
                               u8 norestime, u8 followCmd,
                               u8 waitTxIrq);

s8 as3980HandleResponseWithHeaderBit(s8 ret, u8 *destbuf, u16 rxbits, u8 const * handle);

s8 as3993GetADC( void );
#endif /* _AS3993_PUBLIC_H_ */