lkml.org 
[lkml]   [2020]   [Nov]   [9]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v4 1/5] drm: panel: simple: Fixup the struct panel_desc kernel doc
    Date
    When I run:
    scripts/kernel-doc -rst drivers/gpu/drm/panel/panel-simple.c

    I see that several of the kernel-doc entries aren't showing up because
    they don't specify the full path down the hierarchy. Let's fix that
    and also move to inline kernel docs.

    Signed-off-by: Douglas Anderson <dianders@chromium.org>
    ---

    Changes in v4:
    - ("drm: panel: simple: Fixup the struct panel_desc kernel doc") new for v4.

    drivers/gpu/drm/panel/panel-simple.c | 59 ++++++++++++++++++++--------
    1 file changed, 42 insertions(+), 17 deletions(-)

    diff --git a/drivers/gpu/drm/panel/panel-simple.c b/drivers/gpu/drm/panel/panel-simple.c
    index 597f676a6591..813c90274631 100644
    --- a/drivers/gpu/drm/panel/panel-simple.c
    +++ b/drivers/gpu/drm/panel/panel-simple.c
    @@ -64,33 +64,58 @@ struct panel_desc {

    unsigned int bpc;

    - /**
    - * @width: width (in millimeters) of the panel's active display area
    - * @height: height (in millimeters) of the panel's active display area
    - */
    struct {
    + /**
    + * @size.width: Width (in mm) of the active display area.
    + */
    unsigned int width;
    +
    + /**
    + * @size.height: Height (in mm) of the active display area.
    + */
    unsigned int height;
    } size;

    - /**
    - * @prepare: the time (in milliseconds) that it takes for the panel to
    - * become ready and start receiving video data
    - * @hpd_absent_delay: Add this to the prepare delay if we know Hot
    - * Plug Detect isn't used.
    - * @enable: the time (in milliseconds) that it takes for the panel to
    - * display the first valid frame after starting to receive
    - * video data
    - * @disable: the time (in milliseconds) that it takes for the panel to
    - * turn the display off (no content is visible)
    - * @unprepare: the time (in milliseconds) that it takes for the panel
    - * to power itself down completely
    - */
    struct {
    + /**
    + * @delay.prepare: Time for the panel to become ready.
    + *
    + * The time (in milliseconds) that it takes for the panel to
    + * become ready and start receiving video data
    + */
    unsigned int prepare;
    +
    + /**
    + * @delay.hpd_absent_delay: Time to wait if HPD isn't hooked up.
    + *
    + * Add this to the prepare delay if we know Hot Plug Detect
    + * isn't used.
    + */
    unsigned int hpd_absent_delay;
    +
    + /**
    + * @delay.enable: Time for the panel to display a valid frame.
    + *
    + * The time (in milliseconds) that it takes for the panel to
    + * display the first valid frame after starting to receive
    + * video data.
    + */
    unsigned int enable;
    +
    + /**
    + * @delay.disable: Time for the panel to turn the display off.
    + *
    + * The time (in milliseconds) that it takes for the panel to
    + * turn the display off (no content is visible).
    + */
    unsigned int disable;
    +
    + /**
    + * @delay.unprepare: Time to power down completely.
    + *
    + * The time (in milliseconds) that it takes for the panel
    + * to power itself down completely.
    + */
    unsigned int unprepare;
    } delay;

    --
    2.29.2.222.g5d2a92d10f8-goog
    \
     
     \ /
      Last update: 2020-11-10 02:01    [W:5.876 / U:0.216 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site