docs: ipmb: place it at driver-api and convert to ReST

No new doc should be added at the main Documentation/ directory.

Instead, new docs should be added as ReST files, within the
Kernel documentation body.

Fixes: 51bd6f291583 ("Add support for IPMB driver")
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Message-Id: <d23c36ca65fe6ad56af1723bf70f7a7f4154c410.1561804596.git.mchehab+samsung@kernel.org>
Signed-off-by: Corey Minyard <cminyard@mvista.com>

diff --git a/Documentation/IPMB.txt b/Documentation/IPMB.txt
deleted file mode 100644 (file)
index a6ed8b6..0000000
--- a/Documentation/IPMB.txt
+++ /dev/null
@@ -1,103 +0,0 @@
-==============================
-IPMB Driver for a Satellite MC
-==============================
-
-The Intelligent Platform Management Bus or IPMB, is an
-I2C bus that provides a standardized interconnection between
-different boards within a chassis. This interconnection is
-between the baseboard management (BMC) and chassis electronics.
-IPMB is also associated with the messaging protocol through the
-IPMB bus.
-
-The devices using the IPMB are usually management
-controllers that perform management functions such as servicing
-the front panel interface, monitoring the baseboard,
-hot-swapping disk drivers in the system chassis, etc...
-
-When an IPMB is implemented in the system, the BMC serves as
-a controller to give system software access to the IPMB. The BMC
-sends IPMI requests to a device (usually a Satellite Management
-Controller or Satellite MC) via IPMB and the device
-sends a response back to the BMC.
-
-For more information on IPMB and the format of an IPMB message,
-refer to the IPMB and IPMI specifications.
-
-IPMB driver for Satellite MC
-----------------------------
-
-ipmb-dev-int - This is the driver needed on a Satellite MC to
-receive IPMB messages from a BMC and send a response back.
-This driver works with the I2C driver and a userspace
-program such as OpenIPMI:
-
-1) It is an I2C slave backend driver. So, it defines a callback
-function to set the Satellite MC as an I2C slave.
-This callback function handles the received IPMI requests.
-
-2) It defines the read and write functions to enable a user
-space program (such as OpenIPMI) to communicate with the kernel.
-
-
-Load the IPMB driver
---------------------
-
-The driver needs to be loaded at boot time or manually first.
-First, make sure you have the following in your config file:
-CONFIG_IPMB_DEVICE_INTERFACE=y
-
-1) If you want the driver to be loaded at boot time:
-
-a) Add this entry to your ACPI table, under the appropriate SMBus:
-
-Device (SMB0) // Example SMBus host controller
-{
-  Name (_HID, "<Vendor-Specific HID>") // Vendor-Specific HID
-  Name (_UID, 0) // Unique ID of particular host controller
-  :
-  :
-    Device (IPMB)
-    {
-      Name (_HID, "IPMB0001") // IPMB device interface
-      Name (_UID, 0) // Unique device identifier
-    }
-}
-
-b) Example for device tree:
-
-&i2c2 {
-         status = "okay";
-
-         ipmb@10 {
-                 compatible = "ipmb-dev";
-                 reg = <0x10>;
-         };
-};
-
-2) Manually from Linux:
-modprobe ipmb-dev-int
-
-
-Instantiate the device
-----------------------
-
-After loading the driver, you can instantiate the device as
-described in 'Documentation/i2c/instantiating-devices'.
-If you have multiple BMCs, each connected to your Satellite MC via
-a different I2C bus, you can instantiate a device for each of
-those BMCs.
-The name of the instantiated device contains the I2C bus number
-associated with it as follows:
-
-BMC1 ------ IPMB/I2C bus 1 ---------|   /dev/ipmb-1
-                               Satellite MC
-BMC1 ------ IPMB/I2C bus 2 ---------|   /dev/ipmb-2
-
-For instance, you can instantiate the ipmb-dev-int device from
-user space at the 7 bit address 0x10 on bus 2:
-
-  # echo ipmb-dev 0x1010 > /sys/bus/i2c/devices/i2c-2/new_device
-
-This will create the device file /dev/ipmb-2, which can be accessed
-by the user space program. The device needs to be instantiated
-before running the user space program.

diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index d26308af60360b30f086a684affd0945e65a26f0..b189bd3013ffbdf4f5ea5e6988f8942a72298295 100644 (file)
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -34,6 +34,7 @@ available subsections can be seen below.
    pci/index
    spi
    i2c
+   ipmb
    i3c/index
    hsi
    edac

diff --git a/Documentation/driver-api/ipmb.rst b/Documentation/driver-api/ipmb.rst
new file mode 100644 (file)
index 0000000..7e22651
--- /dev/null
+++ b/Documentation/driver-api/ipmb.rst
@@ -0,0 +1,105 @@
+==============================
+IPMB Driver for a Satellite MC
+==============================
+
+The Intelligent Platform Management Bus or IPMB, is an
+I2C bus that provides a standardized interconnection between
+different boards within a chassis. This interconnection is
+between the baseboard management (BMC) and chassis electronics.
+IPMB is also associated with the messaging protocol through the
+IPMB bus.
+
+The devices using the IPMB are usually management
+controllers that perform management functions such as servicing
+the front panel interface, monitoring the baseboard,
+hot-swapping disk drivers in the system chassis, etc...
+
+When an IPMB is implemented in the system, the BMC serves as
+a controller to give system software access to the IPMB. The BMC
+sends IPMI requests to a device (usually a Satellite Management
+Controller or Satellite MC) via IPMB and the device
+sends a response back to the BMC.
+
+For more information on IPMB and the format of an IPMB message,
+refer to the IPMB and IPMI specifications.
+
+IPMB driver for Satellite MC
+----------------------------
+
+ipmb-dev-int - This is the driver needed on a Satellite MC to
+receive IPMB messages from a BMC and send a response back.
+This driver works with the I2C driver and a userspace
+program such as OpenIPMI:
+
+1) It is an I2C slave backend driver. So, it defines a callback
+   function to set the Satellite MC as an I2C slave.
+   This callback function handles the received IPMI requests.
+
+2) It defines the read and write functions to enable a user
+   space program (such as OpenIPMI) to communicate with the kernel.
+
+
+Load the IPMB driver
+--------------------
+
+The driver needs to be loaded at boot time or manually first.
+First, make sure you have the following in your config file:
+CONFIG_IPMB_DEVICE_INTERFACE=y
+
+1) If you want the driver to be loaded at boot time:
+
+a) Add this entry to your ACPI table, under the appropriate SMBus::
+
+     Device (SMB0) // Example SMBus host controller
+     {
+     Name (_HID, "<Vendor-Specific HID>") // Vendor-Specific HID
+     Name (_UID, 0) // Unique ID of particular host controller
+     :
+     :
+       Device (IPMB)
+       {
+         Name (_HID, "IPMB0001") // IPMB device interface
+         Name (_UID, 0) // Unique device identifier
+       }
+     }
+
+b) Example for device tree::
+
+     &i2c2 {
+            status = "okay";
+
+            ipmb@10 {
+                    compatible = "ipmb-dev";
+                    reg = <0x10>;
+            };
+     };
+
+2) Manually from Linux::
+
+     modprobe ipmb-dev-int
+
+
+Instantiate the device
+----------------------
+
+After loading the driver, you can instantiate the device as
+described in 'Documentation/i2c/instantiating-devices'.
+If you have multiple BMCs, each connected to your Satellite MC via
+a different I2C bus, you can instantiate a device for each of
+those BMCs.
+
+The name of the instantiated device contains the I2C bus number
+associated with it as follows::
+
+  BMC1 ------ IPMB/I2C bus 1 ---------|   /dev/ipmb-1
+                               Satellite MC
+  BMC1 ------ IPMB/I2C bus 2 ---------|   /dev/ipmb-2
+
+For instance, you can instantiate the ipmb-dev-int device from
+user space at the 7 bit address 0x10 on bus 2::
+
+  # echo ipmb-dev 0x1010 > /sys/bus/i2c/devices/i2c-2/new_device
+
+This will create the device file /dev/ipmb-2, which can be accessed
+by the user space program. The device needs to be instantiated
+before running the user space program.