1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
use {AsRaw, BufferObject, BufferObjectFlags, Format, FromRaw, Surface};
#[cfg(feature = "import-egl")]
use egli::egl::EGLImage;
use std::ffi::CStr;
use std::marker::PhantomData;
use std::io::{Error as IoError, Result as IoResult};
use std::os::unix::io::{AsRawFd, IntoRawFd, RawFd};
#[cfg(feature = "drm-support")]
use drm::Device as DrmDevice;
#[cfg(feature = "import-wayland")]
use wayland_server::Resource;
#[cfg(feature = "import-wayland")]
use wayland_server::protocol::wl_buffer::WlBuffer;
/// An open DRM device
pub struct Device<'a> {
ffi: *mut ::ffi::gbm_device,
_lifetime: PhantomData<&'a ()>,
}
impl<'a> AsRawFd for Device<'a> {
fn as_raw_fd(&self) -> RawFd {
unsafe { ::ffi::gbm_device_get_fd(self.ffi) }
}
}
impl<'a> AsRaw<::ffi::gbm_device> for Device<'a> {
fn as_raw(&self) -> *const ::ffi::gbm_device {
self.ffi
}
}
impl<'a> FromRaw<::ffi::gbm_device> for Device<'a> {
unsafe fn from_raw(ffi: *mut ::ffi::gbm_device) -> Self {
Device { ffi: ffi, _lifetime: PhantomData }
}
}
impl<'a> Device<'a> {
/// Open a GBM device from a given IO object taking ownership
pub fn new<I: IntoRawFd>(io: I) -> IoResult<Device<'static>> {
unsafe { Device::new_from_fd(io.into_raw_fd()) }
}
/// Open a GBM device from a given DRM device
#[cfg(feature = "drm-support")]
pub fn new_from_drm<D: DrmDevice + AsRawFd + 'a>(drm: &'a DrmDevice) -> IoResult<Device<'a>> {
unsafe { Device::new_from_fd(drm.as_raw_fd()) }
}
/// Open a GBM device from a given unix file descriptor.
///
/// The file descriptor passed in is used by the backend to communicate with
/// platform for allocating the memory. For allocations using DRI this would be
/// the file descriptor returned when opening a device such as /dev/dri/card0.
///
/// # Unsafety
///
/// The lifetime of the resulting device depends on the ownership of the file descriptor.
/// If the fd will be controlled by the device a static lifetime is valid, if it does not own the fd
/// the lifetime may not outlive the owning object.
///
pub unsafe fn new_from_fd(fd: RawFd) -> IoResult<Device<'a>> {
let ptr = ::ffi::gbm_create_device(fd);
if ptr.is_null() {
Err(IoError::last_os_error())
} else {
Ok(Device { ffi: ptr, _lifetime: PhantomData })
}
}
/// Get the backend name
pub fn backend_name(&self) -> &str {
unsafe {
CStr::from_ptr(::ffi::gbm_device_get_backend_name(self.ffi))
.to_str()
.expect("GBM passed invalid utf8 string")
}
}
/// Test if a format is supported for a given set of usage flags
pub fn is_format_supported(&self, format: Format, usage: &[BufferObjectFlags]) -> bool {
unsafe {
::ffi::gbm_device_is_format_supported(
self.ffi,
format.as_ffi(),
usage.iter().map(|x| x.as_ffi()).fold(
0u32,
|flag, x| flag | x,
),
) != 0
}
}
/// Allocate a new surface object
pub fn create_surface<T: 'static>(
&'a self,
width: u32,
height: u32,
format: Format,
usage: &[BufferObjectFlags],
) -> IoResult<Surface<'a, T>> {
let ptr = unsafe {
::ffi::gbm_surface_create(
self.ffi,
width,
height,
format.as_ffi(),
usage.iter().map(|x| x.as_ffi()).fold(
0u32,
|flag, x| flag | x,
),
)
};
if ptr.is_null() {
Err(IoError::last_os_error())
} else {
Ok(unsafe { Surface::from_raw(ptr) })
}
}
/// Allocate a buffer object for the given dimensions
pub fn create_buffer_object<T: 'static>(
&'a self,
width: u32,
height: u32,
format: Format,
usage: &[BufferObjectFlags],
) -> IoResult<BufferObject<'a, T>> {
let ptr = unsafe {
::ffi::gbm_bo_create(
self.ffi,
width,
height,
format.as_ffi(),
usage.iter().map(|x| x.as_ffi()).fold(
0u32,
|flag, x| flag | x,
),
)
};
if ptr.is_null() {
Err(IoError::last_os_error())
} else {
Ok(unsafe { BufferObject::from_raw(ptr) })
}
}
/// Create a gbm buffer object from a wayland buffer
///
/// This function imports a foreign `WlBuffer` object and creates a new gbm
/// buffer object for it.
/// This enabled using the foreign object with a display API such as KMS.
///
/// The gbm bo shares the underlying pixels but its life-time is
/// independent of the foreign object.
#[cfg(feature = "import-wayland")]
pub fn import_buffer_object_from_wayland<T: 'static>(
&'a self,
buffer: &WlBuffer,
usage: &[BufferObjectFlags],
) -> IoResult<BufferObject<'a, T>> {
let ptr = unsafe {
::ffi::gbm_bo_import(
self.ffi,
::ffi::GBM_BO_IMPORT::WL_BUFFER as u32,
buffer.ptr() as *mut _,
usage.iter().map(|x| x.as_ffi()).fold(
0u32,
|flag, x| flag | x,
),
)
};
if ptr.is_null() {
Err(IoError::last_os_error())
} else {
Ok(unsafe { BufferObject::from_raw(ptr) })
}
}
/// Create a gbm buffer object from an egl buffer
///
/// This function imports a foreign `EGLImage` object and creates a new gbm
/// buffer object for it.
/// This enabled using the foreign object with a display API such as KMS.
///
/// The gbm bo shares the underlying pixels but its life-time is
/// independent of the foreign object.
#[cfg(feature = "import-egl")]
pub fn import_buffer_object_from_egl<T: 'static>(
&'a self,
buffer: &EGLImage,
usage: &[BufferObjectFlags],
) -> IoResult<BufferObject<'a, T>> {
let ptr = unsafe {
::ffi::gbm_bo_import(
self.ffi,
::ffi::GBM_BO_IMPORT::EGL_IMAGE as u32,
*buffer,
usage.iter().map(|x| x.as_ffi()).fold(
0u32,
|flag, x| flag | x,
),
)
};
if ptr.is_null() {
Err(IoError::last_os_error())
} else {
Ok(unsafe { BufferObject::from_raw(ptr) })
}
}
/// Create a gbm buffer object from an dma buffer
///
/// This function imports a foreign dma buffer from an open file descriptor
/// and creates a new gbm buffer object for it.
/// This enabled using the foreign object with a display API such as KMS.
///
/// The gbm bo shares the underlying pixels but its life-time is
/// independent of the foreign object.
pub fn import_buffer_object_from_dma_buf<T: 'static>(
&'a self,
buffer: RawFd,
width: u32,
height: u32,
stride: u32,
format: Format,
usage: &[BufferObjectFlags],
) -> IoResult<BufferObject<'a, T>> {
let mut fd_data = ::ffi::gbm_import_fd_data {
fd: buffer,
width: width,
height: height,
stride: stride,
format: format.as_ffi(),
};
let ptr = unsafe {
::ffi::gbm_bo_import(
self.ffi,
::ffi::GBM_BO_IMPORT::FD as u32,
&mut fd_data as *mut ::ffi::gbm_import_fd_data as *mut _,
usage.iter().map(|x| x.as_ffi()).fold(
0u32,
|flag, x| flag | x,
),
)
};
if ptr.is_null() {
Err(IoError::last_os_error())
} else {
Ok(unsafe { BufferObject::from_raw(ptr) })
}
}
}
impl<'a> Drop for Device<'a> {
fn drop(&mut self) {
unsafe { ::ffi::gbm_device_destroy(self.ffi) };
}
}