* [PATCH v2 00/29] Change wildcards on ABI files
@ 2021-09-14 14:32 Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 07/29] ABI: sysfs-class-cxl: place "not in a guest" at description Mauro Carvalho Chehab
0 siblings, 1 reply; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2021-09-14 14:32 UTC (permalink / raw)
To: Greg Kroah-Hartman, Linux Doc Mailing List
Cc: Heikki Krogerus, Kees Cook, Jonathan Corbet,
Mauro Carvalho Chehab, netdev, Richard Cochran, Anton Vorontsov,
linux-kernel, Johan Hovold, Tony Luck, Colin Cross, linux-usb,
linuxppc-dev, Peter Rosin
The ABI files are meant to be parsed via a script (scripts/get_abi.pl).
A new improvement on it will allow it to help to detect if an ABI description
is missing, or if the What: field won't match the actual location of the symbol.
In order for get_abi.pl to convert What: into regex, changes are needed on
existing ABI files, as the conversion should not be ambiguous.
One alternative would be to convert everything into regexes, but this
would generate a huge amount of patches/changes. So, instead, let's
touch only the ABI files that aren't following the de-facto wildcard
standards already found on most of the ABI files, e. g.:
/.../
*
<foo>
(option1|option2)
X
Y
Z
[0-9] (and variants)
A couple of the patches here came from v1, but most of the patches were
written to address things like rcN, where N is a wildcard.
We can't teach get_abi.pl to use an uppercase "N" letter to be a wildcard,
as the USB ABI already uses "N" inside some of their symbols, like
bNumEndpoints.
Mauro Carvalho Chehab (29):
ABI: sysfs-bus-usb: better document variable argument
ABI: sysfs-tty: better document module name parameter
ABI: sysfs-kernel-slab: use a wildcard for the cache name
ABI: security: fix location for evm and ima_policy
ABI: sysfs-class-tpm: use wildcards for pcr-* nodes
ABI: sysfs-bus-rapidio: use wildcards on What definitions
ABI: sysfs-class-cxl: place "not in a guest" at description
ABI: sysfs-class-devfreq-event: use the right wildcards on What
ABI: sysfs-class-mic: use the right wildcards on What definitions
ABI: pstore: Fix What field
ABI: sysfs-class-typec: fix a bad What field
ABI: sysfs-ata: use a proper wildcard for ata_*
ABI: sysfs-class-infiniband: use wildcards on What definitions
ABI: sysfs-bus-pci: use wildcards on What definitions
ABI: sysfs-bus-soundwire-master: use wildcards on What definitions
ABI: sysfs-bus-soundwire-slave: use wildcards on What definitions
ABI: sysfs-class-gnss: use wildcards on What definitions
ABI: sysfs-class-mei: use wildcards on What definitions
ABI: sysfs-class-mux: use wildcards on What definitions
ABI: sysfs-class-pwm: use wildcards on What definitions
ABI: sysfs-class-rc: use wildcards on What definitions
ABI: sysfs-class-rc-nuvoton: use wildcards on What definitions
ABI: sysfs-class-uwb_rc: use wildcards on What definitions
ABI: sysfs-class-uwb_rc-wusbhc: use wildcards on What definitions
ABI: sysfs-devices-platform-dock: use wildcards on What definitions
ABI: sysfs-devices-system-cpu: use wildcards on What definitions
ABI: sysfs-firmware-efi-esrt: use wildcards on What definitions
ABI: sysfs-platform-sst-atom: use wildcards on What definitions
ABI: sysfs-ptp: use wildcards on What definitions
.../ABI/stable/sysfs-class-infiniband | 64 ++++++-------
Documentation/ABI/stable/sysfs-class-tpm | 2 +-
Documentation/ABI/testing/evm | 4 +-
Documentation/ABI/testing/ima_policy | 2 +-
Documentation/ABI/testing/pstore | 3 +-
Documentation/ABI/testing/sysfs-ata | 2 +-
Documentation/ABI/testing/sysfs-bus-pci | 2 +-
Documentation/ABI/testing/sysfs-bus-rapidio | 32 +++----
.../ABI/testing/sysfs-bus-soundwire-master | 2 +-
.../ABI/testing/sysfs-bus-soundwire-slave | 2 +-
Documentation/ABI/testing/sysfs-bus-usb | 16 ++--
Documentation/ABI/testing/sysfs-class-cxl | 15 ++-
.../ABI/testing/sysfs-class-devfreq-event | 12 +--
Documentation/ABI/testing/sysfs-class-gnss | 2 +-
Documentation/ABI/testing/sysfs-class-mei | 18 ++--
Documentation/ABI/testing/sysfs-class-mic | 24 ++---
Documentation/ABI/testing/sysfs-class-mux | 2 +-
Documentation/ABI/testing/sysfs-class-pwm | 20 ++--
Documentation/ABI/testing/sysfs-class-rc | 14 +--
.../ABI/testing/sysfs-class-rc-nuvoton | 2 +-
Documentation/ABI/testing/sysfs-class-typec | 2 +-
Documentation/ABI/testing/sysfs-class-uwb_rc | 26 ++---
.../ABI/testing/sysfs-class-uwb_rc-wusbhc | 10 +-
.../ABI/testing/sysfs-devices-platform-dock | 10 +-
.../ABI/testing/sysfs-devices-system-cpu | 16 ++--
.../ABI/testing/sysfs-firmware-efi-esrt | 16 ++--
Documentation/ABI/testing/sysfs-kernel-slab | 94 +++++++++----------
.../ABI/testing/sysfs-platform-sst-atom | 2 +-
Documentation/ABI/testing/sysfs-ptp | 30 +++---
Documentation/ABI/testing/sysfs-tty | 32 +++----
30 files changed, 242 insertions(+), 236 deletions(-)
--
2.31.1
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH v2 07/29] ABI: sysfs-class-cxl: place "not in a guest" at description
2021-09-14 14:32 [PATCH v2 00/29] Change wildcards on ABI files Mauro Carvalho Chehab
@ 2021-09-14 14:32 ` Mauro Carvalho Chehab
2021-09-15 3:33 ` Andrew Donnellan
0 siblings, 1 reply; 3+ messages in thread
From: Mauro Carvalho Chehab @ 2021-09-14 14:32 UTC (permalink / raw)
To: Greg Kroah-Hartman, Linux Doc Mailing List
Cc: Andrew Donnellan, Jonathan Corbet, Mauro Carvalho Chehab,
linux-kernel, Frederic Barrat, linuxppc-dev
The What: field should have just the location of the ABI.
Anything else should be inside the description.
This fixes its parsing by get_abi.pl script.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/ABI/testing/sysfs-class-cxl | 15 ++++++++++-----
1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/Documentation/ABI/testing/sysfs-class-cxl b/Documentation/ABI/testing/sysfs-class-cxl
index 818f55970efb..3c77677e0ca7 100644
--- a/Documentation/ABI/testing/sysfs-class-cxl
+++ b/Documentation/ABI/testing/sysfs-class-cxl
@@ -166,10 +166,11 @@ Description: read only
Decimal value of the Per Process MMIO space length.
Users: https://github.com/ibm-capi/libcxl
-What: /sys/class/cxl/<afu>m/pp_mmio_off (not in a guest)
+What: /sys/class/cxl/<afu>m/pp_mmio_off
Date: September 2014
Contact: linuxppc-dev@lists.ozlabs.org
Description: read only
+ (not in a guest)
Decimal value of the Per Process MMIO space offset.
Users: https://github.com/ibm-capi/libcxl
@@ -190,28 +191,31 @@ Description: read only
Identifies the revision level of the PSL.
Users: https://github.com/ibm-capi/libcxl
-What: /sys/class/cxl/<card>/base_image (not in a guest)
+What: /sys/class/cxl/<card>/base_image
Date: September 2014
Contact: linuxppc-dev@lists.ozlabs.org
Description: read only
+ (not in a guest)
Identifies the revision level of the base image for devices
that support loadable PSLs. For FPGAs this field identifies
the image contained in the on-adapter flash which is loaded
during the initial program load.
Users: https://github.com/ibm-capi/libcxl
-What: /sys/class/cxl/<card>/image_loaded (not in a guest)
+What: /sys/class/cxl/<card>/image_loaded
Date: September 2014
Contact: linuxppc-dev@lists.ozlabs.org
Description: read only
+ (not in a guest)
Will return "user" or "factory" depending on the image loaded
onto the card.
Users: https://github.com/ibm-capi/libcxl
-What: /sys/class/cxl/<card>/load_image_on_perst (not in a guest)
+What: /sys/class/cxl/<card>/load_image_on_perst
Date: December 2014
Contact: linuxppc-dev@lists.ozlabs.org
Description: read/write
+ (not in a guest)
Valid entries are "none", "user", and "factory".
"none" means PERST will not cause image to be loaded to the
card. A power cycle is required to load the image.
@@ -235,10 +239,11 @@ Description: write only
contexts on the card AFUs.
Users: https://github.com/ibm-capi/libcxl
-What: /sys/class/cxl/<card>/perst_reloads_same_image (not in a guest)
+What: /sys/class/cxl/<card>/perst_reloads_same_image
Date: July 2015
Contact: linuxppc-dev@lists.ozlabs.org
Description: read/write
+ (not in a guest)
Trust that when an image is reloaded via PERST, it will not
have changed.
--
2.31.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v2 07/29] ABI: sysfs-class-cxl: place "not in a guest" at description
2021-09-14 14:32 ` [PATCH v2 07/29] ABI: sysfs-class-cxl: place "not in a guest" at description Mauro Carvalho Chehab
@ 2021-09-15 3:33 ` Andrew Donnellan
0 siblings, 0 replies; 3+ messages in thread
From: Andrew Donnellan @ 2021-09-15 3:33 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Greg Kroah-Hartman, Linux Doc Mailing List
Cc: Frederic Barrat, linuxppc-dev, linux-kernel, Jonathan Corbet
On 15/9/21 12:32 am, Mauro Carvalho Chehab wrote:
> The What: field should have just the location of the ABI.
> Anything else should be inside the description.
>
> This fixes its parsing by get_abi.pl script.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Looks fine to me.
Acked-by: Andrew Donnellan <ajd@linux.ibm.com>
> ---
> Documentation/ABI/testing/sysfs-class-cxl | 15 ++++++++++-----
> 1 file changed, 10 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-class-cxl b/Documentation/ABI/testing/sysfs-class-cxl
> index 818f55970efb..3c77677e0ca7 100644
> --- a/Documentation/ABI/testing/sysfs-class-cxl
> +++ b/Documentation/ABI/testing/sysfs-class-cxl
> @@ -166,10 +166,11 @@ Description: read only
> Decimal value of the Per Process MMIO space length.
> Users: https://github.com/ibm-capi/libcxl
>
> -What: /sys/class/cxl/<afu>m/pp_mmio_off (not in a guest)
> +What: /sys/class/cxl/<afu>m/pp_mmio_off
> Date: September 2014
> Contact: linuxppc-dev@lists.ozlabs.org
> Description: read only
> + (not in a guest)
> Decimal value of the Per Process MMIO space offset.
> Users: https://github.com/ibm-capi/libcxl
>
> @@ -190,28 +191,31 @@ Description: read only
> Identifies the revision level of the PSL.
> Users: https://github.com/ibm-capi/libcxl
>
> -What: /sys/class/cxl/<card>/base_image (not in a guest)
> +What: /sys/class/cxl/<card>/base_image
> Date: September 2014
> Contact: linuxppc-dev@lists.ozlabs.org
> Description: read only
> + (not in a guest)
> Identifies the revision level of the base image for devices
> that support loadable PSLs. For FPGAs this field identifies
> the image contained in the on-adapter flash which is loaded
> during the initial program load.
> Users: https://github.com/ibm-capi/libcxl
>
> -What: /sys/class/cxl/<card>/image_loaded (not in a guest)
> +What: /sys/class/cxl/<card>/image_loaded
> Date: September 2014
> Contact: linuxppc-dev@lists.ozlabs.org
> Description: read only
> + (not in a guest)
> Will return "user" or "factory" depending on the image loaded
> onto the card.
> Users: https://github.com/ibm-capi/libcxl
>
> -What: /sys/class/cxl/<card>/load_image_on_perst (not in a guest)
> +What: /sys/class/cxl/<card>/load_image_on_perst
> Date: December 2014
> Contact: linuxppc-dev@lists.ozlabs.org
> Description: read/write
> + (not in a guest)
> Valid entries are "none", "user", and "factory".
> "none" means PERST will not cause image to be loaded to the
> card. A power cycle is required to load the image.
> @@ -235,10 +239,11 @@ Description: write only
> contexts on the card AFUs.
> Users: https://github.com/ibm-capi/libcxl
>
> -What: /sys/class/cxl/<card>/perst_reloads_same_image (not in a guest)
> +What: /sys/class/cxl/<card>/perst_reloads_same_image
> Date: July 2015
> Contact: linuxppc-dev@lists.ozlabs.org
> Description: read/write
> + (not in a guest)
> Trust that when an image is reloaded via PERST, it will not
> have changed.
>
>
--
Andrew Donnellan OzLabs, ADL Canberra
ajd@linux.ibm.com IBM Australia Limited
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-09-15 3:34 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-09-14 14:32 [PATCH v2 00/29] Change wildcards on ABI files Mauro Carvalho Chehab
2021-09-14 14:32 ` [PATCH v2 07/29] ABI: sysfs-class-cxl: place "not in a guest" at description Mauro Carvalho Chehab
2021-09-15 3:33 ` Andrew Donnellan
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).