Skip to content

Commit 08effa6

Browse files
praveen-balakrishnancminyard
authored andcommitted
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>
1 parent fa332f5 commit 08effa6

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

Documentation/driver-api/ipmi.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ manual), choose the 'IPMI SI handler' option. A driver also exists
4545
for direct I2C access to the IPMI management controller. Some boards
4646
support this, but it is unknown if it will work on every board. For
4747
this, choose 'IPMI SMBus handler', but be ready to try to do some
48-
figuring to see if it will work on your system if the SMBIOS/APCI
48+
figuring to see if it will work on your system if the SMBIOS/ACPI
4949
information is wrong or not present. It is fairly safe to have both
5050
these enabled and let the drivers auto-detect what is present.
5151

@@ -63,7 +63,7 @@ situation, you need to read the section below named 'The SI Driver' or
6363
IPMI defines a standard watchdog timer. You can enable this with the
6464
'IPMI Watchdog Timer' config option. If you compile the driver into
6565
the kernel, then via a kernel command-line option you can have the
66-
watchdog timer start as soon as it initializes. It also have a lot
66+
watchdog timer start as soon as it initializes. It also has a lot
6767
of other options, see the 'Watchdog' section below for more details.
6868
Note that you can also have the watchdog continue to run if it is
6969
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.
314314

315315
If the message cannot fit into the data you provide, you will get an
316316
EMSGSIZE error and the driver will leave the data in the receive
317-
queue. If you want to get it and have it truncate the message, us
317+
queue. If you want to get it and have it truncate the message, use
318318
the IPMICTL_RECEIVE_MSG_TRUNC ioctl.
319319

320320
When you send a command (which is defined by the lowest-order bit of
321321
the netfn per the IPMI spec) on the IPMB bus, the driver will
322322
automatically assign the sequence number to the command and save the
323-
command. If the response is not receive in the IPMI-specified 5
323+
command. If the response is not received in the IPMI-specified 5
324324
seconds, it will generate a response automatically saying the command
325325
timed out. If an unsolicited response comes in (if it was after 5
326326
seconds, for instance), that response will be ignored.
@@ -364,7 +364,7 @@ channel bitmasks do not overlap.
364364

365365
To respond to a received command, set the response bit in the returned
366366
netfn, use the address from the received message, and use the same
367-
msgid that you got in the receive message.
367+
msgid that you got in the received message.
368368

369369
From userland, equivalent IOCTLs are provided to do these functions.
370370

@@ -437,7 +437,7 @@ register would be 0xca6. This defaults to 1.
437437

438438
The regsizes parameter gives the size of a register, in bytes. The
439439
data used by IPMI is 8-bits wide, but it may be inside a larger
440-
register. This parameter allows the read and write type to specified.
440+
register. This parameter allows the read and write type to be specified.
441441
It may be 1, 2, 4, or 8. The default is 1.
442442

443443
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
478478
SMIC interface, the IPMI driver will start a kernel thread for the
479479
interface to help speed things up. This is a low-priority kernel
480480
thread that constantly polls the IPMI driver while an IPMI operation
481-
is in progress. The force_kipmid module parameter will all the user to
482-
force this thread on or off. If you force it off and don't have
481+
is in progress. The force_kipmid module parameter will allow the user
482+
to force this thread on or off. If you force it off and don't have
483483
interrupts, the driver will run VERY slowly. Don't blame me,
484484
these interfaces suck.
485485

@@ -580,7 +580,7 @@ kernel command line as::
580580
These are the same options as on the module command line.
581581

582582
The I2C driver does not support non-blocking access or polling, so
583-
this driver cannod to IPMI panic events, extend the watchdog at panic
583+
this driver cannot do IPMI panic events, extend the watchdog at panic
584584
time, or other panic-related IPMI functions without special kernel
585585
patches and driver modifications. You can get those at the openipmi
586586
web page.
@@ -607,7 +607,7 @@ Parameters are::
607607
ipmi_ipmb.retry_time_ms=<Time between retries on IPMB>
608608
ipmi_ipmb.max_retries=<Number of times to retry a message>
609609

610-
Loading the module will not result in the driver automatcially
610+
Loading the module will not result in the driver automatically
611611
starting unless there is device tree information setting it up. If
612612
you want to instantiate one of these by hand, do::
613613

0 commit comments

Comments
 (0)