processing_module_factory_interface.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright(c) 2022 Intel Corporation. All rights reserved.
 */
 
#ifndef _PROCESSING_MODULE_FACTORY_INTERFACE_H_
#define _PROCESSING_MODULE_FACTORY_INTERFACE_H_
 
#include "processing_module_interface.h"
#include "system_agent_interface.h"
#include "processing_module_prerequisites.h"
#include "module_initial_settings.h"
 
namespace intel_adsp
{
    typedef void *PinEndpoint;
    typedef struct { void *prt[2]; } FwdEvent;

    struct IoPinsInfo {
        PinEndpoint *sources;
        PinEndpoint *sinks;
        FwdEvent *events;

        uint8_t *pins_mem_pool;
        size_t pins_mem_pool_size;
    };

    class ProcessingModuleFactoryInterface
    {
    public:
        struct ErrorCode : intel_adsp::ErrorCode {
            enum Enum {
                INVALID_IBS = intel_adsp::ErrorCode::MaxValue + 1,
                INVALID_OBS,
                INVALID_CPC,
                INVALID_SETTINGS
            };

            static Enum const MinValue = INVALID_IBS;
            static Enum const MaxValue = INVALID_SETTINGS;

            explicit ErrorCode(Type value)
                :   intel_adsp::ErrorCode(value)
            {}
        };

        virtual void GetPrerequisites(ProcessingModulePrerequisites & module_prereqs
                ) = 0;
        virtual ErrorCode::Type Create(SystemAgentInterface & system_agent,
                ModulePlaceholder * module_placeholder,
                ModuleInitialSettings initial_settings,
                IoPinsInfo & pins_info
            ) = 0;
    }; /* class ProcessingModuleFactoryInterface */
 
} /* namespace intel_adsp */
 
#endif /* #ifndef _PROCESSING_MODULE_FACTORY_INTERFACE_H_ */