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_FORMAT_MAX_PLANES - maximum number of planes a DRM format can have 30 */ 31#define DRM_FORMAT_MAX_PLANES 4u 32 33/* 34 * DRM formats are little endian. Define host endian variants for the 35 * most common formats here, to reduce the #ifdefs needed in drivers. 36 * 37 * Note that the DRM_FORMAT_BIG_ENDIAN flag should only be used in 38 * case the format can't be specified otherwise, so we don't end up 39 * with two values describing the same format. 40 */ 41#ifdef __BIG_ENDIAN 42# define DRM_FORMAT_HOST_XRGB1555 (DRM_FORMAT_XRGB1555 | \ 43 DRM_FORMAT_BIG_ENDIAN) 44# define DRM_FORMAT_HOST_RGB565 (DRM_FORMAT_RGB565 | \ 45 DRM_FORMAT_BIG_ENDIAN) 46# define DRM_FORMAT_HOST_XRGB8888 DRM_FORMAT_BGRX8888 47# define DRM_FORMAT_HOST_ARGB8888 DRM_FORMAT_BGRA8888 48#else 49# define DRM_FORMAT_HOST_XRGB1555 DRM_FORMAT_XRGB1555 50# define DRM_FORMAT_HOST_RGB565 DRM_FORMAT_RGB565 51# define DRM_FORMAT_HOST_XRGB8888 DRM_FORMAT_XRGB8888 52# define DRM_FORMAT_HOST_ARGB8888 DRM_FORMAT_ARGB8888 53#endif 54 55struct drm_device; 56struct drm_mode_fb_cmd2; 57 58/** 59 * struct drm_format_info - information about a DRM format 60 */ 61struct drm_format_info { 62 /** @format: 4CC format identifier (DRM_FORMAT_*) */ 63 u32 format; 64 65 /** 66 * @depth: 67 * 68 * Color depth (number of bits per pixel excluding padding bits), 69 * valid for a subset of RGB formats only. This is a legacy field, do 70 * not use in new code and set to 0 for new formats. 71 */ 72 u8 depth; 73 74 /** @num_planes: Number of color planes (1 to 3) */ 75 u8 num_planes; 76 77 union { 78 /** 79 * @cpp: 80 * 81 * Number of bytes per pixel (per plane), this is aliased with 82 * @char_per_block. It is deprecated in favour of using the 83 * triplet @char_per_block, @block_w, @block_h for better 84 * describing the pixel format. 85 */ 86 u8 cpp[DRM_FORMAT_MAX_PLANES]; 87 88 /** 89 * @char_per_block: 90 * 91 * Number of bytes per block (per plane), where blocks are 92 * defined as a rectangle of pixels which are stored next to 93 * each other in a byte aligned memory region. Together with 94 * @block_w and @block_h this is used to properly describe tiles 95 * in tiled formats or to describe groups of pixels in packed 96 * formats for which the memory needed for a single pixel is not 97 * byte aligned. 98 * 99 * @cpp has been kept for historical reasons because there are 100 * a lot of places in drivers where it's used. In drm core for 101 * generic code paths the preferred way is to use 102 * @char_per_block, drm_format_info_block_width() and 103 * drm_format_info_block_height() which allows handling both 104 * block and non-block formats in the same way. 105 * 106 * For formats that are intended to be used only with non-linear 107 * modifiers both @cpp and @char_per_block must be 0 in the 108 * generic format table. Drivers could supply accurate 109 * information from their drm_mode_config.get_format_info hook 110 * if they want the core to be validating the pitch. 111 */ 112 u8 char_per_block[DRM_FORMAT_MAX_PLANES]; 113 }; 114 115 /** 116 * @block_w: 117 * 118 * Block width in pixels, this is intended to be accessed through 119 * drm_format_info_block_width() 120 */ 121 u8 block_w[DRM_FORMAT_MAX_PLANES]; 122 123 /** 124 * @block_h: 125 * 126 * Block height in pixels, this is intended to be accessed through 127 * drm_format_info_block_height() 128 */ 129 u8 block_h[DRM_FORMAT_MAX_PLANES]; 130 131 /** 132 * @pixels_per_macropixel: 133 * Number of pixels per macro-pixel (per plane). A macro-pixel is 134 * composed of multiple pixels, and there can be extra bits between 135 * pixels. This must be used along with @bytes_per_macropixel, only 136 * when single pixel size is not byte-aligned. In this case, @cpp 137 * is not valid and should be 0. 138 */ 139 u8 pixels_per_macropixel[3]; 140 141 /** 142 * @bytes_per_macropixel: 143 * Number of bytes per macro-pixel (per plane). A macro-pixel is 144 * composed of multiple pixels. The size of single macro-pixel should 145 * be byte-aligned. This should be used with @pixels_per_macropixel, 146 * and @cpp should be 0. 147 */ 148 u8 bytes_per_macropixel[3]; 149 150 /** @hsub: Horizontal chroma subsampling factor */ 151 u8 hsub; 152 /** @vsub: Vertical chroma subsampling factor */ 153 u8 vsub; 154 155 /** @has_alpha: Does the format embeds an alpha component? */ 156 bool has_alpha; 157 158 /** @is_yuv: Is it a YUV format? */ 159 bool is_yuv; 160}; 161 162/** 163 * drm_format_info_is_yuv_packed - check that the format info matches a YUV 164 * format with data laid in a single plane 165 * @info: format info 166 * 167 * Returns: 168 * A boolean indicating whether the format info matches a packed YUV format. 169 */ 170static inline bool 171drm_format_info_is_yuv_packed(const struct drm_format_info *info) 172{ 173 return info->is_yuv && info->num_planes == 1; 174} 175 176/** 177 * drm_format_info_is_yuv_semiplanar - check that the format info matches a YUV 178 * format with data laid in two planes (luminance and chrominance) 179 * @info: format info 180 * 181 * Returns: 182 * A boolean indicating whether the format info matches a semiplanar YUV format. 183 */ 184static inline bool 185drm_format_info_is_yuv_semiplanar(const struct drm_format_info *info) 186{ 187 return info->is_yuv && info->num_planes == 2; 188} 189 190/** 191 * drm_format_info_is_yuv_planar - check that the format info matches a YUV 192 * format with data laid in three planes (one for each YUV component) 193 * @info: format info 194 * 195 * Returns: 196 * A boolean indicating whether the format info matches a planar YUV format. 197 */ 198static inline bool 199drm_format_info_is_yuv_planar(const struct drm_format_info *info) 200{ 201 return info->is_yuv && info->num_planes == 3; 202} 203 204/** 205 * drm_format_info_is_yuv_sampling_410 - check that the format info matches a 206 * YUV format with 4:1:0 sub-sampling 207 * @info: format info 208 * 209 * Returns: 210 * A boolean indicating whether the format info matches a YUV format with 4:1:0 211 * sub-sampling. 212 */ 213static inline bool 214drm_format_info_is_yuv_sampling_410(const struct drm_format_info *info) 215{ 216 return info->is_yuv && info->hsub == 4 && info->vsub == 4; 217} 218 219/** 220 * drm_format_info_is_yuv_sampling_411 - check that the format info matches a 221 * YUV format with 4:1:1 sub-sampling 222 * @info: format info 223 * 224 * Returns: 225 * A boolean indicating whether the format info matches a YUV format with 4:1:1 226 * sub-sampling. 227 */ 228static inline bool 229drm_format_info_is_yuv_sampling_411(const struct drm_format_info *info) 230{ 231 return info->is_yuv && info->hsub == 4 && info->vsub == 1; 232} 233 234/** 235 * drm_format_info_is_yuv_sampling_420 - check that the format info matches a 236 * YUV format with 4:2:0 sub-sampling 237 * @info: format info 238 * 239 * Returns: 240 * A boolean indicating whether the format info matches a YUV format with 4:2:0 241 * sub-sampling. 242 */ 243static inline bool 244drm_format_info_is_yuv_sampling_420(const struct drm_format_info *info) 245{ 246 return info->is_yuv && info->hsub == 2 && info->vsub == 2; 247} 248 249/** 250 * drm_format_info_is_yuv_sampling_422 - check that the format info matches a 251 * YUV format with 4:2:2 sub-sampling 252 * @info: format info 253 * 254 * Returns: 255 * A boolean indicating whether the format info matches a YUV format with 4:2:2 256 * sub-sampling. 257 */ 258static inline bool 259drm_format_info_is_yuv_sampling_422(const struct drm_format_info *info) 260{ 261 return info->is_yuv && info->hsub == 2 && info->vsub == 1; 262} 263 264/** 265 * drm_format_info_is_yuv_sampling_444 - check that the format info matches a 266 * YUV format with 4:4:4 sub-sampling 267 * @info: format info 268 * 269 * Returns: 270 * A boolean indicating whether the format info matches a YUV format with 4:4:4 271 * sub-sampling. 272 */ 273static inline bool 274drm_format_info_is_yuv_sampling_444(const struct drm_format_info *info) 275{ 276 return info->is_yuv && info->hsub == 1 && info->vsub == 1; 277} 278 279/** 280 * drm_format_info_plane_width - width of the plane given the first plane 281 * @info: pixel format info 282 * @width: width of the first plane 283 * @plane: plane index 284 * 285 * Returns: 286 * The width of @plane, given that the width of the first plane is @width. 287 */ 288static inline 289int drm_format_info_plane_width(const struct drm_format_info *info, int width, 290 int plane) 291{ 292 if (!info || plane >= info->num_planes) 293 return 0; 294 295 if (plane == 0) 296 return width; 297 298 return width / info->hsub; 299} 300 301/** 302 * drm_format_info_plane_height - height of the plane given the first plane 303 * @info: pixel format info 304 * @height: height of the first plane 305 * @plane: plane index 306 * 307 * Returns: 308 * The height of @plane, given that the height of the first plane is @height. 309 */ 310static inline 311int drm_format_info_plane_height(const struct drm_format_info *info, int height, 312 int plane) 313{ 314 if (!info || plane >= info->num_planes) 315 return 0; 316 317 if (plane == 0) 318 return height; 319 320 return height / info->vsub; 321} 322 323const struct drm_format_info *__drm_format_info(u32 format); 324const struct drm_format_info *drm_format_info(u32 format); 325const struct drm_format_info * 326drm_get_format_info(struct drm_device *dev, 327 const struct drm_mode_fb_cmd2 *mode_cmd); 328uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth); 329uint32_t drm_driver_legacy_fb_format(struct drm_device *dev, 330 uint32_t bpp, uint32_t depth); 331unsigned int drm_format_info_block_width(const struct drm_format_info *info, 332 int plane); 333unsigned int drm_format_info_block_height(const struct drm_format_info *info, 334 int plane); 335uint64_t drm_format_info_min_pitch(const struct drm_format_info *info, 336 int plane, unsigned int buffer_width); 337uint64_t drm_format_plane_width_bytes(const struct drm_format_info *info, 338 int plane, unsigned int width); 339 340#endif /* __DRM_FOURCC_H__ */ 341