Add a small description and document struct fields of drm_mode_get_plane.
Showing the changes to include/uapi (1 of 1 file). Show all
Unified · Split
| @@ -312,16 +312,48 @@ struct drm_mode_set_plane { · 311 unmodified lines | |||
| 312 | __u32 src_w; | 312 | __u32 src_w; |
| 313 | }; | 313 | }; |
| 314 | 314 | ||
| 315 | /** | ||
| 316 | * struct drm_mode_get_plane - Get plane metadata. | ||
| 317 | * | ||
| 318 | * Userspace can perform a GETPLANE ioctl to retrieve information about a | ||
| 319 | * plane. | ||
| 320 | * | ||
| 321 | * To retrieve the number of formats supported, set @count_format_types to zero | ||
| 322 | * and call the ioctl. @count_format_types will be updated with the value. | ||
| 323 | * | ||
| 324 | * To retrieve these formats, allocate an array with the memory needed to store | ||
| 325 | * @count_format_types formats. Point @format_type_ptr to this array and call | ||
| 326 | * the ioctl again (with @count_format_types still set to the value returned in | ||
| 327 | * the first ioctl call). | ||
| 328 | */ | ||
| 315 | struct drm_mode_get_plane { | 329 | struct drm_mode_get_plane { |
| 330 | /** | ||
| 331 | * @plane_id: Object ID of the plane whose information should be | ||
| 332 | * retrieved. Set by caller. | ||
| 333 | */ | ||
| 316 | __u32 plane_id; | 334 | __u32 plane_id; |
| 317 | 335 | ||
| 336 | /** @crtc_id: Object ID of the current CRTC. */ | ||
| 318 | __u32 crtc_id; | 337 | __u32 crtc_id; |
| 338 | /** @fb_id: Object ID of the current fb. */ | ||
| 319 | __u32 fb_id; | 339 | __u32 fb_id; |
| 320 | 340 | ||
| 341 | /** | ||
| 342 | * @possible_crtcs: Bitmask of CRTC's compatible with the plane. CRTC's | ||
| 343 | * are created and they receive an index, which corresponds to their | ||
| 344 | * position in the bitmask. Bit N corresponds to | ||
| 345 | * :ref:`CRTC index<crtc_index>` N. | ||
| 346 | */ | ||
| 321 | __u32 possible_crtcs; | 347 | __u32 possible_crtcs; |
| 348 | /** @gamma_size: Never used. */ | ||
| 322 | __u32 gamma_size; | 349 | __u32 gamma_size; |
| 323 | 350 | ||
| 351 | /** @count_format_types: Number of formats. */ | ||
| 324 | __u32 count_format_types; | 352 | __u32 count_format_types; |
| 353 | /** | ||
| 354 | * @format_type_ptr: Pointer to ``__u32`` array of formats that are | ||
| 355 | * supported by the plane. These formats do not require modifiers. | ||
| 356 | */ | ||
| 325 | __u64 format_type_ptr; | 357 | __u64 format_type_ptr; |
| 326 | }; | 358 | }; |
| 327 | 359 | ||