nRF Connect SDK API 3.3.99
Loading...
Searching...
No Matches
trace_backend.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2022-2023 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
5 */
6
7#ifndef TRACE_BACKEND_H__
8#define TRACE_BACKEND_H__
9
10#include <zephyr/kernel.h>
11
12#ifdef __cplusplus
13extern "C" {
14#endif
15
26typedef int (*trace_backend_processed_cb)(size_t len);
27
41 int (*init)(trace_backend_processed_cb trace_processed_cb);
42
49 int (*deinit)(void);
50
69 int (*write)(const void *data, size_t len);
70
80 size_t (*data_size)(void);
81
95 int (*read)(void *buf, size_t len);
96
111 int (*peek_at)(size_t offset, void *buf, size_t len);
112
122 int (*clear)(void);
123
134 int (*suspend)(void);
135
145 int (*resume)(void);
146};
147
148 /* defgroup trace_backend */
149
150#ifdef __cplusplus
151}
152#endif
153
154#endif /* TRACE_BACKEND_H__ */
int(* trace_backend_processed_cb)(size_t len)
callback to signal the trace module that some amount of trace data has been processed.
Definition trace_backend.h:26
int(* suspend)(void)
Suspend trace backend.
Definition trace_backend.h:134
int(* peek_at)(size_t offset, void *buf, size_t len)
Peek trace data at a byte offset without consuming it.
Definition trace_backend.h:111
int(* init)(trace_backend_processed_cb trace_processed_cb)
Initialize the compile-time selected trace backend.
Definition trace_backend.h:41
int(* deinit)(void)
Deinitialize the compile-time selected trace backend.
Definition trace_backend.h:49
int(* read)(void *buf, size_t len)
Read trace data from the compile-time selected trace backend.
Definition trace_backend.h:95
int(* clear)(void)
Erase all captured trace data in the compile-time selected trace backend.
Definition trace_backend.h:122
size_t(* data_size)(void)
Get the number of bytes stored in the compile-time selected trace backend.
Definition trace_backend.h:80
int(* resume)(void)
Resume trace backend.
Definition trace_backend.h:145
int(* write)(const void *data, size_t len)
Write trace data to the compile-time selected trace backend.
Definition trace_backend.h:69
The trace backend interface, implemented by the trace backend.
Definition trace_backend.h:31