[igt-dev] [i-g-t] lib/kms: Fix the missing documentaion for KMS library
Sharma, Swati2
swati2.sharma at intel.com
Tue Sep 12 12:59:34 UTC 2023
Hi Bhanu,
Can you make following changes?
1. remove extra \n before kmstest_get_pipe_from_crtc_id()
2. * kmstest_pipe_to_index:
*@pipe: display pipe in string format
^^ add space here
3. For all sort_drm(), _kmstest_connector_config(),
kmstest_get_connector_config(), kmstest_probe_connector_config(),
kmstest_get_crtc_idx, igt_check_output_bpc_equal(), add returns in doc.
4. Extra \n before igt_plane_set_pipe()
With these changes done, I guess we are good with the patch.
On 28-Jun-23 5:57 PM, Bhanuprakash Modem wrote:
> This patch will fix the missing documentaion for KMS library
> includes:
>
> - Add missing documentaion
> - Fix the documentaion style to detect by the scripts
> - Other minor cleanups
>
> Signed-off-by: Bhanuprakash Modem <bhanuprakash.modem at intel.com>
> ---
> lib/igt_kms.c | 221 +++++++++++++++++++++++++++++++++++++++++++++-----
> lib/igt_kms.h | 181 +++++++++++++++++++++++++++++++++++++++++
> 2 files changed, 382 insertions(+), 20 deletions(-)
>
> diff --git a/lib/igt_kms.c b/lib/igt_kms.c
> index f2b0eed57c5..acc7cbd24c8 100644
> --- a/lib/igt_kms.c
> +++ b/lib/igt_kms.c
> @@ -133,6 +133,20 @@ const struct edid *igt_kms_get_base_edid(void)
> return &edid;
> }
>
> +/**
> + * igt_kms_get_full_edid:
> + *
> + * Get the full edid block, which includes the following modes:
> + *
> + * - 2288x1287 144Hz
> + * - 1920x1080 60Hz
> + * - 1280x720 60Hz
> + * - 1024x768 60Hz
> + * - 800x600 60Hz
> + * - 640x480 60Hz
> + *
> + * Returns: a full edid block
> + */
> const struct edid *igt_kms_get_full_edid(void)
> {
> static struct edid edid;
> @@ -163,6 +177,20 @@ const struct edid *igt_kms_get_full_edid(void)
> return &edid;
> }
>
> +/**
> + * igt_kms_get_base_tile_edid:
> + *
> + * Get the base tile edid block, which includes the following modes:
> + *
> + * - 1920x2160 60Hz
> + * - 1920x1080 60Hz
> + * - 1280x720 60Hz
> + * - 1024x768 60Hz
> + * - 800x600 60Hz
> + * - 640x480 60Hz
> + *
> + * Returns: a basic tile edid block
> + */
> const struct edid *igt_kms_get_base_tile_edid(void)
> {
> static struct edid edid;
> @@ -270,6 +298,13 @@ generate_audio_edid(unsigned char raw_edid[static AUDIO_EDID_SIZE],
> return edid;
> }
>
> +/**
> + * igt_kms_get_hdmi_audio_edid:
> + *
> + * Get a basic edid block, which includes the HDMI Audio
> + *
> + * Returns: a basic HDMI Audio edid block
> + */
> const struct edid *igt_kms_get_hdmi_audio_edid(void)
> {
> int channels;
> @@ -294,6 +329,13 @@ const struct edid *igt_kms_get_hdmi_audio_edid(void)
> return generate_audio_edid(raw_edid, true, &sad, &speaker_alloc);
> }
>
> +/**
> + * igt_kms_get_dp_audio_edid:
> + *
> + * Get a basic edid block, which includes the DP Audio
> + *
> + * Returns: a basic DP Audio edid block
> + */
> const struct edid *igt_kms_get_dp_audio_edid(void)
> {
> int channels;
> @@ -318,6 +360,15 @@ const struct edid *igt_kms_get_dp_audio_edid(void)
> return generate_audio_edid(raw_edid, false, &sad, &speaker_alloc);
> }
>
> +/**
> + * igt_kms_get_tiled_edid:
> + * @htile: Target H-tile
> + * @vtile: Target V-tile
> + *
> + * Get a basic edid block, which includes tiled display
> + *
> + * Returns: a basic tiled display edid block
> + */
> struct edid **igt_kms_get_tiled_edid(uint8_t htile, uint8_t vtile)
> {
> uint8_t top[2];
> @@ -405,6 +456,13 @@ static const uint8_t edid_4k_svds[] = {
> 19, /* 720p @ 50Hz */
> };
>
> +/**
> + * igt_kms_get_4k_edid:
> + *
> + * Get a basic edid block, which includes 4K resolution
> + *
> + * Returns: a basic edid block with 4K resolution
> + */
> const struct edid *igt_kms_get_4k_edid(void)
> {
> static unsigned char raw_edid[256] = {0};
> @@ -457,6 +515,13 @@ const struct edid *igt_kms_get_4k_edid(void)
> return edid;
> }
>
> +/**
> + * igt_kms_get_3d_edid:
> + *
> + * Get a basic edid block, which includes 3D mode
> + *
> + * Returns: a basic edid block with 3D mode
> + */
> const struct edid *igt_kms_get_3d_edid(void)
> {
> static unsigned char raw_edid[256] = {0};
> @@ -1397,6 +1462,13 @@ static char *kmstest_connector_dirname(int idx,
> return name;
> }
>
> +/**
> + * igt_connector_sysfs_open:
> + * @drm_fd: drm file descriptor
> + * @connector: drm connector
> + *
> + * Returns: The connector sysfs fd, or -1 on failure.
> + */
> int igt_connector_sysfs_open(int drm_fd,
> drmModeConnector *connector)
> {
> @@ -1893,6 +1965,15 @@ bool kmstest_get_connector_config(int drm_fd, uint32_t connector_id,
> config, 0);
> }
>
> +/**
> + * kmstest_get_path_blob:
> + * @drm_fd: DRM fd
> + * @connector_id: DRM connector id
> + *
> + * Finds a property with the name "PATH" on the connector object.
> + *
> + * Returns: Pointer to the connector's PATH property if found else NULL.
> + */
> drmModePropertyBlobPtr kmstest_get_path_blob(int drm_fd, uint32_t connector_id)
> {
> uint64_t path_blob_id = 0;
> @@ -2197,6 +2278,12 @@ static void igt_display_log_shift(igt_display_t *display, int shift)
> igt_assert(display->log_shift >= 0);
> }
>
> +/**
> + * igt_output_refresh:
> + * @output: Target output
> + *
> + * This function sets the given @output to a valid default pipe
> + */
> void igt_output_refresh(igt_output_t *output)
> {
> igt_display_t *display = output->display;
> @@ -2413,7 +2500,7 @@ void igt_display_reset(igt_display_t *display)
> static void igt_fill_plane_format_mod(igt_display_t *display, igt_plane_t *plane);
> static void igt_fill_display_format_mod(igt_display_t *display);
>
> -/*
> +/**
> * igt_require_pipe:
> * @display: pointer to igt_display_t
> * @pipe: pipe which need to check
> @@ -2506,7 +2593,7 @@ static void igt_handle_spurious_hpd(igt_display_t *display)
> }
>
> /**
> - * igt_display_require:
> + * igt_display_reset_outputs:
> * @display: a pointer to an initialized #igt_display_t structure
> *
> * Initialize @display outputs with their connectors and pipes.
> @@ -2915,6 +3002,14 @@ igt_output_t *igt_output_from_connector(igt_display_t *display,
> return found;
> }
>
> +/**
> + * igt_std_1024_mode_get:
> + * @vrefresh: Required refresh rate for 1024 mode
> + *
> + * This function will create a standard drm mode with a given @vrefresh
> + *
> + * Returns: Standard 1024 at vrefresh mode.
> + */
> drmModeModeInfo *igt_std_1024_mode_get(int vrefresh)
> {
> const drmModeModeInfo std_1024_mode = {
> @@ -2938,8 +3033,8 @@ drmModeModeInfo *igt_std_1024_mode_get(int vrefresh)
> return igt_memdup(&std_1024_mode, sizeof(std_1024_mode));
> }
>
> -/*
> - * igt_modeset_disable_all_outputs
> +/**
> + * igt_modeset_disable_all_outputs:
> * @diplay: igt display structure
> *
> * Modeset to disable all output
> @@ -3168,6 +3263,12 @@ igt_plane_t *igt_pipe_get_plane_type_index(igt_pipe_t *pipe, int plane_type,
> return NULL;
> }
>
> +/**
> + * output_is_internal_panel:
> + * @output: Target output
> + *
> + * Returns: True if the given @output type is internal else False.
> + */
> bool output_is_internal_panel(igt_output_t *output)
> {
> switch (output->config.connector->connector_type) {
> @@ -3793,6 +3894,15 @@ static bool igt_mode_object_get_prop_enum_value(int drm_fd, uint32_t id, const c
> return false;
> }
>
> +/**
> + * igt_plane_try_prop_enum:
> + * @plane: Target plane.
> + * @prop: Property to check.
> + * @val: Value to set.
> + *
> + * Returns: False if the given @plane doesn't have the enum @prop or
> + * failed to set the enum property @val else True.
> + */
> bool igt_plane_try_prop_enum(igt_plane_t *plane,
> enum igt_atomic_plane_properties prop,
> const char *val)
> @@ -3810,6 +3920,15 @@ bool igt_plane_try_prop_enum(igt_plane_t *plane,
> return true;
> }
>
> +/**
> + * igt_plane_set_prop_enum:
> + * @plane: Target plane.
> + * @prop: Property to check.
> + * @val: Value to set.
> + *
> + * This function tries to set given enum property @prop value @val to
> + * the given @plane, and terminate the execution if its failed.
> + */
> void igt_plane_set_prop_enum(igt_plane_t *plane,
> enum igt_atomic_plane_properties prop,
> const char *val)
> @@ -3868,6 +3987,15 @@ uint64_t igt_output_get_prop(igt_output_t *output, enum igt_atomic_connector_pro
> output->id, output->props[prop]);
> }
>
> +/**
> + * igt_output_try_prop_enum:
> + * @output: Target output.
> + * @prop: Property to check.
> + * @val: Value to set.
> + *
> + * Returns: False if the given @output doesn't have the enum @prop or
> + * failed to set the enum property @val else True.
> + */
> bool igt_output_try_prop_enum(igt_output_t *output,
> enum igt_atomic_connector_properties prop,
> const char *val)
> @@ -3885,6 +4013,15 @@ bool igt_output_try_prop_enum(igt_output_t *output,
> return true;
> }
>
> +/**
> + * igt_output_set_prop_enum:
> + * @output: Target output.
> + * @prop: Property to check.
> + * @val: Value to set.
> + *
> + * This function tries to set given enum property @prop value @val to
> + * the given @output, and terminate the execution if its failed.
> + */
> void igt_output_set_prop_enum(igt_output_t *output,
> enum igt_atomic_connector_properties prop,
> const char *val)
> @@ -3943,6 +4080,15 @@ uint64_t igt_pipe_obj_get_prop(igt_pipe_t *pipe, enum igt_atomic_crtc_properties
> pipe->crtc_id, pipe->props[prop]);
> }
>
> +/**
> + * igt_pipe_obj_try_prop_enum:
> + * @pipe_obj: Target pipe object.
> + * @prop: Property to check.
> + * @val: Value to set.
> + *
> + * Returns: False if the given @pipe_obj doesn't have the enum @prop or
> + * failed to set the enum property @val else True.
> + */
> bool igt_pipe_obj_try_prop_enum(igt_pipe_t *pipe_obj,
> enum igt_atomic_crtc_properties prop,
> const char *val)
> @@ -3960,6 +4106,15 @@ bool igt_pipe_obj_try_prop_enum(igt_pipe_t *pipe_obj,
> return true;
> }
>
> +/**
> + * igt_pipe_obj_set_prop_enum:
> + * @pipe_obj: Target pipe object.
> + * @prop: Property to check.
> + * @val: Value to set.
> + *
> + * This function tries to set given enum property @prop value @val to
> + * the given @pipe_obj, and terminate the execution if its failed.
> + */
> void igt_pipe_obj_set_prop_enum(igt_pipe_t *pipe_obj,
> enum igt_atomic_crtc_properties prop,
> const char *val)
> @@ -4474,11 +4629,11 @@ void igt_output_override_mode(igt_output_t *output, const drmModeModeInfo *mode)
> }
> }
>
> -/*
> +/**
> * igt_output_preferred_vrefresh:
> * @output: Output whose preferred vrefresh is queried
> *
> - * Return the vertical refresh rate of @output's preferred
> + * Returns: The vertical refresh rate of @output's preferred
> * mode. If the output reports no modes return 60Hz as
> * a fallback.
> */
> @@ -4492,7 +4647,7 @@ int igt_output_preferred_vrefresh(igt_output_t *output)
> return 60;
> }
>
> -/*
> +/**
> * igt_output_set_pipe:
> * @output: Target output for which the pipe is being set to
> * @pipe: Display pipe to set to
> @@ -4615,7 +4770,7 @@ bool igt_override_all_active_output_modes_to_fit_bw(igt_display_t *display)
> return __override_all_active_output_modes_to_fit_bw(display, outputs, n_outputs, 0);
> }
>
> -/*
> +/**
> * igt_pipe_refresh:
> * @display: a pointer to an #igt_display_t structure
> * @pipe: Pipe to refresh
> @@ -4641,6 +4796,17 @@ void igt_pipe_refresh(igt_display_t *display, enum pipe pipe, bool force)
> igt_pipe_obj_set_prop_changed(pipe_obj, IGT_CRTC_MODE_ID);
> }
>
> +/**
> + * igt_output_get_plane:
> + * @output: Target output
> + * @plane_idx: Plane index
> + *
> + * Finds a driving pipe for the given @output otherwise and gets the valid
> + * plane associated with that pipe for the given @plane_idx. This function
> + * will terminate the execution if driving pipe is not for a given @output.
> + *
> + * Returns: A #igt_plane_t structure that matches the requested plane index
> + */
> igt_plane_t *igt_output_get_plane(igt_output_t *output, int plane_idx)
> {
> igt_pipe_t *pipe;
> @@ -5350,6 +5516,14 @@ static void igt_fill_plane_format_mod(igt_display_t *display, igt_plane_t *plane
> igt_assert_eq(idx, plane->format_mod_count);
> }
>
> +/**
> + * igt_plane_has_format_mod:
> + * @plane: Target plane
> + * @format: Target format
> + * @modifier: Target modifier
> + *
> + * Returns: true if @plane supports the given @format and @modifier, else false
> + */
> bool igt_plane_has_format_mod(igt_plane_t *plane, uint32_t format,
> uint64_t modifier)
> {
> @@ -5426,6 +5600,14 @@ static void igt_fill_display_format_mod(igt_display_t *display)
> }
> }
>
> +/**
> + * igt_display_has_format_mod:
> + * @display: a pointer to an #igt_display_t structure
> + * @format: Target format
> + * @modifier: Target modifier
> + *
> + * Returns: true if @display supports the given @format and @modifier, else false
> + */
> bool igt_display_has_format_mod(igt_display_t *display, uint32_t format,
> uint64_t modifier)
> {
> @@ -5452,7 +5634,6 @@ bool igt_display_has_format_mod(igt_display_t *display, uint32_t format,
> * that consists of 8 integers that are ':' separated.
> *
> */
> -
> void igt_parse_connector_tile_blob(drmModePropertyBlobPtr blob,
> igt_tile_info_t *tile)
> {
> @@ -5571,7 +5752,6 @@ uint32_t igt_reduce_format(uint32_t format)
> *
> * Iterates through list of connectors and
> * dumps their list of modes.
> - *
> */
> void igt_dump_connectors_fd(int drmfd)
> {
> @@ -5672,7 +5852,7 @@ void igt_dump_crtcs_fd(int drmfd)
> drmModeFreeResources(mode_resources);
> }
>
> -/*
> +/**
> * igt_get_output_max_bpc:
> * @drmfd: A drm file descriptor
> * @connector_name: Name of the libdrm connector we're going to use
> @@ -5700,7 +5880,7 @@ unsigned int igt_get_output_max_bpc(int drmfd, char *connector_name)
> return maximum;
> }
>
> -/*
> +/**
> * igt_get_pipe_current_bpc:
> * @drmfd: A drm file descriptor
> * @pipe: Display pipe
> @@ -5747,7 +5927,7 @@ static unsigned int get_current_bpc(int drmfd, enum pipe pipe,
> return current;
> }
>
> -/*
> +/**
> * igt_assert_output_bpc_equal:
> * @drmfd: A drm file descriptor
> * @pipe: Display pipe
> @@ -5764,7 +5944,7 @@ void igt_assert_output_bpc_equal(int drmfd, enum pipe pipe,
> igt_assert_eq(current, bpc);
> }
>
> -/*
> +/**
> * igt_check_output_bpc_equal:
> * @drmfd: A drm file descriptor
> * @pipe: Display pipe
> @@ -5782,8 +5962,8 @@ bool igt_check_output_bpc_equal(int drmfd, enum pipe pipe,
> return (current == bpc);
> }
>
> -/*
> - * igt_max_bpc_constraint
> +/**
> + * igt_max_bpc_constraint:
> * @display: a pointer to an #igt_display_t structure
> * @pipe: Display pipe
> * @output: Target output
> @@ -5825,7 +6005,7 @@ bool igt_max_bpc_constraint(igt_display_t *display, enum pipe pipe,
> return false;
> }
>
> -/*
> +/**
> * igt_get_max_dotclock:
> * @fd: A drm file descriptor
> *
> @@ -5870,7 +6050,8 @@ int igt_get_max_dotclock(int fd)
> return max_dotclock;
> }
>
> -/* igt_bigjoiner_possible:
> +/**
> + * igt_bigjoiner_possible:
> * @mode: libdrm mode
> * @max_dotclock: Max pixel clock frequency
> *
> @@ -5885,7 +6066,7 @@ bool igt_bigjoiner_possible(drmModeModeInfo *mode, int max_dotclock)
> mode->clock > max_dotclock);
> }
>
> -/*
> +/**
> * igt_check_bigjoiner_support:
> * @display: a pointer to an #igt_display_t structure
> *
> @@ -5986,7 +6167,7 @@ bool igt_parse_mode_string(const char *mode_string, drmModeModeInfo *mode)
> return true;
> }
>
> -/*
> +/**
> * i915_pipe_output_combo_valid:
> * @display: a pointer to an #igt_display_t structure
> *
> diff --git a/lib/igt_kms.h b/lib/igt_kms.h
> index 1b6988c17ae..05876d03d1e 100644
> --- a/lib/igt_kms.h
> +++ b/lib/igt_kms.h
> @@ -346,6 +346,13 @@ typedef enum {
> #define IGT_ROTATION_MASK \
> (IGT_ROTATION_0 | IGT_ROTATION_90 | IGT_ROTATION_180 | IGT_ROTATION_270)
>
> +/**
> + * igt_rotation_90_or_270:
> + * @rotation: Target rotation
> + *
> + * Returns: True if the given @rotation contains 90 or 270 degrees,
> + * else False.
> + */
> static inline bool igt_rotation_90_or_270(igt_rotation_t rotation)
> {
> return rotation & (IGT_ROTATION_90 | IGT_ROTATION_270);
> @@ -531,6 +538,13 @@ static inline bool igt_plane_has_rotation(igt_plane_t *plane, igt_rotation_t rot
> void igt_wait_for_vblank(int drm_fd, int crtc_offset);
> void igt_wait_for_vblank_count(int drm_fd, int crtc_offset, int count);
>
> +/**
> + * igt_output_is_connected:
> + * @output: #igt_output_t to check.
> + *
> + * Returns: True if given @output's connection status is CONNECTED,
> + * else False.
> + */
> static inline bool igt_output_is_connected(igt_output_t *output)
> {
> /* Something went wrong during probe? */
> @@ -672,10 +686,26 @@ igt_output_t **__igt_pipe_populate_outputs(igt_display_t *display,
> for_each_connected_output((display), (output)) \
> for_each_if (igt_pipe_connector_valid((pipe), (output)))
>
> +/**
> + * for_each_plane_on_pipe:
> + * @display: a pointer to an #igt_display_t structure
> + * @pipe: Pipe to enumerate valid outputs over
> + * @plane: The enumerated plane.
> + *
> + * This for loop iterates over all planes associated to the given @pipe.
> + * If there are no valid planes for this pipe, nothing happens.
> + */
> #define for_each_plane_on_pipe(display, pipe, plane) \
> for (int j__ = 0; assert(igt_can_fail()), (plane) = &(display)->pipes[(pipe)].planes[j__], \
> j__ < (display)->pipes[(pipe)].n_planes; j__++)
>
> +/**
> + * for_each_connector_mode:
> + * @output: Output to enumerate available modes.
> + *
> + * This for loop iterates over all modes associated to the given @output.
> + * If there are no mode available for this output, nothing happens.
> + */
> #define for_each_connector_mode(output) \
> for (int j__ = 0; j__ < output->config.connector->count_modes; j__++)
>
> @@ -698,15 +728,44 @@ igt_plane_has_prop(igt_plane_t *plane, enum igt_atomic_plane_properties prop)
>
> uint64_t igt_plane_get_prop(igt_plane_t *plane, enum igt_atomic_plane_properties prop);
>
> +/**
> + * igt_plane_is_prop_changed:
> + * @plane: Plane to check.
> + * @prop: Property to check.
> + *
> + * Check whether a given @prop changed for the @plane.
> + */
> #define igt_plane_is_prop_changed(plane, prop) \
> (!!((plane)->changed & (1 << (prop))))
>
> +/**
> + * igt_plane_set_prop_changed:
> + * @plane: Plane to check.
> + * @prop: Property to check.
> + *
> + * Sets the given @prop for the @plane.
> + */
> #define igt_plane_set_prop_changed(plane, prop) \
> (plane)->changed |= 1 << (prop)
>
> +/**
> + * igt_plane_clear_prop_changed:
> + * @plane: Plane to check.
> + * @prop: Property to check.
> + *
> + * Clears the given @prop for the @plane.
> + */
> #define igt_plane_clear_prop_changed(plane, prop) \
> (plane)->changed &= ~(1 << (prop))
>
> +/**
> + * igt_plane_set_prop_value:
> + * @plane: Plane to check.
> + * @prop: Property to check.
> + * @value: Value to set.
> + *
> + * Sets the given @prop with the @value for the @plane.
> + */
> #define igt_plane_set_prop_value(plane, prop, value) \
> do { \
> plane->values[prop] = value; \
> @@ -742,14 +801,44 @@ igt_output_has_prop(igt_output_t *output, enum igt_atomic_connector_properties p
>
> uint64_t igt_output_get_prop(igt_output_t *output, enum igt_atomic_connector_properties prop);
>
> +/**
> + * igt_output_is_prop_changed:
> + * @output: Output to check.
> + * @prop: Property to check.
> + *
> + * Check whether a given @prop changed for the @Output.
> + */
> #define igt_output_is_prop_changed(output, prop) \
> (!!((output)->changed & (1 << (prop))))
> +
> +/**
> + * igt_output_set_prop_changed:
> + * @output: Output to check.
> + * @prop: Property to check.
> + *
> + * Sets the given @prop for the @output.
> + */
> #define igt_output_set_prop_changed(output, prop) \
> (output)->changed |= 1 << (prop)
>
> +/**
> + * igt_output_clear_prop_changed:
> + * @output: Output to check.
> + * @prop: Property to check.
> + *
> + * Clears the given @prop for the @output.
> + */
> #define igt_output_clear_prop_changed(output, prop) \
> (output)->changed &= ~(1 << (prop))
>
> +/**
> + * igt_output_set_prop_value:
> + * @output: Output to check.
> + * @prop: Property to check.
> + * @value: Value to set.
> + *
> + * Sets the given @prop with the @value for the @output.
> + */
> #define igt_output_set_prop_value(output, prop, value) \
> do { \
> (output)->values[prop] = (value); \
> @@ -820,30 +909,88 @@ igt_pipe_has_prop(igt_display_t *display, enum pipe pipe,
> return display->pipes[pipe].props[prop];
> }
>
> +/**
> + * igt_pipe_obj_is_prop_changed:
> + * @pipe_obj: Pipe object to check.
> + * @prop: Property to check.
> + *
> + * Check whether a given @prop changed for the @pipe_obj.
> + */
> #define igt_pipe_obj_is_prop_changed(pipe_obj, prop) \
> (!!((pipe_obj)->changed & (1 << (prop))))
>
> +/**
> + * igt_pipe_is_prop_changed:
> + * @pipe: Pipe object to check.
> + * @prop: Property to check.
> + *
> + * Check whether a given @prop changed for the @pipe.
> + */
> #define igt_pipe_is_prop_changed(display, pipe, prop) \
> igt_pipe_obj_is_prop_changed(&(display)->pipes[(pipe)], prop)
>
> +/**
> + * igt_pipe_obj_set_prop_changed:
> + * @pipe_obj: Pipe object to check.
> + * @prop: Property to check.
> + *
> + * Sets the given @prop for the @pipe_obj.
> + */
> #define igt_pipe_obj_set_prop_changed(pipe_obj, prop) \
> (pipe_obj)->changed |= 1 << (prop)
>
> +/**
> + * igt_pipe_set_prop_changed:
> + * @pipe: Pipe object to check.
> + * @prop: Property to check.
> + *
> + * Sets the given @prop for the @pipe.
> + */
> #define igt_pipe_set_prop_changed(display, pipe, prop) \
> igt_pipe_obj_set_prop_changed(&(display)->pipes[(pipe)], prop)
>
> +/**
> + * igt_pipe_obj_clear_prop_changed:
> + * @pipe_obj: Pipe object to check.
> + * @prop: Property to check.
> + *
> + * Clears the given @prop for the @pipe_obj.
> + */
> #define igt_pipe_obj_clear_prop_changed(pipe_obj, prop) \
> (pipe_obj)->changed &= ~(1 << (prop))
>
> +/**
> + * igt_pipe_clear_prop_changed:
> + * @pipe: Pipe object to check.
> + * @prop: Property to check.
> + *
> + * Clears the given @prop for the @pipe.
> + */
> #define igt_pipe_clear_prop_changed(display, pipe, prop) \
> igt_pipe_obj_clear_prop_changed(&(display)->pipes[(pipe)], prop)
>
> +/**
> + * igt_pipe_obj_set_prop_value:
> + * @pipe_obj: Pipe object to check.
> + * @prop: Property to check.
> + * @value: Value to set.
> + *
> + * Sets the given @prop with the @value for the @pipe_obj.
> + */
> #define igt_pipe_obj_set_prop_value(pipe_obj, prop, value) \
> do { \
> (pipe_obj)->values[prop] = (value); \
> igt_pipe_obj_set_prop_changed(pipe_obj, prop); \
> } while (0)
>
> +/**
> + * igt_pipe_set_prop_value:
> + * @pipe: Pipe to check.
> + * @prop: Property to check.
> + * @value: Value to set.
> + *
> + * Sets the given @prop with the @value for the @pipe.
> + */
> #define igt_pipe_set_prop_value(display, pipe, prop, value) \
> igt_pipe_obj_set_prop_value(&(display)->pipes[(pipe)], prop, value)
>
> @@ -855,9 +1002,27 @@ extern void igt_pipe_obj_set_prop_enum(igt_pipe_t *pipe,
> enum igt_atomic_crtc_properties prop,
> const char *val);
>
> +/**
> + * igt_pipe_try_prop_enum:
> + * @pipe: Target pipe.
> + * @prop: Property to check.
> + * @val: Value to set.
> + *
> + * Returns: False if the given @pipe doesn't have the enum @prop or
> + * failed to set the enum property @val else True.
> + */
> #define igt_pipe_try_prop_enum(display, pipe, prop, val) \
> igt_pipe_obj_try_prop_enum(&(display)->pipes[(pipe)], prop, val)
>
> +/**
> + * igt_pipe_set_prop_enum:
> + * @pipe: Target pipe.
> + * @prop: Property to check.
> + * @val: Value to set.
> + *
> + * This function tries to set given enum property @prop value @val to
> + * the given @pipe, and terminate the execution if its failed.
> + */
> #define igt_pipe_set_prop_enum(display, pipe, prop, val) \
> igt_pipe_obj_set_prop_enum(&(display)->pipes[(pipe)], prop, val)
>
> @@ -865,6 +1030,22 @@ extern void igt_pipe_obj_replace_prop_blob(igt_pipe_t *pipe,
> enum igt_atomic_crtc_properties prop,
> const void *ptr, size_t length);
>
> +/**
> + * igt_pipe_replace_prop_blob:
> + * @pipe: pipe to set property on.
> + * @prop: property for which the blob will be replaced.
> + * @ptr: Pointer to contents for the property.
> + * @length: Length of contents.
> + *
> + * This function will destroy the old property blob for the given property,
> + * and will create a new property blob with the values passed to this function.
> + *
> + * The new property blob will be committed when you call igt_display_commit(),
> + * igt_display_commit2() or igt_display_commit_atomic().
> + *
> + * Please use igt_output_override_mode() if you want to set #IGT_CRTC_MODE_ID,
> + * it works better with legacy commit.
> + */
> #define igt_pipe_replace_prop_blob(display, pipe, prop, ptr, length) \
> igt_pipe_obj_replace_prop_blob(&(display)->pipes[(pipe)], prop, ptr, length)
>
More information about the igt-dev
mailing list