/*

* Copyright (c) 2016, Intel Corporation

* All rights reserved.

*

* Redistribution and use in source and binary forms, with or without

* modification, are permitted provided that the following conditions are met:

* * Redistributions of source code must retain the above copyright

* notice, this list of conditions and the following disclaimer.

* * Redistributions in binary form must reproduce the above copyright

* notice, this list of conditions and the following disclaimer in the

* documentation and/or other materials provided with the distribution.

* * Neither the name of the Intel Corporation nor the

* names of its contributors may be used to endorse or promote products

* derived from this software without specific prior written permission.

*

* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"

* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE

* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR

* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN

* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

* POSSIBILITY OF SUCH DAMAGE.

*

* Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>

* Keyon Jie <yang.jie@linux.intel.com>

* Artur Kloniecki <arturx.kloniecki@linux.intel.com>

*/

#ifndef __INCLUDE_TRACE__

#define __INCLUDE_TRACE__

#include <stdint.h>

#include <stdlib.h>

#include <sof/sof.h>

#include <sof/mailbox.h>

#include <sof/debug.h>

#include <sof/timer.h>

#include <sof/preproc.h>

#include <platform/platform.h>

#include <platform/timer.h>

#include <uapi/user/trace.h>

/* bootloader trace values */

#define TRACE_BOOT_LDR_ENTRY 0x100

#define TRACE_BOOT_LDR_HPSRAM 0x110

#define TRACE_BOOT_LDR_MANIFEST 0x120

#define TRACE_BOOT_LDR_LPSRAM 0x130

#define TRACE_BOOT_LDR_JUMP 0x150

#define TRACE_BOOT_LDR_PARSE_MODULE 0x210

#define TRACE_BOOT_LDR_PARSE_SEGMENT 0x220

/* general trace init codes - only used at boot when main trace is not available */

#define TRACE_BOOT_START 0x1000

#define TRACE_BOOT_ARCH 0x2000

#define TRACE_BOOT_SYS 0x3000

#define TRACE_BOOT_PLATFORM 0x4000

/* system specific codes */

#define TRACE_BOOT_SYS_WORK (TRACE_BOOT_SYS + 0x100)

#define TRACE_BOOT_SYS_CPU_FREQ (TRACE_BOOT_SYS + 0x200)

#define TRACE_BOOT_SYS_HEAP (TRACE_BOOT_SYS + 0x300)

#define TRACE_BOOT_SYS_NOTE (TRACE_BOOT_SYS + 0x400)

#define TRACE_BOOT_SYS_SCHED (TRACE_BOOT_SYS + 0x500)

#define TRACE_BOOT_SYS_POWER (TRACE_BOOT_SYS + 0x600)

/* platform/device specific codes */

#define TRACE_BOOT_PLATFORM_ENTRY (TRACE_BOOT_PLATFORM + 0x100)

#define TRACE_BOOT_PLATFORM_MBOX (TRACE_BOOT_PLATFORM + 0x110)

#define TRACE_BOOT_PLATFORM_SHIM (TRACE_BOOT_PLATFORM + 0x120)

#define TRACE_BOOT_PLATFORM_PMC (TRACE_BOOT_PLATFORM + 0x130)

#define TRACE_BOOT_PLATFORM_TIMER (TRACE_BOOT_PLATFORM + 0x140)

#define TRACE_BOOT_PLATFORM_CLOCK (TRACE_BOOT_PLATFORM + 0x150)

#define TRACE_BOOT_PLATFORM_SSP_FREQ (TRACE_BOOT_PLATFORM + 0x160)

#define TRACE_BOOT_PLATFORM_IPC (TRACE_BOOT_PLATFORM + 0x170)

#define TRACE_BOOT_PLATFORM_DMA (TRACE_BOOT_PLATFORM + 0x180)

#define TRACE_BOOT_PLATFORM_SSP (TRACE_BOOT_PLATFORM + 0x190)

#define TRACE_BOOT_PLATFORM_DMIC (TRACE_BOOT_PLATFORM + 0x1a0)

#define TRACE_BOOT_PLATFORM_IDC (TRACE_BOOT_PLATFORM + 0x1b0)

/* trace event classes - high 8 bits*/

#define TRACE_CLASS_IRQ (1 << 24)

#define TRACE_CLASS_IPC (2 << 24)

#define TRACE_CLASS_PIPE (3 << 24)

#define TRACE_CLASS_HOST (4 << 24)

#define TRACE_CLASS_DAI (5 << 24)

#define TRACE_CLASS_DMA (6 << 24)

#define TRACE_CLASS_SSP (7 << 24)

#define TRACE_CLASS_COMP (8 << 24)

#define TRACE_CLASS_WAIT (9 << 24)

#define TRACE_CLASS_LOCK (10 << 24)

#define TRACE_CLASS_MEM (11 << 24)

#define TRACE_CLASS_MIXER (12 << 24)

#define TRACE_CLASS_BUFFER (13 << 24)

#define TRACE_CLASS_VOLUME (14 << 24)

#define TRACE_CLASS_SWITCH (15 << 24)

#define TRACE_CLASS_MUX (16 << 24)

#define TRACE_CLASS_SRC (17 << 24)

#define TRACE_CLASS_TONE (18 << 24)

#define TRACE_CLASS_EQ_FIR (19 << 24)

#define TRACE_CLASS_EQ_IIR (20 << 24)

#define TRACE_CLASS_SA (21 << 24)

#define TRACE_CLASS_DMIC (22 << 24)

#define TRACE_CLASS_POWER (23 << 24)

#define TRACE_CLASS_IDC (24 << 24)

#define TRACE_CLASS_CPU (25 << 24)

#define TRACE_CLASS_CLK (26 << 24)

#define TRACE_CLASS_SCHEDULE (27 << 24)

/* move to config.h */

#define TRACE 1

#define TRACEV 0

#define TRACEE 1

#define TRACEM 0 /* send all trace messages to mbox and local trace buffer */

#ifdef CONFIG_HOST

extern int test_bench_trace;

char *get_trace_class(uint32_t trace_class);

#define _log_message(mbox, atomic, level, comp_class, id_0, id_1, \

has_ids, format, ...) \

{ \

if (test_bench_trace) { \

char *msg = "%s " format; \

fprintf(stderr, msg, get_trace_class(comp_class), \

##__VA_ARGS__); \

} \

}

#endif

#define _TRACE_EVENT_NTH_PARAMS(id_count, param_count) \

uintptr_t log_entry \

META_SEQ_FROM_0_TO(id_count , META_SEQ_STEP_id_uint32_t) \

META_SEQ_FROM_0_TO(param_count, META_SEQ_STEP_param_uint32_t)

#define _TRACE_EVENT_NTH(postfix, param_count) \

META_FUNC_WITH_VARARGS( \

_trace_event, META_CONCAT(postfix, param_count),\

void, _TRACE_EVENT_NTH_PARAMS(2, param_count) \

)

#define _TRACE_EVENT_NTH_DECLARE_GROUP(arg_count) \

_TRACE_EVENT_NTH( , arg_count); \

_TRACE_EVENT_NTH(_mbox , arg_count); \

_TRACE_EVENT_NTH(_atomic , arg_count); \

_TRACE_EVENT_NTH(_mbox_atomic , arg_count);

/* Declaration of

* void _trace_event0 (uint32_t log_entry, uint32_t ids...);

* void _trace_event_mbox0 (uint32_t log_entry, uint32_t ids...);

* void _trace_event_atomic0 (uint32_t log_entry, uint32_t ids...);

* void _trace_event_mbox_atomic0(uint32_t log_entry, uint32_t ids...);

*/

_TRACE_EVENT_NTH_DECLARE_GROUP(0)

/* Declaration of

* void _trace_event1 (uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

* void _trace_event_mbox1 (uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

* void _trace_event_atomic1 (uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

* void _trace_event_mbox_atomic1(uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

*/

_TRACE_EVENT_NTH_DECLARE_GROUP(1)

/* Declaration of

* void _trace_event2 (uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

* void _trace_event_mbox2 (uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

* void _trace_event_atomic2 (uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

* void _trace_event_mbox_atomic2(uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

*/

_TRACE_EVENT_NTH_DECLARE_GROUP(2)

/* Declaration of

* void _trace_event3 (uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

* void _trace_event_mbox3 (uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

* void _trace_event_atomic3 (uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

* void _trace_event_mbox_atomic3(uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

*/

_TRACE_EVENT_NTH_DECLARE_GROUP(3)

/* Declaration of

* void _trace_event4 (uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

* void _trace_event_mbox4 (uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

* void _trace_event_atomic4 (uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

* void _trace_event_mbox_atomic4(uint32_t log_entry, uint32_t ids...,

* uint32_t params...);

*/

_TRACE_EVENT_NTH_DECLARE_GROUP(4)

#define _TRACE_EVENT_MAX_ARGUMENT_COUNT 4

void trace_flush(void);

void trace_off(void);

void trace_init(struct sof *sof);

#if TRACE

/*

* trace_event macro definition

*

* trace_event() macro is used for logging events that occur at runtime.

* It comes in 2 main flavours, atomic and non-atomic. Depending of definitions

* above, it might also propagate log messages to mbox if desired.

*

* First argument is always class of event being logged, as defined in

* uapi/logging.h.

* Second argument is string literal in printf format, followed by up to 4

* parameters (uint32_t), that are used to expand into string fromat when

* parsing log data.

*

* All compile-time accessible data (verbosity, class, source file name, line

* index and string literal) are linked into .static_log_entries section

* of binary and then extracted by rimage, so they do not contribute to loadable

* image size. This way more elaborate log messages are possible and encouraged,

* for better debugging experience, without worrying about runtime performance.

*/

#define trace_event(class, format, ...) \

_trace_event_with_ids(class, -1, -1, 0, format, ##__VA_ARGS__)

#define trace_event_atomic(class, format, ...) \

_trace_event_atomic_with_ids(class, -1, -1, 0, format, ##__VA_ARGS__)

#define trace_event_with_ids(class, id_0, id_1, format, ...) \

_trace_event_with_ids(class, id_0, id_1, 1, format, ##__VA_ARGS__)

#define trace_event_atomic_with_ids(class, id_0, id_1, format, ...) \

_trace_event_atomic_with_ids(class, id_0, id_1, 1, format, \

##__VA_ARGS__)

#if TRACEM

/* send all trace to mbox and local trace buffer */

#define __mbox _mbox

#else

/* send trace events only to the local trace buffer */

#define __mbox

#endif

#define _trace_event_with_ids(class, id_0, id_1, has_ids, format, ...) \

_log_message(__mbox,, LOG_LEVEL_VERBOSE, class, id_0, id_1, \

has_ids, format, ##__VA_ARGS__)

#define _trace_event_atomic_with_ids(class, id_0, id_1, has_ids, format, ...)\

_log_message(__mbox, _atomic, LOG_LEVEL_VERBOSE, class, id_0, id_1, \

has_ids, format, ##__VA_ARGS__)

#define trace_value(x) trace_event(0, "value %u", x)

#define trace_value_atomic(x) trace_event_atomic(0, "value %u", x)

#define trace_point(x) platform_trace_point(x)

/* verbose tracing */

#if TRACEV

#define tracev_event(...) trace_event(__VA_ARGS__)

#define tracev_event_with_ids(...) trace_event_with_ids(__VA_ARGS__)

#define tracev_event_atomic(...) trace_event_atomic(__VA_ARGS__)

#define tracev_event_atomic_with_ids(...) trace_event_with_ids(__VA_ARGS__)

#define tracev_value(x) trace_value(x)

#define tracev_value_atomic(x) trace_value_atomic(x)

#else

#define tracev_event(...)

#define tracev_event_with_ids(...)

#define tracev_event_atomic(...)

#define tracev_event_atomic_with_ids(...)

#define tracev_value(x)

#define tracev_value_atomic(x)

#endif

/* error tracing */

#if TRACEE

#define _trace_error_with_ids(class, id_0, id_1, has_ids, format, ...) \

_log_message(_mbox, _atomic, LOG_LEVEL_CRITICAL, class, id_0, \

id_1, has_ids, format, ##__VA_ARGS__)

#define trace_error(class, format, ...) \

_trace_error_with_ids(class, -1, -1, 0, format, ##__VA_ARGS__)

#define trace_error_with_ids(class, id_0, id_1, format, ...) \

_trace_error_with_ids(class, id_0, id_1, 1, format, ##__VA_ARGS__)

#define trace_error_atomic(...) trace_error(__VA_ARGS__)

#define trace_error_atomic_with_ids(...) trace_error_with_ids(__VA_ARGS__)

/* write back error value to mbox */

#define trace_error_value(x) trace_error(0, "value %u", x)

#define trace_error_value_atomic(...) trace_error_value(__VA_ARGS__)

#else

#define trace_error(...)

#define trace_error_atomic(...)

#define trace_error_value(x)

#define trace_error_value_atomic(x)

#endif

#ifndef CONFIG_HOST

#define _DECLARE_LOG_ENTRY(lvl, format, comp_class, params, ids)\

__attribute__((section(".static_log." #lvl))) \

static const struct { \

uint32_t level; \

uint32_t component_class; \

uint32_t has_ids; \

uint32_t params_num; \

uint32_t line_idx; \

uint32_t file_name_len; \

uint32_t text_len; \

const char file_name[sizeof(__FILE__)]; \

const char text[sizeof(format)]; \

} log_entry = { \

lvl, \

comp_class, \

ids, \

params, \

__LINE__, \

sizeof(__FILE__), \

sizeof(format), \

__FILE__, \

format \

}

#define BASE_LOG_ASSERT_FAIL_MSG \

unsupported_amount_of_params_in_trace_event\

_thrown_from_macro_BASE_LOG_in_trace_h

#define BASE_LOG(function_name, id_0, id_1, entry, ...) \

{ \

STATIC_ASSERT( \

_TRACE_EVENT_MAX_ARGUMENT_COUNT >= \

META_COUNT_VARAGS_BEFORE_COMPILE(__VA_ARGS__), \

BASE_LOG_ASSERT_FAIL_MSG \

); \

META_CONCAT(function_name, \

META_COUNT_VARAGS_BEFORE_COMPILE(__VA_ARGS__)) \

((uint32_t)entry, id_0, id_1, ##__VA_ARGS__); \

}

#define __log_message(func_name, lvl, comp_class, id_0, id_1, has_ids, \

format, ...) \

{ \

_DECLARE_LOG_ENTRY(lvl, format, comp_class, \

PP_NARG(__VA_ARGS__), has_ids); \

BASE_LOG(func_name, id_0, id_1, &log_entry, ##__VA_ARGS__) \

}

#define _log_message(mbox, atomic, level, comp_class, id_0, id_1, \

has_ids, format, ...) \

__log_message(META_CONCAT_SEQ(_trace_event, mbox, atomic), \

level, comp_class, id_0, id_1, has_ids, format, \

##__VA_ARGS__)

#else

#define _DECLARE_LOG_ENTRY(lvl, format, comp_class, params, ids)\

static const struct { \

uint32_t level; \

uint32_t component_class; \

uint32_t has_ids; \

uint32_t params_num; \

uint32_t line_idx; \

uint32_t file_name_len; \

uint32_t text_len; \

const char file_name[sizeof(__FILE__)]; \

const char text[sizeof(format)]; \

} log_entry = { \

lvl, \

comp_class, \

ids, \

params, \

__LINE__, \

sizeof(__FILE__), \

sizeof(format), \

__FILE__, \

format \

}

#endif

#else

#define trace_event(...)

#define trace_event_atomic(...)

#define trace_error_with_ids(...)

#define trace_error_atomic_with_ids(...)

#define trace_error_value(x)

#define trace_error_value_atomic(x)

#define trace_value(x)

#define trace_value_atomic(x)

#define trace_point(x)

#define tracev_event(...)

#define tracev_event_with_ids(...)

#define tracev_event_atomic(...)

#define tracev_event_atomic_with_ids(...)

#define tracev_value(x)

#define tracev_value_atomic(x)

#endif

#endif