3e24c4af011975aa0c9fb8568f88906841a6f6d4
2 * Copyright © 2011 Intel Corporation
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:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
25 * Benjamin Franzke <benjaminfranzke@googlemail.com>
36 #include <sys/types.h>
45 #define ARRAY_SIZE(a) (sizeof(a)/sizeof((a)[0]))
47 struct gbm_device
*devices
[16];
49 static int device_num
= 0;
51 /** Returns the file description for the gbm device
53 * \return The fd that the struct gbm_device was created with
56 gbm_device_get_fd(struct gbm_device
*gbm
)
61 /* FIXME: maybe superfluous, use udev subclass from the fd? */
62 /** Get the backend name for the given gbm device
64 * \return The backend name string - this belongs to the device and must not
67 GBM_EXPORT
const char *
68 gbm_device_get_backend_name(struct gbm_device
*gbm
)
73 /** Test if a format is supported for a given set of usage flags.
75 * \param gbm The created buffer manager
76 * \param format The format to test
77 * \param usage A bitmask of the usages to test the format against
78 * \return 1 if the format is supported otherwise 0
80 * \sa enum gbm_bo_flags for the list of flags that the format can be
83 * \sa enum gbm_bo_format for the list of formats
86 gbm_device_is_format_supported(struct gbm_device
*gbm
,
87 enum gbm_bo_format format
,
90 return gbm
->is_format_supported(gbm
, format
, usage
);
93 /** Destroy the gbm device and free all resources associated with it.
95 * \param gbm The device created using gbm_create_device()
98 gbm_device_destroy(struct gbm_device
*gbm
)
101 if (gbm
->refcount
== 0)
105 GBM_EXPORT
struct gbm_device
*
106 _gbm_mesa_get_device(int fd
)
108 struct gbm_device
*gbm
= NULL
;
113 if (fd
< 0 || fstat(fd
, &buf
) < 0 || !S_ISCHR(buf
.st_mode
)) {
114 fprintf(stderr
, "_gbm_mesa_get_device: invalid fd: %d\n", fd
);
118 for (i
= 0; i
< device_num
; ++i
) {
119 dev
= devices
[i
]->stat
.st_rdev
;
120 if (major(dev
) == major(buf
.st_rdev
) &&
121 minor(dev
) == minor(buf
.st_rdev
)) {
131 /** Create a gbm device for allocating buffers
133 * The file descriptor passed in is used by the backend to communicate with
134 * platform for allocating the memory. For allocations using DRI this would be
135 * the file descriptor returned when opening a device such as \c
138 * \param fd The file descriptor for an backend specific device
139 * \return The newly created struct gbm_device. The resources associated with
140 * the device should be freed with gbm_device_destroy() when it is no longer
141 * needed. If the creation of the device failed NULL will be returned.
143 GBM_EXPORT
struct gbm_device
*
144 gbm_create_device(int fd
)
146 struct gbm_device
*gbm
= NULL
;
149 if (fd
< 0 || fstat(fd
, &buf
) < 0 || !S_ISCHR(buf
.st_mode
)) {
150 fprintf(stderr
, "gbm_create_device: invalid fd: %d\n", fd
);
155 memset(devices
, 0, sizeof devices
);
157 gbm
= _gbm_create_device(fd
);
161 gbm
->dummy
= gbm_create_device
;
165 if (device_num
< ARRAY_SIZE(devices
)-1)
166 devices
[device_num
++] = gbm
;
171 /** Get the width of the buffer object
173 * \param bo The buffer object
174 * \return The width of the allocated buffer object
177 GBM_EXPORT
unsigned int
178 gbm_bo_get_width(struct gbm_bo
*bo
)
183 /** Get the height of the buffer object
185 * \param bo The buffer object
186 * \return The height of the allocated buffer object
188 GBM_EXPORT
unsigned int
189 gbm_bo_get_height(struct gbm_bo
*bo
)
194 /** Get the stride of the buffer object
196 * This is calculated by the backend when it does the allocation in
199 * \param bo The buffer object
200 * \return The stride of the allocated buffer object
203 gbm_bo_get_pitch(struct gbm_bo
*bo
)
208 /** Get the handle of the buffer object
210 * This is stored in the platform generic union gbm_bo_handle type. However
211 * the format of this handle is platform specific.
213 * \param bo The buffer object
214 * \return Returns the stride of the allocated buffer object
216 GBM_EXPORT
union gbm_bo_handle
217 gbm_bo_get_handle(struct gbm_bo
*bo
)
223 * Destroys the given buffer object and frees all resources associated with
226 * \param bo The buffer object
229 gbm_bo_destroy(struct gbm_bo
*bo
)
231 bo
->gbm
->bo_destroy(bo
);
235 * Allocate a buffer object for the given dimensions
237 * \param gbm The gbm device returned from gbm_create_device()
238 * \param width The width for the buffer
239 * \param height The height for the buffer
240 * \param format The format to use for the buffer
241 * \param usage The union of the usage flags for this buffer
243 * \return A newly allocated buffer that should be freed with gbm_bo_destroy()
244 * when no longer needed. If an error occurs during allocation %NULL will be
247 * \sa enum gbm_bo_format for the list of formats
248 * \sa enum gbm_bo_flags for the list of usage flags
250 GBM_EXPORT
struct gbm_bo
*
251 gbm_bo_create(struct gbm_device
*gbm
,
252 uint32_t width
, uint32_t height
,
253 enum gbm_bo_format format
, uint32_t usage
)
255 if (width
== 0 || height
== 0)
258 if (usage
& GBM_BO_USE_CURSOR_64X64
&&
259 (width
!= 64 || height
!= 64))
262 return gbm
->bo_create(gbm
, width
, height
, format
, usage
);
266 * Create a buffer object representing the contents of an EGLImage
268 * \param gbm The gbm device returned from gbm_create_device()
269 * \param egl_dpy The EGLDisplay on which the EGLImage was created
270 * \param egl_image The EGLImage to create the buffer from
271 * \param width The width to use in the creation of the buffer object
272 * \param height The height to use in the creation of the buffer object
273 * \param usage The union of the usage flags for this buffer
275 * \return A newly allocated buffer object that should be freed with
276 * gbm_bo_destroy() when no longer needed.
278 * \sa enum gbm_bo_flags for the list of usage flags
280 * \note The expectation is that this function will use an efficient method
281 * for making the contents of the EGLImage available as a buffer object.
283 GBM_EXPORT
struct gbm_bo
*
284 gbm_bo_create_from_egl_image(struct gbm_device
*gbm
,
285 void *egl_dpy
, void *egl_image
,
286 uint32_t width
, uint32_t height
,
289 if (width
== 0 || height
== 0)
292 return gbm
->bo_create_from_egl_image(gbm
, egl_dpy
, egl_image
,
293 width
, height
, usage
);