There's a number of things which haven't previously been documented around the usage of format modifiers. Capture the current understanding in an overview comment and add it to the rst documentation. Ideally, the generated documentation would also include documentation of all of the #defines, but the kernel-doc system doesn't currently support kernel-doc comments on #define constants.
Showing the changes to include/uapi (1 of 2 files). Show all
Unified · Split
| @@ -30,6 +30,42 @@ · 29 unmodified lines | |||
| 30 | extern "C" { | 30 | extern "C" { |
| 31 | #endif | 31 | #endif |
| 32 | 32 | ||
| 33 | /** | ||
| 34 | * DOC: overview | ||
| 35 | * | ||
| 36 | * In the DRM subsystem, framebuffer pixel formats are described using the | ||
| 37 | * fourcc codes defined in `include/uapi/drm/drm_fourcc.h`. In addition to the | ||
| 38 | * fourcc code, a Format Modifier may optionally be provided, in order to | ||
| 39 | * further describe the buffer's format - for example tiling or compression. | ||
| 40 | * | ||
| 41 | * Format Modifiers | ||
| 42 | * ---------------- | ||
| 43 | * | ||
| 44 | * Format modifiers are used in conjunction with a fourcc code, forming a | ||
| 45 | * unique fourcc:modifier pair. This format:modifier pair must fully define the | ||
| 46 | * format and data layout of the buffer, and should be the only way to describe | ||
| 47 | * that particular buffer. | ||
| 48 | * | ||
| 49 | * Having multiple fourcc:modifier pairs which describe the same layout should | ||
| 50 | * be avoided, as such aliases run the risk of different drivers exposing | ||
| 51 | * different names for the same data format, forcing userspace to understand | ||
| 52 | * that they are aliases. | ||
| 53 | * | ||
| 54 | * Format modifiers may change any property of the buffer, including the number | ||
| 55 | * of planes and/or the required allocation size. Format modifiers are | ||
| 56 | * vendor-namespaced, and as such the relationship between a fourcc code and a | ||
| 57 | * modifier is specific to the modifer being used. For example, some modifiers | ||
| 58 | * may preserve meaning - such as number of planes - from the fourcc code, | ||
| 59 | * whereas others may not. | ||
| 60 | * | ||
| 61 | * Vendors should document their modifier usage in as much detail as | ||
| 62 | * possible, to ensure maximum compatibility across devices, drivers and | ||
| 63 | * applications. | ||
| 64 | * | ||
| 65 | * The authoritative list of format modifier codes is found in | ||
| 66 | * `include/uapi/drm/drm_fourcc.h` | ||
| 67 | */ | ||
| 68 | |||
| 33 | #define fourcc_code(a, b, c, d) ((__u32)(a) | ((__u32)(b) << 8) | \ | 69 | #define fourcc_code(a, b, c, d) ((__u32)(a) | ((__u32)(b) << 8) | \ |
| 34 | ((__u32)(c) << 16) | ((__u32)(d) << 24)) | 70 | ((__u32)(c) << 16) | ((__u32)(d) << 24)) |
| 35 | 71 | ||