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

IPMI: Add the document description of ipmi_get_smi_info

Add the document description about how to use ipmi_get_smi_info.

Signed-off-by: Zhao Yakui <yakui.zhao@intel.com>
Signed-off-by: Corey Minyard <cminyard@mvista.com>
Signed-off-by: Len Brown <len.brown@intel.com>

authored by

Zhao Yakui and committed by
Len Brown
37bf501b 16f4232c

+27
+27
Documentation/IPMI.txt
··· 533 533 Other Pieces 534 534 ------------ 535 535 536 + Get the detailed info related with the IPMI device 537 + -------------------------------------------------- 538 + 539 + Some users need more detailed information about a device, like where 540 + the address came from or the raw base device for the IPMI interface. 541 + You can use the IPMI smi_watcher to catch the IPMI interfaces as they 542 + come or go, and to grab the information, you can use the function 543 + ipmi_get_smi_info(), which returns the following structure: 544 + 545 + struct ipmi_smi_info { 546 + enum ipmi_addr_src addr_src; 547 + struct device *dev; 548 + union { 549 + struct { 550 + void *acpi_handle; 551 + } acpi_info; 552 + } addr_info; 553 + }; 554 + 555 + Currently special info for only for SI_ACPI address sources is 556 + returned. Others may be added as necessary. 557 + 558 + Note that the dev pointer is included in the above structure, and 559 + assuming ipmi_smi_get_info returns success, you must call put_device 560 + on the dev pointer. 561 + 562 + 536 563 Watchdog 537 564 -------- 538 565