Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
drm/amd/display: Add documentation to some of the cursor struct
Reviewed-by: Harry Wentland <Harry.Wentland@amd.com>
Acked-by: Tom Chung <chiahsuan.chung@amd.com>
Signed-off-by: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
Tested-by: Daniel Wheeler <daniel.wheeler@amd.com>
Signed-off-by: Alex Deucher <alexander.deucher@amd.com>
authored by
Rodrigo Siqueira
and committed by
Alex Deucher
60c93531
194eb174
+55
-7
+55
-7
drivers/gpu/drm/amd/display/dc/dc_hw_types.h
+55
-7
drivers/gpu/drm/amd/display/dc/dc_hw_types.h
···
417
417
SCAN_DIRECTION_VERTICAL = 2, /* 90, 270 rotation */
418
418
};
419
419
420
+
/**
421
+
* struct dc_cursor_position: Hardware cursor data.
422
+
*
423
+
* This struct keeps the action information related to the cursor that will be
424
+
* sent and received from our DC core.
425
+
*/
420
426
struct dc_cursor_position {
427
+
/**
428
+
* @x: It represents the top left abscissa coordinate of the cursor.
429
+
*/
421
430
uint32_t x;
431
+
432
+
/**
433
+
* @y: It is the top ordinate of the cursor coordinate.
434
+
*/
422
435
uint32_t y;
423
436
437
+
/**
438
+
* @x_hotspot: Define the abscissa point where mouse click happens.
439
+
*/
424
440
uint32_t x_hotspot;
441
+
442
+
/**
443
+
* @y_hotspot: Define the ordinate point where mouse click happens.
444
+
*/
425
445
uint32_t y_hotspot;
426
446
427
-
/*
428
-
* This parameter indicates whether HW cursor should be enabled
447
+
/**
448
+
* @enable: This parameter indicates whether hardware cursor should be
449
+
* enabled.
429
450
*/
430
451
bool enable;
431
452
432
-
/* Translate cursor x/y by the source rectangle for each plane. */
453
+
/**
454
+
* @translate_by_source: Translate cursor x/y by the source rectangle
455
+
* for each plane.
456
+
*/
433
457
bool translate_by_source;
434
458
};
435
459
···
518
494
/* Used by both ipp amd opp functions*/
519
495
/* TODO: to be consolidated with enum color_space */
520
496
521
-
/*
497
+
/**
498
+
* enum dc_cursor_color_format - DC cursor programming mode
499
+
*
522
500
* This enum is for programming CURSOR_MODE register field. What this register
523
501
* should be programmed to depends on OS requested cursor shape flags and what
524
502
* we stored in the cursor surface.
···
556
530
};
557
531
558
532
struct dc_cursor_attributes {
533
+
/**
534
+
* @address: This field represents the framebuffer address associated
535
+
* with the cursor. It is important to highlight that this address is
536
+
* divided into a high and low parts.
537
+
*/
559
538
PHYSICAL_ADDRESS_LOC address;
539
+
540
+
/**
541
+
* @pitch: Cursor line stride.
542
+
*/
560
543
uint32_t pitch;
561
544
562
-
/* Width and height should correspond to cursor surface width x heigh */
545
+
/**
546
+
* @width: Width should correspond to cursor surface width.
547
+
*/
563
548
uint32_t width;
549
+
/**
550
+
* @heigh: Height should correspond to cursor surface heigh.
551
+
*/
564
552
uint32_t height;
565
553
554
+
/**
555
+
* @color_format: DC cursor programming mode.
556
+
*/
566
557
enum dc_cursor_color_format color_format;
567
-
uint32_t sdr_white_level; // for boosting (SDR) cursor in HDR mode
558
+
/**
559
+
* @sdr_white_level: Boosting (SDR) cursor in HDR mode.
560
+
*/
561
+
uint32_t sdr_white_level;
568
562
569
-
/* In case we support HW Cursor rotation in the future */
563
+
/**
564
+
* @rotation_angle: In case we support HW Cursor rotation in the future
565
+
*/
570
566
enum dc_rotation_angle rotation_angle;
571
567
572
568
union dc_cursor_attribute_flags attribute_flags;