platform.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 PLATFORM_H_
#define PLATFORM_H_

/*
******************************************************************************
* INCLUDES
******************************************************************************
*/
#include <p24Fxxxx.h>
#include "Compiler.h"
#include "global.h"
#include "as3993_config.h"


/*
******************************************************************************
* DEFINES
******************************************************************************
*/
#define STOP_NONE               0

#define STOP_SGL                1

#define STOP_CONT               2

#define as3993Isr _INT1Interrupt

#define timer3Isr _T3Interrupt

#define timer4Isr _T4Interrupt

#define ENEXTIRQ()                _INT1IE = 1;

#define DISEXTIRQ()               _INT1IE = 0

#define CLREXTIRQ()               _INT1IF = 0



#define EN(x)                     ENABLE=(x)

#define EN_PA(x)                  EN_PAPIN(x)

#define NCS(x)                    NCSPIN=(x)

#define NCS_SELECT()              NCS(0)

#define NCS_DESELECT()            NCS(1)

#ifdef TUNER
#define SEN_TUNER_CIN(x)          SEN_CINPIN(x)
#define SEN_TUNER_CLEN(x)         SEN_CLENPIN(x)
#define SEN_TUNER_COUT(x)         SEN_COUTPIN(x)
#endif

#define MCULED(x)                 MCULEDPIN(x)

#define NUMLEDS                   BOARD_NUMLEDS
#define LED1(x)                   LED1PIN(x)
#define LED2(x)                   LED2PIN(x)
#define LED3(x)                   LED3PIN(x)
#define LED4(x)                   LED4PIN(x)

#define LEDON                     0
#define LEDOFF                    1

// Select RX or TX in Direct Mode by setting a dedicated Pin to High or Low
#define DIRECT_MODE_ENABLE_SENDER()      DM_SW_RX_TX(LOW)
#define DIRECT_MODE_ENABLE_RECEIVER()    DM_SW_RX_TX(HIGH)


//definition of test points for debugging
#if FERMI
#define TP1(x)  _LATB4=(x);
#elif  FEMTO2 || FEMTO2_1
#define TP1(x)  _LATB4=(x);
#elif RADON
/* not available :#define TP1(x)  _LATF1=(x); */
#elif NEWTON
/* not available; */
#endif

//definition of irq pins
#if FERMI
#define AS3993_PORT_INT  _RB14
#elif  FEMTO2 || FEMTO2_1
#define AS3993_PORT_INT  _RB14
#elif RADON
#define AS3993_PORT_INT  _RC4
#elif NEWTON
#define AS3993_PORT_INT  _RB14
#endif

/*
******************************************************************************
* GLOBAL FUNCTIONS
******************************************************************************
*/
/*------------------------------------------------------------------------- */
void platformInit(void);

/*------------------------------------------------------------------------- */
void spiInit(void);

/*------------------------------------------------------------------------- */
void writeReadAS3993( const u8* wbuf, u8 wlen, u8* rbuf, u8 rlen, u8 stopMode, u8 doStart );

void writeReadAS3993Isr( const u8 *wbuf, u8 wlen, u8* rbuf, u8 rlen );

/*------------------------------------------------------------------------- */
void setPortDirect();

/*------------------------------------------------------------------------- */
void setPortNormal();

/*
******************************************************************************
* INTERNAL DEFINES
* Not to be used directly, use the macros at the top of this file
******************************************************************************
*/
#if FERMI

#define NCSPIN                    _LATB15

#define ENABLE                    _LATB13

#define EN_PAPIN(x)                do{u8 r; r = as3993SingleRead(AS3993_REG_RFOUTPUTCONTROL); r = ((x==PA_ON)?(r|0x20):(r&~0x20)); as3993SingleWrite(AS3993_REG_RFOUTPUTCONTROL,r);}while(0)

#define MCULEDPIN(x)              _LATB9=(x)

#define BOARD_NUMLEDS             3
#define LED1PIN(x)                _LATB4=(x)
#define LED2PIN(x)                _LATA4=(x)
#define LED3PIN(x)                _LATB5=(x)
#define LED4PIN(x)

#define PA_ON                     HIGH
#define PA_OFF                    LOW

/* Definition for the Direct Mode Pins */
#define DM_TX              _LATA1       // MOSI PIN
#define DM_RX(x)           _LATA0=(x)   // MISO PIN
#define DM_SW_RX_TX(x)     _LATB3=(x)   // SCLK PIN
#define DM_RX_CLK(x)       _LATB14=(x)  // IRQ PIN

#elif FEMTO2 

#define NCSPIN                    _LATB15

#define ENABLE                    _LATB8

#define MCULEDPIN(x)              _LATB4=(x)

#define BOARD_NUMLEDS             2
#define LED1PIN(x)                _LATA4=(x)
#define LED2PIN(x)                _LATA2=(x)
#define LED3PIN(x)
#define LED4PIN(x)

#define SWITCH_ANTENNA(x)       _LATB2 = ((x)==2?SWITCH_ANT_P2:SWITCH_ANT_P1)
#define SWITCH_ANT_P1           0x0
#define SWITCH_ANT_P2           0x1

#define SEN_CINPIN(x)           _LATB5=(x)
#define SEN_CLENPIN(x)
#define SEN_COUTPIN(x)          _LATB9=(x)

#define PA_ON                     HIGH
#define PA_OFF                    LOW

/* Definition for the Direct Mode Pins */
#define DM_TX              _LATA1       // MOSI PIN
#define DM_RX(x)           _LATA0=(x)   // MISO PIN
#define DM_SW_RX_TX(x)     _LATB3=(x)   // SCLK PIN
#define DM_RX_CLK(x)       _LATB14=(x)  // IRQ PIN


#elif FEMTO2_1

#define NCSPIN                    _LATB15

#define ENABLE                    _LATB8

#define MCULEDPIN(x)              _LATB1=(x) //changed from V2.0 to V2.1

#define BOARD_NUMLEDS             2
#define LED1PIN(x)                _LATB0=(x) //changed from V2.0 to V2.1
#define LED2PIN(x)                _LATA2=(x)
#define LED3PIN(x)
#define LED4PIN(x)

#define SWITCH_ANTENNA(x)       _LATB2 = ((x)==2?SWITCH_ANT_P2:SWITCH_ANT_P1)
#define SWITCH_ANT_P1           0x0
#define SWITCH_ANT_P2           0x1

#define SEN_CINPIN(x)           _LATB5=(x)
#define SEN_CLENPIN(x)
#define SEN_COUTPIN(x)          _LATB9=(x)

#define PA_ON                     HIGH
#define PA_OFF                    LOW

/* Definition for the Direct Mode Pins */
#define DM_TX              _LATA1       // MOSI PIN
#define DM_RX(x)           _LATA0=(x)   // MISO PIN
#define DM_SW_RX_TX(x)     _LATB3=(x)   // SCLK PIN
#define DM_RX_CLK(x)       _LATB14=(x)  // IRQ PIN

#elif RADON

#define NCSPIN                    _LATC5

#define ENABLE                    _LATC3

#define EN_PAPIN(x)               do{u8 r;LED3PIN(x);r = as3993SingleRead(AS3993_REG_RFOUTPUTCONTROL); r = ((x==PA_ON)?(r|0x20):(r&~0x20)); as3993SingleWrite(AS3993_REG_RFOUTPUTCONTROL,r);}while(0)

#define MCULEDPIN(x)              LED1PIN(x)
#define ANT1LEDPIN(x)             LED6PIN(x)
#define ANT2LEDPIN(x)             LED5PIN(x)
#define RFDATARECEIVELED(x)       LED4PIN(x)
#define REFLPOWERTOOHIGHLED(x)    LED2PIN(x)

#define BOARD_NUMLEDS             7
/* A1 is LED5(schematic) aka D13 */
#define LED1PIN(x)                _LATA1=(x)
/* A8 is LED4(schematic) aka D8 */
#define LED2PIN(x)                _LATA8=(x)
/* B4 is LED3(schematic) aka D9 */
#define LED3PIN(x)                _LATB4=(x)
/* A4 is LED2(schematic) aka D10 */
#define LED4PIN(x)                _LATA4=(x)
/* A9 is LED1(schematic) aka D7 */
#define LED5PIN(x)                _LATA9=(x)
/* C6 is LED6(schematic) aka D11 */
#define LED6PIN(x)                _LATC6=(x)

#define SWITCH_ANTENNA(x)       (_LATC7 = ((x)==2?SWITCH_ANT_P2:SWITCH_ANT_P1), ANT2LEDPIN((x)==2), ANT1LEDPIN((x)!=2))
#define SWITCH_ANT_P1           0x0
#define SWITCH_ANT_P2           0x1

#define SEN_CINPIN(x)           _LATC0=(x)
#define SEN_CLENPIN(x)          _LATC1=(x)
#define SEN_COUTPIN(x)          _LATC2=(x)

#define SEN_ANT1_CINPIN(x)      _LATB2=(x)
#define SEN_ANT1_COUTPIN(x)     _LATB3=(x)
#define BUTTON                  _RA0


#define PA_ON                     LOW
#define PA_OFF                    HIGH

/* Definition for the Direct Mode Pins */
#define DM_TX              _LATB8       // MOSI PIN
#define DM_RX(x)           _LATB7=(x)   // MISO PIN
#define DM_SW_RX_TX(x)     _LATB9=(x)   // SCLK PIN
#define DM_RX_CLK(x)       _LATC4=(x)  // IRQ PIN


#elif NEWTON

#define NCSPIN                    _LATB15

#define ENABLE                    _LATB13

#define EN_PAPIN(x)                do{u8 r; r = as3993SingleRead(AS3993_REG_RFOUTPUTCONTROL); r = ((x==PA_ON)?(r|0x20):(r&~0x20)); as3993SingleWrite(AS3993_REG_RFOUTPUTCONTROL,r);}while(0)

#define BUTTON                    _RB4

#if AS3993DEBUG
#define BOARD_NUMLEDS             1
#define MCULEDPIN(x)              LED1PIN(x)
#define LED1PIN(x)               _LATA4=(x)
#define LED2PIN(x)               
#define LED3PIN(x)               
#define LED4PIN(x)         
#else
#define BOARD_NUMLEDS             3
#define MCULEDPIN(x)              LED1PIN(x)
#define ANT1LEDPIN(x)             LED3PIN(x)
#define ANT2LEDPIN(x)             LED2PIN(x)

#define LED1PIN(x)               _LATB0=(x)
#define LED2PIN(x)               _LATB1=(x)
#define LED3PIN(x)               _LATA4=(x)
#define LED4PIN(x)    
#endif
        
#define PA_ON                     HIGH
#define PA_OFF                    LOW

/* Definition for the Direct Mode Pins */
#define DM_TX              _LATA1   // MOSI PIN
#define DM_RX(x)           _LATA0=(x)   // MISO PIN
#define DM_SW_RX_TX(x)     _LATB3=(x)   // SCLK PIN
#define DM_RX_CLK(x)       _LATB14=(x)  // IRQ PIN

#define SWITCH_ANT_A1           0x0 // Internal Antenna
#define SWITCH_ANT_P1           0x1 // External Antenna
#define SWITCH_ANTENNA(x)       (_LATB9 = ((x)==2?SWITCH_ANT_A1:SWITCH_ANT_P1), ANT2LEDPIN((x)==2), ANT1LEDPIN((x)!=2))

#endif

#endif /* PLATFORM_H_ */