Top |
typedef | igt_crc_t |
#define | IGT_FORMAT_FLOAT |
#define | IGT_FORMAT_FMT |
#define | IGT_MODIFIER_FMT |
igt_fb_t | |
enum | igt_text_align |
struct | buf_ops |
This library contains helper functions for handling kms framebuffer objects
using igt_fb structures to track all the metadata. igt_create_fb()
creates
a basic framebuffer and igt_remove_fb()
cleans everything up again.
It also supports drawing using the cairo library and provides some simplified
helper functions to easily draw test patterns. The main function to create a
cairo drawing context for a framebuffer object is igt_get_cairo_ctx()
.
Finally it also pulls in the drm fourcc headers and provides some helper functions to work with these pixel format codes.
void igt_get_fb_tile_size (int fd
,uint64_t modifier
,int fb_bpp
,unsigned *width_ret
,unsigned *height_ret
);
This function returns width and height of a tile based on the given tiling format.
void
igt_calc_fb_size (struct igt_fb *fb
);
This function calculates the framebuffer size/strides/offsets/etc.
appropriately. The framebuffer needs to be sufficiently initialized
beforehand eg. with igt_init_fb()
.
void igt_init_fb (struct igt_fb *fb
,int fd
,int width
,int height
,uint32_t drm_format
,uint64_t modifier
,enum igt_color_encoding color_encoding
,enum igt_color_range color_range
);
unsigned int igt_create_fb_with_bo_size (int fd
,int width
,int height
,uint32_t format
,uint64_t modifier
,enum igt_color_encoding color_encoding
,enum igt_color_range color_range
,struct igt_fb *fb
,uint64_t bo_size
,unsigned bo_stride
);
This function allocates a gem buffer object suitable to back a framebuffer
with the requested properties and then wraps it up in a drm framebuffer
object of the requested size. All metadata is stored in fb
.
The backing storage of the framebuffer is filled with all zeros, i.e. black for rgb pixel formats.
fd |
open i915 drm file descriptor |
|
width |
width of the framebuffer in pixel |
|
height |
height of the framebuffer in pixel |
|
format |
drm fourcc pixel format code |
|
modifier |
tiling layout of the framebuffer (as framebuffer modifier) |
|
color_encoding |
color encoding for YCbCr formats (ignored otherwise) |
|
color_range |
color range for YCbCr formats (ignored otherwise) |
|
fb |
pointer to an igt_fb structure |
|
bo_size |
size of the backing bo (0 for automatic size) |
|
bo_stride |
stride of the backing bo (0 for automatic stride) |
struct intel_buf * igt_fb_create_intel_buf (int fd
,struct buf_ops *bops
,const struct igt_fb *fb
,const char *name
);
unsigned int igt_create_fb (int fd
,int width
,int height
,uint32_t format
,uint64_t modifier
,struct igt_fb *fb
);
This function allocates a gem buffer object suitable to back a framebuffer
with the requested properties and then wraps it up in a drm framebuffer
object. All metadata is stored in fb
.
The backing storage of the framebuffer is filled with all zeros, i.e. black for rgb pixel formats.
fd |
open drm file descriptor |
|
width |
width of the framebuffer in pixel |
|
height |
height of the framebuffer in pixel |
|
format |
drm fourcc pixel format code |
|
modifier |
tiling layout of the framebuffer |
|
fb |
pointer to an igt_fb structure |
unsigned int igt_create_color_fb (int fd
,int width
,int height
,uint32_t format
,uint64_t modifier
,double r
,double g
,double b
,struct igt_fb *fb
);
This function allocates a gem buffer object suitable to back a framebuffer
with the requested properties and then wraps it up in a drm framebuffer
object. All metadata is stored in fb
.
Compared to igt_create_fb()
this function also fills the entire framebuffer
with the given color, which is useful for some simple pipe crc based tests.
fd |
open drm file descriptor |
|
width |
width of the framebuffer in pixel |
|
height |
height of the framebuffer in pixel |
|
format |
drm fourcc pixel format code |
|
modifier |
tiling layout of the framebuffer |
|
r |
red value to use as fill color |
|
g |
green value to use as fill color |
|
b |
blue value to use as fill color |
|
fb |
pointer to an igt_fb structure |
unsigned int igt_create_pattern_fb (int fd
,int width
,int height
,uint32_t format
,uint64_t modifier
,struct igt_fb *fb
);
This function allocates a gem buffer object suitable to back a framebuffer
with the requested properties and then wraps it up in a drm framebuffer
object. All metadata is stored in fb
.
Compared to igt_create_fb()
this function also draws the standard test pattern
into the framebuffer.
fd |
open drm file descriptor |
|
width |
width of the framebuffer in pixel |
|
height |
height of the framebuffer in pixel |
|
format |
drm fourcc pixel format code |
|
modifier |
tiling layout of the framebuffer |
|
fb |
pointer to an igt_fb structure |
unsigned int igt_create_color_pattern_fb (int fd
,int width
,int height
,uint32_t format
,uint64_t modifier
,double r
,double g
,double b
,struct igt_fb *fb
);
This function allocates a gem buffer object suitable to back a framebuffer
with the requested properties and then wraps it up in a drm framebuffer
object. All metadata is stored in fb
.
Compared to igt_create_fb()
this function also fills the entire framebuffer
with the given color, and then draws the standard test pattern into the
framebuffer.
fd |
open drm file descriptor |
|
width |
width of the framebuffer in pixel |
|
height |
height of the framebuffer in pixel |
|
format |
drm fourcc pixel format code |
|
modifier |
tiling layout of the framebuffer |
|
r |
red value to use as fill color |
|
g |
green value to use as fill color |
|
b |
blue value to use as fill color |
|
fb |
pointer to an igt_fb structure |
unsigned int igt_create_image_fb (int drm_fd
,int width
,int height
,uint32_t format
,uint64_t modifier
,const char *filename
,struct igt_fb *fb
);
Create a framebuffer with the specified image. If width
is zero the
image width will be used. If height
is zero the image height will be used.
drm_fd |
open drm file descriptor |
|
width |
width of the framebuffer in pixel or 0 |
|
height |
height of the framebuffer in pixel or 0 |
|
format |
drm fourcc pixel format code |
|
modifier |
tiling layout of the framebuffer |
|
filename |
filename of the png image to draw |
|
fb |
pointer to an igt_fb structure |
unsigned int igt_create_stereo_fb (int drm_fd
,drmModeModeInfo *mode
,uint32_t format
,uint64_t modifier
);
Create a framebuffer for use with the stereo 3D mode specified by mode
.
unsigned int igt_fb_convert_with_stride (struct igt_fb *dst
,struct igt_fb *src
,uint32_t dst_fourcc
,uint64_t dst_modifier
,unsigned int stride
);
This will convert a given src
content to the dst_fourcc
format,
storing the result in the dst
fb, allocating the dst
fb
underlying buffer with a stride of dst_stride
stride.
Once done with dst
, the caller will have to call igt_remove_fb()
on it to free the associated resources.
dst |
pointer to the igt_fb structure that will store the conversion result |
|
src |
pointer to the igt_fb structure that stores the frame we convert |
|
dst_fourcc |
DRM format specifier to convert to |
|
dst_modifier |
DRM format modifier to convert to |
|
dst_stride |
Stride for the resulting framebuffer (0 for automatic stride) |
unsigned int igt_fb_convert (struct igt_fb *dst
,struct igt_fb *src
,uint32_t dst_fourcc
,uint64_t dst_modifier
);
This will convert a given src
content to the dst_fourcc
format,
storing the result in the dst
fb, allocating the dst
fb
underlying buffer.
Once done with dst
, the caller will have to call igt_remove_fb()
on it to free the associated resources.
void igt_remove_fb (int fd
,struct igt_fb *fb
);
This function releases all resources allocated in igt_create_fb()
for fb
.
Note that if this framebuffer is still in use on a primary plane the kernel
will disable the corresponding crtc.
void * igt_fb_map_buffer (int fd
,struct igt_fb *fb
);
This function will creating a new mapping of the buffer and return a pointer
to the content of the supplied framebuffer's plane. This mapping needs to be
deleted using igt_fb_unmap_buffer()
.
void igt_fb_unmap_buffer (struct igt_fb *fb
,void *buffer
);
This function will unmap a buffer mapped previously with
igt_fb_map_buffer()
.
void igt_create_bo_for_fb (int fd
,int width
,int height
,uint32_t format
,uint64_t modifier
,struct igt_fb *fb
);
int igt_create_bo_with_dimensions (int fd
,int width
,int height
,uint32_t format
,uint64_t modifier
,unsigned stride
,uint64_t *size_ret
,unsigned *stride_ret
,bool *is_dumb
);
This function allocates a gem buffer object matching the requested properties.
fd |
open drm file descriptor |
|
width |
width of the buffer object in pixels |
|
height |
height of the buffer object in pixels |
|
format |
drm fourcc pixel format code |
|
modifier |
modifier corresponding to the tiling layout of the buffer object |
|
stride |
stride of the buffer object in bytes (0 for automatic stride) |
|
size_ret |
size of the buffer object as created by the kernel |
|
stride_ret |
stride of the buffer object as created by the kernel |
|
is_dumb |
whether the created buffer object is a dumb buffer or not |
void igt_fb_calc_crc (struct igt_fb *fb
,igt_crc_t *crc
);
This function calculate the 16-bit frame CRC of RGB components over all the active pixels.
uint64_t
igt_fb_mod_to_tiling (uint64_t modifier
);
This function converts a DRM framebuffer modifier to its corresponding tiling constant.
uint64_t
igt_fb_tiling_to_mod (uint64_t tiling
);
This function converts a DRM framebuffer tiling to its corresponding modifier constant.
bool
igt_fb_is_ccs_modifier (uint64_t modifier
);
This function returns true if modifier
supports compression.
bool
igt_fb_is_gen12_rc_ccs_cc_modifier (uint64_t modifier
);
This function returns true if modifier
supports clear color.
bool
igt_fb_is_gen12_mc_ccs_modifier (uint64_t modifier
);
This function returns true if modifier
supports media compression.
bool igt_fb_is_gen12_ccs_cc_plane (const struct igt_fb *fb
,int plane
);
void igt_xe2_blit_with_dst_pat (const struct igt_fb *dst_fb
,const struct igt_fb *src_fb
,uint8_t dst_pat_index
);
Copy matching size src_fb to dst_fb with setting pat index to destination framebuffer
cairo_surface_t * igt_get_cairo_surface (int fd
,struct igt_fb *fb
);
This function stores the contents of the supplied framebuffer's plane into a cairo surface and returns it.
cairo_surface_t *
igt_cairo_image_surface_create_from_png
(const char *filename
);
cairo_t * igt_get_cairo_ctx (int fd
,struct igt_fb *fb
);
This initializes a cairo surface for fb
and then allocates a drawing context
for it. The return cairo drawing context should be released by calling
igt_put_cairo_ctx()
. This also sets a default font for drawing text on
framebuffers.
void
igt_put_cairo_ctx (cairo_t *cr
);
This releases the cairo surface cr
returned by igt_get_cairo_ctx()
for fb, and writes the changes out to the framebuffer if cairo doesn't
have native support for the format.
void igt_paint_color (cairo_t *cr
,int x
,int y
,int w
,int h
,double r
,double g
,double b
);
This functions draws a solid rectangle with the given color using the drawing
context cr
.
void igt_paint_color_rand (cairo_t *cr
,int x
,int y
,int w
,int h
);
This functions draws a solid rectangle with random colors using the drawing
context cr
.
void igt_paint_color_alpha (cairo_t *cr
,int x
,int y
,int w
,int h
,double r
,double g
,double b
,double a
);
This functions draws a rectangle with the given color and alpha values using
the drawing context cr
.
cr |
cairo drawing context |
|
x |
pixel x-coordination of the fill rectangle |
|
y |
pixel y-coordination of the fill rectangle |
|
w |
width of the fill rectangle |
|
h |
height of the fill rectangle |
|
r |
red value to use as fill color |
|
g |
green value to use as fill color |
|
b |
blue value to use as fill color |
|
a |
alpha value to use as fill color |
void igt_paint_color_gradient (cairo_t *cr
,int x
,int y
,int w
,int h
,int r
,int g
,int b
);
This functions draws a gradient into the rectangle which fades in from black
to the given values using the drawing context cr
.
void igt_paint_color_gradient_range (cairo_t *cr
,int x
,int y
,int w
,int h
,double sr
,double sg
,double sb
,double er
,double eg
,double eb
);
This functions draws a gradient into the rectangle which fades in
from one color to the other using the drawing context cr
.
cr |
cairo drawing context |
|
x |
pixel x-coordination of the fill rectangle |
|
y |
pixel y-coordination of the fill rectangle |
|
w |
width of the fill rectangle |
|
h |
height of the fill rectangle |
|
sr |
red value to use as start gradient color |
|
sg |
green value to use as start gradient color |
|
sb |
blue value to use as start gradient color |
|
er |
red value to use as end gradient color |
|
eg |
green value to use as end gradient color |
|
eb |
blue value to use as end gradient color |
void igt_paint_test_pattern (cairo_t *cr
,int width
,int height
);
This functions draws an entire set of test patterns for the given visible
area using the drawing context cr
. This is useful for manual visual
inspection of displayed framebuffers.
The test patterns include
corner markers to check for over/underscan and
a set of color and b/w gradients.
void igt_paint_image (cairo_t *cr
,const char *filename
,int dst_x
,int dst_y
,int dst_width
,int dst_height
);
This function can be used to draw a scaled version of the supplied png image, which is loaded from the package data directory.
int igt_cairo_printf_line (cairo_t *cr
,enum igt_text_align align
,double yspacing
,const char *fmt
,...
);
This is a little helper to draw text onto framebuffers. All the initial setup
(like setting the font size and the moving to the starting position) still
needs to be done manually with explicit cairo calls on cr
.
bool
igt_fb_supported_format (uint32_t drm_format
);
This functions returns whether drm_format
can be succesfully created by
igt_create_fb()
and drawn to by igt_get_cairo_ctx()
.
bool
igt_format_is_yuv (uint32_t drm_format
);
This functions returns whether drm_format
is YUV (as opposed to RGB).
bool
igt_format_is_yuv_semiplanar (uint32_t format
);
This function returns true if given format is yuv semiplanar.
int igt_format_plane_bpp (uint32_t drm_format
,int plane
);
This functions returns the number of bits per pixel for the given plane
index of the drm_format
.
void igt_format_array_fill (uint32_t **formats_array
,unsigned int *count
,bool allow_yuv
);
This functions allocates and fills a formats_array
that lists the DRM
formats current available.
int igt_fill_cts_color_ramp_framebuffer (uint32_t *pixmap
,uint32_t video_width
,uint32_t video_height
,uint32_t bitdepth
,int alpha
);
int igt_fill_cts_color_square_framebuffer (uint32_t *pixmap
,uint32_t video_width
,uint32_t video_height
,uint32_t bitdepth
,int alpha
);
This function draws a color square pattern for given width and height as per the specifications mentioned in section 3.2.5.3 of DP CTS spec.
Pipe CRC value. All other members than frame
are private and should not be
inspected by testcases.
typedef struct { uint32_t fb_id; int fd; uint32_t gem_handle; bool is_dumb; uint32_t drm_format; int width; int height; enum igt_color_encoding color_encoding; enum igt_color_range color_range; uint64_t modifier; uint64_t size; cairo_surface_t *cairo_surface; unsigned int domain; unsigned int num_planes; uint32_t strides[4]; uint32_t offsets[4]; unsigned int plane_bpp[4]; unsigned int plane_width[4]; unsigned int plane_height[4]; void *driver_priv; } igt_fb_t;
Tracking structure for KMS framebuffer objects.
KMS ID of the framebuffer |
||
int |
DRM device fd this framebuffer is created on |
|
GEM handler of the underlying backing storage |
||
Whether this framebuffer was allocated using the dumb buffer API |
||
DRM FOURCC code |
||
int |
width in pixels |
|
int |
height in pixels |
|
tiling mode as a DRM framebuffer modifier |
||
size in bytes of the underlying backing storage |
||
optionally attached cairo drawing surface |
||
unsigned int |
current domain for cache flushing tracking on i915.ko |
|
unsigned int |
Amount of planes on this fb. >1 for planar formats. |
|
line stride for each plane in bytes |
||
Offset for each plane in bytes. |
||
unsigned int |
The bpp for each plane. |
|
unsigned int |
The width for each plane. |
|
unsigned int |
The height for each plane. |
|
Private driver-specific data, if any |