class PipeScalerControlTigerLake

Enables the pipe scaler.

Before enabling the scaler, software should make sure that the scaler

configuration fulfills all the scaler constraints.

Enables the pipe scaler.

Before enabling the scaler, software should make sure that the scaler

configuration fulfills all the scaler constraints.

If true, the scaler performs YUV chroma upsampling while scaling the

output, which is also called "planar mode" in some documentation.

This bit must be true if and only if the following conditions are met:

- The scaler must be bound to a universal plane instead of a pipe.

- The plane it binds to must be an SDR plane (Plane 4 or 5).

- The plane's active image must be of YUV 420 format.

If true, the scaler performs YUV chroma upsampling while scaling the

output, which is also called "planar mode" in some documentation.

This bit must be true if and only if the following conditions are met:

- The scaler must be bound to a universal plane instead of a pipe.

- The plane it binds to must be an SDR plane (Plane 4 or 5).

- The plane's active image must be of YUV 420 format.

Enables the "Adaptive filtering" mode of the pipe scaler.

When set to true, a multi-threshold adaptive filter will be used for

vertical and horizontal filtering. The `filter_selection` field will be

ignored, instead `adaptive_filter_selection` will be used to choose the

filter type.

There are two sets of adaptive filtering thresholds for each pipe scaler.

Threshold values (in `PipeScalerAdaptiveFilterThresholds` register) and

threshold set selection (in `*_filter_set` field) must be programmed before

this bit being enabled.

Enables the "Adaptive filtering" mode of the pipe scaler.

When set to true, a multi-threshold adaptive filter will be used for

vertical and horizontal filtering. The `filter_selection` field will be

ignored, instead `adaptive_filter_selection` will be used to choose the

filter type.

There are two sets of adaptive filtering thresholds for each pipe scaler.

Threshold values (in `PipeScalerAdaptiveFilterThresholds` register) and

threshold set selection (in `*_filter_set` field) must be programmed before

this bit being enabled.

Selects the index of the plane where the output is scaled. An index of 0

indicates that the output of the whole pipe is scaled.

The value of `scaled_plane_index` must not exceed the number of

planes supported by the pipe. On Tiger Lake, each pipe has 7 planes.

The caller must guarantee that the plane / pipe fulfills all the

constraints below:

- The input size of the pipe / plane must be at least 8 scanlines.

- IF (Interlaced fetch) mode must be disabled.

- Keying can only be enabled if the scaling factor is 1.

- The pixel format must not be 8-bit indexed or XR_BIAS.

- Floating point source pixel values must be within the [0.0, 1.0] range.

- For HDR planes (Plane 1 - 3), the `plane_scaling_enabled` field of the

`PLANE_CUS_CTL` register must be enabled.

Selects the index of the plane where the output is scaled. An index of 0

indicates that the output of the whole pipe is scaled.

The value of `scaled_plane_index` must not exceed the number of

planes supported by the pipe. On Tiger Lake, each pipe has 7 planes.

The caller must guarantee that the plane / pipe fulfills all the

constraints below:

- The input size of the pipe / plane must be at least 8 scanlines.

- IF (Interlaced fetch) mode must be disabled.

- Keying can only be enabled if the scaling factor is 1.

- The pixel format must not be 8-bit indexed or XR_BIAS.

- Floating point source pixel values must be within the [0.0, 1.0] range.

- For HDR planes (Plane 1 - 3), the `plane_scaling_enabled` field of the

`PLANE_CUS_CTL` register must be enabled.

Selects the filter to use for the non-adaptive filter.

This field only works on non-adaptive mode. If `adaptive_filtering_enabled`

is true, this field will be ignored and `adaptive_filter_selection` will

be used instead.

Selects the filter to use for the non-adaptive filter.

This field only works on non-adaptive mode. If `adaptive_filtering_enabled`

is true, this field will be ignored and `adaptive_filter_selection` will

be used instead.

Selects the filter to use for the adaptive filter.

This field only works on adaptive mode. If `adaptive_filtering_enabled`

is false, this field will be ignored and `normal_filter_selection` will

be used instead.

Selects the filter to use for the adaptive filter.

This field only works on adaptive mode. If `adaptive_filtering_enabled`

is false, this field will be ignored and `normal_filter_selection` will

be used instead.

Specifies the scaler interface on the display pipeline that the pipe

scaler binds to. See `PipeScalerLocation` for details.

This field is effective only when the scaler is bound to the pipe, i.e.

`scaler_binding_selection` field is 0.

Specifies the scaler interface on the display pipeline that the pipe

scaler binds to. See `PipeScalerLocation` for details.

This field is effective only when the scaler is bound to the pipe, i.e.

`scaler_binding_selection` field is 0.

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 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 all the resources that allow disabling.

Selects the Y plane surface matching the UV plane selected in

`scaled_plane_index`.

This field is effective only if planar mode is enabled.

Only the following values are valid for this field:

- 6 (0b110): indicating Plane 6 is used as input Y plane;

- 7 (0b111): indicating Plane 7 is used as input Y plane.

`y_plane_binding()` and `set_y_plane_binding()` helper methods can be used

to get / set the value of this field.

Selects the Y plane surface matching the UV plane selected in

`scaled_plane_index`.

This field is effective only if planar mode is enabled.

Only the following values are valid for this field:

- 6 (0b110): indicating Plane 6 is used as input Y plane;

- 7 (0b111): indicating Plane 7 is used as input Y plane.

`y_plane_binding()` and `set_y_plane_binding()` helper methods can be used

to get / set the value of this field.

Helper method to get the value of this field with validity check.

Helper method to set the value of this field with validity check.

Selects the filter coefficient / threshold set used by the *vertical*

filter for the Y semi-plane bound to the scaler in YUV planar mode.

It's used only in the following conditions:

- When `chrome_upsampling_enabled` is true and `adaptive_filter_enabled`

is true, it indicates the adaptive filter threshold set index for Y

plane scaling filter.

- When `chrome_upsampling_enabled` is true, adaptive filtering is

disabled and `normal_filter_select` is `kProgrammed`, it indicates the

programmed filter coefficient set index for Y plane scaling filter.

Otherwise, this field will be ignored.

Selects the filter coefficient / threshold set used by the *vertical*

filter for the Y semi-plane bound to the scaler in YUV planar mode.

It's used only in the following conditions:

- When `chrome_upsampling_enabled` is true and `adaptive_filter_enabled`

is true, it indicates the adaptive filter threshold set index for Y

plane scaling filter.

- When `chrome_upsampling_enabled` is true, adaptive filtering is

disabled and `normal_filter_select` is `kProgrammed`, it indicates the

programmed filter coefficient set index for Y plane scaling filter.

Otherwise, this field will be ignored.

Selects the filter coefficient / threshold set used by the *horizontal*

filter for the Y semi-plane bound to the scaler in YUV planar mode.

The semantics of this field is similar to

`y_plane_vertical_filter_set_selection` but it applies to the horizontal

filter instead.

Selects the filter coefficient / threshold set used by the *horizontal*

filter for the Y semi-plane bound to the scaler in YUV planar mode.

The semantics of this field is similar to

`y_plane_vertical_filter_set_selection` but it applies to the horizontal

filter instead.

Selects the filter coefficient / threshold set used by the *vertical*

filter for the plane (or UV semi-plane, if `chroma_upscaling_enabled`

is true) or pipe bound to the scaler.

It's used in the following conditions:

- If `adaptive_filter_enabled` is true, this field indicates the index of

the adaptive filter threshold set.

- If `adaptive_filter_enabled` is false and `normal_filter_select` is

`kProgrammed`, this field indicates the selected filter coefficient set.

Otherwise, this field is ignored.

Selects the filter coefficient / threshold set used by the *vertical*

filter for the plane (or UV semi-plane, if `chroma_upscaling_enabled`

is true) or pipe bound to the scaler.

It's used in the following conditions:

- If `adaptive_filter_enabled` is true, this field indicates the index of

the adaptive filter threshold set.

- If `adaptive_filter_enabled` is false and `normal_filter_select` is

`kProgrammed`, this field indicates the selected filter coefficient set.

Otherwise, this field is ignored.

Selects the filter coefficient / threshold set used by the *horizontal*

filter for the plane (or UV semi-plane, if `chroma_upscaling_enabled` is

true) or pipe bound to the scaler.

The semantics of this field is similar to

`vertical_filter_set_selection` but it applies to the horizontal

filter instead.

Selects the filter coefficient / threshold set used by the *horizontal*

filter for the plane (or UV semi-plane, if `chroma_upscaling_enabled` is

true) or pipe bound to the scaler.

The semantics of this field is similar to

`vertical_filter_set_selection` but it applies to the horizontal

filter instead.

This enum class specifies the scaler interface on the display pipeline that

the pipe scaler binds to.

Tiger Lake: Section "Pipes", IHD-OS-TGL-Vol 12-1.22-Rev 2.0 Part 2, Pages 117