summaryrefslogtreecommitdiff
path: root/cesar/ce/rx/src/trace.c
blob: ba95c8a1ab7b7226d40a101c5801deb99254a992 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/* Cesar project {{{
 *
 * Copyright (C) 2009 Spidcom
 *
 * <<<Licence>>>
 *
 * }}} */
/**
 * \file    ce/rx/src/trace.c
 * \brief   Trace event for the CE/RX.
 * \ingroup ce_rx
 */
#include "common/std.h"
#include "ce/rx/inc/trace.h"
#include "ce/rx/bitloading/fsm/fsm.h"
#include "ce/rx/bitloading/fsm/inc/tables.h"

#include <string.h>
#include <stdio.h>

/**
 * Format a FSM state.
 * \see trace_format_t.
 */
static int
ce_rx_trace_format_fsm_state (char *text, uint text_size, int data)
{
    const char *state_name;
    if (data < 0 || data >= CE_RX_BL_FSM_STATE_NB)
        state_name = "UNKNOWN";
    else
        state_name = ce_rx_bl_fsm_state_names_table[data];
    uint state_name_len = strlen (state_name);
    if (state_name_len > text_size)
        return -1;
    else
    {
        memcpy (text, state_name, state_name_len);
        return state_name_len;
    }
}

/**
 * Format a FSM event.
 * \see trace_format_t.
 */
static int
ce_rx_trace_format_fsm_event (char *text, uint text_size, int data)
{
    const char *event_name;
    if (data < 0 || data >= CE_RX_BL_FSM_EVENT_TYPE_NB)
        event_name = "UNKNOWN";
    else
        event_name = ce_rx_bl_fsm_event_names_table[data];
    uint event_name_len = strlen (event_name);
    if (event_name_len > text_size)
        return -1;
    else
    {
        memcpy (text, event_name, event_name_len);
        return event_name_len;
    }
}

static int
ce_rx_trace_format_s64 (char *text, uint text_size, u64 data)
{
    int ret = snprintf (text, text_size, "%lld", (s64) data);
    return ret < (int) text_size ? ret : -1;
}

void
ce_rx_trace_init (ce_rx_t *ctx)
{
    static trace_namespace_t namespace;
    static const trace_event_id_t event_ids[] =
    {
        TRACE_EVENT (CE_RX_TRACE_INIT, "init"),
        TRACE_EVENT (CE_RX_TRACE_UNINIT, "uninit", TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_MEASURE_HANDLING, "tei %d: "
                     "handling measure: tmi=%d, channel_data=%d, "
                     "pb_count=%d, sound=%d, sound_complete=%d",
                     TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_SAR_CB, "tei %d: "
                     "[sar] enqueue measure: tmi=%d, channel_data=%d, "
                     "pb_count=%d, sound=%d, sound_complete=%d",
                     TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_BL_INITIAL, "tei %d: "
                     "[fsm %d] initial bit-loading", TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_SEND_TONEMAP, "tei %d: "
                     "send tm: new_tmi=%d, old_tmi=%d, initial_ce=%d",
                     TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_SEND_TONEMAP_REFRESH, "tei %d: "
                     "send tm refresh", TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_SEND_RESTART_CE, "tei %d: "
                     "send ce restart", TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_FSM_FROM_TO, "tei %d: "
                     "[fsm %d] %S == %E ==> %S", TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_TONEMAP, "tei %d: "
                     "tone map generated: sum = %d => %dx0, %dx1, %dx2, %dx3 "
                     "%dx4, %dx5, %dx6, %dx7 (fsm id: %d)", TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_WORSE_THAN_ROBO, "tei %d: "
                     "[fsm %d] ROBO is better", TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_RESTART_FORCED, "tei %d: "
                     "forced restart of ce rx - sound received",
                     TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_PB_ERR_RATE_HIGH, "tei %d: "
                     "[fsm %d] PBErrRate high: on tmi %d, %d false on %d total "
                     "since %d frames)", TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_RESTART_PB_ERR, "tei %d: "
                     "[fsm %d] restart PB error rate too high "
                     "(since %d frames)", TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_RESTART_BER, "tei %d: "
                     "[fsm %d] restart BER low", TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_BMU_STATE, "PBER=%d, BER_margin_old=%l, "
                     "BER_margin_new=%l, oscillation_counter=%d, bmu_plus=%b",
                     TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_RESTART_BER_MARGIN_UPDATE, "tei %d: "
                     "restart BER margin update (FEC rate: %u)", TIMESTAMP),
        TRACE_EVENT (CE_RX_TRACE_WRONG_TMI, "tei %d: "
                     "[fsm %d] received with TMI %d instead of %d", TIMESTAMP),
    };
    dbg_assert (ctx);
    trace_namespace_init (&namespace, event_ids, COUNT (event_ids));
    trace_namespace_register_format (&namespace, 'S',
                                     ce_rx_trace_format_fsm_state);
    trace_namespace_register_format (&namespace, 'E',
                                     ce_rx_trace_format_fsm_event);
    trace_namespace_register_format_u64 (&namespace, 'l',
                                         ce_rx_trace_format_s64);
    trace_buffer_add (&ctx->trace, "ce_rx", 8, 1, false, &namespace);
    trace_buffer_add (&ctx->trace_verbose, "ce_rx_verbose", 8, 32, true, &namespace);
}

void
ce_rx_trace_uninit (ce_rx_t *ctx)
{
    dbg_assert (ctx);
    trace_buffer_remove (&ctx->trace);
    trace_buffer_remove (&ctx->trace_verbose);
}