Skip to content

Commit 9c75b68

Browse files
committed
Merge tag 'driver-core-5.10-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/driver-core
Pull driver core and documentation fixes from Greg KH: "Here is one tiny debugfs change to fix up an API where the last user was successfully fixed up in 5.10-rc1 (so it couldn't be merged earlier), and a much larger Documentation/ABI/ update to the files so they can be automatically parsed by our tools. The Documentation/ABI/ updates are just formatting issues, small ones to bring the files into parsable format, and have been acked by numerous subsystem maintainers and the documentation maintainer. I figured it was good to get this into 5.10-rc2 to help wih the merge issues that would arise if these were to stick in linux-next until 5.11-rc1. The debugfs change has been in linux-next for a long time, and the Documentation updates only for the last linux-next release" * tag 'driver-core-5.10-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/driver-core: (40 commits) scripts: get_abi.pl: assume ReST format by default docs: ABI: sysfs-class-led-trigger-pattern: remove hw_pattern duplication docs: ABI: sysfs-class-backlight: unify ABI documentation docs: ABI: sysfs-c2port: remove a duplicated entry docs: ABI: sysfs-class-power: unify duplicated properties docs: ABI: unify /sys/class/leds/<led>/brightness documentation docs: ABI: stable: remove a duplicated documentation docs: ABI: change read/write attributes docs: ABI: cleanup several ABI documents docs: ABI: sysfs-bus-nvdimm: use the right format for ABI docs: ABI: vdso: use the right format for ABI docs: ABI: fix syntax to be parsed using ReST notation docs: ABI: convert testing/configfs-acpi to ReST docs: Kconfig/Makefile: add a check for broken ABI files docs: abi-testing.rst: enable --rst-sources when building docs docs: ABI: don't escape ReST-incompatible chars from obsolete and removed docs: ABI: create a 2-depth index for ABI docs: ABI: make it parse ABI/stable as ReST-compatible files docs: ABI: sysfs-uevent: make it compatible with ReST output docs: ABI: testing: make the files compatible with ReST output ...
2 parents 2376cca + 2fcce37 commit 9c75b68

250 files changed

Lines changed: 4134 additions & 2493 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/README

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The different levels of stability are:
3232
layout of the files below for details on how to do this.)
3333

3434
obsolete/
35-
This directory documents interfaces that are still remaining in
35+
This directory documents interfaces that are still remaining in
3636
the kernel, but are marked to be removed at some later point in
3737
time. The description of the interface will document the reason
3838
why it is obsolete and when it can be expected to be removed.
@@ -58,6 +58,14 @@ Users: All users of this interface who wish to be notified when
5858
be changed further.
5959

6060

61+
Note:
62+
The fields should be use a simple notation, compatible with ReST markup.
63+
Also, the file **should not** have a top-level index, like::
64+
65+
===
66+
foo
67+
===
68+
6169
How things move between levels:
6270

6371
Interfaces in stable may move to obsolete, as long as the proper

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/obsolete/sysfs-gpio

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Description:
1313
GPIOs are identified as they are inside the kernel, using integers in
1414
the range 0..INT_MAX. See Documentation/admin-guide/gpio for more information.
1515

16+
::
17+
1618
/sys/class/gpio
1719
/export ... asks the kernel to export a GPIO to userspace
1820
/unexport ... to return a GPIO to the kernel

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: 38 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,17 @@ Description:
1414
Each /dev/fw* is associated with one IEEE 1394 node, which can
1515
be remote or local nodes. Operations on a /dev/fw* file have
1616
different scope:
17+
1718
- The 1394 node which is associated with the file:
19+
1820
- Asynchronous request transmission
1921
- Get the Configuration ROM
2022
- Query node ID
2123
- Query maximum speed of the path between this node
2224
and local node
25+
2326
- The 1394 bus (i.e. "card") to which the node is attached to:
27+
2428
- Isochronous stream transmission and reception
2529
- Asynchronous stream transmission and reception
2630
- Asynchronous broadcast request transmission
@@ -31,7 +35,9 @@ Description:
3135
manager
3236
- Query cycle time
3337
- Bus reset initiation, bus reset event reception
38+
3439
- All 1394 buses:
40+
3541
- Allocation of IEEE 1212 address ranges on the local
3642
link layers, reception of inbound requests to such
3743
an address range, asynchronous response transmission
@@ -43,6 +49,7 @@ Description:
4349
userland implement different access permission models, some
4450
operations are restricted to /dev/fw* files that are associated
4551
with a local node:
52+
4653
- Addition of descriptors or directories to the local
4754
nodes' Configuration ROM
4855
- PHY packet transmission and reception
@@ -55,50 +62,50 @@ Description:
5562
The following file operations are supported:
5663

5764
open(2)
58-
Currently the only useful flags are O_RDWR.
65+
Currently the only useful flags are O_RDWR.
5966

6067
ioctl(2)
61-
Initiate various actions. Some take immediate effect, others
62-
are performed asynchronously while or after the ioctl returns.
63-
See the inline documentation in <linux/firewire-cdev.h> for
64-
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.
6572

6673
poll(2), select(2), epoll_wait(2) etc.
67-
Watch for events to become available to be read.
74+
Watch for events to become available to be read.
6875

6976
read(2)
70-
Receive various events. There are solicited events like
71-
outbound asynchronous transaction completion or isochronous
72-
buffer completion, and unsolicited events such as bus resets,
73-
request reception, or PHY packet reception. Always use a read
74-
buffer which is large enough to receive the largest event that
75-
could ever arrive. See <linux/firewire-cdev.h> for descriptions
76-
of all event types and for which ioctls affect reception of
77-
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.
7885

7986
mmap(2)
80-
Allocate a DMA buffer for isochronous reception or transmission
81-
and map it into the process address space. The arguments should
82-
be used as follows: addr = NULL, length = the desired buffer
83-
size, i.e. number of packets times size of largest packet,
84-
prot = at least PROT_READ for reception and at least PROT_WRITE
85-
for transmission, flags = MAP_SHARED, fd = the handle to the
86-
/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.
8794

8895
Isochronous reception works in packet-per-buffer fashion except
8996
for multichannel reception which works in buffer-fill mode.
9097

9198
munmap(2)
92-
Unmap the isochronous I/O buffer from the process address space.
99+
Unmap the isochronous I/O buffer from the process address space.
93100

94101
close(2)
95-
Besides stopping and freeing I/O contexts that were associated
96-
with the file descriptor, back out any changes to the local
97-
nodes' Configuration ROM. Deallocate isochronous channels and
98-
bandwidth at the IRM that were marked for kernel-assisted
99-
re- and deallocation.
100-
101-
Users: libraw1394
102-
libdc1394
103-
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;
104111
tools like linux-firewire-utils, fwhack, ...
Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,26 @@
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.
9-
Values: For possible values see ACPI specification:
9+
10+
Values: For possible values see ACPI specification:
1011
5.2.9 Fixed ACPI Description Table (FADT)
1112
Field: Preferred_PM_Profile
1213

1314
Currently these values are defined by spec:
14-
0 Unspecified
15-
1 Desktop
16-
2 Mobile
17-
3 Workstation
18-
4 Enterprise Server
19-
5 SOHO Server
20-
6 Appliance PC
21-
7 Performance Server
15+
16+
== =================
17+
0 Unspecified
18+
1 Desktop
19+
2 Mobile
20+
3 Workstation
21+
4 Enterprise Server
22+
5 SOHO Server
23+
6 Appliance PC
24+
7 Performance Server
2225
>7 Reserved
26+
== =================

0 commit comments

Comments
 (0)