From ee9019092852ac601e6c20386f4c20ac77cb156a Mon Sep 17 00:00:00 2001 From: Devin Ronge <3580448+barefootdeveloper@users.noreply.github.com> Date: Sat, 22 Aug 2026 10:34:44 -0400 Subject: [PATCH] add a timeout parameter to the hw qc_pm5 command and ensure rgb led is off at the conclusion of the test --- armsrc/appmain.c | 80 +++++++++++++------ client/src/cmdhw.c | 17 +++- .../Proxmark5-Instructions.md | 4 +- 3 files changed, 73 insertions(+), 28 deletions(-) diff --git a/armsrc/appmain.c b/armsrc/appmain.c index 644918e84..e64208125 100644 --- a/armsrc/appmain.c +++ b/armsrc/appmain.c @@ -1338,22 +1338,27 @@ void ListenReaderField(uint8_t limit) { // failed_item == 0: BLUE LED in Antenna // failed_item == 1: RGB in mainboard // failed_item == 2: LEDs * 4 or Buzzer or Button in mainboard -static bool QCTestPM5(uint8_t *failed_item) { +// timeout_ms == 0: run until button press or new usb data +static bool QCTestPM5(uint8_t *failed_item, uint32_t timeout_ms) { // 天线蓝灯、主板RGB、主板四颗LED、蜂鸣器、按钮 StartTicks(); I2C_init(true); uint8_t addr_ant = 0x51; // TODO DXL define move to header? uint8_t addr_rgb = 0x48; - uint8_t data_u8; + uint8_t data_u8 = 0; bool isok = false; + bool result = false; + bool data_u8_valid = false; // 读取天线当前MAP配置,如果读取不到,则认为天线的控制芯片可能有问题 isok = I2C_BufferReadRaw(&data_u8, 1, 0x02, addr_ant << 1); if (!isok) { *failed_item = 0; - return false; + result = false; + goto out; } + data_u8_valid = true; // 重新写入天线的MAP配置,去开灯 data_u8 |= 0x06; // 0000 0110 // 125 134 250 375 500 HFLED LFLED Q isok = I2C_BufferWrite(&data_u8, 1, 0x02, addr_ant << 1); @@ -1364,27 +1369,32 @@ static bool QCTestPM5(uint8_t *failed_item) { isok = I2C_WriteByte(0, 0x02, addr_rgb << 1); // 写索引寄存器,设置后续操作的RGB索引 if (!isok) { *failed_item = 1; - return false; + result = false; + goto out; } isok = I2C_WriteByte(1, 0x01, addr_rgb << 1); // 写数量寄存器,设置硬件挂1个灯,很重要!!!,不然无法闪灯 if (!isok) { *failed_item = 1; - return false; + result = false; + goto out; } isok = I2C_BufferWrite(buf_rgb, sizeof(buf_rgb), 0x03, addr_rgb << 1); // 写数据寄存器,每三个字节就是对应的RGB888值 if (!isok) { *failed_item = 1; - return false; + result = false; + goto out; } isok = I2C_WriteByte(1, 0x06, addr_rgb << 1); // 写闪灯使能寄存器,使能 0 号灯珠的可控闪烁 if (!isok) { *failed_item = 1; - return false; + result = false; + goto out; } isok = I2C_BufferWrite(buf_flash_time, sizeof(buf_flash_time), 0x07, addr_rgb << 1); // 写闪灯使能寄存器,使能 0 号灯珠的可控闪烁 if (!isok) { *failed_item = 1; - return false; + result = false; + goto out; } // 在循环中测试LED、蜂鸣器、按钮 @@ -1437,15 +1447,20 @@ static bool QCTestPM5(uint8_t *failed_item) { *failed_item = 2; // 在开始测试之前,如果按钮是按下的,则认为失败,有可能按钮不良卡住了 if (BUTTON_PRESS()) { - return false; + result = false; + goto out; } + uint32_t start_time = GetTickCount(); + while (1) { if (BUTTON_PRESS()) { - return true; + result = true; + goto out; } - if (data_available()) { - return false; + if (data_available() || (timeout_ms > 0 && (GetTickCount() - start_time) >= timeout_ms)) { + result = false; + goto out; } LED_A_ON(); @@ -1457,10 +1472,12 @@ static bool QCTestPM5(uint8_t *failed_item) { LED_A_OFF(); if (BUTTON_PRESS()) { - return true; + result = true; + goto out; } - if (data_available()) { - return false; + if (data_available() || (timeout_ms > 0 && (GetTickCount() - start_time) >= timeout_ms)) { + result = false; + goto out; } LED_B_ON(); @@ -1473,10 +1490,12 @@ static bool QCTestPM5(uint8_t *failed_item) { LED_B_OFF(); if (BUTTON_PRESS()) { - return true; + result = true; + goto out; } - if (data_available()) { - return false; + if (data_available() || (timeout_ms > 0 && (GetTickCount() - start_time) >= timeout_ms)) { + result = false; + goto out; } LED_C_ON(); @@ -1489,10 +1508,12 @@ static bool QCTestPM5(uint8_t *failed_item) { LED_C_OFF(); if (BUTTON_PRESS()) { - return true; + result = true; + goto out; } - if (data_available()) { - return false; + if (data_available() || (timeout_ms > 0 && (GetTickCount() - start_time) >= timeout_ms)) { + result = false; + goto out; } LED_D_ON(); @@ -1505,7 +1526,16 @@ static bool QCTestPM5(uint8_t *failed_item) { LED_D_OFF(); } - return true; +out: + // Turn off the test LEDs (antenna + RGB flash) before returning + LEDsoff(); + RgbLedSet(0, 0, 0); + I2C_WriteByte(0, 0x06, addr_rgb << 1); + if (data_u8_valid) { + data_u8 &= ~0x06; + I2C_BufferWrite(&data_u8, 1, 0x02, addr_ant << 1); + } + return result; } #endif @@ -3999,7 +4029,11 @@ static void PacketReceived(PacketCommandNG *packet) { #ifdef PM5 case CMD_PM5_QC_TEST: { uint8_t failed_item = 0; - reply_ng(CMD_PM5_QC_TEST, QCTestPM5(&failed_item) ? PM3_SUCCESS : PM3_EFAILED, &failed_item, 1); + uint32_t timeout_ms = 0; + if (packet->length >= sizeof(timeout_ms)) { + memcpy(&timeout_ms, packet->data.asBytes, sizeof(timeout_ms)); + } + reply_ng(CMD_PM5_QC_TEST, QCTestPM5(&failed_item, timeout_ms) ? PM3_SUCCESS : PM3_EFAILED, &failed_item, 1); break; } case CMD_PM5_RGB_SET: { diff --git a/client/src/cmdhw.c b/client/src/cmdhw.c index 93e049b3f..0bd310813 100644 --- a/client/src/cmdhw.c +++ b/client/src/cmdhw.c @@ -1992,22 +1992,33 @@ static int CmdDeviceFactoryData(const char *Cmd) { static int CmdPM5QCTest(const char *Cmd) { CLIParserContext *ctx; - CLIParserInit(&ctx, "hw qcpm5", "QC Test for the PM5", "hf qcpm5"); + CLIParserInit(&ctx, "hw qc_pm5", "QC Test for the PM5", + "hw qc_pm5 -> run QC test with default 20 second timeout\n" + "hw qc_pm5 -t 3 -> run QC test with a 3 second timeout"); void *argtable[] = { arg_param_begin, + arg_u64_0("t", "timeout", "", "test sequence timeout in seconds (default 20)"), arg_param_end }; CLIExecWithReturn(ctx, Cmd, argtable, true); + uint32_t timeout_ms = arg_get_u32_def(ctx, 1, 20); + timeout_ms *= 1000; CLIParserFree(ctx); + if (timeout_ms == 0) { + PrintAndLogEx(ERR, "timeout must be greater than zero"); + return PM3_EINVARG; + } + PrintAndLogEx(INFO, "Performing QC test for the PM5..."); clearCommandBuffer(); - SendCommandNG(CMD_PM5_QC_TEST, NULL, 0); + SendCommandNG(CMD_PM5_QC_TEST, (uint8_t *)&timeout_ms, sizeof(timeout_ms)); PacketResponseNG resp; - if (WaitForResponseTimeout(CMD_PM5_QC_TEST, &resp, 20 * 1000) == false) { + // wait a bit longer than the device side sequence timeout, with headroom for RTC drift + if (WaitForResponseTimeout(CMD_PM5_QC_TEST, &resp, timeout_ms + (timeout_ms / 5) + 1000) == false) { SendCommandNG(CMD_BREAK_LOOP, NULL, 0); PrintAndLogEx(WARNING, "command execution time out"); return PM3_ETIMEOUT; diff --git a/doc/md/Installation_Instructions/Proxmark5-Instructions.md b/doc/md/Installation_Instructions/Proxmark5-Instructions.md index 53a301d45..959e01924 100644 --- a/doc/md/Installation_Instructions/Proxmark5-Instructions.md +++ b/doc/md/Installation_Instructions/Proxmark5-Instructions.md @@ -89,8 +89,8 @@ Do not use them unless you fully understand what you're doing. * `hw fpga config`: to upload the FPGA firmware * `hw fpga pwrpwm`: to adjust the antenna's drive voltage TODO: acceptable ranges? * `hw ant_pm5 -m --set <8bit data>` command can be used to modify the frequency and Q value. Note: High Q is only allowed at 125kHz/134kHz to prevent excessive resonant voltage from damaging the device. - > 8bit map: 125 134 250 375 500 HFLED LFLED Q (lsb) -* `hw qc_pm5`: factory quality check command, will activate the RBG, the buzzer and the antenna LEDs. + > 8bit map: 125 134 250 375 500 HFLED LFLED Q (lsb) +* `hw qc_pm5`: factory quality check command, will activate the RBG, the buzzer and the antenna LEDs. Press the button to report success. Use `-t/--timeout ` to change how long the test sequence runs before it fails (default 20 seconds). * `hw factorydata`: read/write the factory data (originality signature etc) ## Standalone Modes