performance_monitor.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2024 Intel Corporation. All rights reserved.
 *
 * Author: Tobiasz Dryjanski <tobiaszx.dryjanski@intel.com>
 */
 
#ifndef __SOF_PERFORMANCE_MONITOR_H__
#define __SOF_PERFORMANCE_MONITOR_H__
 
#include <ipc4/base_fw.h>
 
/* to be moved to Zephyr */
#define WIN3_MBASE DT_REG_ADDR(DT_PHANDLE(DT_NODELABEL(mem_window3), memory))
#define ADSP_PMW ((volatile uint32_t *) \
         (sys_cache_uncached_ptr_get((__sparse_force void __sparse_cache *) \
                     (WIN3_MBASE + WIN3_OFFSET))))
 
#if IS_ENABLED(CONFIG_SOF_TELEMETRY_PERFORMANCE_MEASUREMENTS)
void perf_data_item_comp_init(struct perf_data_item_comp *perf, uint32_t resource_id,
                  uint32_t power_mode);

struct perf_data_item_comp *perf_data_getnext(void);

int free_performance_data(struct perf_data_item_comp *item);

void perf_meas_set_state(enum ipc4_perf_measurements_state_set state);

enum ipc4_perf_measurements_state_set perf_meas_get_state(void);

int get_performance_data(struct global_perf_data * const global_perf_data);

int get_extended_performance_data(struct extended_global_perf_data * const ext_global_perf_data);

int reset_performance_counters(void);

int enable_performance_counters(void);

void disable_performance_counters(void);
 
#else
 
static inline
void perf_data_item_comp_init(struct perf_data_item_comp *perf, uint32_t resource_id,
                  uint32_t power_mode)
{}
 
static inline struct perf_data_item_comp *perf_data_getnext(void)
{
    return NULL;
}
 
static inline
int free_performance_data(struct perf_data_item_comp *item)
{
    return 0;
}
 
static inline void perf_meas_set_state(enum ipc4_perf_measurements_state_set state) {}
 
static inline enum ipc4_perf_measurements_state_set perf_meas_get_state(void)
{
    return IPC4_PERF_MEASUREMENTS_DISABLED;
}
 
static inline int get_performance_data(struct global_perf_data * const global_perf_data)
{
    return 0;
}
 
static inline
int get_extended_performance_data(struct extended_global_perf_data * const ext_global_perf_data)
{
    return 0;
}
 
static inline int reset_performance_counters(void)
{
    return 0;
}
 
static inline int enable_performance_counters(void)
{
    return 0;
}
 
static inline void disable_performance_counters(void) {}
 
#endif
 
#ifdef CONFIG_SOF_TELEMETRY_IO_PERFORMANCE_MEASUREMENTS
 
struct io_perf_data_item {
    /* ID of interface */
    uint32_t id : 8;
    /*  Instance of interface / bus */
    uint32_t instance : 8;
    /*  I/O direction from ACE perspective: 0 - Input, 1 - Output */
    uint32_t direction : 1;
    /*  I/O state: 0 - powered down / disabled, 1 - powered up / enabled */
    uint32_t state : 1;
    /* Power Mode:  0 - D0, 1 - D0ix (clock gating enabled), */
    uint32_t power_mode : 2;
    uint32_t rsvd : 11;
    /* The component still exists (0) or has been already deleted (1) */
    uint32_t is_removed : 1;
    /* Performance data */
    /*
     * I/O (id)  - ID - Units - Description
     *
     * Host IPC  - 0  - Count - Counter of Host IPC messages incoming and outcoming
     * IDC       - 1  - Count - Counter of IDC messages incoming and outcoming per DSP core
     * DMIC      - 2 - Bytes - Counter of bytes transferred over DMIC interface
     * I2S       - 3 - Bytes - Counter of bytes transferred over I2S interface
     * SoundWire - 4 - Bytes - Counter of bytes transferred over SoundWire interface
     * HD/A      - 5 - Bytes - Counter of bytes transferred over HD/A interface
     * USB       - 6 - Bytes - Counter of bytes transferred over USB interface
     * GPIO      - 7 - Count - Counter of GPIO interrupts or triggers
     * I2C       - 8 - Bytes - Counter of bytes transferred over I2C interface
     * I3C       - 9 - Bytes - Counter of bytes transferred over I3C interface
     * I3C interrupt - 10 - Bytes - Counter of I3C interrupts
     * UART      - 11 - Bytes - Counter of bytes transferred over UART interface
     * SPI       - 12 - Bytes - Counter of bytes transferred over SPI interface
     * CSI-2     - 13 - Bytes - Counter of bytes transferred over CSI-2 interface
     * DTF       - 14 - Bytes - Counter of bytes transferred over DTF interface
     */
    uint64_t data;
} __packed;
 
/* those below are used for bits in io_perf_data_item, it just uses 32bit vars specifically */
enum io_perf_data_item_dir {
    IO_PERF_INPUT_DIRECTION = 0,
    IO_PERF_OUTPUT_DIRECTION = 1,
};
 
enum io_perf_data_item_state {
    IO_PERF_POWERED_DOWN_DISABLED = 0,
    IO_PERF_POWERED_UP_ENABLED = 1,
};
 
enum io_perf_data_item_power_mode {
    IO_PERF_D0_POWER_MODE = 0,
    IO_PERF_D0IX_POWER_MODE = 1,
};
 
enum io_perf_data_item_id {
    IO_PERF_IPC_ID = 0,
    IO_PERF_IDC_ID = 1,
    IO_PERF_DMIC_ID = 2,
    IO_PERF_I2S_ID = 3,
    IO_PERF_SOUND_WIRE_ID = 4,
    IO_PERF_HDA_ID = 5,
    IO_PERF_USB_ID = 6,
    IO_PERF_GPIO_ID = 7,
    IO_PERF_I2C_ID = 8,
    IO_PERF_I3C_ID = 9,
    IO_PERF_I3C_INTERRUPT_ID = 10,
    IO_PERF_UART_ID = 11,
    IO_PERF_SPI_ID = 12,
    IO_PERF_CSI_2_ID = 13,
    IO_PERF_DTF_ID = 14,
    IO_PERF_INVALID_ID = 0xFF
};
 
struct io_global_perf_data {
    /* Number of statistics */
    uint32_t perf_item_count;
    /*  Performance statistics per I/O */
    struct io_perf_data_item perf_items[0];
};
 
/* I/O Performance Monitor initialization. */
/*
 * @return ErrorCode
 */
int io_perf_monitor_init(void);
 
/* Release slot */
/*
 * @param [in] slot_id pointer to io_perf_data_item
 * @return ErrorCode
 */
int io_perf_monitor_release_slot(struct io_perf_data_item *slot_id);
 
/* Get I/O performance data */
/*
 * @param [in] io_global_perf_data point to io_global_perf_data
 * @return ErrorCode
 */
int
io_perf_monitor_get_performance_data(struct io_global_perf_data *io_global_perf_data);
 
/* Set control state of I/o performance measurements process */
/*
 * @param [in] state a state to set
 * @return ErrorCode
 */
int
io_perf_monitor_set_state(enum ipc4_perf_measurements_state_set state);
 
/* Get control state of I/o performance measurements process */
/*
 * @return ipc4_perf_measurements_state_set
 */
enum ipc4_perf_measurements_state_set io_perf_monitor_get_state(void);
 
/* Initialization of I/O performance data */
/*
 * @param [out] slot_id pointer to io_perf_data_item
 * @param [in]  init_data pointer to init data
 */
int io_perf_monitor_init_data(struct io_perf_data_item **slot_id,
                  struct io_perf_data_item *init_data);
 
/* Update of I/O performance data */
/*
 * @param [in] slot_id pointer to io_perf_data_item
 * @param [in] increment
 * @note IMPORTANT: this function assumes each perf slot has only one user
 * (use this only once per slot)
 */
void io_perf_monitor_update_data(struct io_perf_data_item *slot_id,
                 uint32_t increment);
 
/* Update of I/0 state */
/*
 * @param [in] slot_id pointer to io_perf_data_item
 * @param [in] power_up 0 - powered down / disabled, 1 - powered up / enabled
 */
void io_perf_monitor_update_io_state(struct io_perf_data_item *slot_id,
                     bool const power_up);
 
/* Update of I/0 power mode */
/*
 * @param [in] slot_id pointer to io_perf_data_item
 * @param [in] power_mode 0 - D0, 1 - D0ix (clock gating enabled)
 */
void io_perf_monitor_update_power_mode(struct io_perf_data_item *slot_id,
                       bool const power_mode);
 
#endif //SUPPORTED(IO_PERFORMANCE_MEASUREMENTS)
 
#endif