Debian Codegraph @

media_driver/agnostic/common/media_interfaces/media_interfaces_mhw.h

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