1 /* 2 * Copyright (c) 2016 Laurent Pinchart <laurent.pinchart@ideasonboard.com> 3 * 4 * Permission to use, copy, modify, distribute, and sell this software and its 5 * documentation for any purpose is hereby granted without fee, provided that 6 * the above copyright notice appear in all copies and that both that copyright 7 * notice and this permission notice appear in supporting documentation, and 8 * that the name of the copyright holders not be used in advertising or 9 * publicity pertaining to distribution of the software without specific, 10 * written prior permission. The copyright holders make no representations 11 * about the suitability of this software for any purpose. It is provided "as 12 * is" without express or implied warranty. 13 * 14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 15 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO 16 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR 17 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, 18 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 19 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 20 * OF THIS SOFTWARE. 21 */ 22 #ifndef __DRM_FOURCC_H__ 23 #define __DRM_FOURCC_H__ 24 25 #include <linux/types.h> 26 #include <uapi/drm/drm_fourcc.h> 27 28 /* 29 * DRM formats are little endian. Define host endian variants for the 30 * most common formats here, to reduce the #ifdefs needed in drivers. 31 * 32 * Note that the DRM_FORMAT_BIG_ENDIAN flag should only be used in 33 * case the format can't be specified otherwise, so we don't end up 34 * with two values describing the same format. 35 */ 36 #ifdef __BIG_ENDIAN 37 # define DRM_FORMAT_HOST_XRGB1555 (DRM_FORMAT_XRGB1555 | \ 38 DRM_FORMAT_BIG_ENDIAN) 39 # define DRM_FORMAT_HOST_RGB565 (DRM_FORMAT_RGB565 | \ 40 DRM_FORMAT_BIG_ENDIAN) 41 # define DRM_FORMAT_HOST_XRGB8888 DRM_FORMAT_BGRX8888 42 # define DRM_FORMAT_HOST_ARGB8888 DRM_FORMAT_BGRA8888 43 #else 44 # define DRM_FORMAT_HOST_XRGB1555 DRM_FORMAT_XRGB1555 45 # define DRM_FORMAT_HOST_RGB565 DRM_FORMAT_RGB565 46 # define DRM_FORMAT_HOST_XRGB8888 DRM_FORMAT_XRGB8888 47 # define DRM_FORMAT_HOST_ARGB8888 DRM_FORMAT_ARGB8888 48 #endif 49 50 struct drm_device; 51 struct drm_mode_fb_cmd2; 52 53 /** 54 * struct drm_format_info - information about a DRM format 55 */ 56 struct drm_format_info { 57 /** @format: 4CC format identifier (DRM_FORMAT_*) */ 58 u32 format; 59 60 /** 61 * @depth: 62 * 63 * Color depth (number of bits per pixel excluding padding bits), 64 * valid for a subset of RGB formats only. This is a legacy field, do 65 * not use in new code and set to 0 for new formats. 66 */ 67 u8 depth; 68 69 /** @num_planes: Number of color planes (1 to 3) */ 70 u8 num_planes; 71 72 union { 73 /** 74 * @cpp: 75 * 76 * Number of bytes per pixel (per plane), this is aliased with 77 * @char_per_block. It is deprecated in favour of using the 78 * triplet @char_per_block, @block_w, @block_h for better 79 * describing the pixel format. 80 */ 81 u8 cpp[4]; 82 83 /** 84 * @char_per_block: 85 * 86 * Number of bytes per block (per plane), where blocks are 87 * defined as a rectangle of pixels which are stored next to 88 * each other in a byte aligned memory region. Together with 89 * @block_w and @block_h this is used to properly describe tiles 90 * in tiled formats or to describe groups of pixels in packed 91 * formats for which the memory needed for a single pixel is not 92 * byte aligned. 93 * 94 * @cpp has been kept for historical reasons because there are 95 * a lot of places in drivers where it's used. In drm core for 96 * generic code paths the preferred way is to use 97 * @char_per_block, drm_format_info_block_width() and 98 * drm_format_info_block_height() which allows handling both 99 * block and non-block formats in the same way. 100 * 101 * For formats that are intended to be used only with non-linear 102 * modifiers both @cpp and @char_per_block must be 0 in the 103 * generic format table. Drivers could supply accurate 104 * information from their drm_mode_config.get_format_info hook 105 * if they want the core to be validating the pitch. 106 */ 107 u8 char_per_block[4]; 108 }; 109 110 /** 111 * @block_w: 112 * 113 * Block width in pixels, this is intended to be accessed through 114 * drm_format_info_block_width() 115 */ 116 u8 block_w[4]; 117 118 /** 119 * @block_h: 120 * 121 * Block height in pixels, this is intended to be accessed through 122 * drm_format_info_block_height() 123 */ 124 u8 block_h[4]; 125 126 /** @hsub: Horizontal chroma subsampling factor */ 127 u8 hsub; 128 /** @vsub: Vertical chroma subsampling factor */ 129 u8 vsub; 130 131 /** @has_alpha: Does the format embeds an alpha component? */ 132 bool has_alpha; 133 134 /** @is_yuv: Is it a YUV format? */ 135 bool is_yuv; 136 }; 137 138 /** 139 * drm_format_info_is_yuv_packed - check that the format info matches a YUV 140 * format with data laid in a single plane 141 * @info: format info 142 * 143 * Returns: 144 * A boolean indicating whether the format info matches a packed YUV format. 145 */ 146 static inline bool 147 drm_format_info_is_yuv_packed(const struct drm_format_info *info) 148 { 149 return info->is_yuv && info->num_planes == 1; 150 } 151 152 /** 153 * drm_format_info_is_yuv_semiplanar - check that the format info matches a YUV 154 * format with data laid in two planes (luminance and chrominance) 155 * @info: format info 156 * 157 * Returns: 158 * A boolean indicating whether the format info matches a semiplanar YUV format. 159 */ 160 static inline bool 161 drm_format_info_is_yuv_semiplanar(const struct drm_format_info *info) 162 { 163 return info->is_yuv && info->num_planes == 2; 164 } 165 166 /** 167 * drm_format_info_is_yuv_planar - check that the format info matches a YUV 168 * format with data laid in three planes (one for each YUV component) 169 * @info: format info 170 * 171 * Returns: 172 * A boolean indicating whether the format info matches a planar YUV format. 173 */ 174 static inline bool 175 drm_format_info_is_yuv_planar(const struct drm_format_info *info) 176 { 177 return info->is_yuv && info->num_planes == 3; 178 } 179 180 /** 181 * drm_format_info_is_yuv_sampling_410 - check that the format info matches a 182 * YUV format with 4:1:0 sub-sampling 183 * @info: format info 184 * 185 * Returns: 186 * A boolean indicating whether the format info matches a YUV format with 4:1:0 187 * sub-sampling. 188 */ 189 static inline bool 190 drm_format_info_is_yuv_sampling_410(const struct drm_format_info *info) 191 { 192 return info->is_yuv && info->hsub == 4 && info->vsub == 4; 193 } 194 195 /** 196 * drm_format_info_is_yuv_sampling_411 - check that the format info matches a 197 * YUV format with 4:1:1 sub-sampling 198 * @info: format info 199 * 200 * Returns: 201 * A boolean indicating whether the format info matches a YUV format with 4:1:1 202 * sub-sampling. 203 */ 204 static inline bool 205 drm_format_info_is_yuv_sampling_411(const struct drm_format_info *info) 206 { 207 return info->is_yuv && info->hsub == 4 && info->vsub == 1; 208 } 209 210 /** 211 * drm_format_info_is_yuv_sampling_420 - check that the format info matches a 212 * YUV format with 4:2:0 sub-sampling 213 * @info: format info 214 * 215 * Returns: 216 * A boolean indicating whether the format info matches a YUV format with 4:2:0 217 * sub-sampling. 218 */ 219 static inline bool 220 drm_format_info_is_yuv_sampling_420(const struct drm_format_info *info) 221 { 222 return info->is_yuv && info->hsub == 2 && info->vsub == 2; 223 } 224 225 /** 226 * drm_format_info_is_yuv_sampling_422 - check that the format info matches a 227 * YUV format with 4:2:2 sub-sampling 228 * @info: format info 229 * 230 * Returns: 231 * A boolean indicating whether the format info matches a YUV format with 4:2:2 232 * sub-sampling. 233 */ 234 static inline bool 235 drm_format_info_is_yuv_sampling_422(const struct drm_format_info *info) 236 { 237 return info->is_yuv && info->hsub == 2 && info->vsub == 1; 238 } 239 240 /** 241 * drm_format_info_is_yuv_sampling_444 - check that the format info matches a 242 * YUV format with 4:4:4 sub-sampling 243 * @info: format info 244 * 245 * Returns: 246 * A boolean indicating whether the format info matches a YUV format with 4:4:4 247 * sub-sampling. 248 */ 249 static inline bool 250 drm_format_info_is_yuv_sampling_444(const struct drm_format_info *info) 251 { 252 return info->is_yuv && info->hsub == 1 && info->vsub == 1; 253 } 254 255 /** 256 * drm_format_info_plane_width - width of the plane given the first plane 257 * @info: pixel format info 258 * @width: width of the first plane 259 * @plane: plane index 260 * 261 * Returns: 262 * The width of @plane, given that the width of the first plane is @width. 263 */ 264 static inline 265 int drm_format_info_plane_width(const struct drm_format_info *info, int width, 266 int plane) 267 { 268 if (!info || plane >= info->num_planes) 269 return 0; 270 271 if (plane == 0) 272 return width; 273 274 return width / info->hsub; 275 } 276 277 /** 278 * drm_format_info_plane_height - height of the plane given the first plane 279 * @info: pixel format info 280 * @height: height of the first plane 281 * @plane: plane index 282 * 283 * Returns: 284 * The height of @plane, given that the height of the first plane is @height. 285 */ 286 static inline 287 int drm_format_info_plane_height(const struct drm_format_info *info, int height, 288 int plane) 289 { 290 if (!info || plane >= info->num_planes) 291 return 0; 292 293 if (plane == 0) 294 return height; 295 296 return height / info->vsub; 297 } 298 299 const struct drm_format_info *__drm_format_info(u32 format); 300 const struct drm_format_info *drm_format_info(u32 format); 301 const struct drm_format_info * 302 drm_get_format_info(struct drm_device *dev, 303 const struct drm_mode_fb_cmd2 *mode_cmd); 304 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth); 305 uint32_t drm_driver_legacy_fb_format(struct drm_device *dev, 306 uint32_t bpp, uint32_t depth); 307 unsigned int drm_format_info_block_width(const struct drm_format_info *info, 308 int plane); 309 unsigned int drm_format_info_block_height(const struct drm_format_info *info, 310 int plane); 311 uint64_t drm_format_info_min_pitch(const struct drm_format_info *info, 312 int plane, unsigned int buffer_width); 313 314 #endif /* __DRM_FOURCC_H__ */ 315