<p>Harald Welte <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/10217">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Jenkins Builder: Verified
Harald Welte: Looks good to me, approved
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">cardem: use TC_ETU to trigger ATR sending<br><br>this changes how ATR is handled.<br>the ATR is also printed when set (as important debug information).<br>the test is also updated to correspond to the new mechanism (<br>simulating the timeout before sending the ATR)<br><br>Change-Id: I69df797e2feadffa9f5f977cb71b69386cee7cd0<br>---<br>M firmware/libcommon/include/card_emu.h<br>M firmware/libcommon/source/card_emu.c<br>M firmware/libcommon/source/mode_cardemu.c<br>M firmware/test/card_emu_tests.c<br>4 files changed, 104 insertions(+), 30 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/firmware/libcommon/include/card_emu.h b/firmware/libcommon/include/card_emu.h</span><br><span>index 7144168..a3c1cf2 100644</span><br><span>--- a/firmware/libcommon/include/card_emu.h</span><br><span>+++ b/firmware/libcommon/include/card_emu.h</span><br><span>@@ -1,6 +1,7 @@</span><br><span> /* ISO7816-3 state machine for the card side</span><br><span> *</span><br><span> * (C) 2010-2017 by Harald Welte <hwelte@hmw-consulting.de></span><br><span style="color: hsl(120, 100%, 40%);">+ * (C) 2018 by sysmocom -s.f.m.c. GmbH, Author: Kevin Redon <kredon@sysmocom.de></span><br><span> *</span><br><span> * This program is free software; you can redistribute it and/or modify</span><br><span> * it under the terms of the GNU General Public License as published by</span><br><span>@@ -54,3 +55,4 @@</span><br><span> int card_emu_uart_tx(uint8_t uart_chan, uint8_t byte);</span><br><span> void card_emu_uart_enable(uint8_t uart_chan, uint8_t rxtx);</span><br><span> void card_emu_uart_wait_tx_idle(uint8_t uart_chan);</span><br><span style="color: hsl(120, 100%, 40%);">+void card_emu_uart_interrupt(uint8_t uart_chan);</span><br><span>diff --git a/firmware/libcommon/source/card_emu.c b/firmware/libcommon/source/card_emu.c</span><br><span>index 25ec36a..51fd923 100644</span><br><span>--- a/firmware/libcommon/source/card_emu.c</span><br><span>+++ b/firmware/libcommon/source/card_emu.c</span><br><span>@@ -1,6 +1,7 @@</span><br><span> /* ISO7816-3 state machine for the card side</span><br><span> *</span><br><span> * (C) 2010-2017 by Harald Welte <laforge@gnumonks.org></span><br><span style="color: hsl(120, 100%, 40%);">+ * (C) 2018 by sysmocom -s.f.m.c. GmbH, Author: Kevin Redon <kredon@sysmocom.de></span><br><span> *</span><br><span> * This program is free software; you can redistribute it and/or modify</span><br><span> * it under the terms of the GNU General Public License as published by</span><br><span>@@ -296,32 +297,39 @@</span><br><span> card_emu_uart_enable(ch->uart_chan, 0);</span><br><span> break;</span><br><span> case ISO_S_WAIT_ATR:</span><br><span style="color: hsl(0, 100%, 40%);">- set_pts_state(ch, PTS_S_WAIT_REQ_PTSS);</span><br><span> /* Reset to initial Fi / Di ratio */</span><br><span> ch->fi = 1;</span><br><span> ch->di = 1;</span><br><span> emu_update_fidi(ch);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* the ATR should only be sent 400 to 40k clock cycles after the RESET.</span><br><span style="color: hsl(120, 100%, 40%);">+ * we use the tc_etu mechanism to wait this time.</span><br><span style="color: hsl(120, 100%, 40%);">+ * since the initial ETU is Fd=372/Dd=1 clock cycles long, we have to wait 2-107 ETU.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+ tc_etu_set_wtime(ch->tc_chan, 2);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* ensure the TC_ETU timer is enabled */</span><br><span style="color: hsl(120, 100%, 40%);">+ tc_etu_enable(ch->tc_chan);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case ISO_S_IN_ATR:</span><br><span> /* initialize to default WI, this will be overwritten if we</span><br><span style="color: hsl(0, 100%, 40%);">- * receive TC2, and it will be programmed into hardware after</span><br><span style="color: hsl(120, 100%, 40%);">+ * send TC2, and it will be programmed into hardware after</span><br><span> * ATR is finished */</span><br><span> ch->wi = ISO7816_3_DEFAULT_WI;</span><br><span> /* update waiting time to initial waiting time */</span><br><span> ch->waiting_time = ISO7816_3_INIT_WTIME;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* set initial waiting time */</span><br><span> tc_etu_set_wtime(ch->tc_chan, ch->waiting_time);</span><br><span> /* Set ATR sub-state to initial state */</span><br><span> ch->atr.idx = 0;</span><br><span style="color: hsl(0, 100%, 40%);">- //set_atr_state(ch, ATR_S_WAIT_TS);</span><br><span style="color: hsl(0, 100%, 40%);">- /* Notice that we are just coming out of reset */</span><br><span style="color: hsl(0, 100%, 40%);">- //ch->sh.flags |= SIMTRACE_FLAG_ATR;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* enable USART transmission to reader */</span><br><span> card_emu_uart_enable(ch->uart_chan, ENABLE_TX);</span><br><span style="color: hsl(0, 100%, 40%);">- break;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* trigger USART TX IRQ to sent first ATR byte TS */</span><br><span style="color: hsl(120, 100%, 40%);">+ card_emu_uart_interrupt(ch->uart_chan);</span><br><span> break;</span><br><span> case ISO_S_WAIT_TPDU:</span><br><span> /* enable the receiver, disable transmitter */</span><br><span> set_tpdu_state(ch, TPDU_S_WAIT_CLA);</span><br><span> card_emu_uart_enable(ch->uart_chan, ENABLE_RX);</span><br><span> break;</span><br><span style="color: hsl(0, 100%, 40%);">- case ISO_S_IN_ATR:</span><br><span> case ISO_S_IN_PTS:</span><br><span> case ISO_S_IN_TPDU:</span><br><span> /* do nothing */</span><br><span>@@ -329,6 +337,47 @@</span><br><span> }</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/**********************************************************************</span><br><span style="color: hsl(120, 100%, 40%);">+ * ATR handling</span><br><span style="color: hsl(120, 100%, 40%);">+ **********************************************************************/</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*! Transmit ATR data to reader</span><br><span style="color: hsl(120, 100%, 40%);">+ * @param[in] ch card interface connected to reader</span><br><span style="color: hsl(120, 100%, 40%);">+ * @return numbers of bytes transmitted</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+static int tx_byte_atr(struct card_handle *ch)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ if (NULL == ch) {</span><br><span style="color: hsl(120, 100%, 40%);">+ TRACE_ERROR("ATR TX: no card handle provided\n\r");</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ if (ISO_S_IN_ATR != ch->state) {</span><br><span style="color: hsl(120, 100%, 40%);">+ TRACE_ERROR("%u: ATR TX: no in ATR state\n\r", ch->num);</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Transmit ATR */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (ch->atr.idx < ch->atr.len) {</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t byte = ch->atr.atr[ch->atr.idx++];</span><br><span style="color: hsl(120, 100%, 40%);">+ card_emu_uart_tx(ch->uart_chan, byte);</span><br><span style="color: hsl(120, 100%, 40%);">+ TRACE_DEBUG("%u: ATR TX: %02x\n\r", ch->num, byte);</span><br><span style="color: hsl(120, 100%, 40%);">+ return 1;</span><br><span style="color: hsl(120, 100%, 40%);">+ } else { /* The ATR has been completely transmitted */</span><br><span style="color: hsl(120, 100%, 40%);">+ /* TODO update WI using optional TC2 and then update WT */</span><br><span style="color: hsl(120, 100%, 40%);">+ //ch->wi = ISO7816_3_DEFAULT_WI;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* update waiting time */</span><br><span style="color: hsl(120, 100%, 40%);">+ //ch->waiting_time = ISO7816_3_INIT_WTIME;</span><br><span style="color: hsl(120, 100%, 40%);">+ //tc_etu_set_wtime(ch->tc_chan, ch->waiting_time);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* reset PTS to initial state */</span><br><span style="color: hsl(120, 100%, 40%);">+ set_pts_state(ch, PTS_S_WAIT_REQ_PTSS);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* go to next state */</span><br><span style="color: hsl(120, 100%, 40%);">+ card_set_state(ch, ISO_S_WAIT_TPDU);</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* return number of bytes transmitted */</span><br><span style="color: hsl(120, 100%, 40%);">+ return 1;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span> </span><br><span> /**********************************************************************</span><br><span> * PTS / PPS handling</span><br><span>@@ -793,17 +842,7 @@</span><br><span> </span><br><span> switch (ch->state) {</span><br><span> case ISO_S_IN_ATR:</span><br><span style="color: hsl(0, 100%, 40%);">- if (ch->atr.idx < ch->atr.len) {</span><br><span style="color: hsl(0, 100%, 40%);">- uint8_t byte;</span><br><span style="color: hsl(0, 100%, 40%);">- byte = ch->atr.atr[ch->atr.idx++];</span><br><span style="color: hsl(0, 100%, 40%);">- rc = 1;</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- card_emu_uart_tx(ch->uart_chan, byte);</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- /* detect end of ATR */</span><br><span style="color: hsl(0, 100%, 40%);">- if (ch->atr.idx >= ch->atr.len)</span><br><span style="color: hsl(0, 100%, 40%);">- card_set_state(ch, ISO_S_WAIT_TPDU);</span><br><span style="color: hsl(0, 100%, 40%);">- }</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = tx_byte_atr(ch);</span><br><span> break;</span><br><span> case ISO_S_IN_PTS:</span><br><span> rc = tx_byte_pts(ch);</span><br><span>@@ -898,9 +937,8 @@</span><br><span> if (ch->vcc_active && ch->clocked) {</span><br><span> /* enable the TC/ETU counter once reset has been released */</span><br><span> tc_etu_enable(ch->tc_chan);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* prepare to send the ATR */</span><br><span> card_set_state(ch, ISO_S_WAIT_ATR);</span><br><span style="color: hsl(0, 100%, 40%);">- /* FIXME: wait 400 to 40k clock cycles before sending ATR */</span><br><span style="color: hsl(0, 100%, 40%);">- card_set_state(ch, ISO_S_IN_ATR);</span><br><span> }</span><br><span> } else if (active && !ch->in_reset) {</span><br><span> TRACE_INFO("%u: RST asserted\r\n", ch->num);</span><br><span>@@ -921,7 +959,15 @@</span><br><span> ch->atr.len = len;</span><br><span> ch->atr.idx = 0;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /* FIXME: race condition with trasmitting ATR to reader? */</span><br><span style="color: hsl(120, 100%, 40%);">+#if TRACE_LEVEL >= TRACE_LEVEL_INFO </span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t i;</span><br><span style="color: hsl(120, 100%, 40%);">+ TRACE_INFO("%u: ATR set: ", ch->num);</span><br><span style="color: hsl(120, 100%, 40%);">+ for (i = 0; i < ch->atr.len; i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+ TRACE_INFO_WP("%02x ", atr[i]);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ TRACE_INFO_WP("\n\r");</span><br><span style="color: hsl(120, 100%, 40%);">+#endif</span><br><span style="color: hsl(120, 100%, 40%);">+ /* FIXME: race condition with transmitting ATR to reader? */</span><br><span> </span><br><span> return 0;</span><br><span> }</span><br><span>@@ -952,7 +998,15 @@</span><br><span> void tc_etu_wtime_expired(void *handle)</span><br><span> {</span><br><span> struct card_handle *ch = handle;</span><br><span style="color: hsl(0, 100%, 40%);">- TRACE_ERROR("%u: wtime_exp\r\n", ch->num);</span><br><span style="color: hsl(120, 100%, 40%);">+ switch (ch->state) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case ISO_S_WAIT_ATR:</span><br><span style="color: hsl(120, 100%, 40%);">+ /* ISO 7816-3 6.2.1 time tc has passed, we can now send the ATR */</span><br><span style="color: hsl(120, 100%, 40%);">+ card_set_state(ch, ISO_S_IN_ATR);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ default:</span><br><span style="color: hsl(120, 100%, 40%);">+ TRACE_ERROR("%u: wtime_exp\r\n", ch->num);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span> }</span><br><span> </span><br><span> /* shortest ATR found in smartcard_list.txt */</span><br><span>diff --git a/firmware/libcommon/source/mode_cardemu.c b/firmware/libcommon/source/mode_cardemu.c</span><br><span>index 57d541b..76b3a01 100644</span><br><span>--- a/firmware/libcommon/source/mode_cardemu.c</span><br><span>+++ b/firmware/libcommon/source/mode_cardemu.c</span><br><span>@@ -1,6 +1,7 @@</span><br><span> /* card emulation mode</span><br><span> *</span><br><span> * (C) 2015-2017 by Harald Welte <laforge@gnumonks.org></span><br><span style="color: hsl(120, 100%, 40%);">+ * (C) 2018 by sysmocom -s.f.m.c. GmbH, Author: Kevin Redon <kredon@sysmocom.de></span><br><span> *</span><br><span> * This program is free software; you can redistribute it and/or modify</span><br><span> * it under the terms of the GNU General Public License as published by</span><br><span>@@ -98,15 +99,11 @@</span><br><span> </span><br><span> static Usart *get_usart_by_chan(uint8_t uart_chan)</span><br><span> {</span><br><span style="color: hsl(0, 100%, 40%);">- switch (uart_chan) {</span><br><span style="color: hsl(0, 100%, 40%);">- case 0:</span><br><span style="color: hsl(0, 100%, 40%);">- return USART1;</span><br><span style="color: hsl(0, 100%, 40%);">-#ifdef CARDEMU_SECOND_UART</span><br><span style="color: hsl(0, 100%, 40%);">- case 1:</span><br><span style="color: hsl(0, 100%, 40%);">- return USART0;</span><br><span style="color: hsl(0, 100%, 40%);">-#endif</span><br><span style="color: hsl(120, 100%, 40%);">+ if (uart_chan < ARRAY_SIZE(cardem_inst)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ return cardem_inst[uart_chan].usart_info.base;</span><br><span style="color: hsl(120, 100%, 40%);">+ } else {</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span> }</span><br><span style="color: hsl(0, 100%, 40%);">- return NULL;</span><br><span> }</span><br><span> </span><br><span> /***********************************************************************</span><br><span>@@ -244,6 +241,20 @@</span><br><span> return 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/* call-back from card_emu.c to force a USART interrupt */</span><br><span style="color: hsl(120, 100%, 40%);">+void card_emu_uart_interrupt(uint8_t uart_chan)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ Usart *usart = get_usart_by_chan(uart_chan);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!usart) {</span><br><span style="color: hsl(120, 100%, 40%);">+ return;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ if (USART0 == usart) {</span><br><span style="color: hsl(120, 100%, 40%);">+ NVIC_SetPendingIRQ(USART0_IRQn);</span><br><span style="color: hsl(120, 100%, 40%);">+ } else if (USART1 == usart) {</span><br><span style="color: hsl(120, 100%, 40%);">+ NVIC_SetPendingIRQ(USART1_IRQn);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /***********************************************************************</span><br><span> * ADC for VCC voltage detection</span><br><span> ***********************************************************************/</span><br><span>diff --git a/firmware/test/card_emu_tests.c b/firmware/test/card_emu_tests.c</span><br><span>index 3ea0678..09b2e0d 100644</span><br><span>--- a/firmware/test/card_emu_tests.c</span><br><span>+++ b/firmware/test/card_emu_tests.c</span><br><span>@@ -65,6 +65,11 @@</span><br><span> printf("uart_enable(uart_chan=%u, %s)\n", uart_chan, rts);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+void card_emu_uart_interrupt(uint8_t uart_chan)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("uart_interrupt(uart_chan=%u)\n", uart_chan);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> void tc_etu_set_wtime(uint8_t tc_chan, uint16_t wtime)</span><br><span> {</span><br><span> printf("tc_etu_set_wtime(tc_chan=%u, wtime=%u)\n", tc_chan, wtime);</span><br><span>@@ -120,6 +125,8 @@</span><br><span> </span><br><span> /* release from reset and verify th ATR */</span><br><span> card_emu_io_statechg(ch, CARD_IO_RST, 0);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* simulate waiting time before ATR expired */</span><br><span style="color: hsl(120, 100%, 40%);">+ tc_etu_wtime_expired(ch);</span><br><span> verify_atr(ch);</span><br><span> }</span><br><span> </span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/10217">change 10217</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/10217"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: simtrace2 </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: I69df797e2feadffa9f5f977cb71b69386cee7cd0 </div>
<div style="display:none"> Gerrit-Change-Number: 10217 </div>
<div style="display:none"> Gerrit-PatchSet: 3 </div>
<div style="display:none"> Gerrit-Owner: Kévin Redon <kredon@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>