mirror of
https://github.com/DarkFlippers/unleashed-firmware.git
synced 2025-12-12 12:42:30 +04:00
Merge branch 'fz-dev' into dev
This commit is contained in:
MX
@@ -3,15 +3,15 @@
|
||||
Nice to see you reading this document, we really appreciate it.
|
||||
|
||||
As all documents of this kind it's unable to cover everything.
|
||||
But it will cover general rules that we enforcing on PR review.
|
||||
But it will cover general rules that we are enforcing on PR review.
|
||||
|
||||
Also we already have automatic rules checking and formatting,
|
||||
but it got it's limitations and this guide is still mandatory.
|
||||
Also, we already have automatic rules checking and formatting,
|
||||
but it got its limitations and this guide is still mandatory.
|
||||
|
||||
Some part of this project do have it's own naming and coding guides.
|
||||
Some part of this project do have its own naming and coding guides.
|
||||
For example: assets. Take a look into `ReadMe.md` in assets folder for more details.
|
||||
|
||||
Also 3rd party libraries are none of our concern.
|
||||
Also, 3rd party libraries are none of our concern.
|
||||
|
||||
And yes, this set is not final and we are open to discussion.
|
||||
If you want to add/remove/change something here please feel free to open new ticket.
|
||||
@@ -30,7 +30,7 @@ Our guide is inspired by, but not claiming to be compatible with:
|
||||
|
||||
Code we write is intended to be public.
|
||||
Avoid one-liners from hell and keep code complexity under control.
|
||||
Try to make code self explanatory and add comments if needed.
|
||||
Try to make code self-explanatory and add comments if needed.
|
||||
Leave references to standards that you are implementing.
|
||||
Use project wiki to document new/reverse engineered standards.
|
||||
|
||||
@@ -89,7 +89,7 @@ Enforced by linter.
|
||||
Suffixes:
|
||||
|
||||
- `alloc` - allocate and init instance. C style constructor. Returns pointer to instance.
|
||||
- `free` - deinit and release instance. C style destructor. Takes pointer to instance.
|
||||
- `free` - de-init and release instance. C style destructor. Takes pointer to instance.
|
||||
|
||||
# C++ coding style
|
||||
|
||||
|
||||
21
Makefile
21
Makefile
@@ -1,21 +0,0 @@
|
||||
$(info +-------------------------------------------------+)
|
||||
$(info | |)
|
||||
$(info | Hello, this is Flipper team speaking! |)
|
||||
$(info | |)
|
||||
$(info | We've migrated to new build system |)
|
||||
$(info | It's nice and based on scons |)
|
||||
$(info | |)
|
||||
$(info | Crash course: |)
|
||||
$(info | |)
|
||||
$(info | `./fbt` |)
|
||||
$(info | `./fbt flash` |)
|
||||
$(info | `./fbt debug` |)
|
||||
$(info | |)
|
||||
$(info | More details in documentation/fbt.md |)
|
||||
$(info | |)
|
||||
$(info | Also Please leave your feedback here: |)
|
||||
$(info | https://flipp.dev/4RDu |)
|
||||
$(info | or |)
|
||||
$(info | https://flipp.dev/2XM8 |)
|
||||
$(info | |)
|
||||
$(info +-------------------------------------------------+)
|
||||
@@ -236,7 +236,7 @@ Games:
|
||||
|
||||
- `applications` - Applications and services used in firmware
|
||||
- `assets` - Assets used by applications and services
|
||||
- `furi` - Furi Core: os level primitives and helpers
|
||||
- `furi` - Furi Core: OS-level primitives and helpers
|
||||
- `debug` - Debug tool: GDB-plugins, SVD-file and etc
|
||||
- `documentation` - Documentation generation system configs and input files
|
||||
- `firmware` - Firmware source code
|
||||
@@ -244,4 +244,4 @@ Games:
|
||||
- `site_scons` - Build helpers
|
||||
- `scripts` - Supplementary scripts and python libraries home
|
||||
|
||||
Also pay attention to `ReadMe.md` files inside those directories.
|
||||
Also, pay attention to `ReadMe.md` files inside those directories.
|
||||
|
||||
14
SConstruct
14
SConstruct
@@ -194,6 +194,20 @@ firmware_bm_flash = distenv.PhonyTarget(
|
||||
],
|
||||
)
|
||||
|
||||
gdb_backtrace_all_threads = distenv.PhonyTarget(
|
||||
"gdb_trace_all",
|
||||
"$GDB $GDBOPTS $SOURCES $GDBFLASH",
|
||||
source=firmware_env["FW_ELF"],
|
||||
GDBOPTS="${GDBOPTS_BASE}",
|
||||
GDBREMOTE="${OPENOCD_GDB_PIPE}",
|
||||
GDBFLASH=[
|
||||
"-ex",
|
||||
"thread apply all bt",
|
||||
"-ex",
|
||||
"quit",
|
||||
],
|
||||
)
|
||||
|
||||
# Debugging firmware
|
||||
firmware_debug = distenv.PhonyTarget(
|
||||
"debug",
|
||||
|
||||
@@ -60,7 +60,13 @@ static void dict_attack_draw_callback(Canvas* canvas, void* model) {
|
||||
if(progress > 1.0) {
|
||||
progress = 1.0;
|
||||
}
|
||||
snprintf(draw_str, sizeof(draw_str), "%d/%d", m->dict_keys_current, m->dict_keys_total);
|
||||
if(m->dict_keys_current == 0) {
|
||||
// Cause when people see 0 they think it's broken
|
||||
snprintf(draw_str, sizeof(draw_str), "%d/%d", 1, m->dict_keys_total);
|
||||
} else {
|
||||
snprintf(
|
||||
draw_str, sizeof(draw_str), "%d/%d", m->dict_keys_current, m->dict_keys_total);
|
||||
}
|
||||
elements_progress_bar_with_text(canvas, 0, 20, 128, dict_progress, draw_str);
|
||||
canvas_set_font(canvas, FontSecondary);
|
||||
snprintf(draw_str, sizeof(draw_str), "Keys found: %d/%d", m->keys_found, m->keys_total);
|
||||
|
||||
@@ -18,6 +18,9 @@
|
||||
|
||||
#define PICOPASS_CSN_BLOCK_INDEX 0
|
||||
#define PICOPASS_CONFIG_BLOCK_INDEX 1
|
||||
#define PICOPASS_EPURSE_BLOCK_INDEX 2
|
||||
#define PICOPASS_KD_BLOCK_INDEX 3
|
||||
#define PICOPASS_KC_BLOCK_INDEX 4
|
||||
#define PICOPASS_AIA_BLOCK_INDEX 5
|
||||
|
||||
#define PICOPASS_APP_FOLDER ANY_PATH("picopass")
|
||||
|
||||
@@ -175,13 +175,12 @@ ReturnCode picopass_read_preauth(PicopassBlock* AA1) {
|
||||
return ERR_NONE;
|
||||
}
|
||||
|
||||
ReturnCode picopass_auth(PicopassBlock* AA1, PicopassPacs* pacs) {
|
||||
static ReturnCode picopass_auth_standard(uint8_t* csn, uint8_t* div_key) {
|
||||
rfalPicoPassReadCheckRes rcRes;
|
||||
rfalPicoPassCheckRes chkRes;
|
||||
|
||||
ReturnCode err;
|
||||
|
||||
uint8_t div_key[8] = {0};
|
||||
uint8_t mac[4] = {0};
|
||||
uint8_t ccnr[12] = {0};
|
||||
|
||||
@@ -192,26 +191,34 @@ ReturnCode picopass_auth(PicopassBlock* AA1, PicopassPacs* pacs) {
|
||||
}
|
||||
memcpy(ccnr, rcRes.CCNR, sizeof(rcRes.CCNR)); // last 4 bytes left 0
|
||||
|
||||
loclass_diversifyKey(AA1[PICOPASS_CSN_BLOCK_INDEX].data, picopass_iclass_key, div_key);
|
||||
loclass_diversifyKey(csn, picopass_iclass_key, div_key);
|
||||
loclass_opt_doReaderMAC(ccnr, div_key, mac);
|
||||
|
||||
err = rfalPicoPassPollerCheck(mac, &chkRes);
|
||||
if(err == ERR_NONE) {
|
||||
return ERR_NONE;
|
||||
}
|
||||
FURI_LOG_E(TAG, "rfalPicoPassPollerCheck error %d", err);
|
||||
return rfalPicoPassPollerCheck(mac, &chkRes);
|
||||
}
|
||||
|
||||
FURI_LOG_E(TAG, "Starting dictionary attack");
|
||||
static ReturnCode picopass_auth_dict(
|
||||
uint8_t* csn,
|
||||
PicopassPacs* pacs,
|
||||
uint8_t* div_key,
|
||||
IclassEliteDictType dict_type) {
|
||||
rfalPicoPassReadCheckRes rcRes;
|
||||
rfalPicoPassCheckRes chkRes;
|
||||
|
||||
ReturnCode err = ERR_PARAM;
|
||||
|
||||
uint8_t mac[4] = {0};
|
||||
uint8_t ccnr[12] = {0};
|
||||
|
||||
size_t index = 0;
|
||||
uint8_t key[PICOPASS_BLOCK_LEN] = {0};
|
||||
|
||||
if(!iclass_elite_dict_check_presence(IclassEliteDictTypeFlipper)) {
|
||||
if(!iclass_elite_dict_check_presence(dict_type)) {
|
||||
FURI_LOG_E(TAG, "Dictionary not found");
|
||||
return ERR_PARAM;
|
||||
}
|
||||
|
||||
IclassEliteDict* dict = iclass_elite_dict_alloc(IclassEliteDictTypeFlipper);
|
||||
IclassEliteDict* dict = iclass_elite_dict_alloc(dict_type);
|
||||
if(!dict) {
|
||||
FURI_LOG_E(TAG, "Dictionary not allocated");
|
||||
return ERR_PARAM;
|
||||
@@ -235,11 +242,11 @@ ReturnCode picopass_auth(PicopassBlock* AA1, PicopassPacs* pacs) {
|
||||
err = rfalPicoPassPollerReadCheck(&rcRes);
|
||||
if(err != ERR_NONE) {
|
||||
FURI_LOG_E(TAG, "rfalPicoPassPollerReadCheck error %d", err);
|
||||
return err;
|
||||
break;
|
||||
}
|
||||
memcpy(ccnr, rcRes.CCNR, sizeof(rcRes.CCNR)); // last 4 bytes left 0
|
||||
|
||||
loclass_iclass_calc_div_key(AA1[PICOPASS_CSN_BLOCK_INDEX].data, key, div_key, true);
|
||||
loclass_iclass_calc_div_key(csn, key, div_key, true);
|
||||
loclass_opt_doReaderMAC(ccnr, div_key, mac);
|
||||
|
||||
err = rfalPicoPassPollerCheck(mac, &chkRes);
|
||||
@@ -254,6 +261,39 @@ ReturnCode picopass_auth(PicopassBlock* AA1, PicopassPacs* pacs) {
|
||||
return err;
|
||||
}
|
||||
|
||||
ReturnCode picopass_auth(PicopassBlock* AA1, PicopassPacs* pacs) {
|
||||
ReturnCode err;
|
||||
|
||||
FURI_LOG_E(TAG, "Trying standard legacy key");
|
||||
err = picopass_auth_standard(
|
||||
AA1[PICOPASS_CSN_BLOCK_INDEX].data, AA1[PICOPASS_KD_BLOCK_INDEX].data);
|
||||
if(err == ERR_NONE) {
|
||||
return ERR_NONE;
|
||||
}
|
||||
|
||||
FURI_LOG_E(TAG, "Starting user dictionary attack");
|
||||
err = picopass_auth_dict(
|
||||
AA1[PICOPASS_CSN_BLOCK_INDEX].data,
|
||||
pacs,
|
||||
AA1[PICOPASS_KD_BLOCK_INDEX].data,
|
||||
IclassEliteDictTypeUser);
|
||||
if(err == ERR_NONE) {
|
||||
return ERR_NONE;
|
||||
}
|
||||
|
||||
FURI_LOG_E(TAG, "Starting in-built dictionary attack");
|
||||
err = picopass_auth_dict(
|
||||
AA1[PICOPASS_CSN_BLOCK_INDEX].data,
|
||||
pacs,
|
||||
AA1[PICOPASS_KD_BLOCK_INDEX].data,
|
||||
IclassEliteDictTypeFlipper);
|
||||
if(err == ERR_NONE) {
|
||||
return ERR_NONE;
|
||||
}
|
||||
|
||||
return err;
|
||||
}
|
||||
|
||||
ReturnCode picopass_read_card(PicopassBlock* AA1) {
|
||||
ReturnCode err;
|
||||
|
||||
@@ -262,6 +302,11 @@ ReturnCode picopass_read_card(PicopassBlock* AA1) {
|
||||
PICOPASS_MAX_APP_LIMIT;
|
||||
|
||||
for(size_t i = 2; i < app_limit; i++) {
|
||||
if(i == PICOPASS_KD_BLOCK_INDEX) {
|
||||
// Skip over Kd block which is populated earlier (READ of Kd returns all FF's)
|
||||
continue;
|
||||
}
|
||||
|
||||
rfalPicoPassReadBlockRes block;
|
||||
err = rfalPicoPassPollerReadBlock(i, &block);
|
||||
if(err != ERR_NONE) {
|
||||
|
||||
@@ -26,7 +26,7 @@ Version: 1
|
||||
- `Name` - name of animation. Must be exact animation directory name.
|
||||
- `Min butthurt`, `Max butthurt` - range of dolphin's butthurt for this animation.
|
||||
- `Min level`, `Max level` - range of dolphin's level for this animation. If 0, this animation doesn't participate in random idle animation selection and can only be selected by exact name.
|
||||
- `Weight` - chance of this animation to be choosen at random animation selection.
|
||||
- `Weight` - chance of this animation to be chosen at random animation selection.
|
||||
|
||||
Some animations can be excluded from participation in random animation selection, such as `L1_NoSd_128x49`.
|
||||
|
||||
|
||||
@@ -1,63 +1,65 @@
|
||||
# Flipper Application Manifests (.fam)
|
||||
|
||||
All components of Flipper Zero firmware — services, user applications, system settings — are developed independently. Each component has a build system manifest file, named `application.fam`, which defines basic properties of that component and its relations to other parts of the system.
|
||||
All components of Flipper Zero firmware — services, user applications, and system settings — are developed independently. Each component has a build system manifest file, named `application.fam`, which defines the basic properties of that component and its relations to other parts of the system.
|
||||
|
||||
When building firmware, **`fbt`** collects all application manifests and processes their dependencies. Then it builds only those components that are referenced in the current build configuration. See [fbt docs](./fbt.md#firmware-application-set) for details on build configurations.
|
||||
When building firmware, **`fbt`** collects all application manifests and processes their dependencies. Then it builds only those components referenced in the current build configuration. See [fbt docs](./fbt.md#firmware-application-set) for details on build configurations.
|
||||
|
||||
## Application definition
|
||||
|
||||
Properties of a firmware component are declared in a form of a Python code snippet, forming a call to App() function with various parameters.
|
||||
A firmware component's properties are declared in a Python code snippet, forming a call to App() function with various parameters.
|
||||
|
||||
Only 2 parameters are mandatory: ***appid*** and ***apptype***, others are optional and may only be meaningful for certain application types.
|
||||
Only 2 parameters are mandatory: ***appid*** and ***apptype***; others are optional and may only be meaningful for certain application types.
|
||||
|
||||
### Parameters
|
||||
|
||||
* **appid**: string, application id within the build system. Used for specifying which applications to include in build configuration and to resolve dependencies and conflicts.
|
||||
* **appid**: string, application id within the build system. Used to specify which applications to include in the build configuration and resolve dependencies and conflicts.
|
||||
|
||||
* **apptype**: member of FlipperAppType.* enumeration. Valid values are:
|
||||
|
||||
| Enum member | Firmware component type |
|
||||
|--------------|--------------------------|
|
||||
| SERVICE | System service, created at early startup |
|
||||
| SYSTEM | Application not being shown in any menus. Can be started by other apps or from CLI |
|
||||
| APP | Regular application for main menu |
|
||||
| PLUGIN | Application to be built as a part of firmware an to be placed in Plugins menu |
|
||||
| SYSTEM | Application is not being shown in any menus. It can be started by other apps or from CLI |
|
||||
| APP | Regular application for the main menu |
|
||||
| PLUGIN | Application to be built as a part of the firmware and to be placed in the Plugins menu |
|
||||
| DEBUG | Application only visible in Debug menu with debug mode enabled |
|
||||
| ARCHIVE | One and only Archive app |
|
||||
| SETTINGS | Application to be placed in System settings menu |
|
||||
| SETTINGS | Application to be placed in the system settings menu |
|
||||
| STARTUP | Callback function to run at system startup. Does not define a separate app |
|
||||
| EXTERNAL | Application to be built as .fap plugin |
|
||||
| METAPACKAGE | Does not define any code to be run, used for declaring dependencies and application bundles |
|
||||
|
||||
* **name**: Name that is displayed in menus.
|
||||
* **entry_point**: C function to be used as application's entry point. Note that C++ function names are mangled, so you need to wrap them in `extern "C"` in order to use them as entry points.
|
||||
* **entry_point**: C function to be used as the application's entry point. Note that C++ function names are mangled, so you need to wrap them in `extern "C"` to use them as entry points.
|
||||
* **flags**: Internal flags for system apps. Do not use.
|
||||
* **cdefines**: C preprocessor definitions to declare globally for other apps when current application is included in active build configuration.
|
||||
* **requires**: List of application IDs to also include in build configuration, when current application is referenced in list of applications to build.
|
||||
* **conflicts**: List of application IDs that current application conflicts with. If any of them is found in constructed application list, **`fbt`** will abort firmware build process.
|
||||
* **cdefines**: C preprocessor definitions to declare globally for other apps when the current application is included in the active build configuration.
|
||||
* **requires**: List of application IDs to include in the build configuration when the current application is referenced in the list of applications to build.
|
||||
* **conflicts**: List of application IDs that the current application conflicts with. If any of them is found in the constructed application list, **`fbt`** will abort the firmware build process.
|
||||
* **provides**: Functionally identical to ***requires*** field.
|
||||
* **stack_size**: Stack size, in bytes, to allocate for application on its startup. Note that allocating a stack that is too small for an app to run will cause system crash due to stack overflow, and allocating too much stack space will reduce usable heap memory size for apps to process data. *Note: you can use `ps` and `free` CLI commands to profile your app's memory usage.*
|
||||
* **icon**: Animated icon name from built-in assets to be used when building app as a part of firmware.
|
||||
* **stack_size**: Stack size, in bytes, to allocate for application on its startup. Note that allocating a stack too small for an app to run will cause a system crash due to stack overflow, and allocating too much stack space will reduce usable heap memory size for apps to process data. *Note: you can use `ps`, and `free` CLI commands to profile your app's memory usage.*
|
||||
* **icon**: Animated icon name from built-in assets to be used when building the app as a part of the firmware.
|
||||
* **order**: Order of an application within its group when sorting entries in it. The lower the order is, the closer to the start of the list the item is placed. *Used for ordering startup hooks and menu entries.*
|
||||
* **sdk_headers**: List of C header files from this app's code to include in API definitions for external applications.
|
||||
* **targets**: list of strings, target names, which this application is compatible with. If not specified, application is built for all targets. Default value is `["all"]`.
|
||||
* **targets**: list of strings, target names, which this application is compatible with. If not specified, the application is built for all targets. The default value is `["all"]`.
|
||||
|
||||
|
||||
#### Parameters for external applications
|
||||
|
||||
The following parameters are used only for [FAPs](./AppsOnSDCard.md):
|
||||
|
||||
* **sources**: list of strings, file name masks, used for gathering sources within app folder. Default value of `["*.c*"]` includes C and C++ source files. Application cannot use `"lib"` folder for their own source code, as it is reserved for **fap_private_libs**.
|
||||
* **fap_version**: tuple, 2 numbers in form of (x,y): application version to be embedded within .fap file. Default value is (0,1), meaning version "0.1".
|
||||
* **sources**: list of strings, file name masks used for gathering sources within the app folder. The default value of `["*.c*"]` includes C and C++ source files. Applications cannot use the `"lib"` folder for their own source code, as it is reserved for **fap_private_libs**.
|
||||
* **fap_version**: tuple, 2 numbers in the form of (x,y): application version to be embedded within .fap file. The default value is (0,1), meaning version "0.1".
|
||||
* **fap_icon**: name of a .png file, 1-bit color depth, 10x10px, to be embedded within .fap file.
|
||||
* **fap_libs**: list of extra libraries to link application against. Provides access to extra functions that are not exported as a part of main firmware at expense of increased .fap file size and RAM consumption.
|
||||
* **fap_category**: string, may be empty. App subcategory, also works as path of FAP within apps folder in the file system.
|
||||
* **fap_libs**: list of extra libraries to link the application against. Provides access to extra functions that are not exported as a part of main firmware at the expense of increased .fap file size and RAM consumption.
|
||||
* **fap_category**: string, may be empty. App subcategory, also determines the path of the FAP within apps folder in the file system.
|
||||
* **fap_description**: string, may be empty. Short application description.
|
||||
* **fap_author**: string, may be empty. Application's author.
|
||||
* **fap_weburl**: string, may be empty. Application's homepage.
|
||||
* **fap_icon_assets**: string. If present, defines a folder name to be used for gathering image assets for this application. These images will be preprocessed and built alongside the application. See [FAP assets](./AppsOnSDCard.md#fap-assets) for details.
|
||||
* **fap_icon_assets**: string. If present defines a folder name to be used for gathering image assets for this application. These images will be preprocessed and built alongside the application. See [FAP assets](./AppsOnSDCard.md#fap-assets) for details.
|
||||
* **fap_extbuild**: provides support for parts of application sources to be built by external tools. Contains a list of `ExtFile(path="file name", command="shell command")` definitions. **`fbt`** will run the specified command for each file in the list.
|
||||
Note that commands are executed at the firmware root folder's root, and all intermediate files must be placed in a application's temporary build folder. For that, you can use pattern expansion by **`fbt`**: `${FAP_WORK_DIR}` will be replaced with the path to the application's temporary build folder, and `${FAP_SRC_DIR}` will be replaced with the path to the application's source folder. You can also use other variables defined internally by **`fbt`**.
|
||||
|
||||
Note that commands are executed at the firmware root folder's root, and all intermediate files must be placed in an application's temporary build folder. For that, you can use pattern expansion by **`fbt`**: `${FAP_WORK_DIR}` will be replaced with the path to the application's temporary build folder, and `${FAP_SRC_DIR}` will be replaced with the path to the application's source folder. You can also use other variables defined internally by **`fbt`**.
|
||||
|
||||
|
||||
Example for building an app from Rust sources:
|
||||
|
||||
@@ -71,16 +73,16 @@ Example for building an app from Rust sources:
|
||||
),
|
||||
```
|
||||
|
||||
* **fap_private_libs**: list of additional libraries that are distributed as sources alongside the application. These libraries will be built as a part of the application build process.
|
||||
* **fap_private_libs**: a list of additional libraries distributed as sources alongside the application. These libraries will be built as a part of the application build process.
|
||||
Library sources must be placed in a subfolder of "`lib`" folder within the application's source folder.
|
||||
Each library is defined as a call to `Lib()` function, accepting the following parameters:
|
||||
|
||||
- **name**: name of library's folder. Required.
|
||||
- **fap_include_paths**: list of library's relative paths to add to parent fap's include path list. Default value is `["."]` meaning library's source root.
|
||||
- **sources**: list of filename masks to be used for gathering include files for this library. Paths are relative to library's source root. Default value is `["*.c*"]`.
|
||||
- **cflags**: list of additional compiler flags to be used for building this library. Default value is `[]`.
|
||||
- **cdefines**: list of additional preprocessor definitions to be used for building this library. Default value is `[]`.
|
||||
- **cincludes**: list of additional include paths to be used for building this library. Paths are relative to application's root. Can be used for providing external search paths for this library's code - for configuration headers. Default value is `[]`.
|
||||
- **fap_include_paths**: list of library's relative paths to add to parent fap's include path list. The default value is `["."]` meaning the library's source root.
|
||||
- **sources**: list of filename masks to be used for gathering include files for this library. Paths are relative to the library's source root. The default value is `["*.c*"]`.
|
||||
- **cflags**: list of additional compiler flags to be used for building this library. The default value is `[]`.
|
||||
- **cdefines**: list of additional preprocessor definitions to be used for building this library. The default value is `[]`.
|
||||
- **cincludes**: list of additional include paths to be used for building this library. Paths are relative to the application's root. This can be used for providing external search paths for this library's code - for configuration headers. The default value is `[]`.
|
||||
|
||||
Example for building an app with a private library:
|
||||
|
||||
@@ -103,10 +105,10 @@ Example for building an app with a private library:
|
||||
],
|
||||
```
|
||||
|
||||
For that snippet, **`fbt`** will build 2 libraries: one from sources in `lib/mbedtls` folder, and another from sources in `lib/loclass` folder. For `mbedtls` library, **`fbt`** will add `lib/mbedtls/include` to the list of include paths for the application and compile only the files specified in `sources` list. Additionally, **`fbt`** will enable `MBEDTLS_ERROR_C` preprocessor definition for `mbedtls` sources.
|
||||
For `loclass` library, **`fbt`** will add `lib/loclass` to the list of include paths for the application and build all sources in that folder. Also **`fbt`** will disable treating compiler warnings as errors for `loclass` library specifically - that can be useful when compiling large 3rd-party codebases.
|
||||
For that snippet, **`fbt`** will build 2 libraries: one from sources in `lib/mbedtls` folder and another from sources in `lib/loclass` folder. For the `mbedtls` library, **`fbt`** will add `lib/mbedtls/include` to the list of include paths for the application and compile only the files specified in the `sources` list. Additionally, **`fbt`** will enable `MBEDTLS_ERROR_C` preprocessor definition for `mbedtls` sources.
|
||||
For the `loclass` library, **`fbt`** will add `lib/loclass` to the list of the include paths for the application and build all sources in that folder. Also, **`fbt`** will disable treating compiler warnings as errors for the `loclass` library, which can be useful when compiling large 3rd-party codebases.
|
||||
|
||||
Both libraries will be linked into the application.
|
||||
Both libraries will be linked with the application.
|
||||
|
||||
|
||||
## .fam file contents
|
||||
|
||||
@@ -37,7 +37,7 @@ With it, you can debug FAPs as if they were a part of main firmware — inspect
|
||||
|
||||
### Setting up debugging environment
|
||||
|
||||
Debugging support script looks up debugging information in latest firmware build dir (`build/latest`). That directory is symlinked by fbt to the latest firmware configuration (Debug or Release) build dir, when you run `./fbt` for chosen configuration. See [fbt docs](./fbt.md#nb) for details.
|
||||
Debugging support script looks up debugging information in the latest firmware build dir (`build/latest`). That directory is symlinked by fbt to the latest firmware configuration (Debug or Release) build dir, when you run `./fbt` for chosen configuration. See [fbt docs](./fbt.md#nb) for details.
|
||||
|
||||
So, to debug FAPs, do the following:
|
||||
1. Build firmware with `./fbt`
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Key Combos
|
||||
|
||||
There are times when your flipper feels blue and doesn't respond to your commands.
|
||||
There are times when your Flipper feels blue and doesn't respond to your commands.
|
||||
In that case, you may find this guide useful.
|
||||
|
||||
|
||||
@@ -12,10 +12,10 @@ In that case, you may find this guide useful.
|
||||
- Press `LEFT` and `BACK` and hold for a couple of seconds
|
||||
- Release `LEFT` and `BACK`
|
||||
|
||||
This combo performs hardware reset by pulling MCU reset line down.
|
||||
This combo performs a hardware reset by pulling MCU reset line down.
|
||||
Main components involved: Keys -> DD8(NC7SZ32M5X, OR-gate) -> DD1(STM32WB55, MCU)
|
||||
|
||||
There is 1 case when it's not working:
|
||||
There is 1 case where it does not work:
|
||||
|
||||
- MCU debug block is active and holding reset line from inside.
|
||||
|
||||
@@ -25,32 +25,32 @@ There is 1 case when it's not working:
|
||||
- Disconnect USB and any external power supplies
|
||||
- Disconnect USB once again
|
||||
- Make sure that you've disconnected USB and any external power supplies
|
||||
- Press `BACK` and hold for 30 seconds (Only will work with USB Disconnected)
|
||||
- Press `BACK` and hold for 30 seconds (Will only work with USB disconnected)
|
||||
- If you have not disconnected USB, then disconnect USB and repeat previous step
|
||||
- Release `BACK` key
|
||||
|
||||
This combo performs a reset by switching SYS power line off and then on.
|
||||
Main components involved: Keys -> DD6(bq25896, charger)
|
||||
|
||||
There is 1 case when it's not working:
|
||||
There is 1 case where it does not work:
|
||||
|
||||
- Power supply is connected to USB or 5V_ext
|
||||
|
||||
|
||||
### Software DFU
|
||||
|
||||
- Press `LEFT` on boot to enter DFU with flipper boot-loader
|
||||
- Press `LEFT` on boot to enter DFU with Flipper boot-loader
|
||||
|
||||
There is 1 case when it's not working:
|
||||
There is 1 case where it does not work:
|
||||
|
||||
- Flipper Boot-loader is damaged or absent
|
||||
- Flipper boot-loader is damaged or absent
|
||||
|
||||
|
||||
### Hardware DFU
|
||||
|
||||
- Press `OK` on boot to enter DFU with ST boot-loader
|
||||
|
||||
There is 1 case when it's not working:
|
||||
There is 1 case where it does not work:
|
||||
|
||||
- Option Bytes are damaged or set to ignore `OK` key
|
||||
|
||||
@@ -65,25 +65,25 @@ There is 1 case when it's not working:
|
||||
- Device will enter DFU with indication (Blue LED + DFU Screen)
|
||||
- Release `LEFT`
|
||||
|
||||
This combo performs hardware reset by pulling MCU reset line down.
|
||||
Then `LEFT` key indicates to boot-loader that DFU mode is requested.
|
||||
This combo performs a hardware reset by pulling MCU reset line down.
|
||||
Then, `LEFT` key indicates to the boot-loader that DFU mode is requested.
|
||||
|
||||
There are 2 cases when it's not working:
|
||||
There are 2 cases where it does not work:
|
||||
|
||||
- MCU debug block is active and holding reset line from inside
|
||||
- Flipper Boot-loader is damaged or absent
|
||||
- Flipper boot-loader is damaged or absent
|
||||
|
||||
|
||||
### Hardware Reset + Hardware DFU
|
||||
|
||||
- Press `LEFT` and `BACK` and `OK` and hold for a couple of seconds
|
||||
- Press `LEFT`, `BACK` and `OK` and hold for a couple of seconds
|
||||
- Release `BACK` and `LEFT`
|
||||
- Device will enter DFU without indication
|
||||
|
||||
This combo performs hardware reset by pulling MCU reset line down.
|
||||
Then `OK` key forces MCU to load internal boot-loader.
|
||||
This combo performs a hardware reset by pulling MCU reset line down.
|
||||
Then, `OK` key forces MCU to load internal boot-loader.
|
||||
|
||||
There are 2 cases when it's not working:
|
||||
There are 2 cases where it does not work:
|
||||
|
||||
- MCU debug block is active and holding reset line from inside
|
||||
- Option Bytes are damaged or set to ignore `OK` key
|
||||
@@ -96,15 +96,15 @@ There are 2 cases when it's not working:
|
||||
- Release `BACK`
|
||||
- Device will enter DFU with indication (Blue LED + DFU Screen)
|
||||
- Release `LEFT`
|
||||
- Plug USB
|
||||
- Plug in USB
|
||||
|
||||
This combo performs reset by switching SYS power line off and then on.
|
||||
Then `LEFT` key indicates to boot-loader that DFU mode requested.
|
||||
This combo performs a reset by switching SYS power line off and then on.
|
||||
Then, `LEFT` key indicates to boot-loader that DFU mode requested.
|
||||
|
||||
There are 2 cases when it's not working:
|
||||
There are 2 cases where it does not work:
|
||||
|
||||
- Power supply is connected to USB or 5V_ext
|
||||
- Flipper Boot-loader is damaged or absent
|
||||
- Flipper boot-loader is damaged or absent
|
||||
|
||||
|
||||
### Hardware Power Reset + Hardware DFU
|
||||
@@ -115,10 +115,10 @@ There are 2 cases when it's not working:
|
||||
- Device will enter DFU without indication
|
||||
- Plug USB
|
||||
|
||||
This combo performs reset by switching SYS power line off and then on.
|
||||
Then `OK` key forces MCU to load internal boot-loader.
|
||||
This combo performs a reset by switching SYS power line off and then on.
|
||||
Then, `OK` key forces MCU to load internal boot-loader.
|
||||
|
||||
There are 2 cases when it's not working:
|
||||
There are 2 cases where it does not work:
|
||||
|
||||
- Power supply is connected to USB or 5V_ext
|
||||
- Option Bytes are damaged or set to ignore `OK` key
|
||||
@@ -131,4 +131,4 @@ If none of the described methods were useful:
|
||||
- Disconnect the battery and connect again (Requires disassembly)
|
||||
- Try to Flash device with ST-Link or other programmer that supports SWD
|
||||
|
||||
If you still here and your device is not working: it's not a software issue.
|
||||
If you still are here and your device is not working: it's not a software issue.
|
||||
@@ -1,5 +1,5 @@
|
||||
# Command syntax
|
||||
BadUsb app uses extended Duckyscript syntax. It is compatible with classic USB Rubber Ducky 1.0 scripts, but provides some additional commands and features, such as custom USB ID, ALT+Numpad input method, SYSRQ command and more fuctional keys.
|
||||
BadUsb app uses extended Duckyscript syntax. It is compatible with classic USB Rubber Ducky 1.0 scripts, but provides some additional commands and features, such as custom USB ID, ALT+Numpad input method, SYSRQ command and more functional keys.
|
||||
# Script file format
|
||||
BadUsb app can execute only text scrips from .txt files, no compilation is required. Both `\n` and `\r\n` line endings are supported. Empty lines are allowed. You can use spaces ore tabs for line indentation.
|
||||
# Command set
|
||||
|
||||
@@ -95,7 +95,7 @@ Note: a single parsed signal must be represented as an array of size 1.
|
||||
| data | raw | uint32 | Ditto. |
|
||||
|
||||
#### Signal names
|
||||
The signal names in an `.irtest` file folow a convention `<name><test_number>`, where the name is one of:
|
||||
The signal names in an `.irtest` file follow a convention `<name><test_number>`, where the name is one of:
|
||||
- decoder_input
|
||||
- decoder_expected
|
||||
- encoder_decoder_input,
|
||||
@@ -103,8 +103,8 @@ The signal names in an `.irtest` file folow a convention `<name><test_number>`,
|
||||
and the number is a sequential integer: 1, 2, 3...etc, which produces names like `decoder_input1`, `encoder_decoder_input3`, and so on.
|
||||
|
||||
| Name | Type | Description |
|
||||
| --------------------- | ------------ | ----------- |
|
||||
| decoder_input | raw | A raw signal contaning the decoder input. Is also used as the expected encoder output. |
|
||||
| --------------------- | ------------ |-------------------------------------------------------------------------------------------------------|
|
||||
| decoder_input | raw | A raw signal containing the decoder input. Is also used as the expected encoder output. |
|
||||
| decoder_expected | parsed_array | An array of parsed signals containing the expected decoder output. Is also used as the encoder input. |
|
||||
| encoder_decoder_input | parsed_array | An array of parsed signals containing both the encoder-decoder input and expected output. |
|
||||
|
||||
|
||||
@@ -68,7 +68,7 @@ This file format is used to store the UID, SAK and ATQA of a Mifare Ultralight/N
|
||||
|
||||
The "Signature" field contains the reply of the tag to the READ_SIG command. More on that can be found here: <https://www.nxp.com/docs/en/data-sheet/MF0ULX1.pdf> (page 31)
|
||||
|
||||
The "Mifare version" field is not related to the file format version, but to the Mifare Ultralight version. It contains the responce of the tag to the GET_VERSION command. More on that can be found here: <https://www.nxp.com/docs/en/data-sheet/MF0ULX1.pdf> (page 21)
|
||||
The "Mifare version" field is not related to the file format version, but to the Mifare Ultralight version. It contains the response of the tag to the GET_VERSION command. More on that can be found here: <https://www.nxp.com/docs/en/data-sheet/MF0ULX1.pdf> (page 21)
|
||||
|
||||
Other fields are the direct representation of the card's internal state, more on them can be found in the same datasheet.
|
||||
|
||||
|
||||
@@ -197,7 +197,7 @@ For each key, a name and encryption method must be specified, according to comme
|
||||
|
||||
## SubGhz `setting_user` File
|
||||
|
||||
This file contains additional radio presets and frequencies for SubGhz application. It is used to add new presets and frequencies for existing presets. This file is be loaded on subghz application start and is located at path `/ext/subghz/assets/setting_user`.
|
||||
This file contains additional radio presets and frequencies for SubGhz application. It is used to add new presets and frequencies for existing presets. This file is being loaded on subghz application start and is located at path `/ext/subghz/assets/setting_user`.
|
||||
|
||||
### File Format
|
||||
|
||||
|
||||
@@ -14,7 +14,7 @@ What does it do?
|
||||
|-----------|-------------------|-----------------------|-----------------------|
|
||||
| f7 | 0x08000000 | L+Back, release both | L+Back, release Back |
|
||||
|
||||
Also there is a "hardware" ST bootloader combo available even on a bricked or empty device: L+Ok+Back, release Back, Left.
|
||||
Also, there is a "hardware" ST bootloader combo available even on a bricked or empty device: L+Ok+Back, release Back, Left.
|
||||
Target independent code and headers in `target/include` folders. More details in `documentation/KeyCombo.md`
|
||||
|
||||
# Building
|
||||
|
||||
@@ -11,7 +11,7 @@
|
||||
- `infrared` - Infrared library
|
||||
- `libusb_stm32` - STM32 USB library
|
||||
- `littlefs` - Internal storage file system
|
||||
- `micro-ecc` - Elliptic Curve Crpytography library
|
||||
- `micro-ecc` - Elliptic Curve Crytography library
|
||||
- `microtar` - TAR archive support library
|
||||
- `mlib` - Algorithms and containers
|
||||
- `nanopb` - Nano Protobuf library
|
||||
|
||||
@@ -27,14 +27,14 @@ Also display type, region and etc...
|
||||
## Core1 and Core2 firmware flashing
|
||||
|
||||
Core2 goes first, then Core1.
|
||||
Never flash FUS or you will loose your job, girlfriend and keys in secure enclave.
|
||||
Never flash FUS or you will lose your job, girlfriend and keys in secure enclave.
|
||||
|
||||
## Option Bytes
|
||||
|
||||
!!! Setting incorrect Option Bytes may brick your MCU !!!
|
||||
|
||||
Defaults are mostly OK, but there are couple things that we'd like to tune.
|
||||
Also OB may be damaged, so we've made couple scripts to check and set option bytes.
|
||||
Also, OB may be damaged, so we've made couple scripts to check and set option bytes.
|
||||
|
||||
!!! Setting incorrect Option Bytes may brick your MCU !!!
|
||||
|
||||
|
||||
68
scripts/power.py
Executable file
68
scripts/power.py
Executable file
@@ -0,0 +1,68 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
from flipper.app import App
|
||||
from flipper.storage import FlipperStorage
|
||||
from flipper.utils.cdc import resolve_port
|
||||
|
||||
|
||||
class Main(App):
|
||||
# this is basic use without sub-commands, simply to reboot flipper / power it off, not meant as a full CLI wrapper
|
||||
def init(self):
|
||||
self.parser.add_argument("-p", "--port", help="CDC Port", default="auto")
|
||||
|
||||
self.subparsers = self.parser.add_subparsers(help="sub-command help")
|
||||
|
||||
self.parser_power_off = self.subparsers.add_parser(
|
||||
"power_off", help="Power off command, won't return to CLI"
|
||||
)
|
||||
self.parser_power_off.set_defaults(func=self.power_off)
|
||||
|
||||
self.parser_reboot = self.subparsers.add_parser(
|
||||
"reboot", help="Reboot command help"
|
||||
)
|
||||
self.parser_reboot.set_defaults(func=self.reboot)
|
||||
|
||||
self.parser_reboot2dfu = self.subparsers.add_parser(
|
||||
"reboot2dfu", help="Reboot to DFU, won't return to CLI"
|
||||
)
|
||||
self.parser_reboot2dfu.set_defaults(func=self.reboot2dfu)
|
||||
|
||||
def _get_flipper(self):
|
||||
if not (port := resolve_port(self.logger, self.args.port)):
|
||||
return None
|
||||
|
||||
flipper = FlipperStorage(port)
|
||||
flipper.start()
|
||||
return flipper
|
||||
|
||||
def power_off(self):
|
||||
if not (flipper := self._get_flipper()):
|
||||
return 1
|
||||
|
||||
self.logger.debug("Powering off")
|
||||
flipper.send("power off" + "\r")
|
||||
flipper.stop()
|
||||
return 0
|
||||
|
||||
def reboot(self):
|
||||
if not (flipper := self._get_flipper()):
|
||||
return 1
|
||||
|
||||
self.logger.debug("Rebooting")
|
||||
flipper.send("power reboot" + "\r")
|
||||
flipper.stop()
|
||||
return 0
|
||||
|
||||
def reboot2dfu(self):
|
||||
if not (flipper := self._get_flipper()):
|
||||
return 1
|
||||
|
||||
self.logger.debug("Rebooting to DFU")
|
||||
flipper.send("power reboot2dfu" + "\r")
|
||||
flipper.stop()
|
||||
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
Main()()
|
||||
@@ -1,6 +1,8 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
import sys, os, time
|
||||
import logging
|
||||
import os
|
||||
import sys
|
||||
import time
|
||||
|
||||
|
||||
def flp_serial_by_name(flp_name):
|
||||
@@ -31,6 +33,12 @@ def main():
|
||||
flipper_name = sys.argv[1]
|
||||
elapsed = 0
|
||||
flipper = flp_serial_by_name(flipper_name)
|
||||
logging.basicConfig(
|
||||
format="%(asctime)s %(levelname)-8s %(message)s",
|
||||
level=logging.INFO,
|
||||
datefmt="%Y-%m-%d %H:%M:%S",
|
||||
)
|
||||
logging.info("Waiting for Flipper to be ready...")
|
||||
|
||||
while flipper == "" and elapsed < UPDATE_TIMEOUT:
|
||||
elapsed += 1
|
||||
@@ -38,9 +46,11 @@ def main():
|
||||
flipper = flp_serial_by_name(flipper_name)
|
||||
|
||||
if flipper == "":
|
||||
print(f"Cannot find {flipper_name} flipper. Guess your flipper swam away")
|
||||
logging.error("Flipper not found!")
|
||||
sys.exit(1)
|
||||
|
||||
logging.info(f"Found Flipper at {flipper}")
|
||||
|
||||
sys.exit(0)
|
||||
|
||||
|
||||
|
||||
@@ -1,28 +1,32 @@
|
||||
#!/usr/bin/env python3
|
||||
|
||||
import sys, os
|
||||
import serial
|
||||
import logging
|
||||
import re
|
||||
import sys
|
||||
|
||||
import serial
|
||||
from await_flipper import flp_serial_by_name
|
||||
|
||||
|
||||
LEAK_THRESHOLD = 3000 # added until units are fixed
|
||||
|
||||
|
||||
def main():
|
||||
logging.basicConfig(
|
||||
format="%(asctime)s %(levelname)-8s %(message)s",
|
||||
level=logging.INFO,
|
||||
datefmt="%Y-%m-%d %H:%M:%S",
|
||||
)
|
||||
logging.info("Trying to run units on flipper")
|
||||
flp_serial = flp_serial_by_name(sys.argv[1])
|
||||
|
||||
if flp_serial == "":
|
||||
print("Name or serial port is invalid")
|
||||
logging.error("Flipper not found!")
|
||||
sys.exit(1)
|
||||
|
||||
with serial.Serial(flp_serial, timeout=1) as flipper:
|
||||
logging.info(f"Found Flipper at {flp_serial}")
|
||||
flipper.baudrate = 230400
|
||||
flipper.flushOutput()
|
||||
flipper.flushInput()
|
||||
|
||||
flipper.timeout = 300
|
||||
flipper.timeout = 180
|
||||
|
||||
flipper.read_until(b">: ").decode("utf-8")
|
||||
flipper.write(b"unit_tests\r")
|
||||
@@ -41,9 +45,13 @@ def main():
|
||||
status_pattern = re.compile(status_re)
|
||||
|
||||
tests, time, leak, status = None, None, None, None
|
||||
total = 0
|
||||
|
||||
for line in lines:
|
||||
print(line)
|
||||
logging.info(line)
|
||||
if "()" in line:
|
||||
total += 1
|
||||
|
||||
if not tests:
|
||||
tests = re.match(tests_pattern, line)
|
||||
if not time:
|
||||
@@ -53,8 +61,8 @@ def main():
|
||||
if not status:
|
||||
status = re.match(status_pattern, line)
|
||||
|
||||
if leak is None or time is None or leak is None or status is None:
|
||||
print("Failed to get data. Or output is corrupt")
|
||||
if None in (tests, time, leak, status):
|
||||
logging.error(f"Failed to parse output: {leak} {time} {leak} {status}")
|
||||
sys.exit(1)
|
||||
|
||||
leak = int(re.findall(r"[- ]\d+", leak.group(0))[0])
|
||||
@@ -62,16 +70,18 @@ def main():
|
||||
tests = int(re.findall(r"\d+", tests.group(0))[0])
|
||||
time = int(re.findall(r"\d+", time.group(0))[0])
|
||||
|
||||
if tests > 0 or leak > LEAK_THRESHOLD or status != "PASSED":
|
||||
print(f"Got {tests} failed tests.")
|
||||
print(f"Leaked {leak} bytes.")
|
||||
print(f"Status by flipper: {status}")
|
||||
print(f"Time elapsed {time/1000} seconds.")
|
||||
if tests > 0 or status != "PASSED":
|
||||
logging.error(f"Got {tests} failed tests.")
|
||||
logging.error(f"Leaked (not failing on this stat): {leak}")
|
||||
logging.error(f"Status: {status}")
|
||||
logging.error(f"Time: {time/1000} seconds")
|
||||
sys.exit(1)
|
||||
|
||||
print(
|
||||
f"Tests ran successfully! Time elapsed {time/1000} seconds. Passed {tests} tests."
|
||||
logging.info(f"Leaked (not failing on this stat): {leak}")
|
||||
logging.info(
|
||||
f"Tests ran successfully! Time elapsed {time/1000} seconds. Passed {total} tests."
|
||||
)
|
||||
|
||||
sys.exit(0)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user