blob: 61843c8a0039ed79a94a9974acfc02db2b826c27 [file] [log] [blame]
/*
* Copyright (c) 2018, Intel Corporation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
//!
//! \file media_scalability_mdf.h
//! \brief Defines the common interface for media scalability mdf
//!
#ifndef __MEDIA_SCALABILITY_MDF_H__
#define __MEDIA_SCALABILITY_MDF_H__
#include "mos_os.h"
#include "media_scalability_defs.h"
#include "media_scalability_option.h"
#include "media_scalability.h"
#include "cm_rt_umd.h"
class MediaStatusReport;
class MediaContext;
class MhwMiInterface;
class CodechalHwInterface;
class MediaScalabilityMdf : public MediaScalability
{
public:
//!
//! \brief Media scalability mdf constructor
//!
MediaScalabilityMdf() {};
//!
//! \brief Media scalability mdf destructor
//!
virtual ~MediaScalabilityMdf() {}
//!
//! \brief Initialize the media scalability
//! \details It will prepare the resources needed in scalability
//! and initialize the state of scalability
//! \param [in] option
//! Input scalability option
//! \return MOS_STATUS
//! MOS_STATUS_SUCCESS if success, else fail reason
//!
MOS_STATUS Initialize(const MediaScalabilityOption &option);
//!
//! \brief Destroy the media scalability
//! \return MOS_STATUS
//! MOS_STATUS_SUCCESS if success, else fail reason
//!
MOS_STATUS Destroy();
//!
//! \brief Get command buffer
//! \param [in] newQueue
//! if need a new queue
//! \param [out] queue
//! Pointer to cmQueue
//! \return MOS_STATUS
//! MOS_STATUS_SUCCESS if success, else fail reason
//!
MOS_STATUS GetQueue(bool newQueue, CmQueue* & queue);
//!
//! \brief Construct parameters for GPU context create.
//! \param [in, out] gpuCtxCreateOption
//! Pointer to the GPU Context Create Option
//! \return MOS_STATUS
//! MOS_STATUS_SUCCESS if success, else fail reason
//!
virtual MOS_STATUS GetGpuCtxCreationOption(MOS_GPUCTX_CREATOPTIONS *gpuCtxCreateOption) {return MOS_STATUS_UNKNOWN;};
//!
//! \brief Update the media scalability state
//! \param [in] statePars
//! parameters to update the state
//! \return MOS_STATUS
//! MOS_STATUS_SUCCESS if success, else fail reason
//!
virtual MOS_STATUS UpdateState(void *statePars) {return MOS_STATUS_SUCCESS;};
//!
//! \brief Verify command buffer
//! \param [in] requestedSize
//! requested size for command buffer
//! \param [in] requestedPatchListSize
//! requested size for patched list
//! \param [out] singleTaskPhaseSupportedInPak
//! Inidcate if to use single task phase in pak.
//! \return MOS_STATUS
//! MOS_STATUS_SUCCESS if success, else fail reason
//!
virtual MOS_STATUS VerifyCmdBuffer(uint32_t requestedSize, uint32_t requestedPatchListSize, bool &singleTaskPhaseSupportedInPak) {return MOS_STATUS_UNKNOWN;};
//!
//! \brief Get command buffer
//! \param [in, out] cmdBuffer
//! Pointer to command buffer
//! \return MOS_STATUS
//! MOS_STATUS_SUCCESS if success, else fail reason
//!
virtual MOS_STATUS GetCmdBuffer(PMOS_COMMAND_BUFFER cmdBuffer, bool frameTrackingRequested = true) {return MOS_STATUS_UNKNOWN;};
//!
//! \brief Return command buffer
//! \param [in, out] cmdBuffer
//! Pointer to command buffer
//! \return MOS_STATUS
//! MOS_STATUS_SUCCESS if success, else fail reason
//!
virtual MOS_STATUS ReturnCmdBuffer(PMOS_COMMAND_BUFFER cmdBuffer) {return MOS_STATUS_UNKNOWN;};
//!
//! \brief Submit command buffer
//! \param [in, out] cmdBuffer
//! Pointer to command buffer
//! \return MOS_STATUS
//! MOS_STATUS_SUCCESS if success, else fail reason
//!
virtual MOS_STATUS SubmitCmdBuffer(PMOS_COMMAND_BUFFER cmdBuffer) {return MOS_STATUS_UNKNOWN;};
//!
//! \brief Add synchronization for pipes.
//! \param [in] syncType
//! type of pipe sync
//! \param [in] semaphoreId
//! Id of the semaphore used for this sync
//! \param [in, out] cmdBuffer
//! Pointer to command buffer
//! \return MOS_STATUS
//! MOS_STATUS_SUCCESS if success, else fail reason
//!
virtual MOS_STATUS SyncPipe(uint32_t syncType, uint32_t semaphoreId, PMOS_COMMAND_BUFFER cmdBuffer) {return MOS_STATUS_UNKNOWN;};
//!
//! \brief Reset semaphore
//! \param [in] syncType
//! type of pipe sync
//! \param [in] semaphoreId
//! Id of the semaphore used for this sync
//! \param [in, out] cmdBuffer
//! Pointer to command buffer
//! \return MOS_STATUS
//! MOS_STATUS_SUCCESS if success, else fail reason
//!
virtual MOS_STATUS ResetSemaphore(uint32_t syncType, uint32_t semaphoreId, PMOS_COMMAND_BUFFER cmdBuffer) {return MOS_STATUS_UNKNOWN;};
//!
//! \brief Send Cmd buffer Attributes with frame tracking info
//!
//! \param [in] cmdBuffer
//! Reference to command buffer
//! \param [in] frameTrackingRequested
//! Indicate if frame tracking is requested
//!
//! \return MOS_STATUS
//! MOS_STATUS_SUCCESS if success, else fail reason
//!
virtual MOS_STATUS SendAttrWithFrameTracking(MOS_COMMAND_BUFFER &cmdBuffer, bool frameTrackingRequested) {return MOS_STATUS_UNKNOWN;};
protected:
bool m_computeContextEnabled = false;
CmDevice *m_cmDev = nullptr; //Not static now, as no where to destroy it. May use static if needed in future.
CmQueue *m_cmQueue = nullptr;
std::vector<CmQueue *> m_cmQueueList = {};
};
#endif // !__MEDIA_SCALABILITY_MDF_H__