arch/sparc/kernel/vio.c

   1 /* vio.c: Virtual I/O channel devices probing infrastructure.
   2  *
   3  *    Copyright (c) 2003-2005 IBM Corp.
   4  *     Dave Engebretsen engebret@us.ibm.com
   5  *     Santiago Leon santil@us.ibm.com
   6  *     Hollis Blanchard <hollisb@us.ibm.com>
   7  *     Stephen Rothwell
   8  *
   9  * Adapted to sparc64 by David S. Miller davem@davemloft.net
  10  */
  11
  12 #include <linux/kernel.h>
  13 #include <linux/slab.h>
  14 #include <linux/irq.h>
  15 #include <linux/export.h>
  16 #include <linux/init.h>
  17
  18 #include <asm/mdesc.h>
  19 #include <asm/vio.h>
  20
  21 static const struct vio_device_id *vio_match_device(
  22         const struct vio_device_id *matches,
  23         const struct vio_dev *dev)
  24 {
  25         const char *type, *compat;
  26         int len;
  27
  28         type = dev->type;
  29         compat = dev->compat;
  30         len = dev->compat_len;
  31
  32         while (matches->type[0] || matches->compat[0]) {
  33                 int match = 1;
  34                 if (matches->type[0])
  35                         match &= !strcmp(matches->type, type);
  36
  37                 if (matches->compat[0]) {
  38                         match &= len &&
  39                                 of_find_in_proplist(compat, matches->compat, len);
  40                 }
  41                 if (match)
  42                         return matches;
  43                 matches++;
  44         }
  45         return NULL;
  46 }
  47
  48 static int vio_bus_match(struct device *dev, struct device_driver *drv)
  49 {
  50         struct vio_dev *vio_dev = to_vio_dev(dev);
  51         struct vio_driver *vio_drv = to_vio_driver(drv);
  52         const struct vio_device_id *matches = vio_drv->id_table;
  53
  54         if (!matches)
  55                 return 0;
  56
  57         return vio_match_device(matches, vio_dev) != NULL;
  58 }
  59
  60 static int vio_device_probe(struct device *dev)
  61 {
  62         struct vio_dev *vdev = to_vio_dev(dev);
  63         struct vio_driver *drv = to_vio_driver(dev->driver);
  64         const struct vio_device_id *id;
  65         int error = -ENODEV;
  66
  67         if (drv->probe) {
  68                 id = vio_match_device(drv->id_table, vdev);
  69                 if (id)
  70                         error = drv->probe(vdev, id);
  71         }
  72
  73         return error;
  74 }
  75
  76 static int vio_device_remove(struct device *dev)
  77 {
  78         struct vio_dev *vdev = to_vio_dev(dev);
  79         struct vio_driver *drv = to_vio_driver(dev->driver);
  80
  81         if (drv->remove)
  82                 return drv->remove(vdev);
  83
  84         return 1;
  85 }
  86
  87 static ssize_t devspec_show(struct device *dev,
  88                 struct device_attribute *attr, char *buf)
  89 {
  90         struct vio_dev *vdev = to_vio_dev(dev);
  91         const char *str = "none";
  92
  93         if (!strcmp(vdev->type, "vnet-port"))
  94                 str = "vnet";
  95         else if (!strcmp(vdev->type, "vdc-port"))
  96                 str = "vdisk";
  97
  98         return sprintf(buf, "%s\n", str);
  99 }
 100
 101 static ssize_t type_show(struct device *dev,
 102                 struct device_attribute *attr, char *buf)
 103 {
 104         struct vio_dev *vdev = to_vio_dev(dev);
 105         return sprintf(buf, "%s\n", vdev->type);
 106 }
 107
 108 static struct device_attribute vio_dev_attrs[] = {
 109         __ATTR_RO(devspec),
 110         __ATTR_RO(type),
 111         __ATTR_NULL
 112 };
 113
 114 static struct bus_type vio_bus_type = {
 115         .name           = "vio",
 116         .dev_attrs      = vio_dev_attrs,
 117         .match          = vio_bus_match,
 118         .probe          = vio_device_probe,
 119         .remove         = vio_device_remove,
 120 };
 121
 122 int __vio_register_driver(struct vio_driver *viodrv, struct module *owner,
 123                         const char *mod_name)
 124 {
 125         viodrv->driver.bus = &vio_bus_type;
 126         viodrv->driver.name = viodrv->name;
 127         viodrv->driver.owner = owner;
 128         viodrv->driver.mod_name = mod_name;
 129
 130         return driver_register(&viodrv->driver);
 131 }
 132 EXPORT_SYMBOL(__vio_register_driver);
 133
 134 void vio_unregister_driver(struct vio_driver *viodrv)
 135 {
 136         driver_unregister(&viodrv->driver);
 137 }
 138 EXPORT_SYMBOL(vio_unregister_driver);
 139
 140 static void vio_dev_release(struct device *dev)
 141 {
 142         kfree(to_vio_dev(dev));
 143 }
 144
 145 static ssize_t
 146 show_pciobppath_attr(struct device *dev, struct device_attribute *attr,
 147                      char *buf)
 148 {
 149         struct vio_dev *vdev;
 150         struct device_node *dp;
 151
 152         vdev = to_vio_dev(dev);
 153         dp = vdev->dp;
 154
 155         return snprintf (buf, PAGE_SIZE, "%s\n", dp->full_name);
 156 }
 157
 158 static DEVICE_ATTR(obppath, S_IRUSR | S_IRGRP | S_IROTH,
 159                    show_pciobppath_attr, NULL);
 160
 161 static struct device_node *cdev_node;
 162
 163 static struct vio_dev *root_vdev;
 164 static u64 cdev_cfg_handle;
 165
 166 static void vio_fill_channel_info(struct mdesc_handle *hp, u64 mp,
 167                                   struct vio_dev *vdev)
 168 {
 169         u64 a;
 170
 171         mdesc_for_each_arc(a, hp, mp, MDESC_ARC_TYPE_FWD) {
 172                 const u64 *chan_id;
 173                 const u64 *irq;
 174                 u64 target;
 175
 176                 target = mdesc_arc_target(hp, a);
 177
 178                 irq = mdesc_get_property(hp, target, "tx-ino", NULL);
 179                 if (irq)
 180                         vdev->tx_irq = sun4v_build_virq(cdev_cfg_handle, *irq);
 181
 182                 irq = mdesc_get_property(hp, target, "rx-ino", NULL);
 183                 if (irq) {
 184                         vdev->rx_irq = sun4v_build_virq(cdev_cfg_handle, *irq);
 185                         vdev->rx_ino = *irq;
 186                 }
 187
 188                 chan_id = mdesc_get_property(hp, target, "id", NULL);
 189                 if (chan_id)
 190                         vdev->channel_id = *chan_id;
 191         }
 192 }
 193
 194 int vio_set_intr(unsigned long dev_ino, int state)
 195 {
 196         int err;
 197
 198         err = sun4v_vintr_set_valid(cdev_cfg_handle, dev_ino, state);
 199         return err;
 200 }
 201 EXPORT_SYMBOL(vio_set_intr);
 202
 203 static struct vio_dev *vio_create_one(struct mdesc_handle *hp, u64 mp,
 204                                       struct device *parent)
 205 {
 206         const char *type, *compat, *bus_id_name;
 207         struct device_node *dp;
 208         struct vio_dev *vdev;
 209         int err, tlen, clen;
 210         const u64 *id, *cfg_handle;
 211         u64 a;
 212
 213         type = mdesc_get_property(hp, mp, "device-type", &tlen);
 214         if (!type) {
 215                 type = mdesc_get_property(hp, mp, "name", &tlen);
 216                 if (!type) {
 217                         type = mdesc_node_name(hp, mp);
 218                         tlen = strlen(type) + 1;
 219                 }
 220         }
 221         if (tlen > VIO_MAX_TYPE_LEN) {
 222                 printk(KERN_ERR "VIO: Type string [%s] is too long.\n",
 223                        type);
 224                 return NULL;
 225         }
 226
 227         id = mdesc_get_property(hp, mp, "id", NULL);
 228
 229         cfg_handle = NULL;
 230         mdesc_for_each_arc(a, hp, mp, MDESC_ARC_TYPE_BACK) {
 231                 u64 target;
 232
 233                 target = mdesc_arc_target(hp, a);
 234                 cfg_handle = mdesc_get_property(hp, target,
 235                                                 "cfg-handle", NULL);
 236                 if (cfg_handle)
 237                         break;
 238         }
 239
 240         bus_id_name = type;
 241         if (!strcmp(type, "domain-services-port"))
 242                 bus_id_name = "ds";
 243
 244         /*
 245          * 20 char is the old driver-core name size limit, which is no more.
 246          * This check can probably be removed after review and possible
 247          * adaption of the vio users name length handling.
 248          */
 249         if (strlen(bus_id_name) >= 20 - 4) {
 250                 printk(KERN_ERR "VIO: bus_id_name [%s] is too long.\n",
 251                        bus_id_name);
 252                 return NULL;
 253         }
 254
 255         compat = mdesc_get_property(hp, mp, "device-type", &clen);
 256         if (!compat) {
 257                 clen = 0;
 258         } else if (clen > VIO_MAX_COMPAT_LEN) {
 259                 printk(KERN_ERR "VIO: Compat len %d for [%s] is too long.\n",
 260                        clen, type);
 261                 return NULL;
 262         }
 263
 264         vdev = kzalloc(sizeof(*vdev), GFP_KERNEL);
 265         if (!vdev) {
 266                 printk(KERN_ERR "VIO: Could not allocate vio_dev\n");
 267                 return NULL;
 268         }
 269
 270         vdev->mp = mp;
 271         memcpy(vdev->type, type, tlen);
 272         if (compat)
 273                 memcpy(vdev->compat, compat, clen);
 274         else
 275                 memset(vdev->compat, 0, sizeof(vdev->compat));
 276         vdev->compat_len = clen;
 277
 278         vdev->channel_id = ~0UL;
 279         vdev->tx_irq = ~0;
 280         vdev->rx_irq = ~0;
 281
 282         vio_fill_channel_info(hp, mp, vdev);
 283
 284         if (!id) {
 285                 dev_set_name(&vdev->dev, "%s", bus_id_name);
 286                 vdev->dev_no = ~(u64)0;
 287                 vdev->id = ~(u64)0;
 288         } else if (!cfg_handle) {
 289                 dev_set_name(&vdev->dev, "%s-%llu", bus_id_name, *id);
 290                 vdev->dev_no = *id;
 291                 vdev->id = ~(u64)0;
 292         } else {
 293                 dev_set_name(&vdev->dev, "%s-%llu-%llu", bus_id_name,
 294                              *cfg_handle, *id);
 295                 vdev->dev_no = *cfg_handle;
 296                 vdev->id = *id;
 297         }
 298
 299         vdev->dev.parent = parent;
 300         vdev->dev.bus = &vio_bus_type;
 301         vdev->dev.release = vio_dev_release;
 302
 303         if (parent == NULL) {
 304                 dp = cdev_node;
 305         } else if (to_vio_dev(parent) == root_vdev) {
 306                 dp = of_get_next_child(cdev_node, NULL);
 307                 while (dp) {
 308                         if (!strcmp(dp->type, type))
 309                                 break;
 310
 311                         dp = of_get_next_child(cdev_node, dp);
 312                 }
 313         } else {
 314                 dp = to_vio_dev(parent)->dp;
 315         }
 316         vdev->dp = dp;
 317
 318         printk(KERN_INFO "VIO: Adding device %s\n", dev_name(&vdev->dev));
 319
 320         err = device_register(&vdev->dev);
 321         if (err) {
 322                 printk(KERN_ERR "VIO: Could not register device %s, err=%d\n",
 323                        dev_name(&vdev->dev), err);
 324                 kfree(vdev);
 325                 return NULL;
 326         }
 327         if (vdev->dp)
 328                 err = sysfs_create_file(&vdev->dev.kobj,
 329                                         &dev_attr_obppath.attr);
 330
 331         return vdev;
 332 }
 333
 334 static void vio_add(struct mdesc_handle *hp, u64 node)
 335 {
 336         (void) vio_create_one(hp, node, &root_vdev->dev);
 337 }
 338
 339 struct vio_md_node_query {
 340         const char *type;
 341         u64 dev_no;
 342         u64 id;
 343 };
 344
 345 static int vio_md_node_match(struct device *dev, void *arg)
 346 {
 347         struct vio_md_node_query *query = (struct vio_md_node_query *) arg;
 348         struct vio_dev *vdev = to_vio_dev(dev);
 349
 350         if (vdev->dev_no != query->dev_no)
 351                 return 0;
 352         if (vdev->id != query->id)
 353                 return 0;
 354         if (strcmp(vdev->type, query->type))
 355                 return 0;
 356
 357         return 1;
 358 }
 359
 360 static void vio_remove(struct mdesc_handle *hp, u64 node)
 361 {
 362         const char *type;
 363         const u64 *id, *cfg_handle;
 364         u64 a;
 365         struct vio_md_node_query query;
 366         struct device *dev;
 367
 368         type = mdesc_get_property(hp, node, "device-type", NULL);
 369         if (!type) {
 370                 type = mdesc_get_property(hp, node, "name", NULL);
 371                 if (!type)
 372                         type = mdesc_node_name(hp, node);
 373         }
 374
 375         query.type = type;
 376
 377         id = mdesc_get_property(hp, node, "id", NULL);
 378         cfg_handle = NULL;
 379         mdesc_for_each_arc(a, hp, node, MDESC_ARC_TYPE_BACK) {
 380                 u64 target;
 381
 382                 target = mdesc_arc_target(hp, a);
 383                 cfg_handle = mdesc_get_property(hp, target,
 384                                                 "cfg-handle", NULL);
 385                 if (cfg_handle)
 386                         break;
 387         }
 388
 389         if (!id) {
 390                 query.dev_no = ~(u64)0;
 391                 query.id = ~(u64)0;
 392         } else if (!cfg_handle) {
 393                 query.dev_no = *id;
 394                 query.id = ~(u64)0;
 395         } else {
 396                 query.dev_no = *cfg_handle;
 397                 query.id = *id;
 398         }
 399
 400         dev = device_find_child(&root_vdev->dev, &query,
 401                                 vio_md_node_match);
 402         if (dev) {
 403                 printk(KERN_INFO "VIO: Removing device %s\n", dev_name(dev));
 404
 405                 device_unregister(dev);
 406                 put_device(dev);
 407         } else {
 408                 if (!id)
 409                         printk(KERN_ERR "VIO: Removed unknown %s node.\n",
 410                                type);
 411                 else if (!cfg_handle)
 412                         printk(KERN_ERR "VIO: Removed unknown %s node %llu.\n",
 413                                type, *id);
 414                 else
 415                         printk(KERN_ERR "VIO: Removed unknown %s node %llu-%llu.\n",
 416                                type, *cfg_handle, *id);
 417         }
 418 }
 419
 420 static struct mdesc_notifier_client vio_device_notifier = {
 421         .add            = vio_add,
 422         .remove         = vio_remove,
 423         .node_name      = "virtual-device-port",
 424 };
 425
 426 /* We are only interested in domain service ports under the
 427  * "domain-services" node.  On control nodes there is another port
 428  * under "openboot" that we should not mess with as aparently that is
 429  * reserved exclusively for OBP use.
 430  */
 431 static void vio_add_ds(struct mdesc_handle *hp, u64 node)
 432 {
 433         int found;
 434         u64 a;
 435
 436         found = 0;
 437         mdesc_for_each_arc(a, hp, node, MDESC_ARC_TYPE_BACK) {
 438                 u64 target = mdesc_arc_target(hp, a);
 439                 const char *name = mdesc_node_name(hp, target);
 440
 441                 if (!strcmp(name, "domain-services")) {
 442                         found = 1;
 443                         break;
 444                 }
 445         }
 446
 447         if (found)
 448                 (void) vio_create_one(hp, node, &root_vdev->dev);
 449 }
 450
 451 static struct mdesc_notifier_client vio_ds_notifier = {
 452         .add            = vio_add_ds,
 453         .remove         = vio_remove,
 454         .node_name      = "domain-services-port",
 455 };
 456
 457 static const char *channel_devices_node = "channel-devices";
 458 static const char *channel_devices_compat = "SUNW,sun4v-channel-devices";
 459 static const char *cfg_handle_prop = "cfg-handle";
 460
 461 static int __init vio_init(void)
 462 {
 463         struct mdesc_handle *hp;
 464         const char *compat;
 465         const u64 *cfg_handle;
 466         int err, len;
 467         u64 root;
 468
 469         err = bus_register(&vio_bus_type);
 470         if (err) {
 471                 printk(KERN_ERR "VIO: Could not register bus type err=%d\n",
 472                        err);
 473                 return err;
 474         }
 475
 476         hp = mdesc_grab();
 477         if (!hp)
 478                 return 0;
 479
 480         root = mdesc_node_by_name(hp, MDESC_NODE_NULL, channel_devices_node);
 481         if (root == MDESC_NODE_NULL) {
 482                 printk(KERN_INFO "VIO: No channel-devices MDESC node.\n");
 483                 mdesc_release(hp);
 484                 return 0;
 485         }
 486
 487         cdev_node = of_find_node_by_name(NULL, "channel-devices");
 488         err = -ENODEV;
 489         if (!cdev_node) {
 490                 printk(KERN_INFO "VIO: No channel-devices OBP node.\n");
 491                 goto out_release;
 492         }
 493
 494         compat = mdesc_get_property(hp, root, "compatible", &len);
 495         if (!compat) {
 496                 printk(KERN_ERR "VIO: Channel devices lacks compatible "
 497                        "property\n");
 498                 goto out_release;
 499         }
 500         if (!of_find_in_proplist(compat, channel_devices_compat, len)) {
 501                 printk(KERN_ERR "VIO: Channel devices node lacks (%s) "
 502                        "compat entry.\n", channel_devices_compat);
 503                 goto out_release;
 504         }
 505
 506         cfg_handle = mdesc_get_property(hp, root, cfg_handle_prop, NULL);
 507         if (!cfg_handle) {
 508                 printk(KERN_ERR "VIO: Channel devices lacks %s property\n",
 509                        cfg_handle_prop);
 510                 goto out_release;
 511         }
 512
 513         cdev_cfg_handle = *cfg_handle;
 514
 515         root_vdev = vio_create_one(hp, root, NULL);
 516         err = -ENODEV;
 517         if (!root_vdev) {
 518                 printk(KERN_ERR "VIO: Could not create root device.\n");
 519                 goto out_release;
 520         }
 521
 522         mdesc_register_notifier(&vio_device_notifier);
 523         mdesc_register_notifier(&vio_ds_notifier);
 524
 525         mdesc_release(hp);
 526
 527         return err;
 528
 529 out_release:
 530         mdesc_release(hp);
 531         return err;
 532 }
 533
 534 postcore_initcall(vio_init);