1 /*
2 * Copyright (c) 2020-2021, Intel Corporation
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included
12 * in all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
21 */
22 //!
23 //! \file     media_interfaces_mcpy.h
24 //! \brief    Gen-specific factory creation of the mcpy interfaces
25 //!
26 
27 #ifndef __MEDIA_INTERFACES_MCPY_H__
28 #define __MEDIA_INTERFACES_MCPY_H__
29 
30 #include "media_interfaces_mhw.h"
31 
32 // forward declaration
33 class MediaCopyBaseState;
34 
35 //!
36 //! \class    McpyDevice
37 //! \brief    MCPY device
38 //!
39 class McpyDevice
40 {
41 public:
~McpyDevice()42     virtual ~McpyDevice() {}
43 
44     MediaCopyBaseState *m_mcpyDevice = nullptr; //!< Media memory copy device
45 
46     //!
47     //! \brief    Create Media memory copy instance
48     //! \details  Entry point to create Gen specific media memory compression instance
49     //! \param    [in] osDriverContext
50     //!           OS context used by to initialize the MOS_INTERFACE, includes information necessary for resource management and interfacing with KMD in general
51     //!
52     //! \return   Pointer to Gen specific media memory compression instance if
53     //!           successful, otherwise return nullptr
54     //!
55     static void* CreateFactory(
56         PMOS_CONTEXT osDriverContext);
57 
58     //!
59     //! \brief    Initializes platform specific MMD (media memory decompression) states
60     //! \param    [in] osInterface
61     //!           OS interface
62     //! \param    [in] mhwInterfaces
63     //!           HW interfaces to be used by MMD
64     //! \return   MOS_STATUS_SUCCESS if succeeded, else error code.
65     //!
66     virtual MOS_STATUS Initialize(
67         PMOS_INTERFACE osInterface,
68         MhwInterfaces *mhwInterfaces) = 0;
69 
70     //!
71     //! \brief    Creat platform specific MMD (media memory decompression) HW interface
72     //! \param    [in] osInterface
73     //!           OS interface
74     //! \return   MhwInterfaces if succeeded.
75     //!
76     virtual MhwInterfaces* CreateMhwInterface(
77         PMOS_INTERFACE osInterface);
78 };
79 
80 extern template class MediaFactory<uint32_t, McpyDevice>;
81 
82 #endif // __MEDIA_INTERFACES_MCPY_H__
83 
84