1 /*
2 * Copyright (c) 2022, 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_next.h
24 //! \brief    Gen-specific factory creation of the mcpy interfaces
25 //!
26 
27 #ifndef __MEDIA_INTERFACES_MCPY_NEXT_H__
28 #define __MEDIA_INTERFACES_MCPY_NEXT_H__
29 #include "media_factory.h"
30 
31 // forward declaration
32 class MediaCopyBaseState;
33 class MhwInterfacesNext;
34 //!
35 //! \class    McpyDevice
36 //! \brief    MCPY device
37 //!
38 class McpyDeviceNext
39 {
40 public:
~McpyDeviceNext()41     virtual ~McpyDeviceNext() {}
42 
43     MediaCopyBaseState *m_mcpyDevice = nullptr; //!< Media memory copy device
44 
45     //!
46     //! \brief    Create Media memory copy instance
47     //! \details  Entry point to create Gen specific media memory compression instance
48     //! \param    [in] osDriverContext
49     //!           OS context used by to initialize the MOS_INTERFACE, includes information necessary for resource management and interfacing with KMD in general
50     //!
51     //! \return   Pointer to Gen specific  mediacopy instance if
52     //!           successful, otherwise return nullptr
53     //!
54     static void* CreateFactory(
55         MOS_CONTEXT_HANDLE osDriverContext);
56 
57     //!
58     //! \brief    Initializes platform specific Media copy states
59     //! \param    [in] osInterface
60     //!           OS interface
61     //! \param    [in] mhwInterfaces
62     //!           HW interfaces to be used by media copy
63     //! \return   MOS_STATUS_SUCCESS if succeeded, else error code.
64     //!
65     virtual MOS_STATUS Initialize(
66         PMOS_INTERFACE    osInterface,
67         MhwInterfacesNext *mhwInterfaces) = 0;
68 
69     //!
70     //! \brief    Creat platform specific media copy HW interface
71     //! \param    [in] osInterface
72     //!           OS interface
73     //! \return   MhwInterfaces if succeeded.
74     //!
75     virtual MhwInterfacesNext* CreateMhwInterface(
76         PMOS_INTERFACE osInterface);
77     MEDIA_CLASS_DEFINE_END(McpyDeviceNext)
78 };
79 
80 extern template class MediaFactory<uint32_t, McpyDeviceNext>;
81 
82 
83 #endif // __MEDIA_INTERFACES_MCPY_NEXT_H__
84 
85