Files
pm3py/tests/test_transport.py
michael 2f221644f9 fix(lf): BigBuf download spoke the wrong protocol — LF sample download hung
download_samples sent a DOWNLOAD_BIGBUF request per chunk and read replies with the
NG-only reader. But the firmware answers ONE request by streaming the data as OLD-format
CMD_DOWNLOADED_BIGBUF frames (no magic) then a single NG ACK (appmain.c) — so the NG
reader scanned for a magic that never came and timed out (hardware repro: lf.read() ok,
download_samples -> Response timeout). This blocked all LF identify on real hardware.

- transport.download_bulk: send the request once, then read with the existing NG/OLD-
  agnostic reader, accumulating CMD_DOWNLOADED_BIGBUF payloads (trimmed to oldarg[1], not
  the 512-byte padding) until the ACK or `count` bytes; drains the trailing ACK so it
  can't poison the next command. Reusable for EML/SPIFFS/flashmem bulk reads.
- download_samples: one call into download_bulk instead of the broken per-chunk loop.

Tests: count-terminated + ACK-terminated streams, oldarg-length trimming, single request.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-14 16:11:11 -07:00

136 lines
5.4 KiB
Python

import struct
from pm3py.core.transport import encode_ng_frame, decode_response_frame, encode_mix_frame, _crc_to_wire
from pm3py.core.protocol import Cmd, CMD_PREAMBLE_MAGIC, CMD_POSTAMBLE_NOCRC, RESP_PREAMBLE_MAGIC, RESP_POSTAMBLE_NOCRC, crc16_a
def test_encode_ng_frame_ping_no_payload():
frame = encode_ng_frame(Cmd.PING, b"")
# 8 byte preamble + 0 payload + 2 postamble = 10 bytes
assert len(frame) == 10
magic, length_ng, cmd = struct.unpack_from("<IHH", frame, 0)
assert magic == CMD_PREAMBLE_MAGIC
assert length_ng & 0x8000 # ng bit set
assert (length_ng & 0x7FFF) == 0
assert cmd == Cmd.PING
# Default: no CRC (USB mode)
crc_actual = struct.unpack_from("<H", frame, 8)[0]
assert crc_actual == CMD_POSTAMBLE_NOCRC
def test_encode_ng_frame_with_payload_no_crc():
"""Default USB mode: no CRC, uses magic postamble."""
payload = bytes(range(32))
frame = encode_ng_frame(Cmd.PING, payload)
assert len(frame) == 10 + 32
_, length_ng, _ = struct.unpack_from("<IHH", frame, 0)
assert (length_ng & 0x7FFF) == 32
assert frame[8:40] == payload
crc_actual = struct.unpack_from("<H", frame, 40)[0]
assert crc_actual == CMD_POSTAMBLE_NOCRC
def test_encode_ng_frame_with_crc():
"""FPC UART mode: real CRC, byte-swapped."""
payload = bytes(range(32))
frame = encode_ng_frame(Cmd.PING, payload, use_crc=True)
crc_expected = _crc_to_wire(crc16_a(frame[:40]))
crc_actual = struct.unpack_from("<H", frame, 40)[0]
assert crc_actual == crc_expected
def test_encode_mix_frame():
frame = encode_mix_frame(Cmd.HF_ISO14443A_READER, 0x107, 0, 0, b"")
_, length_ng, _ = struct.unpack_from("<IHH", frame, 0)
assert not (length_ng & 0x8000) # ng bit NOT set for MIX
assert (length_ng & 0x7FFF) == 24 # 3x uint64 = 24 bytes
def test_decode_response_frame_no_crc():
"""USB mode: response uses no-CRC magic."""
payload = b"\x01\x02\x03\x04"
length_ng = len(payload) | 0x8000
preamble = struct.pack("<IHbbH", RESP_PREAMBLE_MAGIC, length_ng, 0, 0, Cmd.PING)
body = preamble + payload
postamble = struct.pack("<H", RESP_POSTAMBLE_NOCRC)
frame = body + postamble
resp = decode_response_frame(frame)
assert resp["cmd"] == Cmd.PING
assert resp["status"] == 0
assert resp["data"] == payload
assert resp["ng"] is True
def test_decode_response_frame_with_crc():
"""FPC UART mode: response has real CRC, byte-swapped."""
payload = b"\x01\x02\x03\x04"
length_ng = len(payload) | 0x8000
preamble = struct.pack("<IHbbH", RESP_PREAMBLE_MAGIC, length_ng, 0, 0, Cmd.PING)
body = preamble + payload
crc = _crc_to_wire(crc16_a(body))
postamble = struct.pack("<H", crc)
frame = body + postamble
resp = decode_response_frame(frame)
assert resp["cmd"] == Cmd.PING
assert resp["status"] == 0
assert resp["data"] == payload
def test_decode_response_frame_error_status():
length_ng = 0 | 0x8000
preamble = struct.pack("<IHbbH", RESP_PREAMBLE_MAGIC, length_ng, -4, -1, Cmd.STATUS)
postamble = struct.pack("<H", RESP_POSTAMBLE_NOCRC)
frame = preamble + postamble
resp = decode_response_frame(frame)
assert resp["status"] == -4 # ETIMEOUT
assert resp["data"] == b""
# --- bulk download (BigBuf): one request -> OLD data frames -> ACK -----------------------------
import asyncio
from unittest.mock import AsyncMock
from pm3py.core.transport import PM3Transport, PM3Response
from pm3py.core.protocol import PM3_CMD_DATA_SIZE
def _run(coro):
return asyncio.get_event_loop().run_until_complete(coro)
def _bigbuf_frame(offset, data):
# OLD-format CMD_DOWNLOADED_BIGBUF: oldarg=[offset, len, tracelen], data padded to 512
return PM3Response(cmd=int(Cmd.DOWNLOADED_BIGBUF), status=0, reason=0, ng=False,
data=data + b"\x00" * (PM3_CMD_DATA_SIZE - len(data)),
oldarg=[offset, len(data), 4242])
def _ack():
return PM3Response(cmd=int(Cmd.ACK), status=0, reason=0, ng=False, data=b"", oldarg=[1, 0, 0])
def _transport_with(frames):
t = PM3Transport("/dev/null")
t.send_frame = AsyncMock()
t._read_any_response = AsyncMock(side_effect=frames)
return t
def test_download_bulk_count_terminated():
payload = bytes((i * 7) % 256 for i in range(1224))
t = _transport_with([_bigbuf_frame(0, payload[0:512]), _bigbuf_frame(512, payload[512:1024]),
_bigbuf_frame(1024, payload[1024:1224]), _ack()])
got = _run(t.download_bulk(Cmd.DOWNLOAD_BIGBUF, 0, 1224, Cmd.DOWNLOADED_BIGBUF, Cmd.ACK))
assert got == payload # exactly count bytes, reassembled in order
assert t.send_frame.call_count == 1 # ONE request, not one per chunk
def test_download_bulk_ack_terminated_early():
# device has fewer bytes than requested -> stops at the ACK, returns what came
payload = bytes(range(200))
t = _transport_with([_bigbuf_frame(0, payload), _ack()])
got = _run(t.download_bulk(Cmd.DOWNLOAD_BIGBUF, 0, 99999, Cmd.DOWNLOADED_BIGBUF, Cmd.ACK))
assert got == payload
def test_download_bulk_uses_oldarg_length_not_padding():
# the OLD frame is always 512 bytes; only oldarg[1] bytes are valid (rest is padding)
t = _transport_with([_bigbuf_frame(0, b"\xAA\xBB\xCC"), _ack()])
got = _run(t.download_bulk(Cmd.DOWNLOAD_BIGBUF, 0, 3, Cmd.DOWNLOADED_BIGBUF, Cmd.ACK))
assert got == b"\xAA\xBB\xCC" # trimmed to oldarg length, not 512 of padding