iButton: Add support for Dallas DS1971 v2 (#2492)

* iButton: Add DS1971 Support refactored for v2
* Fix requested by gsurkov
* Fix DALLAS_COMMON_CMD_* use, cusotm data field to Eeprom and COPY_SCRAPTCHPAD
* Fix Emulation + Memory Info + Docs
* Fix docs, strings, refactor code

Co-authored-by: Georgii Surkov <georgii.surkov@outlook.com>
Co-authored-by: あく <alleteam@gmail.com>

documentation/file_formats/iButtonFileFormat.md

@@ -24,12 +24,13 @@ Changelog:
 
 #### Format fields
 
-| Name      | Type   | Description                                  |
+| Name        | Type   | Description                                  |
-| --------- | ------ | -------------------------------------------- |
+| ----------- | ------ | -------------------------------------------- |
-| Protocol  | string | Currently supported: DS1990, DS1992, DS1996, DSGeneric*, Cyfral, Metakom |
+| Protocol    | string | Currently supported: DS1990, DS1992, DS1996, DS1997, DSGeneric*, Cyfral, Metakom |
-| Rom Data  | hex    | Read-only memory data (Dallas protocols only) |
+| Rom Data    | hex    | Read-only memory data (Dallas protocols only) |
-| Sram Data | hex    | Static RAM data (DS1992 and DS1996 only)
+| Sram Data   | hex    | Static RAM data (DS1992 and DS1996 only)
-| Data      | hex    | Key data (Cyfral & Metakom only)              |
+| Eeprom Data | hex    | EEPROM data (DS1971 only)
+| Data        | hex    | Key data (Cyfral & Metakom only)              |
 
 NOTE 1: DSGeneric is a catch-all protocol for all unknown 1-Wire devices. It reads only the ROM and does not perform any checks on the read data. 
 It can also be used if a key with a deliberately invalid family code or checksum is required.

lib/one_wire/ibutton/protocols/dallas/dallas_common.c

@@ -21,6 +21,7 @@
 
 #define BITS_IN_BYTE 8U
 #define BITS_IN_KBIT 1024U
+#define BITS_IN_MBIT (BITS_IN_KBIT * 1024U)
 
 bool dallas_common_skip_rom(OneWireHost* host) {
     onewire_host_write(host, DALLAS_COMMON_CMD_SKIP_ROM);
@@ -210,25 +211,35 @@ bool dallas_common_is_valid_crc(const DallasCommonRomData* rom_data) {
 void dallas_common_render_brief_data(
     FuriString* result,
     const DallasCommonRomData* rom_data,
-    const uint8_t* sram_data,
+    const uint8_t* mem_data,
-    size_t sram_data_size) {
+    size_t mem_size,
+    const char* mem_name) {
     for(size_t i = 0; i < sizeof(rom_data->bytes); ++i) {
         furi_string_cat_printf(result, "%02X ", rom_data->bytes[i]);
     }
 
+    const char* size_prefix = "";
+    size_t mem_size_bits = mem_size * BITS_IN_BYTE;
+
+    if(mem_size_bits >= BITS_IN_MBIT) {
+        size_prefix = "M";
+        mem_size_bits /= BITS_IN_MBIT;
+    } else if(mem_size_bits >= BITS_IN_KBIT) {
+        size_prefix = "K";
+        mem_size_bits /= BITS_IN_KBIT;
+    }
+
     furi_string_cat_printf(
-        result,
+        result, "\nInternal %s: %zu %sbit\n", mem_name, mem_size_bits, size_prefix);
-        "\nInternal SRAM: %zu Kbit\n",
-        (size_t)(sram_data_size * BITS_IN_BYTE / BITS_IN_KBIT));
 
     for(size_t i = 0; i < DALLAS_COMMON_BRIEF_HEAD_COUNT; ++i) {
-        furi_string_cat_printf(result, "%02X ", sram_data[i]);
+        furi_string_cat_printf(result, "%02X ", mem_data[i]);
     }
 
     furi_string_cat_printf(result, "[  . . .  ]");
 
-    for(size_t i = sram_data_size - DALLAS_COMMON_BRIEF_TAIL_COUNT; i < sram_data_size; ++i) {
+    for(size_t i = mem_size - DALLAS_COMMON_BRIEF_TAIL_COUNT; i < mem_size; ++i) {
-        furi_string_cat_printf(result, " %02X", sram_data[i]);
+        furi_string_cat_printf(result, " %02X", mem_data[i]);
     }
 }
 

lib/one_wire/ibutton/protocols/dallas/dallas_common.h

@@ -99,8 +99,9 @@ bool dallas_common_is_valid_crc(const DallasCommonRomData* rom_data);
 void dallas_common_render_brief_data(
     FuriString* result,
     const DallasCommonRomData* rom_data,
-    const uint8_t* sram_data,
+    const uint8_t* mem_data,
-    size_t sram_data_size);
+    size_t mem_size,
+    const char* mem_name);
 
 void dallas_common_render_crc_error(FuriString* result, const DallasCommonRomData* rom_data);
 

lib/one_wire/ibutton/protocols/dallas/protocol_ds1971.c

@@ -0,0 +1,270 @@
+#include "protocol_ds1971.h"
+
+#include <core/core_defines.h>
+#include <toolbox/pretty_format.h>
+
+#include "dallas_common.h"
+
+#define DS1971_FAMILY_CODE 0x14U
+#define DS1971_FAMILY_NAME "DS1971"
+
+#define DS1971_EEPROM_DATA_SIZE 32U
+#define DS1971_SRAM_PAGE_SIZE 32U
+#define DS1971_COPY_SCRATCH_DELAY_US 250U
+
+#define DS1971_DATA_BYTE_COUNT 4U
+
+#define DS1971_EEPROM_DATA_KEY "Eeprom Data"
+#define DS1971_MEMORY_TYPE "EEPROM"
+
+#define DS1971_CMD_FINALIZATION 0xA5
+
+typedef struct {
+    OneWireSlave* bus;
+    DallasCommonCommandState command_state;
+} DS1971ProtocolState;
+
+typedef struct {
+    DallasCommonRomData rom_data;
+    uint8_t eeprom_data[DS1971_EEPROM_DATA_SIZE];
+    DS1971ProtocolState state;
+} DS1971ProtocolData;
+
+static bool dallas_ds1971_read(OneWireHost*, void*);
+static bool dallas_ds1971_write_copy(OneWireHost*, iButtonProtocolData*);
+static void dallas_ds1971_emulate(OneWireSlave*, iButtonProtocolData*);
+static bool dallas_ds1971_load(FlipperFormat*, uint32_t, iButtonProtocolData*);
+static bool dallas_ds1971_save(FlipperFormat*, const iButtonProtocolData*);
+static void dallas_ds1971_render_data(FuriString*, const iButtonProtocolData*);
+static void dallas_ds1971_render_brief_data(FuriString*, const iButtonProtocolData*);
+static void dallas_ds1971_render_error(FuriString*, const iButtonProtocolData*);
+static bool dallas_ds1971_is_data_valid(const iButtonProtocolData*);
+static void dallas_ds1971_get_editable_data(iButtonEditableData*, iButtonProtocolData*);
+static void dallas_ds1971_apply_edits(iButtonProtocolData*);
+static bool
+    dallas_ds1971_read_mem(OneWireHost* host, uint8_t address, uint8_t* data, size_t data_size);
+static bool ds1971_emulate_read_mem(OneWireSlave* bus, const uint8_t* data, size_t data_size);
+
+const iButtonProtocolDallasBase ibutton_protocol_ds1971 = {
+    .family_code = DS1971_FAMILY_CODE,
+    .features = iButtonProtocolFeatureExtData | iButtonProtocolFeatureWriteCopy,
+    .data_size = sizeof(DS1971ProtocolData),
+    .manufacturer = DALLAS_COMMON_MANUFACTURER_NAME,
+    .name = DS1971_FAMILY_NAME,
+
+    .read = dallas_ds1971_read,
+    .write_blank = NULL, /* No data to write a blank */
+    .write_copy = dallas_ds1971_write_copy,
+    .emulate = dallas_ds1971_emulate,
+    .save = dallas_ds1971_save,
+    .load = dallas_ds1971_load,
+    .render_data = dallas_ds1971_render_data,
+    .render_brief_data = dallas_ds1971_render_brief_data,
+    .render_error = dallas_ds1971_render_error,
+    .is_valid = dallas_ds1971_is_data_valid,
+    .get_editable_data = dallas_ds1971_get_editable_data,
+    .apply_edits = dallas_ds1971_apply_edits,
+};
+
+bool dallas_ds1971_read(OneWireHost* host, iButtonProtocolData* protocol_data) {
+    DS1971ProtocolData* data = protocol_data;
+    return onewire_host_reset(host) && dallas_common_read_rom(host, &data->rom_data) &&
+           dallas_ds1971_read_mem(host, 0, data->eeprom_data, DS1971_EEPROM_DATA_SIZE);
+}
+
+bool dallas_ds1971_write_copy(OneWireHost* host, iButtonProtocolData* protocol_data) {
+    DS1971ProtocolData* data = protocol_data;
+
+    onewire_host_reset(host);
+    onewire_host_skip(host);
+    // Starting writing from address 0x0000
+    onewire_host_write(host, DALLAS_COMMON_CMD_WRITE_SCRATCH);
+    onewire_host_write(host, 0x00);
+    // Write data to scratchpad
+    onewire_host_write_bytes(host, data->eeprom_data, DS1971_EEPROM_DATA_SIZE);
+
+    // Read data from scratchpad and verify
+    bool pad_valid = false;
+    if(onewire_host_reset(host)) {
+        pad_valid = true;
+        onewire_host_skip(host);
+        onewire_host_write(host, DALLAS_COMMON_CMD_READ_SCRATCH);
+        onewire_host_write(host, 0x00);
+
+        for(size_t i = 0; i < DS1971_EEPROM_DATA_SIZE; ++i) {
+            uint8_t scratch = onewire_host_read(host);
+            if(data->eeprom_data[i] != scratch) {
+                pad_valid = false;
+                break;
+            }
+        }
+    }
+
+    // Copy scratchpad to memory and confirm
+    if(pad_valid) {
+        if(onewire_host_reset(host)) {
+            onewire_host_skip(host);
+            onewire_host_write(host, DALLAS_COMMON_CMD_COPY_SCRATCH);
+            onewire_host_write(host, DS1971_CMD_FINALIZATION);
+
+            furi_delay_us(DS1971_COPY_SCRATCH_DELAY_US);
+        }
+    }
+
+    return pad_valid;
+}
+
+static void dallas_ds1971_reset_callback(void* context) {
+    furi_assert(context);
+    DS1971ProtocolData* data = context;
+    data->state.command_state = DallasCommonCommandStateIdle;
+}
+
+static bool dallas_ds1971_command_callback(uint8_t command, void* context) {
+    furi_assert(context);
+    DS1971ProtocolData* data = context;
+    OneWireSlave* bus = data->state.bus;
+
+    switch(command) {
+    case DALLAS_COMMON_CMD_SEARCH_ROM:
+        if(data->state.command_state == DallasCommonCommandStateIdle) {
+            data->state.command_state = DallasCommonCommandStateRomCmd;
+            return dallas_common_emulate_search_rom(bus, &data->rom_data);
+
+        } else if(data->state.command_state == DallasCommonCommandStateRomCmd) {
+            data->state.command_state = DallasCommonCommandStateMemCmd;
+            ds1971_emulate_read_mem(bus, data->eeprom_data, DS1971_EEPROM_DATA_SIZE);
+            return false;
+
+        } else {
+            return false;
+        }
+
+    case DALLAS_COMMON_CMD_READ_ROM:
+        if(data->state.command_state == DallasCommonCommandStateIdle) {
+            data->state.command_state = DallasCommonCommandStateRomCmd;
+            return dallas_common_emulate_read_rom(bus, &data->rom_data);
+        } else {
+            return false;
+        }
+
+    case DALLAS_COMMON_CMD_SKIP_ROM:
+        if(data->state.command_state == DallasCommonCommandStateIdle) {
+            data->state.command_state = DallasCommonCommandStateRomCmd;
+            return true;
+        } else {
+            return false;
+        }
+
+    default:
+        return false;
+    }
+}
+
+void dallas_ds1971_emulate(OneWireSlave* bus, iButtonProtocolData* protocol_data) {
+    DS1971ProtocolData* data = protocol_data;
+    data->state.bus = bus;
+
+    onewire_slave_set_reset_callback(bus, dallas_ds1971_reset_callback, protocol_data);
+    onewire_slave_set_command_callback(bus, dallas_ds1971_command_callback, protocol_data);
+}
+
+bool dallas_ds1971_load(
+    FlipperFormat* ff,
+    uint32_t format_version,
+    iButtonProtocolData* protocol_data) {
+    DS1971ProtocolData* data = protocol_data;
+    bool success = false;
+
+    do {
+        if(format_version < 2) break;
+        if(!dallas_common_load_rom_data(ff, format_version, &data->rom_data)) break;
+        if(!flipper_format_read_hex(
+               ff, DS1971_EEPROM_DATA_KEY, data->eeprom_data, DS1971_EEPROM_DATA_SIZE))
+            break;
+        success = true;
+    } while(false);
+
+    return success;
+}
+
+bool dallas_ds1971_save(FlipperFormat* ff, const iButtonProtocolData* protocol_data) {
+    const DS1971ProtocolData* data = protocol_data;
+    bool success = false;
+
+    do {
+        if(!dallas_common_save_rom_data(ff, &data->rom_data)) break;
+        if(!flipper_format_write_hex(
+               ff, DS1971_EEPROM_DATA_KEY, data->eeprom_data, DS1971_EEPROM_DATA_SIZE))
+            break;
+        success = true;
+    } while(false);
+
+    return success;
+}
+
+void dallas_ds1971_render_data(FuriString* result, const iButtonProtocolData* protocol_data) {
+    const DS1971ProtocolData* data = protocol_data;
+    pretty_format_bytes_hex_canonical(
+        result,
+        DS1971_DATA_BYTE_COUNT,
+        PRETTY_FORMAT_FONT_MONOSPACE,
+        data->eeprom_data,
+        DS1971_EEPROM_DATA_SIZE);
+}
+
+void dallas_ds1971_render_brief_data(FuriString* result, const iButtonProtocolData* protocol_data) {
+    const DS1971ProtocolData* data = protocol_data;
+    dallas_common_render_brief_data(
+        result, &data->rom_data, data->eeprom_data, DS1971_EEPROM_DATA_SIZE, DS1971_MEMORY_TYPE);
+}
+
+void dallas_ds1971_render_error(FuriString* result, const iButtonProtocolData* protocol_data) {
+    const DS1971ProtocolData* data = protocol_data;
+
+    if(!dallas_common_is_valid_crc(&data->rom_data)) {
+        dallas_common_render_crc_error(result, &data->rom_data);
+    }
+}
+
+bool dallas_ds1971_is_data_valid(const iButtonProtocolData* protocol_data) {
+    const DS1971ProtocolData* data = protocol_data;
+    return dallas_common_is_valid_crc(&data->rom_data);
+}
+
+void dallas_ds1971_get_editable_data(
+    iButtonEditableData* editable_data,
+    iButtonProtocolData* protocol_data) {
+    DS1971ProtocolData* data = protocol_data;
+    editable_data->ptr = data->rom_data.bytes;
+    editable_data->size = sizeof(DallasCommonRomData);
+}
+
+void dallas_ds1971_apply_edits(iButtonProtocolData* protocol_data) {
+    DS1971ProtocolData* data = protocol_data;
+    dallas_common_apply_edits(&data->rom_data, DS1971_FAMILY_CODE);
+}
+
+bool dallas_ds1971_read_mem(OneWireHost* host, uint8_t address, uint8_t* data, size_t data_size) {
+    onewire_host_write(host, DALLAS_COMMON_CMD_READ_MEM);
+
+    onewire_host_write(host, address);
+    onewire_host_read_bytes(host, data, (uint8_t)data_size);
+
+    return true;
+}
+
+bool ds1971_emulate_read_mem(OneWireSlave* bus, const uint8_t* data, size_t data_size) {
+    bool success = false;
+
+    do {
+        uint8_t address;
+        if(!onewire_slave_receive(bus, &address, sizeof(address))) break;
+        if(address >= data_size) break;
+        if(!onewire_slave_send(bus, data + address, data_size - address)) break;
+
+        success = true;
+    } while(false);
+
+    return success;
+}

lib/one_wire/ibutton/protocols/dallas/protocol_ds1971.h

@@ -0,0 +1,5 @@
+#pragma once
+
+#include "protocol_dallas_base.h"
+
+extern const iButtonProtocolDallasBase ibutton_protocol_ds1971;

lib/one_wire/ibutton/protocols/dallas/protocol_ds1992.c

@@ -17,6 +17,7 @@
 #define DS1992_DATA_BYTE_COUNT 4U
 
 #define DS1992_SRAM_DATA_KEY "Sram Data"
+#define DS1992_MEMORY_TYPE "SRAM"
 
 typedef struct {
     OneWireSlave* bus;
@@ -188,7 +189,7 @@ void dallas_ds1992_render_data(FuriString* result, const iButtonProtocolData* pr
 void dallas_ds1992_render_brief_data(FuriString* result, const iButtonProtocolData* protocol_data) {
     const DS1992ProtocolData* data = protocol_data;
     dallas_common_render_brief_data(
-        result, &data->rom_data, data->sram_data, DS1992_SRAM_DATA_SIZE);
+        result, &data->rom_data, data->sram_data, DS1992_SRAM_DATA_SIZE, DS1992_MEMORY_TYPE);
 }
 
 void dallas_ds1992_render_error(FuriString* result, const iButtonProtocolData* protocol_data) {

lib/one_wire/ibutton/protocols/dallas/protocol_ds1996.c

@@ -15,6 +15,7 @@
 #define DS1996_DATA_BYTE_COUNT 4U
 
 #define DS1996_SRAM_DATA_KEY "Sram Data"
+#define DS1996_MEMORY_TYPE "SRAM"
 
 typedef struct {
     OneWireSlave* bus;
@@ -182,7 +183,7 @@ void dallas_ds1996_render_data(FuriString* result, const iButtonProtocolData* pr
 void dallas_ds1996_render_brief_data(FuriString* result, const iButtonProtocolData* protocol_data) {
     const DS1996ProtocolData* data = protocol_data;
     dallas_common_render_brief_data(
-        result, &data->rom_data, data->sram_data, DS1996_SRAM_DATA_SIZE);
+        result, &data->rom_data, data->sram_data, DS1996_SRAM_DATA_SIZE, DS1996_MEMORY_TYPE);
 }
 
 void dallas_ds1996_render_error(FuriString* result, const iButtonProtocolData* protocol_data) {

lib/one_wire/ibutton/protocols/dallas/protocol_group_dallas_defs.c

@@ -3,12 +3,14 @@
 #include "protocol_ds1990.h"
 #include "protocol_ds1992.h"
 #include "protocol_ds1996.h"
+#include "protocol_ds1971.h"
 #include "protocol_ds_generic.h"
 
 const iButtonProtocolDallasBase* ibutton_protocols_dallas[] = {
     [iButtonProtocolDS1990] = &ibutton_protocol_ds1990,
     [iButtonProtocolDS1992] = &ibutton_protocol_ds1992,
     [iButtonProtocolDS1996] = &ibutton_protocol_ds1996,
+    [iButtonProtocolDS1971] = &ibutton_protocol_ds1971,
     /* Add new 1-Wire protocols here */
 
     /* Default catch-all 1-Wire protocol */

lib/one_wire/ibutton/protocols/dallas/protocol_group_dallas_defs.h

@@ -6,6 +6,7 @@ typedef enum {
     iButtonProtocolDS1990,
     iButtonProtocolDS1992,
     iButtonProtocolDS1996,
+    iButtonProtocolDS1971,
     /* Add new 1-Wire protocols here */
 
     /* Default catch-all 1-Wire protocol */