drm_fourcc.h 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  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. #include <linux/types.h>
  25. #include <uapi/drm/drm_fourcc.h>
  26. /*
  27. * DRM formats are little endian. Define host endian variants for the
  28. * most common formats here, to reduce the #ifdefs needed in drivers.
  29. *
  30. * Note that the DRM_FORMAT_BIG_ENDIAN flag should only be used in
  31. * case the format can't be specified otherwise, so we don't end up
  32. * with two values describing the same format.
  33. */
  34. #ifdef __BIG_ENDIAN
  35. # define DRM_FORMAT_HOST_XRGB1555 (DRM_FORMAT_XRGB1555 | \
  36. DRM_FORMAT_BIG_ENDIAN)
  37. # define DRM_FORMAT_HOST_RGB565 (DRM_FORMAT_RGB565 | \
  38. DRM_FORMAT_BIG_ENDIAN)
  39. # define DRM_FORMAT_HOST_XRGB8888 DRM_FORMAT_BGRX8888
  40. # define DRM_FORMAT_HOST_ARGB8888 DRM_FORMAT_BGRA8888
  41. #else
  42. # define DRM_FORMAT_HOST_XRGB1555 DRM_FORMAT_XRGB1555
  43. # define DRM_FORMAT_HOST_RGB565 DRM_FORMAT_RGB565
  44. # define DRM_FORMAT_HOST_XRGB8888 DRM_FORMAT_XRGB8888
  45. # define DRM_FORMAT_HOST_ARGB8888 DRM_FORMAT_ARGB8888
  46. #endif
  47. struct drm_device;
  48. struct drm_mode_fb_cmd2;
  49. /**
  50. * struct drm_format_info - information about a DRM format
  51. * @format: 4CC format identifier (DRM_FORMAT_*)
  52. * @depth: Color depth (number of bits per pixel excluding padding bits),
  53. * valid for a subset of RGB formats only. This is a legacy field, do not
  54. * use in new code and set to 0 for new formats.
  55. * @num_planes: Number of color planes (1 to 3)
  56. * @cpp: Number of bytes per pixel (per plane)
  57. * @hsub: Horizontal chroma subsampling factor
  58. * @vsub: Vertical chroma subsampling factor
  59. */
  60. struct drm_format_info {
  61. u32 format;
  62. u8 depth;
  63. u8 num_planes;
  64. u8 cpp[3];
  65. u8 hsub;
  66. u8 vsub;
  67. };
  68. /**
  69. * struct drm_format_name_buf - name of a DRM format
  70. * @str: string buffer containing the format name
  71. */
  72. struct drm_format_name_buf {
  73. char str[32];
  74. };
  75. const struct drm_format_info *__drm_format_info(u32 format);
  76. const struct drm_format_info *drm_format_info(u32 format);
  77. const struct drm_format_info *
  78. drm_get_format_info(struct drm_device *dev,
  79. const struct drm_mode_fb_cmd2 *mode_cmd);
  80. uint32_t drm_mode_legacy_fb_format(uint32_t bpp, uint32_t depth);
  81. int drm_format_num_planes(uint32_t format);
  82. int drm_format_plane_cpp(uint32_t format, int plane);
  83. int drm_format_horz_chroma_subsampling(uint32_t format);
  84. int drm_format_vert_chroma_subsampling(uint32_t format);
  85. int drm_format_plane_width(int width, uint32_t format, int plane);
  86. int drm_format_plane_height(int height, uint32_t format, int plane);
  87. const char *drm_get_format_name(uint32_t format, struct drm_format_name_buf *buf);
  88. #endif /* __DRM_FOURCC_H__ */