system_service.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause */
/*
 * Copyright(c) 2024 Intel Corporation. All rights reserved.
 *
 * Author: Adrian Warecki <adrian.warecki@intel.com>
 */
 
#ifndef MODULE_MODULE_SYSTEM_SERVICE_H
#define MODULE_MODULE_SYSTEM_SERVICE_H
 
#include <stdint.h>
#include <stddef.h>
 
#include "logger.h"
#include "../iadk/adsp_error_code.h"
 
#ifdef __XTENSA__
    #define RESTRICT __restrict
#else
    #define RESTRICT
#endif
 
struct notification_handle;
 
/* Defines parameters used by ADSP system during notification creation. */
struct notification_params {
    uint32_t type;              
    uint16_t user_val_1;        
    uint32_t user_val_2;        
    uint32_t max_payload_size;  
    uint8_t *payload;           
};
 
/* Defines parameters used by ADSP system during Module Event notification creation. */
struct module_event_notification {
    uint32_t module_instance_id; 
    uint32_t event_id;           
    uint32_t event_data_size;    
    uint32_t event_data[];       
};
 
/* Defines notification targets supported by ADSP system
 * FW defines only two notification targets, HOST and ISH (Integrated Sensor Hub).
 */
enum notification_target {
    NOTIFICATION_TARGET_DSP_TO_HOST = 1,    /* Notification target is HOST */
    NOTIFICATION_TARGET_DSP_TO_ISH = 2  /* Notification target is ISH */
};
 
/* Defines notification types supported by ADSP system
 * FW use reserved first 20 positions describing types of notifications.
 */
enum notification_type {
    /* corresponding to PHRASE_DETECTED notification */
    NOTIFICATION_TYPE_VOICE_COMMAND_NOTIFICATION = 4,
 
    /* corresponding to FW_AUD_CLASS_RESULT notification */
    NOTIFICATION_TYPE_AUDIO_CLASSIFIER_RESULTS = 9,
 
    /* corresponding to MODULE_NOTIFICATION notification */
    NOTIFICATION_TYPE_MODULE_EVENT_NOTIFICATION = 12,
};
 
/* Defines extended interfaces for IADK modules */
enum interface_id {
    INTERFACE_ID_GNA = 0x1000,          /* Reserved for ADSP system */
    INTERFACE_ID_INFERENCE_SERVICE = 0x1001,    /* See InferenceServiceInterface */
    INTERFACE_ID_SDCA = 0x1002,         /* See SdcaInterface */
    INTERFACE_ID_ASYNC_MESSAGE_SERVICE = 0x1003,    /* See AsyncMessageInterface */
    INTERFACE_ID_AM_SERVICE = 0x1005,       /* Reserved for ADSP system */
    INTERFACE_ID_KPB_SERVICE = 0x1006,      /* See KpbInterface */
    INTERFACE_ID_TIMESTAMPING_SERVICE = 0x1007  /* See TimestampingInterface */
};
 
/* Public interface versions are opaque values used by the versioned GetInterface(). */
enum interface_version {
    INTERFACE_VERSION_GNA_V1 = 0x1000,
    INTERFACE_VERSION_INFERENCE_SERVICE_V1 = 0x1000,
    INTERFACE_VERSION_INFERENCE_SERVICE_V2 = 0x1001,
    INTERFACE_VERSION_SDCA_V1 = 0x1000,
    INTERFACE_VERSION_ASYNC_MESSAGE_SERVICE_V1 = 0x1000,
    INTERFACE_VERSION_AM_SERVICE_V1 = 0x1000,
    INTERFACE_VERSION_KPB_SERVICE_V1 = 0x1000,
    INTERFACE_VERSION_KPB_SERVICE_V2 = 0x1001,
    INTERFACE_VERSION_TIMESTAMPING_SERVICE_V1 = 0x1000,
};
 
/* Versions exposed to modules built against the current IADK headers. */
#define INTERFACE_VERSION_GNA           INTERFACE_VERSION_GNA_V1
#define INTERFACE_VERSION_INFERENCE_SERVICE INTERFACE_VERSION_INFERENCE_SERVICE_V2
#define INTERFACE_VERSION_SDCA          INTERFACE_VERSION_SDCA_V1
#define INTERFACE_VERSION_ASYNC_MESSAGE_SERVICE INTERFACE_VERSION_ASYNC_MESSAGE_SERVICE_V1
#define INTERFACE_VERSION_AM_SERVICE        INTERFACE_VERSION_AM_SERVICE_V1
#define INTERFACE_VERSION_KPB_SERVICE       INTERFACE_VERSION_KPB_SERVICE_V2
#define INTERFACE_VERSION_TIMESTAMPING_SERVICE  INTERFACE_VERSION_TIMESTAMPING_SERVICE_V1
 
/* sub interface definition.
 * This type may contain generic interface properties like id or struct size if needed.
 */
struct system_service_iface;
 
struct system_service {
    void (*log_message)(enum log_priority log_priority, uint32_t log_entry,
                struct log_handle const *log_handle, uint32_t param1,
                uint32_t param2, uint32_t param3, uint32_t param4);
 
    AdspErrorCode (*safe_memcpy)(void *RESTRICT dst, size_t maxlen,
                     const void *RESTRICT src, size_t len);
 
    AdspErrorCode (*safe_memmove)(void *dst, size_t maxlen,
                      const void *src, size_t len);
 
    void* (*vec_memset)(void *dst, int c, size_t len);
 
    AdspErrorCode (*notification_create)(struct notification_params *params,
                         uint8_t *notification_buffer,
                         uint32_t notification_buffer_size,
                         struct notification_handle **handle);
    AdspErrorCode (*notification_send)(enum notification_target notification_target,
                       struct notification_handle *message,
                       uint32_t actual_payload_size);
 
    AdspErrorCode (*get_interface)(enum interface_id id, struct system_service_iface **iface);
 
    AdspErrorCode (*get_interface_versioned)(enum interface_id id, uint32_t version,
                         struct system_service_iface **iface);
};
#endif /* MODULE_MODULE_SYSTEM_SERVICE_H */