as3993.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_H_
#define _AS3993_H_

#include "global.h"
#include "ams_types.h"
#include "as3993_config.h"

#define AS3993_REG_STATUSCTRL           0X00
#define AS3993_REG_PROTOCOLCTRL         0X01
#define AS3993_REG_TXOPTIONS            0X02
#define AS3993_REG_RXOPTIONS            0X03
#define AS3993_REG_TRCALHIGH            0X04
#define AS3993_REG_TRCALLOW             0X05
#define AS3993_REG_AUTOACKTIMER         0X06
#define AS3993_REG_RXNORESPONSEWAITTIME 0X07
#define AS3993_REG_RXWAITTIME           0X08
#define AS3993_REG_RXFILTER             0X09
#define AS3993_REG_RXMIXERGAIN          0X0A
#define AS3993_REG_REGULATORCONTROL     0X0B
#define AS3993_REG_RFOUTPUTCONTROL      0X0C
#define AS3993_REG_MISC1                0X0D
#define AS3993_REG_MISC2                0X0E
#define AS3993_REG_MEASUREMENTCONTROL   0X10
#define AS3993_REG_VCOCONTROL           0X11
#define AS3993_REG_CPCONTROL            0X12
#define AS3993_REG_MODULATORCONTROL1    0X13
#define AS3993_REG_MODULATORCONTROL2    0X14
#define AS3993_REG_MODULATORCONTROL3    0X15
#define AS3993_REG_MODULATORCONTROL4    0X16
#define AS3993_REG_PLLMAIN1             0X17
#define AS3993_REG_PLLMAIN2             0X18
#define AS3993_REG_PLLMAIN3             0X19
#define AS3993_REG_PLLAUX1              0X1A
#define AS3993_REG_PLLAUX2              0X1B
#define AS3993_REG_PLLAUX3              0X1C
#define AS3993_REG_ICD                  0X1D
#define AS3993_REG_MIXOPTS              0X22
#define AS3993_REG_TEST1                0X23
#define AS3993_REG_TEST2                0X24
#define AS3993_REG_TEST3                0X25
#define AS3993_REG_TEST4                0X26
#define AS3993_REG_TXRESHAPE            0X27 /* ? */
#define AS3993_REG_STATUSPAGE           0X29
#define AS3993_REG_AGCANDSTATUS         0X2A
#define AS3993_REG_RSSILEVELS           0X2B
#define AS3993_REG_AGL                  0X2C
#define AS3993_REG_ADC                  0X2D
#define AS3993_REG_COMMANDSTATUS        0X2E
#define AS3993_REG_DEVICEVERSION        0X33
#define AS3993_REG_IRQMASK1             0X35
#define AS3993_REG_IRQMASK2             0X36
#define AS3993_REG_IRQSTATUS1           0X37
#define AS3993_REG_IRQSTATUS2           0X38
#define AS3993_REG_FIFOSTATUS           0X39
#define AS3993_REG_RXLENGTHUP           0X3A
#define AS3993_REG_RXLENGTHLOW          0X3B
#define AS3993_REG_TXSETTING            0X3C
#define AS3993_REG_TXLENGTHUP           0X3D
#define AS3993_REG_TXLENGTHLOW          0X3E
#define AS3993_REG_FIFO                 0X3F

//Reader commands-------------------------------------------
#define AS3993_CMD_IDLE                  0x80
#if RUN_ON_AS3993
#define AS3993_CMD_DIRECT_MODE           0x81
#endif
#define AS3993_CMD_SOFT_INIT             0x83
#define AS3993_CMD_HOP_TO_MAIN_FREQUENCY 0x84
#define AS3993_CMD_HOP_TO_AUX_FREQUENCY  0x85
#define AS3993_CMD_TRIGGERADCCON         0x87
#define AS3993_CMD_TRIG_RX_FILTER_CAL    0x88
#define AS3993_CMD_INC_RX_FILTER_CAL     0x89
#define AS3993_CMD_DEC_RX_FILTER_CAL     0x8A
#define AS3993_CMD_TRANSMCRC             0x90
#define AS3993_CMD_TRANSMCRCEHEAD        0x91
#if RUN_ON_AS3993
#define AS3993_CMD_TRANSMNOCRC           0x92
#endif
#define AS3993_CMD_DELAY_TRANSMIT_CRC    0x93 /* ? */
#define AS3993_CMD_DELAY_TRANSMIT_NO_CRC 0x94 /* ? */
#define AS3993_CMD_CLOSE_SLOT_SEQUENCE   0x95 /* ? */
#define AS3993_CMD_BLOCKRX               0x96
#define AS3993_CMD_ENABLERX              0x97
#define AS3993_CMD_QUERY                 0x98
#if RUN_ON_AS3993
#define AS3993_CMD_QUERYREP              0x99
#define AS3993_CMD_QUERYADJUSTUP         0x9A
#define AS3993_CMD_QUERYADJUSTNIC        0x9B
#define AS3993_CMD_QUERYADJUSTDOWN       0x9C
#endif
#define AS3993_CMD_ACK                   0x9D
#define AS3993_CMD_NAK                   0x9E
#define AS3993_CMD_REQRN                 0x9F
#define AS3993_CMD_SUPPLY_AUTO_LEVEL     0xA2
#define AS3993_CMD_SUPPLY_MANUAL_LEVEL   0xA3
#define AS3993_CMD_VCO_AUTO_RANGE        0xA4
#define AS3993_CMD_VCO_MANUAL_RANGE      0xA5
#define AS3993_CMD_AGL_ON                0xA6
#define AS3993_CMD_AGL_OFF               0xA7
#define AS3993_CMD_STORE_RSSI            0xA8
#define AS3993_CMD_CLEAR_RSSI            0xA9
#define AS3993_CMD_ANTI_COLL_ON          0xAA
#define AS3993_CMD_ANTI_COLL_OFF         0xAB

/*IRQ Mask register */
#define AS3993_IRQ1_NORESP               0x01

#define AS3993_IRQ1_AUTOACK              0x02

#define AS3993_IRQ1_HEADER               0x08

#define AS3993_IRQ1_RXERR                0x10

#define AS3993_IRQ1_FIFO                 0x20

#define AS3993_IRQ1_RX                   0x40

#define AS3993_IRQ1_TX                   0x80

#define AS3993_IRQ2_PREAMBLE             0x01

#define AS3993_IRQ2_RXCOUNT              0x02

#define AS3993_IRQ2_CRCERROR             0x04

#define AS3993_IRQ2_END_CMD              0x40

#define AS3993_IRQ2_END_ANA              0x80

#define AS3993_IRQ1_MASK_ALL             0xfb
#define AS3993_IRQ2_MASK_ALL             0xc7

/*AS3993_REG_FIFO STATUS register */
#define AS3993_FIFOSTAT_OVERFLOW              0x20

#define RESP_NORESINTERRUPT AS3993_IRQ1_NORESP   
#define RESP_AUTOACK        AS3993_IRQ1_AUTOACK 
#define RESP_HEADERBIT      AS3993_IRQ1_HEADER   
#define RESP_RXERR          AS3993_IRQ1_RXERR  
#define RESP_FIFO           AS3993_IRQ1_FIFO  
#define RESP_RXIRQ          AS3993_IRQ1_RX   
#define RESP_TXIRQ          AS3993_IRQ1_TX  
#define RESP_PREAMBLEERROR (AS3993_IRQ2_PREAMBLE << 8)
#define RESP_RXCOUNTERROR  (AS3993_IRQ2_RXCOUNT  << 8)
#define RESP_CRCERROR      (AS3993_IRQ2_CRCERROR << 8)
#define RESP_END_CMD       (AS3993_IRQ2_END_CMD  << 8)
#define RESP_END_ANA       (AS3993_IRQ2_END_ANA  << 8)

#if RUN_ON_AS3980   //as3980 produces irq_err2 (without irq_err) if new epc is read 500ms after last one.
#define RESP_RXDONE_OR_ERROR  (RESP_RXIRQ | RESP_AUTOACK | RESP_RXERR | RESP_NORESINTERRUPT | RESP_RXCOUNTERROR)
#else
#define RESP_RXDONE_OR_ERROR  (RESP_RXIRQ | RESP_AUTOACK | RESP_RXERR | RESP_NORESINTERRUPT)
#endif
/* RESP_FIFOOVERFLOW does not work reliably */
#define RESP_ANY    (AS3993_IRQ1_MASK_ALL | (AS3993_IRQ2_MASK_ALL << 8))

#define RSSI_MODE_REALTIME                  0x00
#define RSSI_MODE_PILOT                     0x04
#define RSSI_MODE_2NDBYTE                   0x06
#define RSSI_MODE_PEAK                      0x08

#define AS3993_NOM_SENSITIVITY              68
/* Frequency offset for RSSI measurement.
 * If the measured signal has the same frequency as the pll, I + Q is zero after mixing the signal.
 * If the measured signal will differ with the pll frequency setting, the filtered mixed signal will be seen.
 * This filtered mixed signal should have a maximum if pll frequency and signal frequency differ with this offset.
 * Therefore, the offset has a dependency on the filter settings.
 */
#define AS3993_RSSI_FREQUENCY_OFFSET        50
/* at 40kHz BLF one gen2 slot takes ~40ms, we are going to wait
 * 50ms (in as3993WaitForResponse()) to be on the safe side. */
#define WAITFORRESPONSEDELAY    10

#define WAITFORRESPONSETIMEOUT  50000

#define WAITFORRESPONSECOUNT    WAITFORRESPONSETIMEOUT/WAITFORRESPONSEDELAY


extern volatile u16 as3993Response;
extern u32 as3993CurrentBaseFreq;

/*------------------------------------------------------------------------- */
void as3993SingleCommand(u8 command);

/*------------------------------------------------------------------------- */
void as3993ContinuousRead(u8 address, s8 len, u8 *readbuf);

void as3993FifoRead(s8 len, u8 *readbuf);

u8 as3993SingleRead(u8 address);

/*------------------------------------------------------------------------- */
void as3993ContinuousWrite(u8 address, u8 *buf, s8 len);

void as3993SingleWrite(u8 address, u8 value);

/*------------------------------------------------------------------------- */
void as3993CommandContinuousAddress(u8 *command, u8 com_len,
                             u8 address, u8 *buf, u8 buf_len);

/*------------------------------------------------------------------------- */
void as3993WaitForResponse(u16 waitMask);
/*------------------------------------------------------------------------- */
void as3993WaitForResponseFAST(u16 waitMask);
/*------------------------------------------------------------------------- */
void as3993WaitForResponseTimed(u16 waitMask, u16 ms);

#define as3993GetResponse() as3993Response
#define as3993ClrResponseMask(mask) as3993Response&=~(mask)
#define as3993ClrResponse() as3993Response=0

#if RUN_ON_AS3993

void as3993EnterDirectMode();
void as3993ExitDirectMode();

#endif

void as3993EnterPowerDownMode();

void as3993ExitPowerDownMode();

void as3993EnterPowerNormalMode();

void as3993ExitPowerNormalMode();

void as3993EnterPowerNormalRfMode();

void as3993ExitPowerNormalRfMode();

void as3993EnterPowerStandbyMode();

void as3993ExitPowerStandbyMode();

extern u8 as3993ChipVersion;

void as3993WaitForStartup(void);
#endif /* _AS3993_H_ */