1ae4df11aSLaurent Pinchart /* 2ae4df11aSLaurent Pinchart * Copyright (c) 2016 Laurent Pinchart <laurent.pinchart@ideasonboard.com> 3ae4df11aSLaurent Pinchart * 4ae4df11aSLaurent Pinchart * Permission to use, copy, modify, distribute, and sell this software and its 5ae4df11aSLaurent Pinchart * documentation for any purpose is hereby granted without fee, provided that 6ae4df11aSLaurent Pinchart * the above copyright notice appear in all copies and that both that copyright 7ae4df11aSLaurent Pinchart * notice and this permission notice appear in supporting documentation, and 8ae4df11aSLaurent Pinchart * that the name of the copyright holders not be used in advertising or 9ae4df11aSLaurent Pinchart * publicity pertaining to distribution of the software without specific, 10ae4df11aSLaurent Pinchart * written prior permission. The copyright holders make no representations 11ae4df11aSLaurent Pinchart * about the suitability of this software for any purpose. It is provided "as 12ae4df11aSLaurent Pinchart * is" without express or implied warranty. 13ae4df11aSLaurent Pinchart * 14ae4df11aSLaurent Pinchart * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 15ae4df11aSLaurent Pinchart * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO 16ae4df11aSLaurent Pinchart * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR 17ae4df11aSLaurent Pinchart * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, 18ae4df11aSLaurent Pinchart * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 19ae4df11aSLaurent Pinchart * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 20ae4df11aSLaurent Pinchart * OF THIS SOFTWARE. 21ae4df11aSLaurent Pinchart */ 22ae4df11aSLaurent Pinchart #ifndef __DRM_FOURCC_H__ 23ae4df11aSLaurent Pinchart #define __DRM_FOURCC_H__ 24ae4df11aSLaurent Pinchart 25ae4df11aSLaurent Pinchart #include <linux/types.h> 26ae4df11aSLaurent Pinchart #include <uapi/drm/drm_fourcc.h> 27ae4df11aSLaurent Pinchart 28ec2fae25SGerd Hoffmann /* 29ec2fae25SGerd Hoffmann * DRM formats are little endian. Define host endian variants for the 30ec2fae25SGerd Hoffmann * most common formats here, to reduce the #ifdefs needed in drivers. 31ec2fae25SGerd Hoffmann * 32ec2fae25SGerd Hoffmann * Note that the DRM_FORMAT_BIG_ENDIAN flag should only be used in 33ec2fae25SGerd Hoffmann * case the format can't be specified otherwise, so we don't end up 34ec2fae25SGerd Hoffmann * with two values describing the same format. 35ec2fae25SGerd Hoffmann */ 36ec2fae25SGerd Hoffmann #ifdef __BIG_ENDIAN 37ec2fae25SGerd Hoffmann # define DRM_FORMAT_HOST_XRGB1555 (DRM_FORMAT_XRGB1555 | \ 38ec2fae25SGerd Hoffmann DRM_FORMAT_BIG_ENDIAN) 39ec2fae25SGerd Hoffmann # define DRM_FORMAT_HOST_RGB565 (DRM_FORMAT_RGB565 | \ 40ec2fae25SGerd Hoffmann DRM_FORMAT_BIG_ENDIAN) 41ec2fae25SGerd Hoffmann # define DRM_FORMAT_HOST_XRGB8888 DRM_FORMAT_BGRX8888 42ec2fae25SGerd Hoffmann # define DRM_FORMAT_HOST_ARGB8888 DRM_FORMAT_BGRA8888 43ec2fae25SGerd Hoffmann #else 44ec2fae25SGerd Hoffmann # define DRM_FORMAT_HOST_XRGB1555 DRM_FORMAT_XRGB1555 45ec2fae25SGerd Hoffmann # define DRM_FORMAT_HOST_RGB565 DRM_FORMAT_RGB565 46ec2fae25SGerd Hoffmann # define DRM_FORMAT_HOST_XRGB8888 DRM_FORMAT_XRGB8888 47ec2fae25SGerd Hoffmann # define DRM_FORMAT_HOST_ARGB8888 DRM_FORMAT_ARGB8888 48ec2fae25SGerd Hoffmann #endif 49ec2fae25SGerd Hoffmann 506a0f9ebfSVille Syrjälä struct drm_device; 516a0f9ebfSVille Syrjälä struct drm_mode_fb_cmd2; 526a0f9ebfSVille Syrjälä 5384770cc2SLaurent Pinchart /** 5484770cc2SLaurent Pinchart * struct drm_format_info - information about a DRM format 5584770cc2SLaurent Pinchart */ 5684770cc2SLaurent Pinchart struct drm_format_info { 579c71a668SAlexandru Gheorghe /** @format: 4CC format identifier (DRM_FORMAT_*) */ 5884770cc2SLaurent Pinchart u32 format; 599c71a668SAlexandru Gheorghe 609c71a668SAlexandru Gheorghe /** 619c71a668SAlexandru Gheorghe * @depth: 629c71a668SAlexandru Gheorghe * 639c71a668SAlexandru Gheorghe * Color depth (number of bits per pixel excluding padding bits), 649c71a668SAlexandru Gheorghe * valid for a subset of RGB formats only. This is a legacy field, do 659c71a668SAlexandru Gheorghe * not use in new code and set to 0 for new formats. 669c71a668SAlexandru Gheorghe */ 6784770cc2SLaurent Pinchart u8 depth; 689c71a668SAlexandru Gheorghe 699c71a668SAlexandru Gheorghe /** @num_planes: Number of color planes (1 to 3) */ 7084770cc2SLaurent Pinchart u8 num_planes; 719c71a668SAlexandru Gheorghe 72042bf753SAlexandru Gheorghe union { 73042bf753SAlexandru Gheorghe /** 74042bf753SAlexandru Gheorghe * @cpp: 75042bf753SAlexandru Gheorghe * 76042bf753SAlexandru Gheorghe * Number of bytes per pixel (per plane), this is aliased with 77042bf753SAlexandru Gheorghe * @char_per_block. It is deprecated in favour of using the 78042bf753SAlexandru Gheorghe * triplet @char_per_block, @block_w, @block_h for better 79042bf753SAlexandru Gheorghe * describing the pixel format. 80042bf753SAlexandru Gheorghe */ 8184770cc2SLaurent Pinchart u8 cpp[3]; 829c71a668SAlexandru Gheorghe 83042bf753SAlexandru Gheorghe /** 84042bf753SAlexandru Gheorghe * @char_per_block: 85042bf753SAlexandru Gheorghe * 86042bf753SAlexandru Gheorghe * Number of bytes per block (per plane), where blocks are 87042bf753SAlexandru Gheorghe * defined as a rectangle of pixels which are stored next to 88042bf753SAlexandru Gheorghe * each other in a byte aligned memory region. Together with 89042bf753SAlexandru Gheorghe * @block_w and @block_h this is used to properly describe tiles 90042bf753SAlexandru Gheorghe * in tiled formats or to describe groups of pixels in packed 91042bf753SAlexandru Gheorghe * formats for which the memory needed for a single pixel is not 92042bf753SAlexandru Gheorghe * byte aligned. 93042bf753SAlexandru Gheorghe * 94042bf753SAlexandru Gheorghe * @cpp has been kept for historical reasons because there are 95042bf753SAlexandru Gheorghe * a lot of places in drivers where it's used. In drm core for 96042bf753SAlexandru Gheorghe * generic code paths the preferred way is to use 97042bf753SAlexandru Gheorghe * @char_per_block, drm_format_info_block_width() and 98042bf753SAlexandru Gheorghe * drm_format_info_block_height() which allows handling both 99042bf753SAlexandru Gheorghe * block and non-block formats in the same way. 100042bf753SAlexandru Gheorghe * 101042bf753SAlexandru Gheorghe * For formats that are intended to be used only with non-linear 102042bf753SAlexandru Gheorghe * modifiers both @cpp and @char_per_block must be 0 in the 103042bf753SAlexandru Gheorghe * generic format table. Drivers could supply accurate 104042bf753SAlexandru Gheorghe * information from their drm_mode_config.get_format_info hook 105042bf753SAlexandru Gheorghe * if they want the core to be validating the pitch. 106042bf753SAlexandru Gheorghe */ 107042bf753SAlexandru Gheorghe u8 char_per_block[3]; 108042bf753SAlexandru Gheorghe }; 109042bf753SAlexandru Gheorghe 110042bf753SAlexandru Gheorghe /** 111042bf753SAlexandru Gheorghe * @block_w: 112042bf753SAlexandru Gheorghe * 113042bf753SAlexandru Gheorghe * Block width in pixels, this is intended to be accessed through 114042bf753SAlexandru Gheorghe * drm_format_info_block_width() 115042bf753SAlexandru Gheorghe */ 116042bf753SAlexandru Gheorghe u8 block_w[3]; 117042bf753SAlexandru Gheorghe 118042bf753SAlexandru Gheorghe /** 119042bf753SAlexandru Gheorghe * @block_h: 120042bf753SAlexandru Gheorghe * 121042bf753SAlexandru Gheorghe * Block height in pixels, this is intended to be accessed through 122042bf753SAlexandru Gheorghe * drm_format_info_block_height() 123042bf753SAlexandru Gheorghe */ 124042bf753SAlexandru Gheorghe u8 block_h[3]; 125042bf753SAlexandru Gheorghe 1269c71a668SAlexandru Gheorghe /** @hsub: Horizontal chroma subsampling factor */ 12784770cc2SLaurent Pinchart u8 hsub; 1289c71a668SAlexandru Gheorghe /** @vsub: Vertical chroma subsampling factor */ 12984770cc2SLaurent Pinchart u8 vsub; 1309c71a668SAlexandru Gheorghe 1319c71a668SAlexandru Gheorghe /** @has_alpha: Does the format embeds an alpha component? */ 1324cc4e1b4SMaxime Ripard bool has_alpha; 1339c71a668SAlexandru Gheorghe 1349c71a668SAlexandru Gheorghe /** @is_yuv: Is it a YUV format? */ 135ce2d5461SAyan Kumar Halder bool is_yuv; 13684770cc2SLaurent Pinchart }; 13784770cc2SLaurent Pinchart 138b3c11ac2SEric Engestrom /** 139b3c11ac2SEric Engestrom * struct drm_format_name_buf - name of a DRM format 140b3c11ac2SEric Engestrom * @str: string buffer containing the format name 141b3c11ac2SEric Engestrom */ 142b3c11ac2SEric Engestrom struct drm_format_name_buf { 143b3c11ac2SEric Engestrom char str[32]; 144b3c11ac2SEric Engestrom }; 145b3c11ac2SEric Engestrom 14641c8c210SPaul Kocialkowski /** 14741c8c210SPaul Kocialkowski * drm_format_info_is_yuv_packed - check that the format info matches a YUV 14841c8c210SPaul Kocialkowski * format with data laid in a single plane 14941c8c210SPaul Kocialkowski * @info: format info 15041c8c210SPaul Kocialkowski * 15141c8c210SPaul Kocialkowski * Returns: 15241c8c210SPaul Kocialkowski * A boolean indicating whether the format info matches a packed YUV format. 15341c8c210SPaul Kocialkowski */ 15441c8c210SPaul Kocialkowski static inline bool 15541c8c210SPaul Kocialkowski drm_format_info_is_yuv_packed(const struct drm_format_info *info) 15641c8c210SPaul Kocialkowski { 15741c8c210SPaul Kocialkowski return info->is_yuv && info->num_planes == 1; 15841c8c210SPaul Kocialkowski } 15941c8c210SPaul Kocialkowski 16041c8c210SPaul Kocialkowski /** 16141c8c210SPaul Kocialkowski * drm_format_info_is_yuv_semiplanar - check that the format info matches a YUV 16241c8c210SPaul Kocialkowski * format with data laid in two planes (luminance and chrominance) 16341c8c210SPaul Kocialkowski * @info: format info 16441c8c210SPaul Kocialkowski * 16541c8c210SPaul Kocialkowski * Returns: 16641c8c210SPaul Kocialkowski * A boolean indicating whether the format info matches a semiplanar YUV format. 16741c8c210SPaul Kocialkowski */ 16841c8c210SPaul Kocialkowski static inline bool 16941c8c210SPaul Kocialkowski drm_format_info_is_yuv_semiplanar(const struct drm_format_info *info) 17041c8c210SPaul Kocialkowski { 17141c8c210SPaul Kocialkowski return info->is_yuv && info->num_planes == 2; 17241c8c210SPaul Kocialkowski } 17341c8c210SPaul Kocialkowski 17441c8c210SPaul Kocialkowski /** 17541c8c210SPaul Kocialkowski * drm_format_info_is_yuv_planar - check that the format info matches a YUV 17641c8c210SPaul Kocialkowski * format with data laid in three planes (one for each YUV component) 17741c8c210SPaul Kocialkowski * @info: format info 17841c8c210SPaul Kocialkowski * 17941c8c210SPaul Kocialkowski * Returns: 18041c8c210SPaul Kocialkowski * A boolean indicating whether the format info matches a planar YUV format. 18141c8c210SPaul Kocialkowski */ 18241c8c210SPaul Kocialkowski static inline bool 18341c8c210SPaul Kocialkowski drm_format_info_is_yuv_planar(const struct drm_format_info *info) 18441c8c210SPaul Kocialkowski { 18541c8c210SPaul Kocialkowski return info->is_yuv && info->num_planes == 3; 18641c8c210SPaul Kocialkowski } 18741c8c210SPaul Kocialkowski 188a211e56eSPaul Kocialkowski /** 189a211e56eSPaul Kocialkowski * drm_format_info_is_yuv_sampling_410 - check that the format info matches a 190a211e56eSPaul Kocialkowski * YUV format with 4:1:0 sub-sampling 191a211e56eSPaul Kocialkowski * @info: format info 192a211e56eSPaul Kocialkowski * 193a211e56eSPaul Kocialkowski * Returns: 194a211e56eSPaul Kocialkowski * A boolean indicating whether the format info matches a YUV format with 4:1:0 195a211e56eSPaul Kocialkowski * sub-sampling. 196a211e56eSPaul Kocialkowski */ 197a211e56eSPaul Kocialkowski static inline bool 198a211e56eSPaul Kocialkowski drm_format_info_is_yuv_sampling_410(const struct drm_format_info *info) 199a211e56eSPaul Kocialkowski { 200a211e56eSPaul Kocialkowski return info->is_yuv && info->hsub == 4 && info->vsub == 4; 201a211e56eSPaul Kocialkowski } 202a211e56eSPaul Kocialkowski 203a211e56eSPaul Kocialkowski /** 204a211e56eSPaul Kocialkowski * drm_format_info_is_yuv_sampling_411 - check that the format info matches a 205a211e56eSPaul Kocialkowski * YUV format with 4:1:1 sub-sampling 206a211e56eSPaul Kocialkowski * @info: format info 207a211e56eSPaul Kocialkowski * 208a211e56eSPaul Kocialkowski * Returns: 209a211e56eSPaul Kocialkowski * A boolean indicating whether the format info matches a YUV format with 4:1:1 210a211e56eSPaul Kocialkowski * sub-sampling. 211a211e56eSPaul Kocialkowski */ 212a211e56eSPaul Kocialkowski static inline bool 213a211e56eSPaul Kocialkowski drm_format_info_is_yuv_sampling_411(const struct drm_format_info *info) 214a211e56eSPaul Kocialkowski { 215a211e56eSPaul Kocialkowski return info->is_yuv && info->hsub == 4 && info->vsub == 1; 216a211e56eSPaul Kocialkowski } 217a211e56eSPaul Kocialkowski 218a211e56eSPaul Kocialkowski /** 219a211e56eSPaul Kocialkowski * drm_format_info_is_yuv_sampling_420 - check that the format info matches a 220a211e56eSPaul Kocialkowski * YUV format with 4:2:0 sub-sampling 221a211e56eSPaul Kocialkowski * @info: format info 222a211e56eSPaul Kocialkowski * 223a211e56eSPaul Kocialkowski * Returns: 224a211e56eSPaul Kocialkowski * A boolean indicating whether the format info matches a YUV format with 4:2:0 225a211e56eSPaul Kocialkowski * sub-sampling. 226a211e56eSPaul Kocialkowski */ 227a211e56eSPaul Kocialkowski static inline bool 228a211e56eSPaul Kocialkowski drm_format_info_is_yuv_sampling_420(const struct drm_format_info *info) 229a211e56eSPaul Kocialkowski { 230a211e56eSPaul Kocialkowski return info->is_yuv && info->hsub == 2 && info->vsub == 2; 231a211e56eSPaul Kocialkowski } 232a211e56eSPaul Kocialkowski 233a211e56eSPaul Kocialkowski /** 234a211e56eSPaul Kocialkowski * drm_format_info_is_yuv_sampling_422 - check that the format info matches a 235a211e56eSPaul Kocialkowski * YUV format with 4:2:2 sub-sampling 236a211e56eSPaul Kocialkowski * @info: format info 237a211e56eSPaul Kocialkowski * 238a211e56eSPaul Kocialkowski * Returns: 239a211e56eSPaul Kocialkowski * A boolean indicating whether the format info matches a YUV format with 4:2:2 240a211e56eSPaul Kocialkowski * sub-sampling. 241a211e56eSPaul Kocialkowski */ 242a211e56eSPaul Kocialkowski static inline bool 243a211e56eSPaul Kocialkowski drm_format_info_is_yuv_sampling_422(const struct drm_format_info *info) 244a211e56eSPaul Kocialkowski { 245a211e56eSPaul Kocialkowski return info->is_yuv && info->hsub == 2 && info->vsub == 1; 246a211e56eSPaul Kocialkowski } 247a211e56eSPaul Kocialkowski 248a211e56eSPaul Kocialkowski /** 249a211e56eSPaul Kocialkowski * drm_format_info_is_yuv_sampling_444 - check that the format info matches a 250a211e56eSPaul Kocialkowski * YUV format with 4:4:4 sub-sampling 251a211e56eSPaul Kocialkowski * @info: format info 252a211e56eSPaul Kocialkowski * 253a211e56eSPaul Kocialkowski * Returns: 254a211e56eSPaul Kocialkowski * A boolean indicating whether the format info matches a YUV format with 4:4:4 255a211e56eSPaul Kocialkowski * sub-sampling. 256a211e56eSPaul Kocialkowski */ 257a211e56eSPaul Kocialkowski static inline bool 258a211e56eSPaul Kocialkowski drm_format_info_is_yuv_sampling_444(const struct drm_format_info *info) 259a211e56eSPaul Kocialkowski { 260a211e56eSPaul Kocialkowski return info->is_yuv && info->hsub == 1 && info->vsub == 1; 261a211e56eSPaul Kocialkowski } 262a211e56eSPaul Kocialkowski 26324c478eaSMaxime Ripard /** 26424c478eaSMaxime Ripard * drm_format_info_plane_cpp - determine the bytes per pixel value 26524c478eaSMaxime Ripard * @format: pixel format info 26624c478eaSMaxime Ripard * @plane: plane index 26724c478eaSMaxime Ripard * 26824c478eaSMaxime Ripard * Returns: 26924c478eaSMaxime Ripard * The bytes per pixel value for the specified plane. 27024c478eaSMaxime Ripard */ 27124c478eaSMaxime Ripard static inline 27224c478eaSMaxime Ripard int drm_format_info_plane_cpp(const struct drm_format_info *info, int plane) 27324c478eaSMaxime Ripard { 27424c478eaSMaxime Ripard if (!info || plane >= info->num_planes) 27524c478eaSMaxime Ripard return 0; 27624c478eaSMaxime Ripard 27724c478eaSMaxime Ripard return info->cpp[plane]; 27824c478eaSMaxime Ripard } 27924c478eaSMaxime Ripard 280bf39607cSMaxime Ripard /** 281bf39607cSMaxime Ripard * drm_format_info_plane_width - width of the plane given the first plane 282bf39607cSMaxime Ripard * @format: pixel format info 283bf39607cSMaxime Ripard * @width: width of the first plane 284bf39607cSMaxime Ripard * @plane: plane index 285bf39607cSMaxime Ripard * 286bf39607cSMaxime Ripard * Returns: 287bf39607cSMaxime Ripard * The width of @plane, given that the width of the first plane is @width. 288bf39607cSMaxime Ripard */ 289bf39607cSMaxime Ripard static inline 290bf39607cSMaxime Ripard int drm_format_info_plane_width(const struct drm_format_info *info, int width, 291bf39607cSMaxime Ripard int plane) 292bf39607cSMaxime Ripard { 293bf39607cSMaxime Ripard if (!info || plane >= info->num_planes) 294bf39607cSMaxime Ripard return 0; 295bf39607cSMaxime Ripard 296bf39607cSMaxime Ripard if (plane == 0) 297bf39607cSMaxime Ripard return width; 298bf39607cSMaxime Ripard 299bf39607cSMaxime Ripard return width / info->hsub; 300bf39607cSMaxime Ripard } 301bf39607cSMaxime Ripard 302bf39607cSMaxime Ripard /** 303bf39607cSMaxime Ripard * drm_format_info_plane_height - height of the plane given the first plane 304bf39607cSMaxime Ripard * @format: pixel format info 305bf39607cSMaxime Ripard * @height: height of the first plane 306bf39607cSMaxime Ripard * @plane: plane index 307bf39607cSMaxime Ripard * 308bf39607cSMaxime Ripard * Returns: 309bf39607cSMaxime Ripard * The height of @plane, given that the height of the first plane is @height. 310bf39607cSMaxime Ripard */ 311bf39607cSMaxime Ripard static inline 312bf39607cSMaxime Ripard int drm_format_info_plane_height(const struct drm_format_info *info, int height, 313bf39607cSMaxime Ripard int plane) 314bf39607cSMaxime Ripard { 315bf39607cSMaxime Ripard if (!info || plane >= info->num_planes) 316bf39607cSMaxime Ripard return 0; 317bf39607cSMaxime Ripard 318bf39607cSMaxime Ripard if (plane == 0) 319bf39607cSMaxime Ripard return height; 320bf39607cSMaxime Ripard 321bf39607cSMaxime Ripard return height / info->vsub; 322bf39607cSMaxime Ripard } 323bf39607cSMaxime Ripard 324333d2da5SLaurent Pinchart const struct drm_format_info *__drm_format_info(u32 format); 32584770cc2SLaurent Pinchart const struct drm_format_info *drm_format_info(u32 format); 3266a0f9ebfSVille Syrjälä const struct drm_format_info * 3276a0f9ebfSVille Syrjälä drm_get_format_info(struct drm_device *dev, 3286a0f9ebfSVille Syrjälä const struct drm_mode_fb_cmd2 *mode_cmd); 329ec5e3047SDaniel Vetter uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth); 330059b5eb5SGerd Hoffmann uint32_t drm_driver_legacy_fb_format(struct drm_device *dev, 331059b5eb5SGerd Hoffmann uint32_t bpp, uint32_t depth); 332042bf753SAlexandru Gheorghe unsigned int drm_format_info_block_width(const struct drm_format_info *info, 333042bf753SAlexandru Gheorghe int plane); 334042bf753SAlexandru Gheorghe unsigned int drm_format_info_block_height(const struct drm_format_info *info, 335042bf753SAlexandru Gheorghe int plane); 336042bf753SAlexandru Gheorghe uint64_t drm_format_info_min_pitch(const struct drm_format_info *info, 337042bf753SAlexandru Gheorghe int plane, unsigned int buffer_width); 338b3c11ac2SEric Engestrom const char *drm_get_format_name(uint32_t format, struct drm_format_name_buf *buf); 339ae4df11aSLaurent Pinchart 340ae4df11aSLaurent Pinchart #endif /* __DRM_FOURCC_H__ */ 341