1 /*
2 * Copyright (c) 2013-2020, 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_mhw.h
24 //! \brief    Gen-specific factory creation of the mhw interfaces
25 //!
26 
27 #ifndef __MEDIA_INTERFACES_MHW_H__
28 #define __MEDIA_INTERFACES_MHW_H__
29 
30 #include "media_factory.h"
31 #include "igfxfmid.h"
32 #include "mos_utilities.h"
33 #include "mos_os.h"
34 
35 // forward declarations
36 class MhwCpInterface;
37 class MhwMiInterface;
38 class MhwRenderInterface;
39 class MhwSfcInterface;
40 class XMHW_STATE_HEAP_INTERFACE;
41 class MhwVeboxInterface;
42 class MhwVeboxInterface;
43 class MhwVdboxMfxInterface;
44 class MhwVdboxHcpInterface;
45 class MhwVdboxHucInterface;
46 class MhwVdboxVdencInterface;
47 class MhwBltInterface;
48 
49 //!
50 //! \class    MhwInterfaces
51 //! \brief    MHW interfaces
52 //!
53 class MhwInterfaces
54 {
55 public:
~MhwInterfaces()56     virtual ~MhwInterfaces() {}
57 
58     //! \brief Determines which interfaces are created
59     struct CreateParams
60     {
CreateParamsCreateParams61         CreateParams()
62         {
63             Flags.m_value = 0;
64         }
65 
66         union
67         {
68             struct
69             {
70                 uint32_t m_render : 1;
71                 uint32_t m_sfc : 1;
72                 uint32_t m_stateHeap : 1;
73                 uint32_t m_vebox : 1;
74                 uint32_t m_vdboxAll : 1;
75                 uint32_t m_mfx : 1;
76                 uint32_t m_hcp : 1;
77                 uint32_t m_huc : 1;
78                 uint32_t m_vdenc : 1;
79                 uint32_t m_blt : 1;
80                 uint32_t m_avp : 1;
81                 uint32_t m_reserved : 21;
82             };
83             uint32_t m_value;
84         } Flags;
85 
86         uint8_t m_heapMode = 0; //!< To be deprecated when heap management unified
87         bool m_isDecode = false; //!< Whether or not decode is in use, only valid for VDBOX creation
88         bool m_isCp     = false; //!< Whether or not CP is in use, CP only need mi and cp interface.
89     };
90 
91     //! \brief These interfaces are responsible for constructing instructions,
92      //!           structures, and registers for hardware.
93     MhwCpInterface *m_cpInterface = nullptr;
94     MhwMiInterface *m_miInterface = nullptr;
95     MhwRenderInterface *m_renderInterface = nullptr;
96     MhwSfcInterface *m_sfcInterface = nullptr;
97     XMHW_STATE_HEAP_INTERFACE *m_stateHeapInterface = nullptr;
98     MhwVeboxInterface *m_veboxInterface = nullptr;
99     MhwVdboxMfxInterface *m_mfxInterface = nullptr;
100     MhwVdboxHcpInterface *m_hcpInterface = nullptr;
101     MhwVdboxHucInterface *m_hucInterface = nullptr;
102     MhwVdboxVdencInterface *m_vdencInterface = nullptr;
103     MhwBltInterface *m_bltInterface = nullptr;
104     PMOS_INTERFACE m_osInterface = nullptr;
105 
106     //!
107     //! \brief    Calls the factory function to initialize all requested interfaces.
108     //! \param    [in] params
109     //!           Configuration flags for the creation of MHW interfaces.
110     //! \param    [in] osInterface
111     //!           OS interface
112     //! \return   MhwInterfaces*
113     //!           returns a valid pointer if successful and nullptr if failed.
114     //!
115     static MhwInterfaces* CreateFactory(
116         CreateParams params,
117         PMOS_INTERFACE osInterface);
118 
119     //!
120     //! \brief    Creates requested MHW interfaces.
121     //! \param    [in] params
122     //!           Configuration flags for the creation of MHW interfaces.
123     //! \param    [in] osInterface
124     //!           OS interface
125     //! \return   MOS_STATUS_SUCCESS if succeeded, else error code.
126     //!
127     virtual MOS_STATUS Initialize(
128         CreateParams params,
129         PMOS_INTERFACE osInterface) = 0;
130 
131     //!
132     //! \brief    Destroys all created MHW interfaces
133     //! \details  If the HAL creation fails, this is used for cleanup
134     //!
135     virtual void Destroy();
136 
137     //!
138     //! \brief    Set Interfaces Destroy State
139     //! \details  If the interfaces has destroyed, set this state value on
140     //!
SetDestroyState(bool destorystate)141     void SetDestroyState(bool destorystate) { m_isDestroyed = destorystate; };
GetDestroyState()142     bool GetDestroyState() { return m_isDestroyed; };
143 
144 private:
145     bool m_isDestroyed = false;
146 };
147 
148 extern template class MediaFactory<uint32_t, MhwInterfaces>;
149 
150 #endif // __MEDIA_INTERFACES_MHW_H__
151