notification.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2023 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 __IPC4_NOTIFICATION_H__
#define __IPC4_NOTIFICATION_H__
 
#include <stdint.h>
#include <ipc/header.h>
#include <sof/ipc/msg.h>
#include <sof/compiler_attributes.h>
 
enum sof_ipc4_notification_type {
    SOF_IPC4_NOTIFY_PHRASE_DETECTED     = 4,  
    SOF_IPC4_NOTIFY_RESOURCE_EVENT      = 5,  
    SOF_IPC4_NOTIFY_LOG_BUFFER_STATUS   = 6,  
    SOF_IPC4_NOTIFY_TIMESTAMP_CAPTURED  = 7,  
    SOF_IPC4_NOTIFY_FW_READY        = 8,  
    SOF_IPC4_FW_AUD_CLASS_RESULT        = 9,  
    SOF_IPC4_EXCEPTION_CAUGHT       = 10, 
    SOF_IPC4_MODULE_NOTIFICATION        = 12, 
    SOF_IPC4_UAOL_EVENT         = 13, 
    SOF_IPC4_PROBE_DATA_AVAILABLE       = 14, 
    SOF_IPC4_WATCHDOG_TIMEOUT       = 15, 
    SOF_IPC4_MANAGEMENT_SERVICE     = 16, 
};
 
enum sof_ipc4_resource_event_type {
    SOF_IPC4_BUDGET_VIOLATION       = 0,  
    SOF_IPC4_MIXER_UNDERRUN_DETECTED    = 1,  
    SOF_IPC4_STREAM_DATA_SEGMENT        = 2,  
    SOF_IPC4_PROCESS_DATA_ERROR     = 3,  
    SOF_IPC4_STACK_OVERFLOW         = 4,  
    SOF_IPC4_BUFFERING_MODE_CHANGED     = 5,  
    SOF_IPC4_GATEWAY_UNDERRUN_DETECTED  = 6,  
    SOF_IPC4_GATEWAY_OVERRUN_DETECTED   = 7,  
    SOF_IPC4_EDF_DOMAIN_UNSTABLE        = 8,  
    SOF_IPC4_WATCHDOG_EVENT         = 9,  
    SOF_IPC4_GATEWAY_HIGH_THRES     = 10, 
    SOF_IPC4_GATEWAY_LOW_THRES      = 11, 
    SOF_IPC4_I2S_BCE_DETECTED       = 12, 
    SOF_IPC4_I2S_CLK_STATE_CHANGED      = 13, 
    SOF_IPC4_I2S_SINK_MODE_CHANGED      = 14, 
    SOF_IPC4_I2S_SOURCE_MODE_CHANGED    = 15, 
    SOF_IPC4_SRE_DRIFT_TOO_HIGH     = 16, 
    SOF_IPC4_TELEMETRY_DATA_STATUS      = 17, 
    SOF_IPC4_SNDW_DEBUG_INFO        = 18, 
    SOF_IPC4_INVALID_RESOURCE_EVENT_TYPE    = 19, 
};
 
enum sof_ipc4_resource_type {
    SOF_IPC4_MODULE_INSTANCE        = 0, 
    SOF_IPC4_PIPELINE           = 1, 
    SOF_IPC4_GATEWAY            = 2, 
    SOF_IPC4_EDF_TASK           = 3, 
    SOF_IPC4_INVALID_RESOURCE_TYPE      = 4, 
};
 
#define SOF_IPC4_GLB_NOTIFY_DIR_MASK        BIT(29)
#define SOF_IPC4_REPLY_STATUS_MASK      0xFFFFFF
#define SOF_IPC4_GLB_NOTIFY_TYPE_SHIFT      16
#define SOF_IPC4_GLB_NOTIFY_MSG_TYPE_SHIFT  24
 
#define SOF_IPC4_FW_READY \
        (((SOF_IPC4_NOTIFY_FW_READY) << (SOF_IPC4_GLB_NOTIFY_TYPE_SHIFT)) |\
        ((SOF_IPC4_GLB_NOTIFICATION) << (SOF_IPC4_GLB_NOTIFY_MSG_TYPE_SHIFT)))
 
#define SOF_IPC4_FW_READY_LIB_RESTORED      BIT(15)
 
#define SOF_IPC4_NOTIF_HEADER(notif_type) \
        ((notif_type) << (SOF_IPC4_GLB_NOTIFY_TYPE_SHIFT) | \
        ((SOF_IPC4_GLB_NOTIFICATION) << (SOF_IPC4_GLB_NOTIFY_MSG_TYPE_SHIFT)))
 
union ipc4_notification_header {
    uint32_t dat; 
    struct {
        uint32_t rsvd0 : 16;       
        uint32_t notif_type : 8;   
        uint32_t type : 5;         
        uint32_t rsp : 1;          
        uint32_t msg_tgt : 1;      
        uint32_t _reserved_0 : 1;  
    } r; 
} __packed __aligned(4);
 
struct ipc4_voice_cmd_notification {
    union {
        uint32_t dat;
 
        struct {
            uint32_t word_id : 16;     
            uint32_t notif_type : 8;   
            uint32_t type : 5;         
            uint32_t rsp : 1;          
            uint32_t msg_tgt : 1;      
            uint32_t _reserved_0 : 1;  
        } r; 
    } primary; 
    union {
        uint32_t dat; 
        struct {
            uint32_t sv_score : 16;   
            uint32_t rsvd1 : 14;      
            uint32_t _reserved_2 : 2; 
        } r; 
    } extension; 
} __packed __aligned(4);
 
struct ipc4_watchdog_timeout_notification {
    union {
        uint32_t dat; 
        struct {
            uint32_t core_id : 4;       
            uint32_t first_timeout : 1; 
            uint32_t rsvd : 11;         
            uint32_t notif_type : 8;    
            uint32_t type : 5;          
            uint32_t rsp : 1;           
            uint32_t msg_tgt : 1;       
            uint32_t _hw_rsvd_0 : 1;    
        } r; 
    } primary; 
    union {
        uint32_t dat; 
        struct {
            uint32_t rsvd1 : 30;      
            uint32_t _hw_rsvd_2 : 2;  
        } r; 
    } extension; 
} __packed __aligned(4);
 
static inline void ipc4_notification_watchdog_init(struct ipc4_watchdog_timeout_notification *notif,
                           uint32_t core_id, bool first_timeout)
{
    notif->primary.dat = 0;
    notif->extension.dat = 0;
 
    /* ID of a core that timeouted. */
    notif->primary.r.core_id = core_id;
 
    /* Indicates that it was first timeout and crash dump was done */
    notif->primary.r.first_timeout = first_timeout;
 
    notif->primary.r.notif_type = SOF_IPC4_WATCHDOG_TIMEOUT;
    notif->primary.r.type = SOF_IPC4_GLB_NOTIFICATION;
    notif->primary.r.rsp = SOF_IPC4_MESSAGE_DIR_MSG_REQUEST;
    notif->primary.r.msg_tgt = SOF_IPC4_MESSAGE_TARGET_FW_GEN_MSG;
}
 
struct ipc4_process_data_error_event_data {
    uint32_t error_code; 
};
 
struct ipc4_mixer_underrun_event_data {
    uint32_t eos_flag;             
    uint32_t data_mixed;          
    uint32_t expected_data_mixed; 
};
 
union ipc4_resource_event_data {
    uint32_t dws[6]; 
    struct ipc4_process_data_error_event_data process_data_error; 
    struct ipc4_mixer_underrun_event_data mixer_underrun;         
};
 
struct ipc4_resource_event_data_notification {
    uint32_t resource_type; 
    uint32_t resource_id;   
    uint32_t event_type;    
    uint32_t reserved0;     
    union ipc4_resource_event_data event_data; 
} __packed __aligned(8);
 
#define IPC4_RESOURCE_EVENT_SIZE    sizeof(struct ipc4_resource_event_data_notification)
 
void send_process_data_error_notif_msg(uint32_t resource_id, uint32_t error_code);
 
bool send_copier_gateway_xrun_notif_msg(uint32_t pipeline_id, enum sof_ipc_stream_direction dir);
 
bool send_gateway_xrun_notif_msg(uint32_t resource_id, enum sof_ipc_stream_direction dir);
 
void send_mixer_underrun_notif_msg(uint32_t resource_id, uint32_t eos_flag, uint32_t data_mixed,
                   uint32_t expected_data_mixed);
 
void ipc4_update_notification_mask(uint32_t ntfy_mask, uint32_t enabled_mask);
 
#if defined(__ZEPHYR__) && defined(CONFIG_SOF_FULL_ZEPHYR_APPLICATION)
 
__syscall bool send_resource_notif(uint32_t resource_id, uint32_t event_type,
                   uint32_t resource_type, void *data, uint32_t data_size);
#include <zephyr/syscalls/notification.h>
 
#else
 
bool z_impl_send_resource_notif(uint32_t resource_id, uint32_t event_type,
                uint32_t resource_type, void *data, uint32_t data_size);
#define send_resource_notif z_impl_send_resource_notif
 
#endif
 
#endif /* __IPC4_NOTIFICATION_H__ */