1 /* ISO 14443-4 (T=CL) implementation, PCD side.
3 * (C) 2005 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 static enum rfid_frametype l2_to_frame(unsigned int layer2)
42 case RFID_LAYER2_ISO14443A:
43 return RFID_14443A_FRAME_REGULAR;
45 case RFID_LAYER2_ISO14443B:
46 return RFID_14443B_FRAME_REGULAR;
52 static unsigned int sfgi_to_sfgt(struct rfid_protocol_handle *h,
55 unsigned int multiplier;
61 multiplier = 1 << sfgi; /* 2 to the power of sfgi */
63 /* ISO 14443-4:2000(E) Section 5.2.5:
64 * (256 * 16 / h->l2h->rh->ah->fc) * (2 ^ sfgi) */
65 tmp = (unsigned int) 1000000 * 256 * 16;
67 return (tmp / h->l2h->rh->ah->fc) * multiplier;
70 static unsigned int fwi_to_fwt(struct rfid_protocol_handle *h,
73 unsigned int multiplier, tmp;
78 multiplier = 1 << fwi; /* 2 to the power of fwi */
80 /* ISO 14443-4:2000(E) Section 7.2.:
81 * (256*16 / h->l2h->rh->ah->fc) * (2 ^ fwi) */
83 tmp = (unsigned int) 1000000 * 256 * 16;
85 return (tmp / h->l2h->rh->ah->fc) * multiplier;
88 /* 4.9seconds as microseconds (4.9 billion seconds) exceeds 2^32 */
89 #define activation_fwt(x) (((u_int64_t)1000000 * 65536 / x->l2h->rh->ah->fc))
90 #define deactivation_fwt(x) activation_fwt(x)
93 tcl_parse_ats(struct rfid_protocol_handle *h,
94 unsigned char *ats, unsigned int size)
96 unsigned char len = ats[0];
100 if (len == 0 || size == 0)
109 /* FIXME: assume some default values */
110 h->priv.tcl.fsc = 32;
111 h->priv.tcl.ta = 0x80; /* 0x80 (same d for both dirs) */
112 h->priv.tcl.sfgt = sfgi_to_sfgt(h, 0);
113 if (h->l2h->l2->id == RFID_LAYER2_ISO14443A) {
114 /* Section 7.2: fwi default for type A is 4 */
115 h->priv.tcl.fwt = fwi_to_fwt(h, 4);
117 /* Section 7.2: fwi for type B is always in ATQB */
118 /* Value is assigned in tcl_connect() */
119 /* This function is never called for Type B, since it has no (R)ATS */
124 /* guarateed to be at least 2 bytes in size */
129 iso14443_fsdi_to_fsd(&h->priv.tcl.fsc, t0 & 0x0f);
132 /* TA is transmitted */
133 h->priv.tcl.ta = *cur++;
137 /* TB is transmitted */
138 h->priv.tcl.sfgt = sfgi_to_sfgt(h, *cur & 0x0f);
139 h->priv.tcl.fwt = fwi_to_fwt(h, (*cur & 0xf0) >> 4);
144 /* TC is transmitted */
146 h->priv.tcl.flags |= TCL_HANDLE_F_NAD_SUPPORTED;
148 h->priv.tcl.flags |= TCL_HANDLE_F_CID_SUPPORTED;
152 h->priv.tcl.historical_len = (ats+len) - cur;
153 h->priv.tcl.historical_bytes = cur;
159 /* request an ATS from the PICC */
161 tcl_request_ats(struct rfid_protocol_handle *h)
164 unsigned char rats[2];
167 if (h->priv.tcl.state != TCL_STATE_INITIAL)
170 ret = iso14443_fsd_to_fsdi(&fsdi, h->priv.tcl.fsd);
172 DEBUGP("unable to encode FSD of %u as FSDI\n", h->priv.tcl.fsd);
177 rats[1] = (h->priv.tcl.cid & 0x0f) | ((fsdi << 4) & 0xf0);
179 /* transcieve (with CRC) */
180 ret = rfid_layer2_transcieve(h->l2h, RFID_14443A_FRAME_REGULAR,
181 rats, 2, h->priv.tcl.ats,
182 &h->priv.tcl.ats_len, activation_fwt(h),
183 TCL_TRANSP_F_TX_CRC);
185 DEBUGP("transcieve of rats failed\n");
186 h->priv.tcl.state = TCL_STATE_RATS_SENT;
187 /* FIXME: retransmit */
190 h->priv.tcl.state = TCL_STATE_ATS_RCVD;
192 ret = tcl_parse_ats(h, h->priv.tcl.ats, h->priv.tcl.ats_len);
194 DEBUGP("parsing of ats failed\n");
201 #define ATS_TA_DIV_2 1
202 #define ATS_TA_DIV_4 2
203 #define ATS_TA_DIV_8 4
209 static unsigned char d_to_di(struct rfid_protocol_handle *h, unsigned char D)
212 unsigned int speed = h->l2h->rh->reader->iso14443a.speed;
214 if ((D & ATS_TA_DIV_8) && (speed & RFID_14443A_SPEED_848K))
216 else if ((D & ATS_TA_DIV_4) && (speed & RFID_14443A_SPEED_424K))
218 else if ((D & ATS_TA_DIV_2) && (speed & RFID_14443A_SPEED_212K))
226 static unsigned int di_to_speed(unsigned char DI)
230 return RFID_14443A_SPEED_848K;
233 return RFID_14443A_SPEED_424K;
236 return RFID_14443A_SPEED_212K;
239 return RFID_14443A_SPEED_106K;
244 /* start a PPS run (autimatically configure highest possible speed */
246 tcl_do_pps(struct rfid_protocol_handle *h)
249 unsigned char ppss[3];
250 unsigned char pps_response[1];
251 unsigned int rx_len = 1;
252 unsigned char Dr, Ds, DrI, DsI;
255 if (h->priv.tcl.state != TCL_STATE_ATS_RCVD)
258 Dr = h->priv.tcl.ta & 0x07;
259 Ds = h->priv.tcl.ta & 0x70 >> 4;
260 DEBUGP("Dr = 0x%x, Ds = 0x%x\n", Dr, Ds);
262 if (Dr != Ds && !(h->priv.tcl.ta & 0x80)) {
263 /* device supports different divisors for rx and tx, but not
265 DEBUGP("PICC has contradictory TA, aborting PPS\n");
269 /* ISO 14443-4:2000(E) Section 5.3. */
271 ppss[0] = 0xd0 | (h->priv.tcl.cid & 0x0f);
275 /* FIXME: deal with different speed for each direction */
276 DrI = d_to_di(h, Dr);
277 DsI = d_to_di(h, Ds);
278 DEBUGP("DrI = 0x%x, DsI = 0x%x\n", DrI, DsI);
280 ppss[2] = (ppss[2] & 0xf0) | (DrI | DsI << 2);
282 ret = rfid_layer2_transcieve(h->l2h, RFID_14443A_FRAME_REGULAR,
283 ppss, 3, pps_response, &rx_len,
284 h->priv.tcl.fwt, TCL_TRANSP_F_TX_CRC);
288 if (pps_response[0] != ppss[0]) {
289 DEBUGP("PPS Response != PPSS\n");
293 speed = di_to_speed(DrI);
295 ret = rfid_layer2_setopt(h->l2h, RFID_OPT_14443A_SPEED_RX,
296 &speed, sizeof(speed));
300 ret = rfid_layer2_setopt(h->l2h, RFID_OPT_14443A_SPEED_TX,
301 &speed, sizeof(speed));
310 tcl_build_prologue2(struct tcl_handle *th,
311 unsigned char *prlg, unsigned int *prlg_len,
319 /* we've sent a toggle bit last time */
322 /* we've not sent a toggle last time: send one */
327 if (th->flags & TCL_HANDLE_F_CID_USED) {
328 /* ISO 14443-4:2000(E) Section 7.1.1.2 */
329 *prlg |= TCL_PCB_CID_FOLLOWING;
331 prlg[*prlg_len] = th->cid & 0x0f;
334 /* nad only for I-block (0xc0 == 00) */
335 if ((th->flags & TCL_HANDLE_F_NAD_USED) &&
336 ((pcb & 0xc0) == 0x00)) {
337 /* ISO 14443-4:2000(E) Section 7.1.1.3 */
338 /* FIXME: in case of chaining only for first frame */
339 *prlg |= TCL_PCB_NAD_FOLLOWING;
340 prlg[*prlg_len] = th->nad;
348 tcl_build_prologue_i(struct tcl_handle *th,
349 unsigned char *prlg, unsigned int *prlg_len)
351 /* ISO 14443-4:2000(E) Section 7.1.1.1 */
352 return tcl_build_prologue2(th, prlg, prlg_len, 0x02);
356 tcl_build_prologue_r(struct tcl_handle *th,
357 unsigned char *prlg, unsigned int *prlg_len,
360 unsigned char pcb = 0xa2;
361 /* ISO 14443-4:2000(E) Section 7.1.1.1 */
366 return tcl_build_prologue2(th, prlg, prlg_len, pcb);
370 tcl_build_prologue_s(struct tcl_handle *th,
371 unsigned char *prlg, unsigned int *prlg_len)
373 /* ISO 14443-4:2000(E) Section 7.1.1.1 */
375 /* the only S-block from PCD->PICC is DESELECT,
376 * well, actually there is the S(WTX) response. */
377 return tcl_build_prologue2(th, prlg, prlg_len, 0xc2);
380 /* FIXME: WTXM implementation */
382 static int tcl_prlg_len(struct tcl_handle *th)
386 if (th->flags & TCL_HANDLE_F_CID_USED)
389 if (th->flags & TCL_HANDLE_F_NAD_USED)
395 #define max_net_tx_framesize(x) (x->fsc - tcl_prlg_len(x))
398 tcl_connect(struct rfid_protocol_handle *h)
402 if (h->priv.tcl.state != TCL_STATE_DESELECTED &&
403 h->priv.tcl.state != TCL_STATE_INITIAL)
406 switch (h->l2h->l2->id) {
407 case RFID_LAYER2_ISO14443A:
408 /* Start Type A T=CL Activation Sequence */
409 ret = tcl_request_ats(h);
413 /* Only do PPS if any non-default divisors supported */
414 if (h->priv.tcl.ta & 0x77) {
420 case RFID_LAYER2_ISO14443B:
421 /* initialized T=CL state from Type B Activation Data */
422 h->priv.tcl.cid = h->l2h->priv.iso14443b.cid;
423 h->priv.tcl.fsc = h->l2h->priv.iso14443b.fsc;
424 h->priv.tcl.fsd = h->l2h->priv.iso14443b.fsd;
425 h->priv.tcl.fwt = h->l2h->priv.iso14443b.fwt;
427 /* what about ta? sfgt? */
429 if (h->l2h->priv.iso14443b.flags & ISO14443B_CID_SUPPORTED)
430 h->priv.tcl.flags |= TCL_HANDLE_F_CID_SUPPORTED;
431 if (h->l2h->priv.iso14443b.flags & ISO14443B_NAD_SUPPORTED)
432 h->priv.tcl.flags |= TCL_HANDLE_F_NAD_SUPPORTED;
434 switch (h->l2h->priv.iso14443b.state) {
435 case ISO14443B_STATE_SELECTED:
436 h->priv.tcl.state = TCL_STATE_ATS_RCVD;
438 case ISO14443B_STATE_ATTRIB_SENT:
439 h->priv.tcl.state = TCL_STATE_RATS_SENT;
443 /* PUPI will be presented as ATS/historical bytes */
444 memcpy(h->priv.tcl.ats, h->l2h->uid, 4);
445 h->priv.tcl.ats_len = 4;
446 h->priv.tcl.historical_bytes = h->priv.tcl.ats;
450 DEBUGP("unsupported l2: %u\n", h->l2h->l2->id);
455 h->priv.tcl.state = TCL_STATE_ESTABLISHED;
461 tcl_deselect(struct rfid_protocol_handle *h)
463 /* ISO 14443-4:2000(E) Section 8 */
465 unsigned char frame[3]; /* 3 bytes prologue, no information */
467 unsigned int rx_len = sizeof(rx);
468 unsigned int prlg_len;
469 struct tcl_handle *th = &h->priv.tcl;
471 if (th->state != TCL_STATE_ESTABLISHED) {
472 /* FIXME: not sure whether deselect is possible here,
473 * probably better send a HLTA? */
476 /* build DESELECT S-block */
477 ret = tcl_build_prologue_s(th, frame, &prlg_len);
481 ret = rfid_layer2_transcieve(h->l2h, RFID_14443A_FRAME_REGULAR,
483 &rx_len, deactivation_fwt(h),
484 TCL_TRANSP_F_TX_CRC);
486 /* FIXME: retransmit, HLT(A|B) */
490 th->state = TCL_STATE_DESELECTED;
495 #define is_s_block(x) ((x & 0xc0) == 0xc0)
496 #define is_r_block(x) ((x & 0xc0) == 0x80)
497 #define is_i_block(x) ((x & 0xc0) == 0x00)
500 tcl_transcieve(struct rfid_protocol_handle *h,
501 const unsigned char *tx_data, unsigned int tx_len,
502 unsigned char *rx_data, unsigned int *rx_len,
503 unsigned int timeout, unsigned int flags)
506 unsigned char *tx_buf, *rx_buf;
507 unsigned char *_rx_data = rx_data;
508 unsigned int _rx_len;
509 unsigned int max_rx_len = *rx_len; /* maximum number of payoload that
510 caller has requested */
511 unsigned int prlg_len;
512 struct tcl_handle *th = &h->priv.tcl;
515 unsigned int _tx_len, _timeout;
516 unsigned char wtx_resp[3];
517 unsigned char ack[10];
518 unsigned int ack_len;
520 if (tx_len > max_net_tx_framesize(th)) {
521 /* slow path: we need to use chaining */
525 tx_buf = malloc(tcl_prlg_len(th) + tx_len);
530 rx_buf = malloc(tcl_prlg_len(th) + *rx_len);
536 if (tcl_build_prologue_i(th, tx_buf, &prlg_len) < 0) {
540 memcpy(tx_buf + prlg_len, tx_data, tx_len);
542 /* intialize to data-to-be-transferred */
544 _tx_len = tx_len+prlg_len;
550 ret = rfid_layer2_transcieve(h->l2h, l2_to_frame(h->l2h->l2->id),
552 rx_buf, &_rx_len, _timeout, 0);
553 DEBUGP("l2 transcieve finished\n");
557 if ((*rx_buf & 0x01) != h->priv.tcl.toggle) {
558 DEBUGP("response with wrong toggle bit\n");
562 if (is_r_block(*rx_buf)) {
563 unsigned int txed = _tx - tx_buf;
565 /* Handle ACK frame in case of chaining */
566 if (*rx_buf & TCL_PCB_CID_FOLLOWING) {
567 if (*(rx_buf+1) != h->priv.tcl.cid) {
568 DEBUGP("CID %u is not valid\n", *(rx_buf)+1);
572 /* set up parameters for next frame in chain */
574 /* move tx pointer by the amount of bytes transferred
577 _tx_len = (tx_len - txed);
578 if (_tx_len > max_net_tx_framesize(th)) {
579 /* not last frame in chain */
580 _tx_len = max_net_tx_framesize(th);
582 /* last frame in chain */
586 DEBUGP("Received ACK in response to last frame in "
587 "chain?!? Expected I-frame.\n");
591 } else if (is_s_block(*rx_buf)) {
593 unsigned int prlg_len;
596 /* Handle Wait Time Extension */
597 if (*rx_buf & TCL_PCB_CID_FOLLOWING) {
599 DEBUGP("S-Block with CID but short len\n");
603 if (*(rx_buf+1) != h->priv.tcl.cid) {
604 DEBUGP("CID %u is not valid\n", *(rx_buf)+1);
611 if ((*rx_buf & 0x30) != 0x30) {
612 DEBUGP("S-Block but not WTX?\n");
616 inf &= 0x3f; /* only lower 6 bits code WTXM */
617 if (inf == 0 || (inf >= 60 && inf <= 63)) {
618 DEBUGP("WTXM %u is RFU!\n", inf);
623 /* Acknowledge WTXM */
624 tcl_build_prologue_s(&h->priv.tcl, wtx_resp, &prlg_len);
625 /* set two bits that make this block a wtx */
627 wtx_resp[prlg_len] = inf;
629 _tx_len = prlg_len+1;
630 _timeout = th->fwt * inf;
632 /* start over with next transcieve */
633 goto do_tx; /* FIXME: do transcieve locally since we use
634 totally different buffer */
636 } else if (is_i_block(*rx_buf)) {
637 unsigned char *inf = rx_buf+1;
638 unsigned int net_payload_len;
639 /* we're actually receiving payload data */
642 if (*rx_buf & TCL_PCB_CID_FOLLOWING) {
643 if (*(rx_buf+1) != h->priv.tcl.cid) {
644 DEBUGPC("CID %u is not valid\n", *(rx_buf)+1);
649 if (*rx_buf & TCL_PCB_NAD_FOLLOWING) {
652 net_payload_len = _rx_len - (inf - rx_buf);
653 DEBUGPC("%u bytes\n", net_payload_len);
654 memcpy(_rx_data, inf, net_payload_len);
655 /* increment the number of payload bytes that we actually
657 *rx_len += net_payload_len;
658 _rx_data += net_payload_len;
660 if (*rx_buf & 0x10) {
661 /* we're not the last frame in the chain, continue rx */
662 DEBUGP("not the last frame in the chain, continue\n");
663 ack_len = sizeof(ack);
664 tcl_build_prologue_r(&h->priv.tcl, ack, &ack_len, 0);
679 static struct rfid_protocol_handle *
680 tcl_init(struct rfid_layer2_handle *l2h)
682 struct rfid_protocol_handle *th;
683 unsigned int mru = l2h->rh->ah->mru;
685 th = malloc(sizeof(struct rfid_protocol_handle) + mru);
689 /* FIXME: mru should be attribute of layer2 (in case it adds/removes
691 memset(th, 0, sizeof(struct rfid_protocol_handle) + mru);
693 /* maximum received ats length equals mru of asic/reader */
694 th->priv.tcl.state = TCL_STATE_INITIAL;
695 th->priv.tcl.ats_len = mru;
696 th->priv.tcl.toggle = 1;
698 th->priv.tcl.fsd = iso14443_fsd_approx(mru);
704 tcl_fini(struct rfid_protocol_handle *ph)
710 struct rfid_protocol rfid_protocol_tcl = {
711 .id = RFID_PROTOCOL_TCL,
712 .name = "ISO 14443-4 / T=CL",
715 .open = &tcl_connect,
716 .transcieve = &tcl_transcieve,
717 .close = &tcl_deselect,