forked from ATrappmann/PN5180-Library
-
Notifications
You must be signed in to change notification settings - Fork 0
/
PN5180ISO15693.cpp
753 lines (668 loc) · 24.3 KB
/
PN5180ISO15693.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
// NAME: PN5180ISO15693.h
//
// DESC: ISO15693 protocol on NXP Semiconductors PN5180 module for Arduino.
//
// Copyright (c) 2018 by Andreas Trappmann. All rights reserved.
//
// This file is part of the PN5180 library for the Arduino environment.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
//#define DEBUG 1
#include <Arduino.h>
#include "PN5180ISO15693.h"
#include "Debug.h"
PN5180ISO15693::PN5180ISO15693(uint8_t SSpin, uint8_t BUSYpin, uint8_t RSTpin)
: PN5180(SSpin, BUSYpin, RSTpin) {
}
/*
* Inventory, code=01
*
* Request format: SOF, Req.Flags, Inventory, AFI (opt.), Mask len, Mask value, CRC16, EOF
* Response format: SOF, Resp.Flags, DSFID, UID, CRC16, EOF
*
*/
ISO15693ErrorCode PN5180ISO15693::getInventory(uint8_t *uid) {
// Flags, CMD, maskLen
uint8_t inventory[] = { 0x26, 0x01, 0x00 };
// |\- inventory flag + high data rate
// \-- 1 slot: only one card, no AFI field present
PN5180DEBUG(F("Get Inventory...\n"));
for (int i=0; i<8; i++) {
uid[i] = 0;
}
uint8_t *readBuffer;
ISO15693ErrorCode rc = issueISO15693Command(inventory, sizeof(inventory), &readBuffer);
if (ISO15693_EC_OK != rc) {
return rc;
}
PN5180DEBUG(F("Response flags: "));
PN5180DEBUG(formatHex(readBuffer[0]));
PN5180DEBUG(F(", Data Storage Format ID: "));
PN5180DEBUG(formatHex(readBuffer[1]));
PN5180DEBUG(F(", UID: "));
for (int i=0; i<8; i++) {
uid[i] = readBuffer[2+i];
#ifdef DEBUG
PN5180DEBUG(formatHex(uid[7-i])); // LSB comes first
if (i<2) PN5180DEBUG(":");
#endif
}
PN5180DEBUG("\n");
return ISO15693_EC_OK;
}
/*
* Read single block, code=20
*
* Request format: SOF, Req.Flags, ReadSingleBlock, UID (opt.), BlockNumber, CRC16, EOF
* Response format:
* when ERROR flag is set:
* SOF, Resp.Flags, ErrorCode, CRC16, EOF
*
* Response Flags:
* xxxx.3xx0
* |||\_ Error flag: 0=no error, 1=error detected, see error field
* \____ Extension flag: 0=no extension, 1=protocol format is extended
*
* If Error flag is set, the following error codes are defined:
* 01 = The command is not supported, i.e. the request code is not recognized.
* 02 = The command is not recognized, i.e. a format error occurred.
* 03 = The option is not supported.
* 0F = Unknown error.
* 10 = The specific block is not available.
* 11 = The specific block is already locked and cannot be locked again.
* 12 = The specific block is locked and cannot be changed.
* 13 = The specific block was not successfully programmed.
* 14 = The specific block was not successfully locked.
* A0-DF = Custom command error codes
*
* when ERROR flag is NOT set:
* SOF, Flags, BlockData (len=blockLength), CRC16, EOF
*/
ISO15693ErrorCode PN5180ISO15693::readSingleBlock(uint8_t *uid, uint8_t blockNo, uint8_t *blockData, uint8_t blockSize) {
// flags, cmd, uid, blockNo
uint8_t readSingleBlock[] = { 0x22, 0x20, 1,2,3,4,5,6,7,8, blockNo }; // UID has LSB first!
// |\- high data rate
// \-- no options, addressed by UID
for (int i=0; i<8; i++) {
readSingleBlock[2+i] = uid[i];
}
#ifdef DEBUG
PN5180DEBUG("Read Single Block #");
PN5180DEBUG(blockNo);
PN5180DEBUG(", size=");
PN5180DEBUG(blockSize);
PN5180DEBUG(": ");
for (int i=0; i<sizeof(readSingleBlock); i++) {
PN5180DEBUG(" ");
PN5180DEBUG(formatHex(readSingleBlock[i]));
}
PN5180DEBUG("\n");
#endif
uint8_t *resultPtr;
ISO15693ErrorCode rc = issueISO15693Command(readSingleBlock, sizeof(readSingleBlock), &resultPtr);
if (ISO15693_EC_OK != rc) {
return rc;
}
PN5180DEBUG("Value=");
for (int i=0; i<blockSize; i++) {
blockData[i] = resultPtr[1+i];
#ifdef DEBUG
PN5180DEBUG(formatHex(blockData[i]));
PN5180DEBUG(" ");
#endif
}
#ifdef DEBUG
PN5180DEBUG(" ");
for (int i=0; i<blockSize; i++) {
char c = blockData[i];
if (isPrintable(c)) {
PN5180DEBUG(c);
}
else PN5180DEBUG(".");
}
PN5180DEBUG("\n");
#endif
return ISO15693_EC_OK;
}
/**
* @brief Writes the Application Family Identifier (AFI) to a tag.
*
* This method constructs and sends a command to write the AFI value to the specified UID.
* The command format includes both flags and UID, followed by the AFI value.
* Debug output is enabled if DEBUG is defined, printing the command to the Serial console.
*
* @param uid Pointer to an array containing the UID of the tag (8 bytes).
* @param afi The AFI value to be written to the tag.
* @return ISO15693ErrorCode indicating the success or failure of the operation.
*/
ISO15693ErrorCode PN5180ISO15693::writeAFI(uint8_t *uid, uint8_t afi) {
// Construct the command for writing AFI
uint8_t writeAFICommand[] = { 0x22, 0x27, 0, 0, 0, 0, 0, 0, 0, 0, afi }; // UID has LSB first!
for (int i = 0; i < 8; i++) {
writeAFICommand[2 + i] = uid[i];
}
#ifdef DEBUG
Serial.print("Write AFI Command: ");
for (int i = 0; i < sizeof(writeAFICommand); i++) {
Serial.print(writeAFICommand[i], HEX);
Serial.print(" ");
}
Serial.println();
#endif
uint8_t* resultPtr;
ISO15693ErrorCode rc = issueISO15693Command(writeAFICommand, sizeof(writeAFICommand), &resultPtr);
return rc;
}
/**
* @brief Reads the Application Family Identifier (AFI) from a tag.
*
* This method uses the getSystemInfo command to retrieve the AFI value.
* The AFI value is included in the system information response if the
* tag supports and has an AFI value set.
*
* @param uid Pointer to an array containing the UID of the tag (8 bytes).
* @param afi Pointer to store the read AFI value.
* @return ISO15693ErrorCode indicating the success or failure of the operation.
*/
ISO15693ErrorCode PN5180ISO15693::readAFI(uint8_t *uid, uint8_t *afi) {
uint8_t sysInfo[] = { 0x22, 0x2b, 0, 0, 0, 0, 0, 0, 0, 0 }; // Get System Info command
// Copy UID into command buffer (LSB first)
for (int i = 0; i < 8; i++) {
sysInfo[2+i] = uid[i];
}
#ifdef DEBUG
PN5180DEBUG(F("Read AFI using System Info command: "));
for (int i=0; i<sizeof(sysInfo); i++) {
PN5180DEBUG(formatHex(sysInfo[i]));
PN5180DEBUG(" ");
}
PN5180DEBUG("\n");
#endif
uint8_t *readBuffer;
ISO15693ErrorCode rc = issueISO15693Command(sysInfo, sizeof(sysInfo), &readBuffer);
if (rc != ISO15693_EC_OK) {
return rc;
}
// Check info flags to see if AFI is supported/present
uint8_t infoFlags = readBuffer[1];
if (!(infoFlags & 0x02)) { // AFI flag not set
return ISO15693_EC_OPTION_NOT_SUPPORTED;
}
// Calculate position of AFI in response buffer
uint8_t *p = &readBuffer[10]; // Start after UID
// Skip DSFID if present
if (infoFlags & 0x01) { // DSFID flag
p++;
}
// Read AFI value
*afi = *p;
#ifdef DEBUG
PN5180DEBUG(F("AFI value read: 0x"));
PN5180DEBUG(formatHex(*afi));
PN5180DEBUG("\n");
#endif
return ISO15693_EC_OK;
}
/*
* Write single block, code=21
*
* Request format: SOF, Requ.Flags, WriteSingleBlock, UID (opt.), BlockNumber, BlockData (len=blcokLength), CRC16, EOF
* Response format:
* when ERROR flag is set:
* SOF, Resp.Flags, ErrorCode, CRC16, EOF
*
* Response Flags:
* xxxx.3xx0
* |||\_ Error flag: 0=no error, 1=error detected, see error field
* \____ Extension flag: 0=no extension, 1=protocol format is extended
*
* If Error flag is set, the following error codes are defined:
* 01 = The command is not supported, i.e. the request code is not recognized.
* 02 = The command is not recognized, i.e. a format error occurred.
* 03 = The option is not supported.
* 0F = Unknown error.
* 10 = The specific block is not available.
* 11 = The specific block is already locked and cannot be locked again.
* 12 = The specific block is locked and cannot be changed.
* 13 = The specific block was not successfully programmed.
* 14 = The specific block was not successfully locked.
* A0-DF = Custom command error codes
*
* when ERROR flag is NOT set:
* SOF, Resp.Flags, CRC16, EOF
*/
ISO15693ErrorCode PN5180ISO15693::writeSingleBlock(uint8_t *uid, uint8_t blockNo, uint8_t *blockData, uint8_t blockSize) {
// flags, cmd, uid, blockNo
uint8_t writeSingleBlock[] = { 0x22, 0x21, 1,2,3,4,5,6,7,8, blockNo }; // UID has LSB first!
// |\- high data rate
// \-- no options, addressed by UID
uint8_t writeCmdSize = sizeof(writeSingleBlock) + blockSize;
uint8_t *writeCmd = (uint8_t*)malloc(writeCmdSize);
uint8_t pos = 0;
writeCmd[pos++] = writeSingleBlock[0];
writeCmd[pos++] = writeSingleBlock[1];
for (int i=0; i<8; i++) {
writeCmd[pos++] = uid[i];
}
writeCmd[pos++] = blockNo;
for (int i=0; i<blockSize; i++) {
writeCmd[pos++] = blockData[i];
}
#ifdef DEBUG
PN5180DEBUG("Write Single Block #");
PN5180DEBUG(blockNo);
PN5180DEBUG(", size=");
PN5180DEBUG(blockSize);
PN5180DEBUG(":");
for (int i=0; i<writeCmdSize; i++) {
PN5180DEBUG(" ");
PN5180DEBUG(formatHex(writeCmd[i]));
}
PN5180DEBUG("\n");
#endif
uint8_t *resultPtr;
ISO15693ErrorCode rc = issueISO15693Command(writeCmd, writeCmdSize, &resultPtr);
if (ISO15693_EC_OK != rc) {
free(writeCmd);
return rc;
}
free(writeCmd);
return ISO15693_EC_OK;
}
/*
* Get System Information, code=2B
*
* Request format: SOF, Req.Flags, GetSysInfo, UID (opt.), CRC16, EOF
* Response format:
* when ERROR flag is set:
* SOF, Resp.Flags, ErrorCode, CRC16, EOF
*
* Response Flags:
* xxxx.3xx0
* |||\_ Error flag: 0=no error, 1=error detected, see error field
* \____ Extension flag: 0=no extension, 1=protocol format is extended
*
* If Error flag is set, the following error codes are defined:
* 01 = The command is not supported, i.e. the request code is not recognized.
* 02 = The command is not recognized, i.e. a format error occurred.
* 03 = The option is not supported.
* 0F = Unknown error.
* 10 = The specific block is not available.
* 11 = The specific block is already locked and cannot be locked again.
* 12 = The specific block is locked and cannot be changed.
* 13 = The specific block was not successfully programmed.
* 14 = The specific block was not successfully locked.
* A0-DF = Custom command error codes
*
* when ERROR flag is NOT set:
* SOF, Flags, InfoFlags, UID, DSFID (opt.), AFI (opt.), Other fields (opt.), CRC16, EOF
*
* InfoFlags:
* xxxx.3210
* |||\_ DSFID: 0=DSFID not supported, DSFID field NOT present; 1=DSFID supported, DSFID field present
* ||\__ AFI: 0=AFI not supported, AFI field not present; 1=AFI supported, AFI field present
* |\___ VICC memory size:
* | 0=Information on VICC memory size is not supported. Memory size field is present. ???
* | 1=Information on VICC memory size is supported. Memory size field is present.
* \____ IC reference:
* 0=Information on IC reference is not supported. IC reference field is not present.
* 1=Information on IC reference is supported. IC reference field is not present.
*
* VICC memory size:
* xxxb.bbbb nnnn.nnnn
* bbbbb - Block size is expressed in number of bytes, on 5 bits, allowing to specify up to 32 bytes i.e. 256 bits.
* nnnn.nnnn - Number of blocks is on 8 bits, allowing to specify up to 256 blocks.
*
* IC reference: The IC reference is on 8 bits and its meaning is defined by the IC manufacturer.
*/
ISO15693ErrorCode PN5180ISO15693::getSystemInfo(uint8_t *uid, uint8_t *blockSize, uint8_t *numBlocks) {
uint8_t sysInfo[] = { 0x22, 0x2b, 1,2,3,4,5,6,7,8 }; // UID has LSB first!
for (int i=0; i<8; i++) {
sysInfo[2+i] = uid[i];
}
#ifdef DEBUG
PN5180DEBUG("Get System Information");
for (int i=0; i<sizeof(sysInfo); i++) {
PN5180DEBUG(" ");
PN5180DEBUG(formatHex(sysInfo[i]));
}
PN5180DEBUG("\n");
#endif
uint8_t *readBuffer;
ISO15693ErrorCode rc = issueISO15693Command(sysInfo, sizeof(sysInfo), &readBuffer);
if (ISO15693_EC_OK != rc) {
return rc;
}
for (int i=0; i<8; i++) {
uid[i] = readBuffer[2+i];
}
#ifdef DEBUG
PN5180DEBUG("UID=");
for (int i=0; i<8; i++) {
PN5180DEBUG(formatHex(readBuffer[9-i])); // UID has LSB first!
if (i<2) PN5180DEBUG(":");
}
PN5180DEBUG("\n");
#endif
uint8_t *p = &readBuffer[10];
uint8_t infoFlags = readBuffer[1];
if (infoFlags & 0x01) { // DSFID flag
uint8_t dsfid = *p++;
PN5180DEBUG("DSFID="); // Data storage format identifier
PN5180DEBUG(formatHex(dsfid));
PN5180DEBUG("\n");
}
#ifdef DEBUG
else PN5180DEBUG(F("No DSFID\n"));
#endif
if (infoFlags & 0x02) { // AFI flag
uint8_t afi = *p++;
PN5180DEBUG(F("AFI=")); // Application family identifier
PN5180DEBUG(formatHex(afi));
PN5180DEBUG(F(" - "));
switch (afi >> 4) {
case 0: PN5180DEBUG(F("All families")); break;
case 1: PN5180DEBUG(F("Transport")); break;
case 2: PN5180DEBUG(F("Financial")); break;
case 3: PN5180DEBUG(F("Identification")); break;
case 4: PN5180DEBUG(F("Telecommunication")); break;
case 5: PN5180DEBUG(F("Medical")); break;
case 6: PN5180DEBUG(F("Multimedia")); break;
case 7: PN5180DEBUG(F("Gaming")); break;
case 8: PN5180DEBUG(F("Data storage")); break;
case 9: PN5180DEBUG(F("Item management")); break;
case 10: PN5180DEBUG(F("Express parcels")); break;
case 11: PN5180DEBUG(F("Postal services")); break;
case 12: PN5180DEBUG(F("Airline bags")); break;
default: PN5180DEBUG(F("Unknown")); break;
}
PN5180DEBUG("\n");
}
#ifdef DEBUG
else PN5180DEBUG(F("No AFI\n"));
#endif
if (infoFlags & 0x04) { // VICC Memory size
*numBlocks = *p++;
*blockSize = *p++;
*blockSize = (*blockSize) & 0x1f;
*blockSize = *blockSize + 1; // range: 1-32
*numBlocks = *numBlocks + 1; // range: 1-256
uint16_t viccMemSize = (*blockSize) * (*numBlocks);
PN5180DEBUG("VICC MemSize=");
PN5180DEBUG(viccMemSize);
PN5180DEBUG(" BlockSize=");
PN5180DEBUG(*blockSize);
PN5180DEBUG(" NumBlocks=");
PN5180DEBUG(*numBlocks);
PN5180DEBUG("\n");
}
#ifdef DEBUG
else PN5180DEBUG(F("No VICC memory size\n"));
#endif
if (infoFlags & 0x08) { // IC reference
uint8_t icRef = *p++;
PN5180DEBUG("IC Ref=");
PN5180DEBUG(formatHex(icRef));
PN5180DEBUG("\n");
}
#ifdef DEBUG
else PN5180DEBUG(F("No IC ref\n"));
#endif
return ISO15693_EC_OK;
}
// ICODE SLIX specific commands
/*
* The GET RANDOM NUMBER command is required to receive a random number from the label IC.
* The passwords that will be transmitted with the SET PASSWORD,ENABLEPRIVACY and DESTROY commands
* have to be calculated with the password and therandom number (see Section 9.5.3.2 "SET PASSWORD")
*/
ISO15693ErrorCode PN5180ISO15693::getRandomNumber(uint8_t *randomData) {
uint8_t getrandom[] = {0x02, 0xB2, 0x04};
uint8_t *readBuffer;
ISO15693ErrorCode rc = issueISO15693Command(getrandom, sizeof(getrandom), &readBuffer);
if (rc == ISO15693_EC_OK) {
randomData[0] = readBuffer[1];
randomData[1] = readBuffer[2];
}
return rc;
}
/*
* The SET PASSWORD command enables the different passwords to be transmitted to the label
* to access the different protected functionalities of the following commands.
* The SET PASSWORD command has to be executed just once for the related passwords if the label is powered
*/
ISO15693ErrorCode PN5180ISO15693::setPassword(uint8_t *password, uint8_t *random) {
uint8_t setPassword[] = {0x02, 0xB3, 0x04, 0x04, 0x00, 0x00, 0x00, 0x00};
uint8_t *readBuffer;
setPassword[4] = password[0] ^ random[0];
setPassword[5] = password[1] ^ random[1];
setPassword[6] = password[2] ^ random[0];
setPassword[7] = password[3] ^ random[1];
ISO15693ErrorCode rc = issueISO15693Command(setPassword, sizeof(setPassword), &readBuffer);
return rc;
}
ISO15693ErrorCode PN5180ISO15693::enablePrivacy(uint8_t *password, uint8_t *random) {
uint8_t setPrivacy[] = {0x02, 0xBA, 0x04, 0x00, 0x00, 0x00, 0x00};
uint8_t *readBuffer;
setPrivacy[3] = password[0] ^ random[0];
setPrivacy[4] = password[1] ^ random[1];
setPrivacy[5] = password[2] ^ random[0];
setPrivacy[6] = password[3] ^ random[1];
ISO15693ErrorCode rc = issueISO15693Command(setPrivacy, sizeof(setPrivacy), &readBuffer);
return rc;
}
ISO15693ErrorCode PN5180ISO15693::writePassword(uint8_t *password, uint8_t *uid) {
uint8_t writePassword[] = {0x22, 0xB4, 0x04, uid[0], uid[1], uid[2], uid[3], uid[4], uid[5], uid[6], uid[7], 0x04, 0x00, 0x00, 0x00, 0x00};
uint8_t *readBuffer;
writePassword[12] = password[0];
writePassword[13] = password[1];
writePassword[14] = password[2];
writePassword[15] = password[3];
ISO15693ErrorCode rc = issueISO15693Command(writePassword, sizeof(writePassword), &readBuffer);
return rc;
}
// unlock a ICODE SLIX2 tag with given password
ISO15693ErrorCode PN5180ISO15693::unlockICODESLIX2(uint8_t *password) {
// get a random number from the tag
uint8_t random[]= {0x00, 0x00};
ISO15693ErrorCode rc = getRandomNumber(random);
if (rc != ISO15693_EC_OK) {
return rc;
}
// set password to unlock the tag
rc = setPassword(password, random);
return rc;
}
// lock a ICODE SLIX2 tag with given password (set to privacy mode)
ISO15693ErrorCode PN5180ISO15693::lockICODESLIX2(uint8_t *password) {
// get a random number from the tag
uint8_t random[]= {0x00, 0x00};
ISO15693ErrorCode rc = getRandomNumber(random);
if (rc != ISO15693_EC_OK) {
return rc;
}
// enable privacy command to lock the tag
rc = enablePrivacy(password, random);
return rc;
}
// set a new privacy password for slix2 Tags
ISO15693ErrorCode PN5180ISO15693::newpasswordICODESLIX2(uint8_t *newpassword, uint8_t *oldpassword, uint8_t *uid) {
// get a random number from the tag
uint8_t random[]= {0x00, 0x00};
ISO15693ErrorCode rc = getRandomNumber(random);
if (rc != ISO15693_EC_OK) {
return rc;
}
// set password to unlock the tag
rc = setPassword(oldpassword, random);
if (rc != ISO15693_EC_OK) {
return rc;
}
// write new password
rc = writePassword(newpassword, uid);
return rc;
}
/*
* ISO 15693 - Protocol
*
* General Request Format:
* SOF, Req.Flags, Command code, Parameters, Data, CRC16, EOF
*
* Request Flags:
* xxxx.3210
* |||\_ Subcarrier flag: 0=single sub-carrier, 1=two sub-carrier
* ||\__ Datarate flag: 0=low data rate, 1=high data rate
* |\___ Inventory flag: 0=no inventory, 1=inventory
* \____ Protocol extension flag: 0=no extension, 1=protocol format is extended
*
* If Inventory flag is set:
* 7654.xxxx
* ||\_ AFI flag: 0=no AFI field present, 1=AFI field is present
* |\__ Number of slots flag: 0=16 slots, 1=1 slot
* \___ Option flag: 0=default, 1=meaning is defined by command description
*
* If Inventory flag is NOT set:
* 7654.xxxx
* ||\_ Select flag: 0=request shall be executed by any VICC according to Address_flag
* || 1=request shall be executed only by VICC in selected state
* |\__ Address flag: 0=request is not addressed. UID field is not present.
* | 1=request is addressed. UID field is present. Only VICC with UID shall answer
* \___ Option flag: 0=default, 1=meaning is defined by command description
*
* General Response Format:
* SOF, Resp.Flags, Parameters, Data, CRC16, EOF
*
* Response Flags:
* xxxx.3210
* |||\_ Error flag: 0=no error, 1=error detected, see error field
* ||\__ RFU: 0
* |\___ RFU: 0
* \____ Extension flag: 0=no extension, 1=protocol format is extended
*
* If Error flag is set, the following error codes are defined:
* 01 = The command is not supported, i.e. the request code is not recognized.
* 02 = The command is not recognized, i.e. a format error occurred.
* 03 = The option is not supported.
* 0F = Unknown error.
* 10 = The specific block is not available.
* 11 = The specific block is already locked and cannot be locked again.
* 12 = The specific block is locked and cannot be changed.
* 13 = The specific block was not successfully programmed.
* 14 = The specific block was not successfully locked.
* A0-DF = Custom command error codes
*
* Function return values:
* 0 = OK
* -1 = No card detected
* >0 = Error code
*/
ISO15693ErrorCode PN5180ISO15693::issueISO15693Command(uint8_t *cmd, uint8_t cmdLen, uint8_t **resultPtr) {
#ifdef DEBUG
PN5180DEBUG(F("Issue Command 0x"));
PN5180DEBUG(formatHex(cmd[1]));
PN5180DEBUG("...\n");
#endif
sendData(cmd, cmdLen);
delay(10);
uint32_t status = getIRQStatus();
if (0 == (status & RX_SOF_DET_IRQ_STAT)) {
return EC_NO_CARD;
}
while (0 == (status & RX_IRQ_STAT)) {
delay(10);
status = getIRQStatus();
}
uint32_t rxStatus;
readRegister(RX_STATUS, &rxStatus);
PN5180DEBUG(F("RX-Status="));
PN5180DEBUG(formatHex(rxStatus));
uint16_t len = (uint16_t)(rxStatus & 0x000001ff);
PN5180DEBUG(", len=");
PN5180DEBUG(len);
PN5180DEBUG("\n");
*resultPtr = readData(len);
if (0L == *resultPtr) {
PN5180DEBUG(F("*** ERROR in readData!\n"));
return ISO15693_EC_UNKNOWN_ERROR;
}
#ifdef DEBUG
Serial.print("Read=");
for (int i=0; i<len; i++) {
Serial.print(formatHex((*resultPtr)[i]));
if (i<len-1) Serial.print(":");
}
Serial.println();
#endif
uint32_t irqStatus = getIRQStatus();
if (0 == (RX_SOF_DET_IRQ_STAT & irqStatus)) { // no card detected
clearIRQStatus(TX_IRQ_STAT | IDLE_IRQ_STAT);
return EC_NO_CARD;
}
uint8_t responseFlags = (*resultPtr)[0];
if (responseFlags & (1<<0)) { // error flag
uint8_t errorCode = (*resultPtr)[1];
PN5180DEBUG("ERROR code=");
PN5180DEBUG(formatHex(errorCode));
PN5180DEBUG(" - ");
PN5180DEBUG(strerror(errorCode));
PN5180DEBUG("\n");
if (errorCode >= 0xA0) { // custom command error codes
return ISO15693_EC_CUSTOM_CMD_ERROR;
}
else return (ISO15693ErrorCode)errorCode;
}
#ifdef DEBUG
if (responseFlags & (1<<3)) { // extendsion flag
PN5180DEBUG("Extension flag is set!\n");
}
#endif
clearIRQStatus(RX_SOF_DET_IRQ_STAT | IDLE_IRQ_STAT | TX_IRQ_STAT | RX_IRQ_STAT);
return ISO15693_EC_OK;
}
bool PN5180ISO15693::setupRF() {
PN5180DEBUG(F("Loading RF-Configuration...\n"));
if (loadRFConfig(0x0d, 0x8d)) { // ISO15693 parameters
PN5180DEBUG(F("done.\n"));
}
else return false;
PN5180DEBUG(F("Turning ON RF field...\n"));
if (setRF_on()) {
PN5180DEBUG(F("done.\n"));
}
else return false;
writeRegisterWithAndMask(SYSTEM_CONFIG, 0xfffffff8); // Idle/StopCom Command
writeRegisterWithOrMask(SYSTEM_CONFIG, 0x00000003); // Transceive Command
return true;
}
const __FlashStringHelper *PN5180ISO15693::strerror(ISO15693ErrorCode errno) {
PN5180DEBUG(F("ISO15693ErrorCode="));
PN5180DEBUG(errno);
PN5180DEBUG("\n");
switch (errno) {
case EC_NO_CARD: return F("No card detected!");
case ISO15693_EC_OK: return F("OK!");
case ISO15693_EC_NOT_SUPPORTED: return F("Command is not supported!");
case ISO15693_EC_NOT_RECOGNIZED: return F("Command is not recognized!");
case ISO15693_EC_OPTION_NOT_SUPPORTED: return F("Option is not supported!");
case ISO15693_EC_UNKNOWN_ERROR: return F("Unknown error!");
case ISO15693_EC_BLOCK_NOT_AVAILABLE: return F("Specified block is not available!");
case ISO15693_EC_BLOCK_ALREADY_LOCKED: return F("Specified block is already locked!");
case ISO15693_EC_BLOCK_IS_LOCKED: return F("Specified block is locked and cannot be changed!");
case ISO15693_EC_BLOCK_NOT_PROGRAMMED: return F("Specified block was not successfully programmed!");
case ISO15693_EC_BLOCK_NOT_LOCKED: return F("Specified block was not successfully locked!");
default:
if ((errno >= 0xA0) && (errno <= 0xDF)) {
return F("Custom command error code!");
}
else return F("Undefined error code in ISO15693!");
}
}