Gh0st
/
linux
mirror of https://github.com/torvalds/linux.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: ipmi: fix spelling and grammar mistakes 

Corrected various spelling and grammatical mistakes in
Documentation/driver-api/ipmi.rst to improve readability.

No changes to the technical content has been made.

Signed-off-by: Praveen Balakrishnan <praveen.balakrishnan@magd.ox.ac.uk>
Message-ID: <20250515234757.19710-1-praveen.balakrishnan@magd.ox.ac.uk>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Corey Minyard <corey@minyard.net>
This commit is contained in:
Praveen Balakrishnan 2025-05-16 00:47:57 +01:00 committed by Corey Minyard
parent fa332f5dc6
commit 08effa6b77
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
Documentation/driver-api/ipmi.rst
View File

@ -45,7 +45,7 @@ manual), choose the 'IPMI SI handler' option. A driver also exists
for direct I2C access to the IPMI management controller. Some boards for direct I2C access to the IPMI management controller. Some boards
support this, but it is unknown if it will work on every board. For support this, but it is unknown if it will work on every board. For
this, choose 'IPMI SMBus handler', but be ready to try to do some this, choose 'IPMI SMBus handler', but be ready to try to do some
figuring to see if it will work on your system if the SMBIOS/APCI figuring to see if it will work on your system if the SMBIOS/ACPI
information is wrong or not present. It is fairly safe to have both information is wrong or not present. It is fairly safe to have both
these enabled and let the drivers auto-detect what is present. these enabled and let the drivers auto-detect what is present.
@ -63,7 +63,7 @@ situation, you need to read the section below named 'The SI Driver' or
IPMI defines a standard watchdog timer. You can enable this with the IPMI defines a standard watchdog timer. You can enable this with the
'IPMI Watchdog Timer' config option. If you compile the driver into 'IPMI Watchdog Timer' config option. If you compile the driver into
the kernel, then via a kernel command-line option you can have the the kernel, then via a kernel command-line option you can have the
watchdog timer start as soon as it initializes. It also have a lot watchdog timer start as soon as it initializes. It also has a lot
of other options, see the 'Watchdog' section below for more details. of other options, see the 'Watchdog' section below for more details.
Note that you can also have the watchdog continue to run if it is Note that you can also have the watchdog continue to run if it is
closed (by default it is disabled on close). Go into the 'Watchdog closed (by default it is disabled on close). Go into the 'Watchdog
@ -314,13 +314,13 @@ This gives the receiver a place to actually put the message.
If the message cannot fit into the data you provide, you will get an If the message cannot fit into the data you provide, you will get an
EMSGSIZE error and the driver will leave the data in the receive EMSGSIZE error and the driver will leave the data in the receive
queue. If you want to get it and have it truncate the message, us queue. If you want to get it and have it truncate the message, use
the IPMICTL_RECEIVE_MSG_TRUNC ioctl. the IPMICTL_RECEIVE_MSG_TRUNC ioctl.
When you send a command (which is defined by the lowest-order bit of When you send a command (which is defined by the lowest-order bit of
the netfn per the IPMI spec) on the IPMB bus, the driver will the netfn per the IPMI spec) on the IPMB bus, the driver will
automatically assign the sequence number to the command and save the automatically assign the sequence number to the command and save the
command. If the response is not receive in the IPMI-specified 5 command. If the response is not received in the IPMI-specified 5
seconds, it will generate a response automatically saying the command seconds, it will generate a response automatically saying the command
timed out. If an unsolicited response comes in (if it was after 5 timed out. If an unsolicited response comes in (if it was after 5
seconds, for instance), that response will be ignored. seconds, for instance), that response will be ignored.
@ -364,7 +364,7 @@ channel bitmasks do not overlap.
To respond to a received command, set the response bit in the returned To respond to a received command, set the response bit in the returned
netfn, use the address from the received message, and use the same netfn, use the address from the received message, and use the same
msgid that you got in the receive message. msgid that you got in the received message.
From userland, equivalent IOCTLs are provided to do these functions. From userland, equivalent IOCTLs are provided to do these functions.
@ -437,7 +437,7 @@ register would be 0xca6. This defaults to 1.
The regsizes parameter gives the size of a register, in bytes. The The regsizes parameter gives the size of a register, in bytes. The
data used by IPMI is 8-bits wide, but it may be inside a larger data used by IPMI is 8-bits wide, but it may be inside a larger
register. This parameter allows the read and write type to specified. register. This parameter allows the read and write type to be specified.
It may be 1, 2, 4, or 8. The default is 1. It may be 1, 2, 4, or 8. The default is 1.
Since the register size may be larger than 32 bits, the IPMI data may not Since the register size may be larger than 32 bits, the IPMI data may not
@ -478,8 +478,8 @@ If your IPMI interface does not support interrupts and is a KCS or
SMIC interface, the IPMI driver will start a kernel thread for the SMIC interface, the IPMI driver will start a kernel thread for the
interface to help speed things up. This is a low-priority kernel interface to help speed things up. This is a low-priority kernel
thread that constantly polls the IPMI driver while an IPMI operation thread that constantly polls the IPMI driver while an IPMI operation
is in progress. The force_kipmid module parameter will all the user to is in progress. The force_kipmid module parameter will allow the user
force this thread on or off. If you force it off and don't have to force this thread on or off. If you force it off and don't have
interrupts, the driver will run VERY slowly. Don't blame me, interrupts, the driver will run VERY slowly. Don't blame me,
these interfaces suck. these interfaces suck.
@ -580,7 +580,7 @@ kernel command line as::
These are the same options as on the module command line. These are the same options as on the module command line.
The I2C driver does not support non-blocking access or polling, so The I2C driver does not support non-blocking access or polling, so
this driver cannod to IPMI panic events, extend the watchdog at panic this driver cannot do IPMI panic events, extend the watchdog at panic
time, or other panic-related IPMI functions without special kernel time, or other panic-related IPMI functions without special kernel
patches and driver modifications. You can get those at the openipmi patches and driver modifications. You can get those at the openipmi
web page. web page.
@ -607,7 +607,7 @@ Parameters are::
ipmi_ipmb.retry_time_ms=<Time between retries on IPMB> ipmi_ipmb.retry_time_ms=<Time between retries on IPMB>
ipmi_ipmb.max_retries=<Number of times to retry a message> ipmi_ipmb.max_retries=<Number of times to retry a message>
Loading the module will not result in the driver automatcially Loading the module will not result in the driver automatically
starting unless there is device tree information setting it up. If starting unless there is device tree information setting it up. If
you want to instantiate one of these by hand, do:: you want to instantiate one of these by hand, do::