Commit 37bf501b authored by Zhao Yakui's avatar Zhao Yakui Committed by Len Brown
Browse files

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: default avatarZhao Yakui <yakui.zhao@intel.com>
Signed-off-by: default avatarCorey Minyard <cminyard@mvista.com>
Signed-off-by: default avatarLen Brown <len.brown@intel.com>
parent 16f4232c

Documentation/IPMI.txt

+27 −0
Original line number Diff line number Diff line
@@ -533,6 +533,33 @@ completion during sending a panic event. 
Other Pieces

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



Get the detailed info related with the IPMI device

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



Some users need more detailed information about a device, like where

the address came from or the raw base device for the IPMI interface.

You can use the IPMI smi_watcher to catch the IPMI interfaces as they

come or go, and to grab the information, you can use the function

ipmi_get_smi_info(), which returns the following structure:



struct ipmi_smi_info {

	enum ipmi_addr_src addr_src;

	struct device *dev;

	union {

		struct {

			void *acpi_handle;

		} acpi_info;

	} addr_info;

};



Currently special info for only for SI_ACPI address sources is

returned.  Others may be added as necessary.



Note that the dev pointer is included in the above structure, and

assuming ipmi_smi_get_info returns success, you must call put_device

on the dev pointer.





Watchdog

--------