[PATCH] drm/vkms: Add kerneldoc entry

[Haneen Mohammed]

On Tue, Sep 11, 2018 at 08:06:31PM +0200, Daniel Vetter wrote:
> On Fri, Sep 07, 2018 at 08:41:36PM +0300, Haneen Mohammed wrote:
> > Add an initial kerneldoc entry for vkms with a todo list.
> > 
> > Signed-off-by: Haneen Mohammed <hamohammed.sa at gmail.com>
> > ---
> >  Documentation/gpu/drivers.rst   |  1 +
> >  Documentation/gpu/todo.rst      | 12 ------------
> >  Documentation/gpu/vkms.rst      | 21 +++++++++++++++++++++
> >  drivers/gpu/drm/vkms/vkms_drv.c |  9 +++++++++
> >  4 files changed, 31 insertions(+), 12 deletions(-)
> >  create mode 100644 Documentation/gpu/vkms.rst
> > 
> > diff --git a/Documentation/gpu/drivers.rst b/Documentation/gpu/drivers.rst
> > index 65be325bf282..7d2d3875ff1a 100644
> > --- a/Documentation/gpu/drivers.rst
> > +++ b/Documentation/gpu/drivers.rst
> > @@ -13,6 +13,7 @@ GPU Driver Documentation
> >     tve200
> >     v3d
> >     vc4
> > +   vkms
> >     bridge/dw-hdmi
> >     xen-front
> >  
> > diff --git a/Documentation/gpu/todo.rst b/Documentation/gpu/todo.rst
> > index a7c150d6b63f..f8dfa603e89f 100644
> > --- a/Documentation/gpu/todo.rst
> > +++ b/Documentation/gpu/todo.rst
> > @@ -398,18 +398,6 @@ the non-i915 specific modeset tests.
> >  
> >  Contact: Daniel Vetter
> >  
> > -Create a virtual KMS driver for testing (vkms)
> > -----------------------------------------------
> > -
> > -With all the latest helpers it should be fairly simple to create a virtual KMS
> > -driver useful for testing, or for running X or similar on headless machines
> > -(to be able to still use the GPU). This would be similar to vgem, but aimed at
> > -the modeset side.
> > -
> > -Once the basics are there there's tons of possibilities to extend it.
> > -
> > -Contact: Daniel Vetter
> 
> I've changed this to instead point at the vkms todo list, so we still have
> an entry for this here. And then applied your patch.
> 
> Cursor patches also applied now, thanks.
> 
> Aside: Do you have any plans to continue working on this, i.e. in need of
> commit rights?
> 
> Cheers, Daniel

Thanks!

I still have two patches I didn't submit (suspend/resume, and another that checks
if work_struct is queued before calling flush_work()).
I can volunteer to review future patches to vkms, but unfortunately I don't think I'd
be at capacity to add new features to vkms anymore.

Thank you so much for all your help!

Haneen

> > -
> >  Driver Specific
> >  ===============
> >  
> > diff --git a/Documentation/gpu/vkms.rst b/Documentation/gpu/vkms.rst
> > new file mode 100644
> > index 000000000000..58bce5f4ec0a
> > --- /dev/null
> > +++ b/Documentation/gpu/vkms.rst
> > @@ -0,0 +1,21 @@
> > +==========================================
> > + drm/vkms Virtual Kernel Modesetting
> > +==========================================
> > +
> > +.. kernel-doc:: drivers/gpu/drm/vkms/vkms_drv.c
> > +   :doc: vkms (Virtual Kernel Modesetting)
> > +
> > +TODO
> > +====
> > +
> > +CRC API
> > +-------
> > +
> > +- Optimize CRC computation ``compute_crc()`` and plane blending ``blend()``
> > +
> > +- Use the alpha value to blend vaddr_src with vaddr_dst instead of
> > +  overwriting it in ``blend()``.
> > +
> > +- Add igt test to check cleared alpha value for XRGB plane format.
> > +
> > +- Add igt test to check extreme alpha values i.e. fully opaque and fully transparent (intermediate values are affected by hw-specific rounding modes).
> > diff --git a/drivers/gpu/drm/vkms/vkms_drv.c b/drivers/gpu/drm/vkms/vkms_drv.c
> > index 7ce9a76fb940..73cd11845973 100644
> > --- a/drivers/gpu/drm/vkms/vkms_drv.c
> > +++ b/drivers/gpu/drm/vkms/vkms_drv.c
> > @@ -5,6 +5,15 @@
> >   * (at your option) any later version.
> >   */
> >  
> > +/**
> > + * DOC: vkms (Virtual Kernel Modesetting)
> > + *
> > + * vkms is a software-only model of a kms driver that is useful for testing,
> > + * or for running X (or similar) on headless machines and be able to still
> > + * use the GPU. vkms aims to enable a virtual display without the need for
> > + * a hardware display capability.
> > + */
> > +
> >  #include <linux/module.h>
> >  #include <drm/drm_gem.h>
> >  #include <drm/drm_crtc_helper.h>
> > -- 
> > 2.17.1
> > 
> 
> -- 
> Daniel Vetter
> Software Engineer, Intel Corporation
> http://blog.ffwll.ch