rapidio: rework device hierarchy and introduce mport class of devices
authorAlexandre Bounine <alexandre.bounine@idt.com>
Mon, 7 Apr 2014 22:38:56 +0000 (15:38 -0700)
committerLinus Torvalds <torvalds@linux-foundation.org>
Mon, 7 Apr 2014 23:36:07 +0000 (16:36 -0700)
This patch removes an artificial RapidIO bus root device and establishes
actual device hierarchy by providing reference to real parent devices.
It also introduces device class for RapidIO controller devices (on-chip
or an eternal bridge, known as "mport").

Existing implementation was sufficient for SoC-based platforms that have
a single RapidIO controller.  With introduction of devices using
multiple RapidIO controllers and PCIe-to-RapidIO bridges the old scheme
is very limiting or does not work at all.  The implemented changes allow
to properly reference platform's local RapidIO mport devices and provide
device details needed for upper layers.

This change to RapidIO device hierarchy does not break any known
existing kernel or user space interfaces.

Signed-off-by: Alexandre Bounine <alexandre.bounine@idt.com>
Cc: Matt Porter <mporter@kernel.crashing.org>
Cc: Li Yang <leoli@freescale.com>
Cc: Kumar Gala <galak@kernel.crashing.org>
Cc: Andre van Herk <andre.van.herk@prodrive-technologies.com>
Cc: Stef van Os <stef.van.os@prodrive-technologies.com>
Cc: Jerry Jacobs <jerry.jacobs@prodrive-technologies.com>
Cc: Arno Tiemersma <arno.tiemersma@prodrive-technologies.com>
Cc: Rob Landley <rob@landley.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Documentation/rapidio/sysfs.txt
arch/powerpc/sysdev/fsl_rio.c
drivers/net/rionet.c
drivers/rapidio/devices/tsi721.c
drivers/rapidio/rio-driver.c
drivers/rapidio/rio-scan.c
drivers/rapidio/rio-sysfs.c
drivers/rapidio/rio.c
drivers/rapidio/rio.h
include/linux/rio.h

index 271438c0617f9be8b1ea2d23a2ac17eedd483bd3..47ce9a5336e1b05c91944942095d42b094744087 100644 (file)
@@ -2,8 +2,8 @@
 
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-1. Device Subdirectories
-------------------------
+1. RapidIO Device Subdirectories
+--------------------------------
 
 For each RapidIO device, the RapidIO subsystem creates files in an individual
 subdirectory with the following name, /sys/bus/rapidio/devices/<device_name>.
@@ -25,8 +25,8 @@ seen by the enumerating host (destID = 1):
 NOTE: An enumerating or discovering endpoint does not create a sysfs entry for
 itself, this is why an endpoint with destID=1 is not shown in the list.
 
-2. Attributes Common for All Devices
-------------------------------------
+2. Attributes Common for All RapidIO Devices
+--------------------------------------------
 
 Each device subdirectory contains the following informational read-only files:
 
@@ -52,16 +52,16 @@ This attribute is similar in behavior to the "config" attribute of PCI devices
 and provides an access to the RapidIO device registers using standard file read
 and write operations.
 
-3. Endpoint Device Attributes
------------------------------
+3. RapidIO Endpoint Device Attributes
+-------------------------------------
 
 Currently Linux RapidIO subsystem does not create any endpoint specific sysfs
 attributes. It is possible that RapidIO master port drivers and endpoint device
 drivers will add their device-specific sysfs attributes but such attributes are
 outside the scope of this document.
 
-4. Switch Device Attributes
----------------------------
+4. RapidIO Switch Device Attributes
+-----------------------------------
 
 RapidIO switches have additional attributes in sysfs. RapidIO subsystem supports
 common and device-specific sysfs attributes for switches. Because switches are
@@ -106,3 +106,53 @@ attribute:
         for that controller always will be 0.
         To initiate RapidIO enumeration/discovery on all available mports
         a user must write '-1' (or RIO_MPORT_ANY) into this attribute file.
+
+
+6. RapidIO Bus Controllers/Ports
+--------------------------------
+
+On-chip RapidIO controllers and PCIe-to-RapidIO bridges (referenced as
+"Master Port" or "mport") are presented in sysfs as the special class of
+devices: "rapidio_port".
+
+The /sys/class/rapidio_port subdirectory contains individual subdirectories
+named as "rapidioN" where N = mport ID registered with RapidIO subsystem.
+
+NOTE: An mport ID is not a RapidIO destination ID assigned to a given local
+mport device.
+
+Each mport device subdirectory in addition to standard entries contains the
+following device-specific attributes:
+
+   port_destid - reports RapidIO destination ID assigned to the given RapidIO
+                 mport device. If value 0xFFFFFFFF is returned this means that
+                 no valid destination ID have been assigned to the mport (yet).
+                 Normally, before enumeration/discovery have been executed only
+                 fabric enumerating mports have a valid destination ID assigned
+                 to them using "hdid=..." rapidio module parameter.
+      sys_size - reports RapidIO common transport system size:
+                   0 = small (8-bit destination ID, max. 256 devices),
+                   1 = large (16-bit destination ID, max. 65536 devices).
+
+After enumeration or discovery was performed for a given mport device,
+the corresponding subdirectory will also contain subdirectories for each
+child RapidIO device connected to the mport. Naming conventions for RapidIO
+devices are described in Section 1 above.
+
+The example below shows mport device subdirectory with several child RapidIO
+devices attached to it.
+
+[rio@rapidio ~]$ ls /sys/class/rapidio_port/rapidio0/ -l
+total 0
+drwxr-xr-x 3 root root    0 Feb 11 15:10 00:e:0001
+drwxr-xr-x 3 root root    0 Feb 11 15:10 00:e:0004
+drwxr-xr-x 3 root root    0 Feb 11 15:10 00:e:0007
+drwxr-xr-x 3 root root    0 Feb 11 15:10 00:s:0002
+drwxr-xr-x 3 root root    0 Feb 11 15:10 00:s:0003
+drwxr-xr-x 3 root root    0 Feb 11 15:10 00:s:0005
+lrwxrwxrwx 1 root root    0 Feb 11 15:11 device -> ../../../0000:01:00.0
+-r--r--r-- 1 root root 4096 Feb 11 15:11 port_destid
+drwxr-xr-x 2 root root    0 Feb 11 15:11 power
+lrwxrwxrwx 1 root root    0 Feb 11 15:04 subsystem -> ../../../../../../class/rapidio_port
+-r--r--r-- 1 root root 4096 Feb 11 15:11 sys_size
+-rw-r--r-- 1 root root 4096 Feb 11 15:04 uevent
index 95dd892e99047dc3bb8b8967e54c380a783c781c..cf2b0840a672f893a3b2386154716ef54672dfd7 100644 (file)
@@ -531,6 +531,7 @@ int fsl_rio_setup(struct platform_device *dev)
                sprintf(port->name, "RIO mport %d", i);
 
                priv->dev = &dev->dev;
+               port->dev.parent = &dev->dev;
                port->ops = ops;
                port->priv = priv;
                port->phys_efptr = 0x100;
index 6d1f6ed3113fc1a0604e2db595989bd48c386c3a..a8497183ff8b079985b7930fd5eb26dc9fb44813 100644 (file)
@@ -493,6 +493,7 @@ static int rionet_setup_netdev(struct rio_mport *mport, struct net_device *ndev)
        ndev->netdev_ops = &rionet_netdev_ops;
        ndev->mtu = RIO_MAX_MSG_SIZE - 14;
        ndev->features = NETIF_F_LLTX;
+       SET_NETDEV_DEV(ndev, &mport->dev);
        SET_ETHTOOL_OPS(ndev, &rionet_ethtool_ops);
 
        spin_lock_init(&rnet->lock);
index ff7cbf2d28e3aca513a21999334ae01352208600..1753dc693c15af46c1dd84b5ab1cd63347a99e05 100644 (file)
@@ -2256,6 +2256,7 @@ static int tsi721_setup_mport(struct tsi721_device *priv)
        mport->phy_type = RIO_PHY_SERIAL;
        mport->priv = (void *)priv;
        mport->phys_efptr = 0x100;
+       mport->dev.parent = &pdev->dev;
        priv->mport = mport;
 
        INIT_LIST_HEAD(&mport->dbells);
index c9ae692d34518c97485114cae2c685e6da81e11a..f301f059bb85c1b18820ee45cfe4f08427ae8ec9 100644 (file)
@@ -167,7 +167,6 @@ void rio_unregister_driver(struct rio_driver *rdrv)
 void rio_attach_device(struct rio_dev *rdev)
 {
        rdev->dev.bus = &rio_bus_type;
-       rdev->dev.parent = &rio_bus;
 }
 EXPORT_SYMBOL_GPL(rio_attach_device);
 
@@ -216,9 +215,12 @@ static int rio_uevent(struct device *dev, struct kobj_uevent_env *env)
        return 0;
 }
 
-struct device rio_bus = {
-       .init_name = "rapidio",
+struct class rio_mport_class = {
+       .name           = "rapidio_port",
+       .owner          = THIS_MODULE,
+       .dev_groups     = rio_mport_groups,
 };
+EXPORT_SYMBOL_GPL(rio_mport_class);
 
 struct bus_type rio_bus_type = {
        .name = "rapidio",
@@ -233,14 +235,20 @@ struct bus_type rio_bus_type = {
 /**
  *  rio_bus_init - Register the RapidIO bus with the device model
  *
- *  Registers the RIO bus device and RIO bus type with the Linux
+ *  Registers the RIO mport device class and RIO bus type with the Linux
  *  device model.
  */
 static int __init rio_bus_init(void)
 {
-       if (device_register(&rio_bus) < 0)
-               printk("RIO: failed to register RIO bus device\n");
-       return bus_register(&rio_bus_type);
+       int ret;
+
+       ret = class_register(&rio_mport_class);
+       if (!ret) {
+               ret = bus_register(&rio_bus_type);
+               if (ret)
+                       class_unregister(&rio_mport_class);
+       }
+       return ret;
 }
 
 postcore_initcall(rio_bus_init);
index d3a6539a77cce19ef7ba6f311aed249c8e1cf87d..47a1b2ea76c45a0a02d671bc4d7bee042ec1818c 100644 (file)
@@ -461,6 +461,7 @@ static struct rio_dev *rio_setup_device(struct rio_net *net,
                             rdev->comp_tag & RIO_CTAG_UDEVID);
        }
 
+       rdev->dev.parent = &port->dev;
        rio_attach_device(rdev);
 
        device_initialize(&rdev->dev);
index e0221c6d0cc238543cc84557a9ffb176a64c23f3..cdb005c0094df0b58362db0e6a4b462afd2f0621 100644 (file)
@@ -341,3 +341,43 @@ const struct attribute_group *rio_bus_groups[] = {
        &rio_bus_group,
        NULL,
 };
+
+static ssize_t
+port_destid_show(struct device *dev, struct device_attribute *attr,
+                char *buf)
+{
+       struct rio_mport *mport = to_rio_mport(dev);
+
+       if (mport)
+               return sprintf(buf, "0x%04x\n", mport->host_deviceid);
+       else
+               return -ENODEV;
+}
+static DEVICE_ATTR_RO(port_destid);
+
+static ssize_t sys_size_show(struct device *dev, struct device_attribute *attr,
+                          char *buf)
+{
+       struct rio_mport *mport = to_rio_mport(dev);
+
+       if (mport)
+               return sprintf(buf, "%u\n", mport->sys_size);
+       else
+               return -ENODEV;
+}
+static DEVICE_ATTR_RO(sys_size);
+
+static struct attribute *rio_mport_attrs[] = {
+       &dev_attr_port_destid.attr,
+       &dev_attr_sys_size.attr,
+       NULL,
+};
+
+static const struct attribute_group rio_mport_group = {
+       .attrs = rio_mport_attrs,
+};
+
+const struct attribute_group *rio_mport_groups[] = {
+       &rio_mport_group,
+       NULL,
+};
index 2e8a20cac58848cdd0e2afa6201f3f82f4a88e84..a54ba0494dd3e9105abea0368303712ff4b35c8f 100644 (file)
@@ -1884,6 +1884,7 @@ static int rio_get_hdid(int index)
 int rio_register_mport(struct rio_mport *port)
 {
        struct rio_scan_node *scan = NULL;
+       int res = 0;
 
        if (next_portid >= RIO_MAX_MPORTS) {
                pr_err("RIO: reached specified max number of mports\n");
@@ -1894,6 +1895,16 @@ int rio_register_mport(struct rio_mport *port)
        port->host_deviceid = rio_get_hdid(port->id);
        port->nscan = NULL;
 
+       dev_set_name(&port->dev, "rapidio%d", port->id);
+       port->dev.class = &rio_mport_class;
+
+       res = device_register(&port->dev);
+       if (res)
+               dev_err(&port->dev, "RIO: mport%d registration failed ERR=%d\n",
+                       port->id, res);
+       else
+               dev_dbg(&port->dev, "RIO: mport%d registered\n", port->id);
+
        mutex_lock(&rio_mport_list_lock);
        list_add_tail(&port->node, &rio_mports);
 
index 5f99d22ad0b04534440ba1d17d247c9b127caba2..2d0550e08ea204c2d9b1b1afbdb71cb6b554e4ba 100644 (file)
@@ -50,6 +50,7 @@ extern int rio_mport_scan(int mport_id);
 /* Structures internal to the RIO core code */
 extern const struct attribute_group *rio_dev_groups[];
 extern const struct attribute_group *rio_bus_groups[];
+extern const struct attribute_group *rio_mport_groups[];
 
 #define RIO_GET_DID(size, x)   (size ? (x & 0xffff) : ((x & 0x00ff0000) >> 16))
 #define RIO_SET_DID(size, x)   (size ? (x & 0xffff) : ((x & 0x000000ff) << 16))
index b71d5738e68345345bc1580abae26b2d8e582048..6bda06f21930bcce8ff57ad7eaa5f3afad8bf45d 100644 (file)
@@ -83,7 +83,7 @@
 #define RIO_CTAG_UDEVID        0x0001ffff /* Unique device identifier */
 
 extern struct bus_type rio_bus_type;
-extern struct device rio_bus;
+extern struct class rio_mport_class;
 
 struct rio_mport;
 struct rio_dev;
@@ -201,6 +201,7 @@ struct rio_dev {
 #define rio_dev_f(n) list_entry(n, struct rio_dev, net_list)
 #define        to_rio_dev(n) container_of(n, struct rio_dev, dev)
 #define sw_to_rio_dev(n) container_of(n, struct rio_dev, rswitch[0])
+#define        to_rio_mport(n) container_of(n, struct rio_mport, dev)
 
 /**
  * struct rio_msg - RIO message event
@@ -248,6 +249,7 @@ enum rio_phy_type {
  * @phy_type: RapidIO phy type
  * @phys_efptr: RIO port extended features pointer
  * @name: Port name string
+ * @dev: device structure associated with an mport
  * @priv: Master port private data
  * @dma: DMA device associated with mport
  * @nscan: RapidIO network enumeration/discovery operations
@@ -272,6 +274,7 @@ struct rio_mport {
        enum rio_phy_type phy_type;     /* RapidIO phy type */
        u32 phys_efptr;
        unsigned char name[RIO_MAX_MPORT_NAME];
+       struct device dev;
        void *priv;             /* Master port private data */
 #ifdef CONFIG_RAPIDIO_DMA_ENGINE
        struct dma_device       dma;