Commit 7852fe3a authored by Randy Dunlap's avatar Randy Dunlap Committed by Jonathan Corbet
Browse files

Documentation: driver-api: correct spelling 



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

Signed-off-by: default avatarRandy 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: default avatarDan Williams <dan.j.williams@intel.com>
Acked-by: default avatarSong Liu <song@kernel.org>
Acked-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Link: https://lore.kernel.org/r/20230129231053.20863-3-rdunlap@infradead.org


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent dbeb56fe

Documentation/driver-api/dma-buf.rst

+1 −1
Original line number Diff line number Diff line
@@ -264,7 +264,7 @@ through memory management dependencies which userspace is unaware of, which 
randomly hangs workloads until the timeout kicks in. Workloads, which from

userspace's perspective, do not contain a deadlock.  In such a mixed fencing

architecture there is no single entity with knowledge of all dependencies.

Thefore preventing such deadlocks from within the kernel is not possible.

Therefore preventing such deadlocks from within the kernel is not possible.



The only solution to avoid dependencies loops is by not allowing indefinite

fences in the kernel. This means:

Documentation/driver-api/dmaengine/client.rst

+1 −1
Original line number Diff line number Diff line
@@ -175,7 +175,7 @@ The details of these operations are: 
    driver can ask for the pointer, maximum size and the currently used size of

    the metadata and can directly update or read it.



    Becasue the DMA driver manages the memory area containing the metadata,

    Because the DMA driver manages the memory area containing the metadata,

    clients must make sure that they do not try to access or get the pointer

    after their transfer completion callback has run for the descriptor.

    If no completion callback has been defined for the transfer, then the

Documentation/driver-api/dmaengine/dmatest.rst

+1 −1
Original line number Diff line number Diff line
@@ -89,7 +89,7 @@ The following command returns the state of the test. :: 


    % cat /sys/module/dmatest/parameters/run



To wait for test completion userpace can poll 'run' until it is false, or use

To wait for test completion userspace can poll 'run' until it is false, or use

the wait parameter. Specifying 'wait=1' when loading the module causes module

initialization to pause until a test run has completed, while reading

/sys/module/dmatest/parameters/wait waits for any running test to complete

Documentation/driver-api/hsi.rst

+2 −2
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ High Speed Synchronous Serial Interface (HSI) 
Introduction

---------------



High Speed Syncronous Interface (HSI) is a fullduplex, low latency protocol,

High Speed Synchronous Interface (HSI) is a full duplex, low latency protocol,

that is optimized for die-level interconnect between an Application Processor

and a Baseband chipset. It has been specified by the MIPI alliance in 2003 and

implemented by multiple vendors since then.
@@ -52,7 +52,7 @@ hsi-char Device 
------------------



Each port automatically registers a generic client driver called hsi_char,

which provides a charecter device for userspace representing the HSI port.

which provides a character device for userspace representing the HSI port.

It can be used to communicate via HSI from userspace. Userspace may

configure the hsi_char device using the following ioctl commands:

Documentation/driver-api/io-mapping.rst

+2 −2
Original line number Diff line number Diff line
@@ -44,7 +44,7 @@ This _wc variant returns a write-combining map to the page and may only be 
used with mappings created by io_mapping_create_wc()



Temporary mappings are only valid in the context of the caller. The mapping

is not guaranteed to be globaly visible.

is not guaranteed to be globally visible.



io_mapping_map_local_wc() has a side effect on X86 32bit as it disables

migration to make the mapping code work. No caller can rely on this side
@@ -78,7 +78,7 @@ variant, although this may be significantly slower:: 
				unsigned long offset)



This works like io_mapping_map_atomic/local_wc() except it has no side

effects and the pointer is globaly visible.

effects and the pointer is globally visible.



The mappings are released with::