Skip to content

Commit 54a19b4

Browse files
mchehabgregkh
authored andcommitted
docs: ABI: cleanup several ABI documents
There are some ABI documents that, while they don't generate any warnings, they have issues when parsed by get_abi.pl script on its output result. Address them, in order to provide a clean output. Reviewed-by: Tom Rix <trix@redhat.com> # for fpga-manager Reviewed-By: Kajol Jain<kjain@linux.ibm.com> # for sysfs-bus-event_source-devices-hv_gpci and sysfs-bus-event_source-devices-hv_24x7 Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> #for IIO Acked-by: Oded Gabbay <oded.gabbay@gmail.com> # for Habanalabs Acked-by: Vaibhav Jain <vaibhav@linux.ibm.com> # for sysfs-bus-papr-pmem Acked-by: Cezary Rojewski <cezary.rojewski@intel.com> # for catpt Acked-by: Suzuki K Poulose <suzuki.poulose@arm.com> Acked-by: Ilya Dryomov <idryomov@gmail.com> # for rbd Acked-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/5bc78e5b68ed1e9e39135173857cb2e753be868f.1604042072.git.mchehab+huawei@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
1 parent ed8c39d commit 54a19b4

126 files changed

Lines changed: 1327 additions & 771 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Documentation/ABI/obsolete/sysfs-class-dax

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ Description: Device DAX is the device-centric analogue of Filesystem
88
system. Device DAX is strict, precise and predictable.
99
Specifically this interface:
1010

11-
1/ Guarantees fault granularity with respect to a given
12-
page size (pte, pmd, or pud) set at configuration time.
11+
1. Guarantees fault granularity with respect to a given
12+
page size (pte, pmd, or pud) set at configuration time.
1313

14-
2/ Enforces deterministic behavior by being strict about
15-
what fault scenarios are supported.
14+
2. Enforces deterministic behavior by being strict about
15+
what fault scenarios are supported.
1616

1717
The /sys/class/dax/ interface enumerates all the
1818
device-dax instances in the system. The ABI is

Documentation/ABI/obsolete/sysfs-driver-hid-roccat-pyra

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,13 @@ Description: It is possible to switch the cpi setting of the mouse with the
77
setting reported by the mouse. This number has to be further
88
processed to receive the real dpi value:
99

10+
===== ====
1011
VALUE DPI
12+
===== ====
1113
1 400
1214
2 800
1315
4 1600
16+
===== ====
1417

1518
This file is readonly.
1619
Has never been used. If bookkeeping is done, it's done in userland tools.

Documentation/ABI/removed/devfs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Description:
55
devfs has been unmaintained for a number of years, has unfixable
66
races, contains a naming policy within the kernel that is
77
against the LSB, and can be replaced by using udev.
8+
89
The files fs/devfs/*, include/linux/devfs_fs*.h were removed,
910
along with the assorted devfs function calls throughout the
1011
kernel tree.

Documentation/ABI/removed/raw1394

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Description:
77
to implement sensible device security policies, and its low level
88
of abstraction that required userspace clients to duplicate much
99
of the kernel's ieee1394 core functionality.
10+
1011
Replaced by /dev/fw*, i.e. the <linux/firewire-cdev.h> ABI of
1112
firewire-core.
1213

Documentation/ABI/removed/sysfs-class-rfkill

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ Description: This file was deprecated because there no longer was a way to
1010
claim just control over a single rfkill instance.
1111
This file was scheduled to be removed in 2012, and was removed
1212
in 2016.
13-
Values: 0: Kernel handles events
13+
Values: 0: Kernel handles events

Documentation/ABI/removed/video1394

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Description:
88
performance issues in its first generation. Any video1394 user had
99
to use raw1394 + libraw1394 too because video1394 did not provide
1010
asynchronous I/O for device discovery and configuration.
11+
1112
Replaced by /dev/fw*, i.e. the <linux/firewire-cdev.h> ABI of
1213
firewire-core.
1314

Documentation/ABI/stable/firewire-cdev

Lines changed: 34 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,15 @@ Description:
1616
different scope:
1717

1818
- The 1394 node which is associated with the file:
19+
1920
- Asynchronous request transmission
2021
- Get the Configuration ROM
2122
- Query node ID
2223
- Query maximum speed of the path between this node
2324
and local node
2425

2526
- The 1394 bus (i.e. "card") to which the node is attached to:
27+
2628
- Isochronous stream transmission and reception
2729
- Asynchronous stream transmission and reception
2830
- Asynchronous broadcast request transmission
@@ -35,6 +37,7 @@ Description:
3537
- Bus reset initiation, bus reset event reception
3638

3739
- All 1394 buses:
40+
3841
- Allocation of IEEE 1212 address ranges on the local
3942
link layers, reception of inbound requests to such
4043
an address range, asynchronous response transmission
@@ -59,50 +62,50 @@ Description:
5962
The following file operations are supported:
6063

6164
open(2)
62-
Currently the only useful flags are O_RDWR.
65+
Currently the only useful flags are O_RDWR.
6366

6467
ioctl(2)
65-
Initiate various actions. Some take immediate effect, others
66-
are performed asynchronously while or after the ioctl returns.
67-
See the inline documentation in <linux/firewire-cdev.h> for
68-
descriptions of all ioctls.
68+
Initiate various actions. Some take immediate effect, others
69+
are performed asynchronously while or after the ioctl returns.
70+
See the inline documentation in <linux/firewire-cdev.h> for
71+
descriptions of all ioctls.
6972

7073
poll(2), select(2), epoll_wait(2) etc.
71-
Watch for events to become available to be read.
74+
Watch for events to become available to be read.
7275

7376
read(2)
74-
Receive various events. There are solicited events like
75-
outbound asynchronous transaction completion or isochronous
76-
buffer completion, and unsolicited events such as bus resets,
77-
request reception, or PHY packet reception. Always use a read
78-
buffer which is large enough to receive the largest event that
79-
could ever arrive. See <linux/firewire-cdev.h> for descriptions
80-
of all event types and for which ioctls affect reception of
81-
events.
77+
Receive various events. There are solicited events like
78+
outbound asynchronous transaction completion or isochronous
79+
buffer completion, and unsolicited events such as bus resets,
80+
request reception, or PHY packet reception. Always use a read
81+
buffer which is large enough to receive the largest event that
82+
could ever arrive. See <linux/firewire-cdev.h> for descriptions
83+
of all event types and for which ioctls affect reception of
84+
events.
8285

8386
mmap(2)
84-
Allocate a DMA buffer for isochronous reception or transmission
85-
and map it into the process address space. The arguments should
86-
be used as follows: addr = NULL, length = the desired buffer
87-
size, i.e. number of packets times size of largest packet,
88-
prot = at least PROT_READ for reception and at least PROT_WRITE
89-
for transmission, flags = MAP_SHARED, fd = the handle to the
90-
/dev/fw*, offset = 0.
87+
Allocate a DMA buffer for isochronous reception or transmission
88+
and map it into the process address space. The arguments should
89+
be used as follows: addr = NULL, length = the desired buffer
90+
size, i.e. number of packets times size of largest packet,
91+
prot = at least PROT_READ for reception and at least PROT_WRITE
92+
for transmission, flags = MAP_SHARED, fd = the handle to the
93+
/dev/fw*, offset = 0.
9194

9295
Isochronous reception works in packet-per-buffer fashion except
9396
for multichannel reception which works in buffer-fill mode.
9497

9598
munmap(2)
96-
Unmap the isochronous I/O buffer from the process address space.
99+
Unmap the isochronous I/O buffer from the process address space.
97100

98101
close(2)
99-
Besides stopping and freeing I/O contexts that were associated
100-
with the file descriptor, back out any changes to the local
101-
nodes' Configuration ROM. Deallocate isochronous channels and
102-
bandwidth at the IRM that were marked for kernel-assisted
103-
re- and deallocation.
104-
105-
Users: libraw1394
106-
libdc1394
107-
libhinawa
102+
Besides stopping and freeing I/O contexts that were associated
103+
with the file descriptor, back out any changes to the local
104+
nodes' Configuration ROM. Deallocate isochronous channels and
105+
bandwidth at the IRM that were marked for kernel-assisted
106+
re- and deallocation.
107+
108+
Users: libraw1394;
109+
libdc1394;
110+
libhinawa;
108111
tools like linux-firewire-utils, fwhack, ...

Documentation/ABI/stable/sysfs-acpi-pmprofile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
What: /sys/firmware/acpi/pm_profile
1+
What: /sys/firmware/acpi/pm_profile
22
Date: 03-Nov-2011
33
KernelVersion: v3.2
44
Contact: linux-acpi@vger.kernel.org
5-
Description: The ACPI pm_profile sysfs interface exports the platform
5+
Description: The ACPI pm_profile sysfs interface exports the platform
66
power management (and performance) requirement expectations
77
as provided by BIOS. The integer value is directly passed as
88
retrieved from the FADT ACPI table.

Documentation/ABI/stable/sysfs-bus-w1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Description: Bus scanning interval, microseconds component.
66
control systems are attached/generate presence for as short as
77
100 ms - hence the tens-to-hundreds milliseconds scan intervals
88
are required.
9+
910
see Documentation/w1/w1-generic.rst for detailed information.
1011
Users: any user space application which wants to know bus scanning
1112
interval

Documentation/ABI/stable/sysfs-class-tpm

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,6 @@ Contact: linux-integrity@vger.kernel.org
191191
Description: The "tpm_version_major" property shows the TCG spec major version
192192
implemented by the TPM device.
193193

194-
Example output:
194+
Example output::
195195

196-
2
196+
2

0 commit comments

Comments
 (0)