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 /** @cpp: Number of bytes per pixel (per plane) */ 73 u8 cpp[3]; 74 75 /** @hsub: Horizontal chroma subsampling factor */ 76 u8 hsub; 77 /** @vsub: Vertical chroma subsampling factor */ 78 u8 vsub; 79 80 /** @has_alpha: Does the format embeds an alpha component? */ 81 bool has_alpha; 82 83 /** @is_yuv: Is it a YUV format? */ 84 bool is_yuv; 85 }; 86 87 /** 88 * struct drm_format_name_buf - name of a DRM format 89 * @str: string buffer containing the format name 90 */ 91 struct drm_format_name_buf { 92 char str[32]; 93 }; 94 95 const struct drm_format_info *__drm_format_info(u32 format); 96 const struct drm_format_info *drm_format_info(u32 format); 97 const struct drm_format_info * 98 drm_get_format_info(struct drm_device *dev, 99 const struct drm_mode_fb_cmd2 *mode_cmd); 100 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth); 101 uint32_t drm_driver_legacy_fb_format(struct drm_device *dev, 102 uint32_t bpp, uint32_t depth); 103 int drm_format_num_planes(uint32_t format); 104 int drm_format_plane_cpp(uint32_t format, int plane); 105 int drm_format_horz_chroma_subsampling(uint32_t format); 106 int drm_format_vert_chroma_subsampling(uint32_t format); 107 int drm_format_plane_width(int width, uint32_t format, int plane); 108 int drm_format_plane_height(int height, uint32_t format, int plane); 109 const char *drm_get_format_name(uint32_t format, struct drm_format_name_buf *buf); 110 111 #endif /* __DRM_FOURCC_H__ */ 112