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

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>

authored by

Praveen Balakrishnan and committed by
Corey Minyard
08effa6b fa332f5d

+10 -10
+10 -10
Documentation/driver-api/ipmi.rst
··· 45 45 for direct I2C access to the IPMI management controller. Some boards 46 46 support this, but it is unknown if it will work on every board. For 47 47 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 49 49 information is wrong or not present. It is fairly safe to have both 50 50 these enabled and let the drivers auto-detect what is present. 51 51 ··· 63 63 IPMI defines a standard watchdog timer. You can enable this with the 64 64 'IPMI Watchdog Timer' config option. If you compile the driver into 65 65 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 67 67 of other options, see the 'Watchdog' section below for more details. 68 68 Note that you can also have the watchdog continue to run if it is 69 69 closed (by default it is disabled on close). Go into the 'Watchdog ··· 314 314 315 315 If the message cannot fit into the data you provide, you will get an 316 316 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 318 318 the IPMICTL_RECEIVE_MSG_TRUNC ioctl. 319 319 320 320 When you send a command (which is defined by the lowest-order bit of 321 321 the netfn per the IPMI spec) on the IPMB bus, the driver will 322 322 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 324 324 seconds, it will generate a response automatically saying the command 325 325 timed out. If an unsolicited response comes in (if it was after 5 326 326 seconds, for instance), that response will be ignored. ··· 364 364 365 365 To respond to a received command, set the response bit in the returned 366 366 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. 368 368 369 369 From userland, equivalent IOCTLs are provided to do these functions. 370 370 ··· 437 437 438 438 The regsizes parameter gives the size of a register, in bytes. The 439 439 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. 441 441 It may be 1, 2, 4, or 8. The default is 1. 442 442 443 443 Since the register size may be larger than 32 bits, the IPMI data may not ··· 478 478 SMIC interface, the IPMI driver will start a kernel thread for the 479 479 interface to help speed things up. This is a low-priority kernel 480 480 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 483 483 interrupts, the driver will run VERY slowly. Don't blame me, 484 484 these interfaces suck. 485 485 ··· 580 580 These are the same options as on the module command line. 581 581 582 582 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 584 584 time, or other panic-related IPMI functions without special kernel 585 585 patches and driver modifications. You can get those at the openipmi 586 586 web page. ··· 607 607 ipmi_ipmb.retry_time_ms=<Time between retries on IPMB> 608 608 ipmi_ipmb.max_retries=<Number of times to retry a message> 609 609 610 - Loading the module will not result in the driver automatcially 610 + Loading the module will not result in the driver automatically 611 611 starting unless there is device tree information setting it up. If 612 612 you want to instantiate one of these by hand, do:: 613 613