[FL-3162] Moved ufbt to fbt codebase (#2520)

* scripts: moved ufbt code * ufbt: fixed tool path * ufbt: fixed linter/formatter target descriptions * scripts: ufbt: cleanup * fbt: moved fap launch target to tools; ufbt fixes * fbt: fixed missing headers from SDK * ufbt: removed debug output * ufbt: moved project template to main codebase * ufbt: fixed vscode_dist * ufbt: path naming changes * fbt: error message for older ufbt versions * ufbt: docs fixes * ufbt: fixed build dir location * fbt: fixes for extapps objcopy * fbt: extapps: removed extra debug output; fixed formatting * ufbt: handle launch target for multiple known apps * ufbt: dropping wrapper; linter fixes * ufbt: fixed boostrap path * ufbt: renamed entrypoint * ufbt: updated vscode config * ufbt: moved sconsign db location * ufbt: fixed sconsign path * fbt: SDK builders rework * fbt: reworked sdk packaging * ufbt: additional checks and state processing * ufbt: fixed sdk state file location * dist: not packaging pycache * dump commit json content * Github: more workflow debug prints * Github: fix incorrect commit meta extraction in get_env.py * ufbt, fbt: changed SConsEnvironmentError->StopError * fbtenv: no longer needs SCRIPT_PATH pre-set * ufbt: fixed sdk state check * scripts: exception fixes for storage.py * scripts: fbtenv: added FBT_TOOLCHAIN_PATH for on Windows for compat * ufbt: app template: creating .gitkeep for images folder * ufbt: app template: fixed .gitkeep creation * docs: formatting fixes for AppManifests; added link to ufbt * fbt: added link to PyPI for old ufbt versions * sdk: fixed dir component paths Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>
2023-04-06 06:44:37 +04:00
parent 8a021ae48c
commit a91d319839
32 changed files with 1496 additions and 200 deletions
--- a/scripts/ufbt/project_template/.clang-format
+++ b/scripts/ufbt/project_template/.clang-format
@@ -0,0 +1,191 @@
+---
+Language:        Cpp
+AccessModifierOffset: -4
+AlignAfterOpenBracket: AlwaysBreak
+AlignArrayOfStructures: None
+AlignConsecutiveMacros: None
+AlignConsecutiveAssignments: None
+AlignConsecutiveBitFields: None
+AlignConsecutiveDeclarations: None
+AlignEscapedNewlines: Left
+AlignOperands:   Align
+AlignTrailingComments: false
+AllowAllArgumentsOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortEnumsOnASingleLine: true
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortLambdasOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: WithoutElse
+AllowShortLoopsOnASingleLine: true
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: Yes
+AttributeMacros:
+  - __capability
+BinPackArguments: false
+BinPackParameters: false
+BraceWrapping:
+  AfterCaseLabel:  false
+  AfterClass:      false
+  AfterControlStatement: Never
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  AfterExternBlock: false
+  BeforeCatch:     false
+  BeforeElse:      false
+  BeforeLambdaBody: false
+  BeforeWhile:     false
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeConceptDeclarations: true
+BreakBeforeBraces: Attach
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeColon
+BreakBeforeTernaryOperators: false
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeComma
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: false
+ColumnLimit:     99
+CommentPragmas:  '^ IWYU pragma:'
+QualifierAlignment: Leave
+CompactNamespaces: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DeriveLineEnding: true
+DerivePointerAlignment: false
+DisableFormat:   false
+EmptyLineAfterAccessModifier: Never
+EmptyLineBeforeAccessModifier: LogicalBlock
+ExperimentalAutoDetectBinPacking: false
+PackConstructorInitializers: BinPack
+BasedOnStyle:    ''
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+AllowAllConstructorInitializersOnNextLine: true
+FixNamespaceComments: false
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IfMacros:
+  - KJ_IF_MAYBE
+IncludeBlocks:   Preserve
+IncludeCategories:
+  - Regex:           '.*'
+    Priority:        1
+    SortPriority:    0
+    CaseSensitive:   false
+  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+    Priority:        3
+    SortPriority:    0
+    CaseSensitive:   false
+  - Regex:           '.*'
+    Priority:        1
+    SortPriority:    0
+    CaseSensitive:   false
+IncludeIsMainRegex: '(Test)?$'
+IncludeIsMainSourceRegex: ''
+IndentAccessModifiers: false
+IndentCaseLabels: false
+IndentCaseBlocks: false
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentExternBlock: AfterExternBlock
+IndentRequires:  false
+IndentWidth:     4
+IndentWrappedFunctionNames: true
+InsertTrailingCommas: None
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+LambdaBodyIndentation: Signature
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Auto
+ObjCBlockIndentWidth: 4
+ObjCBreakBeforeNestedBlockParam: true
+ObjCSpaceAfterProperty: true
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 10
+PenaltyBreakBeforeFirstCallParameter: 30
+PenaltyBreakComment: 10
+PenaltyBreakFirstLessLess: 0
+PenaltyBreakOpenParenthesis: 0
+PenaltyBreakString: 10
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 100
+PenaltyReturnTypeOnItsOwnLine: 60
+PenaltyIndentedWhitespace: 0
+PointerAlignment: Left
+PPIndentWidth:   -1
+ReferenceAlignment: Pointer
+ReflowComments:  false
+RemoveBracesLLVM: false
+SeparateDefinitionBlocks: Leave
+ShortNamespaceLines: 1
+SortIncludes:    Never
+SortJavaStaticImport: Before
+SortUsingDeclarations: false
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: Never
+SpaceBeforeParensOptions:
+  AfterControlStatements: false
+  AfterForeachMacros: false
+  AfterFunctionDefinitionName: false
+  AfterFunctionDeclarationName: false
+  AfterIfMacros:   false
+  AfterOverloadedOperator: false
+  BeforeNonEmptyParentheses: false
+SpaceAroundPointerQualifiers: Default
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  Never
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: false
+SpacesInCStyleCastParentheses: false
+SpacesInLineCommentPrefix:
+  Minimum:         1
+  Maximum:         -1
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+SpaceBeforeSquareBrackets: false
+BitFieldColonSpacing: Both
+Standard:        c++03
+StatementAttributeLikeMacros:
+  - Q_EMIT
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth:        4
+UseCRLF:         false
+UseTab:          Never
+WhitespaceSensitiveMacros:
+  - STRINGIZE
+  - PP_STRINGIZE
+  - BOOST_PP_STRINGIZE
+  - NS_SWIFT_NAME
+  - CF_SWIFT_NAME
+...
+
--- a/scripts/ufbt/project_template/.editorconfig
+++ b/scripts/ufbt/project_template/.editorconfig
@@ -0,0 +1,13 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+
+[*.{cpp,h,c,py,sh}]
+indent_style = space
+indent_size = 4
+
+[{Makefile,*.mk}]
+indent_size = tab
--- a/scripts/ufbt/project_template/.gitignore
+++ b/scripts/ufbt/project_template/.gitignore
@@ -0,0 +1,4 @@
+dist/*
+.vscode
+.clang-format
+.editorconfig
--- a/scripts/ufbt/project_template/.vscode/c_cpp_properties.json
+++ b/scripts/ufbt/project_template/.vscode/c_cpp_properties.json
@@ -0,0 +1,14 @@
+{
+    "configurations": [
+        {
+            "name": "main",
+            "compilerPath": "@UFBT_TOOLCHAIN_GCC@",
+            "intelliSenseMode": "gcc-arm",
+            "compileCommands": "${workspaceFolder}/.vscode/compile_commands.json",
+            "configurationProvider": "ms-vscode.cpptools",
+            "cStandard": "gnu17",
+            "cppStandard": "c++17"
+        },
+    ],
+    "version": 4
+}
--- a/scripts/ufbt/project_template/.vscode/extensions.json
+++ b/scripts/ufbt/project_template/.vscode/extensions.json
@@ -0,0 +1,18 @@
+{
+	// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+	// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+	// List of extensions which should be recommended for users of this workspace.
+	"recommendations": [
+		"ms-python.black-formatter",
+		"ms-vscode.cpptools",
+		"amiralizadeh9480.cpp-helper",
+		"marus25.cortex-debug",
+		"zxh404.vscode-proto3",
+		"augustocdias.tasks-shell-input"
+	],
+	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+	"unwantedRecommendations": [
+		"twxs.cmake",
+		"ms-vscode.cmake-tools"
+	]
+}
--- a/scripts/ufbt/project_template/.vscode/launch.json
+++ b/scripts/ufbt/project_template/.vscode/launch.json
@@ -0,0 +1,98 @@
+{
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "inputs": [
+        // {
+        //     "id": "BLACKMAGIC",
+        //     "type": "command",
+        //     "command": "shellCommand.execute",
+        //     "args": {
+        //         "useSingleResult": true,
+        //         "env": {
+        //             "PATH": "${workspaceFolder};${env:PATH}"
+        //         },
+        //         "command": "./fbt get_blackmagic",
+        //         "description": "Get Blackmagic device",
+        //     }
+        // },
+    ],
+    "configurations": [
+        {
+            "name": "Attach FW (ST-Link)",
+            "cwd": "${workspaceFolder}",
+            "executable": "@UFBT_FIRMWARE_ELF@",
+            "request": "attach",
+            "type": "cortex-debug",
+            "servertype": "openocd",
+            "device": "stlink",
+            "svdFile": "@UFBT_DEBUG_DIR@/STM32WB55_CM4.svd",
+            "rtos": "FreeRTOS",
+            "configFiles": [
+                "interface/stlink.cfg",
+                "@UFBT_DEBUG_DIR@/stm32wbx.cfg"
+            ],
+            "postAttachCommands": [
+                "source @UFBT_DEBUG_DIR@/flipperapps.py",
+                "fap-set-debug-elf-root @UFBT_DEBUG_ELF_DIR@"
+            ],
+            // "showDevDebugOutput": "raw",
+        },
+        {
+            "name": "Attach FW (DAP)",
+            "cwd": "${workspaceFolder}",
+            "executable": "@UFBT_FIRMWARE_ELF@",
+            "request": "attach",
+            "type": "cortex-debug",
+            "servertype": "openocd",
+            "device": "cmsis-dap",
+            "svdFile": "@UFBT_DEBUG_DIR@/STM32WB55_CM4.svd",
+            "rtos": "FreeRTOS",
+            "configFiles": [
+                "interface/cmsis-dap.cfg",
+                "@UFBT_DEBUG_DIR@/stm32wbx.cfg"
+            ],
+            "postAttachCommands": [
+                "source @UFBT_DEBUG_DIR@/flipperapps.py",
+                "fap-set-debug-elf-root @UFBT_DEBUG_ELF_DIR@"
+            ],
+            // "showDevDebugOutput": "raw",
+        },
+        // {
+        //     "name": "Attach FW (blackmagic)",
+        //     "cwd": "${workspaceFolder}",
+        //     "executable": "@UFBT_FIRMWARE_ELF@",
+        //     "request": "attach",
+        //     "type": "cortex-debug",
+        //     "servertype": "external",
+        //     "gdbTarget": "${input:BLACKMAGIC}",
+        //     "svdFile": "@UFBT_DEBUG_DIR@/STM32WB55_CM4.svd",
+        //     "rtos": "FreeRTOS",
+        //     "postAttachCommands": [
+        //         "monitor swdp_scan",
+        //         "attach 1",
+        //         "set confirm off",
+        //         "set mem inaccessible-by-default off",
+        //         "source @UFBT_DEBUG_DIR@/flipperapps.py",
+        //         "fap-set-debug-elf-root @UFBT_DEBUG_ELF_DIR@"
+        //     ]
+        //     // "showDevDebugOutput": "raw",
+        // },
+        {
+            "name": "Attach FW (JLink)",
+            "cwd": "${workspaceFolder}",
+            "executable": "@UFBT_FIRMWARE_ELF@",
+            "request": "attach",
+            "type": "cortex-debug",
+            "servertype": "jlink",
+            "interface": "swd",
+            "device": "STM32WB55RG",
+            "svdFile": "@UFBT_DEBUG_DIR@/STM32WB55_CM4.svd",
+            "rtos": "FreeRTOS",
+            "postAttachCommands": [
+                "source @UFBT_DEBUG_DIR@/flipperapps.py",
+                "fap-set-debug-elf-root @UFBT_DEBUG_ELF_DIR@"
+            ]
+            // "showDevDebugOutput": "raw",
+        },
+    ]
+}
--- a/scripts/ufbt/project_template/.vscode/settings.json
+++ b/scripts/ufbt/project_template/.vscode/settings.json
@@ -0,0 +1,20 @@
+{
+    "cortex-debug.enableTelemetry": false,
+    "cortex-debug.variableUseNaturalFormat": false,
+    "cortex-debug.showRTOS": true,
+    "cortex-debug.armToolchainPath": "@UFBT_TOOLCHAIN_ARM_TOOLCHAIN_DIR@",
+    "cortex-debug.openocdPath": "@UFBT_TOOLCHAIN_OPENOCD@",
+    "cortex-debug.gdbPath": "@UFBT_TOOLCHAIN_GDB_PY@",
+    "editor.formatOnSave": true,
+    "files.associations": {
+        "*.scons": "python",
+        "SConscript": "python",
+        "SConstruct": "python",
+        "*.fam": "python"
+    },
+    "cortex-debug.registerUseNaturalFormat": false,
+    "python.analysis.typeCheckingMode": "off",
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter"
+    }
+}
--- a/scripts/ufbt/project_template/.vscode/tasks.json
+++ b/scripts/ufbt/project_template/.vscode/tasks.json
@@ -0,0 +1,54 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "options": {
+        "env": {
+            "PATH": "${workspaceFolder}@UFBT_VSCODE_PATH_SEP@${env:PATH}@UFBT_VSCODE_PATH_SEP@@UFBT_ROOT_DIR@"
+        }
+    },
+    "tasks": [
+        {
+            "label": "Launch App on Flipper",
+            "group": "build",
+            "type": "shell",
+            "command": "ufbt launch"
+        },
+        {
+            "label": "Build",
+            "group": "build",
+            "type": "shell",
+            "command": "ufbt"
+        },
+        {
+            "label": "Flash FW (ST-Link)",
+            "group": "build",
+            "type": "shell",
+            "command": "ufbt FORCE=1 flash"
+        },
+        // {
+        //     "label": "[NOTIMPL] Flash FW (blackmagic)",
+        //     "group": "build",
+        //     "type": "shell",
+        //     "command": "ufbt flash_blackmagic"
+        // },
+        // {
+        //     "label": "[NOTIMPL] Flash FW (JLink)",
+        //     "group": "build",
+        //     "type": "shell",
+        //     "command": "ufbt FORCE=1 jflash"
+        // },
+        {
+            "label": "Flash FW (USB, with resources)",
+            "group": "build",
+            "type": "shell",
+            "command": "ufbt FORCE=1 flash_usb"
+        },
+        {
+            "label": "Update uFBT SDK",
+            "group": "build",
+            "type": "shell",
+            "command": "ufbt update"
+        }
+    ]
+}
--- a/scripts/ufbt/project_template/app_template/${FBT_APPID}.c
+++ b/scripts/ufbt/project_template/app_template/${FBT_APPID}.c
@@ -0,0 +1,12 @@
+#include <furi.h>
+
+/* generated by fbt from .png files in images folder */
+#include <@FBT_APPID@_icons.h>
+
+int32_t @FBT_APPID@_app(void* p) {
+    UNUSED(p);
+    FURI_LOG_I("TEST", "Hello world");
+    FURI_LOG_I("TEST", "I'm @FBT_APPID@!");
+
+    return 0;
+}
--- a/scripts/ufbt/project_template/app_template/${FBT_APPID}.png
+++ b/scripts/ufbt/project_template/app_template/${FBT_APPID}.png
--- a/scripts/ufbt/project_template/app_template/application.fam
+++ b/scripts/ufbt/project_template/app_template/application.fam
@@ -0,0 +1,17 @@
+# For details & more options, see documentation/AppManifests.md in firmware repo
+
+App(
+    appid="@FBT_APPID@",  # Must be unique
+    name="App @FBT_APPID@",  # Displayed in menus
+    apptype=FlipperAppType.EXTERNAL,
+    entry_point="@FBT_APPID@_app",
+    stack_size=2 * 1024,
+    fap_category="Misc",
+    # Optional values
+    # fap_version=(0, 1),  # (major, minor)
+    fap_icon="@FBT_APPID@.png",  # 10x10 1-bit PNG
+    # fap_description="A simple app",
+    # fap_author="J. Doe",
+    # fap_weburl="https://github.com/user/@FBT_APPID@",
+    fap_icon_assets="images",  # Image assets to compile for this application
+)