| Message ID | 20201109170018.v4.1.Icaa86f0a4ca45a9a7184da4bc63386b29792d613@changeid (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [v4,1/5] drm: panel: simple: Fixup the struct panel_desc kernel doc | expand |
Hi, On Mon, Nov 9, 2020 at 5:01 PM Douglas Anderson <dianders@chromium.org> wrote: > > 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(-) I'm curious if there are any outstanding actions I need to take for this series. I know I found that on patch #4 I should have added the sync flags [1] but I was waiting to see if there was any other feedback before sending a v5. If there's nothing else I'm happy with any of: a) I can send a v5 with that small fix. b) v4 can land an the maintainer landing can add the ".flags = DRM_MODE_FLAG_PHSYNC | DRM_MODE_FLAG_NVSYNC," into the patch when landing. c) v4 can land and I can send a follow-up patch with the sync flags fix. I know it's the holidays right now and folks are busy, but I just wanted to see if there were any actions I needed to take. Personally I'm on vacation the last 3 days this week and I imagine I'll come back to work Monday swamped with email, so today/tomorrow would be an ideal time to send a spin if one is needed. Thanks! -Doug [1] https://lore.kernel.org/r/CAD=FV=UPkuJ5E2sCQeozNR3CO+LZW=DW9h77vfooeiSMqGnYpA@mail.gmail.com
Hi Douglas, On Mon, Nov 09, 2020 at 05:00:55PM -0800, Douglas Anderson wrote: > 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> Thanks, applied to drm-misc-next. Could you do a follow-up patch that moves the rest as inline comments and verify that all fields are described. (W=1 should show no warnings). That would be appreciated! Sam
Hi, On Sun, Nov 29, 2020 at 2:10 PM Sam Ravnborg <sam@ravnborg.org> wrote: > > Hi Douglas, > On Mon, Nov 09, 2020 at 05:00:55PM -0800, Douglas Anderson wrote: > > 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> > > Thanks, applied to drm-misc-next. > > Could you do a follow-up patch that moves the rest as inline comments > and verify that all fields are described. (W=1 should show no warnings). > That would be appreciated! Ah, I hadn't realized that you wanted it all moved and thought originally you just wanted the deeply nested stuff. See if: https://lore.kernel.org/r/20201201125822.1.I3c4191336014bd57364309439e56f600c94bb12b@changeid ...looks like what you want. :-) -Doug
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;
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(-)