[FL-3070] iButton system and app refactoring (#2388)

* Add 1-wire thermometer example app stub * Working 1-wire thermometer app * Refactor app to use threads * Clean up code, add comments * Add CRC checking * Increase update period * Fix error in fbt * Revert the old update period * Use settable pin in onewire_host * Use settable pin for onewire_slave * Clear EXTI flag after callback, make private methods static in onewire_slave * Do not hardcode GPIO pin number * Remove iButton hal from furi_hal_rfid * Remove most of furi_hal_ibutton * Add some of furi_hal_ibutton back * Slightly neater code * Update CODEOWNERS * Add furi_hal_gpio_get_ext_pin_number * Create README.md * Temporary get Metakom and Cyfral keys out of the way * Better enum name * Syncing work, does not compile * Syncing work, now compiles * Working read impl for DS1990 and DS1992 * Add the ability to display extended key data * Get rid of DialogEx * Add save and load API * Better iButtonKey encapsulation * Fix crash * Load key code boilerplate * More load key code boilerplate * Minor code cleanup * Implement loading and saving DS1990 keys * Implement the Info scene * Implement loading & saving for DS1992 * Implement read error scene stub * Implement delete confirmation screen * Better error messages (protocol-dependent) * Minor old code cleanup * Remove iButtonDevice, add command callback to iButtonSlave * Implement draft emulation for DS1990 * Better emulation for DS1990 * Initial emulation implementation for DS1992 * Better common command definitions * Use common submenu callback, add protocol list * Improve ViewData screen * Improve scene_add_type * Add stubs for write functionality * Improve naming consistency * Implement writing a DS1992 onto another one * Improve DS1992 write code * Improve DS1992 write code once more * Prepare write_blank for DS1990, delete ibutton_writer * Implement writing DS1990 onto blanks * Fix reading DS1990 * Partially implement writing DS1992 onto blanks * Implement GUI for writing keys * Implement GUI for emulating keys * Reduce memory usage for pretty_format * Automatically truncate data more than 256 bytes * Initial implementation of DS1996 (not tested) * Fix crash due to missing virtual function * Improve emulation code * Improve DS1992 emulation code * Correct return value for onewire_slave_send * Correct return value for onewire_slave_receive * Implement emulation for DS1992 & DS1996 * Better constant names * Simplify & optimise the emulation code * Remove duplicate code * Add skip rom command emulation * Show loading animation for large keys * Implement manual adding & editing of keys * Use buffered file streams to speed up saving & loading * Reset key name before adding a new one * Sync a buffered file stream before saving * Use the DSGeneric protocol as a fallback option * Implement emulation via RPC * Refactor iButton code in preparation for comparator keys * Refactor iButton code in preparation for comparator keys once more * Make some functions static * Make protocols not rely on one_wire classes * Improve ProtocolDict usage * Improve ProtocolDict usage more * Implement reading Metakom & Cyfral keys * Rename some files * Better file structure * Implement a unified interface for misc protocols * Implement a unified interface for dallas protocols * Concrete types for Dallas protocols * Implement a unified interface for all key types * Improved type naming * Improved private types * Proper types in protocol definitions * Implement emulation for Cyfral & Metakom keys * Implement save&load for Metakom & Cyfral keys * Better type names * Rename files, better names * Allocate iButtonProtocols like a normal class * Reset the key each time the start scene is selected * Improve comments and constants * Add ibutton_protocols to SDK headers * Add ibutton_key to SDK headers * Add ibutton_key to SDK headers * Implement reading via cli * Implement emulation via cli * Implement writing Dallas blanks via cli * Correctly revert the editing if cancelled by the user * Correct committing mishap * Elide the long text on the info screen * Change key name for data in Misc keys * Update iButtonFileFormat.md * Remember the key's folder * Save menu position in ReadKeyMenu and SavedKeyMenu * Correct use of preselected path in file browser Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
2023-03-02 16:23:33 +03:00
parent 4359e2eaa9
commit 806428efeb
91 changed files with 3826 additions and 2166 deletions
--- a/lib/one_wire/ibutton/protocols/misc/protocol_cyfral.c
+++ b/lib/one_wire/ibutton/protocols/misc/protocol_cyfral.c
@@ -0,0 +1,352 @@
+#include <furi.h>
+#include <furi_hal.h>
+
+#include "protocol_cyfral.h"
+
+#define CYFRAL_DATA_SIZE sizeof(uint16_t)
+#define CYFRAL_PERIOD (125 * furi_hal_cortex_instructions_per_microsecond())
+#define CYFRAL_0_LOW (CYFRAL_PERIOD * 0.66f)
+#define CYFRAL_0_HI (CYFRAL_PERIOD * 0.33f)
+#define CYFRAL_1_LOW (CYFRAL_PERIOD * 0.33f)
+#define CYFRAL_1_HI (CYFRAL_PERIOD * 0.66f)
+
+#define CYFRAL_MAX_PERIOD_US 230
+
+typedef enum {
+    CYFRAL_BIT_WAIT_FRONT_HIGH,
+    CYFRAL_BIT_WAIT_FRONT_LOW,
+} CyfralBitState;
+
+typedef enum {
+    CYFRAL_WAIT_START_NIBBLE,
+    CYFRAL_READ_NIBBLE,
+    CYFRAL_READ_STOP_NIBBLE,
+} CyfralState;
+
+typedef struct {
+    CyfralState state;
+    CyfralBitState bit_state;
+
+    // high + low period time
+    uint32_t period_time;
+    // temporary nibble storage
+    uint8_t nibble;
+    // data valid flag
+    // MUST be checked only in READ_STOP_NIBBLE state
+    bool data_valid;
+    // nibble index, we expect 8 nibbles
+    uint8_t index;
+    // bit index in nibble, 4 bit per nibble
+    uint8_t bit_index;
+    // max period, 230us x clock per us
+    uint32_t max_period;
+} ProtocolCyfralDecoder;
+
+typedef struct {
+    uint32_t data;
+    uint32_t index;
+} ProtocolCyfralEncoder;
+
+typedef struct {
+    uint16_t data;
+
+    ProtocolCyfralDecoder decoder;
+    ProtocolCyfralEncoder encoder;
+} ProtocolCyfral;
+
+static void* protocol_cyfral_alloc(void) {
+    ProtocolCyfral* proto = malloc(sizeof(ProtocolCyfral));
+    return (void*)proto;
+}
+
+static void protocol_cyfral_free(ProtocolCyfral* proto) {
+    free(proto);
+}
+
+static uint8_t* protocol_cyfral_get_data(ProtocolCyfral* proto) {
+    return (uint8_t*)&proto->data;
+}
+
+static void protocol_cyfral_decoder_start(ProtocolCyfral* proto) {
+    ProtocolCyfralDecoder* cyfral = &proto->decoder;
+
+    cyfral->state = CYFRAL_WAIT_START_NIBBLE;
+    cyfral->bit_state = CYFRAL_BIT_WAIT_FRONT_LOW;
+    cyfral->period_time = 0;
+    cyfral->bit_index = 0;
+    cyfral->index = 0;
+    cyfral->nibble = 0;
+    cyfral->data_valid = true;
+    cyfral->max_period = CYFRAL_MAX_PERIOD_US * furi_hal_cortex_instructions_per_microsecond();
+
+    proto->data = 0;
+}
+
+static bool protocol_cyfral_decoder_process_bit(
+    ProtocolCyfralDecoder* cyfral,
+    bool polarity,
+    uint32_t length,
+    bool* bit_ready,
+    bool* bit_value) {
+    bool result = true;
+    *bit_ready = false;
+
+    // bit start from low
+    switch(cyfral->bit_state) {
+    case CYFRAL_BIT_WAIT_FRONT_LOW:
+        if(polarity == true) {
+            cyfral->period_time += length;
+
+            *bit_ready = true;
+            if(cyfral->period_time <= cyfral->max_period) {
+                if((cyfral->period_time / 2) > length) {
+                    *bit_value = false;
+                } else {
+                    *bit_value = true;
+                }
+            } else {
+                result = false;
+            }
+
+            cyfral->bit_state = CYFRAL_BIT_WAIT_FRONT_HIGH;
+        } else {
+            result = false;
+        }
+        break;
+    case CYFRAL_BIT_WAIT_FRONT_HIGH:
+        if(polarity == false) {
+            cyfral->period_time = length;
+            cyfral->bit_state = CYFRAL_BIT_WAIT_FRONT_LOW;
+        } else {
+            result = false;
+        }
+        break;
+    }
+
+    return result;
+}
+
+static bool protocol_cyfral_decoder_feed(ProtocolCyfral* proto, bool level, uint32_t duration) {
+    ProtocolCyfralDecoder* cyfral = &proto->decoder;
+
+    bool bit_ready;
+    bool bit_value;
+    bool decoded = false;
+
+    switch(cyfral->state) {
+    case CYFRAL_WAIT_START_NIBBLE:
+        // wait for start word
+        if(protocol_cyfral_decoder_process_bit(cyfral, level, duration, &bit_ready, &bit_value)) {
+            if(bit_ready) {
+                cyfral->nibble = ((cyfral->nibble << 1) | bit_value) & 0x0F;
+                if(cyfral->nibble == 0b0001) {
+                    cyfral->nibble = 0;
+                    cyfral->state = CYFRAL_READ_NIBBLE;
+                }
+            }
+        } else {
+            protocol_cyfral_decoder_start(proto);
+        }
+
+        break;
+    case CYFRAL_READ_NIBBLE:
+        // read nibbles
+        if(protocol_cyfral_decoder_process_bit(cyfral, level, duration, &bit_ready, &bit_value)) {
+            if(bit_ready) {
+                cyfral->nibble = (cyfral->nibble << 1) | bit_value;
+
+                cyfral->bit_index++;
+
+                //convert every nibble to 2-bit index
+                if(cyfral->bit_index == 4) {
+                    switch(cyfral->nibble) {
+                    case 0b1110:
+                        proto->data = (proto->data << 2) | 0b11;
+                        break;
+                    case 0b1101:
+                        proto->data = (proto->data << 2) | 0b10;
+                        break;
+                    case 0b1011:
+                        proto->data = (proto->data << 2) | 0b01;
+                        break;
+                    case 0b0111:
+                        proto->data = (proto->data << 2) | 0b00;
+                        break;
+                    default:
+                        cyfral->data_valid = false;
+                        break;
+                    }
+
+                    cyfral->nibble = 0;
+                    cyfral->bit_index = 0;
+                    cyfral->index++;
+                }
+
+                // successfully read 8 nibbles
+                if(cyfral->index == 8) {
+                    cyfral->state = CYFRAL_READ_STOP_NIBBLE;
+                }
+            }
+        } else {
+            protocol_cyfral_decoder_start(proto);
+        }
+        break;
+    case CYFRAL_READ_STOP_NIBBLE:
+        // read stop nibble
+        if(protocol_cyfral_decoder_process_bit(cyfral, level, duration, &bit_ready, &bit_value)) {
+            if(bit_ready) {
+                cyfral->nibble = ((cyfral->nibble << 1) | bit_value) & 0x0F;
+                cyfral->bit_index++;
+
+                switch(cyfral->bit_index) {
+                case 0:
+                case 1:
+                case 2:
+                case 3:
+                    break;
+                case 4:
+                    if(cyfral->nibble == 0b0001) {
+                        // validate data
+                        if(cyfral->data_valid) {
+                            decoded = true;
+                        } else {
+                            protocol_cyfral_decoder_start(proto);
+                        }
+                    } else {
+                        protocol_cyfral_decoder_start(proto);
+                    }
+                    break;
+                default:
+                    protocol_cyfral_decoder_start(proto);
+                    break;
+                }
+            }
+        } else {
+            protocol_cyfral_decoder_start(proto);
+        }
+        break;
+    }
+
+    return decoded;
+}
+
+static uint32_t protocol_cyfral_encoder_encode(const uint16_t data) {
+    uint32_t value = 0;
+    for(int8_t i = 0; i <= 7; i++) {
+        switch((data >> (i * 2)) & 0b00000011) {
+        case 0b11:
+            value = value << 4;
+            value += 0b00000111;
+            break;
+        case 0b10:
+            value = value << 4;
+            value += 0b00001011;
+            break;
+        case 0b01:
+            value = value << 4;
+            value += 0b00001101;
+            break;
+        case 0b00:
+            value = value << 4;
+            value += 0b00001110;
+            break;
+        default:
+            break;
+        }
+    }
+
+    return value;
+}
+
+static bool protocol_cyfral_encoder_start(ProtocolCyfral* proto) {
+    proto->encoder.index = 0;
+    proto->encoder.data = protocol_cyfral_encoder_encode(proto->data);
+    return true;
+}
+
+static LevelDuration protocol_cyfral_encoder_yield(ProtocolCyfral* proto) {
+    LevelDuration result;
+
+    if(proto->encoder.index < 8) {
+        // start word (0b0001)
+        switch(proto->encoder.index) {
+        case 0:
+            result = level_duration_make(false, CYFRAL_0_LOW); //-V1037
+            break;
+        case 1:
+            result = level_duration_make(true, CYFRAL_0_HI); //-V1037
+            break;
+        case 2:
+            result = level_duration_make(false, CYFRAL_0_LOW);
+            break;
+        case 3:
+            result = level_duration_make(true, CYFRAL_0_HI);
+            break;
+        case 4:
+            result = level_duration_make(false, CYFRAL_0_LOW);
+            break;
+        case 5:
+            result = level_duration_make(true, CYFRAL_0_HI);
+            break;
+        case 6:
+            result = level_duration_make(false, CYFRAL_1_LOW);
+            break;
+        case 7:
+            result = level_duration_make(true, CYFRAL_1_HI);
+            break;
+        }
+    } else {
+        // data
+        uint8_t data_start_index = proto->encoder.index - 8;
+        bool clock_polarity = (data_start_index) % 2;
+        uint8_t bit_index = (data_start_index) / 2;
+        bool bit_value = ((proto->encoder.data >> bit_index) & 1);
+
+        if(!clock_polarity) {
+            if(bit_value) {
+                result = level_duration_make(false, CYFRAL_1_LOW);
+            } else {
+                result = level_duration_make(false, CYFRAL_0_LOW);
+            }
+        } else {
+            if(bit_value) {
+                result = level_duration_make(true, CYFRAL_1_HI);
+            } else {
+                result = level_duration_make(true, CYFRAL_0_HI);
+            }
+        }
+    }
+
+    proto->encoder.index++;
+    if(proto->encoder.index >= (9 * 4 * 2)) {
+        proto->encoder.index = 0;
+    }
+
+    return result;
+}
+
+static void protocol_cyfral_render_brief_data(ProtocolCyfral* proto, FuriString* result) {
+    for(size_t i = 0; i < CYFRAL_DATA_SIZE; ++i) {
+        furi_string_cat_printf(result, "%02X ", ((uint8_t*)&proto->data)[i]);
+    }
+}
+
+const ProtocolBase ibutton_protocol_misc_cyfral = {
+    .name = "Cyfral",
+    .manufacturer = "Cyfral",
+    .data_size = CYFRAL_DATA_SIZE,
+    .alloc = (ProtocolAlloc)protocol_cyfral_alloc,
+    .free = (ProtocolFree)protocol_cyfral_free,
+    .get_data = (ProtocolGetData)protocol_cyfral_get_data,
+    .decoder =
+        {
+            .start = (ProtocolDecoderStart)protocol_cyfral_decoder_start,
+            .feed = (ProtocolDecoderFeed)protocol_cyfral_decoder_feed,
+        },
+    .encoder =
+        {
+            .start = (ProtocolEncoderStart)protocol_cyfral_encoder_start,
+            .yield = (ProtocolEncoderYield)protocol_cyfral_encoder_yield,
+        },
+    .render_brief_data = (ProtocolRenderData)protocol_cyfral_render_brief_data,
+};