blob: 024b5c179348e26f062a2becab6896c260e26a06 [file] [log] [blame]
Narendra K911e1c92010-07-26 05:56:50 -05001/*
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 *
Narendra_K@Dell.com60589892011-03-02 22:34:17 +05308 * 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 *
Narendra K911e1c92010-07-26 05:56:50 -050015 * 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>
Narendra_K@Dell.com60589892011-03-02 22:34:17 +053029#include <linux/nls.h>
30#include <linux/acpi.h>
31#include <linux/pci-acpi.h>
Narendra K911e1c92010-07-26 05:56:50 -050032#include "pci.h"
33
Bjorn Helgaas4c859802014-01-13 17:01:11 -070034#ifdef CONFIG_DMI
Narendra K911e1c92010-07-26 05:56:50 -050035enum smbios_attr_enum {
36 SMBIOS_ATTR_NONE = 0,
37 SMBIOS_ATTR_LABEL_SHOW,
38 SMBIOS_ATTR_INSTANCE_SHOW,
39};
40
Ryan Desfosses3c78bc62014-04-18 20:13:49 -040041static size_t find_smbios_instance_string(struct pci_dev *pdev, char *buf,
42 enum smbios_attr_enum attribute)
Narendra K911e1c92010-07-26 05:56:50 -050043{
44 const struct dmi_device *dmi;
45 struct dmi_dev_onboard *donboard;
46 int bus;
47 int devfn;
48
49 bus = pdev->bus->number;
50 devfn = pdev->devfn;
51
52 dmi = NULL;
53 while ((dmi = dmi_find_device(DMI_DEV_TYPE_DEV_ONBOARD,
54 NULL, dmi)) != NULL) {
55 donboard = dmi->device_data;
56 if (donboard && donboard->bus == bus &&
57 donboard->devfn == devfn) {
58 if (buf) {
59 if (attribute == SMBIOS_ATTR_INSTANCE_SHOW)
60 return scnprintf(buf, PAGE_SIZE,
61 "%d\n",
62 donboard->instance);
63 else if (attribute == SMBIOS_ATTR_LABEL_SHOW)
64 return scnprintf(buf, PAGE_SIZE,
65 "%s\n",
66 dmi->name);
67 }
68 return strlen(dmi->name);
69 }
70 }
71 return 0;
72}
73
Ryan Desfosses3c78bc62014-04-18 20:13:49 -040074static umode_t smbios_instance_string_exist(struct kobject *kobj,
75 struct attribute *attr, int n)
Narendra K911e1c92010-07-26 05:56:50 -050076{
77 struct device *dev;
78 struct pci_dev *pdev;
79
80 dev = container_of(kobj, struct device, kobj);
81 pdev = to_pci_dev(dev);
82
83 return find_smbios_instance_string(pdev, NULL, SMBIOS_ATTR_NONE) ?
84 S_IRUGO : 0;
85}
86
Ryan Desfosses3c78bc62014-04-18 20:13:49 -040087static ssize_t smbioslabel_show(struct device *dev,
88 struct device_attribute *attr, char *buf)
Narendra K911e1c92010-07-26 05:56:50 -050089{
90 struct pci_dev *pdev;
91 pdev = to_pci_dev(dev);
92
93 return find_smbios_instance_string(pdev, buf,
94 SMBIOS_ATTR_LABEL_SHOW);
95}
96
Ryan Desfosses3c78bc62014-04-18 20:13:49 -040097static ssize_t smbiosinstance_show(struct device *dev,
98 struct device_attribute *attr, char *buf)
Narendra K911e1c92010-07-26 05:56:50 -050099{
100 struct pci_dev *pdev;
101 pdev = to_pci_dev(dev);
102
103 return find_smbios_instance_string(pdev, buf,
104 SMBIOS_ATTR_INSTANCE_SHOW);
105}
106
107static struct device_attribute smbios_attr_label = {
Stephen Rothwell763e9db2010-08-04 14:25:31 +1000108 .attr = {.name = "label", .mode = 0444},
Narendra K911e1c92010-07-26 05:56:50 -0500109 .show = smbioslabel_show,
110};
111
112static struct device_attribute smbios_attr_instance = {
Stephen Rothwell763e9db2010-08-04 14:25:31 +1000113 .attr = {.name = "index", .mode = 0444},
Narendra K911e1c92010-07-26 05:56:50 -0500114 .show = smbiosinstance_show,
115};
116
117static struct attribute *smbios_attributes[] = {
118 &smbios_attr_label.attr,
119 &smbios_attr_instance.attr,
120 NULL,
121};
122
123static struct attribute_group smbios_attr_group = {
124 .attrs = smbios_attributes,
125 .is_visible = smbios_instance_string_exist,
126};
127
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400128static int pci_create_smbiosname_file(struct pci_dev *pdev)
Narendra K911e1c92010-07-26 05:56:50 -0500129{
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530130 return sysfs_create_group(&pdev->dev.kobj, &smbios_attr_group);
Narendra K911e1c92010-07-26 05:56:50 -0500131}
132
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400133static void pci_remove_smbiosname_file(struct pci_dev *pdev)
Narendra K911e1c92010-07-26 05:56:50 -0500134{
135 sysfs_remove_group(&pdev->dev.kobj, &smbios_attr_group);
136}
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700137#else
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400138static inline int pci_create_smbiosname_file(struct pci_dev *pdev)
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700139{
140 return -1;
141}
Narendra K911e1c92010-07-26 05:56:50 -0500142
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400143static inline void pci_remove_smbiosname_file(struct pci_dev *pdev)
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700144{
145}
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530146#endif
147
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700148#ifdef CONFIG_ACPI
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530149enum acpi_attr_enum {
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530150 ACPI_ATTR_LABEL_SHOW,
151 ACPI_ATTR_INDEX_SHOW,
152};
153
154static void dsm_label_utf16s_to_utf8s(union acpi_object *obj, char *buf)
155{
156 int len;
Simone Gottidcfa9be2014-06-18 16:55:30 +0200157 len = utf16s_to_utf8s((const wchar_t *)obj->buffer.pointer,
158 obj->buffer.length,
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530159 UTF16_LITTLE_ENDIAN,
160 buf, PAGE_SIZE);
161 buf[len] = '\n';
162}
163
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400164static int dsm_get_label(struct device *dev, char *buf,
165 enum acpi_attr_enum attr)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530166{
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800167 acpi_handle handle;
168 union acpi_object *obj, *tmp;
169 int len = -1;
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530170
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800171 handle = ACPI_HANDLE(dev);
172 if (!handle)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530173 return -1;
174
Aaron Lu18e94a32015-03-25 14:31:41 +0800175 obj = acpi_evaluate_dsm(handle, pci_acpi_dsm_uuid, 0x2,
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800176 DEVICE_LABEL_DSM, NULL);
177 if (!obj)
178 return -1;
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530179
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800180 tmp = obj->package.elements;
181 if (obj->type == ACPI_TYPE_PACKAGE && obj->package.count == 2 &&
182 tmp[0].type == ACPI_TYPE_INTEGER &&
Simone Gottidcfa9be2014-06-18 16:55:30 +0200183 (tmp[1].type == ACPI_TYPE_STRING ||
184 tmp[1].type == ACPI_TYPE_BUFFER)) {
Jiang Liu2fc59fe2013-12-19 20:38:14 +0800185 /*
186 * The second string element is optional even when
187 * this _DSM is implemented; when not implemented,
188 * this entry must return a null string.
189 */
Simone Gottidcfa9be2014-06-18 16:55:30 +0200190 if (attr == ACPI_ATTR_INDEX_SHOW) {
Jiang Liu2fc59fe2013-12-19 20:38:14 +0800191 scnprintf(buf, PAGE_SIZE, "%llu\n", tmp->integer.value);
Simone Gottidcfa9be2014-06-18 16:55:30 +0200192 } else if (attr == ACPI_ATTR_LABEL_SHOW) {
193 if (tmp[1].type == ACPI_TYPE_STRING)
194 scnprintf(buf, PAGE_SIZE, "%s\n",
195 tmp[1].string.pointer);
196 else if (tmp[1].type == ACPI_TYPE_BUFFER)
197 dsm_label_utf16s_to_utf8s(tmp + 1, buf);
198 }
Jiang Liu2fc59fe2013-12-19 20:38:14 +0800199 len = strlen(buf) > 0 ? strlen(buf) : -1;
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530200 }
Jiang Liu54e5bb42013-12-19 20:38:12 +0800201
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800202 ACPI_FREE(obj);
Jiang Liu54e5bb42013-12-19 20:38:12 +0800203
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800204 return len;
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530205}
206
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400207static bool device_has_dsm(struct device *dev)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530208{
209 acpi_handle handle;
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530210
Rafael J. Wysocki3a83f992013-11-14 23:17:21 +0100211 handle = ACPI_HANDLE(dev);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530212 if (!handle)
Jiang Liu2fc59fe2013-12-19 20:38:14 +0800213 return false;
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530214
Aaron Lu18e94a32015-03-25 14:31:41 +0800215 return !!acpi_check_dsm(handle, pci_acpi_dsm_uuid, 0x2,
Jiang Liu2fc59fe2013-12-19 20:38:14 +0800216 1 << DEVICE_LABEL_DSM);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530217}
218
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400219static umode_t acpi_index_string_exist(struct kobject *kobj,
220 struct attribute *attr, int n)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530221{
222 struct device *dev;
223
224 dev = container_of(kobj, struct device, kobj);
225
226 if (device_has_dsm(dev))
227 return S_IRUGO;
228
229 return 0;
230}
231
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400232static ssize_t acpilabel_show(struct device *dev,
233 struct device_attribute *attr, char *buf)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530234{
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800235 return dsm_get_label(dev, buf, ACPI_ATTR_LABEL_SHOW);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530236}
237
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400238static ssize_t acpiindex_show(struct device *dev,
239 struct device_attribute *attr, char *buf)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530240{
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800241 return dsm_get_label(dev, buf, ACPI_ATTR_INDEX_SHOW);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530242}
243
244static struct device_attribute acpi_attr_label = {
245 .attr = {.name = "label", .mode = 0444},
246 .show = acpilabel_show,
247};
248
249static struct device_attribute acpi_attr_index = {
250 .attr = {.name = "acpi_index", .mode = 0444},
251 .show = acpiindex_show,
252};
253
254static struct attribute *acpi_attributes[] = {
255 &acpi_attr_label.attr,
256 &acpi_attr_index.attr,
257 NULL,
258};
259
260static struct attribute_group acpi_attr_group = {
261 .attrs = acpi_attributes,
262 .is_visible = acpi_index_string_exist,
263};
264
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400265static int pci_create_acpi_index_label_files(struct pci_dev *pdev)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530266{
267 return sysfs_create_group(&pdev->dev.kobj, &acpi_attr_group);
268}
269
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400270static int pci_remove_acpi_index_label_files(struct pci_dev *pdev)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530271{
272 sysfs_remove_group(&pdev->dev.kobj, &acpi_attr_group);
273 return 0;
274}
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700275#else
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400276static inline int pci_create_acpi_index_label_files(struct pci_dev *pdev)
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700277{
278 return -1;
279}
280
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400281static inline int pci_remove_acpi_index_label_files(struct pci_dev *pdev)
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700282{
283 return -1;
284}
285
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400286static inline bool device_has_dsm(struct device *dev)
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700287{
288 return false;
289}
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530290#endif
291
Narendra K911e1c92010-07-26 05:56:50 -0500292void pci_create_firmware_label_files(struct pci_dev *pdev)
293{
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530294 if (device_has_dsm(&pdev->dev))
295 pci_create_acpi_index_label_files(pdev);
296 else
297 pci_create_smbiosname_file(pdev);
Narendra K911e1c92010-07-26 05:56:50 -0500298}
299
300void pci_remove_firmware_label_files(struct pci_dev *pdev)
301{
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530302 if (device_has_dsm(&pdev->dev))
303 pci_remove_acpi_index_label_files(pdev);
304 else
305 pci_remove_smbiosname_file(pdev);
Narendra K911e1c92010-07-26 05:56:50 -0500306}