summaryrefslogtreecommitdiff
path: root/src/lib/ecore_drm/Ecore_Drm.h
diff options
context:
space:
mode:
authorChris Michael <cp.michael@samsung.com>2015-04-08 10:29:29 -0400
committerStefan Schmidt <s.schmidt@samsung.com>2015-04-10 11:09:50 +0200
commit70e8a002718e137bf85f20c6179fa8932fd12083 (patch)
treebbd2efe3f44d73f6ee1fb03697225d8d0e0972f2 /src/lib/ecore_drm/Ecore_Drm.h
parentdb87e02ac6c3ad9595e107951e0fa73c18d0e668 (diff)
ecore-drm: Move doxygen documentation to main Ecore_Drm header
Summary: This moves all doxygen to the main Ecore_Drm header to match rest of efl. @fix Signed-off-by: Chris Michael <cp.michael@samsung.com>
Diffstat (limited to 'src/lib/ecore_drm/Ecore_Drm.h')
-rw-r--r--src/lib/ecore_drm/Ecore_Drm.h231
1 files changed, 231 insertions, 0 deletions
diff --git a/src/lib/ecore_drm/Ecore_Drm.h b/src/lib/ecore_drm/Ecore_Drm.h
index 9c29505b5d..8d1320e8f2 100644
--- a/src/lib/ecore_drm/Ecore_Drm.h
+++ b/src/lib/ecore_drm/Ecore_Drm.h
@@ -201,15 +201,137 @@ EAPI extern int ECORE_DRM_EVENT_SEAT_ADD; /**< @since 1.14 */
201EAPI int ecore_drm_init(void); 201EAPI int ecore_drm_init(void);
202EAPI int ecore_drm_shutdown(void); 202EAPI int ecore_drm_shutdown(void);
203 203
204/**
205 * Find a drm device in the system.
206 *
207 * @param name The name of the device to find. If NULL, this function will
208 * search for the default drm device.
209 * @param seat The name of the seat where this device may be found. If NULL,
210 * this function will use a default seat name 'seat0'.
211 *
212 * @return An opaque Ecore_Drm_Device structure representing the card.
213 *
214 * @ingroup Ecore_Drm_Device_Group
215 */
204EAPI Ecore_Drm_Device *ecore_drm_device_find(const char *name, const char *seat); 216EAPI Ecore_Drm_Device *ecore_drm_device_find(const char *name, const char *seat);
217
218/**
219 * Free an Ecore_Drm_Device
220 *
221 * This function will cleanup and free any previously allocated Ecore_Drm_Device.
222 *
223 * @param dev The Ecore_Drm_Device to free
224 *
225 * @ingroup Ecore_Drm_Device_Group
226 */
205EAPI void ecore_drm_device_free(Ecore_Drm_Device *dev); 227EAPI void ecore_drm_device_free(Ecore_Drm_Device *dev);
228
229/**
230 * Open an Ecore_Drm_Device
231 *
232 * This function will open an existing Ecore_Drm_Device for use.
233 *
234 * @param dev The Ecore_Drm_Device to try and open
235 *
236 * @return EINA_TRUE on success, EINA_FALSE on failure
237 *
238 * @ingroup Ecore_Drm_Device_Group
239 */
206EAPI Eina_Bool ecore_drm_device_open(Ecore_Drm_Device *dev); 240EAPI Eina_Bool ecore_drm_device_open(Ecore_Drm_Device *dev);
241
242/**
243 * Close an Ecore_Drm_Device
244 *
245 * This function will close a previously opened Ecore_Drm_Device
246 *
247 * @param dev The Ecore_Drm_Device to free
248 *
249 * @return EINA_TRUE on success, EINA_FALSE on failure
250 *
251 * @ingroup Ecore_Drm_Device_Group
252 */
207EAPI Eina_Bool ecore_drm_device_close(Ecore_Drm_Device *dev); 253EAPI Eina_Bool ecore_drm_device_close(Ecore_Drm_Device *dev);
254
255/**
256 * Get if a given Ecore_Drm_Device is master
257 *
258 * This function will check if the given drm device is set to master
259 *
260 * @param dev The Ecore_Drm_Device to check
261 *
262 * @return EINA_TRUE if device is master, EINA_FALSE otherwise
263 *
264 * @ingroup Ecore_Drm_Device_Group
265 */
208EAPI Eina_Bool ecore_drm_device_master_get(Ecore_Drm_Device *dev); 266EAPI Eina_Bool ecore_drm_device_master_get(Ecore_Drm_Device *dev);
267
268/**
269 * Set a given Ecore_Drm_Device to master
270 *
271 * This function will attempt to set a given drm device to be master
272 *
273 * @param dev The Ecore_Drm_Device to set
274 *
275 * @return EINA_TRUE on success, EINA_FALSE on failure
276 *
277 * @ingroup Ecore_Drm_Device_Group
278 */
209EAPI Eina_Bool ecore_drm_device_master_set(Ecore_Drm_Device *dev); 279EAPI Eina_Bool ecore_drm_device_master_set(Ecore_Drm_Device *dev);
280
281/**
282 * Tell a given Ecore_Drm_Device to stop being master
283 *
284 * This function will attempt to ask a drm device to stop being master
285 *
286 * @param dev The Ecore_Drm_Device to set
287 *
288 * @return EINA_TRUE on success, EINA_FALSE on failure
289 *
290 * @ingroup Ecore_Drm_Device_Group
291 */
210EAPI Eina_Bool ecore_drm_device_master_drop(Ecore_Drm_Device *dev); 292EAPI Eina_Bool ecore_drm_device_master_drop(Ecore_Drm_Device *dev);
293
294/**
295 * Get the file descriptor of Ecore_Drm_Device
296 *
297 * This function will get the file descriptor of drm device
298 *
299 * @param dev The Ecore_Drm_Device to get
300 *
301 * @return fd value on success, -1 on failure
302 *
303 * @ingroup Ecore_Drm_Device_Group
304 *
305 */
211EAPI int ecore_drm_device_fd_get(Ecore_Drm_Device *dev); 306EAPI int ecore_drm_device_fd_get(Ecore_Drm_Device *dev);
307
308/**
309 * Set the window of Ecore_Drm_Device
310 *
311 * This function will set the window for given drm device
312 *
313 * @param dev The Ecore_Drm_Device for which window is set
314 * @param window The window to set
315 *
316 * @ingroup Ecore_Drm_Device_Group
317 *
318 * @since 1.10
319 */
212EAPI void ecore_drm_device_window_set(Ecore_Drm_Device *dev, unsigned int window); 320EAPI void ecore_drm_device_window_set(Ecore_Drm_Device *dev, unsigned int window);
321
322/**
323 * Get the name of the Ecore_Drm_Device
324 *
325 * This function will return the name of Ecore_Drm_Device
326 *
327 * @param dev The Ecore_Drm_Device to get name
328 *
329 * @return device name on success, NULL on failure
330 *
331 * @ingroup Ecore_Drm_Device_Group
332 *
333 * @since 1.10
334 */
213EAPI const char *ecore_drm_device_name_get(Ecore_Drm_Device *dev); 335EAPI const char *ecore_drm_device_name_get(Ecore_Drm_Device *dev);
214 336
215/** 337/**
@@ -226,15 +348,105 @@ EAPI const char *ecore_drm_device_name_get(Ecore_Drm_Device *dev);
226 */ 348 */
227EAPI Eina_Bool ecore_drm_device_software_setup(Ecore_Drm_Device *dev); 349EAPI Eina_Bool ecore_drm_device_software_setup(Ecore_Drm_Device *dev);
228 350
351/**
352 * Open a tty for use
353 *
354 * @param dev The Ecore_Drm_Device that this tty will belong to.
355 * @param name The name of the tty to try and open.
356 * If NULL, /dev/tty0 will be used.
357 *
358 * @return EINA_TRUE on success, EINA_FALSE on failure
359 *
360 * @ingroup Ecore_Drm_Tty_Group
361 */
229EAPI Eina_Bool ecore_drm_tty_open(Ecore_Drm_Device *dev, const char *name); 362EAPI Eina_Bool ecore_drm_tty_open(Ecore_Drm_Device *dev, const char *name);
363
364/**
365 * Close an already opened tty
366 *
367 * @param dev The Ecore_Drm_Device which owns this tty.
368 *
369 * @return EINA_TRUE on success, EINA_FALSE on failure
370 *
371 * @ingroup Ecore_Drm_Tty_Group
372 */
230EAPI Eina_Bool ecore_drm_tty_close(Ecore_Drm_Device *dev); 373EAPI Eina_Bool ecore_drm_tty_close(Ecore_Drm_Device *dev);
374
375/**
376 * Release a virtual terminal
377 *
378 * @param dev The Ecore_Drm_Device which owns this tty.
379 *
380 * @return EINA_TRUE on success, EINA_FALSE on failure
381 *
382 * @ingroup Ecore_Drm_Tty_Group
383 */
231EAPI Eina_Bool ecore_drm_tty_release(Ecore_Drm_Device *dev); 384EAPI Eina_Bool ecore_drm_tty_release(Ecore_Drm_Device *dev);
385
386/**
387 * Acquire a virtual terminal
388 *
389 * @param dev The Ecore_Drm_Device which owns this tty.
390 *
391 * @return EINA_TRUE on success, EINA_FALSE on failure
392 *
393 * @ingroup Ecore_Drm_Tty_Group
394 */
232EAPI Eina_Bool ecore_drm_tty_acquire(Ecore_Drm_Device *dev); 395EAPI Eina_Bool ecore_drm_tty_acquire(Ecore_Drm_Device *dev);
396
397/**
398 * Get the opened virtual terminal file descriptor
399 *
400 * @param dev The Ecore_Drm_Device which owns this tty.
401 *
402 * @return The tty fd opened from previous call to ecore_drm_tty_open
403 *
404 * @ingroup Ecore_Drm_Tty_Group
405 *
406 * @since 1.10
407 */
233EAPI int ecore_drm_tty_get(Ecore_Drm_Device *dev); 408EAPI int ecore_drm_tty_get(Ecore_Drm_Device *dev);
234 409
410/**
411 * Create outputs for a drm device
412 *
413 * This function will create outputs for Ecore_Drm_Device
414 *
415 * @param dev The Ecore_Drm_Device device for which outputs
416 * needs to be created
417 *
418 * @return EINA_TRUE on success, EINA_FALSE on failure.
419 *
420 * @ingroup Ecore_Drm_Output_Group
421 */
235EAPI Eina_Bool ecore_drm_outputs_create(Ecore_Drm_Device *dev); 422EAPI Eina_Bool ecore_drm_outputs_create(Ecore_Drm_Device *dev);
423
424/**
425 * Free an Ecore_Drm_Output
426 *
427 * This function will cleanup and free any previously allocated Ecore_Drm_Output
428 *
429 * @param output The Ecore_Drm_Output to free
430 *
431 * @ingroup Ecore_Drm_Output_Group
432 */
236EAPI void ecore_drm_output_free(Ecore_Drm_Output *output); 433EAPI void ecore_drm_output_free(Ecore_Drm_Output *output);
434
435/**
436 * Set the cursor size for Ecore_Drm_Output
437 *
438 * This function will set the cursor size of Ecore_Drm_Output
439 *
440 * @param output The Ecore_Drm_Output to set
441 * @param handle The Drm handle
442 * @param w The width of cursor
443 * @param h The height of cursor
444 *
445 * @ingroup Ecore_Drm_Output_Group
446 */
237EAPI void ecore_drm_output_cursor_size_set(Ecore_Drm_Output *output, int handle, int w, int h); 447EAPI void ecore_drm_output_cursor_size_set(Ecore_Drm_Output *output, int handle, int w, int h);
448
449/* TODO: Doxy */
238EAPI Eina_Bool ecore_drm_output_enable(Ecore_Drm_Output *output); 450EAPI Eina_Bool ecore_drm_output_enable(Ecore_Drm_Output *output);
239 451
240/** 452/**
@@ -248,15 +460,34 @@ EAPI Eina_Bool ecore_drm_output_enable(Ecore_Drm_Output *output);
248 * @since 1.15 460 * @since 1.15
249 */ 461 */
250EAPI void ecore_drm_output_disable(Ecore_Drm_Output *output); 462EAPI void ecore_drm_output_disable(Ecore_Drm_Output *output);
463
464/* TODO: Doxy */
251EAPI void ecore_drm_output_fb_release(Ecore_Drm_Output *output, Ecore_Drm_Fb *fb); 465EAPI void ecore_drm_output_fb_release(Ecore_Drm_Output *output, Ecore_Drm_Fb *fb);
466
467/* TODO: Doxy */
252EAPI void ecore_drm_output_repaint(Ecore_Drm_Output *output); 468EAPI void ecore_drm_output_repaint(Ecore_Drm_Output *output);
469
470/**
471 * Get the output size of Ecore_Drm_Device
472 *
473 * This function will give the output size of Ecore_Drm_Device
474 *
475 * @param dev The Ecore_Drm_Device to get output size
476 * @param output The output id whose information needs to be retrived
477 * @param *w The parameter in which output width is stored
478 * @param *h The parameter in which output height is stored
479 *
480 * @ingroup Ecore_Drm_Output_Group
481 */
253EAPI void ecore_drm_output_size_get(Ecore_Drm_Device *dev, int output, int *w, int *h); 482EAPI void ecore_drm_output_size_get(Ecore_Drm_Device *dev, int output, int *w, int *h);
254 483
255/** 484/**
485 * TODO: Doxy
256 * @since 1.12 486 * @since 1.12
257 */ 487 */
258EAPI void ecore_drm_outputs_geometry_get(Ecore_Drm_Device *dev, int *x, int *y, int *w, int *h); 488EAPI void ecore_drm_outputs_geometry_get(Ecore_Drm_Device *dev, int *x, int *y, int *w, int *h);
259 489
490/* TODO: Doxy */
260EAPI Eina_Bool ecore_drm_inputs_create(Ecore_Drm_Device *dev); 491EAPI Eina_Bool ecore_drm_inputs_create(Ecore_Drm_Device *dev);
261EAPI void ecore_drm_inputs_destroy(Ecore_Drm_Device *dev); 492EAPI void ecore_drm_inputs_destroy(Ecore_Drm_Device *dev);
262EAPI Eina_Bool ecore_drm_inputs_enable(Ecore_Drm_Input *input); 493EAPI Eina_Bool ecore_drm_inputs_enable(Ecore_Drm_Input *input);