system_agent_interface.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2022 Intel Corporation. All rights reserved.
 */
#ifndef _ADSP_SYSTEM_AGENT_INTERFACE_H_
#define _ADSP_SYSTEM_AGENT_INTERFACE_H_
 
#include "system_service.h"
#include "system_error.h"
 
#include <stdint.h>
#include <stddef.h>
 
namespace intel_adsp
{
    struct ModulePlaceholder;
    class ProcessingModuleFactoryInterface;
    class ProcessingModuleInterface;
    class DetectorModuleInterface;
    class ModuleInitialSettings;
    struct ProcessingModulePrerequisites;
    struct IoPinsInfo;
    class ModuleHandle;
    struct LogHandle;
 
namespace internal
{
    class Endpoint;
} /* namespace internal */
 
    class SystemAgentInterface
    {
    public:
        struct ErrorCode : intel_adsp::ErrorCode
        {
            enum Enum {
                MODULE_CREATION_FAILURE = intel_adsp::ErrorCode::MaxValue + 1
            };
            static Enum const MinValue = MODULE_CREATION_FAILURE;
            static Enum const MaxValue = MODULE_CREATION_FAILURE;
 
            explicit ErrorCode(Type value)
                :   intel_adsp::ErrorCode(value)
            {}
        };
 
        virtual void CheckIn(ProcessingModuleInterface & processing_module,
                     ModuleHandle & module_handle,
                     LogHandle * &log_handle 
                    ) = 0;
 
        virtual int CheckIn(ProcessingModuleFactoryInterface & module_factory,
                    ModulePlaceholder * module_placeholder,
                    size_t,
                    uint32_t,
                    const void*,
                    void*,
                    void**) = 0;
 
        virtual SystemService const &GetSystemService(void) = 0;
 
        virtual LogHandle const &GetLogHandle(void) = 0;
    };
 
    class SystemAgentInterface2 : public SystemAgentInterface
    {
    public:
 
        virtual void CheckInDetector(DetectorModuleInterface & processing_module,
                         ModuleHandle & module_handle,
                         LogHandle * &log_handle
                        ) = 0;
    };
 
    class SystemAgentInterface3 : public SystemAgentInterface2
    {
    public:
 
        virtual void *GetBssBase(void) = 0;
    };
 
} /* namespace intel_adsp */
 
#endif /* _ADSP_SYSTEM_AGENT_H_ */