[v2] Documentation: Document user_events ioctl code

[PATCH v2] Documentation: Document user_events ioctl code

Posted by Beau Belgrave 1 year, 6 months ago

The user events trace subsystem uses the 0x2A/'*' code for ioctls. These
are published via the uapi/linux/user_events.h header file.

Add a line indicating user events as the owner of the 0x2A/'*' code and
reserve the first 32 sequence numbers.

Signed-off-by: Beau Belgrave <beaub@linux.microsoft.com>
---
 V2 Changes: Reserved first 32 sequence numbers for growth.

 Documentation/userspace-api/ioctl/ioctl-number.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/userspace-api/ioctl/ioctl-number.rst b/Documentation/userspace-api/ioctl/ioctl-number.rst
index a141e8e65c5d..d953549f0b2b 100644
--- a/Documentation/userspace-api/ioctl/ioctl-number.rst
+++ b/Documentation/userspace-api/ioctl/ioctl-number.rst
@@ -97,6 +97,8 @@ Code  Seq#    Include File                                           Comments
 '%'   00-0F  include/uapi/linux/stm.h                                System Trace Module subsystem
                                                                      <mailto:alexander.shishkin@linux.intel.com>
 '&'   00-07  drivers/firewire/nosy-user.h
+'*'   00-1F  uapi/linux/user_events.h                                User Events Subsystem
+                                                                     <mailto:linux-trace-kernel@vger.kernel.org>
 '1'   00-1F  linux/timepps.h                                         PPS kit from Ulrich Windl
                                                                      <ftp://ftp.de.kernel.org/pub/linux/daemons/ntp/PPS/>
 '2'   01-04  linux/i2o.h
-- 
2.34.1

Re: [PATCH v2] Documentation: Document user_events ioctl code

Posted by Jonathan Corbet 1 year, 6 months ago

Beau Belgrave <beaub@linux.microsoft.com> writes:

> The user events trace subsystem uses the 0x2A/'*' code for ioctls. These
> are published via the uapi/linux/user_events.h header file.
>
> Add a line indicating user events as the owner of the 0x2A/'*' code and
> reserve the first 32 sequence numbers.
>
> Signed-off-by: Beau Belgrave <beaub@linux.microsoft.com>
> ---
>  V2 Changes: Reserved first 32 sequence numbers for growth.
>
>  Documentation/userspace-api/ioctl/ioctl-number.rst | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/Documentation/userspace-api/ioctl/ioctl-number.rst b/Documentation/userspace-api/ioctl/ioctl-number.rst
> index a141e8e65c5d..d953549f0b2b 100644
> --- a/Documentation/userspace-api/ioctl/ioctl-number.rst
> +++ b/Documentation/userspace-api/ioctl/ioctl-number.rst
> @@ -97,6 +97,8 @@ Code  Seq#    Include File                                           Comments
>  '%'   00-0F  include/uapi/linux/stm.h                                System Trace Module subsystem
>                                                                       <mailto:alexander.shishkin@linux.intel.com>
>  '&'   00-07  drivers/firewire/nosy-user.h
> +'*'   00-1F  uapi/linux/user_events.h                                User Events Subsystem
> +                                                                     <mailto:linux-trace-kernel@vger.kernel.org>

I've applied this, thanks.

jon