Re: [PATCH v3 4/5] staging/android: add Doc for SW_SYNC ioctl interface

Gustavo Padovan
2016-08-11T16:41:46Z

2016-08-11 Eric Engestrom <eric.engestrom@imgtec.com>:

> On Thu, Aug 11, 2016 at 12:26:43PM -0300, Gustavo Padovan wrote:
> > From: Gustavo Padovan <gustavo.padovan@collabora.co.uk>
> >
> > This interface is hidden from kernel headers and it is intended for use
> > only for testing. So testers would have to add the ioctl information
> > internally. This is to prevent misuse of this feature.
> >
> > v2: take in Eric suggestions for the Documentation
> >
> > Signed-off-by: Gustavo Padovan <gustavo.padovan@collabora.co.uk>
> > Reviewed-by: Eric Engestrom <eric.engestrom@imgtec.com>
> > ---
> > drivers/staging/android/sw_sync.c | 31 +++++++++++++++++++++++++++++++
> > 1 file changed, 31 insertions(+)
> >
> > diff --git a/drivers/staging/android/sw_sync.c b/drivers/staging/android/sw_sync.c
> > index 039e1f4..498ab55 100644
> > --- a/drivers/staging/android/sw_sync.c
> > +++ b/drivers/staging/android/sw_sync.c
> > @@ -25,6 +25,36 @@
> > #define CREATE_TRACE_POINTS
> > #include "sync_trace.h"
> >
> > +/*
> > + * SW SYNC validation framework
> > + *
> > + * A sync object driver that uses a 32bit counter to coordinate
> > + * synchronization. Useful when there is no hardware primitive backing
> > + * the synchronization.
> > + *
> > + * To start the framework just open:
> > + *
> > + * <debugfs>/sync/sw_sync
> > + *
> > + * That will create a sync timeline, all fences created under this timeline
> > + * file descriptor will belong to the this timeline.
> > + *
> > + * The 'sw_sync' file can be opened many times as to create different
> > + * timelines.
> > + *
> > + * Fences can be created with SW_SYNC_IOC_CREATE_FENCE ioctl with struct
> > + * sw_sync_ioctl_create_fence as parameter.
> > + *
> > + * To increment the timeline counter, SW_SYNC_IOC_INC ioctl should be used
> > + * with the increment as u32. This will update the last signaled value
> > + * from the timeline and signal any fence that has seqno smaller of equal
> > + * it.
>
> You didn't fix all of it: "that has a seqno smaller or equal to it."
> Missing "a" (just noticed), s/of/or/, and missing "to" :)

Oh. Right. I didn't pay attention to all your fixes in that phrase.
Thanks. I'll send an updated patch.