diff mbox series

drm/i915: Correct the docs for intel_engine_cmd_parser

Message ID 20210720182108.2761496-1-jason@jlekstrand.net (mailing list archive)
State New, archived
Headers show
Series drm/i915: Correct the docs for intel_engine_cmd_parser | expand

Commit Message

Jason Ekstrand July 20, 2021, 6:21 p.m. UTC
In c9d9fdbc108a ("drm/i915: Revert "drm/i915/gem: Asynchronous
cmdparser""), the parameters to intel_engine_cmd_parser() were altered
without updating the docs, causing Fi.CI.DOCS to start failing.

Signed-off-by: Jason Ekstrand <jason@jlekstrand.net>
---
 drivers/gpu/drm/i915/i915_cmd_parser.c | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

Comments

Rodrigo Vivi July 20, 2021, 8:25 p.m. UTC | #1
On Tue, Jul 20, 2021 at 01:21:08PM -0500, Jason Ekstrand wrote:
> In c9d9fdbc108a ("drm/i915: Revert "drm/i915/gem: Asynchronous
> cmdparser""), the parameters to intel_engine_cmd_parser() were altered
> without updating the docs, causing Fi.CI.DOCS to start failing.
> 
> Signed-off-by: Jason Ekstrand <jason@jlekstrand.net>
> ---
>  drivers/gpu/drm/i915/i915_cmd_parser.c | 4 +---
>  1 file changed, 1 insertion(+), 3 deletions(-)
> 
> diff --git a/drivers/gpu/drm/i915/i915_cmd_parser.c b/drivers/gpu/drm/i915/i915_cmd_parser.c
> index 322f4d5955a4f..e0403ce9ce692 100644
> --- a/drivers/gpu/drm/i915/i915_cmd_parser.c
> +++ b/drivers/gpu/drm/i915/i915_cmd_parser.c
> @@ -1416,9 +1416,7 @@ static unsigned long *alloc_whitelist(u32 batch_length)
>   * @batch_offset: byte offset in the batch at which execution starts
>   * @batch_length: length of the commands in batch_obj
>   * @shadow: validated copy of the batch buffer in question
> - * @jump_whitelist: buffer preallocated with intel_engine_cmd_parser_alloc_jump_whitelist()
> - * @shadow_map: mapping to @shadow vma
> - * @batch_map: mapping to @batch vma
> + * @trampoline: true if we need to trampoline into privileged execution

I was wondering if we should also return the original text, but this one
here looks better.


Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>


>   *
>   * Parses the specified batch buffer looking for privilege violations as
>   * described in the overview.
> -- 
> 2.31.1
> 
> _______________________________________________
> Intel-gfx mailing list
> Intel-gfx@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Rodrigo Vivi July 20, 2021, 8:26 p.m. UTC | #2
On Tue, Jul 20, 2021 at 04:25:21PM -0400, Rodrigo Vivi wrote:
> On Tue, Jul 20, 2021 at 01:21:08PM -0500, Jason Ekstrand wrote:
> > In c9d9fdbc108a ("drm/i915: Revert "drm/i915/gem: Asynchronous
> > cmdparser""), the parameters to intel_engine_cmd_parser() were altered
> > without updating the docs, causing Fi.CI.DOCS to start failing.
> > 
> > Signed-off-by: Jason Ekstrand <jason@jlekstrand.net>
> > ---
> >  drivers/gpu/drm/i915/i915_cmd_parser.c | 4 +---
> >  1 file changed, 1 insertion(+), 3 deletions(-)
> > 
> > diff --git a/drivers/gpu/drm/i915/i915_cmd_parser.c b/drivers/gpu/drm/i915/i915_cmd_parser.c
> > index 322f4d5955a4f..e0403ce9ce692 100644
> > --- a/drivers/gpu/drm/i915/i915_cmd_parser.c
> > +++ b/drivers/gpu/drm/i915/i915_cmd_parser.c
> > @@ -1416,9 +1416,7 @@ static unsigned long *alloc_whitelist(u32 batch_length)
> >   * @batch_offset: byte offset in the batch at which execution starts
> >   * @batch_length: length of the commands in batch_obj
> >   * @shadow: validated copy of the batch buffer in question
> > - * @jump_whitelist: buffer preallocated with intel_engine_cmd_parser_alloc_jump_whitelist()
> > - * @shadow_map: mapping to @shadow vma
> > - * @batch_map: mapping to @batch vma
> > + * @trampoline: true if we need to trampoline into privileged execution
> 
> I was wondering if we should also return the original text, but this one
> here looks better.
> 
> 
> Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>

btw, while on it, I wouldn't mind if you squash some english fixes to
the trampoline documentation block inside this function ;)

> 
> 
> >   *
> >   * Parses the specified batch buffer looking for privilege violations as
> >   * described in the overview.
> > -- 
> > 2.31.1
> > 
> > _______________________________________________
> > Intel-gfx mailing list
> > Intel-gfx@lists.freedesktop.org
> > https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Jason Ekstrand July 20, 2021, 9:04 p.m. UTC | #3
On Tue, Jul 20, 2021 at 3:26 PM Rodrigo Vivi <rodrigo.vivi@intel.com> wrote:
>
> On Tue, Jul 20, 2021 at 04:25:21PM -0400, Rodrigo Vivi wrote:
> > On Tue, Jul 20, 2021 at 01:21:08PM -0500, Jason Ekstrand wrote:
> > > In c9d9fdbc108a ("drm/i915: Revert "drm/i915/gem: Asynchronous
> > > cmdparser""), the parameters to intel_engine_cmd_parser() were altered
> > > without updating the docs, causing Fi.CI.DOCS to start failing.
> > >
> > > Signed-off-by: Jason Ekstrand <jason@jlekstrand.net>
> > > ---
> > >  drivers/gpu/drm/i915/i915_cmd_parser.c | 4 +---
> > >  1 file changed, 1 insertion(+), 3 deletions(-)
> > >
> > > diff --git a/drivers/gpu/drm/i915/i915_cmd_parser.c b/drivers/gpu/drm/i915/i915_cmd_parser.c
> > > index 322f4d5955a4f..e0403ce9ce692 100644
> > > --- a/drivers/gpu/drm/i915/i915_cmd_parser.c
> > > +++ b/drivers/gpu/drm/i915/i915_cmd_parser.c
> > > @@ -1416,9 +1416,7 @@ static unsigned long *alloc_whitelist(u32 batch_length)
> > >   * @batch_offset: byte offset in the batch at which execution starts
> > >   * @batch_length: length of the commands in batch_obj
> > >   * @shadow: validated copy of the batch buffer in question
> > > - * @jump_whitelist: buffer preallocated with intel_engine_cmd_parser_alloc_jump_whitelist()
> > > - * @shadow_map: mapping to @shadow vma
> > > - * @batch_map: mapping to @batch vma
> > > + * @trampoline: true if we need to trampoline into privileged execution
> >
> > I was wondering if we should also return the original text, but this one
> > here looks better.
> >
> >
> > Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
>
> btw, while on it, I wouldn't mind if you squash some english fixes to
> the trampoline documentation block inside this function ;)

I don't mind at all but I'm not sure what changes you're suggesting.

> >
> >
> > >   *
> > >   * Parses the specified batch buffer looking for privilege violations as
> > >   * described in the overview.
> > > --
> > > 2.31.1
> > >
> > > _______________________________________________
> > > Intel-gfx mailing list
> > > Intel-gfx@lists.freedesktop.org
> > > https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Rodrigo Vivi July 21, 2021, 10:05 a.m. UTC | #4
On Tue, Jul 20, 2021 at 04:04:59PM -0500, Jason Ekstrand wrote:
> On Tue, Jul 20, 2021 at 3:26 PM Rodrigo Vivi <rodrigo.vivi@intel.com> wrote:
> >
> > On Tue, Jul 20, 2021 at 04:25:21PM -0400, Rodrigo Vivi wrote:
> > > On Tue, Jul 20, 2021 at 01:21:08PM -0500, Jason Ekstrand wrote:
> > > > In c9d9fdbc108a ("drm/i915: Revert "drm/i915/gem: Asynchronous
> > > > cmdparser""), the parameters to intel_engine_cmd_parser() were altered
> > > > without updating the docs, causing Fi.CI.DOCS to start failing.
> > > >
> > > > Signed-off-by: Jason Ekstrand <jason@jlekstrand.net>
> > > > ---
> > > >  drivers/gpu/drm/i915/i915_cmd_parser.c | 4 +---
> > > >  1 file changed, 1 insertion(+), 3 deletions(-)
> > > >
> > > > diff --git a/drivers/gpu/drm/i915/i915_cmd_parser.c b/drivers/gpu/drm/i915/i915_cmd_parser.c
> > > > index 322f4d5955a4f..e0403ce9ce692 100644
> > > > --- a/drivers/gpu/drm/i915/i915_cmd_parser.c
> > > > +++ b/drivers/gpu/drm/i915/i915_cmd_parser.c
> > > > @@ -1416,9 +1416,7 @@ static unsigned long *alloc_whitelist(u32 batch_length)
> > > >   * @batch_offset: byte offset in the batch at which execution starts
> > > >   * @batch_length: length of the commands in batch_obj
> > > >   * @shadow: validated copy of the batch buffer in question
> > > > - * @jump_whitelist: buffer preallocated with intel_engine_cmd_parser_alloc_jump_whitelist()
> > > > - * @shadow_map: mapping to @shadow vma
> > > > - * @batch_map: mapping to @batch vma
> > > > + * @trampoline: true if we need to trampoline into privileged execution
> > >
> > > I was wondering if we should also return the original text, but this one
> > > here looks better.
> > >
> > >
> > > Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
> >
> > btw, while on it, I wouldn't mind if you squash some english fixes to
> > the trampoline documentation block inside this function ;)
> 
> I don't mind at all but I'm not sure what changes you're suggesting.

nevermind...
It was just my broke english that didn't know the inversion on the "only if"


> 
> > >
> > >
> > > >   *
> > > >   * Parses the specified batch buffer looking for privilege violations as
> > > >   * described in the overview.
> > > > --
> > > > 2.31.1
> > > >
> > > > _______________________________________________
> > > > Intel-gfx mailing list
> > > > Intel-gfx@lists.freedesktop.org
> > > > https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Jason Ekstrand July 21, 2021, 3:25 p.m. UTC | #5
Would you mind pushing?  I still don't have those magic powers. :-)

--Jason

On Wed, Jul 21, 2021 at 5:05 AM Rodrigo Vivi <rodrigo.vivi@intel.com> wrote:
>
> On Tue, Jul 20, 2021 at 04:04:59PM -0500, Jason Ekstrand wrote:
> > On Tue, Jul 20, 2021 at 3:26 PM Rodrigo Vivi <rodrigo.vivi@intel.com> wrote:
> > >
> > > On Tue, Jul 20, 2021 at 04:25:21PM -0400, Rodrigo Vivi wrote:
> > > > On Tue, Jul 20, 2021 at 01:21:08PM -0500, Jason Ekstrand wrote:
> > > > > In c9d9fdbc108a ("drm/i915: Revert "drm/i915/gem: Asynchronous
> > > > > cmdparser""), the parameters to intel_engine_cmd_parser() were altered
> > > > > without updating the docs, causing Fi.CI.DOCS to start failing.
> > > > >
> > > > > Signed-off-by: Jason Ekstrand <jason@jlekstrand.net>
> > > > > ---
> > > > >  drivers/gpu/drm/i915/i915_cmd_parser.c | 4 +---
> > > > >  1 file changed, 1 insertion(+), 3 deletions(-)
> > > > >
> > > > > diff --git a/drivers/gpu/drm/i915/i915_cmd_parser.c b/drivers/gpu/drm/i915/i915_cmd_parser.c
> > > > > index 322f4d5955a4f..e0403ce9ce692 100644
> > > > > --- a/drivers/gpu/drm/i915/i915_cmd_parser.c
> > > > > +++ b/drivers/gpu/drm/i915/i915_cmd_parser.c
> > > > > @@ -1416,9 +1416,7 @@ static unsigned long *alloc_whitelist(u32 batch_length)
> > > > >   * @batch_offset: byte offset in the batch at which execution starts
> > > > >   * @batch_length: length of the commands in batch_obj
> > > > >   * @shadow: validated copy of the batch buffer in question
> > > > > - * @jump_whitelist: buffer preallocated with intel_engine_cmd_parser_alloc_jump_whitelist()
> > > > > - * @shadow_map: mapping to @shadow vma
> > > > > - * @batch_map: mapping to @batch vma
> > > > > + * @trampoline: true if we need to trampoline into privileged execution
> > > >
> > > > I was wondering if we should also return the original text, but this one
> > > > here looks better.
> > > >
> > > >
> > > > Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
> > >
> > > btw, while on it, I wouldn't mind if you squash some english fixes to
> > > the trampoline documentation block inside this function ;)
> >
> > I don't mind at all but I'm not sure what changes you're suggesting.
>
> nevermind...
> It was just my broke english that didn't know the inversion on the "only if"
>
>
> >
> > > >
> > > >
> > > > >   *
> > > > >   * Parses the specified batch buffer looking for privilege violations as
> > > > >   * described in the overview.
> > > > > --
> > > > > 2.31.1
> > > > >
> > > > > _______________________________________________
> > > > > Intel-gfx mailing list
> > > > > Intel-gfx@lists.freedesktop.org
> > > > > https://lists.freedesktop.org/mailman/listinfo/intel-gfx
Rodrigo Vivi July 21, 2021, 3:52 p.m. UTC | #6
On Wed, Jul 21, 2021 at 10:25:27AM -0500, Jason Ekstrand wrote:
> Would you mind pushing?  I still don't have those magic powers. :-)
> 
> --Jason
> 
> On Wed, Jul 21, 2021 at 5:05 AM Rodrigo Vivi <rodrigo.vivi@intel.com> wrote:
> >
> > On Tue, Jul 20, 2021 at 04:04:59PM -0500, Jason Ekstrand wrote:
> > > On Tue, Jul 20, 2021 at 3:26 PM Rodrigo Vivi <rodrigo.vivi@intel.com> wrote:
> > > >
> > > > On Tue, Jul 20, 2021 at 04:25:21PM -0400, Rodrigo Vivi wrote:
> > > > > On Tue, Jul 20, 2021 at 01:21:08PM -0500, Jason Ekstrand wrote:
> > > > > > In c9d9fdbc108a ("drm/i915: Revert "drm/i915/gem: Asynchronous

while pushing I noticed this hash was for the patch in the drm-intel-fixes
branch. I updated to the right one in drm-intel-gt-next.

Then I also added the Fixes tag and cherry-picked to drm-intel-fixes branch.

Everything pushed now.

Thanks for the patch,
Rodrigo.

> > > > > > cmdparser""), the parameters to intel_engine_cmd_parser() were altered
> > > > > > without updating the docs, causing Fi.CI.DOCS to start failing.
> > > > > >
> > > > > > Signed-off-by: Jason Ekstrand <jason@jlekstrand.net>
> > > > > > ---
> > > > > >  drivers/gpu/drm/i915/i915_cmd_parser.c | 4 +---
> > > > > >  1 file changed, 1 insertion(+), 3 deletions(-)
> > > > > >
> > > > > > diff --git a/drivers/gpu/drm/i915/i915_cmd_parser.c b/drivers/gpu/drm/i915/i915_cmd_parser.c
> > > > > > index 322f4d5955a4f..e0403ce9ce692 100644
> > > > > > --- a/drivers/gpu/drm/i915/i915_cmd_parser.c
> > > > > > +++ b/drivers/gpu/drm/i915/i915_cmd_parser.c
> > > > > > @@ -1416,9 +1416,7 @@ static unsigned long *alloc_whitelist(u32 batch_length)
> > > > > >   * @batch_offset: byte offset in the batch at which execution starts
> > > > > >   * @batch_length: length of the commands in batch_obj
> > > > > >   * @shadow: validated copy of the batch buffer in question
> > > > > > - * @jump_whitelist: buffer preallocated with intel_engine_cmd_parser_alloc_jump_whitelist()
> > > > > > - * @shadow_map: mapping to @shadow vma
> > > > > > - * @batch_map: mapping to @batch vma
> > > > > > + * @trampoline: true if we need to trampoline into privileged execution
> > > > >
> > > > > I was wondering if we should also return the original text, but this one
> > > > > here looks better.
> > > > >
> > > > >
> > > > > Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
> > > >
> > > > btw, while on it, I wouldn't mind if you squash some english fixes to
> > > > the trampoline documentation block inside this function ;)
> > >
> > > I don't mind at all but I'm not sure what changes you're suggesting.
> >
> > nevermind...
> > It was just my broke english that didn't know the inversion on the "only if"
> >
> >
> > >
> > > > >
> > > > >
> > > > > >   *
> > > > > >   * Parses the specified batch buffer looking for privilege violations as
> > > > > >   * described in the overview.
> > > > > > --
> > > > > > 2.31.1
> > > > > >
> > > > > > _______________________________________________
> > > > > > Intel-gfx mailing list
> > > > > > Intel-gfx@lists.freedesktop.org
> > > > > > https://lists.freedesktop.org/mailman/listinfo/intel-gfx
diff mbox series

Patch

diff --git a/drivers/gpu/drm/i915/i915_cmd_parser.c b/drivers/gpu/drm/i915/i915_cmd_parser.c
index 322f4d5955a4f..e0403ce9ce692 100644
--- a/drivers/gpu/drm/i915/i915_cmd_parser.c
+++ b/drivers/gpu/drm/i915/i915_cmd_parser.c
@@ -1416,9 +1416,7 @@  static unsigned long *alloc_whitelist(u32 batch_length)
  * @batch_offset: byte offset in the batch at which execution starts
  * @batch_length: length of the commands in batch_obj
  * @shadow: validated copy of the batch buffer in question
- * @jump_whitelist: buffer preallocated with intel_engine_cmd_parser_alloc_jump_whitelist()
- * @shadow_map: mapping to @shadow vma
- * @batch_map: mapping to @batch vma
+ * @trampoline: true if we need to trampoline into privileged execution
  *
  * Parses the specified batch buffer looking for privilege violations as
  * described in the overview.