Pileus Git - ~andy/linux/blob - drivers/pci/pci-label.c

   1 /*
   2  * Purpose: Export the firmware instance and label associated with
   3  * a pci device to sysfs
   4  * Copyright (C) 2010 Dell Inc.
   5  * by Narendra K <Narendra_K@dell.com>,
   6  * Jordan Hargrave <Jordan_Hargrave@dell.com>
   7  *
   8  * PCI Firmware Specification Revision 3.1 section 4.6.7 (DSM for Naming a
   9  * PCI or PCI Express Device Under Operating Systems) defines an instance
  10  * number and string name. This code retrieves them and exports them to sysfs.
  11  * If the system firmware does not provide the ACPI _DSM (Device Specific
  12  * Method), then the SMBIOS type 41 instance number and string is exported to
  13  * sysfs.
  14  *
  15  * SMBIOS defines type 41 for onboard pci devices. This code retrieves
  16  * the instance number and string from the type 41 record and exports
  17  * it to sysfs.
  18  *
  19  * Please see http://linux.dell.com/wiki/index.php/Oss/libnetdevname for more
  20  * information.
  21  */
  22
  23 #include <linux/dmi.h>
  24 #include <linux/sysfs.h>
  25 #include <linux/pci.h>
  26 #include <linux/pci_ids.h>
  27 #include <linux/module.h>
  28 #include <linux/device.h>
  29 #include <linux/nls.h>
  30 #include <linux/acpi.h>
  31 #include <linux/pci-acpi.h>
  32 #include "pci.h"
  33
  34 #define DEVICE_LABEL_DSM        0x07
  35
  36 #ifndef CONFIG_DMI
  37
  38 static inline int
  39 pci_create_smbiosname_file(struct pci_dev *pdev)
  40 {
  41         return -1;
  42 }
  43
  44 static inline void
  45 pci_remove_smbiosname_file(struct pci_dev *pdev)
  46 {
  47 }
  48
  49 #else
  50
  51 enum smbios_attr_enum {
  52         SMBIOS_ATTR_NONE = 0,
  53         SMBIOS_ATTR_LABEL_SHOW,
  54         SMBIOS_ATTR_INSTANCE_SHOW,
  55 };
  56
  57 static size_t
  58 find_smbios_instance_string(struct pci_dev *pdev, char *buf,
  59                             enum smbios_attr_enum attribute)
  60 {
  61         const struct dmi_device *dmi;
  62         struct dmi_dev_onboard *donboard;
  63         int bus;
  64         int devfn;
  65
  66         bus = pdev->bus->number;
  67         devfn = pdev->devfn;
  68
  69         dmi = NULL;
  70         while ((dmi = dmi_find_device(DMI_DEV_TYPE_DEV_ONBOARD,
  71                                       NULL, dmi)) != NULL) {
  72                 donboard = dmi->device_data;
  73                 if (donboard && donboard->bus == bus &&
  74                                         donboard->devfn == devfn) {
  75                         if (buf) {
  76                                 if (attribute == SMBIOS_ATTR_INSTANCE_SHOW)
  77                                         return scnprintf(buf, PAGE_SIZE,
  78                                                          "%d\n",
  79                                                          donboard->instance);
  80                                 else if (attribute == SMBIOS_ATTR_LABEL_SHOW)
  81                                         return scnprintf(buf, PAGE_SIZE,
  82                                                          "%s\n",
  83                                                          dmi->name);
  84                         }
  85                         return strlen(dmi->name);
  86                 }
  87         }
  88         return 0;
  89 }
  90
  91 static umode_t
  92 smbios_instance_string_exist(struct kobject *kobj, struct attribute *attr,
  93                              int n)
  94 {
  95         struct device *dev;
  96         struct pci_dev *pdev;
  97
  98         dev = container_of(kobj, struct device, kobj);
  99         pdev = to_pci_dev(dev);
 100
 101         return find_smbios_instance_string(pdev, NULL, SMBIOS_ATTR_NONE) ?
 102                                            S_IRUGO : 0;
 103 }
 104
 105 static ssize_t
 106 smbioslabel_show(struct device *dev, struct device_attribute *attr, char *buf)
 107 {
 108         struct pci_dev *pdev;
 109         pdev = to_pci_dev(dev);
 110
 111         return find_smbios_instance_string(pdev, buf,
 112                                            SMBIOS_ATTR_LABEL_SHOW);
 113 }
 114
 115 static ssize_t
 116 smbiosinstance_show(struct device *dev,
 117                     struct device_attribute *attr, char *buf)
 118 {
 119         struct pci_dev *pdev;
 120         pdev = to_pci_dev(dev);
 121
 122         return find_smbios_instance_string(pdev, buf,
 123                                            SMBIOS_ATTR_INSTANCE_SHOW);
 124 }
 125
 126 static struct device_attribute smbios_attr_label = {
 127         .attr = {.name = "label", .mode = 0444},
 128         .show = smbioslabel_show,
 129 };
 130
 131 static struct device_attribute smbios_attr_instance = {
 132         .attr = {.name = "index", .mode = 0444},
 133         .show = smbiosinstance_show,
 134 };
 135
 136 static struct attribute *smbios_attributes[] = {
 137         &smbios_attr_label.attr,
 138         &smbios_attr_instance.attr,
 139         NULL,
 140 };
 141
 142 static struct attribute_group smbios_attr_group = {
 143         .attrs = smbios_attributes,
 144         .is_visible = smbios_instance_string_exist,
 145 };
 146
 147 static int
 148 pci_create_smbiosname_file(struct pci_dev *pdev)
 149 {
 150         return sysfs_create_group(&pdev->dev.kobj, &smbios_attr_group);
 151 }
 152
 153 static void
 154 pci_remove_smbiosname_file(struct pci_dev *pdev)
 155 {
 156         sysfs_remove_group(&pdev->dev.kobj, &smbios_attr_group);
 157 }
 158
 159 #endif
 160
 161 #ifndef CONFIG_ACPI
 162
 163 static inline int
 164 pci_create_acpi_index_label_files(struct pci_dev *pdev)
 165 {
 166         return -1;
 167 }
 168
 169 static inline int
 170 pci_remove_acpi_index_label_files(struct pci_dev *pdev)
 171 {
 172         return -1;
 173 }
 174
 175 static inline bool
 176 device_has_dsm(struct device *dev)
 177 {
 178         return false;
 179 }
 180
 181 #else
 182
 183 static const char device_label_dsm_uuid[] = {
 184         0xD0, 0x37, 0xC9, 0xE5, 0x53, 0x35, 0x7A, 0x4D,
 185         0x91, 0x17, 0xEA, 0x4D, 0x19, 0xC3, 0x43, 0x4D
 186 };
 187
 188 enum acpi_attr_enum {
 189         ACPI_ATTR_LABEL_SHOW,
 190         ACPI_ATTR_INDEX_SHOW,
 191 };
 192
 193 static void dsm_label_utf16s_to_utf8s(union acpi_object *obj, char *buf)
 194 {
 195         int len;
 196         len = utf16s_to_utf8s((const wchar_t *)obj->string.pointer,
 197                               obj->string.length,
 198                               UTF16_LITTLE_ENDIAN,
 199                               buf, PAGE_SIZE);
 200         buf[len] = '\n';
 201 }
 202
 203 static int
 204 dsm_get_label(struct device *dev, char *buf, enum acpi_attr_enum attr)
 205 {
 206         acpi_handle handle;
 207         union acpi_object *obj, *tmp;
 208         int len = -1;
 209
 210         handle = ACPI_HANDLE(dev);
 211         if (!handle)
 212                 return -1;
 213
 214         obj = acpi_evaluate_dsm(handle, device_label_dsm_uuid, 0x2,
 215                                 DEVICE_LABEL_DSM, NULL);
 216         if (!obj)
 217                 return -1;
 218
 219         tmp = obj->package.elements;
 220         if (obj->type == ACPI_TYPE_PACKAGE && obj->package.count == 2 &&
 221             tmp[0].type == ACPI_TYPE_INTEGER &&
 222             tmp[1].type == ACPI_TYPE_STRING) {
 223                 /*
 224                  * The second string element is optional even when
 225                  * this _DSM is implemented; when not implemented,
 226                  * this entry must return a null string.
 227                  */
 228                 if (attr == ACPI_ATTR_INDEX_SHOW)
 229                         scnprintf(buf, PAGE_SIZE, "%llu\n", tmp->integer.value);
 230                 else if (attr == ACPI_ATTR_LABEL_SHOW)
 231                         dsm_label_utf16s_to_utf8s(tmp + 1, buf);
 232                 len = strlen(buf) > 0 ? strlen(buf) : -1;
 233         }
 234
 235         ACPI_FREE(obj);
 236
 237         return len;
 238 }
 239
 240 static bool
 241 device_has_dsm(struct device *dev)
 242 {
 243         acpi_handle handle;
 244
 245         handle = ACPI_HANDLE(dev);
 246         if (!handle)
 247                 return false;
 248
 249         return !!acpi_check_dsm(handle, device_label_dsm_uuid, 0x2,
 250                                 1 << DEVICE_LABEL_DSM);
 251 }
 252
 253 static umode_t
 254 acpi_index_string_exist(struct kobject *kobj, struct attribute *attr, int n)
 255 {
 256         struct device *dev;
 257
 258         dev = container_of(kobj, struct device, kobj);
 259
 260         if (device_has_dsm(dev))
 261                 return S_IRUGO;
 262
 263         return 0;
 264 }
 265
 266 static ssize_t
 267 acpilabel_show(struct device *dev, struct device_attribute *attr, char *buf)
 268 {
 269         return dsm_get_label(dev, buf, ACPI_ATTR_LABEL_SHOW);
 270 }
 271
 272 static ssize_t
 273 acpiindex_show(struct device *dev, struct device_attribute *attr, char *buf)
 274 {
 275         return dsm_get_label(dev, buf, ACPI_ATTR_INDEX_SHOW);
 276 }
 277
 278 static struct device_attribute acpi_attr_label = {
 279         .attr = {.name = "label", .mode = 0444},
 280         .show = acpilabel_show,
 281 };
 282
 283 static struct device_attribute acpi_attr_index = {
 284         .attr = {.name = "acpi_index", .mode = 0444},
 285         .show = acpiindex_show,
 286 };
 287
 288 static struct attribute *acpi_attributes[] = {
 289         &acpi_attr_label.attr,
 290         &acpi_attr_index.attr,
 291         NULL,
 292 };
 293
 294 static struct attribute_group acpi_attr_group = {
 295         .attrs = acpi_attributes,
 296         .is_visible = acpi_index_string_exist,
 297 };
 298
 299 static int
 300 pci_create_acpi_index_label_files(struct pci_dev *pdev)
 301 {
 302         return sysfs_create_group(&pdev->dev.kobj, &acpi_attr_group);
 303 }
 304
 305 static int
 306 pci_remove_acpi_index_label_files(struct pci_dev *pdev)
 307 {
 308         sysfs_remove_group(&pdev->dev.kobj, &acpi_attr_group);
 309         return 0;
 310 }
 311 #endif
 312
 313 void pci_create_firmware_label_files(struct pci_dev *pdev)
 314 {
 315         if (device_has_dsm(&pdev->dev))
 316                 pci_create_acpi_index_label_files(pdev);
 317         else
 318                 pci_create_smbiosname_file(pdev);
 319 }
 320
 321 void pci_remove_firmware_label_files(struct pci_dev *pdev)
 322 {
 323         if (device_has_dsm(&pdev->dev))
 324                 pci_remove_acpi_index_label_files(pdev);
 325         else
 326                 pci_remove_smbiosname_file(pdev);
 327 }