nrf_profiler.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef _NRF_PROFILER_H_
#define _NRF_PROFILER_H_
 
#include <zephyr/types.h>
#include <zephyr/sys/util.h>
#include <zephyr/sys/__assert.h>
 
#ifndef CONFIG_NRF_PROFILER_MAX_NUMBER_OF_APP_EVENTS
#define CONFIG_NRF_PROFILER_MAX_NUMBER_OF_APP_EVENTS 0
#endif
 
#ifndef CONFIG_NRF_PROFILER_NUMBER_OF_INTERNAL_EVENTS
#define CONFIG_NRF_PROFILER_NUMBER_OF_INTERNAL_EVENTS 0
#endif
 
#define NRF_PROFILER_MAX_NUMBER_OF_APPLICATION_AND_INTERNAL_EVENTS \
        ((CONFIG_NRF_PROFILER_MAX_NUMBER_OF_APP_EVENTS) + \
        (CONFIG_NRF_PROFILER_NUMBER_OF_INTERNAL_EVENTS))
 
struct nrf_profiler_event_enabled_bm {
        ATOMIC_DEFINE(flags, NRF_PROFILER_MAX_NUMBER_OF_APPLICATION_AND_INTERNAL_EVENTS);
};
 
extern struct nrf_profiler_event_enabled_bm _nrf_profiler_event_enabled_bm;
 
 
extern uint8_t nrf_profiler_num_events;
 
 
enum nrf_profiler_arg {
        NRF_PROFILER_ARG_U8,
        NRF_PROFILER_ARG_S8,
        NRF_PROFILER_ARG_U16,
        NRF_PROFILER_ARG_S16,
        NRF_PROFILER_ARG_U32,
        NRF_PROFILER_ARG_S32,
        NRF_PROFILER_ARG_STRING,
        NRF_PROFILER_ARG_TIMESTAMP
};
 
 
struct log_event_buf {
#ifdef CONFIG_NRF_PROFILER
        uint8_t *payload;
        uint8_t payload_start[CONFIG_NRF_PROFILER_CUSTOM_EVENT_BUF_LEN];
#endif
};
 
 
#ifdef CONFIG_NRF_PROFILER
int nrf_profiler_init(void);
#else
static inline int nrf_profiler_init(void) {return 0; }
#endif
 
 
#ifdef CONFIG_NRF_PROFILER
void nrf_profiler_term(void);
#else
static inline void nrf_profiler_term(void) {}
#endif
 
#ifdef CONFIG_NRF_PROFILER
const char *nrf_profiler_get_event_descr(size_t nrf_profiler_event_id);
#else
static inline const char *nrf_profiler_get_event_descr(size_t nrf_profiler_event_id)
{
        return NULL;
}
#endif
 
static inline bool is_profiling_enabled(size_t nrf_profiler_event_id)
{
        if (IS_ENABLED(CONFIG_NRF_PROFILER)) {
                __ASSERT_NO_MSG(nrf_profiler_event_id <
                                        NRF_PROFILER_MAX_NUMBER_OF_APPLICATION_AND_INTERNAL_EVENTS);
                return atomic_test_bit(_nrf_profiler_event_enabled_bm.flags, nrf_profiler_event_id);
        }
        return false;
}
 
#ifdef CONFIG_NRF_PROFILER
uint16_t nrf_profiler_register_event_type(const char *name, const char * const *args,
                                   const enum nrf_profiler_arg *arg_types,
                                   uint8_t arg_cnt);
#else
static inline uint16_t nrf_profiler_register_event_type(const char *name,
                        const char * const *args, const enum nrf_profiler_arg *arg_types,
                        uint8_t arg_cnt) {return 0; }
#endif
 
 
#ifdef CONFIG_NRF_PROFILER
void nrf_profiler_log_start(struct log_event_buf *buf);
#else
static inline void nrf_profiler_log_start(struct log_event_buf *buf) {}
#endif
 
#ifdef CONFIG_NRF_PROFILER
void nrf_profiler_log_encode_uint32(struct log_event_buf *buf, uint32_t data);
#else
static inline void nrf_profiler_log_encode_uint32(struct log_event_buf *buf,
                                              uint32_t data) {}
#endif
 
#ifdef CONFIG_NRF_PROFILER
void nrf_profiler_log_encode_int32(struct log_event_buf *buf, int32_t data);
#else
static inline void nrf_profiler_log_encode_int32(struct log_event_buf *buf,
                                             int32_t data) {}
#endif
 
#ifdef CONFIG_NRF_PROFILER
void nrf_profiler_log_encode_uint16(struct log_event_buf *buf, uint16_t data);
#else
static inline void nrf_profiler_log_encode_uint16(struct log_event_buf *buf,
                                              uint16_t data) {}
#endif
 
#ifdef CONFIG_NRF_PROFILER
void nrf_profiler_log_encode_int16(struct log_event_buf *buf, int16_t data);
#else
static inline void nrf_profiler_log_encode_int16(struct log_event_buf *buf,
                                             int16_t data) {}
#endif
 
#ifdef CONFIG_NRF_PROFILER
void nrf_profiler_log_encode_uint8(struct log_event_buf *buf, uint8_t data);
#else
static inline void nrf_profiler_log_encode_uint8(struct log_event_buf *buf,
                                             uint8_t data) {}
#endif
 
#ifdef CONFIG_NRF_PROFILER
void nrf_profiler_log_encode_int8(struct log_event_buf *buf, int8_t data);
#else
static inline void nrf_profiler_log_encode_int8(struct log_event_buf *buf,
                                            int8_t data) {}
#endif
 
#ifdef CONFIG_NRF_PROFILER
void nrf_profiler_log_encode_string(struct log_event_buf *buf, const char *string);
#else
static inline void nrf_profiler_log_encode_string(struct log_event_buf *buf,
                                              const char *string) {}
#endif
 
 
#ifdef CONFIG_NRF_PROFILER
void nrf_profiler_log_add_mem_address(struct log_event_buf *buf,
                                  const void *mem_address);
#else
static inline void nrf_profiler_log_add_mem_address(struct log_event_buf *buf,
                                                const void *mem_address) {}
#endif
 
 
#ifdef CONFIG_NRF_PROFILER
void nrf_profiler_log_send(struct log_event_buf *buf, uint16_t event_type_id);
#else
static inline void nrf_profiler_log_send(struct log_event_buf *buf,
                                     uint16_t event_type_id) {}
#endif
 
 
#endif /* _NRF_PROFILER_H_ */