xref: /aosp_15_r20/external/mesa3d/src/gallium/auxiliary/pipe-loader/pipe_loader_priv.h (revision 6104692788411f58d303aa86923a9ff6ecaded22)
1 /**************************************************************************
2  *
3  * Copyright 2012 Francisco Jerez
4  * All Rights Reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the
8  * "Software"), to deal in the Software without restriction, including
9  * without limitation the rights to use, copy, modify, merge, publish,
10  * distribute, sub license, and/or sell copies of the Software, and to
11  * permit persons to whom the Software is furnished to do so, subject to
12  * the following conditions:
13  *
14  * The above copyright notice and this permission notice (including the
15  * next paragraph) shall be included in all copies or substantial portions
16  * of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25  *
26  **************************************************************************/
27 
28 #ifndef PIPE_LOADER_PRIV_H
29 #define PIPE_LOADER_PRIV_H
30 
31 #include "pipe_loader.h"
32 
33 struct pipe_loader_ops {
34    /**
35     * Create a pipe_screen for the specified pipe_loader_device.
36     *
37     * Consumers are expected to use pipe_loader_create_screen_vk() or
38     * pipe_loader_create_screen() which will take care of creating the
39     * configuration.
40     *
41     * Implementations should not free the device here, even on failure.
42     *
43     * \param dev The device the screen will be created for
44     * \param config The screen configuration
45     * \param sw_vk Whether the device is for software vulkan
46     * \return a pipe_screen, or NULL on failure
47    */
48    struct pipe_screen *(*create_screen)(struct pipe_loader_device *dev,
49                                         const struct pipe_screen_config *config,
50                                         bool sw_vk);
51 
52    const struct driOptionDescription *(*get_driconf)(struct pipe_loader_device *dev,
53                                                      unsigned *count);
54 
55    void (*release)(struct pipe_loader_device **dev);
56 };
57 
58 /**
59  * Open the pipe driver module that contains the specified driver.
60  */
61 struct util_dl_library *
62 pipe_loader_find_module(const char *driver_name,
63                         const char *library_paths);
64 
65 /**
66  * Free the base device structure.
67  *
68  * Implementations of pipe_loader_ops::release must call this.
69  *
70  * (*dev)->driver_name must be freed by the caller if it was allocated on the
71  * heap.
72  */
73 void
74 pipe_loader_base_release(struct pipe_loader_device **dev);
75 
76 #endif /* PIPE_LOADER_PRIV_H */
77