Commit 3a63e9fc authored by Puranjay Mohan's avatar Puranjay Mohan Committed by Jonathan Corbet
Browse files

Driver-API: Documentation: Replace deprecated :c:func: Usage 



Replace :c:func: with func() as the previous usage is deprecated.

Signed-off-by: default avatarPuranjay Mohan <puranjay12@gmail.com>
Link: https://lore.kernel.org/r/20200707053252.32703-1-puranjay12@gmail.com


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

Documentation/driver-api/device-io.rst

+11 −11
Original line number Original line Diff line number Diff line
@@ -36,14 +36,14 @@ are starting with one. Physical addresses are of type unsigned long. 




This address should not be used directly. Instead, to get an address

This address should not be used directly. Instead, to get an address

suitable for passing to the accessor functions described below, you

suitable for passing to the accessor functions described below, you

should call :c:func:`ioremap()`. An address suitable for accessing

should call ioremap(). An address suitable for accessing

the device will be returned to you.

the device will be returned to you.





After you've finished using the device (say, in your module's exit

After you've finished using the device (say, in your module's exit

routine), call :c:func:`iounmap()` in order to return the address

routine), call iounmap() in order to return the address

space to the kernel. Most architectures allocate new address space each

space to the kernel. Most architectures allocate new address space each

time you call :c:func:`ioremap()`, and they can run out unless you

time you call ioremap(), and they can run out unless you

call :c:func:`iounmap()`.

call iounmap().





Accessing the device

Accessing the device

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

--------------------
@@ -60,8 +60,8 @@ readb_relaxed(), readw_relaxed(), readl_relaxed(), readq_relaxed(), 
writeb(), writew(), writel() and writeq().

writeb(), writew(), writel() and writeq().





Some devices (such as framebuffers) would like to use larger transfers than

Some devices (such as framebuffers) would like to use larger transfers than

8 bytes at a time. For these devices, the :c:func:`memcpy_toio()`,

8 bytes at a time. For these devices, the memcpy_toio(),

:c:func:`memcpy_fromio()` and :c:func:`memset_io()` functions are

memcpy_fromio() and memset_io() functions are

provided. Do not use memset or memcpy on IO addresses; they are not

provided. Do not use memset or memcpy on IO addresses; they are not

guaranteed to copy data in order.

guaranteed to copy data in order.
@@ -135,15 +135,15 @@ Accessing Port Space 




Accesses to this space are provided through a set of functions which

Accesses to this space are provided through a set of functions which

allow 8-bit, 16-bit and 32-bit accesses; also known as byte, word and

allow 8-bit, 16-bit and 32-bit accesses; also known as byte, word and

long. These functions are :c:func:`inb()`, :c:func:`inw()`,

long. These functions are inb(), inw(),

:c:func:`inl()`, :c:func:`outb()`, :c:func:`outw()` and

inl(), outb(), outw() and

:c:func:`outl()`.

outl().





Some variants are provided for these functions. Some devices require

Some variants are provided for these functions. Some devices require

that accesses to their ports are slowed down. This functionality is

that accesses to their ports are slowed down. This functionality is

provided by appending a ``_p`` to the end of the function.

provided by appending a ``_p`` to the end of the function.

There are also equivalents to memcpy. The :c:func:`ins()` and

There are also equivalents to memcpy. The ins() and

:c:func:`outs()` functions copy bytes, words or longs to the given

outs() functions copy bytes, words or longs to the given

port.

port.





Public Functions Provided

Public Functions Provided