class PlaneControl

If true, the plane generates pixels for display.

If false, the plane stops fetching surface memory, and outputs transparent

pixels.

If true, the plane generates pixels for display.

If false, the plane stops fetching surface memory, and outputs transparent

pixels.

If true, pipe-level gamma correction is enabled for the plane's pixel data.

Pipe-level gamma correction is separate from plane-level gamma correction.

This field only exists on Kaby Lake and Skylake. On Tiger Lake, this field

was moved to the PlaneColorControl register, and the underlying bit here

is used for another field.

If true, pipe-level gamma correction is enabled for the plane's pixel data.

Pipe-level gamma correction is separate from plane-level gamma correction.

This field only exists on Kaby Lake and Skylake. On Tiger Lake, this field

was moved to the PlaneColorControl register, and the underlying bit here

is used for another field.

See `yuv_offset_preserved` in PlaneColorControl for details.

This field only exists on Kaby Lake and Skylake. On Tiger Lake, this field

was moved to the PlaneColorControl register, and the underlying bit here

is used for another field.

See `yuv_offset_preserved` in PlaneColorControl for details.

This field only exists on Kaby Lake and Skylake. On Tiger Lake, this field

was moved to the PlaneColorControl register, and the underlying bit here

is used for another field.

See `yuv_range_correction_disabled` in PlaneColorControl for details.

This field only exists on Kaby Lake and Skylake. On Tiger Lake, this field

was moved to the PlaneColorControl register, and the underlying bit here

is used for another field.

See `yuv_range_correction_disabled` in PlaneColorControl for details.

This field only exists on Kaby Lake and Skylake. On Tiger Lake, this field

was moved to the PlaneColorControl register, and the underlying bit here

is used for another field.

Number of slots allocated to this plane in pipe slice request arbitration.

This field is not documented on Kaby Lake or Skylake. The underlying bits

are used by different fields.

See `pipe_slice_request_arbitration_slot_count_tiger_lake()` for details.

The source pixel format for the plane.

The plane converts the source data to the pipe's pixel format, before the

data enters the blending logic. Some formats are only supported by HDR

planes.

This setter uses the field and color format values documented for Tiger

Lake.

The source pixel format for the plane.

The plane converts the source data to the pipe's pixel format, before the

data enters the blending logic.

This setter uses the field and color format values documented for Kaby Lake

and Skylake.

If true, pipe-level color space conversion is enabled for this plane.

The pipe-level CSC (color space conversion) is separate from the

plane-level CSC.

This field only exists on Kaby Lake and Skylake. On Tiger Lake, this field

was moved to the PlaneColorControl register, and the underlying bit here

is used for another field.

If true, pipe-level color space conversion is enabled for this plane.

The pipe-level CSC (color space conversion) is separate from the

plane-level CSC.

This field only exists on Kaby Lake and Skylake. On Tiger Lake, this field

was moved to the PlaneColorControl register, and the underlying bit here

is used for another field.

Selects the plane's color keying functionality.

Color keying has the following restrictions:

* The pixel format must not be 8-bit indexed

* If used, Source Key Window and Destination color keying must be enabled

on a pair of adjacent planes on a pipe

* Source and Source Window keying must not be used on the bottom active

plane

* Destination keying must not be used on the top active plane

Selects the plane's color keying functionality.

Color keying has the following restrictions:

* The pixel format must not be 8-bit indexed

* If used, Source Key Window and Destination color keying must be enabled

on a pair of adjacent planes on a pipe

* Source and Source Window keying must not be used on the bottom active

plane

* Destination keying must not be used on the top active plane

Selects the color ordering for most RGB formats.

This field is ignored for the following input formats:

* XR_BIAS 10:10:10

* BGRX 5:6:5

* Non-RGB color formats, such as YUV and indexed

Selects the color ordering for most RGB formats.

This field is ignored for the following input formats:

* XR_BIAS 10:10:10

* BGRX 5:6:5

* Non-RGB color formats, such as YUV and indexed

If true, the plane performs no YUV-to-RGB color conversion.

This field is ignored when the plane's source is an RGB format.

This field is not documented on Tiger Lake. The underlying bit is used by a

different field.

If true, the plane performs no YUV-to-RGB color conversion.

This field is ignored when the plane's source is an RGB format.

This field is not documented on Tiger Lake. The underlying bit is used by a

different field.

If true, this plane stores the Y component of planar YUV420 data.

If false, this plane stores the U and V components of planar YUV420 data.

This field is used when the source pixel format is a YUV420 planar format

(NV12 or P0xx). This field must be set to false for all other formats.

Only planes 1-5 can store the U and V components in planar YUV420 data.

Only planes 6-7 can store the Y component in planar YUV420 data.

This field is not documented on Kaby Lake or Skylake. The underlying bit is

used by a different field.

See `has_y_component_in_planar_yuv420_tiger_lake()` for details.

Specifies the YUV format for the plane's YUV-to-RGB color space conversion.

This field is ignored when the plane's source is not a YUV format.

This field is not documented on Tiger Lake. The underlying bit is reserved

MBZ (must be zero).

Specifies the YUV format for the plane's YUV-to-RGB color space conversion.

This field is ignored when the plane's source is not a YUV format.

This field is not documented on Tiger Lake. The underlying bit is reserved

MBZ (must be zero).

Selects the byte order for YUV 4:2:2 data formats.

This field is ignored when the plane's source format is not YUV 4:2:2.

Selects the byte order for YUV 4:2:2 data formats.

This field is ignored when the plane's source format is not YUV 4:2:2.

If true, the display engine will decompress Render-compressed surfaces.

Decompression has the following limitations:

* Decompression must be left-right cache-line pair

* The compressed surface must use Y (Legacy) or YF tiling

* Plane rotation must not be set to 90 or 270 degrees

* The surface format must be RGB8888, RGB1010102 (only on Tiger Lake), or

FP16 (only on Tiger Lake)

* On Kaby Lake and Skylake, decompression is only supported on planes 1-2

of pipes A and B

If true, the display engine will decompress Render-compressed surfaces.

Decompression has the following limitations:

* Decompression must be left-right cache-line pair

* The compressed surface must use Y (Legacy) or YF tiling

* Plane rotation must not be set to 90 or 270 degrees

* The surface format must be RGB8888, RGB1010102 (only on Tiger Lake), or

FP16 (only on Tiger Lake)

* On Kaby Lake and Skylake, decompression is only supported on planes 1-2

of pipes A and B

If true, plane-level gamma correction is disabled.

This field is not documented on Tiger Lake. The underlying bit is used by a

different field.

If true, plane-level gamma correction is disabled.

This field is not documented on Tiger Lake. The underlying bit is used by a

different field.

If true, clear color mode is disabled when display decompresses surfaces.

This field is ignored if `decompress_render_compressed_surfaces` is false.

If `decompress_render_compressed_surfaces` and this field is false (Color

Clear is enabled), the color must be set in the PLANE_CC_VAL register

before performing a flip via a PLANE_SURF register write.

This field is not documented on Kaby Lake and Skylake. That hardware does

not support Color Clear with decompression. The underlying bit is used by a

different field.

See `render_decompression_clear_color_disabled_tiger_lake()` for details.

Indicates the tiling used by the plane's surface data.

Y tiling is not compatible with interlaced modes. YS tiling is not

supported.

Indicates the tiling used by the plane's surface data.

Y tiling is not compatible with interlaced modes. YS tiling is not

supported.

If true, surface MMIO address writes take effect as soon as possible.

If false, MMIO writes that change the plane's surface address will take

effect synchronously, during vertical blank start.

If true, surface MMIO address writes take effect as soon as possible.

If false, MMIO writes that change the plane's surface address will take

effect synchronously, during vertical blank start.

If true, the plane performs a horizontal flip before any rotation.

This field is not documented on Kaby Lake and Skylake. The underlying bit

is reserved MBZ (must be zero), which is semantically equivalent to

considering that horizontal flipping is not supported on Kaby Lake /

Skylake, and must always be disabled.

If true, the plane performs a horizontal flip before any rotation.

This field is not documented on Kaby Lake and Skylake. The underlying bit

is reserved MBZ (must be zero), which is semantically equivalent to

considering that horizontal flipping is not supported on Kaby Lake /

Skylake, and must always be disabled.

If true, right eye Vblank does not trigger plane surface double-buffering.

This field is ignored outside stereo 3D mode. In stereo 3D mode, at least

one eye Vblank must be unmasked.

If true, right eye Vblank does not trigger plane surface double-buffering.

This field is ignored outside stereo 3D mode. In stereo 3D mode, at least

one eye Vblank must be unmasked.

If true, left eye Vblank does not trigger plane surface double-buffering.

This field is ignored outside stereo 3D mode. In stereo 3D mode, at least

one eye Vblank must be unmasked.

If true, left eye Vblank does not trigger plane surface double-buffering.

This field is ignored outside stereo 3D mode. In stereo 3D mode, at least

one eye Vblank must be unmasked.

See `alpha_mode` in PlaneColorControl for details.

This field only exists on Kaby Lake and Skylake. On Tiger Lake, this field

was moved to the PlaneColorControl register, and the underlying bits here

are used for other fields.

See `alpha_mode` in PlaneColorControl for details.

This field only exists on Kaby Lake and Skylake. On Tiger Lake, this field

was moved to the PlaneColorControl register, and the underlying bits here

are used for other fields.

If true, the display engine will decompress Media-compressed surfaces.

This field must not be set to true for a plane where

`decompress_render_compressed_surfaces` is true.

Media decompression is supported for the following formats: YUV420 planar

(NV12, P0xx), YUV422, YUV4444, RGB8888, RGB1010102 and FP16.

This field is not documented on Kaby Lake and Skylake. The underlying bit

is used by a different field.

See `decompress_media_compressed_surfaces_tiger_lake()` for details.

If true, double-buffer updates can be disabled for this plane.

This field applies when the DOUBLE_BUFFER_CTL register is used to disable

the double-buffering of for all the resources that allow disabling.

If true, double-buffer updates can be disabled for this plane.

This field applies when the DOUBLE_BUFFER_CTL register is used to disable

the double-buffering of for all the resources that allow disabling.

Selects the hardware rotation performed by the plane.

90 and 270 degree rotations have the following restrictions:

* The surface must be Y-Tiled

* Interlacing must be disabled

* Render-Display compression must be disabled

Selects the hardware rotation performed by the plane.

90 and 270 degree rotations have the following restrictions:

* The surface must be Y-Tiled

* Interlacing must be disabled

* Render-Display compression must be disabled

Documented values for the `source_pixel_format_kaby_lake` field.

Kaby Lake: IHD-OS-KBL-Vol 2c-1.17 Part 2 page 564

Skylake: IHD-OS-SKL-Vol 2c-05.16 Part 2 page 561

Documented values for the `source_pixel_format_tiger_lake` field.

Tiger Lake: IHD-OS-TGL-Vol 2c-1.22-Rev2.0 Part 2 page 749

Possible values for the `color_key` field.

Possible values for the `rgb_color_order` field.

Possible values for the `yuv_to_rgb_csc_format_kaby_lake` field.

Possible values for the `yuv_422_byte_order` field.

Documented values for the `surface_tiling` field.

Possible values for the `rotation` field.