Skip to content

Commit

Permalink
Memfault Firmware SDK 0.30.5 (Build 447316)
Browse files Browse the repository at this point in the history
  • Loading branch information
Memfault Inc committed May 25, 2022
1 parent 7660861 commit bdacc2d
Show file tree
Hide file tree
Showing 17 changed files with 377 additions and 13 deletions.
19 changes: 19 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
### Changes between Memfault SDK 0.30.5 and SDK 0.30.4 - May 24, 2022

#### :rocket: New Features

- ESP-IDF: add Memfault Compact Log example integration to the
[`examples/esp32`](examples/esp32) project

#### :chart_with_upwards_trend: Improvements

- ESP-IDF: Fix backtraces when using ESP-IDF v4.4+
- nRF-Connect SDK: enable the Kconfig flag `MEMFAULT_NRF_CONNECT_SDK` by default
when targeting the nrf52 + nrf53 series SOCs (previously only enabled by
default for nrf91 series)

#### :house: Internal

Added clarifications around licensing in ports and examples folders. See
[README](README.md) for more details.

### Changes between Memfault SDK 0.30.4 and SDK 0.30.3 - May 4, 2022

#### :chart_with_upwards_trend: Improvements
Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,3 +162,10 @@ the top for build & test coverage status of the `master` branch.
- Don't hesitate to contact us for help! You can reach us through
[[email protected]](mailto:[email protected]).
# License
Unless specifically indicated otherwise in a file, all memfault-firmware-sdk
files are all licensed under the [Memfault License](/License.txt). (A few files
in the [examples](/examples) and [ports](/ports) directory are licensed
differently based on vendor requirements.)
4 changes: 2 additions & 2 deletions VERSION
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
BUILD ID: 438599
GIT COMMIT: 3905e51c1
BUILD ID: 447316
GIT COMMIT: 77b7799c5
2 changes: 1 addition & 1 deletion components/include/memfault/version.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ typedef struct {
uint8_t patch;
} sMfltSdkVersion;

#define MEMFAULT_SDK_VERSION { .major = 0, .minor = 30, .patch = 4 }
#define MEMFAULT_SDK_VERSION { .major = 0, .minor = 30, .patch = 5 }

#ifdef __cplusplus
}
Expand Down
16 changes: 15 additions & 1 deletion examples/esp32/apps/memfault_demo_app/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,18 @@ project(${PROJECT_NAME})
set(IDF_PROJECT_EXECUTABLE ${PROJECT_NAME}.elf)
add_custom_command(TARGET ${IDF_PROJECT_EXECUTABLE}
POST_BUILD
COMMAND python ${memfault_firmare_sdk_dir}/scripts/fw_build_id.py ${IDF_PROJECT_EXECUTABLE})
# Compute and insert the build id
COMMAND python ${memfault_firmare_sdk_dir}/scripts/fw_build_id.py ${IDF_PROJECT_EXECUTABLE}
# Save a copy of the ELF that includes the 'log_fmt' section
COMMAND ${CMAKE_COMMAND} -E copy ${IDF_PROJECT_EXECUTABLE} ${IDF_PROJECT_EXECUTABLE}.memfault
# Remove the 'log_fmt' compact log section, which confuses elf2image
COMMAND ${CMAKE_OBJCOPY} --remove-section log_fmt ${IDF_PROJECT_EXECUTABLE}
)

# Add a custom target to swap over the stashed complete elf above after
# elf2image runs
add_custom_target(swap_original_memfault_elf ALL
COMMAND ${CMAKE_COMMAND} -E rename ${IDF_PROJECT_EXECUTABLE}.memfault ${IDF_PROJECT_EXECUTABLE}
DEPENDS app
COMMENT "Copy over original ELF for Memfault uploading"
)
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,10 @@ void app_main() {
register_wifi();
register_app();

#if MEMFAULT_COMPACT_LOG_ENABLE
MEMFAULT_COMPACT_LOG_SAVE(kMemfaultPlatformLogLevel_Info, "This is a compact log example");
#endif

/* Prompt to be printed before each line.
* This can be customized, made dynamic, etc.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@
//! Default configuration settings can be found in "memfault/config.h"

#define MEMFAULT_TASK_WATCHDOG_ENABLE 1
#define MEMFAULT_COMPACT_LOG_ENABLE 1
8 changes: 8 additions & 0 deletions examples/nrf-connect-sdk/nrf9160/memfault_demo_app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,14 @@ $ west build -b nrf9160dk_nrf9160_ns memfault_demo_app
Note that you will need to use `nrf9160dk_nrf9160ns` instead on
versions of NCS based on Zephyr 2.6 and earlier.

And on versions of NCS based on Zephyr 2.5 and earlier,
`CONFIG_OPENOCD_SUPPORT=y` should be set, for example:

```bash
# NCS v1.4.0, which uses Zephyr 2.5, requires this build command
$ BOARD=nrf9160dk_nrf9160ns west build -b nrf9160dk_nrf9160ns memfault_demo_app -- -DCONFIG_OPENOCD_SUPPORT=y
```

## Testing the Integration

Commands to test the integration are exposed under the `mflt` submenu in the CLI
Expand Down
8 changes: 8 additions & 0 deletions ports/esp_idf/memfault/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -85,3 +85,11 @@ component_compile_options(-DMEMFAULT_ESP_HTTP_CLIENT_ENABLE=$ENV{MEMFAULT_ESP_HT
# Much more flexibility in debug information collected (e.g. all RAM, just the current stack trace, select stacks and variables)
# Data can be posted directly from device to Memfault cloud for deduplication and analysis
target_link_libraries(${this_component} INTERFACE "-Wl,--wrap=esp_core_dump_to_flash -Wl,--wrap=esp_core_dump_init -Wl,--wrap=esp_core_dump_image_get")

# Include a linker script fragment to support compact logs, when enabled
get_filename_component(compact_log_linker_script ${MEMFAULT_ESP_IDF_PORT_COMMON}/memfault_compact_log.ld ABSOLUTE)
target_link_libraries(
${this_component}
INTERFACE
-T ${compact_log_linker_script}
)
19 changes: 19 additions & 0 deletions ports/esp_idf/memfault/common/memfault_compact_log.ld
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
/*
Custom section to be included in the linker command file to support compact
logs. Read more at https://mflt.io/compact-logs
*/

SECTIONS
{
log_fmt 0xF0000000 (INFO) :
{
/*
explicitly define this symbol. some versions of the xtensa toolchain
(esp-2020r3-8.4.0 at least) incorrectly places it by default at 8 bytes
into the log_fmt section, which causes decoding to fail.
*/
__start_log_fmt = ABSOLUTE(.);
KEEP(*(*.log_fmt_hdr))
KEEP(*(log_fmt))
}
}
14 changes: 14 additions & 0 deletions ports/esp_idf/memfault/common/memfault_fault_handler.c
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

#include "esp_core_dump.h"
#include "freertos/xtensa_api.h"
#include "memfault/esp_port/version.h"
#include "memfault/panics/arch/xtensa/xtensa.h"
#include "memfault/panics/coredump.h"
#include "memfault/panics/fault_handling.h"
Expand All @@ -35,7 +36,15 @@ void memfault_fault_handling_assert_extra(void *pc, void *lr, sMemfaultAssertInf
//! @note This is a drop in replacement for the pre-existing flash coredump handler.
//! The default implementation is replaced by leveraging GCCs --wrap feature
//! https://github.com/espressif/esp-idf/blob/v4.0/components/esp32/panic.c#L620
//!
//! @note The signature for the wrapped function changed in esp-idf v4.3+,
//! support that change with a version check (see static assert below)
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4,3,0)
void __wrap_esp_core_dump_to_flash(panic_info_t *info) {
XtExcFrame *fp = (void *)info->frame;
#else
void __wrap_esp_core_dump_to_flash(XtExcFrame *fp) {
#endif
// Clear "EXCM" bit so we don't have to correct PS.OWB to get a good unwind This will also be
// more reflective of the state of the register prior to the "panicHandler" being invoked
const uint32_t corrected_ps = fp->ps & ~(PS_EXCM_MASK);
Expand Down Expand Up @@ -76,3 +85,8 @@ void __wrap_esp_core_dump_to_flash(XtExcFrame *fp) {

memfault_fault_handler(&regs, kMfltRebootReason_HardFault);
}

// Ensure the substituted function signature matches the original function
_Static_assert(__builtin_types_compatible_p(__typeof__(&esp_core_dump_to_flash),
__typeof__(&__wrap_esp_core_dump_to_flash)),
"Error: core dump handler is not compatible with esp-idf's default implementation");
33 changes: 33 additions & 0 deletions ports/esp_idf/memfault/include/memfault/esp_port/version.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
#pragma once

//! @file
//!
//! Copyright (c) Memfault, Inc.
//! See License.txt for details
//!
//! @brief
//! Provide some esp-idf version identifiers that work across esp-idf versions.
//!

#include "esp_system.h"

#ifdef __cplusplus
extern "C" {
#endif

// These version macros were added in esp-idf v4.0. If they don't exist, it's an
// earlier release. Define the macros so they can be used, and set a fallback
// version of 3.99.99 for comparison purposes. These macros can't be used to
// compare for earlier versions.

#if !defined(ESP_IDF_VERSION)

#define ESP_IDF_VERSION_VAL(major, minor, patch) ((major << 16) | (minor << 8) | (patch))

#define ESP_IDF_VERSION ESP_IDF_VERSION_VAL(3, 99, 99)

#endif

#ifdef __cplusplus
}
#endif
201 changes: 201 additions & 0 deletions ports/templates/apache-2.0.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Loading

0 comments on commit bdacc2d

Please sign in to comment.