probe.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2022 Intel Corporation. All rights reserved.
 */
 
/*
 * This file contains structures that are exact copies of an existing ABI used
 * by IOT middleware. They are Intel specific and will be used by one middleware.
 *
 * Some of the structures may contain programming implementations that makes them
 * unsuitable for generic use and general usage.
 *
 * This code is mostly copied "as-is" from existing C++ interface files hence the use of
 * different style in places. The intention is to keep the interface as close as possible to
 * original so it's easier to track changes with IPC host code.
 */
 
#ifndef __SOF_IPC4_PROBE_H__
#define __SOF_IPC4_PROBE_H__
 
#include <sof/compiler_attributes.h>
#include "base-config.h"
#include <rtos/bit.h>
#include <stdint.h>
 
#define PROBE_LOGGING_BUFFER_ID     0x01000000
 
#define PROBE_PURPOSE_EXTRACTION    0
#define PROBE_PURPOSE_INJECTION     1
 
#define PROBE_TYPE_INPUT        0
#define PROBE_TYPE_OUTPUT       1
#define PROBE_TYPE_INTERNAL     2
 
#define IPC4_PROBE_MODULE_INJECTION_DMA_ADD   1
#define IPC4_PROBE_MODULE_INJECTION_DMA_DETACH    2
#define IPC4_PROBE_MODULE_PROBE_POINTS_ADD    3
#define IPC4_PROBE_MODULE_DISCONNECT_PROBE_POINTS 4
#define IPC4_PROBE_MODULE_AVAILABLE_PROBE_POINTS  5
 
struct probe_dma {
    uint32_t stream_tag;        
    uint32_t dma_buffer_size;   
} __attribute__((packed, aligned(4)));
 
typedef union probe_point_id {
    uint32_t full_id; 
    struct {
        uint32_t  module_id   : 16; 
        uint32_t  instance_id : 8;  
        uint32_t  type        : 2;  
        uint32_t  index       : 6;  
    } fields; 
} __attribute__((packed, aligned(4))) probe_point_id_t;
 
struct probe_point {
    probe_point_id_t buffer_id; 
    uint32_t purpose;   
    uint32_t stream_tag;    
} __attribute__((packed, aligned(4)));
 
struct sof_ipc_probe_info_params {
    uint32_t num_elems;             
    union {
        struct probe_dma probe_dma[0];      
        struct probe_point probe_point[0];  
    };
} __attribute__((packed, aligned(4)));
 
struct ipc4_probe_module_cfg {
    struct ipc4_base_module_cfg base_cfg; 
    struct probe_dma gtw_cfg;             
} __packed __aligned(4);
 
#endif /* __SOF_IPC4_PROBE_H__ */