From: Jens Taprogge Date: Thu, 27 Sep 2012 10:37:40 +0000 (+0200) Subject: staging: ipack: Documentation cleanups. X-Git-Tag: firefly_0821_release~3680^2~1519^2~1200 X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=26c295cb4bd2a18f943a9962c6f954c8daee90f7;p=firefly-linux-kernel-4.4.55.git staging: ipack: Documentation cleanups. Signed-off-by: Jens Taprogge Signed-off-by: Samuel Iglesias Gonsalvez Signed-off-by: Greg Kroah-Hartman --- diff --git a/drivers/staging/ipack/Kconfig b/drivers/staging/ipack/Kconfig index 9b4495a35f91..5cf43b3364eb 100644 --- a/drivers/staging/ipack/Kconfig +++ b/drivers/staging/ipack/Kconfig @@ -6,11 +6,14 @@ menuconfig IPACK_BUS tristate "IndustryPack bus support" depends on HAS_IOMEM ---help--- - If you say Y here you get support for the IndustryPack Framework - for drivers for many types of boards that support this industrial - bus. The IndustryPack Framework is a virtual bus allowing to - communicate between carrier and mezzanine cards connected through - this bus. + This option provides support for the IndustryPack framework. There + are IndustryPack carrier boards, which interface another bus (such as + PCI) to an IndustryPack bus, and IndustryPack modules, that are + hosted on these buses. While IndustryPack modules can provide a + large variety of functionality, they are most often found in + industrial control applications. + + Say N if unsure. if IPACK_BUS diff --git a/drivers/staging/ipack/carriers/Kconfig b/drivers/staging/ipack/carriers/Kconfig index 33fdc2456c0c..922ff5c35acc 100644 --- a/drivers/staging/ipack/carriers/Kconfig +++ b/drivers/staging/ipack/carriers/Kconfig @@ -1,7 +1,7 @@ config BOARD_TPCI200 - tristate "TEWS TPCI-200 support for IndustryPack bus" + tristate "Support for the TEWS TPCI-200 IndustryPack carrier board" depends on IPACK_BUS depends on PCI help - This driver supports the TEWS TPCI200 device for the IndustryPack bus. + This driver adds support for the TEWS TPCI200 IndustryPack carrier board. default n diff --git a/drivers/staging/ipack/ipack.h b/drivers/staging/ipack/ipack.h index 689af9239dce..7ca8789459e9 100644 --- a/drivers/staging/ipack/ipack.h +++ b/drivers/staging/ipack/ipack.h @@ -80,10 +80,11 @@ struct ipack_device { }; /** - * struct ipack_driver_ops -- callbacks to mezzanine driver for installing/removing one device + * struct ipack_driver_ops -- Callbacks to IPack device driver * - * @probe: Probe function - * @remove: tell the driver that the carrier board wants to remove one device + * @probe: Probe function + * @remove: Prepare imminent removal of the device. Services provided by the + * device should be revoked. */ struct ipack_driver_ops { @@ -92,10 +93,10 @@ struct ipack_driver_ops { }; /** - * struct ipack_driver -- Specific data to each ipack board driver + * struct ipack_driver -- Specific data to each ipack device driver * - * @driver: Device driver kernel representation - * @ops: Mezzanine driver operations specific for the ipack bus. + * @driver: Device driver kernel representation + * @ops: Callbacks provided by the IPack device driver */ struct ipack_driver { struct device_driver driver; @@ -165,7 +166,7 @@ struct ipack_bus_device *ipack_bus_register(struct device *parent, int slots, int ipack_bus_unregister(struct ipack_bus_device *bus); /** - * ipack_driver_register -- Register a new driver + * ipack_driver_register -- Register a new ipack device driver * * Called by a ipack driver to register itself as a driver * that can manage ipack devices.