- 28 Sep, 2021 23 commits
-
-
Mauro Carvalho Chehab authored
There are some PCI ABI that aren't shown under: /sys/bus/pci/drivers/.../ Because they're registered with a different class. That's the case of, for instance: /sys/bus/i2c/drivers/CHT Whiskey Cove PMIC/unbind This one is not present under /sys/bus/pci: $ find /sys/bus/pci -name 'CHT Whiskey Cove PMIC' Although clearly this is provided by a PCI driver: /sys/devices/pci0000:00/0000:00:02.0/i2c-4/subsystem/drivers/CHT Whiskey Cove PMIC/unbind So, add an altertate What location in order to match bind/unbind to such devices. Signed-off-by:
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/15ba8c07f1b0fd7359106920c8e34a7b9af7aea6.1632750608.git.mchehab+huawei@kernel.orgSigned-off-by:
Greg Kroah-Hartman <gregkh@linuxfoundation.org>
-
Mauro Carvalho Chehab authored
Those files were added back in Apr 2010, but there's no documentation for them yet. Fixes: c92445fa ("PM / Runtime: Add sysfs debug files") Signed-off-by:
-
Mauro Carvalho Chehab authored
Document three slab stats that were added in 2011 and 2017. Fixes: 49e22585 ("slub: per cpu cache for partial pages") Fixes: 8eb8284b ("usercopy: Prepare for usercopy whitelisting") Signed-off-by:
-
Mauro Carvalho Chehab authored
This was renamed to /sys/fs/o2cb. Mark the old name as obsolete. Signed-off-by:
-
Mauro Carvalho Chehab authored
Even being available since 2005, there's no documentation for modalias. Acked-by:
Bjorn Helgaas <bhelgaas@google.com> Signed-off-by:
-
Mauro Carvalho Chehab authored
Changeset 23681e47 ("[PATCH] Driver core: allow struct device to have a dev_t") added a /dev ABI for /sys/devices. Document it. Signed-off-by:
-
Mauro Carvalho Chehab authored
Changeset 8d4b9d1b ("PM / Runtime: Add runtime PM statistics (v3)") added runtime_active_time and runtime_suspended_time, in order to allow powertop to identify the amount of time a device is active/suspended. Add an ABI description for those. Signed-off-by:
-
Mauro Carvalho Chehab authored
Despite being an old ABI, present on all modules, its documentation is missing. Add it, based on the original commit. Signed-off-by:
-
Mauro Carvalho Chehab authored
Changeset c988d2b2 ("[PATCH] modules: add version and srcversion to sysfs") added version and srcversion ABI to modules. Document them. Signed-off-by:
-
Mauro Carvalho Chehab authored
Instead of placing almost everything there as a text, use the proper What: for each component of the ABI. This allows it to be better documented and parsed by get_abi.pl. While here, use wildcards for MODULENAME. Signed-off-by:
-
Mauro Carvalho Chehab authored
Originally, get_abi.pl was using spaces to separate What: parameters, but there are several references that declare things like: /sys/class/powercap/.../<power zone>/enabled So, the logic was changes in order to properly address it. That broke the second What added by Changeset 18e49b30 ("ABI: security: fix location for evm and ima_policy"). As the only file that defines multiple What: at the same line is this file, let's move the second What: to a separate line. Fixes: 18e49b30 ("ABI: security: fix location for evm and ima_policy") Fixes: ab9c1480 ("scripts: get_abi.pl: Better handle multiple What parameters") Signed-off-by:
-
Mauro Carvalho Chehab authored
As parsing the sysfs entries can take a long time, add progress information. The progress logic will update the stats on every second, or on 1% steps of the progress. When STDERR is a console, it will use a single line, using a VT-100 command to erase the line before rewriting it. Otherwise, it will put one message on a separate line. That would help to identify what parts of sysfs checking that it is taking more time to process. Signed-off-by:
-
Mauro Carvalho Chehab authored
On undefined checks, use STDOUT only for the not found entries. All other data (search-string and show-hints) is printed at STDERR. Signed-off-by:
-
Mauro Carvalho Chehab authored
The current highlight schema is not working properly. So, use, instead, Pod::Text. While here, also update the copyright in order to reflect the latest changes and the e-mail I'm currently using. Signed-off-by:
-
Mauro Carvalho Chehab authored
It doesn't make any sense to parse ABI entries under /sys/firmware, as those are either specified by ACPI specs or by Documentation/devicetree. The current logic to ignore firmware entries is incomplete, as it ignores just the relative name of the file, and not its absolute name. This cause errors while parsing the symlinks. So, rewrite the logic for it to do a better job. Tested with both x86 and arm64 (HiKey970) systems. Signed-off-by:
-
Mauro Carvalho Chehab authored
The logic under graph_add_file should create, for every entry, a __name name array for all entries of the tree. If this fails, the symlink parsing will break. Add an error if this ever happens. While here, improve the output of data dumper to be more compact and to avoid displaying things like $VAR1=. Signed-off-by:
-
Mauro Carvalho Chehab authored
The ReST format requires blank lines before/after identation changes, for it to properly detect lists. Fixes: ee7abc10 ("platform/x86: intel_pmc_core: export platform global reset bits via etr3 sysfs file") Signed-off-by:
-
Mauro Carvalho Chehab authored
Changeset 70f400d4 ("driver core: Move the "removable" attribute from USB to core") added a table to the file, but not using a valid ReST format. Change it to avoid build issues when producing documentation with "make htmldocs". Fixes: 70f400d4 ("driver core: Move the "removable" attribute from USB to core") Signed-off-by:
-
Mauro Carvalho Chehab authored
Changeset af6cbe09920 ("usb: gadget: f_uac2: add volume and mute support") added some new elements to the table but didn't care enough to actually adjust the columns, causing the output to be broken as warned by Sphinx when producing the documentation. Readjust it for it to be a valid ReST table. Fixes: eaf6cbe0 ("usb: gadget: f_uac2: add volume and mute support") Signed-off-by: -
Mauro Carvalho Chehab authored
Changeset 0356e628 ("usb: gadget: f_uac1: add volume and mute support") added some new elements to the table but didn't care enough to actually adjust the columns, causing the output to be broken as warned by Sphinx when producing the documentation. Readjust it for it to be a valid ReST table. Fixes: 0356e628 ("usb: gadget: f_uac1: add volume and mute support") Signed-off-by:
-
Mauro Carvalho Chehab authored
Solve those warnings: Documentation/ABI/testing/sysfs-platform-dptf:130: WARNING: Unexpected indentation. Documentation/ABI/testing/sysfs-platform-dptf:130: WARNING: Block quote ends without a blank line; unexpected unindent. Documentation/ABI/testing/sysfs-platform-dptf:130: WARNING: Definition list ends without a blank line; unexpected unindent. Fixes: 668ce99e ("ACPI: DPTF: Additional sysfs attributes for power participant driver") Signed-off-by:
-
Mauro Carvalho Chehab authored
As described at Documentation/ABI/README doesn't contain an Attribute: field. The way sysfs ABI is supposed to work is that each different attribute would have a separate file. So, the right way to map this would be like: /sys/.../dell_privacy_supported_type/mic_mute /sys/.../dell_privacy_supported_type/camera_shutter /sys/.../dell_privacy_current_state/mic_mute /sys/.../dell_privacy_current_state/camera_shutter However, it seems to late to fix that, as this was merged already on Kernel 5.13, and a change right now would be a regression. So, instead, let's at least fix the entry to match the expected format. While here, fix the format of the contact, which is not a valid e-mail URL. This should also fix the current warnings produced when building the docs: Documentation/ABI/testing/sysfs-platform-dell-privacy-wmi:35: WARNING: Unexpected indentation. Documentation/ABI/testing/sysfs-platform-dell-privacy-wmi:2: WARNING: Unexpected indentation. Fixes: 8af9fa37 ("platform/x86: dell-privacy: Add support for Dell hardware privacy") Signed-off-by:
-
Mauro Carvalho Chehab authored
As warned, /sys/bus/iio/devices/iio:deviceX/fault_ovuv is defined 2 times: Warning: /sys/bus/iio/devices/iio:deviceX/fault_ovuv is defined 2 times: ./Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856:14 ./Documentation/ABI/testing/sysfs-bus-iio-temperature-max31865:0 The logic with joins the two entries is just places the paragraph for the second entry after the previous one. That could cause more warnings, as the produced ReST may become invalid, as in the case of this specific symbol, which ends with a table: /new_devel/v4l/docs/Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856:2: WARNING: Malformed table. No bottom table border found or no blank line after table bottom. === ======================================================= '1' The input voltage is negative or greater than VDD. '0' The input voltage is positive and less than VDD (normal state). === ======================================================= /new_devel/v4l/docs/Documentation/ABI/testing/sysfs-bus-iio-temperature-max31856:2: WARNING: Blank line required after table. Address it by adding two blank lines before joining duplicated symbols. Signed-off-by:
-
- 23 Sep, 2021 8 commits
-
-
Mauro Carvalho Chehab authored
The way the search algorithm works is that reduces the number of regex expressions that will be checked for a given file entry at sysfs. It does that by looking at the devnode name. For instance, when it checks for this file: /sys/bus/pci/drivers/iosf_mbi_pci/bind The logic will seek only the "What:" expressions that end with "bind". Currently, there are just a couple of What expressions that matches it: What: /sys/bus/fsl\-mc/drivers/.*/bind What: /sys/bus/pci/drivers/.*/bind It will then run an O(n²) algorithm to seek, which runs quickly when there are few regexs to seek. There are, however, some What: expressions that end with a wildcard. Those are harder to process. Right now, they're all grouped together at the "others" group. As those don't depend on the basename of the node, add an extra loop to ensure that those will be processed at the end, if not done yet. Signed-off-by:
-
Mauro Carvalho Chehab authored
In order to earn some time during matches, pre-compile regexes. Before this patch: $ time ./scripts/get_abi.pl undefined |wc -l 6970 real 0m54,751s user 0m54,022s sys 0m0,592s Afterwards: $ time ./scripts/get_abi.pl undefined |wc -l 6970 real 0m5,888s user 0m5,310s sys 0m0,562s Signed-off-by:
-
Mauro Carvalho Chehab authored
Right now, there are two loops used to seek for a regex. Make sure that both will be skip when a match is found. While here, drop the unused $defined variable. Signed-off-by:
-
Mauro Carvalho Chehab authored
When checking for undefined symbols, some nodes aren't easy or don't make sense to be checked right now. Prevent allocating memory for those, as they'll be ignored anyway. Signed-off-by:
-
Mauro Carvalho Chehab authored
When the the leaf of a regex ends with a wildcard, the speedup algorithm to reduce the number of regexes to seek won't work. So, when those are found, place at the "others" exception. That slows down the search from 0.14s to 1 minute on my machine, but the results are a lot more consistent. Signed-off-by:
-
Mauro Carvalho Chehab authored
Add a level for debug, in order to allow it to be extended to debug other parts of the script. Signed-off-by:
-
Mauro Carvalho Chehab authored
The $what conversions need to replace some characters to avoid breaking regex expressions found on some What:. only after replacing them back, the script should get the $leave devnode. Fixes: ca8e055c ("scripts: get_abi.pl: add a graph to speedup the undefined algorithm") Signed-off-by:
-
Mauro Carvalho Chehab authored
Currently, the get_abi.pl will print an invalid symbol (\xac character). Fix it. Fixes: ab9c1480 ("scripts: get_abi.pl: Better handle multiple What parameters") Signed-off-by:
-
- 21 Sep, 2021 9 commits
-
-
Mauro Carvalho Chehab authored
Searching for symlinks is an expensive operation with the current logic, as it is at the order of O(n^3). In practice, running the check spends 2-3 minutes to check all symbols. Fix it by storing the directory tree into a graph, and using a Breadth First Search (BFS) to find the links for each sysfs node. With such improvement, it can now report issues with ~11 seconds on my machine. It comes with a price, though: there are more symbols reported as undefined after this change. I suspect it is due to some sysfs circular loops that are dropped by BFS. Despite such increase, it seems that the reports are now more coherent. Signed-off-by:
-
Mauro Carvalho Chehab authored
In order to speedup the parser and store less data, handle fs/cgroup exceptions a lot earlier. Signed-off-by:
-
Mauro Carvalho Chehab authored
The search algorithm used inside check_undefined_symbols has an optimization: it seeks only whats that have the same leave name. This helps not only to speedup the search, but it also allows providing a hint about a partial match. There's a drawback, however: when "what:" finishes with a wildcard, the logic will skip the what, reporting it as "not found". Fix it by grouping the remaining cases altogether, and disabing any hints for such cases. Signed-off-by:
-
Mauro Carvalho Chehab authored
The output of this script can be too big. Add an option to filter out results, in order to help finding issues at the ABI files. Signed-off-by:
-
Mauro Carvalho Chehab authored
The way sysfs works is that the same leave may be present under /sys/devices, /sys/bus and /sys/class, etc, linked via soft symlinks. To make it harder to parse, the ABI definition usually refers only to one of those locations. So, improve the logic in order to retrieve the symlinks. Signed-off-by:
-
Mauro Carvalho Chehab authored
Check for the symbols that exists under /sys but aren't defined at Documentation/ABI. Signed-off-by:
-
Mauro Carvalho Chehab authored
Using a comma here is problematic, as some What: expressions may already contain a comma. So, use \xac character instead. Signed-off-by:
-
Mauro Carvalho Chehab authored
An "N" upper letter is not a wildcard, nor can easily be identified by script, specially since the USB sysfs define things like. bNumInterfaces. Use, instead, <N>, in order to let script/get_abi.pl to convert it into a Regex. Signed-off-by:
-
Mauro Carvalho Chehab authored
An "N" upper letter is not a wildcard, nor can easily be identified by script, specially since the USB sysfs define things like. bNumInterfaces. Use, instead, <N>, in order to let script/get_abi.pl to convert it into a Regex. Acked-by:
Richard Cochran <richardcochran@gmail.com> Signed-off-by:
-
