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 /** 29 * \file Library that provides device enumeration and creation of 30 * winsys/pipe_screen instances. 31 */ 32 33 #ifndef PIPE_LOADER_H 34 #define PIPE_LOADER_H 35 36 #include "util/compiler.h" 37 #include "frontend/drm_driver.h" 38 #include "util/xmlconfig.h" 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 struct pipe_screen; 45 struct drisw_loader_funcs; 46 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 52 }; 53 54 /** 55 * A device known to the pipe loader. 56 */ 57 struct pipe_loader_device { 58 enum pipe_loader_device_type type; 59 60 union { 61 struct { 62 int vendor_id; 63 int chip_id; 64 } pci; 65 } u; /**< Discriminated by \a type */ 66 67 char *driver_name; 68 const struct pipe_loader_ops *ops; 69 70 driOptionCache option_cache; 71 driOptionCache option_info; 72 }; 73 74 /** 75 * Get a list of known devices. 76 * 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 * \param with_zink If devices should also be loaded with zink. 81 * \return Number of devices available in the system. 82 */ 83 int 84 pipe_loader_probe(struct pipe_loader_device **devs, int ndev, bool with_zink); 85 86 /** 87 * Create a pipe_screen for the specified device. 88 * 89 * \param dev Device the screen will be created for. 90 * \param sw_vk Device is for software vulkan 91 */ 92 struct pipe_screen * 93 pipe_loader_create_screen_vk(struct pipe_loader_device *dev, bool sw_vk); 94 95 /** 96 * Create a pipe_screen for the specified device. 97 * 98 * \param dev Device the screen will be created for. 99 */ 100 struct pipe_screen * 101 pipe_loader_create_screen(struct pipe_loader_device *dev); 102 103 /** 104 * Ensures that the driconf option cache has been parsed for the driver. 105 * 106 * Drivers may parse during screen creation, but for those that don't (probably 107 * due to not having any driver-specific driconf options), this can be used to 108 * finish the parsing so that general driconf options can be queried. 109 */ 110 void 111 pipe_loader_config_options(struct pipe_loader_device *dev); 112 113 /** 114 * Get the driinfo XML string used by the given driver. 115 * 116 * The returned string is heap-allocated. 117 */ 118 char * 119 pipe_loader_get_driinfo_xml(const char *driver_name); 120 121 /** 122 * Release resources allocated for a list of devices. 123 * 124 * Should be called when the specified devices are no longer in use to 125 * release any resources allocated by pipe_loader_probe. 126 * 127 * \param devs Devices to release. 128 * \param ndev Number of devices to release. 129 */ 130 void 131 pipe_loader_release(struct pipe_loader_device **devs, int ndev); 132 133 /** 134 * Initialize sw dri device give the drisw_loader_funcs. 135 * 136 * This function is platform-specific. 137 * 138 * Function does not take ownership of the fd, but duplicates it locally. 139 * The local fd is closed during pipe_loader_release. 140 * 141 * \sa pipe_loader_probe 142 */ 143 bool 144 pipe_loader_sw_probe_dri(struct pipe_loader_device **devs, 145 const struct drisw_loader_funcs *drisw_lf); 146 147 /** 148 * Initialize vk dri device give the drisw_loader_funcs. 149 * 150 * This function is platform-specific. 151 * 152 * Function does not take ownership of the fd, but duplicates it locally. 153 * The local fd is closed during pipe_loader_release. 154 * 155 * \sa pipe_loader_probe 156 */ 157 bool 158 pipe_loader_vk_probe_dri(struct pipe_loader_device **devs, 159 const struct drisw_loader_funcs *drisw_lf); 160 161 #ifdef HAVE_DRISW_KMS 162 /** 163 * Initialize a kms backed sw device given an fd. 164 * 165 * This function is platform-specific. 166 * 167 * Function does not take ownership of the fd, but duplicates it locally. 168 * The local fd is closed during pipe_loader_release. 169 * 170 * \sa pipe_loader_probe 171 */ 172 bool 173 pipe_loader_sw_probe_kms(struct pipe_loader_device **devs, int fd); 174 #endif 175 176 /** 177 * Initialize a null sw device. 178 * 179 * This function is platform-specific. 180 * 181 * \sa pipe_loader_probe 182 */ 183 bool 184 pipe_loader_sw_probe_null(struct pipe_loader_device **devs); 185 186 /** 187 * Get a list of known software devices. 188 * 189 * This function is platform-specific. 190 * 191 * \sa pipe_loader_probe 192 */ 193 int 194 pipe_loader_sw_probe(struct pipe_loader_device **devs, int ndev); 195 196 /** 197 * Get a software device wrapped atop another device. 198 * 199 * This function is platform-specific. 200 * 201 * \sa pipe_loader_probe 202 */ 203 bool 204 pipe_loader_sw_probe_wrapped(struct pipe_loader_device **dev, 205 struct pipe_screen *screen); 206 207 /** 208 * Get a list of known DRM devices. 209 * 210 * This function is platform-specific. 211 * 212 * \sa pipe_loader_probe 213 */ 214 int 215 pipe_loader_drm_probe(struct pipe_loader_device **devs, int ndev); 216 217 #ifdef HAVE_ZINK 218 /** 219 * Get a list of known DRM devices compatible with zink. 220 * 221 * This function is platform-specific. 222 * 223 * \sa pipe_loader_probe 224 */ 225 int 226 pipe_loader_drm_zink_probe(struct pipe_loader_device **devs, int ndev); 227 #endif 228 229 /** 230 * Get the fd of a render-capable device compatible with a given display-only 231 * device fd. 232 */ 233 int 234 pipe_loader_get_compatible_render_capable_device_fd(int kms_only_fd); 235 236 /** 237 * Initialize a DRM device in an already opened fd. 238 * 239 * This function is platform-specific. 240 * 241 * \sa pipe_loader_probe 242 */ 243 bool 244 pipe_loader_drm_probe_fd(struct pipe_loader_device **dev, int fd, bool zink); 245 246 /** 247 * Get the dri options used for the DRM driver of the given name, if any. 248 * 249 * The returned array is heap-allocated. 250 */ 251 const struct driOptionDescription * 252 pipe_loader_drm_get_driconf_by_name(const char *driver_name, unsigned *count); 253 254 #ifdef __cplusplus 255 } 256 #endif 257 258 #endif /* PIPE_LOADER_H */ 259