Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

Documentation: driver-api: correct spelling

Correct spelling problems for Documentation/driver-api/ as reported
by codespell.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: linux-media@vger.kernel.org
Cc: Vishal Verma <vishal.l.verma@intel.com>
Cc: Dave Jiang <dave.jiang@intel.com>
Cc: nvdimm@lists.linux.dev
Cc: Vinod Koul <vkoul@kernel.org>
Cc: dmaengine@vger.kernel.org
Cc: linux-raid@vger.kernel.org
Cc: linux-usb@vger.kernel.org
Acked-by: Dan Williams <dan.j.williams@intel.com>
Acked-by: Song Liu <song@kernel.org>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Link: https://lore.kernel.org/r/20230129231053.20863-3-rdunlap@infradead.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Randy Dunlap and committed by
Jonathan Corbet
7852fe3a dbeb56fe

+24 -24
+1 -1
Documentation/driver-api/dma-buf.rst
··· 264 264 randomly hangs workloads until the timeout kicks in. Workloads, which from 265 265 userspace's perspective, do not contain a deadlock. In such a mixed fencing 266 266 architecture there is no single entity with knowledge of all dependencies. 267 - Thefore preventing such deadlocks from within the kernel is not possible. 267 + Therefore preventing such deadlocks from within the kernel is not possible. 268 268 269 269 The only solution to avoid dependencies loops is by not allowing indefinite 270 270 fences in the kernel. This means:
+1 -1
Documentation/driver-api/dmaengine/client.rst
··· 175 175 driver can ask for the pointer, maximum size and the currently used size of 176 176 the metadata and can directly update or read it. 177 177 178 - Becasue the DMA driver manages the memory area containing the metadata, 178 + Because the DMA driver manages the memory area containing the metadata, 179 179 clients must make sure that they do not try to access or get the pointer 180 180 after their transfer completion callback has run for the descriptor. 181 181 If no completion callback has been defined for the transfer, then the
+1 -1
Documentation/driver-api/dmaengine/dmatest.rst
··· 89 89 90 90 % cat /sys/module/dmatest/parameters/run 91 91 92 - To wait for test completion userpace can poll 'run' until it is false, or use 92 + To wait for test completion userspace can poll 'run' until it is false, or use 93 93 the wait parameter. Specifying 'wait=1' when loading the module causes module 94 94 initialization to pause until a test run has completed, while reading 95 95 /sys/module/dmatest/parameters/wait waits for any running test to complete
+2 -2
Documentation/driver-api/hsi.rst
··· 4 4 Introduction 5 5 --------------- 6 6 7 - High Speed Syncronous Interface (HSI) is a fullduplex, low latency protocol, 7 + High Speed Synchronous Interface (HSI) is a full duplex, low latency protocol, 8 8 that is optimized for die-level interconnect between an Application Processor 9 9 and a Baseband chipset. It has been specified by the MIPI alliance in 2003 and 10 10 implemented by multiple vendors since then. ··· 52 52 ------------------ 53 53 54 54 Each port automatically registers a generic client driver called hsi_char, 55 - which provides a charecter device for userspace representing the HSI port. 55 + which provides a character device for userspace representing the HSI port. 56 56 It can be used to communicate via HSI from userspace. Userspace may 57 57 configure the hsi_char device using the following ioctl commands: 58 58
+2 -2
Documentation/driver-api/io-mapping.rst
··· 44 44 used with mappings created by io_mapping_create_wc() 45 45 46 46 Temporary mappings are only valid in the context of the caller. The mapping 47 - is not guaranteed to be globaly visible. 47 + is not guaranteed to be globally visible. 48 48 49 49 io_mapping_map_local_wc() has a side effect on X86 32bit as it disables 50 50 migration to make the mapping code work. No caller can rely on this side ··· 78 78 unsigned long offset) 79 79 80 80 This works like io_mapping_map_atomic/local_wc() except it has no side 81 - effects and the pointer is globaly visible. 81 + effects and the pointer is globally visible. 82 82 83 83 The mappings are released with:: 84 84
+1 -1
Documentation/driver-api/md/md-cluster.rst
··· 65 65 2.3 new-device management 66 66 ------------------------- 67 67 68 - A single lock: "no-new-dev" is used to co-ordinate the addition of 68 + A single lock: "no-new-dev" is used to coordinate the addition of 69 69 new devices - this must be synchronized across the array. 70 70 Normally all nodes hold a concurrent-read lock on this device. 71 71
+1 -1
Documentation/driver-api/md/raid5-cache.rst
··· 81 81 is organized as a simple write log. The log consists of 'meta data' and 'data' 82 82 pairs. The meta data describes the data. It also includes checksum and sequence 83 83 ID for recovery identification. Data can be IO data and parity data. Data is 84 - checksumed too. The checksum is stored in the meta data ahead of the data. The 84 + checksummed too. The checksum is stored in the meta data ahead of the data. The 85 85 checksum is an optimization because MD can write meta and data freely without 86 86 worry about the order. MD superblock has a field pointed to the valid meta data 87 87 of log head.
+1 -1
Documentation/driver-api/media/drivers/vidtv.rst
··· 28 28 takes parameters at initialization that will dictate how the simulation 29 29 behaves. 30 30 31 - - Code reponsible for encoding a valid MPEG Transport Stream, which is then 31 + - Code responsible for encoding a valid MPEG Transport Stream, which is then 32 32 passed to the bridge driver. This fake stream contains some hardcoded content. 33 33 For now, we have a single, audio-only channel containing a single MPEG 34 34 Elementary Stream, which in turn contains a SMPTE 302m encoded sine-wave.
+1 -1
Documentation/driver-api/media/dtv-demux.rst
··· 24 24 25 25 The demux kABI only controls front-ends regarding to their connections with 26 26 demuxes; the kABI used to set the other front-end parameters, such as 27 - tuning, are devined via the Digital TV Frontend kABI. 27 + tuning, are defined via the Digital TV Frontend kABI. 28 28 29 29 The functions that implement the abstract interface demux should be defined 30 30 static or module private and registered to the Demux core for external
+2 -2
Documentation/driver-api/media/v4l2-subdev.rst
··· 321 321 hardware from applications. For complex devices, finer-grained control of the 322 322 device than what the video nodes offer may be required. In those cases, bridge 323 323 drivers that implement :ref:`the media controller API <media_controller>` may 324 - opt for making the subdevice operations directly accessible from userpace. 324 + opt for making the subdevice operations directly accessible from userspace. 325 325 326 326 Device nodes named ``v4l-subdev``\ *X* can be created in ``/dev`` to access 327 327 sub-devices directly. If a sub-device supports direct userspace configuration ··· 574 574 as they expect to receive the appropriate state as a parameter. To help the 575 575 conversion of subdevice drivers to a managed active state without having to 576 576 convert all callers at the same time, an additional wrapper layer has been 577 - added to v4l2_subdev_call(), which handles the NULL case by geting and locking 577 + added to v4l2_subdev_call(), which handles the NULL case by getting and locking 578 578 the callee's active state with :c:func:`v4l2_subdev_lock_and_get_active_state()`, 579 579 and unlocking the state after the call. 580 580
+1 -1
Documentation/driver-api/mei/nfc.rst
··· 3 3 MEI NFC 4 4 ------- 5 5 6 - Some Intel 8 and 9 Serieses chipsets supports NFC devices connected behind 6 + Some Intel 8 and 9 Series chipsets support NFC devices connected behind 7 7 the Intel Management Engine controller. 8 8 MEI client bus exposes the NFC chips as NFC phy devices and enables 9 9 binding with Microread and NXP PN544 NFC device driver from the Linux NFC
+1 -1
Documentation/driver-api/nfc/nfc-hci.rst
··· 150 150 151 151 Communication between the CPU and the chip often requires some link layer 152 152 protocol. Those are isolated as modules managed by the HCI layer. There are 153 - currently two modules : nop (raw transfert) and shdlc. 153 + currently two modules : nop (raw transfer) and shdlc. 154 154 A new llc must implement the following functions:: 155 155 156 156 struct nfc_llc_ops {
+1 -1
Documentation/driver-api/nvdimm/nvdimm.rst
··· 82 82 Metadata stored on a DIMM device that partitions and identifies 83 83 (persistently names) capacity allocated to different PMEM namespaces. It 84 84 also indicates whether an address abstraction like a BTT is applied to 85 - the namepsace. Note that traditional partition tables, GPT/MBR, are 85 + the namespace. Note that traditional partition tables, GPT/MBR, are 86 86 layered on top of a PMEM namespace, or an address abstraction like BTT 87 87 if present, but partition support is deprecated going forward. 88 88
+1 -1
Documentation/driver-api/nvdimm/security.rst
··· 83 83 6. Freeze 84 84 --------- 85 85 The freeze operation does not require any keys. The security config can be 86 - frozen by a user with root privelege. 86 + frozen by a user with root privilege. 87 87 88 88 7. Disable 89 89 ----------
+1 -1
Documentation/driver-api/pin-control.rst
··· 882 882 883 883 Depending on the exact HW register design, some functions exposed by the 884 884 GPIO subsystem may call into the pinctrl subsystem in order to 885 - co-ordinate register settings across HW modules. In particular, this may 885 + coordinate register settings across HW modules. In particular, this may 886 886 be needed for HW with separate GPIO and pin controller HW modules, where 887 887 e.g. GPIO direction is determined by a register in the pin controller HW 888 888 module rather than the GPIO HW module.
+1 -1
Documentation/driver-api/pldmfw/index.rst
··· 20 20 21 21 The ``pldmfw`` library is intended to be used by device drivers for 22 22 implementing device flash update based on firmware files following the PLDM 23 - firwmare file format. 23 + firmware file format. 24 24 25 25 It is implemented using an ops table that allows device drivers to provide 26 26 the underlying device specific functionality.
+1 -1
Documentation/driver-api/serial/driver.rst
··· 24 24 Console Support 25 25 --------------- 26 26 27 - The serial core provides a few helper functions. This includes identifing 27 + The serial core provides a few helper functions. This includes identifying 28 28 the correct port structure (via uart_get_console()) and decoding command line 29 29 arguments (uart_parse_options()). 30 30
+1 -1
Documentation/driver-api/surface_aggregator/ssh.rst
··· 76 76 its own CRC (over all payload bytes). If the payload is not present (i.e. 77 77 the frame has ``LEN=0``), the CRC of the payload is still present and will 78 78 evaluate to ``0xffff``. The |LEN| field does not include any of the CRCs, it 79 - equals the number of bytes inbetween the CRC of the frame and the CRC of the 79 + equals the number of bytes between the CRC of the frame and the CRC of the 80 80 payload. 81 81 82 82 Additionally, the following fixed two-byte sequences are used:
+1 -1
Documentation/driver-api/thermal/intel_powerclamp.rst
··· 85 85 belong to the offlined CPUs will be terminated immediately. 86 86 87 87 Running as SCHED_FIFO and relatively high priority, also allows such 88 - scheme to work for both preemptable and non-preemptable kernels. 88 + scheme to work for both preemptible and non-preemptible kernels. 89 89 Alignment of idle time around jiffies ensures scalability for HZ 90 90 values. This effect can be better visualized using a Perf timechart. 91 91 The following diagram shows the behavior of kernel thread
+1 -1
Documentation/driver-api/usb/dwc3.rst
··· 18 18 4. Hub configuration 19 19 20 20 Linux currently supports several versions of this controller. In all 21 - likelyhood, the version in your SoC is already supported. At the time 21 + likelihood, the version in your SoC is already supported. At the time 22 22 of this writing, known tested versions range from 2.02a to 3.10a. As a 23 23 rule of thumb, anything above 2.02a should work reliably well. 24 24
+1 -1
Documentation/driver-api/usb/usb3-debug-port.rst
··· 48 48 "earlyprintk=xdbc" 49 49 50 50 If there are multiple xHCI controllers in your system, you can 51 - append a host contoller index to this kernel parameter. This 51 + append a host controller index to this kernel parameter. This 52 52 index starts from 0. 53 53 54 54 Current design doesn't support DbC runtime suspend/resume. As