Intel-XE Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Aravind Iddamsetty <aravind.iddamsetty@linux.intel.com>
To: Lucas De Marchi <lucas.demarchi@intel.com>,
	Francois Dugast <francois.dugast@intel.com>,
	Himal Prasad Ghimiray <himal.prasad.ghimiray@intel.com>
Cc: intel-xe@lists.freedesktop.org, Rodrigo Vivi <rodrigo.vivi@intel.com>
Subject: Re: [PATCH v1 08/14] drm/xe/uapi: Order sections
Date: Fri, 15 Dec 2023 09:36:49 +0530	[thread overview]
Message-ID: <0998a123-7852-49ab-941a-7b3c9acb2b11@linux.intel.com> (raw)
In-Reply-To: <6bqke2ogy77tiprn6hifcyy57yclahjpi4ueeuatxmtfuvmwt7@qypor7sctqx7>

On 12/15/23 02:27, Lucas De Marchi wrote:

Hi  Lucas,

> On Thu, Dec 07, 2023 at 01:50:03PM +0000, Francois Dugast wrote:
>> From: Rodrigo Vivi <rodrigo.vivi@intel.com>
>>
>> This patch doesn't modify any text or uapi entries themselves.
>> It only move things up and down aiming a better organization of the uAPI.
>>
>> While fixing the documentation I noticed that query_engine_cs_cycles
>> was in the middle of the memory_region info. Then I noticed more
>> mismatches on the order when compared to the order of the IOCTL
>> and QUERY entries declaration. So this patch aims to bring some
>> order to the uAPI so it gets easier to read and the documentation
>> generated in the end is able to tell a consistent story.
>>
>> Overall order:
>>
>> 1. IOCTL definition
>> 2. Extension definition and helper structs
>> 3. IOCTL's Query structs in the order of the Query's entries.
>> 4. The rest of IOCTL structs in the order of IOCTL declaration.
>> 5. uEvents
>> 6. PMU
>>
>> Signed-off-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
>> Signed-off-by: Francois Dugast <francois.dugast@intel.com>
>> ---
>> include/uapi/drm/xe_drm.h | 255 ++++++++++++++++++++------------------
>> 1 file changed, 132 insertions(+), 123 deletions(-)
>>
>> diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
>> index f9178fe024a5..b36f3bd53611 100644
>> --- a/include/uapi/drm/xe_drm.h
>> +++ b/include/uapi/drm/xe_drm.h
>> @@ -12,19 +12,51 @@
>> extern "C" {
>> #endif
>>
<snip>
>> +/**
>> + * DOC: uevent generated by xe on its pci node.
>> + *
>> + * DRM_XE_RESET_FAILED_UEVENT - Event is generated when attempt to reset gt
>> + * fails. The value supplied with the event is always "NEEDS_RESET".
>> + * Additional information supplied is tile id and gt id of the gt unit for
>> + * which reset has failed.
>> + */
>> +#define DRM_XE_RESET_FAILED_UEVENT "DEVICE_STATUS"
>
> Unrelated to this.... Aravind has a patch renaming this to make it
> future proof. We will need to either rename it now, or remove and leave
> its addition for later.

it was actual Himal who sent a patch to rework this.

@Himal what's your plan on this.

Thanks,
Aravind.
>
>
> Reviewed-by: Lucas De Marchi <lucas.demarchi@intel.com>
>
>
> Lucas De Marchi
>
>> /**
>>  * DOC: XE PMU event config IDs
>>  *
>> -- 
>> 2.34.1
>>

  reply	other threads:[~2023-12-15  4:04 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-07 13:49 [PATCH v1 00/14] uAPI Alignment - Documentation Francois Dugast
2023-12-07 13:49 ` [PATCH v1 01/14] drm/xe/uapi: Add a comment to each struct Francois Dugast
2023-12-14 14:17   ` Rodrigo Vivi
2023-12-07 13:49 ` [PATCH v1 02/14] drm/xe/uapi: Add missing documentation for struct members Francois Dugast
2023-12-14 14:17   ` Rodrigo Vivi
2023-12-07 13:49 ` [PATCH v1 03/14] drm/xe/uapi: Document use of size in drm_xe_device_query Francois Dugast
2023-12-13 18:16   ` Rodrigo Vivi
2023-12-07 13:49 ` [PATCH v1 04/14] drm/xe/uapi: Document drm_xe_query_config keys Francois Dugast
2023-12-13 18:14   ` Rodrigo Vivi
2023-12-07 13:50 ` [PATCH v1 05/14] drm/xe/uapi: Document DRM_XE_DEVICE_QUERY_HWCONFIG Francois Dugast
2023-12-13 18:14   ` Rodrigo Vivi
2023-12-07 13:50 ` [PATCH v1 06/14] drm/xe/uapi: Make constant comments visible in kernel doc Francois Dugast
2023-12-13 18:16   ` Rodrigo Vivi
2023-12-07 13:50 ` [PATCH v1 07/14] drm/xe/uapi: Replace BO with GEM in documentation Francois Dugast
2023-12-07 14:49   ` Matthew Auld
2023-12-13 18:27     ` Rodrigo Vivi
2023-12-07 13:50 ` [PATCH v1 08/14] drm/xe/uapi: Order sections Francois Dugast
2023-12-14 20:57   ` Lucas De Marchi
2023-12-15  4:06     ` Aravind Iddamsetty [this message]
2023-12-07 13:50 ` [PATCH v1 09/14] drm/xe/uapi: More uAPI documentation additions and cosmetic updates Francois Dugast
2023-12-14 16:45   ` Lucas De Marchi
2023-12-14 19:40     ` Francois Dugast
2023-12-07 13:50 ` [PATCH v1 10/14] drm/xe/uapi: Document the memory_region bitmask Francois Dugast
2023-12-14 21:23   ` Lucas De Marchi
2023-12-07 13:50 ` [PATCH v1 11/14] drm/xe/uapi: Add block diagram of a device Francois Dugast
2023-12-07 14:01   ` Souza, Jose
2023-12-07 13:50 ` [PATCH v1 12/14] drm/xe/uapi: Add examples of user space code Francois Dugast
2023-12-13 18:26   ` Rodrigo Vivi
2023-12-07 13:50 ` [PATCH v1 13/14] drm/xe/uapi: Move CPU_CACHING defines before doc Francois Dugast
2023-12-13 18:18   ` Rodrigo Vivi
2023-12-07 13:50 ` [PATCH v1 14/14] drm/xe/uapi: Move DRM_XE_ACC_GRANULARITY_* where they are used Francois Dugast
2023-12-13 18:17   ` Rodrigo Vivi
2023-12-07 16:42 ` ✓ CI.Patch_applied: success for uAPI Alignment - Documentation Patchwork
2023-12-07 16:42 ` ✗ CI.checkpatch: warning " Patchwork
2023-12-07 16:44 ` ✓ CI.KUnit: success " Patchwork
2023-12-07 16:51 ` ✓ CI.Build: " Patchwork
2023-12-07 16:51 ` ✓ CI.Hooks: " Patchwork
2023-12-07 16:53 ` ✓ CI.checksparse: " Patchwork
2023-12-07 17:28 ` ✓ CI.BAT: " Patchwork

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=0998a123-7852-49ab-941a-7b3c9acb2b11@linux.intel.com \
    --to=aravind.iddamsetty@linux.intel.com \
    --cc=francois.dugast@intel.com \
    --cc=himal.prasad.ghimiray@intel.com \
    --cc=intel-xe@lists.freedesktop.org \
    --cc=lucas.demarchi@intel.com \
    --cc=rodrigo.vivi@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox