1 /* ISO 14443-4 (T=CL) implementation, PCD side.
3 * (C) 2005-2006 by Harald Welte <laforge@gnumonks.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2
10 * as published by the Free Software Foundation
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 #include <librfid/rfid.h>
29 #include <librfid/rfid_protocol_tcl.h>
30 #include <librfid/rfid_protocol.h>
31 #include <librfid/rfid_layer2.h>
32 #include <librfid/rfid_layer2_iso14443b.h>
34 #include <librfid/rfid_asic.h>
35 #include <librfid/rfid_reader.h>
37 #include "rfid_iso14443_common.h"
39 #define RFID_MAX_FRAMELEN 256
41 #define is_s_block(x) ((x & 0xc0) == 0xc0)
42 #define is_r_block(x) ((x & 0xc0) == 0x80)
43 #define is_i_block(x) ((x & 0xc0) == 0x00)
45 static enum rfid_frametype l2_to_frame(unsigned int layer2)
48 case RFID_LAYER2_ISO14443A:
49 return RFID_14443A_FRAME_REGULAR;
51 case RFID_LAYER2_ISO14443B:
52 return RFID_14443B_FRAME_REGULAR;
58 static unsigned int sfgi_to_sfgt(struct rfid_protocol_handle *h,
61 unsigned int multiplier;
67 multiplier = 1 << sfgi; /* 2 to the power of sfgi */
69 /* ISO 14443-4:2000(E) Section 5.2.5:
70 * (256 * 16 / h->l2h->rh->ah->fc) * (2 ^ sfgi) */
71 tmp = (unsigned int) 1000000 * 256 * 16;
73 return (tmp / h->l2h->rh->ah->fc) * multiplier;
76 static unsigned int fwi_to_fwt(struct rfid_protocol_handle *h,
79 unsigned int multiplier, tmp;
84 multiplier = 1 << fwi; /* 2 to the power of fwi */
86 /* ISO 14443-4:2000(E) Section 7.2.:
87 * (256*16 / h->l2h->rh->ah->fc) * (2 ^ fwi) */
89 tmp = (unsigned int) 1000000 * 256 * 16;
91 return (tmp / h->l2h->rh->ah->fc) * multiplier;
94 /* 4.9seconds as microseconds (4.9 billion seconds) exceeds 2^32 */
95 #define activation_fwt(x) (((u_int64_t)1000000 * 65536 / x->l2h->rh->ah->fc))
96 #define deactivation_fwt(x) activation_fwt(x)
99 tcl_parse_ats(struct rfid_protocol_handle *h,
100 unsigned char *ats, unsigned int size)
102 unsigned char len = ats[0];
106 if (len == 0 || size == 0)
115 /* FIXME: assume some default values */
116 h->priv.tcl.fsc = 32;
117 h->priv.tcl.ta = 0x80; /* 0x80 (same d for both dirs) */
118 h->priv.tcl.sfgt = sfgi_to_sfgt(h, 0);
119 if (h->l2h->l2->id == RFID_LAYER2_ISO14443A) {
120 /* Section 7.2: fwi default for type A is 4 */
121 h->priv.tcl.fwt = fwi_to_fwt(h, 4);
123 /* Section 7.2: fwi for type B is always in ATQB */
124 /* Value is assigned in tcl_connect() */
125 /* This function is never called for Type B,
126 * since Type B has no (R)ATS */
131 /* guarateed to be at least 2 bytes in size */
136 iso14443_fsdi_to_fsd(&h->priv.tcl.fsc, t0 & 0x0f);
137 if (h->priv.tcl.fsc > h->l2h->rh->ah->mtu)
138 h->priv.tcl.fsc = h->l2h->rh->ah->mtu;
141 /* TA is transmitted */
142 h->priv.tcl.ta = *cur++;
146 /* TB is transmitted */
147 h->priv.tcl.sfgt = sfgi_to_sfgt(h, *cur & 0x0f);
148 h->priv.tcl.fwt = fwi_to_fwt(h, (*cur & 0xf0) >> 4);
153 /* TC is transmitted */
155 h->priv.tcl.flags |= TCL_HANDLE_F_NAD_SUPPORTED;
156 DEBUGP("This PICC supports NAD\n");
159 h->priv.tcl.flags |= TCL_HANDLE_F_CID_SUPPORTED;
160 DEBUGP("This PICC supports CID\n");
165 h->priv.tcl.historical_len = (ats+len) - cur;
166 h->priv.tcl.historical_bytes = cur;
172 /* request an ATS from the PICC */
174 tcl_request_ats(struct rfid_protocol_handle *h)
177 unsigned char rats[2];
180 if (h->priv.tcl.state != TCL_STATE_INITIAL)
183 ret = iso14443_fsd_to_fsdi(&fsdi, h->priv.tcl.fsd);
185 DEBUGP("unable to encode FSD of %u as FSDI\n", h->priv.tcl.fsd);
190 rats[1] = (h->priv.tcl.cid & 0x0f) | ((fsdi << 4) & 0xf0);
192 /* transceive (with CRC) */
193 ret = rfid_layer2_transceive(h->l2h, RFID_14443A_FRAME_REGULAR,
194 rats, 2, h->priv.tcl.ats,
195 &h->priv.tcl.ats_len, activation_fwt(h),
196 TCL_TRANSP_F_TX_CRC);
198 DEBUGP("transceive of rats failed\n");
199 h->priv.tcl.state = TCL_STATE_RATS_SENT;
200 /* FIXME: retransmit */
203 h->priv.tcl.state = TCL_STATE_ATS_RCVD;
205 ret = tcl_parse_ats(h, h->priv.tcl.ats, h->priv.tcl.ats_len);
207 DEBUGP("parsing of ats failed\n");
214 #define ATS_TA_DIV_2 1
215 #define ATS_TA_DIV_4 2
216 #define ATS_TA_DIV_8 4
222 static unsigned char d_to_di(struct rfid_protocol_handle *h, unsigned char D)
225 unsigned int speed = h->l2h->rh->reader->iso14443a.speed;
227 if ((D & ATS_TA_DIV_8) && (speed & RFID_14443A_SPEED_848K))
229 else if ((D & ATS_TA_DIV_4) && (speed & RFID_14443A_SPEED_424K))
231 else if ((D & ATS_TA_DIV_2) && (speed & RFID_14443A_SPEED_212K))
239 static unsigned int di_to_speed(unsigned char DI)
243 return RFID_14443A_SPEED_848K;
246 return RFID_14443A_SPEED_424K;
249 return RFID_14443A_SPEED_212K;
252 return RFID_14443A_SPEED_106K;
257 /* start a PPS run (autimatically configure highest possible speed */
259 tcl_do_pps(struct rfid_protocol_handle *h)
262 unsigned char ppss[3];
263 /* FIXME: this stinks like hell. IF we reduce pps_response size to one,
264 we'll get stack corruption! */
265 unsigned char pps_response[10];
266 unsigned int rx_len = 1;
267 unsigned char Dr, Ds, DrI, DsI;
270 if (h->priv.tcl.state != TCL_STATE_ATS_RCVD)
273 Dr = h->priv.tcl.ta & 0x07;
274 Ds = h->priv.tcl.ta & 0x70 >> 4;
275 DEBUGP("Dr = 0x%x, Ds = 0x%x\n", Dr, Ds);
277 if (Dr != Ds && !(h->priv.tcl.ta & 0x80)) {
278 /* device supports different divisors for rx and tx, but not
280 DEBUGP("PICC has contradictory TA, aborting PPS\n");
284 /* ISO 14443-4:2000(E) Section 5.3. */
286 ppss[0] = 0xd0 | (h->priv.tcl.cid & 0x0f);
290 /* FIXME: deal with different speed for each direction */
291 DrI = d_to_di(h, Dr);
292 DsI = d_to_di(h, Ds);
293 DEBUGP("DrI = 0x%x, DsI = 0x%x\n", DrI, DsI);
295 ppss[2] = (ppss[2] & 0xf0) | (DrI | DsI << 2);
297 ret = rfid_layer2_transceive(h->l2h, RFID_14443A_FRAME_REGULAR,
298 ppss, 3, pps_response, &rx_len,
299 h->priv.tcl.fwt, TCL_TRANSP_F_TX_CRC);
303 if (pps_response[0] != ppss[0]) {
304 DEBUGP("PPS Response != PPSS\n");
308 speed = di_to_speed(DrI);
310 ret = rfid_layer2_setopt(h->l2h, RFID_OPT_14443A_SPEED_RX,
311 &speed, sizeof(speed));
315 ret = rfid_layer2_setopt(h->l2h, RFID_OPT_14443A_SPEED_TX,
316 &speed, sizeof(speed));
325 tcl_build_prologue2(struct tcl_handle *th,
326 unsigned char *prlg, unsigned int *prlg_len,
333 if (!is_s_block(pcb)) {
335 /* we've sent a toggle bit last time */
338 /* we've not sent a toggle last time: send one */
344 if (th->flags & TCL_HANDLE_F_CID_USED) {
345 /* ISO 14443-4:2000(E) Section 7.1.1.2 */
346 *prlg |= TCL_PCB_CID_FOLLOWING;
348 prlg[*prlg_len] = th->cid & 0x0f;
351 /* nad only for I-block */
352 if ((th->flags & TCL_HANDLE_F_NAD_USED) && is_i_block(pcb)) {
353 /* ISO 14443-4:2000(E) Section 7.1.1.3 */
354 /* FIXME: in case of chaining only for first frame */
355 *prlg |= TCL_PCB_NAD_FOLLOWING;
356 prlg[*prlg_len] = th->nad;
364 tcl_build_prologue_i(struct tcl_handle *th,
365 unsigned char *prlg, unsigned int *prlg_len)
367 /* ISO 14443-4:2000(E) Section 7.1.1.1 */
368 return tcl_build_prologue2(th, prlg, prlg_len, 0x02);
372 tcl_build_prologue_r(struct tcl_handle *th,
373 unsigned char *prlg, unsigned int *prlg_len,
376 unsigned char pcb = 0xa2;
377 /* ISO 14443-4:2000(E) Section 7.1.1.1 */
382 return tcl_build_prologue2(th, prlg, prlg_len, pcb);
386 tcl_build_prologue_s(struct tcl_handle *th,
387 unsigned char *prlg, unsigned int *prlg_len)
389 /* ISO 14443-4:2000(E) Section 7.1.1.1 */
391 /* the only S-block from PCD->PICC is DESELECT,
392 * well, actually there is the S(WTX) response. */
393 return tcl_build_prologue2(th, prlg, prlg_len, 0xc2);
396 /* FIXME: WTXM implementation */
398 static int tcl_prlg_len(struct tcl_handle *th)
402 if (th->flags & TCL_HANDLE_F_CID_USED)
405 if (th->flags & TCL_HANDLE_F_NAD_USED)
411 #define max_net_tx_framesize(x) (x->fsc - tcl_prlg_len(x))
414 tcl_connect(struct rfid_protocol_handle *h)
418 if (h->priv.tcl.state != TCL_STATE_DESELECTED &&
419 h->priv.tcl.state != TCL_STATE_INITIAL)
422 switch (h->l2h->l2->id) {
423 case RFID_LAYER2_ISO14443A:
424 /* Start Type A T=CL Activation Sequence */
425 ret = tcl_request_ats(h);
429 /* Only do PPS if any non-default divisors supported */
430 if (h->priv.tcl.ta & 0x77) {
436 case RFID_LAYER2_ISO14443B:
437 /* initialized T=CL state from Type B Activation Data */
438 h->priv.tcl.cid = h->l2h->priv.iso14443b.cid;
439 h->priv.tcl.fsc = h->l2h->priv.iso14443b.fsc;
440 h->priv.tcl.fsd = h->l2h->priv.iso14443b.fsd;
441 h->priv.tcl.fwt = h->l2h->priv.iso14443b.fwt;
443 /* what about ta? sfgt? */
445 if (h->l2h->priv.iso14443b.flags & ISO14443B_CID_SUPPORTED)
446 h->priv.tcl.flags |= TCL_HANDLE_F_CID_SUPPORTED;
447 if (h->l2h->priv.iso14443b.flags & ISO14443B_NAD_SUPPORTED)
448 h->priv.tcl.flags |= TCL_HANDLE_F_NAD_SUPPORTED;
450 switch (h->l2h->priv.iso14443b.state) {
451 case ISO14443B_STATE_SELECTED:
452 h->priv.tcl.state = TCL_STATE_ATS_RCVD;
454 case ISO14443B_STATE_ATTRIB_SENT:
455 h->priv.tcl.state = TCL_STATE_RATS_SENT;
459 /* PUPI will be presented as ATS/historical bytes */
460 memcpy(h->priv.tcl.ats, h->l2h->uid, 4);
461 h->priv.tcl.ats_len = 4;
462 h->priv.tcl.historical_bytes = h->priv.tcl.ats;
466 DEBUGP("unsupported l2: %u\n", h->l2h->l2->id);
471 h->priv.tcl.state = TCL_STATE_ESTABLISHED;
477 tcl_deselect(struct rfid_protocol_handle *h)
479 /* ISO 14443-4:2000(E) Section 8 */
481 unsigned char frame[3]; /* 3 bytes prologue, no information */
483 unsigned int rx_len = sizeof(rx);
484 unsigned int prlg_len;
485 struct tcl_handle *th = &h->priv.tcl;
487 if (th->state != TCL_STATE_ESTABLISHED) {
488 /* FIXME: not sure whether deselect is possible here,
489 * probably better send a HLTA? */
492 /* build DESELECT S-block */
493 ret = tcl_build_prologue_s(th, frame, &prlg_len);
497 ret = rfid_layer2_transceive(h->l2h, RFID_14443A_FRAME_REGULAR,
499 &rx_len, deactivation_fwt(h),
500 TCL_TRANSP_F_TX_CRC);
502 /* FIXME: retransmit, HLT(A|B) */
506 th->state = TCL_STATE_DESELECTED;
512 unsigned int frame_len; /* length of frame */
513 unsigned int hdr_len; /* length of header within frame */
514 unsigned char data[RFID_MAX_FRAMELEN];
517 #define frb_payload(x) (x.data + x.hdr_len)
520 /* RFID transceive buffer. */
522 struct rfix_xcvb *next; /* next in queue of buffers */
524 u_int64_t timeout; /* timeout to wait for reply */
528 //struct rfid_protocol_handle *h; /* connection to which we belong */
531 struct tcl_tx_context {
532 const unsigned char *tx;
534 const unsigned char *next_tx_byte;
535 unsigned char *next_rx_byte;
538 struct rfid_protocol_handle *h;
541 #define tcl_ctx_todo(ctx) (ctx->tx_len - (ctx->next_tx_byte - ctx->tx))
544 tcl_refill_xcvb(struct rfid_xcvb *xcvb, struct tcl_tx_context *ctx)
546 struct tcl_handle *th = &ctx->h->priv.tcl;
548 if (ctx->next_tx_byte >= ctx->tx + ctx->tx_len) {
549 DEBUGP("tyring to refill tx xcvb but no data left!\n");
553 if (tcl_build_prologue_i(th, xcvb->tx.data,
554 &xcvb->tx.hdr_len) < 0)
557 if (tcl_ctx_todo(ctx) > th->fsc - xcvb->tx.hdr_len)
558 xcvb->tx.frame_len = max_net_tx_framesize(th);
560 xcvb->tx.frame_len = tcl_ctx_todo(ctx);
562 memcpy(frb_payload(xcvb->tx), ctx->next_tx_byte,
565 ctx->next_tx_byte += xcvb->tx.frame_len;
567 /* check whether we need to set the chaining bit */
568 if (ctx->next_tx_byte < ctx->tx + ctx->tx_len)
569 xcvb->tx.data[0] |= 0x10;
571 /* add hdr_len after copying the net payload */
572 xcvb->tx.frame_len += xcvb->tx.hdr_len;
574 xcvb->timeout = th->fwt;
579 static void fill_xcvb_wtxm(struct tcl_handle *th, struct rfid_xcvb *xcvb,
582 /* Acknowledge WTXM */
583 tcl_build_prologue_s(th, xcvb->tx.data, &xcvb->tx.hdr_len);
584 /* set two bits that make this block a wtx */
585 xcvb->tx.data[0] |= 0x30;
586 xcvb->tx.data[xcvb->tx.hdr_len] = inf;
587 xcvb->tx.frame_len = xcvb->tx.hdr_len+1;
588 xcvb->timeout = th->fwt * inf;
591 static int check_cid(struct tcl_handle *th, struct rfid_xcvb *xcvb)
593 if (xcvb->rx.data[0] & TCL_PCB_CID_FOLLOWING) {
594 if (xcvb->rx.data[1] != th->cid) {
595 DEBUGP("CID %u is not valid, we expected %u\n",
596 xcvb->rx.data[1], th->cid);
604 tcl_transceive(struct rfid_protocol_handle *h,
605 const unsigned char *tx_data, unsigned int tx_len,
606 unsigned char *rx_data, unsigned int *rx_len,
607 unsigned int timeout, unsigned int flags)
611 struct rfid_xcvb xcvb;
612 struct tcl_tx_context tcl_ctx;
613 struct tcl_handle *th = &h->priv.tcl;
615 unsigned char ack[10];
616 unsigned int ack_len;
618 /* initialize context */
619 tcl_ctx.next_tx_byte = tcl_ctx.tx = tx_data;
620 tcl_ctx.next_rx_byte = tcl_ctx.rx = rx_data;
621 tcl_ctx.rx_len = *rx_len;
622 tcl_ctx.tx_len = tx_len;
625 /* initialize xcvb */
626 xcvb.timeout = th->fwt;
629 if (tcl_refill_xcvb(&xcvb, &tcl_ctx) < 0) {
635 xcvb.rx.frame_len = sizeof(xcvb.rx.data);
636 ret = rfid_layer2_transceive(h->l2h, l2_to_frame(h->l2h->l2->id),
637 xcvb.tx.data, xcvb.tx.frame_len,
638 xcvb.rx.data, &xcvb.rx.frame_len,
641 DEBUGP("l2 transceive finished\n");
645 if (is_r_block(xcvb.rx.data[0])) {
648 if ((xcvb.rx.data[0] & 0x01) != h->priv.tcl.toggle) {
649 DEBUGP("response with wrong toggle bit\n");
653 /* Handle ACK frame in case of chaining */
654 if (!check_cid(th, &xcvb))
658 } else if (is_s_block(xcvb.rx.data[0])) {
660 unsigned int prlg_len;
663 /* Handle Wait Time Extension */
665 if (!check_cid(th, &xcvb))
668 if (xcvb.rx.data[0] & TCL_PCB_CID_FOLLOWING) {
669 if (xcvb.rx.frame_len < 3) {
670 DEBUGP("S-Block with CID but short len\n");
674 inf = xcvb.rx.data[2];
676 inf = xcvb.rx.data[1];
678 if ((xcvb.rx.data[0] & 0x30) != 0x30) {
679 DEBUGP("S-Block but not WTX?\n");
683 inf &= 0x3f; /* only lower 6 bits code WTXM */
684 if (inf == 0 || (inf >= 60 && inf <= 63)) {
685 DEBUGP("WTXM %u is RFU!\n", inf);
690 fill_xcvb_wtxm(th, &xcvb, inf);
691 /* start over with next transceive */
693 } else if (is_i_block(xcvb.rx.data[0])) {
694 unsigned int net_payload_len;
695 /* we're actually receiving payload data */
699 if ((xcvb.rx.data[0] & 0x01) != h->priv.tcl.toggle) {
700 DEBUGP("response with wrong toggle bit\n");
706 if (!check_cid(th, &xcvb))
709 if (xcvb.rx.data[0] & TCL_PCB_CID_FOLLOWING)
711 if (xcvb.rx.data[0] & TCL_PCB_NAD_FOLLOWING)
714 net_payload_len = xcvb.rx.frame_len - xcvb.rx.hdr_len;
715 DEBUGPC("%u bytes\n", net_payload_len);
716 memcpy(tcl_ctx.next_rx_byte, &xcvb.rx.data[xcvb.rx.hdr_len],
718 tcl_ctx.next_rx_byte += net_payload_len;
720 if (xcvb.rx.data[0] & 0x10) {
721 /* we're not the last frame in the chain, continue rx */
722 DEBUGP("not the last frame in the chain, continue\n");
723 ack_len = sizeof(ack);
724 tcl_build_prologue_r(th, xcvb.tx.data, &xcvb.tx.frame_len, 0);
725 xcvb.timeout = th->fwt;
731 *rx_len = tcl_ctx.next_rx_byte - tcl_ctx.rx;
735 static struct rfid_protocol_handle *
736 tcl_init(struct rfid_layer2_handle *l2h)
738 struct rfid_protocol_handle *th;
739 unsigned int mru = l2h->rh->ah->mru;
741 th = malloc_protocol_handle(sizeof(struct rfid_protocol_handle));
745 /* FIXME: mru should be attribute of layer2 (in case it adds/removes
747 memset(th, 0, sizeof(struct rfid_protocol_handle));
749 /* maximum received ats length equals mru of asic/reader */
750 th->priv.tcl.state = TCL_STATE_INITIAL;
751 th->priv.tcl.ats_len = mru;
752 th->priv.tcl.toggle = 1;
754 th->priv.tcl.fsd = iso14443_fsd_approx(mru);
760 tcl_fini(struct rfid_protocol_handle *ph)
762 free_protocol_handle(ph);
767 tcl_getopt(struct rfid_protocol_handle *h, int optname, void *optval,
768 unsigned int *optlen)
770 u_int8_t *opt_str = optval;
773 case RFID_OPT_P_TCL_ATS:
774 if (h->priv.tcl.ats_len < *optlen)
775 *optlen = h->priv.tcl.ats_len;
776 memcpy(opt_str, h->priv.tcl.ats, *optlen);
778 case RFID_OPT_P_TCL_ATS_LEN:
779 if (*optlen < sizeof(u_int8_t))
781 *optlen = sizeof(u_int8_t);
782 *opt_str = h->priv.tcl.ats_len & 0xff;
790 tcl_setopt(struct rfid_protocol_handle *h, int optname, const void *optval,
803 const struct rfid_protocol rfid_protocol_tcl = {
804 .id = RFID_PROTOCOL_TCL,
805 .name = "ISO 14443-4 / T=CL",
808 .open = &tcl_connect,
809 .transceive = &tcl_transceive,
810 .close = &tcl_deselect,
812 .getopt = &tcl_getopt,
813 .setopt = &tcl_setopt,