Skip to content

Latest commit

 

History

History
80 lines (58 loc) · 2.17 KB

README.md

File metadata and controls

80 lines (58 loc) · 2.17 KB
Raw

Quantum Leaps' QP™ Specific Port

Overview

This directory contains patches needed to integrate the Memfault SDK into Quantum Leaps' QP™.

The patches have been verified against versions v6.0.0 up to v6.6.0 of QP/C and QP/C++.

The instructions below assume you have an environment already setup for building and flashing a QP application. If you do not, see the official site for instructions.

Integrating SDK

  1. Apply qassert.h.patch

QP uses its Q_ASSERT... macros to ensure the QP API is used correctly and the system is behaving correctly. The qassert.h.patch change these macros such that failing assertions will trigger the Memfault SDK to capture a coredump.

$ cd $QP_ROOT/
$ patch include/qassert.h $MEMFAULT_SDK_ROOT/ports/qp/qassert.h.patch
  1. Apply qf_pkg.h.patch or qf_pkg.hpp.patch

This patches a second set of assertion macros that QP uses internally, since version 6.3.2. If you are using an older version than 6.3.2, you can skip this step.

In case you are using QP/C:

$ cd $QP_ROOT/
$ patch src/qf_pkg.h $MEMFAULT_SDK_ROOT/ports/qp/qf_pkg.h.patch

In case you are using QP/C++:

$ cd $QP_ROOT/
$ patch src/qf_pkg.hpp $MEMFAULT_SDK_ROOT/ports/qp/qf_pkg.hpp.patch
  1. Remove Q_onAssert

After applying the ports/qp/qassert.h.patch and ports/qp/qf_pkg.h.patch files from the Memfault Firmware SDK, the Q_onAssert function will no longer be necessary. Instead, Memfault's assertion handling will be used.

In case your application's code is using Q_onAssert directly, either replace the usages with the Q_ASSERT... macros or use Memfault's MEMFAULT_ASSERT... macros.

  1. Implement device-specific dependencies.
void memfault_platform_get_device_info(sMemfaultDeviceInfo *info) {
  *info = (sMemfaultDeviceInfo) {
    .device_serial = "DEMOSERIAL",
    .software_type = "qp-main",
    .software_version = "1.15.0",
    .hardware_version = "stm32f407g-disc1",
  };
}

sMfltHttpClientConfig g_mflt_http_client_config = {
  .api_key = "<YOUR PROJECT KEY HERE>",
};

Demo

An example integration and instructions can be found for the STM32F407 in $MEMFAULT_SDK_ROOT/examples/qp/README.md