|
| 1 | +/* |
| 2 | + * Copyright (c) 2025 Nordic Semiconductor ASA |
| 3 | + * |
| 4 | + * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause |
| 5 | + */ |
| 6 | + |
| 7 | +#include <zephyr/kernel.h> |
| 8 | +#include <zephyr/logging/log.h> |
| 9 | +#include <zephyr/task_wdt/task_wdt.h> |
| 10 | +#include <zephyr/zbus/zbus.h> |
| 11 | +#include "memfault/components.h" |
| 12 | +#include <memfault/ports/zephyr/http.h> |
| 13 | +#include <memfault/metrics/metrics.h> |
| 14 | +#include <memfault/core/data_packetizer.h> |
| 15 | +#include <memfault/core/trace_event.h> |
| 16 | +#include "memfault/panics/coredump.h" |
| 17 | +#include <modem/nrf_modem_lib_trace.h> |
| 18 | +#include <modem/nrf_modem_lib.h> |
| 19 | + |
| 20 | +LOG_MODULE_DECLARE(memfault_ncs, CONFIG_MEMFAULT_NCS_LOG_LEVEL); |
| 21 | + |
| 22 | +/* Forward declarations */ |
| 23 | +static bool has_cdr_cb(sMemfaultCdrMetadata *metadata); |
| 24 | +static void mark_cdr_read_cb(void); |
| 25 | +static bool read_data_cb(uint32_t offset, void *buf, size_t buf_len); |
| 26 | + |
| 27 | +static const char * const mimetypes[] = { |
| 28 | + MEMFAULT_CDR_BINARY |
| 29 | +}; |
| 30 | + |
| 31 | +static sMemfaultCdrMetadata trace_recording_metadata = { |
| 32 | + .start_time.type = kMemfaultCurrentTimeType_Unknown, |
| 33 | + .mimetypes = (char const **)mimetypes, |
| 34 | + .num_mimetypes = 1, |
| 35 | + .data_size_bytes = 0, |
| 36 | + .collection_reason = "modem traces", |
| 37 | +}; |
| 38 | + |
| 39 | +static sMemfaultCdrSourceImpl recording = { |
| 40 | + .has_cdr_cb = has_cdr_cb, |
| 41 | + .read_data_cb = read_data_cb, |
| 42 | + .mark_cdr_read_cb = mark_cdr_read_cb, |
| 43 | +}; |
| 44 | + |
| 45 | +static int modem_trace_enable(void) |
| 46 | +{ |
| 47 | + int err; |
| 48 | + |
| 49 | + err = nrf_modem_lib_trace_level_set(NRF_MODEM_LIB_TRACE_LEVEL_LTE_AND_IP); |
| 50 | + if (err) { |
| 51 | + LOG_ERR("nrf_modem_lib_trace_level_set, error: %d", err); |
| 52 | + return err; |
| 53 | + } |
| 54 | + |
| 55 | + return 0; |
| 56 | +} |
| 57 | + |
| 58 | +/* Enable modem traces as soon as the modem is initialized if there is no valid coredump. |
| 59 | + * Modem traces are disabled by default via CONFIG_NRF_MODEM_LIB_TRACE_LEVEL_OFF. |
| 60 | + */ |
| 61 | +NRF_MODEM_LIB_ON_INIT(memfault_init_hook, on_modem_lib_init, NULL) |
| 62 | + |
| 63 | +static void on_modem_lib_init(int ret, void *ctx) |
| 64 | +{ |
| 65 | + int err; |
| 66 | + |
| 67 | + if (memfault_coredump_has_valid_coredump(NULL)) { |
| 68 | + return; |
| 69 | + } |
| 70 | + |
| 71 | + LOG_DBG("No coredump valid, clearing modem trace buffer"); |
| 72 | + |
| 73 | + err = nrf_modem_lib_trace_clear(); |
| 74 | + if (err) { |
| 75 | + LOG_ERR("Failed to clear modem trace data: %d", err); |
| 76 | + return; |
| 77 | + } |
| 78 | + |
| 79 | + err = modem_trace_enable(); |
| 80 | + if (err) { |
| 81 | + LOG_ERR("Failed to enable modem traces: %d", err); |
| 82 | + return; |
| 83 | + } |
| 84 | +} |
| 85 | + |
| 86 | +static bool has_cdr_cb(sMemfaultCdrMetadata *metadata) |
| 87 | +{ |
| 88 | + if (trace_recording_metadata.data_size_bytes == 0) { |
| 89 | + return false; |
| 90 | + } |
| 91 | + |
| 92 | + *metadata = trace_recording_metadata; |
| 93 | + return true; |
| 94 | +} |
| 95 | + |
| 96 | +static void mark_cdr_read_cb(void) |
| 97 | +{ |
| 98 | + int err; |
| 99 | + |
| 100 | + LOG_DBG("Modem trace data has been processed / uploaded"); |
| 101 | + |
| 102 | + /* It's not guaranteed that the trace backend clears the stored traces after readout, |
| 103 | + * so we clear them before enabling traces just in case. |
| 104 | + */ |
| 105 | + err = nrf_modem_lib_trace_clear(); |
| 106 | + if (err) { |
| 107 | + LOG_ERR("Failed to clear modem trace data: %d", err); |
| 108 | + |
| 109 | + /* Continue */ |
| 110 | + } |
| 111 | + |
| 112 | + err = modem_trace_enable(); |
| 113 | + if (err) { |
| 114 | + LOG_ERR("Failed to enable modem traces after upload: %d", err); |
| 115 | + |
| 116 | + /* Continue */ |
| 117 | + } |
| 118 | + |
| 119 | + /* Set CDR data length to 0 once the modem trace has been processed (uploaded) */ |
| 120 | + trace_recording_metadata.data_size_bytes = 0; |
| 121 | +} |
| 122 | + |
| 123 | +static bool read_data_cb(uint32_t offset, void *buf, size_t buf_len) |
| 124 | +{ |
| 125 | + ARG_UNUSED(offset); |
| 126 | + |
| 127 | + int err = nrf_modem_lib_trace_read(buf, buf_len); |
| 128 | + |
| 129 | + if (err == -ENODATA) { |
| 130 | + LOG_WRN("No more modem trace data to read"); |
| 131 | + return false; |
| 132 | + } else if (err < 0) { |
| 133 | + LOG_ERR("Failed to read modem trace data: %d", err); |
| 134 | + return false; |
| 135 | + } |
| 136 | + |
| 137 | + return true; |
| 138 | +} |
| 139 | + |
| 140 | +int memfault_lte_coredump_modem_trace_init(void) |
| 141 | +{ |
| 142 | + static bool initialized; |
| 143 | + |
| 144 | + if (initialized) { |
| 145 | + LOG_ERR("Already initialized"); |
| 146 | + return -EALREADY; |
| 147 | + } |
| 148 | + |
| 149 | + if (!memfault_cdr_register_source(&recording)) { |
| 150 | + LOG_ERR("Failed to register modem trace CDR source, storage full"); |
| 151 | + return -EIO; |
| 152 | + } |
| 153 | + |
| 154 | + initialized = true; |
| 155 | + |
| 156 | + LOG_DBG("Modem trace CDR source initialized"); |
| 157 | + |
| 158 | + return 0; |
| 159 | +} |
| 160 | + |
| 161 | +int memfault_lte_coredump_modem_trace_prepare_for_upload(void) |
| 162 | +{ |
| 163 | + size_t trace_size = 0; |
| 164 | + |
| 165 | + trace_size = nrf_modem_lib_trace_data_size(); |
| 166 | + |
| 167 | + if (trace_size == -ENOTSUP) { |
| 168 | + LOG_ERR("The current modem trace backend is not supported"); |
| 169 | + return -ENOTSUP; |
| 170 | + } else if (trace_size < 0) { |
| 171 | + LOG_ERR("Failed to get modem trace size: %d", trace_size); |
| 172 | + return trace_size; |
| 173 | + } else if (trace_size == 0) { |
| 174 | + LOG_DBG("No modem traces to send"); |
| 175 | + return -ENODATA; |
| 176 | + } |
| 177 | + |
| 178 | + LOG_DBG("Preparing modem trace data upload of: %d bytes", trace_size); |
| 179 | + |
| 180 | + trace_recording_metadata.duration_ms = 0; |
| 181 | + trace_recording_metadata.data_size_bytes = trace_size; |
| 182 | + |
| 183 | + return 0; |
| 184 | +} |
0 commit comments