1 /**************************************************************************
3 * Copyright 2012 Francisco Jerez
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
29 * \file Library that provides device enumeration and creation of
30 * winsys/pipe_screen instances.
36 #include "pipe/p_compiler.h"
37 #include "state_tracker/drm_driver.h"
38 #include "util/xmlconfig.h"
45 struct drisw_loader_funcs
;
47 enum pipe_loader_device_type
{
48 PIPE_LOADER_DEVICE_SOFTWARE
,
49 PIPE_LOADER_DEVICE_PCI
,
50 PIPE_LOADER_DEVICE_PLATFORM
,
51 NUM_PIPE_LOADER_DEVICE_TYPES
55 * A device known to the pipe loader.
57 struct pipe_loader_device
{
58 enum pipe_loader_device_type type
;
65 } u
; /**< Discriminated by \a type */
68 const struct pipe_loader_ops
*ops
;
70 driOptionCache option_cache
;
71 driOptionCache option_info
;
75 * Get a list of known devices.
77 * \param devs Array that will be filled with pointers to the devices
78 * available in the system.
79 * \param ndev Maximum number of devices to return.
80 * \return Number of devices available in the system.
83 pipe_loader_probe(struct pipe_loader_device
**devs
, int ndev
);
86 * Create a pipe_screen for the specified device.
88 * \param dev Device the screen will be created for.
91 pipe_loader_create_screen(struct pipe_loader_device
*dev
);
94 * Query the configuration parameters for the specified device.
96 * \param dev Device that will be queried.
97 * \param conf The drm_conf id of the option to be queried.
99 const struct drm_conf_ret
*
100 pipe_loader_configuration(struct pipe_loader_device
*dev
,
104 * Ensure that dev->option_cache is initialized appropriately for the driver.
106 * This function can be called multiple times.
108 * \param dev Device for which options should be loaded.
111 pipe_loader_load_options(struct pipe_loader_device
*dev
);
114 * Get the driinfo XML string used by the given driver.
116 * The returned string is heap-allocated.
119 pipe_loader_get_driinfo_xml(const char *driver_name
);
122 * Release resources allocated for a list of devices.
124 * Should be called when the specified devices are no longer in use to
125 * release any resources allocated by pipe_loader_probe.
127 * \param devs Devices to release.
128 * \param ndev Number of devices to release.
131 pipe_loader_release(struct pipe_loader_device
**devs
, int ndev
);
134 * Initialize sw dri device give the drisw_loader_funcs.
136 * This function is platform-specific.
138 * Function does not take ownership of the fd, but duplicates it locally.
139 * The local fd is closed during pipe_loader_release.
141 * \sa pipe_loader_probe
144 pipe_loader_sw_probe_dri(struct pipe_loader_device
**devs
,
145 struct drisw_loader_funcs
*drisw_lf
);
148 * Initialize a kms backed sw device given an fd.
150 * This function is platform-specific.
152 * Function does not take ownership of the fd, but duplicates it locally.
153 * The local fd is closed during pipe_loader_release.
155 * \sa pipe_loader_probe
158 pipe_loader_sw_probe_kms(struct pipe_loader_device
**devs
, int fd
);
161 * Initialize a null sw device.
163 * This function is platform-specific.
165 * \sa pipe_loader_probe
168 pipe_loader_sw_probe_null(struct pipe_loader_device
**devs
);
171 * Get a list of known software devices.
173 * This function is platform-specific.
175 * \sa pipe_loader_probe
178 pipe_loader_sw_probe(struct pipe_loader_device
**devs
, int ndev
);
181 * Get a software device wrapped atop another device.
183 * This function is platform-specific.
185 * \sa pipe_loader_probe
188 pipe_loader_sw_probe_wrapped(struct pipe_loader_device
**dev
,
189 struct pipe_screen
*screen
);
192 * Get a list of known DRM devices.
194 * This function is platform-specific.
196 * \sa pipe_loader_probe
199 pipe_loader_drm_probe(struct pipe_loader_device
**devs
, int ndev
);
202 * Initialize a DRM device in an already opened fd.
204 * This function is platform-specific.
206 * \sa pipe_loader_probe
209 pipe_loader_drm_probe_fd(struct pipe_loader_device
**dev
, int fd
);
212 * Get the driinfo XML used for the DRM driver of the given name, if any.
214 * The returned string is heap-allocated.
217 pipe_loader_drm_get_driinfo_xml(const char *driver_name
);
219 extern const char gallium_driinfo_xml
[];
225 #endif /* PIPE_LOADER_H */