~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/drm/drm_fourcc.h

Version: ~ [ linux-6.1-rc7 ] ~ [ linux-6.0.10 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.80 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.156 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.225 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.267 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.300 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.334 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.302 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.9 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  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[3];
 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[3];
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[3];
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[3];
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  * struct drm_format_name_buf - name of a DRM format
140  * @str: string buffer containing the format name
141  */
142 struct drm_format_name_buf {
143         char str[32];
144 };
145 
146 const struct drm_format_info *__drm_format_info(u32 format);
147 const struct drm_format_info *drm_format_info(u32 format);
148 const struct drm_format_info *
149 drm_get_format_info(struct drm_device *dev,
150                     const struct drm_mode_fb_cmd2 *mode_cmd);
151 uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
152 uint32_t drm_driver_legacy_fb_format(struct drm_device *dev,
153                                      uint32_t bpp, uint32_t depth);
154 int drm_format_num_planes(uint32_t format);
155 int drm_format_plane_cpp(uint32_t format, int plane);
156 int drm_format_horz_chroma_subsampling(uint32_t format);
157 int drm_format_vert_chroma_subsampling(uint32_t format);
158 int drm_format_plane_width(int width, uint32_t format, int plane);
159 int drm_format_plane_height(int height, uint32_t format, int plane);
160 unsigned int drm_format_info_block_width(const struct drm_format_info *info,
161                                          int plane);
162 unsigned int drm_format_info_block_height(const struct drm_format_info *info,
163                                           int plane);
164 uint64_t drm_format_info_min_pitch(const struct drm_format_info *info,
165                                    int plane, unsigned int buffer_width);
166 const char *drm_get_format_name(uint32_t format, struct drm_format_name_buf *buf);
167 
168 #endif /* __DRM_FOURCC_H__ */
169 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp