xref: /aosp_15_r20/external/intel-media-driver/media_driver/agnostic/gen9/vp/hal/vphal_g9.h (revision ba62d9d3abf0e404f2022b4cd7a85e107f48596f)
1 /*
2 * Copyright (c) 2017, 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     vphal_g9.h
24 //! \brief    vphal interface clarification for GEN9
25 //! \details  vphal interface clarification for GEN9 inlcuding:
26 //!           some marcro, enum, structure, function
27 //!
28 #ifndef __VPHAL_G9_H__
29 #define __VPHAL_G9_H__
30 
31 #include "vphal.h"
32 
33 //!
34 //! Class VphalStateG9
35 //! \brief VPHAL class definition for GEN9
36 //!
37 class VphalStateG9 : public VphalState
38 {
39 public:
40     //!
41     //! \brief    VphalState Constructor
42     //! \details  Creates instance of VphalState
43     //!           - Caller must call Allocate to allocate all VPHAL states and objects.
44     //! \param    [in] pOsInterface
45     //!           OS interface, if provided externally - may be NULL
46     //! \param    [in] pOsDriverContext
47     //!           OS driver context (UMD context, pShared, ...)
48     //! \param    [in,out] peStatus
49     //!           Pointer to the MOS_STATUS flag.
50     //!           Will assign this flag to MOS_STATUS_SUCCESS if successful, otherwise failed
51     //!
VphalStateG9(PMOS_INTERFACE pOsInterface,MOS_STATUS * peStatus)52     VphalStateG9(
53         PMOS_INTERFACE          pOsInterface,
54         MOS_STATUS              *peStatus) :
55         VphalState(pOsInterface, peStatus)
56     {
57     }
58 
59     //!
60     //! \brief    VphalState Destuctor
61     //! \details  Destroys VPHAL and all internal states and objects
62     //!
~VphalStateG9()63     virtual ~VphalStateG9()
64     {
65     }
66 
67 protected:
68     //!
69     //! \brief    Create instance of VphalRenderer
70     //! \details  Create instance of VphalRenderer
71     //! \return   MOS_STATUS
72     //!           Return MOS_STATUS_SUCCESS if successful, otherwise failed
73     //!
74     virtual MOS_STATUS CreateRenderer();
75 };
76 
77 #endif  // __VPHAL_G9_H__
78