Mirror/Momentum-Firmware
1
0
Fork 0
mirror of https://github.com/Next-Flip/Momentum-Firmware.git synced 2026-05-15 04:19:26 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'upstream/dev' into emv-fixes

Browse Source
This commit is contained in:
Methodius
2024-02-11 00:09:52 +09:00
parent ab609bc294 8a86571068
commit 1e09034e23
78 changed files with 3795 additions and 1309 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
applications/main/nfc/api/gallagher/gallagher_util.c Normal file
View File

@@ -0,0 +1,59 @@
/* gallagher_util.c - Utilities for parsing Gallagher cards (New Zealand).
* Author: Nick Mooney (nick@mooney.nz)
*
* Reference: https://github.com/megabug/gallagher-research
*/
#include "gallagher_util.h"
#define GALLAGHER_CREDENTIAL_SECTOR 15
/* The Gallagher obfuscation algorithm is a 256-byte substitution table. The below array is generated from
* https://github.com/megabug/gallagher-research/blob/master/formats/cardholder/substitution-table.bin.
*/
const uint8_t GALLAGHER_DECODE_TABLE[256] = {
0x2f, 0x6e, 0xdd, 0xdf, 0x1d, 0xf, 0xb0, 0x76, 0xad, 0xaf, 0x7f, 0xbb, 0x77, 0x85, 0x11,
0x6d, 0xf4, 0xd2, 0x84, 0x42, 0xeb, 0xf7, 0x34, 0x55, 0x4a, 0x3a, 0x10, 0x71, 0xe7, 0xa1,
0x62, 0x1a, 0x3e, 0x4c, 0x14, 0xd3, 0x5e, 0xb2, 0x7d, 0x56, 0xbc, 0x27, 0x82, 0x60, 0xe3,
0xae, 0x1f, 0x9b, 0xaa, 0x2b, 0x95, 0x49, 0x73, 0xe1, 0x92, 0x79, 0x91, 0x38, 0x6c, 0x19,
0xe, 0xa9, 0xe2, 0x8d, 0x66, 0xc7, 0x5a, 0xf5, 0x1c, 0x80, 0x99, 0xbe, 0x4e, 0x41, 0xf0,
0xe8, 0xa6, 0x20, 0xab, 0x87, 0xc8, 0x1e, 0xa0, 0x59, 0x7b, 0xc, 0xc3, 0x3c, 0x61, 0xcc,
0x40, 0x9e, 0x6, 0x52, 0x1b, 0x32, 0x8c, 0x12, 0x93, 0xbf, 0xef, 0x3b, 0x25, 0xd, 0xc2,
0x88, 0xd1, 0xe0, 0x7, 0x2d, 0x70, 0xc6, 0x29, 0x6a, 0x4d, 0x47, 0x26, 0xa3, 0xe4, 0x8b,
0xf6, 0x97, 0x2c, 0x5d, 0x3d, 0xd7, 0x96, 0x28, 0x2, 0x8, 0x30, 0xa7, 0x22, 0xc9, 0x65,
0xf8, 0xb7, 0xb4, 0x8a, 0xca, 0xb9, 0xf2, 0xd0, 0x17, 0xff, 0x46, 0xfb, 0x9a, 0xba, 0x8f,
0xb6, 0x69, 0x68, 0x8e, 0x21, 0x6f, 0xc4, 0xcb, 0xb3, 0xce, 0x51, 0xd4, 0x81, 0x0, 0x2e,
0x9c, 0x74, 0x63, 0x45, 0xd9, 0x16, 0x35, 0x5f, 0xed, 0x78, 0x9f, 0x1, 0x48, 0x4, 0xc1,
0x33, 0xd6, 0x4f, 0x94, 0xde, 0x31, 0x9d, 0xa, 0xac, 0x18, 0x4b, 0xcd, 0x98, 0xb8, 0x37,
0xa2, 0x83, 0xec, 0x3, 0xd8, 0xda, 0xe5, 0x7a, 0x6b, 0x53, 0xd5, 0x15, 0xa4, 0x43, 0xe9,
0x90, 0x67, 0x58, 0xc0, 0xa5, 0xfa, 0x2a, 0xb1, 0x75, 0x50, 0x39, 0x5c, 0xe6, 0xdc, 0x89,
0xfc, 0xcf, 0xfe, 0xf9, 0x57, 0x54, 0x64, 0xa8, 0xee, 0x23, 0xb, 0xf1, 0xea, 0xfd, 0xdb,
0xbd, 0x9, 0xb5, 0x5b, 0x5, 0x86, 0x13, 0xf3, 0x24, 0xc5, 0x3f, 0x44, 0x72, 0x7c, 0x7e,
0x36};
// The second block of a Gallagher credential sector is the literal
// "www.cardax.com " (note two padding spaces)
const uint8_t GALLAGHER_CARDAX_ASCII[MF_CLASSIC_BLOCK_SIZE] =
{'w', 'w', 'w', '.', 'c', 'a', 'r', 'd', 'a', 'x', '.', 'c', 'o', 'm', ' ', ' '};
/* Precondition: cardholder_data_obfuscated points to at least 8 safe-to-read bytes of memory.
*/
void gallagher_deobfuscate_and_parse_credential(
GallagherCredential* credential,
const uint8_t* cardholder_data_obfuscated) {
uint8_t cardholder_data_deobfuscated[8];
for(int i = 0; i < 8; i++) {
cardholder_data_deobfuscated[i] = GALLAGHER_DECODE_TABLE[cardholder_data_obfuscated[i]];
}
// Pull out values from the deobfuscated data
credential->region = (cardholder_data_deobfuscated[3] >> 1) & 0x0F;
credential->facility = ((uint16_t)(cardholder_data_deobfuscated[5] & 0x0F) << 12) +
((uint16_t)cardholder_data_deobfuscated[1] << 4) +
(((uint16_t)cardholder_data_deobfuscated[7] >> 4) & 0x0F);
credential->card = ((uint32_t)cardholder_data_deobfuscated[0] << 16) +
((uint32_t)(cardholder_data_deobfuscated[4] & 0x1F) << 11) +
((uint32_t)cardholder_data_deobfuscated[2] << 3) +
(((uint32_t)cardholder_data_deobfuscated[3] >> 5) & 0x07);
credential->issue = cardholder_data_deobfuscated[7] & 0x0F;
}

33
applications/main/nfc/api/gallagher/gallagher_util.h Normal file
View File

@@ -0,0 +1,33 @@
/* gallagher_util.h - Utilities for parsing Gallagher cards (New Zealand).
* Author: Nick Mooney (nick@mooney.nz)
*
* Reference: https://github.com/megabug/gallagher-research
*/
#pragma once
#include <lib/nfc/protocols/mf_classic/mf_classic.h>
#define GALLAGHER_CREDENTIAL_SECTOR 15
#ifdef __cplusplus
extern "C" {
#endif
extern const uint8_t GALLAGHER_DECODE_TABLE[256];
extern const uint8_t GALLAGHER_CARDAX_ASCII[MF_CLASSIC_BLOCK_SIZE];
typedef struct GallagherCredential {
uint8_t region;
uint8_t issue;
uint16_t facility;
uint32_t card;
} GallagherCredential;
void gallagher_deobfuscate_and_parse_credential(
GallagherCredential* credential,
const uint8_t* cardholder_data_obfuscated);
#ifdef __cplusplus
}
#endif

9
applications/main/nfc/api/nfc_app_api_interface.h Normal file
View File

@@ -0,0 +1,9 @@
#pragma once
#include <flipper_application/api_hashtable/api_hashtable.h>
/*
* Resolver interface with private application's symbols.
* Implementation is contained in app_api_table.c
*/
extern const ElfApiInterface* const nfc_application_api_interface;

27
applications/main/nfc/api/nfc_app_api_table.cpp Normal file
View File

@@ -0,0 +1,27 @@
#include <flipper_application/api_hashtable/api_hashtable.h>
#include <flipper_application/api_hashtable/compilesort.hpp>
/*
* This file contains an implementation of a symbol table
* with private app's symbols. It is used by composite API resolver
* to load plugins that use internal application's APIs.
*/
#include "nfc_app_api_table_i.h"
static_assert(!has_hash_collisions(nfc_app_api_table), "Detected API method hash collision!");
constexpr HashtableApiInterface nfc_application_hashtable_api_interface{
{
.api_version_major = 0,
.api_version_minor = 0,
/* generic resolver using pre-sorted array */
.resolver_callback = &elf_resolve_from_hashtable,
},
/* pointers to application's API table boundaries */
.table_cbegin = nfc_app_api_table.cbegin(),
.table_cend = nfc_app_api_table.cend(),
};
/* Casting to generic resolver to use in Composite API resolver */
extern "C" const ElfApiInterface* const nfc_application_api_interface =
&nfc_application_hashtable_api_interface;

13
applications/main/nfc/api/nfc_app_api_table_i.h Normal file
View File

@@ -0,0 +1,13 @@
#include "gallagher/gallagher_util.h"
/*
* A list of app's private functions and objects to expose for plugins.
* It is used to generate a table of symbols for import resolver to use.
* TBD: automatically generate this table from app's header files
*/
static constexpr auto nfc_app_api_table = sort(create_array_t<sym_entry>(
API_METHOD(
gallagher_deobfuscate_and_parse_credential,
void,
(GallagherCredential * credential, const uint8_t* cardholder_data_obfuscated)),
API_VARIABLE(GALLAGHER_CARDAX_ASCII, const uint8_t*)));

38
applications/main/nfc/application.fam
View File

@@ -9,7 +9,7 @@ App(
order=30,
resources="resources",
sources=[
"*.c",
"*.c*",
"!plugins",
"!nfc_cli.c",
],
@@ -29,6 +29,33 @@ App(
sources=["plugins/supported_cards/all_in_one.c"],
)
App(
appid="microel_parser",
apptype=FlipperAppType.PLUGIN,
entry_point="microel_plugin_ep",
targets=["f7"],
requires=["nfc"],
sources=["plugins/supported_cards/microel.c"],
)
App(
appid="mizip_parser",
apptype=FlipperAppType.PLUGIN,
entry_point="mizip_plugin_ep",
targets=["f7"],
requires=["nfc"],
sources=["plugins/supported_cards/mizip.c"],
)
App(
appid="hi_parser",
apptype=FlipperAppType.PLUGIN,
entry_point="hi_plugin_ep",
targets=["f7"],
requires=["nfc"],
sources=["plugins/supported_cards/hi.c"],
)
App(
appid="opal_parser",
apptype=FlipperAppType.PLUGIN,
@@ -155,6 +182,15 @@ App(
sources=["plugins/supported_cards/zolotaya_korona_online.c"],
)
App(
appid="gallagher_parser",
apptype=FlipperAppType.PLUGIN,
entry_point="gallagher_plugin_ep",
targets=["f7"],
requires=["nfc"],
sources=["plugins/supported_cards/gallagher.c"],
)
App(
appid="clipper_parser",
apptype=FlipperAppType.PLUGIN,

42
applications/main/nfc/helpers/nfc_supported_cards.c
View File

@@ -1,9 +1,11 @@
#include "nfc_supported_cards.h"
#include "../api/nfc_app_api_interface.h"
#include "../plugins/supported_cards/nfc_supported_card_plugin.h"
#include <flipper_application/flipper_application.h>
#include <flipper_application/plugins/plugin_manager.h>
#include <flipper_application/plugins/composite_resolver.h>
#include <loader/firmware_api/firmware_api.h>
#include <furi.h>
@@ -45,6 +47,7 @@ typedef struct {
} NfcSupportedCardsLoadContext;
struct NfcSupportedCards {
CompositeApiResolver* api_resolver;
NfcSupportedCardsPluginCache_t plugins_cache_arr;
NfcSupportedCardsLoadState load_state;
NfcSupportedCardsLoadContext* load_context;
@@ -52,6 +55,11 @@ struct NfcSupportedCards {
NfcSupportedCards* nfc_supported_cards_alloc() {
NfcSupportedCards* instance = malloc(sizeof(NfcSupportedCards));
instance->api_resolver = composite_api_resolver_alloc();
composite_api_resolver_add(instance->api_resolver, firmware_api_interface);
composite_api_resolver_add(instance->api_resolver, nfc_application_api_interface);
NfcSupportedCardsPluginCache_init(instance->plugins_cache_arr);
return instance;
@@ -67,8 +75,9 @@ void nfc_supported_cards_free(NfcSupportedCards* instance) {
NfcSupportedCardsPluginCache* plugin_cache = NfcSupportedCardsPluginCache_ref(iter);
furi_string_free(plugin_cache->path);
}
NfcSupportedCardsPluginCache_clear(instance->plugins_cache_arr);
composite_api_resolver_free(instance->api_resolver);
free(instance);
}
@@ -100,15 +109,17 @@ static void nfc_supported_cards_load_context_free(NfcSupportedCardsLoadContext*
free(instance);
}
static const NfcSupportedCardsPlugin*
nfc_supported_cards_get_plugin(NfcSupportedCardsLoadContext* instance, FuriString* path) {
static const NfcSupportedCardsPlugin* nfc_supported_cards_get_plugin(
NfcSupportedCardsLoadContext* instance,
const FuriString* path,
const ElfApiInterface* api_interface) {
furi_assert(instance);
furi_assert(path);
const NfcSupportedCardsPlugin* plugin = NULL;
do {
if(instance->app) flipper_application_free(instance->app);
instance->app = flipper_application_alloc(instance->storage, firmware_api_interface);
instance->app = flipper_application_alloc(instance->storage, api_interface);
if(flipper_application_preload(instance->app, furi_string_get_cstr(path)) !=
FlipperApplicationPreloadStatusSuccess)
break;
@@ -129,8 +140,9 @@ static const NfcSupportedCardsPlugin*
return plugin;
}
static const NfcSupportedCardsPlugin*
nfc_supported_cards_get_next_plugin(NfcSupportedCardsLoadContext* instance) {
static const NfcSupportedCardsPlugin* nfc_supported_cards_get_next_plugin(
NfcSupportedCardsLoadContext* instance,
const ElfApiInterface* api_interface) {
const NfcSupportedCardsPlugin* plugin = NULL;
do {
@@ -145,7 +157,7 @@ static const NfcSupportedCardsPlugin*
path_concat(NFC_SUPPORTED_CARDS_PLUGINS_PATH, instance->file_name, instance->file_path);
plugin = nfc_supported_cards_get_plugin(instance, instance->file_path);
plugin = nfc_supported_cards_get_plugin(instance, instance->file_path, api_interface);
} while(plugin == NULL); //-V654
return plugin;
@@ -162,8 +174,10 @@ void nfc_supported_cards_load_cache(NfcSupportedCards* instance) {
instance->load_context = nfc_supported_cards_load_context_alloc();
while(true) {
const ElfApiInterface* api_interface =
composite_api_resolver_get(instance->api_resolver);
const NfcSupportedCardsPlugin* plugin =
nfc_supported_cards_get_next_plugin(instance->load_context);
nfc_supported_cards_get_next_plugin(instance->load_context, api_interface);
if(plugin == NULL) break; //-V547
NfcSupportedCardsPluginCache plugin_cache = {}; //-V779
@@ -216,8 +230,10 @@ bool nfc_supported_cards_read(NfcSupportedCards* instance, NfcDevice* device, Nf
if(plugin_cache->protocol != protocol) continue;
if((plugin_cache->feature & NfcSupportedCardsPluginFeatureHasRead) == 0) continue;
const NfcSupportedCardsPlugin* plugin =
nfc_supported_cards_get_plugin(instance->load_context, plugin_cache->path);
const ElfApiInterface* api_interface =
composite_api_resolver_get(instance->api_resolver);
const NfcSupportedCardsPlugin* plugin = nfc_supported_cards_get_plugin(
instance->load_context, plugin_cache->path, api_interface);
if(plugin == NULL) continue;
if(plugin->verify) {
@@ -262,8 +278,10 @@ bool nfc_supported_cards_parse(
if(plugin_cache->protocol != protocol) continue;
if((plugin_cache->feature & NfcSupportedCardsPluginFeatureHasParse) == 0) continue;
const NfcSupportedCardsPlugin* plugin =
nfc_supported_cards_get_plugin(instance->load_context, plugin_cache->path);
const ElfApiInterface* api_interface =
composite_api_resolver_get(instance->api_resolver);
const NfcSupportedCardsPlugin* plugin = nfc_supported_cards_get_plugin(
instance->load_context, plugin_cache->path, api_interface);
if(plugin == NULL) continue;
if(plugin->parse) {

3
applications/main/nfc/helpers/protocol_support/mf_classic/mf_classic.c
View File

@@ -199,6 +199,9 @@ static bool nfc_scene_read_menu_on_event_mf_classic(NfcApp* instance, SceneManag
} else if(event.event == SubmenuIndexDictAttack) {
scene_manager_next_scene(instance->scene_manager, NfcSceneMfClassicDictAttack);
consumed = true;
} else if(event.event == SubmenuIndexCommonEdit) {
scene_manager_next_scene(instance->scene_manager, NfcSceneSetUid);
consumed = true;
}
}

11
applications/main/nfc/helpers/protocol_support/mf_ultralight/mf_ultralight.c
View File

@@ -266,16 +266,21 @@ static void nfc_scene_emulate_on_enter_mf_ultralight(NfcApp* instance) {
static bool nfc_scene_read_and_saved_menu_on_event_mf_ultralight(
NfcApp* instance,
SceneManagerEvent event) {
bool consumed = false;
if(event.type == SceneManagerEventTypeCustom) {
if(event.event == SubmenuIndexUnlock) {
scene_manager_next_scene(instance->scene_manager, NfcSceneMfUltralightUnlockMenu);
return true;
consumed = true;
} else if(event.event == SubmenuIndexWrite) {
scene_manager_next_scene(instance->scene_manager, NfcSceneMfUltralightWrite);
return true;
consumed = true;
} else if(event.event == SubmenuIndexCommonEdit) {
scene_manager_next_scene(instance->scene_manager, NfcSceneSetUid);
consumed = true;
}
}
return false;
return consumed;
}
const NfcProtocolSupportBase nfc_protocol_support_mf_ultralight = {

9
applications/main/nfc/helpers/protocol_support/nfc_protocol_support.c
View File

@@ -233,6 +233,15 @@ static void nfc_protocol_support_scene_read_menu_on_enter(NfcApp* instance) {
nfc_protocol_support_common_submenu_callback,
instance);
if(scene_manager_has_previous_scene(instance->scene_manager, NfcSceneGenerateInfo)) {
submenu_add_item(
submenu,
"Change UID",
SubmenuIndexCommonEdit,
nfc_protocol_support_common_submenu_callback,
instance);
}
if(nfc_protocol_support_has_feature(protocol, NfcProtocolFeatureEmulateUid)) {
submenu_add_item(
submenu,

64
applications/main/nfc/helpers/slix_unlock.c Normal file
View File

@@ -0,0 +1,64 @@
#include "slix_unlock.h"
#include <furi/furi.h>
#define SLIX_UNLOCK_PASSWORD_NUM_MAX (2)
struct SlixUnlock {
SlixUnlockMethod method;
SlixPassword password_arr[SLIX_UNLOCK_PASSWORD_NUM_MAX];
size_t password_arr_len;
size_t password_idx;
};
static const SlixPassword tonie_box_pass_arr[] = {0x5B6EFD7F, 0x0F0F0F0F};
SlixUnlock* slix_unlock_alloc() {
SlixUnlock* instance = malloc(sizeof(SlixUnlock));
return instance;
}
void slix_unlock_free(SlixUnlock* instance) {
furi_assert(instance);
free(instance);
}
void slix_unlock_reset(SlixUnlock* instance) {
furi_assert(instance);
memset(instance, 0, sizeof(SlixUnlock));
}
void slix_unlock_set_method(SlixUnlock* instance, SlixUnlockMethod method) {
furi_assert(instance);
instance->method = method;
if(method == SlixUnlockMethodTonieBox) {
instance->password_arr_len = COUNT_OF(tonie_box_pass_arr);
memcpy(instance->password_arr, tonie_box_pass_arr, sizeof(tonie_box_pass_arr));
}
}
void slix_unlock_set_password(SlixUnlock* instance, SlixPassword password) {
furi_assert(instance);
furi_assert(instance->method == SlixUnlockMethodManual);
instance->password_arr[0] = password;
instance->password_arr_len = 1;
}
bool slix_unlock_get_next_password(SlixUnlock* instance, SlixPassword* password) {
furi_assert(instance);
furi_assert(password);
bool password_set = false;
if(instance->password_arr_len) {
*password = instance->password_arr[instance->password_idx++];
instance->password_idx %= instance->password_arr_len;
password_set = true;
}
return password_set;
}

30
applications/main/nfc/helpers/slix_unlock.h Normal file
View File

@@ -0,0 +1,30 @@
#pragma once
#include <nfc/protocols/slix/slix.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef enum {
SlixUnlockMethodManual,
SlixUnlockMethodTonieBox,
} SlixUnlockMethod;
typedef struct SlixUnlock SlixUnlock;
SlixUnlock* slix_unlock_alloc();
void slix_unlock_free(SlixUnlock* instance);
void slix_unlock_reset(SlixUnlock* instance);
void slix_unlock_set_method(SlixUnlock* instance, SlixUnlockMethod method);
void slix_unlock_set_password(SlixUnlock* instance, SlixPassword password);
bool slix_unlock_get_next_password(SlixUnlock* instance, SlixPassword* password);
#ifdef __cplusplus
}
#endif

2
applications/main/nfc/nfc_app.c
View File

@@ -51,6 +51,7 @@ NfcApp* nfc_app_alloc() {
instance->nfc = nfc_alloc();
instance->mf_ul_auth = mf_ultralight_auth_alloc();
instance->slix_unlock = slix_unlock_alloc();
instance->mfc_key_cache = mf_classic_key_cache_alloc();
instance->nfc_supported_cards = nfc_supported_cards_alloc();
@@ -141,6 +142,7 @@ void nfc_app_free(NfcApp* instance) {
nfc_free(instance->nfc);
mf_ultralight_auth_free(instance->mf_ul_auth);
slix_unlock_free(instance->slix_unlock);
mf_classic_key_cache_free(instance->mfc_key_cache);
nfc_supported_cards_free(instance->nfc_supported_cards);

2
applications/main/nfc/nfc_app_i.h
View File

@@ -33,6 +33,7 @@
#include "helpers/nfc_emv_parser.h"
#include "helpers/mf_classic_key_cache.h"
#include "helpers/nfc_supported_cards.h"
#include "helpers/slix_unlock.h"
#include <dialogs/dialogs.h>
#include <storage/storage.h>
@@ -130,6 +131,7 @@ struct NfcApp {
NfcListener* listener;
MfUltralightAuth* mf_ul_auth;
SlixUnlock* slix_unlock;
NfcMfClassicDictAttackContext nfc_dict_context;
Mfkey32Logger* mfkey32_logger;
MfUserDict* mf_user_dict;

2
applications/main/nfc/plugins/supported_cards/aime.c
View File

@@ -67,7 +67,7 @@ static bool aime_read(Nfc* nfc, NfcDevice* device) {
nfc_device_set_data(device, NfcProtocolMfClassic, data);
is_read = mf_classic_is_card_read(data);
is_read = (error == MfClassicErrorNone);
} while(false);
mf_classic_free(data);

87
applications/main/nfc/plugins/supported_cards/gallagher.c Normal file
View File

@@ -0,0 +1,87 @@
/* gallagher.c - NFC supported cards plugin for Gallagher access control cards (New Zealand).
* Author: Nick Mooney (nick@mooney.nz)
*
* Reference: https://github.com/megabug/gallagher-research
*/
#include "nfc_supported_card_plugin.h"
#include "../../api/gallagher/gallagher_util.h"
#include <flipper_application/flipper_application.h>
#include <nfc/protocols/mf_classic/mf_classic.h>
#include <nfc/protocols/mf_classic/mf_classic_poller_sync.h>
#include <nfc/helpers/nfc_util.h>
static bool gallagher_parse(const NfcDevice* device, FuriString* parsed_data) {
furi_assert(device);
furi_assert(parsed_data);
const MfClassicData* data = nfc_device_get_data(device, NfcProtocolMfClassic);
if(!(data->type == MfClassicType1k || data->type == MfClassicType4k)) {
return false;
}
// It's possible for a single tag to contain multiple credentials,
// but this is currently unimplementecd.
const uint8_t credential_sector_start_block_number =
mf_classic_get_first_block_num_of_sector(GALLAGHER_CREDENTIAL_SECTOR);
// Test 1: The first 8 bytes and the second 8 bytes should be bitwise inverses.
const uint8_t* credential_block_start_ptr =
&data->block[credential_sector_start_block_number].data[0];
uint64_t cardholder_credential = nfc_util_bytes2num(credential_block_start_ptr, 8);
uint64_t cardholder_credential_inverse = nfc_util_bytes2num(credential_block_start_ptr + 8, 8);
// Due to endianness, this is testing the bytes in the wrong order,
// but the result still should be correct.
if(cardholder_credential != ~cardholder_credential_inverse) {
return false;
}
// Test 2: The contents of the second block should be equal to the GALLAGHER_CARDAX_ASCII constant.
const uint8_t* cardax_block_start_ptr =
&data->block[credential_sector_start_block_number + 1].data[0];
if(memcmp(cardax_block_start_ptr, GALLAGHER_CARDAX_ASCII, MF_CLASSIC_BLOCK_SIZE) != 0) {
return false;
}
// Deobfuscate the credential data
GallagherCredential credential;
gallagher_deobfuscate_and_parse_credential(&credential, credential_block_start_ptr);
char display_region = 'A';
// Per https://github.com/megabug/gallagher-research/blob/master/formats/cardholder/cardholder.md,
// regions are generally A-P.
if(credential.region < 16) {
display_region = display_region + (char)credential.region;
} else {
display_region = '?';
}
furi_string_cat_printf(
parsed_data,
"\e#Gallagher NZ\nFacility %c%u\nCard %lu (IL %u)",
display_region,
credential.facility,
credential.card,
credential.issue);
return true;
}
static const NfcSupportedCardsPlugin gallagher_plugin = {
.protocol = NfcProtocolMfClassic,
.verify = NULL,
.read = NULL,
.parse = gallagher_parse,
};
static const FlipperAppPluginDescriptor gallagher_plugin_descriptor = {
.appid = NFC_SUPPORTED_CARD_PLUGIN_APP_ID,
.ep_api_version = NFC_SUPPORTED_CARD_PLUGIN_API_VERSION,
.entry_point = &gallagher_plugin,
};
/* Plugin entry point */
const FlipperAppPluginDescriptor* gallagher_plugin_ep() {
return &gallagher_plugin_descriptor;
}

226
applications/main/nfc/plugins/supported_cards/hi.c Normal file
View File

@@ -0,0 +1,226 @@
#include "nfc_supported_card_plugin.h"
#include <flipper_application/flipper_application.h>
#include <nfc/nfc_device.h>
#include <nfc/helpers/nfc_util.h>
#include <nfc/protocols/mf_classic/mf_classic_poller_sync.h>
#include <stdint.h>
#define TAG "HI!"
#define KEY_LENGTH 6
#define HI_KEY_TO_GEN 5
#define UID_LENGTH 7
typedef struct {
uint64_t a;
uint64_t b;
} MfClassicKeyPair;
typedef struct {
MfClassicKeyPair* keys;
uint32_t verify_sector;
} HiCardConfig;
static MfClassicKeyPair hi_1k_keys[] = {
{.a = 0xa0a1a2a3a4a5, .b = 0x30871CF60CF1}, // 000
{.a = 0x000000000000, .b = 0x000000000000}, // 001
{.a = 0x000000000000, .b = 0x000000000000}, // 002
{.a = 0x000000000000, .b = 0x000000000000}, // 003
{.a = 0x000000000000, .b = 0x000000000000}, // 004
{.a = 0x42FFE4C76209, .b = 0x7B30CFD04CBD}, // 005
{.a = 0x01ED8145BDF8, .b = 0x92257F472FCE}, // 006
{.a = 0x7583A07D21A6, .b = 0x51CA6EA8EE26}, // 007
{.a = 0x1E10BF5D6A1D, .b = 0x87B9B9BFABA6}, // 008
{.a = 0xF9DB1B2B21BA, .b = 0x80A781F4134C}, // 009
{.a = 0x7F5283FACB72, .b = 0x73250009D75A}, // 010
{.a = 0xE48E86A03078, .b = 0xCFFBBF08A254}, // 011
{.a = 0x39AB26301F60, .b = 0xC71A6E532C83}, // 012
{.a = 0xAD656C6C639F, .b = 0xFD9819CBD20A}, // 013
{.a = 0xF0E15160DB3E, .b = 0x3F622D515ADD}, // 014
{.a = 0x03F44E033C42, .b = 0x61E897875F46}, // 015
};
//KDF
void hi_generate_key(uint8_t* uid, uint8_t keyA[5][KEY_LENGTH], uint8_t keyB[5][KEY_LENGTH]) {
// Static XOR table for key generation
static const uint8_t xor_table_keyB[4][6] = {
{0x1F, 0xC4, 0x4D, 0x94, 0x6A, 0x31},
{0x12, 0xC1, 0x5C, 0x70, 0xDF, 0x31},
{0x56, 0xF0, 0x13, 0x1B, 0x63, 0xF2},
{0x4E, 0xFA, 0xC2, 0xF8, 0xC9, 0xCC}};
static const uint8_t xor_table_keyA[4][6] = {
{0xB6, 0xE6, 0xAE, 0x72, 0x91, 0x0D},
{0x6D, 0x38, 0x50, 0xFB, 0x42, 0x89},
{0x1E, 0x5F, 0xC7, 0xED, 0xAA, 0x02},
{0x7E, 0xB9, 0xCA, 0xF1, 0x9C, 0x59}};
// Permutation table for rearranging elements in uid
static const uint8_t xorOrderA[6] = {0, 1, 2, 3, 0, 2};
static const uint8_t xorOrderB[6] = {1, 3, 3, 2, 1, 0};
// Generate key based on uid and XOR table
for(uint8_t j = 1; j < 5; j++) {
for(uint8_t i = 0; i < 6; i++) {
keyA[j][i] = uid[xorOrderA[i]] ^ xor_table_keyA[j - 1][i];
keyB[j][i] = uid[xorOrderB[i]] ^ xor_table_keyB[j - 1][i];
}
}
}
static bool hi_get_card_config(HiCardConfig* config, MfClassicType type) {
bool success = true;
if(type == MfClassicType1k) {
config->verify_sector = 0;
config->keys = hi_1k_keys;
} else {
success = false;
}
return success;
}
static bool hi_verify_type(Nfc* nfc, MfClassicType type) {
bool verified = false;
do {
HiCardConfig cfg = {};
if(!hi_get_card_config(&cfg, type)) break;
const uint8_t block_num = mf_classic_get_first_block_num_of_sector(cfg.verify_sector);
FURI_LOG_D(TAG, "Verifying sector %lu", cfg.verify_sector);
MfClassicKey key = {0};
nfc_util_num2bytes(cfg.keys[cfg.verify_sector].b, COUNT_OF(key.data), key.data);
MfClassicAuthContext auth_context;
MfClassicError error =
mf_classic_poller_sync_auth(nfc, block_num, &key, MfClassicKeyTypeB, &auth_context);
if(error != MfClassicErrorNone) {
FURI_LOG_D(
TAG, "Failed to read block %u: %d, this is not a HI card", block_num, error);
break;
}
FURI_LOG_D(TAG, "Found a HI Card");
verified = true;
} while(false);
return verified;
}
static bool hi_verify(Nfc* nfc) {
return hi_verify_type(nfc, MfClassicType1k);
}
static bool hi_read(Nfc* nfc, NfcDevice* device) {
FURI_LOG_D(TAG, "Entering HI KDF");
furi_assert(nfc);
furi_assert(device);
bool is_read = false;
MfClassicData* data = mf_classic_alloc();
nfc_device_copy_data(device, NfcProtocolMfClassic, data);
do {
MfClassicType type = MfClassicType1k;
MfClassicError error = mf_classic_poller_sync_detect_type(nfc, &type);
if(error != MfClassicErrorNone) break;
HiCardConfig cfg = {};
if(!hi_get_card_config(&cfg, data->type)) break;
uint8_t uid[UID_LENGTH];
memcpy(uid, data->iso14443_3a_data->uid, UID_LENGTH);
uint8_t keyA[HI_KEY_TO_GEN][KEY_LENGTH];
uint8_t keyB[HI_KEY_TO_GEN][KEY_LENGTH];
hi_generate_key(uid, keyA, keyB);
for(size_t i = 0; i < mf_classic_get_total_sectors_num(data->type); i++) {
if(cfg.keys[i].a == 0x000000000000 && cfg.keys[i].b == 0x000000000000) {
cfg.keys[i].a = nfc_util_bytes2num(keyA[i], KEY_LENGTH);
cfg.keys[i].b = nfc_util_bytes2num(keyB[i], KEY_LENGTH);
}
}
MfClassicDeviceKeys keys = {};
for(size_t i = 0; i < mf_classic_get_total_sectors_num(data->type); i++) {
nfc_util_num2bytes(cfg.keys[i].a, sizeof(MfClassicKey), keys.key_a[i].data);
FURI_BIT_SET(keys.key_a_mask, i);
nfc_util_num2bytes(cfg.keys[i].b, sizeof(MfClassicKey), keys.key_b[i].data);
FURI_BIT_SET(keys.key_b_mask, i);
}
error = mf_classic_poller_sync_read(nfc, &keys, data);
if(error == MfClassicErrorNotPresent) {
FURI_LOG_W(TAG, "Failed to read data");
break;
}
nfc_device_set_data(device, NfcProtocolMfClassic, data);
is_read = (error == MfClassicErrorNone);
} while(false);
mf_classic_free(data);
return is_read;
}
static bool hi_parse(const NfcDevice* device, FuriString* parsed_data) {
furi_assert(device);
furi_assert(parsed_data);
const MfClassicData* data = nfc_device_get_data(device, NfcProtocolMfClassic);
bool parsed = false;
do {
// Verify card type
HiCardConfig cfg = {};
if(!hi_get_card_config(&cfg, data->type)) break;
// Verify key
MfClassicSectorTrailer* sec_tr =
mf_classic_get_sector_trailer_by_sector(data, cfg.verify_sector);
uint64_t key = nfc_util_bytes2num(sec_tr->key_b.data, 6);
if(key != cfg.keys[cfg.verify_sector].b) return false;
//Get UID
uint8_t uid[UID_LENGTH];
memcpy(uid, data->iso14443_3a_data->uid, UID_LENGTH);
//parse data
furi_string_cat_printf(parsed_data, "\e#HI! Card\n");
furi_string_cat_printf(parsed_data, "UID:");
for(size_t i = 0; i < UID_LENGTH; i++) {
furi_string_cat_printf(parsed_data, " %02X", uid[i]);
}
furi_string_cat_printf(parsed_data, "\n");
parsed = true;
} while(false);
return parsed;
}
/* Actual implementation of app<>plugin interface */
static const NfcSupportedCardsPlugin hi_plugin = {
.protocol = NfcProtocolMfClassic,
.verify = hi_verify,
.read = hi_read,
.parse = hi_parse,
};
/* Plugin descriptor to comply with basic plugin specification */
static const FlipperAppPluginDescriptor hi_plugin_descriptor = {
.appid = NFC_SUPPORTED_CARD_PLUGIN_APP_ID,
.ep_api_version = NFC_SUPPORTED_CARD_PLUGIN_API_VERSION,
.entry_point = &hi_plugin,
};
/* Plugin entry point - must return a pointer to const descriptor */
const FlipperAppPluginDescriptor* hi_plugin_ep() {
return &hi_plugin_descriptor;
}

2
applications/main/nfc/plugins/supported_cards/hid.c
View File

@@ -67,7 +67,7 @@ static bool hid_read(Nfc* nfc, NfcDevice* device) {
nfc_device_set_data(device, NfcProtocolMfClassic, data);
is_read = mf_classic_is_card_read(data);
is_read = (error == MfClassicErrorNone);
} while(false);
mf_classic_free(data);

114
applications/main/nfc/plugins/supported_cards/kazan.c
View File

@@ -34,7 +34,7 @@ typedef struct {
uint64_t b;
} MfClassicKeyPair;
static const MfClassicKeyPair kazan_1k_keys_standart[] = {
static const MfClassicKeyPair kazan_1k_keys_v1[] = {
{.a = 0xFFFFFFFFFFFF, .b = 0xFFFFFFFFFFFF},
{.a = 0xFFFFFFFFFFFF, .b = 0xFFFFFFFFFFFF},
{.a = 0xFFFFFFFFFFFF, .b = 0xFFFFFFFFFFFF},
@@ -53,7 +53,7 @@ static const MfClassicKeyPair kazan_1k_keys_standart[] = {
{.a = 0xFFFFFFFFFFFF, .b = 0xFFFFFFFFFFFF},
};
static const MfClassicKeyPair kazan_1k_keys_old[] = {
static const MfClassicKeyPair kazan_1k_keys_v2[] = {
{.a = 0xFFFFFFFFFFFF, .b = 0xFFFFFFFFFFFF},
{.a = 0xFFFFFFFFFFFF, .b = 0xFFFFFFFFFFFF},
{.a = 0xFFFFFFFFFFFF, .b = 0xFFFFFFFFFFFF},
@@ -72,6 +72,25 @@ static const MfClassicKeyPair kazan_1k_keys_old[] = {
{.a = 0xFFFFFFFFFFFF, .b = 0xFFFFFFFFFFFF},
};
static const MfClassicKeyPair kazan_1k_keys_v3[] = {
{.a = 0x165D3B5280C0, .b = 0xFC7C2BB34E0F},
{.a = 0xC178E3DA7A39, .b = 0xC70FB78B4934},
{.a = 0x1BDF96089D2F, .b = 0x9500F058ABC5},
{.a = 0xB65AA70AD524, .b = 0x733A63B8B7F3},
{.a = 0x8BDB8FECDCAF, .b = 0xB0048EE71C0F},
{.a = 0xBC10468ABF05, .b = 0x1700A7D5C034},
{.a = 0xE7F3282E0C7D, .b = 0x65909B89BDA5},
{.a = 0x986C63DD0355, .b = 0x901C125ED37D},
{.a = 0x2058EAEE8446, .b = 0xCB9B23815F87},
{.a = 0x492F3744A1DC, .b = 0x6B770AADA274},
{.a = 0x87EB933B9BF7, .b = 0xFC98A9460EE5},
{.a = 0x7EBC8337F8F0, .b = 0x887C97E53DBC},
{.a = 0xA369BF6D4452, .b = 0x03BBA7CA2F24},
{.a = 0x37569D7992EF, .b = 0x710BBD01B3B8},
{.a = 0xD4AA94C4B5E8, .b = 0x7F5C4D210F0B},
{.a = 0x521B8C4B2123, .b = 0x2D2392CC43A7},
};
enum SubscriptionType {
SUBSCRIPTION_TYPE_UNKNOWN,
SUBSCRIPTION_TYPE_PURSE,
@@ -96,6 +115,9 @@ enum SubscriptionType get_subscription_type(uint8_t value, FuriString* tariff_na
case 0x53:
furi_string_printf(tariff_name, "Standart purse");
return SUBSCRIPTION_TYPE_PURSE;
case 0x01:
furi_string_printf(tariff_name, "Token");
return SUBSCRIPTION_TYPE_ABONNEMENT_BY_TRIPS;
default:
furi_string_printf(tariff_name, "Unknown");
return SUBSCRIPTION_TYPE_UNKNOWN;
@@ -106,21 +128,34 @@ static bool kazan_verify(Nfc* nfc) {
bool verified = false;
do {
const uint8_t verification_sector_number = 10;
const uint8_t verification_sector_number = 8;
const uint8_t verification_block_number =
mf_classic_get_first_block_num_of_sector(verification_sector_number) + 1;
FURI_LOG_D(TAG, "Verifying sector %u", verification_sector_number);
MfClassicKey key = {0};
MfClassicKey key_1 = {0};
nfc_util_num2bytes(
kazan_1k_keys_standart[verification_sector_number].a, COUNT_OF(key.data), key.data);
kazan_1k_keys_v1[verification_sector_number].a, COUNT_OF(key_1.data), key_1.data);
MfClassicAuthContext auth_context;
MfClassicError error = mf_classic_poller_sync_auth(
nfc, verification_block_number, &key, MfClassicKeyTypeA, &auth_context);
nfc, verification_block_number, &key_1, MfClassicKeyTypeA, &auth_context);
if(error != MfClassicErrorNone) {
FURI_LOG_D(TAG, "Failed to read block %u: %d", verification_block_number, error);
break;
FURI_LOG_D(
TAG, "Failed to read block %u: %d. Keys: v1", verification_block_number, error);
MfClassicKey key_2 = {0};
nfc_util_num2bytes(
kazan_1k_keys_v2[verification_sector_number].a, COUNT_OF(key_2.data), key_2.data);
MfClassicAuthContext auth_context;
MfClassicError error = mf_classic_poller_sync_auth(
nfc, verification_block_number, &key_2, MfClassicKeyTypeA, &auth_context);
if(error != MfClassicErrorNone) {
FURI_LOG_D(
TAG, "Failed to read block %u: %d. Keys: v2", verification_block_number, error);
break;
}
}
verified = true;
@@ -145,41 +180,57 @@ static bool kazan_read(Nfc* nfc, NfcDevice* device) {
data->type = type;
if(type != MfClassicType1k) break;
MfClassicDeviceKeys keys = {
MfClassicDeviceKeys keys_v1 = {
.key_a_mask = 0,
.key_b_mask = 0,
};
MfClassicDeviceKeys keys_old = {
MfClassicDeviceKeys keys_v2 = {
.key_a_mask = 0,
.key_b_mask = 0,
};
MfClassicDeviceKeys keys_v3 = {
.key_a_mask = 0,
.key_b_mask = 0,
};
for(size_t i = 0; i < mf_classic_get_total_sectors_num(data->type); i++) {
nfc_util_num2bytes(
kazan_1k_keys_standart[i].a, sizeof(MfClassicKey), keys.key_a[i].data);
nfc_util_num2bytes(
kazan_1k_keys_old[i].a, sizeof(MfClassicKey), keys_old.key_a[i].data);
FURI_BIT_SET(keys.key_a_mask, i);
FURI_BIT_SET(keys_old.key_a_mask, i);
nfc_util_num2bytes(kazan_1k_keys_v1[i].a, sizeof(MfClassicKey), keys_v1.key_a[i].data);
nfc_util_num2bytes(kazan_1k_keys_v2[i].a, sizeof(MfClassicKey), keys_v2.key_a[i].data);
nfc_util_num2bytes(kazan_1k_keys_v3[i].a, sizeof(MfClassicKey), keys_v3.key_a[i].data);
nfc_util_num2bytes(
kazan_1k_keys_standart[i].b, sizeof(MfClassicKey), keys.key_b[i].data);
nfc_util_num2bytes(
kazan_1k_keys_old[i].b, sizeof(MfClassicKey), keys_old.key_b[i].data);
FURI_BIT_SET(keys.key_b_mask, i);
FURI_BIT_SET(keys_old.key_b_mask, i);
FURI_BIT_SET(keys_v1.key_a_mask, i);
FURI_BIT_SET(keys_v2.key_a_mask, i);
FURI_BIT_SET(keys_v3.key_a_mask, i);
nfc_util_num2bytes(kazan_1k_keys_v1[i].b, sizeof(MfClassicKey), keys_v1.key_b[i].data);
nfc_util_num2bytes(kazan_1k_keys_v2[i].b, sizeof(MfClassicKey), keys_v2.key_b[i].data);
nfc_util_num2bytes(kazan_1k_keys_v3[i].b, sizeof(MfClassicKey), keys_v3.key_b[i].data);
FURI_BIT_SET(keys_v1.key_b_mask, i);
FURI_BIT_SET(keys_v2.key_b_mask, i);
FURI_BIT_SET(keys_v3.key_b_mask, i);
}
error = mf_classic_poller_sync_read(nfc, &keys, data);
if(error != MfClassicErrorNone) {
FURI_LOG_W(TAG, "Failed to read data: standart keys");
error = mf_classic_poller_sync_read(nfc, &keys_v1, data);
if(error == MfClassicErrorNotPresent) {
FURI_LOG_W(TAG, "Failed to read data: keys_v1");
break;
}
if(!mf_classic_is_card_read(data)) {
error = mf_classic_poller_sync_read(nfc, &keys_old, data);
if(error != MfClassicErrorNone) {
FURI_LOG_W(TAG, "Failed to read data: old keys");
error = mf_classic_poller_sync_read(nfc, &keys_v2, data);
if(error == MfClassicErrorNotPresent) {
FURI_LOG_W(TAG, "Failed to read data: keys_v1");
break;
}
}
if(!mf_classic_is_card_read(data)) {
error = mf_classic_poller_sync_read(nfc, &keys_v3, data);
if(error == MfClassicErrorNotPresent) {
FURI_LOG_W(TAG, "Failed to read data: keys_v3");
break;
}
}
@@ -202,18 +253,19 @@ static bool kazan_parse(const NfcDevice* device, FuriString* parsed_data) {
bool parsed = false;
do {
const uint8_t verification_sector_number = 10;
const uint8_t ticket_sector_number = 8;
const uint8_t balance_sector_number = 9;
// Verify keys
MfClassicKeyPair keys = {};
const MfClassicSectorTrailer* sec_tr =
mf_classic_get_sector_trailer_by_sector(data, verification_sector_number);
mf_classic_get_sector_trailer_by_sector(data, ticket_sector_number);
keys.a = nfc_util_bytes2num(sec_tr->key_a.data, COUNT_OF(sec_tr->key_a.data));
keys.b = nfc_util_bytes2num(sec_tr->key_b.data, COUNT_OF(sec_tr->key_b.data));
if(keys.a != 0xF7A545095C49) {
if(((keys.a != kazan_1k_keys_v1[8].a) && (keys.a != kazan_1k_keys_v2[8].a)) ||
((keys.b != kazan_1k_keys_v1[8].b) && (keys.b != kazan_1k_keys_v2[8].b))) {
FURI_LOG_D(TAG, "Parser: Failed to verify key a: %llu", keys.a);
break;
}

4
applications/main/nfc/plugins/supported_cards/metromoney.c
View File

@@ -107,14 +107,14 @@ static bool metromoney_read(Nfc* nfc, NfcDevice* device) {
}
error = mf_classic_poller_sync_read(nfc, &keys, data);
if(error != MfClassicErrorNone) {
if(error == MfClassicErrorNotPresent) {
FURI_LOG_W(TAG, "Failed to read data");
break;
}
nfc_device_set_data(device, NfcProtocolMfClassic, data);
is_read = mf_classic_is_card_read(data);
is_read = (error == MfClassicErrorNone);
} while(false);
mf_classic_free(data);

228
applications/main/nfc/plugins/supported_cards/microel.c Normal file
View File

@@ -0,0 +1,228 @@
#include "nfc_supported_card_plugin.h"
#include <flipper_application/flipper_application.h>
#include <nfc/nfc_device.h>
#include <nfc/helpers/nfc_util.h>
#include <nfc/protocols/mf_classic/mf_classic_poller_sync.h>
#include <stdint.h>
#define TAG "Microel"
#define KEY_LENGTH 6
#define UID_LENGTH 4
typedef struct {
uint64_t a;
uint64_t b;
} MfClassicKeyPair;
static MfClassicKeyPair microel_1k_keys[] = {
{.a = 0x000000000000, .b = 0x000000000000}, // 000
{.a = 0x000000000000, .b = 0x000000000000}, // 001
{.a = 0xffffffffffff, .b = 0xffffffffffff}, // 002
{.a = 0xffffffffffff, .b = 0xffffffffffff}, // 003
{.a = 0xffffffffffff, .b = 0xffffffffffff}, // 004
{.a = 0xffffffffffff, .b = 0xffffffffffff}, // 005
{.a = 0xffffffffffff, .b = 0xffffffffffff}, // 006
{.a = 0xffffffffffff, .b = 0xffffffffffff}, // 007
{.a = 0xffffffffffff, .b = 0xffffffffffff}, // 008
{.a = 0xffffffffffff, .b = 0xffffffffffff}, // 009
{.a = 0xffffffffffff, .b = 0xffffffffffff}, // 010
{.a = 0xffffffffffff, .b = 0xffffffffffff}, // 011
{.a = 0xffffffffffff, .b = 0xffffffffffff}, // 012
{.a = 0xffffffffffff, .b = 0xffffffffffff}, // 013
{.a = 0xffffffffffff, .b = 0xffffffffffff}, // 014
{.a = 0xffffffffffff, .b = 0xffffffffffff}, // 015
};
const uint8_t verify_sector = 1;
void calculateSumHex(const uint8_t* uid, size_t uidSize, uint8_t sumHex[]) {
const uint8_t xorKey[] = {0x01, 0x92, 0xA7, 0x75, 0x2B, 0xF9};
int sum = 0;
for(size_t i = 0; i < uidSize; i++) {
sum += uid[i];
}
int sumTwoDigits = sum % 256;
if(sumTwoDigits % 2 == 1) {
sumTwoDigits += 2;
}
for(size_t i = 0; i < sizeof(xorKey); i++) {
sumHex[i] = sumTwoDigits ^ xorKey[i];
}
}
void generateKeyA(const uint8_t* uid, uint8_t uidSize, uint8_t keyA[]) {
uint8_t sumHex[6];
calculateSumHex(uid, uidSize, sumHex);
uint8_t firstCharacter = (sumHex[0] >> 4) & 0xF;
if(firstCharacter == 0x2 || firstCharacter == 0x3 || firstCharacter == 0xA ||
firstCharacter == 0xB) {
// XOR WITH 0x40
for(size_t i = 0; i < sizeof(sumHex); i++) {
keyA[i] = 0x40 ^ sumHex[i];
}
} else if(
firstCharacter == 0x6 || firstCharacter == 0x7 || firstCharacter == 0xE ||
firstCharacter == 0xF) {
// XOR WITH 0xC0
for(size_t i = 0; i < sizeof(sumHex); i++) {
keyA[i] = 0xC0 ^ sumHex[i];
}
} else {
//Key a is the same as sumHex
for(size_t i = 0; i < sizeof(sumHex); i++) {
keyA[i] = sumHex[i];
}
}
}
void generateKeyB(uint8_t keyA[], size_t keyASize, uint8_t keyB[]) {
for(size_t i = 0; i < keyASize; i++) {
keyB[i] = 0xFF ^ keyA[i];
}
}
static bool microel_read(Nfc* nfc, NfcDevice* device) {
FURI_LOG_D(TAG, "Entering Microel KDF");
furi_assert(nfc);
furi_assert(device);
bool is_read = false;
MfClassicData* data = mf_classic_alloc();
nfc_device_copy_data(device, NfcProtocolMfClassic, data);
do {
MfClassicType type = MfClassicType1k;
MfClassicError error = mf_classic_poller_sync_detect_type(nfc, &type);
if(error != MfClassicErrorNone) break;
//Get UID and check if it is 4 bytes
size_t uid_len;
const uint8_t* uid = mf_classic_get_uid(data, &uid_len);
FURI_LOG_D(TAG, "UID identified: %02X%02X%02X%02X", uid[0], uid[1], uid[2], uid[3]);
if(uid_len != UID_LENGTH) break;
// Generate keys
uint8_t keyA[KEY_LENGTH];
uint8_t keyB[KEY_LENGTH];
generateKeyA(uid, UID_LENGTH, keyA);
generateKeyB(keyA, KEY_LENGTH, keyB);
// Check key 0a to verify if it is a microel card
MfClassicKey key = {0};
nfc_util_num2bytes(nfc_util_bytes2num(keyA, KEY_LENGTH), COUNT_OF(key.data), key.data);
const uint8_t block_num = mf_classic_get_first_block_num_of_sector(0); // This is 0
MfClassicAuthContext auth_context;
error =
mf_classic_poller_sync_auth(nfc, block_num, &key, MfClassicKeyTypeA, &auth_context);
if(error != MfClassicErrorNone) {
break;
}
// Save keys generated to stucture
for(size_t i = 0; i < mf_classic_get_total_sectors_num(data->type); i++) {
if(microel_1k_keys[i].a == 0x000000000000) {
microel_1k_keys[i].a = nfc_util_bytes2num(keyA, KEY_LENGTH);
}
if(microel_1k_keys[i].b == 0x000000000000) {
microel_1k_keys[i].b = nfc_util_bytes2num(keyB, KEY_LENGTH);
}
}
MfClassicDeviceKeys keys = {};
for(size_t i = 0; i < mf_classic_get_total_sectors_num(data->type); i++) {
nfc_util_num2bytes(microel_1k_keys[i].a, sizeof(MfClassicKey), keys.key_a[i].data);
FURI_BIT_SET(keys.key_a_mask, i);
nfc_util_num2bytes(microel_1k_keys[i].b, sizeof(MfClassicKey), keys.key_b[i].data);
FURI_BIT_SET(keys.key_b_mask, i);
}
error = mf_classic_poller_sync_read(nfc, &keys, data);
if(error == MfClassicErrorNotPresent) {
FURI_LOG_W(TAG, "Failed to read data");
break;
}
nfc_device_set_data(device, NfcProtocolMfClassic, data);
is_read = (error == MfClassicErrorNone);
} while(false);
mf_classic_free(data);
return is_read;
}
static bool microel_parse(const NfcDevice* device, FuriString* parsed_data) {
furi_assert(device);
furi_assert(parsed_data);
const MfClassicData* data = nfc_device_get_data(device, NfcProtocolMfClassic);
bool parsed = false;
do {
//Get UID
size_t uid_len;
const uint8_t* uid = mf_classic_get_uid(data, &uid_len);
if(uid_len != UID_LENGTH) break;
// Generate key from uid
uint8_t keyA[KEY_LENGTH];
generateKeyA(uid, UID_LENGTH, keyA);
// Verify key
MfClassicSectorTrailer* sec_tr =
mf_classic_get_sector_trailer_by_sector(data, verify_sector);
uint64_t key = nfc_util_bytes2num(sec_tr->key_a.data, 6);
uint64_t key_for_check_from_array = nfc_util_bytes2num(keyA, KEY_LENGTH);
if(key != key_for_check_from_array) break;
//Get credit in block number 8
const uint8_t* temp_ptr = data->block[4].data;
uint16_t balance = (temp_ptr[6] << 8) | (temp_ptr[5]);
uint16_t previus_balance = (data->block[5].data[6] << 8) | (data->block[5].data[5]);
furi_string_cat_printf(parsed_data, "\e#Microel Card\n");
furi_string_cat_printf(parsed_data, "UID:");
for(size_t i = 0; i < UID_LENGTH; i++) {
furi_string_cat_printf(parsed_data, " %02X", uid[i]);
}
furi_string_cat_printf(
parsed_data, "\nCurrent Credit: %d.%02d E \n", balance / 100, balance % 100);
furi_string_cat_printf(
parsed_data,
"Previus Credit: %d.%02d E \n",
previus_balance / 100,
previus_balance % 100);
parsed = true;
} while(false);
return parsed;
}
/* Actual implementation of app<>plugin interface */
static const NfcSupportedCardsPlugin microel_plugin = {
.protocol = NfcProtocolMfClassic,
.verify =
NULL, // the verification I need is based on verifying the keys generated via uid and try to authenticate not like on mizip that there is default b0 but added verify in read function
.read = microel_read,
.parse = microel_parse,
};
/* Plugin descriptor to comply with basic plugin specification */
static const FlipperAppPluginDescriptor microel_plugin_descriptor = {
.appid = NFC_SUPPORTED_CARD_PLUGIN_APP_ID,
.ep_api_version = NFC_SUPPORTED_CARD_PLUGIN_API_VERSION,
.entry_point = &microel_plugin,
};
/* Plugin entry point - must return a pointer to const descriptor */
const FlipperAppPluginDescriptor* microel_plugin_ep() {
return &microel_plugin_descriptor;
}

257
applications/main/nfc/plugins/supported_cards/mizip.c Normal file
View File

@@ -0,0 +1,257 @@
#include "nfc_supported_card_plugin.h"
#include <flipper_application/flipper_application.h>
#include <nfc/nfc_device.h>
#include <nfc/helpers/nfc_util.h>
#include <nfc/protocols/mf_classic/mf_classic_poller_sync.h>
#include <stdint.h>
#define TAG "MiZIP"
#define KEY_LENGTH 6
#define MIZIP_KEY_TO_GEN 5
#define UID_LENGTH 4
typedef struct {
uint64_t a;
uint64_t b;
} MfClassicKeyPair;
typedef struct {
MfClassicKeyPair* keys;
uint32_t verify_sector;
} MizipCardConfig;
static MfClassicKeyPair mizip_1k_keys[] = {
{.a = 0xa0a1a2a3a4a5, .b = 0xb4c132439eef}, // 000
{.a = 0x000000000000, .b = 0x000000000000}, // 001
{.a = 0x000000000000, .b = 0x000000000000}, // 002
{.a = 0x000000000000, .b = 0x000000000000}, // 003
{.a = 0x000000000000, .b = 0x000000000000}, // 004
{.a = 0x0222179AB995, .b = 0x13321774F9B5}, // 005
{.a = 0xB25CBD76A7B4, .b = 0x7571359B4274}, // 006
{.a = 0xDA857B4907CC, .b = 0xD26B856175F7}, // 007
{.a = 0x16D85830C443, .b = 0x8F790871A21E}, // 008
{.a = 0x88BD5098FC82, .b = 0xFCD0D77745E4}, // 009
{.a = 0x983349449D78, .b = 0xEA2631FBDEDD}, // 010
{.a = 0xC599F962F3D9, .b = 0x949B70C14845}, // 011
{.a = 0x72E668846BE8, .b = 0x45490B5AD707}, // 012
{.a = 0xBCA105E5685E, .b = 0x248DAF9D674D}, // 013
{.a = 0x4F6FE072D1FD, .b = 0x4250A05575FA}, // 014
{.a = 0x56438ABE8152, .b = 0x59A45912B311}, // 015
};
static MfClassicKeyPair mizip_mini_keys[] = {
{.a = 0xa0a1a2a3a4a5, .b = 0xb4c132439eef}, // 000
{.a = 0x000000000000, .b = 0x000000000000}, // 001
{.a = 0x000000000000, .b = 0x000000000000}, // 002
{.a = 0x000000000000, .b = 0x000000000000}, // 003
{.a = 0x000000000000, .b = 0x000000000000}, // 004
};
//KDF
void mizip_generate_key(uint8_t* uid, uint8_t keyA[5][KEY_LENGTH], uint8_t keyB[5][KEY_LENGTH]) {
// Static XOR table for key generation
static const uint8_t xor_table_keyA[4][6] = {
{0x09, 0x12, 0x5A, 0x25, 0x89, 0xE5},
{0xAB, 0x75, 0xC9, 0x37, 0x92, 0x2F},
{0xE2, 0x72, 0x41, 0xAF, 0x2C, 0x09},
{0x31, 0x7A, 0xB7, 0x2F, 0x44, 0x90}};
static const uint8_t xor_table_keyB[4][6] = {
{0xF1, 0x2C, 0x84, 0x53, 0xD8, 0x21},
{0x73, 0xE7, 0x99, 0xFE, 0x32, 0x41},
{0xAA, 0x4D, 0x13, 0x76, 0x56, 0xAE},
{0xB0, 0x13, 0x27, 0x27, 0x2D, 0xFD}};
// Permutation table for rearranging elements in uid
static const uint8_t xorOrderA[6] = {0, 1, 2, 3, 0, 1};
static const uint8_t xorOrderB[6] = {2, 3, 0, 1, 2, 3};
// Generate key based on uid and XOR table
for(uint8_t j = 1; j < 5; j++) {
for(uint8_t i = 0; i < 6; i++) {
keyA[j][i] = uid[xorOrderA[i]] ^ xor_table_keyA[j - 1][i];
keyB[j][i] = uid[xorOrderB[i]] ^ xor_table_keyB[j - 1][i];
}
}
}
static bool mizip_get_card_config(MizipCardConfig* config, MfClassicType type) {
bool success = true;
if(type == MfClassicType1k) {
config->verify_sector = 0;
config->keys = mizip_1k_keys;
} else if(type == MfClassicTypeMini) {
config->verify_sector = 0;
config->keys = mizip_mini_keys;
} else {
success = false;
}
return success;
}
static bool mizip_verify_type(Nfc* nfc, MfClassicType type) {
bool verified = false;
do {
MizipCardConfig cfg = {};
if(!mizip_get_card_config(&cfg, type)) break;
const uint8_t block_num = mf_classic_get_first_block_num_of_sector(cfg.verify_sector);
FURI_LOG_D(TAG, "Verifying sector %lu", cfg.verify_sector);
MfClassicKey key = {0};
nfc_util_num2bytes(cfg.keys[cfg.verify_sector].b, COUNT_OF(key.data), key.data);
MfClassicAuthContext auth_context;
MfClassicError error =
mf_classic_poller_sync_auth(nfc, block_num, &key, MfClassicKeyTypeB, &auth_context);
if(error != MfClassicErrorNone) {
FURI_LOG_D(
TAG, "Failed to read block %u: %d, this is not a MiZIP card", block_num, error);
break;
}
FURI_LOG_D(TAG, "Found a MiZIP Card");
verified = true;
} while(false);
return verified;
}
static bool mizip_verify(Nfc* nfc) {
return mizip_verify_type(nfc, MfClassicType1k) || mizip_verify_type(nfc, MfClassicTypeMini);
}
static bool mizip_read(Nfc* nfc, NfcDevice* device) {
FURI_LOG_D(TAG, "Entering MiZIP KDF");
furi_assert(nfc);
furi_assert(device);
bool is_read = false;
MfClassicData* data = mf_classic_alloc();
nfc_device_copy_data(device, NfcProtocolMfClassic, data);
do {
MfClassicType type = MfClassicTypeMini;
MfClassicError error = mf_classic_poller_sync_detect_type(nfc, &type);
if(error != MfClassicErrorNone) break;
//temp fix but fix mf_classic_poller_sync_detect_type because view type mfclassic1k and not verify mfmini
data->type = MfClassicTypeMini;
MizipCardConfig cfg = {};
if(!mizip_get_card_config(&cfg, data->type)) break;
uint8_t uid[UID_LENGTH];
memcpy(uid, data->iso14443_3a_data->uid, UID_LENGTH);
uint8_t keyA[MIZIP_KEY_TO_GEN][KEY_LENGTH];
uint8_t keyB[MIZIP_KEY_TO_GEN][KEY_LENGTH];
mizip_generate_key(uid, keyA, keyB);
for(size_t i = 0; i < mf_classic_get_total_sectors_num(data->type); i++) {
if(cfg.keys[i].a == 0x000000000000 && cfg.keys[i].b == 0x000000000000) {
cfg.keys[i].a = nfc_util_bytes2num(keyA[i], KEY_LENGTH);
cfg.keys[i].b = nfc_util_bytes2num(keyB[i], KEY_LENGTH);
}
}
MfClassicDeviceKeys keys = {};
for(size_t i = 0; i < mf_classic_get_total_sectors_num(data->type); i++) {
nfc_util_num2bytes(cfg.keys[i].a, sizeof(MfClassicKey), keys.key_a[i].data);
FURI_BIT_SET(keys.key_a_mask, i);
nfc_util_num2bytes(cfg.keys[i].b, sizeof(MfClassicKey), keys.key_b[i].data);
FURI_BIT_SET(keys.key_b_mask, i);
}
error = mf_classic_poller_sync_read(nfc, &keys, data);
if(error == MfClassicErrorNotPresent) {
FURI_LOG_W(TAG, "Failed to read data");
break;
}
nfc_device_set_data(device, NfcProtocolMfClassic, data);
is_read = (error == MfClassicErrorNone);
} while(false);
mf_classic_free(data);
return is_read;
}
static bool mizip_parse(const NfcDevice* device, FuriString* parsed_data) {
furi_assert(device);
furi_assert(parsed_data);
const MfClassicData* data = nfc_device_get_data(device, NfcProtocolMfClassic);
bool parsed = false;
do {
// Verify card type
MizipCardConfig cfg = {};
if(!mizip_get_card_config(&cfg, data->type)) break;
// Verify key
MfClassicSectorTrailer* sec_tr =
mf_classic_get_sector_trailer_by_sector(data, cfg.verify_sector);
uint64_t key = nfc_util_bytes2num(sec_tr->key_b.data, 6);
if(key != cfg.keys[cfg.verify_sector].b) return false;
//Get UID
uint8_t uid[UID_LENGTH];
memcpy(uid, data->iso14443_3a_data->uid, UID_LENGTH);
//Get credit
uint8_t credit_pointer = 0x08;
uint8_t previus_credit_pointer = 0x09;
if(data->block[10].data[0] == 0x55) {
credit_pointer = 0x09;
previus_credit_pointer = 0x08;
}
uint16_t balance = (data->block[credit_pointer].data[2] << 8) |
(data->block[credit_pointer].data[1]);
uint16_t previus_balance = (data->block[previus_credit_pointer].data[2] << 8) |
(data->block[previus_credit_pointer].data[1]);
//parse data
furi_string_cat_printf(parsed_data, "\e#MiZIP Card\n");
furi_string_cat_printf(parsed_data, "UID:");
for(size_t i = 0; i < UID_LENGTH; i++) {
furi_string_cat_printf(parsed_data, " %02X", uid[i]);
}
furi_string_cat_printf(
parsed_data, "\nCurrent Credit: %d.%02d E \n", balance / 100, balance % 100);
furi_string_cat_printf(
parsed_data,
"Previus Credit: %d.%02d E \n",
previus_balance / 100,
previus_balance % 100);
parsed = true;
} while(false);
return parsed;
}
/* Actual implementation of app<>plugin interface */
static const NfcSupportedCardsPlugin mizip_plugin = {
.protocol = NfcProtocolMfClassic,
.verify = mizip_verify,
.read = mizip_read,
.parse = mizip_parse,
};
/* Plugin descriptor to comply with basic plugin specification */
static const FlipperAppPluginDescriptor mizip_plugin_descriptor = {
.appid = NFC_SUPPORTED_CARD_PLUGIN_APP_ID,
.ep_api_version = NFC_SUPPORTED_CARD_PLUGIN_API_VERSION,
.entry_point = &mizip_plugin,
};
/* Plugin entry point - must return a pointer to const descriptor */
const FlipperAppPluginDescriptor* mizip_plugin_ep() {
return &mizip_plugin_descriptor;
}

30
applications/main/nfc/plugins/supported_cards/ndef.c
View File

@@ -362,20 +362,26 @@ static bool ndef_parse(const NfcDevice* device, FuriString* parsed_data) {
// Memory layout documentation:
// https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrfxlib/nfc/doc/type_2_tag.html#id2
// Double check static values layout
// First 4 static reserved pages for UID, internal and lock bytes
// (Not sure if NDEF cata can be found in cards with different layout)
if(data->page[0].data[0] != 0x04) break;
if(data->page[2].data[1] != 0x48) break; // Internal
if(data->page[2].data[2] != 0x00) break; // Lock bytes
if(data->page[2].data[3] != 0x00) break; // ...
if(data->page[3].data[0] != 0xE1) break; // Capability container
if(data->page[3].data[1] != 0x10) break; // ...
// Check card type can contain NDEF
if(data->type != MfUltralightTypeNTAG203 && data->type != MfUltralightTypeNTAG213 &&
data->type != MfUltralightTypeNTAG215 && data->type != MfUltralightTypeNTAG216 &&
data->type != MfUltralightTypeNTAGI2C1K && data->type != MfUltralightTypeNTAGI2C2K) {
break;
}
// Data content starts here at 5th page
// Double check Capability Container (CC) and find data area bounds
struct {
uint8_t nfc_magic_number;
uint8_t document_version_number;
uint8_t data_area_size;
uint8_t read_write_access;
}* cc = (void*)&data->page[3].data[0];
if(cc->nfc_magic_number != 0xE1) break;
if(cc->document_version_number != 0x10) break;
const uint8_t* cur = &data->page[4].data[0];
const uint8_t* end = &data->page[0].data[0] +
(mf_ultralight_get_pages_total(data->type) * MF_ULTRALIGHT_PAGE_SIZE);
const uint8_t* end = cur + (cc->data_area_size * 2 * MF_ULTRALIGHT_PAGE_SIZE);
size_t max_size = mf_ultralight_get_pages_total(data->type) * MF_ULTRALIGHT_PAGE_SIZE;
end = MIN(end, &data->page[0].data[0] + max_size);
size_t message_num = 0;
// Parse as TLV (see docs above)

4
applications/main/nfc/plugins/supported_cards/saflok.c
View File

@@ -137,14 +137,14 @@ static bool saflok_read(Nfc* nfc, NfcDevice* device) {
}
error = mf_classic_poller_sync_read(nfc, &keys, data);
if(error != MfClassicErrorNone) {
if(error == MfClassicErrorNotPresent) {
FURI_LOG_W(TAG, "Failed to read data");
break;
}
nfc_device_set_data(device, NfcProtocolMfClassic, data);
is_read = mf_classic_is_card_read(data);
is_read = (error == MfClassicErrorNone);
} while(false);
mf_classic_free(data);

4
applications/main/nfc/plugins/supported_cards/social_moscow.c
View File

@@ -1534,14 +1534,14 @@ static bool social_moscow_read(Nfc* nfc, NfcDevice* device) {
}
error = mf_classic_poller_sync_read(nfc, &keys, data);
if(error != MfClassicErrorNone) {
if(error == MfClassicErrorNotPresent) {
FURI_LOG_W(TAG, "Failed to read data");
break;
}
nfc_device_set_data(device, NfcProtocolMfClassic, data);
is_read = mf_classic_is_card_read(data);
is_read = (error == MfClassicErrorNone);
} while(false);
mf_classic_free(data);

4
applications/main/nfc/plugins/supported_cards/troika.c
View File

@@ -1559,14 +1559,14 @@ static bool troika_read(Nfc* nfc, NfcDevice* device) {
}
error = mf_classic_poller_sync_read(nfc, &keys, data);
if(error != MfClassicErrorNone) {
if(error == MfClassicErrorNotPresent) {
FURI_LOG_W(TAG, "Failed to read data");
break;
}
nfc_device_set_data(device, NfcProtocolMfClassic, data);
is_read = mf_classic_is_card_read(data);
is_read = (error == MfClassicErrorNone);
} while(false);
mf_classic_free(data);

4
applications/main/nfc/plugins/supported_cards/washcity.c
View File

@@ -108,14 +108,14 @@ static bool washcity_read(Nfc* nfc, NfcDevice* device) {
}
error = mf_classic_poller_sync_read(nfc, &keys, data);
if(error != MfClassicErrorNone) {
if(error == MfClassicErrorNotPresent) {
FURI_LOG_W(TAG, "Failed to read data");
break;
}
nfc_device_set_data(device, NfcProtocolMfClassic, data);
is_read = mf_classic_is_card_read(data);
is_read = (error == MfClassicErrorNone);
} while(false);
mf_classic_free(data);

35
applications/main/nfc/plugins/supported_cards/zolotaya_korona.c
View File

@@ -40,37 +40,6 @@ static const uint8_t info_sector_signature[] = {0xE2, 0x87, 0x80, 0x8E, 0x20, 0x
0xAE, 0xE0, 0xAE, 0xAD, 0xA0, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00};
#define FURI_HAL_RTC_SECONDS_PER_MINUTE 60
#define FURI_HAL_RTC_SECONDS_PER_HOUR (FURI_HAL_RTC_SECONDS_PER_MINUTE * 60)
#define FURI_HAL_RTC_SECONDS_PER_DAY (FURI_HAL_RTC_SECONDS_PER_HOUR * 24)
#define FURI_HAL_RTC_EPOCH_START_YEAR 1970
void timestamp_to_datetime(uint32_t timestamp, FuriHalRtcDateTime* datetime) {
uint32_t days = timestamp / FURI_HAL_RTC_SECONDS_PER_DAY;
uint32_t seconds_in_day = timestamp % FURI_HAL_RTC_SECONDS_PER_DAY;
datetime->year = FURI_HAL_RTC_EPOCH_START_YEAR;
while(days >= furi_hal_rtc_get_days_per_year(datetime->year)) {
days -= furi_hal_rtc_get_days_per_year(datetime->year);
(datetime->year)++;
}
datetime->month = 1;
while(days >= furi_hal_rtc_get_days_per_month(
furi_hal_rtc_is_leap_year(datetime->year), datetime->month)) {
days -= furi_hal_rtc_get_days_per_month(
furi_hal_rtc_is_leap_year(datetime->year), datetime->month);
(datetime->month)++;
}
datetime->day = days + 1;
datetime->hour = seconds_in_day / FURI_HAL_RTC_SECONDS_PER_HOUR;
datetime->minute =
(seconds_in_day % FURI_HAL_RTC_SECONDS_PER_HOUR) / FURI_HAL_RTC_SECONDS_PER_MINUTE;
datetime->second = seconds_in_day % FURI_HAL_RTC_SECONDS_PER_MINUTE;
}
uint64_t bytes2num_bcd(const uint8_t* src, uint8_t len_bytes, bool* is_bcd) {
furi_assert(src);
furi_assert(len_bytes <= 9);
@@ -151,7 +120,7 @@ static bool zolotaya_korona_parse(const NfcDevice* device, FuriString* parsed_da
const uint16_t refill_counter = nfc_util_bytes2num_little_endian(block_start_ptr + 10, 2);
FuriHalRtcDateTime last_refill_datetime = {0};
timestamp_to_datetime(last_refill_timestamp, &last_refill_datetime);
furi_hal_rtc_timestamp_to_datetime(last_refill_timestamp, &last_refill_datetime);
// block 2: trip block
block_start_ptr = &data->block[start_trip_block_number + 2].data[0];
@@ -166,7 +135,7 @@ static bool zolotaya_korona_parse(const NfcDevice* device, FuriString* parsed_da
const uint8_t prev_balance_kop = prev_balance % 100;
FuriHalRtcDateTime last_trip_datetime = {0};
timestamp_to_datetime(last_trip_timestamp, &last_trip_datetime);
furi_hal_rtc_timestamp_to_datetime(last_trip_timestamp, &last_trip_datetime);
// PARSE DATA FROM PURSE SECTOR
const uint8_t start_purse_block_number =

1617
applications/main/nfc/resources/nfc/assets/mf_classic_dict.nfc
View File

File diff suppressed because it is too large Load Diff

5
applications/main/nfc/scenes/nfc_scene_config.h
View File

@@ -61,4 +61,9 @@ ADD_SCENE(nfc, set_sak, SetSak)
ADD_SCENE(nfc, set_atqa, SetAtqa)
ADD_SCENE(nfc, set_uid, SetUid)
ADD_SCENE(nfc, slix_unlock_menu, SlixUnlockMenu)
ADD_SCENE(nfc, slix_key_input, SlixKeyInput)
ADD_SCENE(nfc, slix_unlock, SlixUnlock)
ADD_SCENE(nfc, slix_unlock_success, SlixUnlockSuccess)
ADD_SCENE(nfc, generate_info, GenerateInfo)

7
applications/main/nfc/scenes/nfc_scene_exit_confirm.c
View File

@@ -31,6 +31,13 @@ bool nfc_scene_exit_confirm_on_event(void* context, SceneManagerEvent event) {
if(scene_manager_has_previous_scene(nfc->scene_manager, NfcSceneSelectProtocol)) {
consumed = scene_manager_search_and_switch_to_previous_scene(
nfc->scene_manager, NfcSceneSelectProtocol);
} else if(
scene_manager_has_previous_scene(nfc->scene_manager, NfcSceneMfClassicDictAttack) &&
(scene_manager_has_previous_scene(nfc->scene_manager, NfcSceneReadMenu) ||
scene_manager_has_previous_scene(nfc->scene_manager, NfcSceneSavedMenu))) {
const uint32_t possible_scenes[] = {NfcSceneReadMenu, NfcSceneSavedMenu};
consumed = scene_manager_search_and_switch_to_previous_scene_one_of(
nfc->scene_manager, possible_scenes, COUNT_OF(possible_scenes));
} else {
consumed = scene_manager_search_and_switch_to_previous_scene(
nfc->scene_manager, NfcSceneStart);

10
applications/main/nfc/scenes/nfc_scene_extra_actions.c
View File

@@ -4,6 +4,7 @@ enum SubmenuIndex {
SubmenuIndexReadCardType,
SubmenuIndexMfClassicKeys,
SubmenuIndexMfUltralightUnlock,
SubmenuIndexSlixUnlock,
};
void nfc_scene_extra_actions_submenu_callback(void* context, uint32_t index) {
@@ -34,6 +35,12 @@ void nfc_scene_extra_actions_on_enter(void* context) {
SubmenuIndexMfUltralightUnlock,
nfc_scene_extra_actions_submenu_callback,
instance);
submenu_add_item(
submenu,
"Unlock SLIX-L",
SubmenuIndexSlixUnlock,
nfc_scene_extra_actions_submenu_callback,
instance);
submenu_set_selected_item(
submenu, scene_manager_get_scene_state(instance->scene_manager, NfcSceneExtraActions));
view_dispatcher_switch_to_view(instance->view_dispatcher, NfcViewMenu);
@@ -54,6 +61,9 @@ bool nfc_scene_extra_actions_on_event(void* context, SceneManagerEvent event) {
} else if(event.event == SubmenuIndexReadCardType) {
scene_manager_next_scene(instance->scene_manager, NfcSceneSelectProtocol);
consumed = true;
} else if(event.event == SubmenuIndexSlixUnlock) {
scene_manager_next_scene(instance->scene_manager, NfcSceneSlixUnlockMenu);
consumed = true;
}
scene_manager_set_scene_state(instance->scene_manager, NfcSceneExtraActions, event.event);
}

8
applications/main/nfc/scenes/nfc_scene_retry_confirm.c
View File

@@ -28,7 +28,13 @@ bool nfc_scene_retry_confirm_on_event(void* context, SceneManagerEvent event) {
if(event.event == DialogExResultRight) {
consumed = scene_manager_previous_scene(nfc->scene_manager);
} else if(event.event == DialogExResultLeft) {
if(scene_manager_has_previous_scene(nfc->scene_manager, NfcSceneMfClassicDictAttack)) {
if(scene_manager_has_previous_scene(nfc->scene_manager, NfcSceneSlixUnlock)) {
consumed = scene_manager_search_and_switch_to_previous_scene(
nfc->scene_manager, NfcSceneSlixUnlock);
} else if(
scene_manager_has_previous_scene(nfc->scene_manager, NfcSceneMfClassicDictAttack) &&
(scene_manager_has_previous_scene(nfc->scene_manager, NfcSceneReadMenu) ||
scene_manager_has_previous_scene(nfc->scene_manager, NfcSceneSavedMenu))) {
consumed = scene_manager_search_and_switch_to_previous_scene(
nfc->scene_manager, NfcSceneMfClassicDictAttack);
} else if(scene_manager_has_previous_scene(

23
applications/main/nfc/scenes/nfc_scene_set_type.c
View File

@@ -32,20 +32,10 @@ void nfc_scene_set_type_on_enter(void* context) {
nfc_protocol_support_common_submenu_callback,
instance);
FuriString* str = furi_string_alloc();
for(size_t i = 0; i < NfcDataGeneratorTypeNum; i++) {
furi_string_cat_str(str, nfc_data_generator_get_name(i));
furi_string_replace_str(str, "Mifare", "MIFARE");
submenu_add_item(
submenu,
furi_string_get_cstr(str),
i,
nfc_protocol_support_common_submenu_callback,
instance);
furi_string_reset(str);
const char* name = nfc_data_generator_get_name(i);
submenu_add_item(submenu, name, i, nfc_protocol_support_common_submenu_callback, instance);
}
furi_string_free(str);
view_dispatcher_switch_to_view(instance->view_dispatcher, NfcViewMenu);
}
@@ -63,15 +53,6 @@ bool nfc_scene_set_type_on_event(void* context, SceneManagerEvent event) {
nfc_scene_set_type_init_edit_data(instance->iso14443_3a_edit_data, 4);
scene_manager_next_scene(instance->scene_manager, NfcSceneSetSak);
consumed = true;
} else if(
(event.event == NfcDataGeneratorTypeMfClassic1k_4b) ||
(event.event == NfcDataGeneratorTypeMfClassic1k_7b) ||
(event.event == NfcDataGeneratorTypeMfClassic4k_4b) ||
(event.event == NfcDataGeneratorTypeMfClassic4k_7b) ||
(event.event == NfcDataGeneratorTypeMfClassicMini)) {
nfc_data_generator_fill_data(event.event, instance->nfc_device);
scene_manager_next_scene(instance->scene_manager, NfcSceneSetUid);
consumed = true;
} else {
nfc_data_generator_fill_data(event.event, instance->nfc_device);
scene_manager_set_scene_state(

30
applications/main/nfc/scenes/nfc_scene_set_uid.c
View File

@@ -2,29 +2,6 @@
#include "../helpers/protocol_support/nfc_protocol_support_gui_common.h"
// Sync UID from #UID to block 0 data
void mfclassic_sync_uid(NfcDevice* instance) {
size_t uid_len;
const uint8_t* uid = nfc_device_get_uid(instance, &uid_len);
MfClassicData* mfc_data = (MfClassicData*)nfc_device_get_data(instance, NfcProtocolMfClassic);
uint8_t* block = mfc_data->block[0].data;
// Sync UID
for(uint8_t i = 0; i < (uint8_t)uid_len; i++) {
block[i] = uid[i];
}
if(uid_len == 4) {
// Calculate BCC
block[uid_len] = 0;
for(uint8_t i = 0; i < (uint8_t)uid_len; i++) {
block[uid_len] ^= block[i];
}
}
}
static void nfc_scene_set_uid_byte_input_changed_callback(void* context) {
NfcApp* instance = context;
// Retrieve previously saved UID length
@@ -67,10 +44,11 @@ bool nfc_scene_set_uid_on_event(void* context, SceneManagerEvent event) {
scene_manager_next_scene(instance->scene_manager, NfcSceneSaveSuccess);
consumed = true;
}
} else if(scene_manager_has_previous_scene(instance->scene_manager, NfcSceneReadMenu)) {
scene_manager_search_and_switch_to_previous_scene(
instance->scene_manager, NfcSceneReadMenu);
consumed = true;
} else {
if(nfc_device_get_protocol(instance->nfc_device) == NfcProtocolMfClassic)
mfclassic_sync_uid(instance->nfc_device);
scene_manager_next_scene(instance->scene_manager, NfcSceneSaveName);
consumed = true;
}

48
applications/main/nfc/scenes/nfc_scene_slix_key_input.c Normal file
View File

@@ -0,0 +1,48 @@
#include "../nfc_app_i.h"
#include <nfc/helpers/nfc_util.h>
void nfc_scene_slix_key_input_byte_input_callback(void* context) {
NfcApp* instance = context;
SlixPassword password = nfc_util_bytes2num(instance->byte_input_store, sizeof(SlixPassword));
slix_unlock_set_password(instance->slix_unlock, password);
view_dispatcher_send_custom_event(instance->view_dispatcher, NfcCustomEventByteInputDone);
}
void nfc_scene_slix_key_input_on_enter(void* context) {
NfcApp* instance = context;
// Setup view
ByteInput* byte_input = instance->byte_input;
byte_input_set_header_text(byte_input, "Enter the password in hex");
byte_input_set_result_callback(
byte_input,
nfc_scene_slix_key_input_byte_input_callback,
NULL,
instance,
instance->byte_input_store,
sizeof(SlixPassword));
view_dispatcher_switch_to_view(instance->view_dispatcher, NfcViewByteInput);
}
bool nfc_scene_slix_key_input_on_event(void* context, SceneManagerEvent event) {
NfcApp* instance = context;
bool consumed = false;
if(event.type == SceneManagerEventTypeCustom) {
if(event.event == NfcCustomEventByteInputDone) {
scene_manager_next_scene(instance->scene_manager, NfcSceneSlixUnlock);
consumed = true;
}
}
return consumed;
}
void nfc_scene_slix_key_input_on_exit(void* context) {
NfcApp* instance = context;
// Clear view
byte_input_set_result_callback(instance->byte_input, NULL, NULL, NULL, NULL, 0);
byte_input_set_header_text(instance->byte_input, "");
}

70
applications/main/nfc/scenes/nfc_scene_slix_unlock.c Normal file
View File

@@ -0,0 +1,70 @@
#include "../nfc_app_i.h"
#include <nfc/protocols/slix/slix_poller.h>
NfcCommand nfc_scene_slix_unlock_worker_callback(NfcGenericEvent event, void* context) {
furi_assert(event.protocol == NfcProtocolSlix);
NfcCommand command = NfcCommandContinue;
NfcApp* instance = context;
SlixPollerEvent* slix_event = event.event_data;
if(slix_event->type == SlixPollerEventTypePrivacyUnlockRequest) {
SlixPassword pwd = 0;
bool get_password_success = slix_unlock_get_next_password(instance->slix_unlock, &pwd);
slix_event->data->privacy_password.password = pwd;
slix_event->data->privacy_password.password_set = get_password_success;
} else if(slix_event->type == SlixPollerEventTypeError) {
view_dispatcher_send_custom_event(instance->view_dispatcher, NfcCustomEventPollerFailure);
} else if(slix_event->type == SlixPollerEventTypeReady) {
nfc_device_set_data(
instance->nfc_device, NfcProtocolSlix, nfc_poller_get_data(instance->poller));
view_dispatcher_send_custom_event(instance->view_dispatcher, NfcCustomEventPollerSuccess);
command = NfcCommandStop;
}
return command;
}
void nfc_scene_slix_unlock_on_enter(void* context) {
NfcApp* instance = context;
popup_set_icon(instance->popup, 0, 8, &I_NFC_manual_60x50);
popup_set_header(instance->popup, "Unlocking", 97, 15, AlignCenter, AlignTop);
popup_set_text(
instance->popup, "Apply card to\nFlipper's back", 97, 27, AlignCenter, AlignTop);
view_dispatcher_switch_to_view(instance->view_dispatcher, NfcViewPopup);
instance->poller = nfc_poller_alloc(instance->nfc, NfcProtocolSlix);
nfc_poller_start(instance->poller, nfc_scene_slix_unlock_worker_callback, instance);
}
bool nfc_scene_slix_unlock_on_event(void* context, SceneManagerEvent event) {
NfcApp* instance = context;
UNUSED(instance);
bool consumed = false;
if(event.type == SceneManagerEventTypeCustom) {
if(event.event == NfcCustomEventPollerFailure) {
consumed = true;
} else if(event.event == NfcCustomEventPollerSuccess) {
notification_message(instance->notifications, &sequence_success);
scene_manager_next_scene(instance->scene_manager, NfcSceneSlixUnlockSuccess);
consumed = true;
}
} else if(event.type == SceneManagerEventTypeBack) {
consumed = scene_manager_search_and_switch_to_previous_scene(
instance->scene_manager, NfcSceneSlixUnlockMenu);
}
return consumed;
}
void nfc_scene_slix_unlock_on_exit(void* context) {
NfcApp* instance = context;
nfc_poller_stop(instance->poller);
nfc_poller_free(instance->poller);
popup_reset(instance->popup);
}

60
applications/main/nfc/scenes/nfc_scene_slix_unlock_menu.c Normal file
View File

@@ -0,0 +1,60 @@
#include "../nfc_app_i.h"
enum SubmenuIndex {
SubmenuIndexSlixUnlockMenuManual,
SubmenuIndexSlixUnlockMenuTonieBox,
};
void nfc_scene_slix_unlock_menu_submenu_callback(void* context, uint32_t index) {
NfcApp* instance = context;
view_dispatcher_send_custom_event(instance->view_dispatcher, index);
}
void nfc_scene_slix_unlock_menu_on_enter(void* context) {
NfcApp* instance = context;
Submenu* submenu = instance->submenu;
uint32_t state =
scene_manager_get_scene_state(instance->scene_manager, NfcSceneSlixUnlockMenu);
submenu_add_item(
submenu,
"Enter Password Manually",
SubmenuIndexSlixUnlockMenuManual,
nfc_scene_slix_unlock_menu_submenu_callback,
instance);
submenu_add_item(
submenu,
"Auth As TommyBox",
SubmenuIndexSlixUnlockMenuTonieBox,
nfc_scene_slix_unlock_menu_submenu_callback,
instance);
submenu_set_selected_item(submenu, state);
view_dispatcher_switch_to_view(instance->view_dispatcher, NfcViewMenu);
}
bool nfc_scene_slix_unlock_menu_on_event(void* context, SceneManagerEvent event) {
NfcApp* instance = context;
bool consumed = false;
if(event.type == SceneManagerEventTypeCustom) {
if(event.event == SubmenuIndexSlixUnlockMenuManual) {
slix_unlock_set_method(instance->slix_unlock, SlixUnlockMethodManual);
scene_manager_next_scene(instance->scene_manager, NfcSceneSlixKeyInput);
consumed = true;
} else if(event.event == SubmenuIndexSlixUnlockMenuTonieBox) {
slix_unlock_set_method(instance->slix_unlock, SlixUnlockMethodTonieBox);
scene_manager_next_scene(instance->scene_manager, NfcSceneSlixUnlock);
consumed = true;
}
scene_manager_set_scene_state(
instance->scene_manager, NfcSceneSlixUnlockMenu, event.event);
}
return consumed;
}
void nfc_scene_slix_unlock_menu_on_exit(void* context) {
NfcApp* instance = context;
submenu_reset(instance->submenu);
}

71
applications/main/nfc/scenes/nfc_scene_slix_unlock_success.c Normal file
View File

@@ -0,0 +1,71 @@
#include "../nfc_app_i.h"
static void nfc_scene_slix_unlock_success_widget_callback(
GuiButtonType result,
InputType type,
void* context) {
NfcApp* instance = context;
if(type == InputTypeShort) {
view_dispatcher_send_custom_event(instance->view_dispatcher, result);
}
}
void nfc_scene_slix_unlock_success_on_enter(void* context) {
NfcApp* instance = context;
Widget* widget = instance->widget;
widget_add_string_element(widget, 0, 0, AlignLeft, AlignTop, FontPrimary, "SLIX Unlocked!");
FuriString* temp_str = furi_string_alloc_set_str("UID:");
size_t uid_len = 0;
const uint8_t* uid = nfc_device_get_uid(instance->nfc_device, &uid_len);
for(size_t i = 0; i < uid_len; i++) {
furi_string_cat_printf(temp_str, " %02X", uid[i]);
}
furi_string_cat_printf(temp_str, "\nPrivacy Mode: Disabled");
widget_add_string_multiline_element(
widget, 0, 12, AlignLeft, AlignTop, FontSecondary, furi_string_get_cstr(temp_str));
furi_string_free(temp_str);
widget_add_button_element(
widget,
GuiButtonTypeLeft,
"Retry",
nfc_scene_slix_unlock_success_widget_callback,
instance);
widget_add_button_element(
widget,
GuiButtonTypeRight,
"More",
nfc_scene_slix_unlock_success_widget_callback,
instance);
view_dispatcher_switch_to_view(instance->view_dispatcher, NfcViewWidget);
}
bool nfc_scene_slix_unlock_success_on_event(void* context, SceneManagerEvent event) {
NfcApp* instance = context;
bool consumed = false;
if(event.type == SceneManagerEventTypeCustom) {
if(event.event == GuiButtonTypeLeft) {
scene_manager_next_scene(instance->scene_manager, NfcSceneRetryConfirm);
consumed = true;
} else if(event.event == GuiButtonTypeRight) {
scene_manager_next_scene(instance->scene_manager, NfcSceneReadMenu);
consumed = true;
}
} else if(event.type == SceneManagerEventTypeBack) {
scene_manager_next_scene(instance->scene_manager, NfcSceneExitConfirm);
consumed = true;
}
return consumed;
}
void nfc_scene_slix_unlock_success_on_exit(void* context) {
NfcApp* instance = context;
widget_reset(instance->widget);
}

6
applications/services/cli/cli.c
View File

@@ -6,6 +6,8 @@
#define TAG "CliSrv"
#define CLI_INPUT_LEN_LIMIT 256
Cli* cli_alloc() {
Cli* cli = malloc(sizeof(Cli));
@@ -356,7 +358,9 @@ void cli_process_input(Cli* cli) {
cli_handle_backspace(cli);
} else if(in_chr == CliSymbolAsciiCR) {
cli_handle_enter(cli);
} else if(in_chr >= 0x20 && in_chr < 0x7F) { //-V560
} else if(
(in_chr >= 0x20 && in_chr < 0x7F) && //-V560
(furi_string_size(cli->line) < CLI_INPUT_LEN_LIMIT)) {
if(cli->cursor_position == furi_string_size(cli->line)) {
furi_string_push_back(cli->line, in_chr);
cli_putc(cli, in_chr);

2
applications/services/expansion/application.fam
View File

@@ -8,5 +8,5 @@ App(
],
requires=["rpc_start"],
provides=["expansion_settings"],
order=10,
order=150,
)

566
applications/services/expansion/expansion.c
View File

@@ -1,20 +1,18 @@
#include "expansion.h"
#include "expansion_i.h"
#include <furi_hal_power.h>
#include <furi_hal_serial.h>
#include <furi_hal_serial_control.h>
#include <furi.h>
#include <toolbox/api_lock.h>
#include <rpc/rpc.h>
#include "expansion_worker.h"
#include "expansion_settings.h"
#include "expansion_protocol.h"
#define TAG "ExpansionSrv"
#define EXPANSION_BUFFER_SIZE (sizeof(ExpansionFrame) + sizeof(ExpansionFrameChecksum))
#define EXPANSION_CONTROL_QUEUE_SIZE (8UL)
#define EXPANSION_CONTROL_STACK_SIZE (768UL)
typedef enum {
ExpansionStateDisabled,
@@ -23,370 +21,193 @@ typedef enum {
} ExpansionState;
typedef enum {
ExpansionSessionStateHandShake,
ExpansionSessionStateConnected,
ExpansionSessionStateRpcActive,
} ExpansionSessionState;
ExpansionMessageTypeEnable,
ExpansionMessageTypeDisable,
ExpansionMessageTypeSetListenSerial,
ExpansionMessageTypeModuleConnected,
ExpansionMessageTypeModuleDisconnected,
} ExpansionMessageType;
typedef enum {
ExpansionSessionExitReasonUnknown,
ExpansionSessionExitReasonUser,
ExpansionSessionExitReasonError,
ExpansionSessionExitReasonTimeout,
} ExpansionSessionExitReason;
typedef union {
FuriHalSerialId serial_id;
} ExpansionMessageData;
typedef enum {
ExpansionFlagStop = 1 << 0,
ExpansionFlagData = 1 << 1,
ExpansionFlagError = 1 << 2,
} ExpansionFlag;
#define EXPANSION_ALL_FLAGS (ExpansionFlagData | ExpansionFlagStop)
typedef struct {
ExpansionMessageType type;
ExpansionMessageData data;
FuriApiLock api_lock;
} ExpansionMessage;
struct Expansion {
ExpansionState state;
ExpansionSessionState session_state;
ExpansionSessionExitReason exit_reason;
FuriStreamBuffer* rx_buf;
FuriSemaphore* tx_semaphore;
FuriMutex* state_mutex;
FuriThread* worker_thread;
FuriThread* thread;
FuriMessageQueue* queue;
FuriHalSerialId serial_id;
FuriHalSerialHandle* serial_handle;
RpcSession* rpc_session;
ExpansionWorker* worker;
ExpansionState state;
ExpansionSettings settings;
};
static void expansion_detect_callback(void* context);
// Called in UART IRQ context
static void expansion_serial_rx_callback(
FuriHalSerialHandle* handle,
FuriHalSerialRxEvent event,
void* context) {
furi_assert(handle);
furi_assert(context);
Expansion* instance = context;
if(event == FuriHalSerialRxEventData) {
const uint8_t data = furi_hal_serial_async_rx(handle);
furi_stream_buffer_send(instance->rx_buf, &data, sizeof(data), 0);
furi_thread_flags_set(furi_thread_get_id(instance->worker_thread), ExpansionFlagData);
}
}
static size_t expansion_receive_callback(uint8_t* data, size_t data_size, void* context) {
Expansion* instance = context;
size_t received_size = 0;
while(true) {
received_size += furi_stream_buffer_receive(
instance->rx_buf, data + received_size, data_size - received_size, 0);
if(received_size == data_size) break;
const uint32_t flags = furi_thread_flags_wait(
EXPANSION_ALL_FLAGS, FuriFlagWaitAny, furi_ms_to_ticks(EXPANSION_PROTOCOL_TIMEOUT_MS));
if(flags & FuriFlagError) {
if(flags == (unsigned)FuriFlagErrorTimeout) {
// Exiting due to timeout
instance->exit_reason = ExpansionSessionExitReasonTimeout;
} else {
// Exiting due to an unspecified error
instance->exit_reason = ExpansionSessionExitReasonError;
}
break;
} else if(flags & ExpansionFlagStop) {
// Exiting due to explicit request
instance->exit_reason = ExpansionSessionExitReasonUser;
break;
} else if(flags & ExpansionFlagError) {
// Exiting due to RPC error
instance->exit_reason = ExpansionSessionExitReasonError;
break;
} else if(flags & ExpansionFlagData) {
// Go to buffer reading
continue;
}
}
return received_size;
}
static inline bool expansion_receive_frame(Expansion* instance, ExpansionFrame* frame) {
return expansion_protocol_decode(frame, expansion_receive_callback, instance) ==
ExpansionProtocolStatusOk;
}
static size_t expansion_send_callback(const uint8_t* data, size_t data_size, void* context) {
Expansion* instance = context;
furi_hal_serial_tx(instance->serial_handle, data, data_size);
furi_hal_serial_tx_wait_complete(instance->serial_handle);
return data_size;
}
static inline bool expansion_send_frame(Expansion* instance, const ExpansionFrame* frame) {
return expansion_protocol_encode(frame, expansion_send_callback, instance) ==
ExpansionProtocolStatusOk;
}
static bool expansion_send_heartbeat(Expansion* instance) {
const ExpansionFrame frame = {
.header.type = ExpansionFrameTypeHeartbeat,
.content.heartbeat = {},
};
return expansion_send_frame(instance, &frame);
}
static bool expansion_send_status_response(Expansion* instance, ExpansionFrameError error) {
const ExpansionFrame frame = {
.header.type = ExpansionFrameTypeStatus,
.content.status.error = error,
};
return expansion_send_frame(instance, &frame);
}
static bool
expansion_send_data_response(Expansion* instance, const uint8_t* data, size_t data_size) {
furi_assert(data_size <= EXPANSION_PROTOCOL_MAX_DATA_SIZE);
ExpansionFrame frame = {
.header.type = ExpansionFrameTypeData,
.content.data.size = data_size,
};
memcpy(frame.content.data.bytes, data, data_size);
return expansion_send_frame(instance, &frame);
}
// Called in Rpc session thread context
static void expansion_rpc_send_callback(void* context, uint8_t* data, size_t data_size) {
Expansion* instance = context;
for(size_t sent_data_size = 0; sent_data_size < data_size;) {
if(furi_semaphore_acquire(
instance->tx_semaphore, furi_ms_to_ticks(EXPANSION_PROTOCOL_TIMEOUT_MS)) !=
FuriStatusOk) {
furi_thread_flags_set(furi_thread_get_id(instance->worker_thread), ExpansionFlagError);
break;
}
const size_t current_data_size =
MIN(data_size - sent_data_size, EXPANSION_PROTOCOL_MAX_DATA_SIZE);
if(!expansion_send_data_response(instance, data + sent_data_size, current_data_size))
break;
sent_data_size += current_data_size;
}
}
static bool expansion_rpc_session_open(Expansion* instance) {
Rpc* rpc = furi_record_open(RECORD_RPC);
instance->rpc_session = rpc_session_open(rpc, RpcOwnerUart);
if(instance->rpc_session) {
instance->tx_semaphore = furi_semaphore_alloc(1, 1);
rpc_session_set_context(instance->rpc_session, instance);
rpc_session_set_send_bytes_callback(instance->rpc_session, expansion_rpc_send_callback);
}
return instance->rpc_session != NULL;
}
static void expansion_rpc_session_close(Expansion* instance) {
if(instance->rpc_session) {
rpc_session_close(instance->rpc_session);
furi_semaphore_free(instance->tx_semaphore);
}
furi_record_close(RECORD_RPC);
}
static bool
expansion_handle_session_state_handshake(Expansion* instance, const ExpansionFrame* rx_frame) {
bool success = false;
do {
if(rx_frame->header.type != ExpansionFrameTypeBaudRate) break;
const uint32_t baud_rate = rx_frame->content.baud_rate.baud;
FURI_LOG_D(TAG, "Proposed baud rate: %lu", baud_rate);
if(furi_hal_serial_is_baud_rate_supported(instance->serial_handle, baud_rate)) {
instance->session_state = ExpansionSessionStateConnected;
// Send response at previous baud rate
if(!expansion_send_status_response(instance, ExpansionFrameErrorNone)) break;
furi_hal_serial_set_br(instance->serial_handle, baud_rate);
} else {
if(!expansion_send_status_response(instance, ExpansionFrameErrorBaudRate)) break;
FURI_LOG_E(TAG, "Bad baud rate");
}
success = true;
} while(false);
return success;
}
static bool
expansion_handle_session_state_connected(Expansion* instance, const ExpansionFrame* rx_frame) {
bool success = false;
do {
if(rx_frame->header.type == ExpansionFrameTypeControl) {
if(rx_frame->content.control.command != ExpansionFrameControlCommandStartRpc) break;
instance->session_state = ExpansionSessionStateRpcActive;
if(!expansion_rpc_session_open(instance)) break;
if(!expansion_send_status_response(instance, ExpansionFrameErrorNone)) break;
} else if(rx_frame->header.type == ExpansionFrameTypeHeartbeat) {
if(!expansion_send_heartbeat(instance)) break;
} else {
break;
}
success = true;
} while(false);
return success;
}
static bool
expansion_handle_session_state_rpc_active(Expansion* instance, const ExpansionFrame* rx_frame) {
bool success = false;
do {
if(rx_frame->header.type == ExpansionFrameTypeData) {
if(!expansion_send_status_response(instance, ExpansionFrameErrorNone)) break;
const size_t size_consumed = rpc_session_feed(
instance->rpc_session,
rx_frame->content.data.bytes,
rx_frame->content.data.size,
EXPANSION_PROTOCOL_TIMEOUT_MS);
if(size_consumed != rx_frame->content.data.size) break;
} else if(rx_frame->header.type == ExpansionFrameTypeControl) {
if(rx_frame->content.control.command != ExpansionFrameControlCommandStopRpc) break;
instance->session_state = ExpansionSessionStateConnected;
expansion_rpc_session_close(instance);
if(!expansion_send_status_response(instance, ExpansionFrameErrorNone)) break;
} else if(rx_frame->header.type == ExpansionFrameTypeStatus) {
if(rx_frame->content.status.error != ExpansionFrameErrorNone) break;
furi_semaphore_release(instance->tx_semaphore);
} else if(rx_frame->header.type == ExpansionFrameTypeHeartbeat) {
if(!expansion_send_heartbeat(instance)) break;
} else {
break;
}
success = true;
} while(false);
return success;
}
static inline void expansion_state_machine(Expansion* instance) {
typedef bool (*ExpansionSessionStateHandler)(Expansion*, const ExpansionFrame*);
static const ExpansionSessionStateHandler expansion_handlers[] = {
[ExpansionSessionStateHandShake] = expansion_handle_session_state_handshake,
[ExpansionSessionStateConnected] = expansion_handle_session_state_connected,
[ExpansionSessionStateRpcActive] = expansion_handle_session_state_rpc_active,
};
ExpansionFrame rx_frame;
while(true) {
if(!expansion_receive_frame(instance, &rx_frame)) break;
if(!expansion_handlers[instance->session_state](instance, &rx_frame)) break;
}
}
static void expansion_worker_pending_callback(void* context, uint32_t arg) {
furi_assert(context);
UNUSED(arg);
Expansion* instance = context;
furi_thread_join(instance->worker_thread);
// Do not re-enable detection interrupt on user-requested exit
if(instance->exit_reason != ExpansionSessionExitReasonUser) {
furi_check(furi_mutex_acquire(instance->state_mutex, FuriWaitForever) == FuriStatusOk);
instance->state = ExpansionStateEnabled;
furi_hal_serial_control_set_expansion_callback(
instance->serial_id, expansion_detect_callback, instance);
furi_mutex_release(instance->state_mutex);
}
}
static int32_t expansion_worker(void* context) {
furi_assert(context);
Expansion* instance = context;
furi_hal_power_insomnia_enter();
furi_hal_serial_control_set_expansion_callback(instance->serial_id, NULL, NULL);
instance->serial_handle = furi_hal_serial_control_acquire(instance->serial_id);
furi_check(instance->serial_handle);
FURI_LOG_D(TAG, "Service started");
instance->rx_buf = furi_stream_buffer_alloc(EXPANSION_BUFFER_SIZE, 1);
instance->session_state = ExpansionSessionStateHandShake;
instance->exit_reason = ExpansionSessionExitReasonUnknown;
furi_hal_serial_init(instance->serial_handle, EXPANSION_PROTOCOL_DEFAULT_BAUD_RATE);
furi_hal_serial_async_rx_start(
instance->serial_handle, expansion_serial_rx_callback, instance, false);
if(expansion_send_heartbeat(instance)) {
expansion_state_machine(instance);
}
if(instance->session_state == ExpansionSessionStateRpcActive) {
expansion_rpc_session_close(instance);
}
FURI_LOG_D(TAG, "Service stopped");
furi_hal_serial_control_release(instance->serial_handle);
furi_stream_buffer_free(instance->rx_buf);
furi_hal_power_insomnia_exit();
furi_timer_pending_callback(expansion_worker_pending_callback, instance, 0);
return 0;
}
static const char* const expansion_uart_names[] = {
"USART",
"LPUART",
};
// Called from the serial control thread
static void expansion_detect_callback(void* context) {
furi_assert(context);
Expansion* instance = context;
furi_check(furi_mutex_acquire(instance->state_mutex, FuriWaitForever) == FuriStatusOk);
ExpansionMessage message = {
.type = ExpansionMessageTypeModuleConnected,
.api_lock = NULL, // Not locking the API here to avoid a deadlock
};
if(instance->state == ExpansionStateEnabled) {
instance->state = ExpansionStateRunning;
furi_thread_start(instance->worker_thread);
// Not waiting for available queue space, discarding message if there is none
const FuriStatus status = furi_message_queue_put(instance->queue, &message, 0);
UNUSED(status);
}
static void expansion_worker_callback(void* context) {
furi_assert(context);
Expansion* instance = context;
ExpansionMessage message = {
.type = ExpansionMessageTypeModuleDisconnected,
.api_lock = NULL, // Not locking the API here to avoid a deadlock
};
const FuriStatus status = furi_message_queue_put(instance->queue, &message, FuriWaitForever);
furi_check(status == FuriStatusOk);
}
static void
expansion_control_handler_enable(Expansion* instance, const ExpansionMessageData* data) {
UNUSED(data);
if(instance->state != ExpansionStateDisabled) {
return;
}
furi_mutex_release(instance->state_mutex);
if(instance->settings.uart_index < FuriHalSerialIdMax) {
instance->state = ExpansionStateEnabled;
instance->serial_id = instance->settings.uart_index;
furi_hal_serial_control_set_expansion_callback(
instance->serial_id, expansion_detect_callback, instance);
FURI_LOG_D(TAG, "Detection enabled on %s", expansion_uart_names[instance->serial_id]);
}
}
static void
expansion_control_handler_disable(Expansion* instance, const ExpansionMessageData* data) {
UNUSED(data);
if(instance->state == ExpansionStateDisabled) {
return;
} else if(instance->state == ExpansionStateRunning) {
expansion_worker_stop(instance->worker);
expansion_worker_free(instance->worker);
} else {
furi_hal_serial_control_set_expansion_callback(instance->serial_id, NULL, NULL);
}
instance->state = ExpansionStateDisabled;
FURI_LOG_D(TAG, "Detection disabled");
}
static void expansion_control_handler_set_listen_serial(
Expansion* instance,
const ExpansionMessageData* data) {
furi_check(data->serial_id < FuriHalSerialIdMax);
if(instance->state == ExpansionStateRunning) {
expansion_worker_stop(instance->worker);
expansion_worker_free(instance->worker);
} else if(instance->state == ExpansionStateEnabled) {
furi_hal_serial_control_set_expansion_callback(instance->serial_id, NULL, NULL);
}
instance->state = ExpansionStateEnabled;
instance->serial_id = data->serial_id;
furi_hal_serial_control_set_expansion_callback(
instance->serial_id, expansion_detect_callback, instance);
FURI_LOG_D(TAG, "Listen serial changed to %s", expansion_uart_names[instance->serial_id]);
}
static void expansion_control_handler_module_connected(
Expansion* instance,
const ExpansionMessageData* data) {
UNUSED(data);
if(instance->state != ExpansionStateEnabled) {
return;
}
furi_hal_serial_control_set_expansion_callback(instance->serial_id, NULL, NULL);
instance->state = ExpansionStateRunning;
instance->worker = expansion_worker_alloc(instance->serial_id);
expansion_worker_set_callback(instance->worker, expansion_worker_callback, instance);
expansion_worker_start(instance->worker);
}
static void expansion_control_handler_module_disconnected(
Expansion* instance,
const ExpansionMessageData* data) {
UNUSED(data);
if(instance->state != ExpansionStateRunning) {
return;
}
instance->state = ExpansionStateEnabled;
expansion_worker_free(instance->worker);
furi_hal_serial_control_set_expansion_callback(
instance->serial_id, expansion_detect_callback, instance);
}
typedef void (*ExpansionControlHandler)(Expansion*, const ExpansionMessageData*);
static const ExpansionControlHandler expansion_control_handlers[] = {
[ExpansionMessageTypeEnable] = expansion_control_handler_enable,
[ExpansionMessageTypeDisable] = expansion_control_handler_disable,
[ExpansionMessageTypeSetListenSerial] = expansion_control_handler_set_listen_serial,
[ExpansionMessageTypeModuleConnected] = expansion_control_handler_module_connected,
[ExpansionMessageTypeModuleDisconnected] = expansion_control_handler_module_disconnected,
};
static int32_t expansion_control(void* context) {
furi_assert(context);
Expansion* instance = context;
for(;;) {
ExpansionMessage message;
FuriStatus status = furi_message_queue_get(instance->queue, &message, FuriWaitForever);
furi_check(status == FuriStatusOk);
furi_check(message.type < COUNT_OF(expansion_control_handlers));
expansion_control_handlers[message.type](instance, &message.data);
if(message.api_lock != NULL) {
api_lock_unlock(message.api_lock);
}
}
return 0;
}
static Expansion* expansion_alloc() {
Expansion* instance = malloc(sizeof(Expansion));
instance->state_mutex = furi_mutex_alloc(FuriMutexTypeNormal);
instance->worker_thread = furi_thread_alloc_ex(TAG, 768, expansion_worker, instance);
instance->queue =
furi_message_queue_alloc(EXPANSION_CONTROL_QUEUE_SIZE, sizeof(ExpansionMessage));
instance->thread =
furi_thread_alloc_ex(TAG, EXPANSION_CONTROL_STACK_SIZE, expansion_control, instance);
return instance;
}
@@ -396,6 +217,7 @@ void expansion_on_system_start(void* arg) {
Expansion* instance = expansion_alloc();
furi_record_create(RECORD_EXPANSION, instance);
furi_thread_start(instance->thread);
expansion_settings_load(&instance->settings);
expansion_enable(instance);
@@ -404,41 +226,41 @@ void expansion_on_system_start(void* arg) {
// Public API functions
void expansion_enable(Expansion* instance) {
if(instance->settings.uart_index < FuriHalSerialIdMax) {
expansion_set_listen_serial(instance, instance->settings.uart_index);
}
furi_check(instance);
ExpansionMessage message = {
.type = ExpansionMessageTypeEnable,
.api_lock = api_lock_alloc_locked(),
};
furi_message_queue_put(instance->queue, &message, FuriWaitForever);
api_lock_wait_unlock_and_free(message.api_lock);
}
void expansion_disable(Expansion* instance) {
furi_check(furi_mutex_acquire(instance->state_mutex, FuriWaitForever) == FuriStatusOk);
furi_check(instance);
if(instance->state == ExpansionStateRunning) {
furi_thread_flags_set(furi_thread_get_id(instance->worker_thread), ExpansionFlagStop);
furi_thread_join(instance->worker_thread);
} else if(instance->state == ExpansionStateEnabled) {
FURI_LOG_D(TAG, "Detection disabled");
furi_hal_serial_control_set_expansion_callback(instance->serial_id, NULL, NULL);
}
ExpansionMessage message = {
.type = ExpansionMessageTypeDisable,
.api_lock = api_lock_alloc_locked(),
};
instance->state = ExpansionStateDisabled;
furi_mutex_release(instance->state_mutex);
furi_message_queue_put(instance->queue, &message, FuriWaitForever);
api_lock_wait_unlock_and_free(message.api_lock);
}
void expansion_set_listen_serial(Expansion* instance, FuriHalSerialId serial_id) {
expansion_disable(instance);
furi_check(instance);
furi_check(serial_id < FuriHalSerialIdMax);
furi_check(furi_mutex_acquire(instance->state_mutex, FuriWaitForever) == FuriStatusOk);
ExpansionMessage message = {
.type = ExpansionMessageTypeSetListenSerial,
.data.serial_id = serial_id,
.api_lock = api_lock_alloc_locked(),
};
instance->serial_id = serial_id;
instance->state = ExpansionStateEnabled;
furi_hal_serial_control_set_expansion_callback(
instance->serial_id, expansion_detect_callback, instance);
furi_mutex_release(instance->state_mutex);
FURI_LOG_D(TAG, "Detection enabled");
furi_message_queue_put(instance->queue, &message, FuriWaitForever);
api_lock_wait_unlock_and_free(message.api_lock);
}
ExpansionSettings* expansion_get_settings(Expansion* instance) {

396
applications/services/expansion/expansion_worker.c Normal file
View File

@@ -0,0 +1,396 @@
#include "expansion_worker.h"
#include <furi_hal_power.h>
#include <furi_hal_serial.h>
#include <furi_hal_serial_control.h>
#include <furi.h>
#include <rpc/rpc.h>
#include "expansion_protocol.h"
#define TAG "ExpansionSrv"
#define EXPANSION_WORKER_STACK_SZIE (768UL)
#define EXPANSION_WORKER_BUFFER_SIZE (sizeof(ExpansionFrame) + sizeof(ExpansionFrameChecksum))
typedef enum {
ExpansionWorkerStateHandShake,
ExpansionWorkerStateConnected,
ExpansionWorkerStateRpcActive,
} ExpansionWorkerState;
typedef enum {
ExpansionWorkerExitReasonUnknown,
ExpansionWorkerExitReasonUser,
ExpansionWorkerExitReasonError,
ExpansionWorkerExitReasonTimeout,
} ExpansionWorkerExitReason;
typedef enum {
ExpansionWorkerFlagStop = 1 << 0,
ExpansionWorkerFlagData = 1 << 1,
ExpansionWorkerFlagError = 1 << 2,
} ExpansionWorkerFlag;
#define EXPANSION_ALL_FLAGS (ExpansionWorkerFlagData | ExpansionWorkerFlagStop)
struct ExpansionWorker {
FuriThread* thread;
FuriStreamBuffer* rx_buf;
FuriSemaphore* tx_semaphore;
FuriHalSerialId serial_id;
FuriHalSerialHandle* serial_handle;
RpcSession* rpc_session;
ExpansionWorkerState state;
ExpansionWorkerExitReason exit_reason;
ExpansionWorkerCallback callback;
void* cb_context;
};
// Called in UART IRQ context
static void expansion_worker_serial_rx_callback(
FuriHalSerialHandle* handle,
FuriHalSerialRxEvent event,
void* context) {
furi_assert(handle);
furi_assert(context);
ExpansionWorker* instance = context;
if(event & (FuriHalSerialRxEventNoiseError | FuriHalSerialRxEventFrameError |
FuriHalSerialRxEventOverrunError)) {
furi_thread_flags_set(furi_thread_get_id(instance->thread), ExpansionWorkerFlagError);
} else if(event & FuriHalSerialRxEventData) {
while(furi_hal_serial_async_rx_available(handle)) {
const uint8_t data = furi_hal_serial_async_rx(handle);
furi_stream_buffer_send(instance->rx_buf, &data, sizeof(data), 0);
}
furi_thread_flags_set(furi_thread_get_id(instance->thread), ExpansionWorkerFlagData);
}
}
static size_t expansion_worker_receive_callback(uint8_t* data, size_t data_size, void* context) {
ExpansionWorker* instance = context;
size_t received_size = 0;
while(true) {
received_size += furi_stream_buffer_receive(
instance->rx_buf, data + received_size, data_size - received_size, 0);
if(received_size == data_size) break;
const uint32_t flags = furi_thread_flags_wait(
EXPANSION_ALL_FLAGS, FuriFlagWaitAny, furi_ms_to_ticks(EXPANSION_PROTOCOL_TIMEOUT_MS));
if(flags & FuriFlagError) {
if(flags == (unsigned)FuriFlagErrorTimeout) {
// Exiting due to timeout
instance->exit_reason = ExpansionWorkerExitReasonTimeout;
} else {
// Exiting due to an unspecified error
instance->exit_reason = ExpansionWorkerExitReasonError;
}
break;
} else if(flags & ExpansionWorkerFlagStop) {
// Exiting due to explicit request
instance->exit_reason = ExpansionWorkerExitReasonUser;
break;
} else if(flags & ExpansionWorkerFlagError) {
// Exiting due to RPC error
instance->exit_reason = ExpansionWorkerExitReasonError;
break;
} else if(flags & ExpansionWorkerFlagData) {
// Go to buffer reading
continue;
}
}
return received_size;
}
static inline bool
expansion_worker_receive_frame(ExpansionWorker* instance, ExpansionFrame* frame) {
return expansion_protocol_decode(frame, expansion_worker_receive_callback, instance) ==
ExpansionProtocolStatusOk;
}
static size_t
expansion_worker_send_callback(const uint8_t* data, size_t data_size, void* context) {
ExpansionWorker* instance = context;
furi_hal_serial_tx(instance->serial_handle, data, data_size);
furi_hal_serial_tx_wait_complete(instance->serial_handle);
return data_size;
}
static inline bool
expansion_worker_send_frame(ExpansionWorker* instance, const ExpansionFrame* frame) {
return expansion_protocol_encode(frame, expansion_worker_send_callback, instance) ==
ExpansionProtocolStatusOk;
}
static bool expansion_worker_send_heartbeat(ExpansionWorker* instance) {
const ExpansionFrame frame = {
.header.type = ExpansionFrameTypeHeartbeat,
.content.heartbeat = {},
};
return expansion_worker_send_frame(instance, &frame);
}
static bool
expansion_worker_send_status_response(ExpansionWorker* instance, ExpansionFrameError error) {
const ExpansionFrame frame = {
.header.type = ExpansionFrameTypeStatus,
.content.status.error = error,
};
return expansion_worker_send_frame(instance, &frame);
}
static bool expansion_worker_send_data_response(
ExpansionWorker* instance,
const uint8_t* data,
size_t data_size) {
furi_assert(data_size <= EXPANSION_PROTOCOL_MAX_DATA_SIZE);
ExpansionFrame frame = {
.header.type = ExpansionFrameTypeData,
.content.data.size = data_size,
};
memcpy(frame.content.data.bytes, data, data_size);
return expansion_worker_send_frame(instance, &frame);
}
// Called in Rpc session thread context
static void expansion_worker_rpc_send_callback(void* context, uint8_t* data, size_t data_size) {
ExpansionWorker* instance = context;
for(size_t sent_data_size = 0; sent_data_size < data_size;) {
if(furi_semaphore_acquire(
instance->tx_semaphore, furi_ms_to_ticks(EXPANSION_PROTOCOL_TIMEOUT_MS)) !=
FuriStatusOk) {
furi_thread_flags_set(furi_thread_get_id(instance->thread), ExpansionWorkerFlagError);
break;
}
const size_t current_data_size =
MIN(data_size - sent_data_size, EXPANSION_PROTOCOL_MAX_DATA_SIZE);
if(!expansion_worker_send_data_response(instance, data + sent_data_size, current_data_size))
break;
sent_data_size += current_data_size;
}
}
static bool expansion_worker_rpc_session_open(ExpansionWorker* instance) {
Rpc* rpc = furi_record_open(RECORD_RPC);
instance->rpc_session = rpc_session_open(rpc, RpcOwnerUart);
if(instance->rpc_session) {
instance->tx_semaphore = furi_semaphore_alloc(1, 1);
rpc_session_set_context(instance->rpc_session, instance);
rpc_session_set_send_bytes_callback(
instance->rpc_session, expansion_worker_rpc_send_callback);
}
return instance->rpc_session != NULL;
}
static void expansion_worker_rpc_session_close(ExpansionWorker* instance) {
if(instance->rpc_session) {
rpc_session_close(instance->rpc_session);
furi_semaphore_free(instance->tx_semaphore);
}
furi_record_close(RECORD_RPC);
}
static bool expansion_worker_handle_state_handshake(
ExpansionWorker* instance,
const ExpansionFrame* rx_frame) {
bool success = false;
do {
if(rx_frame->header.type != ExpansionFrameTypeBaudRate) break;
const uint32_t baud_rate = rx_frame->content.baud_rate.baud;
FURI_LOG_D(TAG, "Proposed baud rate: %lu", baud_rate);
if(furi_hal_serial_is_baud_rate_supported(instance->serial_handle, baud_rate)) {
instance->state = ExpansionWorkerStateConnected;
// Send response at previous baud rate
if(!expansion_worker_send_status_response(instance, ExpansionFrameErrorNone)) break;
furi_hal_serial_set_br(instance->serial_handle, baud_rate);
} else {
if(!expansion_worker_send_status_response(instance, ExpansionFrameErrorBaudRate))
break;
FURI_LOG_E(TAG, "Bad baud rate");
}
success = true;
} while(false);
return success;
}
static bool expansion_worker_handle_state_connected(
ExpansionWorker* instance,
const ExpansionFrame* rx_frame) {
bool success = false;
do {
if(rx_frame->header.type == ExpansionFrameTypeControl) {
if(rx_frame->content.control.command != ExpansionFrameControlCommandStartRpc) break;
instance->state = ExpansionWorkerStateRpcActive;
if(!expansion_worker_rpc_session_open(instance)) break;
if(!expansion_worker_send_status_response(instance, ExpansionFrameErrorNone)) break;
} else if(rx_frame->header.type == ExpansionFrameTypeHeartbeat) {
if(!expansion_worker_send_heartbeat(instance)) break;
} else {
break;
}
success = true;
} while(false);
return success;
}
static bool expansion_worker_handle_state_rpc_active(
ExpansionWorker* instance,
const ExpansionFrame* rx_frame) {
bool success = false;
do {
if(rx_frame->header.type == ExpansionFrameTypeData) {
if(!expansion_worker_send_status_response(instance, ExpansionFrameErrorNone)) break;
const size_t size_consumed = rpc_session_feed(
instance->rpc_session,
rx_frame->content.data.bytes,
rx_frame->content.data.size,
EXPANSION_PROTOCOL_TIMEOUT_MS);
if(size_consumed != rx_frame->content.data.size) break;
} else if(rx_frame->header.type == ExpansionFrameTypeControl) {
if(rx_frame->content.control.command != ExpansionFrameControlCommandStopRpc) break;
instance->state = ExpansionWorkerStateConnected;
expansion_worker_rpc_session_close(instance);
if(!expansion_worker_send_status_response(instance, ExpansionFrameErrorNone)) break;
} else if(rx_frame->header.type == ExpansionFrameTypeStatus) {
if(rx_frame->content.status.error != ExpansionFrameErrorNone) break;
furi_semaphore_release(instance->tx_semaphore);
} else if(rx_frame->header.type == ExpansionFrameTypeHeartbeat) {
if(!expansion_worker_send_heartbeat(instance)) break;
} else {
break;
}
success = true;
} while(false);
return success;
}
typedef bool (*ExpansionWorkerStateHandler)(ExpansionWorker*, const ExpansionFrame*);
static const ExpansionWorkerStateHandler expansion_handlers[] = {
[ExpansionWorkerStateHandShake] = expansion_worker_handle_state_handshake,
[ExpansionWorkerStateConnected] = expansion_worker_handle_state_connected,
[ExpansionWorkerStateRpcActive] = expansion_worker_handle_state_rpc_active,
};
static inline void expansion_worker_state_machine(ExpansionWorker* instance) {
ExpansionFrame rx_frame;
while(true) {
if(!expansion_worker_receive_frame(instance, &rx_frame)) break;
if(!expansion_handlers[instance->state](instance, &rx_frame)) break;
}
}
static int32_t expansion_worker(void* context) {
furi_assert(context);
ExpansionWorker* instance = context;
furi_hal_power_insomnia_enter();
instance->serial_handle = furi_hal_serial_control_acquire(instance->serial_id);
furi_check(instance->serial_handle);
FURI_LOG_D(TAG, "Worker started");
instance->state = ExpansionWorkerStateHandShake;
instance->exit_reason = ExpansionWorkerExitReasonUnknown;
furi_hal_serial_init(instance->serial_handle, EXPANSION_PROTOCOL_DEFAULT_BAUD_RATE);
furi_hal_serial_async_rx_start(
instance->serial_handle, expansion_worker_serial_rx_callback, instance, true);
if(expansion_worker_send_heartbeat(instance)) {
expansion_worker_state_machine(instance);
}
if(instance->state == ExpansionWorkerStateRpcActive) {
expansion_worker_rpc_session_close(instance);
}
FURI_LOG_D(TAG, "Worker stopped");
furi_hal_serial_control_release(instance->serial_handle);
furi_hal_power_insomnia_exit();
// Do not invoke worker callback on user-requested exit
if((instance->exit_reason != ExpansionWorkerExitReasonUser) && (instance->callback != NULL)) {
instance->callback(instance->cb_context);
}
return 0;
}
ExpansionWorker* expansion_worker_alloc(FuriHalSerialId serial_id) {
ExpansionWorker* instance = malloc(sizeof(ExpansionWorker));
instance->thread = furi_thread_alloc_ex(
TAG "Worker", EXPANSION_WORKER_STACK_SZIE, expansion_worker, instance);
instance->rx_buf = furi_stream_buffer_alloc(EXPANSION_WORKER_BUFFER_SIZE, 1);
instance->serial_id = serial_id;
// Improves responsiveness in heavy games at the expense of dropped frames
furi_thread_set_priority(instance->thread, FuriThreadPriorityLow);
return instance;
}
void expansion_worker_free(ExpansionWorker* instance) {
furi_stream_buffer_free(instance->rx_buf);
furi_thread_join(instance->thread);
furi_thread_free(instance->thread);
free(instance);
}
void expansion_worker_set_callback(
ExpansionWorker* instance,
ExpansionWorkerCallback callback,
void* context) {
instance->callback = callback;
instance->cb_context = context;
}
void expansion_worker_start(ExpansionWorker* instance) {
furi_thread_start(instance->thread);
}
void expansion_worker_stop(ExpansionWorker* instance) {
furi_thread_flags_set(furi_thread_get_id(instance->thread), ExpansionWorkerFlagStop);
furi_thread_join(instance->thread);
}

78
applications/services/expansion/expansion_worker.h Normal file
View File

@@ -0,0 +1,78 @@
/**
* @file expansion_worker.h
* @brief Expansion module handling thread wrapper.
*
* The worker is started each time an expansion module is detected
* and handles all of the communication protocols. Likewise, it is stopped
* upon module disconnection or communication error.
*
* @warning This file is a private implementation detail. Please do not attempt to use it in applications.
*/
#pragma once
#include <furi_hal_serial_types.h>
/**
* @brief Expansion worker opaque type declaration.
*/
typedef struct ExpansionWorker ExpansionWorker;
/**
* @brief Worker callback type.
*
* @see expansion_worker_set_callback()
*
* @param[in,out] context pointer to a user-defined object.
*/
typedef void (*ExpansionWorkerCallback)(void* context);
/**
* @brief Create an expansion worker instance.
*
* @param[in] serial_id numerical identifier of the serial to be used by the worker.
* @returns pointer to the created instance.
*/
ExpansionWorker* expansion_worker_alloc(FuriHalSerialId serial_id);
/**
* @brief Delete an expansion worker instance.
*
* @param[in,out] instance pointer to the instance to be deleted.
*/
void expansion_worker_free(ExpansionWorker* instance);
/**
* @brief Set the module disconnect callback.
*
* The callback will be triggered upon worker stop EXCEPT
* when it was stopped via an expansion_worker_stop() call.
*
* In other words, the callback will ONLY be triggered if the worker was
* stopped due to the user disconnecting/resetting/powering down the module,
* or due to some communication error.
*
* @param[in,out] instance pointer to the worker instance to be modified.
* @param[in] callback pointer to the callback function to be called under the above conditions.
* @param[in] context pointer to a user-defined object, will be passed as a parameter to the callback.
*/
void expansion_worker_set_callback(
ExpansionWorker* instance,
ExpansionWorkerCallback callback,
void* context);
/**
* @brief Start the expansion module worker.
*
* @param[in,out] instance pointer to the worker instance to be started.
*/
void expansion_worker_start(ExpansionWorker* instance);
/**
* @brief Stop the expansion module worker.
*
* If the worker was stopped via this call (and not because of module disconnect/
* protocol error), the callback will not be triggered.
*
* @param[in,out] instance pointer to the worker instance to be stopped.
*/
void expansion_worker_stop(ExpansionWorker* instance);

55
applications/services/gui/canvas.c
View File

@@ -19,6 +19,12 @@ Canvas* canvas_init() {
Canvas* canvas = malloc(sizeof(Canvas));
canvas->compress_icon = compress_icon_alloc();
// Initialize mutex
canvas->mutex = furi_mutex_alloc(FuriMutexTypeNormal);
// Initialize callback array
CanvasCallbackPairArray_init(canvas->canvas_callback_pair);
// Setup u8g2
u8g2_Setup_st756x_flipper(&canvas->fb, U8G2_R0, u8x8_hw_spi_stm32, u8g2_gpio_and_delay_stm32);
canvas->orientation = CanvasOrientationHorizontal;
@@ -37,9 +43,21 @@ Canvas* canvas_init() {
void canvas_free(Canvas* canvas) {
furi_assert(canvas);
compress_icon_free(canvas->compress_icon);
CanvasCallbackPairArray_clear(canvas->canvas_callback_pair);
furi_mutex_free(canvas->mutex);
free(canvas);
}
static void canvas_lock(Canvas* canvas) {
furi_assert(canvas);
furi_check(furi_mutex_acquire(canvas->mutex, FuriWaitForever) == FuriStatusOk);
}
static void canvas_unlock(Canvas* canvas) {
furi_assert(canvas);
furi_check(furi_mutex_release(canvas->mutex) == FuriStatusOk);
}
void canvas_reset(Canvas* canvas) {
furi_assert(canvas);
@@ -53,6 +71,18 @@ void canvas_reset(Canvas* canvas) {
void canvas_commit(Canvas* canvas) {
furi_assert(canvas);
u8g2_SendBuffer(&canvas->fb);
// Iterate over callbacks
canvas_lock(canvas);
for
M_EACH(p, canvas->canvas_callback_pair, CanvasCallbackPairArray_t) {
p->callback(
canvas_get_buffer(canvas),
canvas_get_buffer_size(canvas),
canvas_get_orientation(canvas),
p->context);
}
canvas_unlock(canvas);
}
uint8_t* canvas_get_buffer(Canvas* canvas) {
@@ -567,3 +597,28 @@ void canvas_set_orientation(Canvas* canvas, CanvasOrientation orientation) {
CanvasOrientation canvas_get_orientation(const Canvas* canvas) {
return canvas->orientation;
}
void canvas_add_framebuffer_callback(Canvas* canvas, CanvasCommitCallback callback, void* context) {
furi_assert(canvas);
const CanvasCallbackPair p = {callback, context};
canvas_lock(canvas);
furi_assert(!CanvasCallbackPairArray_count(canvas->canvas_callback_pair, p));
CanvasCallbackPairArray_push_back(canvas->canvas_callback_pair, p);
canvas_unlock(canvas);
}
void canvas_remove_framebuffer_callback(
Canvas* canvas,
CanvasCommitCallback callback,
void* context) {
furi_assert(canvas);
const CanvasCallbackPair p = {callback, context};
canvas_lock(canvas);
furi_assert(CanvasCallbackPairArray_count(canvas->canvas_callback_pair, p) == 1);
CanvasCallbackPairArray_remove_val(canvas->canvas_callback_pair, p);
canvas_unlock(canvas);
}

45
applications/services/gui/canvas_i.h
View File

@@ -8,11 +8,31 @@
#include "canvas.h"
#include <u8g2.h>
#include <toolbox/compress.h>
#include <m-array.h>
#include <m-algo.h>
#include <furi.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef void (*CanvasCommitCallback)(
uint8_t* data,
size_t size,
CanvasOrientation orientation,
void* context);
typedef struct {
CanvasCommitCallback callback;
void* context;
} CanvasCallbackPair;
ARRAY_DEF(CanvasCallbackPairArray, CanvasCallbackPair, M_POD_OPLIST);
#define M_OPL_CanvasCallbackPairArray_t() ARRAY_OPLIST(CanvasCallbackPairArray, M_POD_OPLIST)
ALGO_DEF(CanvasCallbackPairArray, CanvasCallbackPairArray_t);
/** Canvas structure
*/
struct Canvas {
@@ -23,6 +43,8 @@ struct Canvas {
uint8_t width;
uint8_t height;
CompressIcon* compress_icon;
CanvasCallbackPairArray_t canvas_callback_pair;
FuriMutex* mutex;
};
/** Allocate memory and initialize canvas
@@ -102,6 +124,27 @@ void canvas_draw_u8g2_bitmap(
const uint8_t* bitmap,
uint8_t rotation);
/** Add canvas commit callback.
*
* This callback will be called upon Canvas commit.
*
* @param canvas Canvas instance
* @param callback CanvasCommitCallback
* @param context CanvasCommitCallback context
*/
void canvas_add_framebuffer_callback(Canvas* canvas, CanvasCommitCallback callback, void* context);
/** Remove canvas commit callback.
*
* @param canvas Canvas instance
* @param callback CanvasCommitCallback
* @param context CanvasCommitCallback context
*/
void canvas_remove_framebuffer_callback(
Canvas* canvas,
CanvasCommitCallback callback,
void* context);
#ifdef __cplusplus
}
#endif
#endif

27
applications/services/gui/gui.c
View File

@@ -265,14 +265,6 @@ static void gui_redraw(Gui* gui) {
}
canvas_commit(gui->canvas);
for
M_EACH(p, gui->canvas_callback_pair, CanvasCallbackPairArray_t) {
p->callback(
canvas_get_buffer(gui->canvas),
canvas_get_buffer_size(gui->canvas),
canvas_get_orientation(gui->canvas),
p->context);
}
} while(false);
gui_unlock(gui);
@@ -473,12 +465,7 @@ void gui_view_port_send_to_back(Gui* gui, ViewPort* view_port) {
void gui_add_framebuffer_callback(Gui* gui, GuiCanvasCommitCallback callback, void* context) {
furi_assert(gui);
const CanvasCallbackPair p = {callback, context};
gui_lock(gui);
furi_assert(!CanvasCallbackPairArray_count(gui->canvas_callback_pair, p));
CanvasCallbackPairArray_push_back(gui->canvas_callback_pair, p);
gui_unlock(gui);
canvas_add_framebuffer_callback(gui->canvas, callback, context);
// Request redraw
gui_update(gui);
@@ -487,12 +474,7 @@ void gui_add_framebuffer_callback(Gui* gui, GuiCanvasCommitCallback callback, vo
void gui_remove_framebuffer_callback(Gui* gui, GuiCanvasCommitCallback callback, void* context) {
furi_assert(gui);
const CanvasCallbackPair p = {callback, context};
gui_lock(gui);
furi_assert(CanvasCallbackPairArray_count(gui->canvas_callback_pair, p) == 1);
CanvasCallbackPairArray_remove_val(gui->canvas_callback_pair, p);
gui_unlock(gui);
canvas_remove_framebuffer_callback(gui->canvas, callback, context);
}
size_t gui_get_framebuffer_size(const Gui* gui) {
@@ -542,20 +524,19 @@ Gui* gui_alloc() {
gui->thread_id = furi_thread_get_current_id();
// Allocate mutex
gui->mutex = furi_mutex_alloc(FuriMutexTypeNormal);
furi_check(gui->mutex);
// Layers
for(size_t i = 0; i < GuiLayerMAX; i++) {
ViewPortArray_init(gui->layers[i]);
}
// Drawing canvas
gui->canvas = canvas_init();
CanvasCallbackPairArray_init(gui->canvas_callback_pair);
// Input
gui->input_queue = furi_message_queue_alloc(8, sizeof(InputEvent));
gui->input_events = furi_record_open(RECORD_INPUT_EVENTS);
furi_check(gui->input_events);
furi_pubsub_subscribe(gui->input_events, gui_input_events_callback, gui);
return gui;

13
applications/services/gui/gui_i.h
View File

@@ -10,7 +10,6 @@
#include <furi.h>
#include <furi_hal_rtc.h>
#include <m-array.h>
#include <m-algo.h>
#include <stdio.h>
#include "canvas.h"
@@ -44,17 +43,6 @@
ARRAY_DEF(ViewPortArray, ViewPort*, M_PTR_OPLIST);
typedef struct {
GuiCanvasCommitCallback callback;
void* context;
} CanvasCallbackPair;
ARRAY_DEF(CanvasCallbackPairArray, CanvasCallbackPair, M_POD_OPLIST);
#define M_OPL_CanvasCallbackPairArray_t() ARRAY_OPLIST(CanvasCallbackPairArray, M_POD_OPLIST)
ALGO_DEF(CanvasCallbackPairArray, CanvasCallbackPairArray_t);
/** Gui structure */
struct Gui {
// Thread and lock
@@ -66,7 +54,6 @@ struct Gui {
bool direct_draw;
ViewPortArray_t layers[GuiLayerMAX];
Canvas* canvas;
CanvasCallbackPairArray_t canvas_callback_pair;
// Input
FuriMessageQueue* input_queue;

6
applications/services/rpc/rpc.c
View File

@@ -189,6 +189,12 @@ bool rpc_pb_stream_read(pb_istream_t* istream, pb_byte_t* buf, size_t count) {
furi_assert(session);
furi_assert(istream->bytes_left);
/* TODO FL-3768 this function may be called after
marking the worker for termination */
if(session->terminate) {
return false;
}
uint32_t flags = 0;
size_t bytes_received = 0;

38
applications/services/rpc/rpc_gui.c
View File

@@ -54,6 +54,7 @@ typedef enum {
typedef struct {
RpcSession* session;
Gui* gui;
const Icon* icon;
// Receive part
ViewPort* virtual_display_view_port;
@@ -380,10 +381,19 @@ static void rpc_system_gui_virtual_display_frame_process(const PB_Main* request,
(void)session;
}
static const Icon* rpc_system_gui_get_owner_icon(RpcOwner owner) {
switch(owner) {
case RpcOwnerUart:
return &I_Exp_module_connected_12x8;
default:
return &I_Rpc_active_7x8;
}
}
static void rpc_active_session_icon_draw_callback(Canvas* canvas, void* context) {
UNUSED(context);
furi_assert(canvas);
canvas_draw_icon(canvas, 0, 0, &I_Rpc_active_7x8);
RpcGuiSystem* rpc_gui = context;
canvas_draw_icon(canvas, 0, 0, rpc_gui->icon);
}
void* rpc_system_gui_alloc(RpcSession* session) {
@@ -394,16 +404,16 @@ void* rpc_system_gui_alloc(RpcSession* session) {
rpc_gui->session = session;
// Active session icon
rpc_gui->rpc_session_active_viewport = view_port_alloc();
view_port_set_width(rpc_gui->rpc_session_active_viewport, icon_get_width(&I_Rpc_active_7x8));
view_port_draw_callback_set(
rpc_gui->rpc_session_active_viewport, rpc_active_session_icon_draw_callback, session);
if(rpc_session_get_owner(rpc_gui->session) != RpcOwnerBle) {
view_port_enabled_set(rpc_gui->rpc_session_active_viewport, true);
} else {
view_port_enabled_set(rpc_gui->rpc_session_active_viewport, false);
const RpcOwner owner = rpc_session_get_owner(rpc_gui->session);
if(owner != RpcOwnerBle) {
rpc_gui->icon = rpc_system_gui_get_owner_icon(owner);
rpc_gui->rpc_session_active_viewport = view_port_alloc();
view_port_set_width(rpc_gui->rpc_session_active_viewport, icon_get_width(rpc_gui->icon));
view_port_draw_callback_set(
rpc_gui->rpc_session_active_viewport, rpc_active_session_icon_draw_callback, rpc_gui);
gui_add_view_port(
rpc_gui->gui, rpc_gui->rpc_session_active_viewport, GuiLayerStatusBarLeft);
}
gui_add_view_port(rpc_gui->gui, rpc_gui->rpc_session_active_viewport, GuiLayerStatusBarLeft);
RpcHandler rpc_handler = {
.message_handler = NULL,
@@ -445,8 +455,10 @@ void rpc_system_gui_free(void* context) {
rpc_gui->virtual_display_not_empty = false;
}
gui_remove_view_port(rpc_gui->gui, rpc_gui->rpc_session_active_viewport);
view_port_free(rpc_gui->rpc_session_active_viewport);
if(rpc_gui->rpc_session_active_viewport) {
gui_remove_view_port(rpc_gui->gui, rpc_gui->rpc_session_active_viewport);
view_port_free(rpc_gui->rpc_session_active_viewport);
}
if(rpc_gui->is_streaming) {
rpc_gui->is_streaming = false;

2
applications/system/hid_app/views/hid_ptt.c
View File

@@ -276,7 +276,7 @@ static void hid_ptt_stop_ptt_linux_teamspeak(HidPushToTalk* hid_ptt) {
// teams
static void hid_ptt_start_ptt_macos_teams(HidPushToTalk* hid_ptt) {
hid_hal_keyboard_press(hid_ptt->hid, KEY_MOD_LEFT_GUI | HID_KEYBOARD_SPACEBAR);
hid_hal_keyboard_press(hid_ptt->hid, KEY_MOD_LEFT_ALT | HID_KEYBOARD_SPACEBAR);
}
static void hid_ptt_start_ptt_linux_teams(HidPushToTalk* hid_ptt) {
hid_hal_keyboard_press(hid_ptt->hid, KEY_MOD_LEFT_CTRL | HID_KEYBOARD_SPACEBAR);