MAXREADERKIT-EUR Cypress Semiconductor, MAXREADERKIT-EUR Datasheet
MAXREADERKIT-EUR
Specifications of MAXREADERKIT-EUR
Related parts for MAXREADERKIT-EUR
MAXREADERKIT-EUR Summary of contents
Page 1
MaxReader CLI User Guide 1.05 Rev Number st Date October 31 , 2011 RELEASE ~ ~ 1 ...
Page 2
Overview ............................................................................................................................................... 5 2 Nomenclature ....................................................................................................................................... 6 3 Reader Setup ........................................................................................................................................ 7 3.1 Hardware Setup ............................................................................................................................... 7 3.2 USB Driver Installation ................................................................................................................... 7 3.3 Terminal Setup ................................................................................................................................ 7 3.3.1 Quick Setup .............................................................................................................................. 7 3.3.2 Manual Setup ........................................................................................................................... 8 4 ...
Page 3
G2READEPC: Gen2 Read EPC Memory Bank ...................................................................... 27 4.3.5 G2READTID: Gen2 Read TID Memory Bank ......................................................................... 28 4.3.6 G2READUSER: Gen2 Read USER Memory Bank .................................................................. 28 4.3.7 G2READCNTL: Gen2 Read MaxArias Control/Status ............................................................ 28 4.3.8 G2READSTRDADDR: Gen2 Read MaxArias ...
Page 4
APPENDIX D EBV-Formatting ........................................................................................................... 52 MaxReader CLI User Guide v1. ...
Page 5
O VERVIEW This document provides a complete description of all commands available in the MaxReader Command Line Interpretter (CLI). The CLI is accessed through a terminal interface such as Windows ® Hyperterminal for Windows XP, Windows 7, or other ...
Page 6
N OMENCLATURE CLI Command Description Nomenclature G2* All CLI Gen2 commands and CLI Gen2 command sequences shall start with a “G2” command header. G2*X CLI Gen2 commands using EBV-formatted extended addressing shall include the character “X” in the command ...
Page 7
R S EADER ETUP 3.1 Hardware Setup The MaxReader requires the following to be connected to it prior to operation power cable, 2. USB cable, and 3. Antenna. The MaxReader obtains all the power it requires ...
Page 8
Manual Setup The computer terminal must be configured as shown below. COM port settings: Baud rate 460,800 Data bits 8 Parity None Stop bits 1 Flow control Hardware CTS/RTS COM port properties: Emulation ANSIW Input translation Standard JIS The ...
Page 9
OMMAND INE NTERPRETER This section defines the CLI instruction syntax. A complete instruction short-form can be found in APPENDIX A. Commands may be entered into the CLI in either upper-case or lower-case – commands shown in ...
Page 10
Control Instructions MaxReader control instructions are used to adjust the reader’s hardware and functional settings. They include enabling RF, buzzer, setting the Gen2 link frequency, controlling the display mode, etc. The following sections provide detail on all CLI control ...
Page 11
ASINIT: Front-End RF Hardware Initialization ASINIT Syntax AS3992 initialization Function Parameters None Cmd Reply None Command must always be performed once after startup and prior to any Gen2 command to initialize Description the AS3992 hardware. 4.1.2 RFON: RF Enable ...
Page 12
SPKROFF: Disable Buzzer SPKROFF Syntax Disable reader buzzer Function Parameters None Cmd Reply None Disables the buzzer from chirping when a successful Gen2 RFID command has completed. Description 4.1.6 SCRIPTON: Enable Scripting SCRIPTON Syntax Enables scripting Function Parameters None ...
Page 13
RFCHAN: RF Channel Select RFCHAN {chan} Syntax Define RF channel Function Parameters Parameter Value (hex) chan 1 – 32 None Cmd Reply This command sets the reader’s RF frequency channel available channels between 902- Description ...
Page 14
Conducted Reader Power as a Function of Attenuation 35.0 30.0 25.0 20.0 15.0 10.0 5.0 0 Figure 1 Relationship Between Nominal Output Power and ‘Attenuation Setting’ 4.1.11 LF40K: Link Frequency 40kHz LF40K Syntax Function Set link frequency to ...
Page 15
M0: Terminal Display Mode - Raw M0 Syntax Set display mode to raw Function Parameters None Cmd Reply None No display formatting is performed for Gen2 or DSPI read commands on the computer’s terminal. Description 4.1.14 M1: Terminal Display ...
Page 16
M4: Terminal Display Mode – Disable Line Feeds M4 Syntax Disable line feed transmission Function Parameters None Cmd Reply None The reader shall terminate a line transmission by transmitting a carriage return only. Line feeds are Description enabled by ...
Page 17
TESTPAG: Test Output Port Page Select TESTPAG {data} Syntax Set test port page select Function Parameters Parameter Value (hex) data None Cmd Reply Outputs internal signals on the test port. Refer to APPENDIX C. Description 4.1.22 ...
Page 18
Query Instructions CLI query instructions perform a Gen2 command sequence to transfer a tag from the arbitration state to an open state. A tag must continue to be powered by the RF field and must be in the open ...
Page 19
G2SCAN: Gen2 Continuous Tag Query – RF Channel Polling G2SCAN Syntax Perform a continuous tag query over all RF channels Function Parameters None :aaaa_bbbbccccddddeeeeffffgggg_hhhh Cmd Reply Parameter Definition aaaa EPC Protocol Control word (PC) bbbb EPC word 0 cccc ...
Page 20
G2FASTSCAN: Gen2 Continuous Tag Query – Fast RF Channel Polling G2FASTSCAN Syntax Perform a continuous tag query over all RF channels Function Parameters None :aaaa_bbbbccccddddeeeeffffgggg_hhhh Cmd Reply Parameter Definition aaaa EPC Protocol Control word (PC) bbbb EPC word 0 ...
Page 21
G2AUTOSCAN: Gen2 Continuous Tag Query – Automatic Channel Removal G2AUTOSCAN Syntax Perform a continuous tag query over all RF channels Function Parameters None :aaaa_bbbbccccddddeeeeffffgggg_hhhh Cmd Reply Parameter Definition aaaa EPC Protocol Control word (PC) bbbb EPC word 0 cccc ...
Page 22
G2CQRY: Gen2 Continuous Tag Query – Single RF Channel G2CQRY {Q} {sel} {session} {target} {M} Syntax Perform a continuous tag query over a single RF channel Function Parameters Parameter Value (hex) Q 0-F sel 0-4 session 0-3 target 0-1 ...
Page 23
G2QRY: Single Gen2 Tag Query G2QRY {Q} {sel} {session} {target} {M} Syntax Perform a single tag query Function Parameters Parameter Value (hex) Q 0-F sel 0-4 session 0-3 target 0-1 M 0-3 :aaaa_bbbbccccddddeeeeffffgggg_hhhh Cmd Reply Parameter Definition aaaa EPC ...
Page 24
G2RQRY: Single Gen2 Tag Re-Query G2RQRY {Q} {sel} {session} {target} {M} Syntax Perform a single tag re-query Function Parameters Parameter Value (hex) Q 0-F sel 0-4 session 0-3 target 0-1 M 0-3 :aaaa_bbbbccccddddeeeeffffgggg_hhhh Cmd Reply Parameter Definition aaaa EPC ...
Page 25
G2QRYPASS: Gen2 Continuous-Query Pass Counter G2QRYPASS Syntax Counts the number of successful tag queries Function Parameters None :pppp Cmd Reply Parameter Definition pppp 16-bit pass count Description Counts the number of successful tag queries when any one of the ...
Page 26
Read Instructions Gen2 read instructions are performed through the CLI by using the target memory bank (or register) in the name of the CLI command inferred that commands that do not include the Gen2 memory bank name ...
Page 27
G2READX: Gen2 Read – Extended Addressing G2READX {addr} {len} Syntax Gen2 USER memory bank read command – extended EBV addressing Function Parameters Parameter Value (hex) addr 8000-FF7F len 00-FF Cmd Reply data , data , …, data 0 1 ...
Page 28
G2READTID: Gen2 Read TID Memory Bank G2READTID Syntax Gen2 TID memory bank read command Function Parameters None Cmd Reply tid0, tid1, tid2, tid3, Handle, CRC16 Performs a standard Gen2 read command of the entire TID memory bank. The first ...
Page 29
G2READSTRDADDR: Gen2 Read MaxArias Working Stored Address G2READSTRDADDR Syntax MaxArias Working Stored Address read command Function Parameters None Cmd Reply data, Handle, CRC16 Performs a standard Gen2 read command of the MaxArias Working Stored Address register. The Description parsing ...
Page 30
Write Instructions Gen2 write instructions are performed through the CLI by using the target memory bank (or register) in the name of the CLI command inferred that commands that do not include the Gen2 memory bank name ...
Page 31
G2WRITEX: Gen2 Write – Extended Addressing G2WRITEX {addr} {data} Syntax Gen2 USER memory bank write command – extended addressing Function Parameters Parameter Value (hex) addr 8000-FF7F data 0-FFFF :WR_OK:handle Cmd Reply Description Performs a standard Gen2 write command on ...
Page 32
G2WRITEEPC: Gen2 Write EPC Identifier G2WRITEEPC {pc} {epc1} {epc2} {epc3} {epc4} {epc5} {epc6} Syntax Gen2 EPC memory bank write command Function Parameters Parameter Value pc See next epc1 user-defined EPC identifier – word 1 epc2 user-defined EPC identifier – ...
Page 33
G2WRITEKILL: Gen2 Write Kill Passwords G2WRITEKILL {pwd1} {pwd2} Syntax Gen2 RESERVED memory bank write command of the KILL passwords. Function Parameters Parameter Value pwd1 user-defined Kill password – most significant word pwd2 user-defined Kill password – least significant word ...
Page 34
G2WRITESTRDADDR: Gen2 Write MaxArias Working Stored Address G2WRITESTRDADDR {addr} Syntax MaxArias Working Stored Address write command Function Parameters Parameter Value addr user-defined The address parameter must not be less than x0005 and not greater Cmd Reply None Description Performs ...
Page 35
G2BLKWRITE: Gen2 MaxArias Blockwrite Command The MaxArias blockwrite instruction allows multiple data words (up to 127 written to the USER memory bank with a single instruction. The MaxArias block-write instructions defined here are designed to support the ...
Page 36
Memory Bank Lock Instructions The Gen2 standard defines two methodologies of locking tag memory: 1. Entire memory bank locking, and 2. USER memory bank block locking For each memory bank (with the exception of the TID memory bank that ...
Page 37
G2ULOCKKILL: Clear Kill Lock G2ULOCKKILL Syntax Clears the RESERVED memory bank kill password lock bit Function Parameters None Description Clears the lock bit of the RESERVED memory bank kill password. Prior to executing the G2ULOCKKILL command, the tag must ...
Page 38
G2ULOCKACC: Clear Access Lock G2ULOCKACC Syntax Clears the RESERVED memory bank access password lock bit Function Parameters None Description Clears the lock bit of the RESERVED memory bank access password. Prior to executing the G2ULOCKACC command, the tag must ...
Page 39
G2LOCKUSER: Set USER Lock G2LOCKUSER Syntax Sets the USER memory bank lock bit Function Parameters None Description Performs the lock function on the entire USER memory bank. Prior to executing the G2LOCKUSER command, the tag must be in the ...
Page 40
G2BLKPERMALOCK_RD: Read USER Block Lock Status G2BLKPERMALOCK_RD {blkpntr} {range} Syntax Reads the block permalock status Function Parameters Parameter Value (hex) blkpntr 0-7F range 1-FF Description Performs a Gen2 blockpermalock read instruction. The USER memory block lock status is read ...
Page 41
Other ACCESS Instructions This section details additional Gen2 instructions required for various functions, such as accessing a password-protected tag by advancing the tag’s state from the open state to the secured state, or generating a MaxArias interrupt. CLI Command ...
Page 42
G2KILL: Gen2 Kill Command Sequence G2KILL {pwd1} {pwd2} Syntax Performs a Gen2 kill command sequence Function Parameters Parameter Value pwd1 user-defined pwd2 user-defined Cmd Reply None Description Performs a Gen2 kill command to permanently disable the Gen2 interface from ...
Page 43
DSPI Instructions The CLI supports basic instructions to read/write MaxArias memory through the DSPI port. Additional functions have been incorporated to further assist use and implementation. CLI Command DSREAD DSWRITE DSINTEND DSPINGON DSPINGOFF 4.8.1 DSREAD: DSPI Read DSREAD {addr} ...
Page 44
DSINTEND: DSPI Interrupt End Opcode DSINTEND Syntax Transmits a serial port DSPI interrupt end opcode Function Parameters None Cmd Reply None Performs a MaxArias DSPI interrupt end instruction by transmitting the DSPI INTEND opcode. Description Refer to the MaxArias ...
Page 45
Direct-Mode Instructions Direct-mode instructions give access to the reader’s register map. Caution should be exercised when the direct mode instructions – they should only be used as indicated within this documentation or through advice from Ramtron’s technical support. 4.9.1 ...
Page 46
OMMAND XAMPLES To perform a single tag query: ASINIT RFON G2QRY NOTE: ASINIT is only executed a single time after reader power-on. To perform a continuous-query of the RFID tag: G2CQRY NOTE: Continuous-query mode ...
Page 47
APPENDIX A CLI Opcode n/a ASINIT n/a RFOFF RFON n/a n/a SPKRON n/a SPKROFF RFCHAN data n/a LF40K n/a LF160K n/a M0 n/a M1 n/a M2 n/a M3 n/a M4 n n/a n/a TESTPAG n/a G2SCAN ...
Page 48
CLI Opcode addr G2READ addr G2READX G2READRSVD n/a n/a G2READEPC G2READTID n/a n/a G2READUSER G2READCNTL n/a n/a G2READSTRDADDR addr data G2WRITE addr data G2WRITEX data x7 G2WRITEEPC data x2 G2WRITEACC G2WRITEKILL data x2 data G2WRITECNTL G2WRITESTRDADDR data G2BLKWRITE8W *** G2BLKWRITE32W ...
Page 49
CLI Opcode G2ULOCKUSER blkpntr len G2BLKPERMALOCK_RD G2BLKPERMALOCK_LK blkpntr mask DSREAD addr len addr data DSWRITE DSINTEND n/a n/a DSPINGON DSPINGOFF n/a W addr data addr len R Gen2 unlock USER memory bank Gen2 block-permalock read USER blocks lock status bits ...
Page 50
APPENDIX B Register Mnemonic Address MAIN_CNTL DSPI_FREQ QRY_PASS_CNT QRY_FAIL_CNT RF_CHAN FPGAVER TEST_REG Direct Register Memory Map Init. Data (hex) State Granularity (hex) (bits 000F 16 58 0000 16 59 0000 ...
Page 51
APPENDIX C Page Test 0 0 Gen2 DSPI Clk 2 UART TxD 4 Rx decode enable A Gen2 test_reg(0) Test Port Pages Test 1 Test 2 Gen2 Rx BB Gen2 Rx Enable DSPI Data1 ...
Page 52
APPENDIX D EBV-formatted addressing is best understood by first considering the conversion from an EBV-formatted address to a standard-formatted address using the following simple rules: 1. Remove the most significant bits from all bytes. 2. Concatenate the remaining bits. 3. ...
Page 53
Rev’n Date Author 1.00 05.09.11 Kirk Greefkes 1.01 05.21.11 Kirk Greefkes 1.03 09.02.11 Kirk Greefkes 1.04 10.20.11 Kirk Greefkes 1.05 10.31.11 Kirk Greefkes Revision History Comments Initial creation. Add elapsed timer information. Add section 5. Add two appendices. Add various ...