<p>Harald Welte <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/9878">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;">sniffing: move conversion convertion and flag processing from ISR to main loop to keep ISR fast and focus on data capture<br><br>Change-Id: Ieefa8a5f81dbcc12c1ad3059660dbffa0c1a4961<br>---<br>M firmware/libcommon/source/sniffer.c<br>M host/simtrace2-sniff.c<br>2 files changed, 88 insertions(+), 64 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/firmware/libcommon/source/sniffer.c b/firmware/libcommon/source/sniffer.c</span><br><span>index fe550ea..c2b8725 100644</span><br><span>--- a/firmware/libcommon/source/sniffer.c</span><br><span>+++ b/firmware/libcommon/source/sniffer.c</span><br><span>@@ -19,8 +19,7 @@</span><br><span> */</span><br><span> /* This code implement the Sniffer mode to sniff the communication between a SIM card (or any ISO 7816 smart card) and a phone (or any ISO 7816 card reader).</span><br><span> * For historical reasons (i.e. SIMtrace hardware) the USART peripheral connected to the SIM card is used.</span><br><span style="color: hsl(0, 100%, 40%);">- * TODO handle RST, PTS, and send data over USB</span><br><span style="color: hsl(0, 100%, 40%);">- * TODO put common ISO7816-3 code is separate library (and combine clean with iso7816_4)</span><br><span style="color: hsl(120, 100%, 40%);">+ * TODO put common ISO7816-3 code is separate library (and combine clean with iso7816_4)</span><br><span> */</span><br><span> #include "board.h"</span><br><span> #include "simtrace.h"</span><br><span>@@ -221,26 +220,6 @@</span><br><span> usb_buf_submit(usb_msg);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! Send card change flags over USB</span><br><span style="color: hsl(0, 100%, 40%);">- * @param[in] flags change flags corresponding to SIMTRACE_MSGT_SNIFF_CHANGE </span><br><span style="color: hsl(0, 100%, 40%);">- */</span><br><span style="color: hsl(0, 100%, 40%);">-static void usb_send_change(uint32_t flags)</span><br><span style="color: hsl(0, 100%, 40%);">-{</span><br><span style="color: hsl(0, 100%, 40%);">- /* Check flags */</span><br><span style="color: hsl(0, 100%, 40%);">- if(0==flags) { /* no changes */</span><br><span style="color: hsl(0, 100%, 40%);">- return;</span><br><span style="color: hsl(0, 100%, 40%);">- }</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- /* Send message over USB */</span><br><span style="color: hsl(0, 100%, 40%);">- struct msgb *usb_msg = usb_msg_alloc_hdr(SIMTRACE_USB_EP_CARD_DATAIN, SIMTRACE_MSGC_SNIFF, SIMTRACE_MSGT_SNIFF_CHANGE);</span><br><span style="color: hsl(0, 100%, 40%);">- if (!usb_msg) {</span><br><span style="color: hsl(0, 100%, 40%);">- return;</span><br><span style="color: hsl(0, 100%, 40%);">- }</span><br><span style="color: hsl(0, 100%, 40%);">- struct sniff_change *usb_sniff_change = (struct sniff_change *) msgb_put(usb_msg, sizeof(*usb_sniff_change));</span><br><span style="color: hsl(0, 100%, 40%);">- usb_sniff_change->flags = flags;</span><br><span style="color: hsl(0, 100%, 40%);">- usb_msg_upd_len_and_submit(usb_msg);</span><br><span style="color: hsl(0, 100%, 40%);">-}</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span> /*! Update the ISO 7816-3 state</span><br><span> * @param[in] iso_state_new new ISO 7816-3 state to update to</span><br><span> */</span><br><span>@@ -256,11 +235,11 @@</span><br><span> switch (iso_state_new) {</span><br><span> case ISO7816_S_RESET:</span><br><span> update_fidi(&sniff_usart, 0x11); /* reset baud rate to default Di/Fi values */</span><br><span style="color: hsl(0, 100%, 40%);">- usb_send_change(SNIFF_CHANGE_FLAG_RESET_HOLD); /* send reset change to host software over USB */</span><br><span style="color: hsl(120, 100%, 40%);">+ change_flags |= SNIFF_CHANGE_FLAG_RESET_HOLD; /* set flag and let main loop send it */</span><br><span> break;</span><br><span> case ISO7816_S_WAIT_ATR:</span><br><span> rbuf_reset(&sniff_buffer); /* reset buffer for new communication */</span><br><span style="color: hsl(0, 100%, 40%);">- usb_send_change(SNIFF_CHANGE_FLAG_RESET_RELEASE); /* send reset change to host software over USB */</span><br><span style="color: hsl(120, 100%, 40%);">+ change_flags |= SNIFF_CHANGE_FLAG_RESET_RELEASE; /* set flag and let main loop send it */</span><br><span> break;</span><br><span> case ISO7816_S_IN_ATR:</span><br><span> atr_i = 0;</span><br><span>@@ -705,42 +684,34 @@</span><br><span> void Sniffer_usart_isr(void)</span><br><span> {</span><br><span> /* Read channel status register */</span><br><span style="color: hsl(0, 100%, 40%);">- uint32_t csr = sniff_usart.base->US_CSR & sniff_usart.base->US_IMR;</span><br><span style="color: hsl(120, 100%, 40%);">+ uint32_t csr = sniff_usart.base->US_CSR;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Verify if there was an error */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (csr & US_CSR_OVRE) {</span><br><span style="color: hsl(120, 100%, 40%);">+ TRACE_WARNING("USART overrun error\n\r");</span><br><span style="color: hsl(120, 100%, 40%);">+ sniff_usart.base->US_CR |= US_CR_RSTSTA;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ if (csr & US_CSR_FRAME) {</span><br><span style="color: hsl(120, 100%, 40%);">+ TRACE_WARNING("USART framing error\n\r");</span><br><span style="color: hsl(120, 100%, 40%);">+ sniff_usart.base->US_CR |= US_CR_RSTSTA;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span> /* Verify if character has been received */</span><br><span> if (csr & US_CSR_RXRDY) {</span><br><span> /* Read communication data byte between phone and SIM */</span><br><span> uint8_t byte = sniff_usart.base->US_RHR;</span><br><span style="color: hsl(0, 100%, 40%);">- /* Convert convention if required */</span><br><span style="color: hsl(0, 100%, 40%);">- if (convention_convert) {</span><br><span style="color: hsl(0, 100%, 40%);">- byte = convention_convert_lut[byte];</span><br><span style="color: hsl(0, 100%, 40%);">- }</span><br><span> /* Store sniffed data into buffer (also clear interrupt */</span><br><span style="color: hsl(0, 100%, 40%);">- rbuf_write(&sniff_buffer, byte);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rbuf_is_full(&sniff_buffer)) {</span><br><span style="color: hsl(120, 100%, 40%);">+ TRACE_ERROR("USART buffer full\n\r");</span><br><span style="color: hsl(120, 100%, 40%);">+ } else {</span><br><span style="color: hsl(120, 100%, 40%);">+ rbuf_write(&sniff_buffer, byte);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span> }</span><br><span style="color: hsl(120, 100%, 40%);">+ </span><br><span> /* Verify it WT timeout occurred, to detect unresponsive card */</span><br><span> if (csr & US_CSR_TIMEOUT) {</span><br><span> /* Stop timeout until next character is received */</span><br><span> sniff_usart.base->US_CR |= US_CR_STTTO;</span><br><span style="color: hsl(0, 100%, 40%);">- /* Use timeout to detect end of ATR/PPS/TPDU */</span><br><span style="color: hsl(0, 100%, 40%);">- switch (iso_state) {</span><br><span style="color: hsl(0, 100%, 40%);">- case ISO7816_S_RESET:</span><br><span style="color: hsl(0, 100%, 40%);">- case ISO7816_S_WAIT_ATR:</span><br><span style="color: hsl(0, 100%, 40%);">- break;</span><br><span style="color: hsl(0, 100%, 40%);">- case ISO7816_S_IN_ATR:</span><br><span style="color: hsl(0, 100%, 40%);">- change_state(ISO7816_S_WAIT_ATR);</span><br><span style="color: hsl(0, 100%, 40%);">- break;</span><br><span style="color: hsl(0, 100%, 40%);">- case ISO7816_S_WAIT_TPDU:</span><br><span style="color: hsl(0, 100%, 40%);">- break;</span><br><span style="color: hsl(0, 100%, 40%);">- case ISO7816_S_WAIT_PPS_RSP:</span><br><span style="color: hsl(0, 100%, 40%);">- case ISO7816_S_IN_TPDU:</span><br><span style="color: hsl(0, 100%, 40%);">- case ISO7816_S_IN_PPS_REQ:</span><br><span style="color: hsl(0, 100%, 40%);">- case ISO7816_S_IN_PPS_RSP:</span><br><span style="color: hsl(0, 100%, 40%);">- change_state(ISO7816_S_WAIT_TPDU);</span><br><span style="color: hsl(0, 100%, 40%);">- break;</span><br><span style="color: hsl(0, 100%, 40%);">- default:</span><br><span style="color: hsl(0, 100%, 40%);">- break;</span><br><span style="color: hsl(0, 100%, 40%);">- }</span><br><span style="color: hsl(0, 100%, 40%);">- usb_send_change(SNIFF_CHANGE_FLAG_TIMEOUT_WT); /* send timeout to host software over USB */</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Just set the flag and let the main loop handle it */</span><br><span style="color: hsl(120, 100%, 40%);">+ change_flags |= SNIFF_CHANGE_FLAG_TIMEOUT_WT;</span><br><span> }</span><br><span> }</span><br><span> </span><br><span>@@ -844,6 +815,30 @@</span><br><span> }</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*! Send card change flags over USB</span><br><span style="color: hsl(120, 100%, 40%);">+ * @param[in] flags change flags corresponding to SIMTRACE_MSGT_SNIFF_CHANGE </span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+static void usb_send_change(uint32_t flags)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Check flags */</span><br><span style="color: hsl(120, 100%, 40%);">+ if(0==flags) { /* no changes */</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%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (flags&SNIFF_CHANGE_FLAG_TIMEOUT_WT) {</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("waiting time (WT) timeout\n\r");</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%);">+ /* Send message over USB */</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *usb_msg = usb_msg_alloc_hdr(SIMTRACE_USB_EP_CARD_DATAIN, SIMTRACE_MSGC_SNIFF, SIMTRACE_MSGT_SNIFF_CHANGE);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!usb_msg) {</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%);">+ struct sniff_change *usb_sniff_change = (struct sniff_change *) msgb_put(usb_msg, sizeof(*usb_sniff_change));</span><br><span style="color: hsl(120, 100%, 40%);">+ usb_sniff_change->flags = flags;</span><br><span style="color: hsl(120, 100%, 40%);">+ usb_msg_upd_len_and_submit(usb_msg);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /* Main (idle/busy) loop of this USB configuration */</span><br><span> void Sniffer_run(void)</span><br><span> {</span><br><span>@@ -862,7 +857,11 @@</span><br><span> /* Handle sniffed data */</span><br><span> if (!rbuf_is_empty(&sniff_buffer)) { /* use if instead of while to let the main loop restart the watchdog */</span><br><span> uint8_t byte = rbuf_read(&sniff_buffer);</span><br><span style="color: hsl(0, 100%, 40%);">- TRACE_DEBUG_WP("< 0x%02x\n\r", byte);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Convert convention if required */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (convention_convert) {</span><br><span style="color: hsl(120, 100%, 40%);">+ byte = convention_convert_lut[byte];</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ //TRACE_ERROR_WP(">%02x", byte);</span><br><span> switch (iso_state) { /* Handle byte depending on state */</span><br><span> case ISO7816_S_RESET: /* During reset we shouldn't receive any data */</span><br><span> break;</span><br><span>@@ -899,6 +898,31 @@</span><br><span> </span><br><span> /* Handle flags */</span><br><span> if (change_flags) { /* WARNING this is not synced with the data buffer handling */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (change_flags&SNIFF_CHANGE_FLAG_TIMEOUT_WT) {</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Use timeout to detect interrupted data transmission */</span><br><span style="color: hsl(120, 100%, 40%);">+ switch (iso_state) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case ISO7816_S_IN_ATR:</span><br><span style="color: hsl(120, 100%, 40%);">+ //usb_send_atr(false); /* send incomplete ATR to host software using USB */</span><br><span style="color: hsl(120, 100%, 40%);">+ change_state(ISO7816_S_WAIT_ATR);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case ISO7816_S_IN_TPDU:</span><br><span style="color: hsl(120, 100%, 40%);">+ //usb_send_tpdu(false); /* send incomplete PPS to host software using USB */</span><br><span style="color: hsl(120, 100%, 40%);">+ change_state(ISO7816_S_WAIT_TPDU);</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</span><br><span style="color: hsl(120, 100%, 40%);">+ case ISO7816_S_IN_PPS_REQ:</span><br><span style="color: hsl(120, 100%, 40%);">+ case ISO7816_S_IN_PPS_RSP:</span><br><span style="color: hsl(120, 100%, 40%);">+ //usb_send_pps(false); /* send incomplete TPDU to host software using USB */</span><br><span style="color: hsl(120, 100%, 40%);">+ change_state(ISO7816_S_WAIT_TPDU);</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%);">+ change_flags &= ~SNIFF_CHANGE_FLAG_TIMEOUT_WT; /* We don't care about the timeout is all other cases */</span><br><span style="color: hsl(120, 100%, 40%);">+ break;</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%);">+ if (change_flags) {</span><br><span style="color: hsl(120, 100%, 40%);">+ usb_send_change(change_flags); /* send timeout to host software over USB */</span><br><span style="color: hsl(120, 100%, 40%);">+ change_flags = 0; /* Reset flags */</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span> }</span><br><span> }</span><br><span> #endif /* HAVE_SNIFFER */</span><br><span>diff --git a/host/simtrace2-sniff.c b/host/simtrace2-sniff.c</span><br><span>index dc4708f..67bfb79 100644</span><br><span>--- a/host/simtrace2-sniff.c</span><br><span>+++ b/host/simtrace2-sniff.c</span><br><span>@@ -92,7 +92,7 @@</span><br><span> return 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-static int process_change(uint8_t *buf, int len)</span><br><span style="color: hsl(120, 100%, 40%);">+static int process_change(const uint8_t *buf, int len)</span><br><span> {</span><br><span> /* check if there is enough data for the structure */</span><br><span> if (len<sizeof(struct sniff_change)) {</span><br><span>@@ -100,9 +100,7 @@</span><br><span> }</span><br><span> struct sniff_change *change = (struct sniff_change *)buf;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- if (SNIFF_CHANGE_FLAG_TIMEOUT_WT!=change->flags) {</span><br><span style="color: hsl(0, 100%, 40%);">- printf("Card state change: ");</span><br><span style="color: hsl(0, 100%, 40%);">- }</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("Card state change: ");</span><br><span> if (change->flags&SNIFF_CHANGE_FLAG_CARD_INSERT) {</span><br><span> printf("card inserted ");</span><br><span> }</span><br><span>@@ -116,11 +114,9 @@</span><br><span> printf("reset release ");</span><br><span> }</span><br><span> if (change->flags&SNIFF_CHANGE_FLAG_TIMEOUT_WT) {</span><br><span style="color: hsl(0, 100%, 40%);">- // do nothing since this also triggers on inactivity</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("data transfer timeout ");</span><br><span> }</span><br><span style="color: hsl(0, 100%, 40%);">- if (SNIFF_CHANGE_FLAG_TIMEOUT_WT!=change->flags) {</span><br><span style="color: hsl(0, 100%, 40%);">- printf("\n");</span><br><span style="color: hsl(0, 100%, 40%);">- }</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("\n");</span><br><span> </span><br><span> return 0;</span><br><span> }</span><br><span>@@ -131,7 +127,7 @@</span><br><span> /* Table 8 from ISO 7816-3:2006 */</span><br><span> static const uint8_t di_table[] = { 0, 1, 2, 4, 8, 16, 32, 64, 12, 20, 2, 4, 8, 16, 32, 64, };</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-static int process_fidi(uint8_t *buf, int len)</span><br><span style="color: hsl(120, 100%, 40%);">+static int process_fidi(const uint8_t *buf, int len)</span><br><span> {</span><br><span> /* check if there is enough data for the structure */</span><br><span> if (len<sizeof(struct sniff_fidi)) {</span><br><span>@@ -143,7 +139,7 @@</span><br><span> return 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-static int process_atr(uint8_t *buf, int len)</span><br><span style="color: hsl(120, 100%, 40%);">+static int process_atr(const uint8_t *buf, int len)</span><br><span> {</span><br><span> /* check if there is enough data for the structure */</span><br><span> if (len<sizeof(struct sniff_data)) {</span><br><span>@@ -165,7 +161,7 @@</span><br><span> return 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-static int process_pps(uint8_t *buf, int len)</span><br><span style="color: hsl(120, 100%, 40%);">+static int process_pps(const uint8_t *buf, int len)</span><br><span> {</span><br><span> /* check if there is enough data for the structure */</span><br><span> if (len<sizeof(struct sniff_data)) {</span><br><span>@@ -187,7 +183,7 @@</span><br><span> return 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-static int process_tpdu(uint8_t *buf, int len)</span><br><span style="color: hsl(120, 100%, 40%);">+static int process_tpdu(const uint8_t *buf, int len)</span><br><span> {</span><br><span> /* check if there is enough data for the structure */</span><br><span> if (len<sizeof(struct sniff_data)) {</span><br><span>@@ -200,17 +196,21 @@</span><br><span> return -2;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ /* print TPDU */</span><br><span> printf("TPDU%s: ", tpdu->complete ? "" : " (incomplete)");</span><br><span> uint16_t i;</span><br><span> for (i = 0; i < tpdu->length; i++) {</span><br><span> printf("%02x ", tpdu->data[i]);</span><br><span> }</span><br><span> printf("\n");</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* send TPDU (now considered as APDU) to GSMTAP */</span><br><span style="color: hsl(120, 100%, 40%);">+ gsmtap_send_sim(tpdu->data, tpdu->length);</span><br><span> return 0;</span><br><span> }</span><br><span> </span><br><span> /*! \brief Process an incoming message from the SIMtrace2 */</span><br><span style="color: hsl(0, 100%, 40%);">-static int process_usb_msg(uint8_t *buf, int len)</span><br><span style="color: hsl(120, 100%, 40%);">+static int process_usb_msg(const uint8_t *buf, int len)</span><br><span> {</span><br><span> /* check if enough data for the header is present */</span><br><span> if (len<sizeof(struct simtrace_msg_hdr)) {</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/9878">change 9878</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/9878"/><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: Ieefa8a5f81dbcc12c1ad3059660dbffa0c1a4961 </div>
<div style="display:none"> Gerrit-Change-Number: 9878 </div>
<div style="display:none"> Gerrit-PatchSet: 13 </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>
<div style="display:none"> Gerrit-Reviewer: Kévin Redon <kredon@sysmocom.de> </div>