Skip to main content

ModusToolbox™ Getting Started Guide for PSoC™ 6

This tutorial will go over integrating the Memfault Firmware SDK into a PSoC™ 6 project using Infineon's ModusToolbox™ Software SDK.

note

Note: these instructions were written using ModusToolbox™ release 2.4.0.5972 and tested against the CY8CKIT-062S2-43012 evaluation board.

These instructions should also apply to any other PSoC™ 6 family board.

A full example project targeting the CY8CKIT-062S2-43012 development board can be found at https://github.com/memfault/mtb-example-memfault

Overview

This document describes how to integrate the Memfault SDK into a ModusToolbox™ based project.

Prerequisite

This guide assumes you already have an application running on a PSoC™ 6 development board. At a high level, this will require the following steps.

  1. Download ModusToolbox™ Software SDK from Infineon.
  2. Generate a sample project from that SDK. This can be done from the IDE or using the project-creator-cli, i.e
project-creator-cli --board-id CY8CKIT-062S2-43012 --app-id  mtb-example-anycloud-udp-server --user-app-name my_example_app
  1. Compile and program application on development board, i,e

    $ make getlibs
    $ make build -j8
    $ make program

For further documentation about ModusToolbox™ and how to use it, check out Infineon's website here!

Integrate the Memfault SDK

Add the Memfault Sources and Build Flags

  1. The Memfault SDK is implemented as a ModusToolbox™ middleware and can be imported using the "library-manager". To launch the library manager for your project, either type make modlib from the command line or click on "Library Manager" under the tools tab in the IDE. From there, search for "Memfault Firmware SDK" and click "Update"

    Alternatively, you can add the library manually by creating deps/memfault-firmware-sdk.mtb and running make getlibs

    $ echo 'https://github.com/memfault/memfault-firmware-sdk#0.31.0#$$ASSET_REPO$$/memfault-firmware-sdk/0.31.0' > deps/memfault-firmware-sdk.mtb
    $ make getlibs
  2. Add #include "memfault/ports/freertos_trace.h" to your FreeRTOSConfig.h file. By default ModusToolbox™ will place the file in your projects root directory.

    diff --git a/FreeRTOSConfig.h b/FreeRTOSConfig.h
    index 4718e2a..7fc9a78 100644
    --- a/FreeRTOSConfig.h
    +++ b/FreeRTOSConfig.h
    @@ -39,6 +39,8 @@
    #ifndef FREERTOS_CONFIG_H
    #define FREERTOS_CONFIG_H

    +#include "memfault/ports/freertos_trace.h"
    +
  3. Add a unique identifier to project. Memfault will use this to match the appropriate symbol files to decode information published by the memfault-firmware-sdk. This requires the following modification to your projects Makefile

    info

    This step requires the memfault build id package in your python environment, which can be installed with pip:

    pip install mflt-build-id
    diff --git a/Makefile b/Makefile

    -POSTBUILD=
    +POSTBUILD=python -m mflt_build_id.__init__ $(CY_OPENOCD_SYMBOL_IMG)
  4. Update Makefile with an additional linker script. Add the following .ld file to the build. This will enable the collection of all FreeRTOS task state when a crash takes place.

    diff --git a/Makefile b/Makefile

    -LDFLAGS=
    +LDFLAGS= -T$(SEARCH_memfault-firmware-sdk)/ports/cypress/psoc6/memfault_bss.ld
  5. Implement the following dependency functions in your project following the inline steps below:

    #include "memfault/components.h"

    sMfltHttpClientConfig g_mflt_http_client_config = {
    // retrieve project key from: https://mflt.io/project-key
    .api_key = "YOUR_PROJECT_KEY",
    };

    void memfault_platform_get_device_info(sMemfaultDeviceInfo *info) {
    // !FIXME: Populate with platform device information

    // IMPORTANT: All strings returned in info must be constant
    // or static as they will be used _after_ the function returns

    // See https://mflt.io/version-nomenclature for more context
    *info = (sMemfaultDeviceInfo) {
    // An ID that uniquely identifies the device in your fleet
    // (i.e serial number, mac addr, chip id, etc)
    // Regular expression defining valid device serials: ^[-a-zA-Z0-9_]+$
    .device_serial = "DEMOSERIAL",
    // A name to represent the firmware running on the MCU.
    // (i.e "ble-fw", "main-fw", or a codename for your project)
    .software_type = "app-fw",
    // The version of the "software_type" currently running.
    // "software_type" + "software_version" must uniquely represent
    // a single binary
    .software_version = "1.0.0-dev",
    // The revision of hardware for the device. This value must remain
    // the same for a unique device.
    // (i.e evt, dvt, pvt, or rev1, rev2, etc)
    // Regular expression defining valid hardware versions: ^[-a-zA-Z0-9_\.\+]+$
    .hardware_version = "dvt1",
    };
    }
  6. Initialize Memfault SDK from your main function before starting the FreeRTOS scheduler

    //! @file main.c
    #include "memfault/components.h"

    int main(void) {
    // ...

    memfault_platform_boot();

    // ...
    vTaskStartScheduler();
    }

Verification & Tuning Steps

Add Test Commands to CLI

With Memfault compiling into your build, it's now time to add some initial instrumentation and test the integration! The quickest way to do this is to extend or add a command line interface.

For projects that have a CLI expand here for instructions

The Memfault SDK functionality can be easily exercised via CLI test commands.

note

If your platform does not have a CLI, these commands can also be wired up to a button press or called from main() on bootup from a test image

Test platform ports

#include "memfault/components.h"

int test_logging(int argc, char *argv[]) {
MEMFAULT_LOG_DEBUG("Debug log!");
MEMFAULT_LOG_INFO("Info log!");
MEMFAULT_LOG_WARN("Warning log!");
MEMFAULT_LOG_ERROR("Error log!");
return 0;
}
#include "memfault/components.h"

// Runs a sanity test to confirm coredump port is working as expected
int test_coredump_storage(int argc, char *argv[]) {

// Note: Coredump saving runs from an ISR prior to reboot so should
// be safe to call with interrupts disabled.
your_platform_disable_interrupts();
memfault_coredump_storage_debug_test_begin();
your_platform_enable_interrupts();

memfault_coredump_storage_debug_test_finish();
return 0;
}

Test core SDK functionality

#include "memfault/components.h"

// Triggers an immediate heartbeat capture (instead of waiting for timer
// to expire)
int test_heartbeat(int argc, char *argv[]) {
memfault_metrics_heartbeat_debug_trigger();
return 0;
}

int test_trace(int argc, char *argv[]) {
MEMFAULT_TRACE_EVENT_WITH_LOG(critical_error, "A test error trace!");
return 0;
}

//! Trigger a user initiated reboot and confirm reason is persisted
int test_reboot(int argc, char *argv[]) {
memfault_reboot_tracking_mark_reset_imminent(kMfltRebootReason_UserReset, NULL);
memfault_platform_reboot();
}

Test different crash types where a coredump should be captured

#include "memfault/components.h"

int test_assert(int argc, char *argv[]) {
MEMFAULT_ASSERT(0);
return -1; // should never get here
}

int test_fault(void) {
void (*bad_func)(void) = (void *)0xEEEEDEAD;
bad_func();
return -1; // should never get here
}

int test_hang(int argc, char *argv[]) {
while (1) {}
return -1; // should never get here
}

// Dump Memfault data collected to console
int test_export(int argc, char *argv[]) {
memfault_data_export_dump_chunks();
return 0;
}

If your project does not already have a command line for testing, the memfault demo CLI can be added for quick verification. To do this, copy the following into a memfault_cli_task.c and then call memfault_cli_task_start() from your main routine.

//! @file memfault_cli_task.c

#include "cyhal.h"
#include "memfault/components.h"

#include "cy_retarget_io.h"

#include <FreeRTOS.h>
#include <task.h>

#define MEMFAULT_CLI_TASK_SIZE (1024)
#define MEMFAULT_CLI_TASK_PRIORITY (1)

static int prv_send_char(char c) {
cyhal_uart_putc(&cy_retarget_io_uart_obj, c);
return 0;
}

void memfault_cli_task(void *arg) {
cyhal_syspm_lock_deepsleep();
const sMemfaultShellImpl impl = {
.send_char = prv_send_char,
};
memfault_demo_shell_boot(&impl);

while (1) {
uint32_t num_bytes = cyhal_uart_readable(&cy_retarget_io_uart_obj);
if (num_bytes < 1) {
// Sleep for a little bit if there was not data
vTaskDelay(10);
continue;
}

uint8_t rx_byte;
// data should be available so we should not need to wait
const uint32_t uart_input_timeout_ms = 1;
cy_rslt_t result = cyhal_uart_getc(&cy_retarget_io_uart_obj, &rx_byte, uart_input_timeout_ms);
if (result != CY_RSLT_SUCCESS) {
MEMFAULT_LOG_ERROR("Unexpected UART read error: 0x%x", (int)result);
continue;
}

memfault_demo_shell_receive_char(rx_byte);
}
}

void memfault_cli_task_start(void) {
xTaskCreate(memfault_cli_task, "MFLT CLI", MEMFAULT_CLI_TASK_SIZE,
NULL, MEMFAULT_CLI_TASK_PRIORITY, NULL);
}

At boot, you should now see something like:

[I] Memfault Build ID: 7726fbc695f4c50db091746118ad69468e152341
[I] S/N: DEMOSERIAL
[I] SW type: app-fw
[I] SW version: 1.0.0-dev
[I] HW version: dvt1
[I] Reset Reason, Cy_SysLib_GetResetReason=0x10
[I] Reset Cause:
[I] Software Reset
[I] Memfault Initialized!

mflt>
mflt>
help>
clear_core: Clear an existing coredump
drain_chunks: Flushes queued Memfault data. To upload data see https://mflt.io/posting-chunks-with-gdb
export: Export base64-encoded chunks. To upload data see https://mflt.io/chunk-data-export
get_core: Get coredump info
get_device_info: Get device info
test_assert: Trigger memfault assert
test_busfault: Trigger a busfault
test_hardfault: Trigger a hardfault
test_memmanage: Trigger a memory management fault
test_usagefault: Trigger a usage fault
test_log: Writes test logs to log buffer
test_log_capture: Trigger capture of current log buffer contents
test_reboot: Force system reset and track it with a trace event
test_trace: Capture an example trace event
help: Lists all commands

Post Data to Cloud via Local Debug Setup

Prior to having an end-to-end transport in place, Memfault data can be exported over any serial connection or via GDB directly.

Post Chunks To Memfault

All data collected by Memfault can be exported as opaque packets called "chunks". To trigger an export, call the test_export command added to your device CLI.

If data has been collected, you will see strings with the format: MC:BASE64_ENCODED_CHUNK: in the dump.

note

It's perfectly fine for other logs to be interleaved with the exported data.

For example:

shell> reboot
[00:00:01] INFO: System Booting!
[00:00:02] INFO: Memfault Build ID: d8d6a047282f025fffa29fa767100f310bc40f80
shell> trace
# CLI command making a call to `memfault_data_export_dump_chunks`
shell> export
[00:00:10] INFO: MC:SFQCpwIBAwEHalRFU1RTRVJJQUwKbXRlc3Qtc29mdHdhcmUJajEuMC4wLXRlcw==:

Copy the logs from the console, navigate to the "Chunks Debug" view for your project, and paste the logs:

Select "Next" to review the chunks that were identified and (optionally) update the "Device Serial" being used to report data:

Select "Post" to submit the chunks to Memfault. The chunks will appear in the view directly below. Check and make sure there are no "Errors" to address.

(Optional) Automate Chunk Posting

Posting chunks from a local setup can be automated using our CLI tool or GDB script.

note

This strategy can also be used even when an end-to-end transport is in place for local QA testing or in CI/CD test automation setups.

Automated Posting Options
Prerequisite: Project Key from Memfault UI

A Project key will be needed in order to communicate with Memfault's web services. Go to https://app.memfault.com/, navigate to the project you want to use and select 'Settings'→'General'. The 'Project Key' listed is what you will want to use.

With Desktop CLI Tool

Install the Python Memfault CLI Tool

The Memfault Desktop CLI tool. tool is written in Python and published publicly in the Python Package Index (pypi).

To install it, make sure you have a recent version of Python 3.x installed and run:

$ pip3 install memfault-cli
$ memfault --help

Save device logs to file

Start your console with your favorite terminal client. Let the system run for a bit, periodically dumping data to the console by calling memfault_data_export_dump_chunks.

You should see strings with the format: MC:BASE64_ENCODED_CHUNK: in the dump.

note

It's perfectly fine for other logs to be interleaved with the exported data.

For example:

shell> reboot
[00:00:01] INFO: System Booting!
[00:00:02] INFO: Memfault Build ID: d8d6a047282f025fffa29fa767100f310bc40f80
shell> trace
# CLI command making a call to `memfault_data_export_dump_chunks`
shell> export
[00:00:10] INFO: MC:SFQCpwIBAwEHalRFU1RTRVJJQUwKbXRlc3Qtc29mdHdhcmUJajEuMC4wLXRlcw==:

Save the resulting logs to a file such as logs.txt

Post chunks from logs with Memfault CLI

Run the desktop Memfault CLI tool on your saved log file. The utility will parse the logs, extract the Memfault data, and post it here for processing!

$ memfault --project-key ${YOUR_PROJECT_KEY} post-chunk --encoding sdk_data_export logs.txt
Found 2 Chunks. Sending Data ...
Success
With GDB

Prerequisites

  • You need to have a way to debug your product with GDB as part of your development setup
  • The GDB version you are using needs to have the GDB Python API enabled. (It's generally the default or there is a -py version of GDB which has it included.)
  • You need to compile your firmware with debug symbol information (i.e -g CFLAG)
note

Even if you are using other compilers such as ARMCC or IAR, you can load the ELF (.out, .elf) generated and debug it in GDB as well.

Launch GDB and connect debugger

For example:

$ arm-none-eabi-gdb-py my_app.elf --ex="target remote :3333"
(gdb)

Load Memfault GDB script

Copy and paste and run the following in gdb:

python exec('try:\n from urllib2 import urlopen\nexcept:\n from urllib.request import urlopen'); exec(urlopen('https://mflt.io/memfault-gdb-script').read())
tip

Some GDB versions do not support Python scripting by default. If you see a message like "Python scripting is not supported in this copy of GDB", you might be able to run an alternative GDB binary with a -py suffix, for example arm-none-eabi-gdb-py.

Register Handler

Copy the command below and paste it into GDB and hit enter. This will load a handler which automatically posts data to Memfault whenever memfault_data_export_dump_chunks is called.

memfault install_chunk_handler --verbose --project-key <YOUR_PROJECT_KEY>
note

memfault_data_export_dump_chunks() needs to be called by your port as part of a CLI command or periodic task in order for the data to be extracted. For example:

#include "memfault/components.h"

int export_data_cli_command(int argc, char *argv[]) {
memfault_data_export_dump_chunks();
return 0;
}

void some_periodic_task(void) {
memfault_data_export_dump_chunks();
}

Try It Out!

Now, every time memfault_data_export_dump_chunks is called, the data passed as a parameter to the function will automatically be posted to the Memfault cloud. You don't have to do anything else! You will see logs print in the gdb CLI as data is posted:

(gdb) Continuing.
Successfully posted 45 bytes of chunk data
Successfully posted 53 bytes of chunk data
[...]

Upload Symbol File

info

With ModusToolbox™ your projects symbol files can be found in the build/ directory, i.e.ModusToolbox

build/CY8CKIT-062S2-43012/Debug/your_application.elf

At this point, you should be able to generate test events and crashes and push the data to the Memfault UI.

You can confirm the error traces and crashes have arrived successfully by navigating to the "Issues" page. Follow the link pointed to below and upload a symbol file.

After this step, you will see the trace in the list of issues!

tip

You can programmatically upload symbol files with the Memfault CLI tool.

Troubleshooting Data Transfer

If you encounter any issues in your data transfer implementation, Memfault has tools to help debug!

Data Transport Steps

With data collection verified locally, the final step is to push data automatically to the Memfault cloud for analysis! Check out the two options below for the one that matches your use case.

Using Wi-Fi Connection Manager (WCM) & HTTPS

If your project makes use of Wi-Fi, data can be posted directly to Memfault using HTTPS. To enable this functionality, make the following changes:

  1. Register Memfault Root certificates with stack
#include "memfault/components.h"
// [...]

//! Load root certificates necessary for talking to Memfault servers
result = cy_tls_load_global_root_ca_certificates(MEMFAULT_ROOT_CERTS_PEM, sizeof(MEMFAULT_ROOT_CERTS_PEM) - 1);
if (result != CY_RSLT_SUCCESS) {
MEMFAULT_LOG_ERROR("cy_tls_load_global_root_ca_certificates failed! rv=0x%x", (int)result);
}
  1. Add periodic call to post data using Memfault HTTP client
#include "memfault/components.h"
// [...]
memfault_http_client_post_chunk();

Post Data to Cloud via Other Transport

Extensive details about how data from the Memfault SDK makes it to the cloud can be found here. In short, the Memfault SDK packetizes data into "chunks" that must be pushed to the Memfault cloud via the chunk REST endpoint.

The Memfault SDK exposes an API that packetizes Memfault data into "chunks". These "chunks" need to be forwarded to the Memfault Cloud (either directly via HTTPs or indirectly via a gateway device such as a computer or mobile application)

tip

If you cannot post data directly using HTTP, no problem at all. In fact, that is one of the most common configurations. In these setups, data can be proxied from the MCU to a device which can perform a HTTP request over transports such as UART, BLE, COAP, LoRa, Zigbee, etc). The size of a "chunk" is fully configurable and can be tuned to best match your transport requirements. All message re-assembly is dealt with by Memfault in the cloud.

#include "memfault/components.h"

bool try_send_memfault_data(void) {
// buffer to copy chunk data into
uint8_t buf[USER_CHUNK_SIZE];
size_t buf_len = sizeof(buf);

bool data_available = memfault_packetizer_get_chunk(buf, &buf_len);
if (!data_available ) {
return false; // no more data to send
}

// send payload collected to chunks endpoint
user_transport_send_chunk_data(buf, buf_len);
return true;
}

void send_memfault_data(void) {
if (!memfault_packetizer_data_available()) {
return false; // no new data to send
}

// [... user specific logic deciding when & how much data to send
while (try_send_memfault_data()) { }
}