blob: 6beafc1bee96a162a5b07d0e7c45e86dc596065a [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Narendra K911e1c92010-07-26 05:56:50 -05002/*
3 * Purpose: Export the firmware instance and label associated with
4 * a pci device to sysfs
5 * Copyright (C) 2010 Dell Inc.
6 * by Narendra K <Narendra_K@dell.com>,
7 * Jordan Hargrave <Jordan_Hargrave@dell.com>
8 *
Narendra_K@Dell.com60589892011-03-02 22:34:17 +05309 * PCI Firmware Specification Revision 3.1 section 4.6.7 (DSM for Naming a
10 * PCI or PCI Express Device Under Operating Systems) defines an instance
11 * number and string name. This code retrieves them and exports them to sysfs.
12 * If the system firmware does not provide the ACPI _DSM (Device Specific
13 * Method), then the SMBIOS type 41 instance number and string is exported to
14 * sysfs.
15 *
Narendra K911e1c92010-07-26 05:56:50 -050016 * SMBIOS defines type 41 for onboard pci devices. This code retrieves
17 * the instance number and string from the type 41 record and exports
18 * it to sysfs.
19 *
Naga Venkata Sai Indubhaskar Jupudi6ca72272016-02-09 14:10:16 -080020 * Please see http://linux.dell.com/files/biosdevname/ for more
Narendra K911e1c92010-07-26 05:56:50 -050021 * information.
22 */
23
24#include <linux/dmi.h>
25#include <linux/sysfs.h>
26#include <linux/pci.h>
27#include <linux/pci_ids.h>
28#include <linux/module.h>
29#include <linux/device.h>
Narendra_K@Dell.com60589892011-03-02 22:34:17 +053030#include <linux/nls.h>
31#include <linux/acpi.h>
32#include <linux/pci-acpi.h>
Narendra K911e1c92010-07-26 05:56:50 -050033#include "pci.h"
34
Bjorn Helgaas4c859802014-01-13 17:01:11 -070035#ifdef CONFIG_DMI
Narendra K911e1c92010-07-26 05:56:50 -050036enum smbios_attr_enum {
37 SMBIOS_ATTR_NONE = 0,
38 SMBIOS_ATTR_LABEL_SHOW,
39 SMBIOS_ATTR_INSTANCE_SHOW,
40};
41
Ryan Desfosses3c78bc62014-04-18 20:13:49 -040042static size_t find_smbios_instance_string(struct pci_dev *pdev, char *buf,
43 enum smbios_attr_enum attribute)
Narendra K911e1c92010-07-26 05:56:50 -050044{
45 const struct dmi_device *dmi;
46 struct dmi_dev_onboard *donboard;
Sujith Pandel6c51c822017-05-02 06:55:40 -040047 int domain_nr;
Narendra K911e1c92010-07-26 05:56:50 -050048 int bus;
49 int devfn;
50
Sujith Pandel6c51c822017-05-02 06:55:40 -040051 domain_nr = pci_domain_nr(pdev->bus);
Narendra K911e1c92010-07-26 05:56:50 -050052 bus = pdev->bus->number;
53 devfn = pdev->devfn;
54
55 dmi = NULL;
56 while ((dmi = dmi_find_device(DMI_DEV_TYPE_DEV_ONBOARD,
57 NULL, dmi)) != NULL) {
58 donboard = dmi->device_data;
Sujith Pandel6c51c822017-05-02 06:55:40 -040059 if (donboard && donboard->segment == domain_nr &&
60 donboard->bus == bus &&
61 donboard->devfn == devfn) {
Narendra K911e1c92010-07-26 05:56:50 -050062 if (buf) {
63 if (attribute == SMBIOS_ATTR_INSTANCE_SHOW)
64 return scnprintf(buf, PAGE_SIZE,
65 "%d\n",
66 donboard->instance);
67 else if (attribute == SMBIOS_ATTR_LABEL_SHOW)
68 return scnprintf(buf, PAGE_SIZE,
69 "%s\n",
70 dmi->name);
71 }
72 return strlen(dmi->name);
73 }
74 }
75 return 0;
76}
77
Ryan Desfosses3c78bc62014-04-18 20:13:49 -040078static umode_t smbios_instance_string_exist(struct kobject *kobj,
79 struct attribute *attr, int n)
Narendra K911e1c92010-07-26 05:56:50 -050080{
81 struct device *dev;
82 struct pci_dev *pdev;
83
Geliang Tang554a6032015-12-23 20:28:13 +080084 dev = kobj_to_dev(kobj);
Narendra K911e1c92010-07-26 05:56:50 -050085 pdev = to_pci_dev(dev);
86
87 return find_smbios_instance_string(pdev, NULL, SMBIOS_ATTR_NONE) ?
88 S_IRUGO : 0;
89}
90
Ryan Desfosses3c78bc62014-04-18 20:13:49 -040091static ssize_t smbioslabel_show(struct device *dev,
92 struct device_attribute *attr, char *buf)
Narendra K911e1c92010-07-26 05:56:50 -050093{
94 struct pci_dev *pdev;
95 pdev = to_pci_dev(dev);
96
97 return find_smbios_instance_string(pdev, buf,
98 SMBIOS_ATTR_LABEL_SHOW);
99}
100
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400101static ssize_t smbiosinstance_show(struct device *dev,
102 struct device_attribute *attr, char *buf)
Narendra K911e1c92010-07-26 05:56:50 -0500103{
104 struct pci_dev *pdev;
105 pdev = to_pci_dev(dev);
106
107 return find_smbios_instance_string(pdev, buf,
108 SMBIOS_ATTR_INSTANCE_SHOW);
109}
110
111static struct device_attribute smbios_attr_label = {
Stephen Rothwell763e9db2010-08-04 14:25:31 +1000112 .attr = {.name = "label", .mode = 0444},
Narendra K911e1c92010-07-26 05:56:50 -0500113 .show = smbioslabel_show,
114};
115
116static struct device_attribute smbios_attr_instance = {
Stephen Rothwell763e9db2010-08-04 14:25:31 +1000117 .attr = {.name = "index", .mode = 0444},
Narendra K911e1c92010-07-26 05:56:50 -0500118 .show = smbiosinstance_show,
119};
120
121static struct attribute *smbios_attributes[] = {
122 &smbios_attr_label.attr,
123 &smbios_attr_instance.attr,
124 NULL,
125};
126
Arvind Yadavf4841282017-07-11 14:57:08 +0530127static const struct attribute_group smbios_attr_group = {
Narendra K911e1c92010-07-26 05:56:50 -0500128 .attrs = smbios_attributes,
129 .is_visible = smbios_instance_string_exist,
130};
131
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400132static int pci_create_smbiosname_file(struct pci_dev *pdev)
Narendra K911e1c92010-07-26 05:56:50 -0500133{
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530134 return sysfs_create_group(&pdev->dev.kobj, &smbios_attr_group);
Narendra K911e1c92010-07-26 05:56:50 -0500135}
136
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400137static void pci_remove_smbiosname_file(struct pci_dev *pdev)
Narendra K911e1c92010-07-26 05:56:50 -0500138{
139 sysfs_remove_group(&pdev->dev.kobj, &smbios_attr_group);
140}
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700141#else
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400142static inline int pci_create_smbiosname_file(struct pci_dev *pdev)
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700143{
144 return -1;
145}
Narendra K911e1c92010-07-26 05:56:50 -0500146
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400147static inline void pci_remove_smbiosname_file(struct pci_dev *pdev)
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700148{
149}
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530150#endif
151
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700152#ifdef CONFIG_ACPI
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530153enum acpi_attr_enum {
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530154 ACPI_ATTR_LABEL_SHOW,
155 ACPI_ATTR_INDEX_SHOW,
156};
157
158static void dsm_label_utf16s_to_utf8s(union acpi_object *obj, char *buf)
159{
160 int len;
Simone Gottidcfa9be2014-06-18 16:55:30 +0200161 len = utf16s_to_utf8s((const wchar_t *)obj->buffer.pointer,
162 obj->buffer.length,
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530163 UTF16_LITTLE_ENDIAN,
Krzysztof Wilczyńskibe6225e2021-06-03 00:01:12 +0000164 buf, PAGE_SIZE - 1);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530165 buf[len] = '\n';
166}
167
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400168static int dsm_get_label(struct device *dev, char *buf,
169 enum acpi_attr_enum attr)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530170{
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800171 acpi_handle handle;
172 union acpi_object *obj, *tmp;
173 int len = -1;
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530174
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800175 handle = ACPI_HANDLE(dev);
176 if (!handle)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530177 return -1;
178
Andy Shevchenko94116f82017-06-05 19:40:46 +0300179 obj = acpi_evaluate_dsm(handle, &pci_acpi_dsm_guid, 0x2,
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800180 DEVICE_LABEL_DSM, NULL);
181 if (!obj)
182 return -1;
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530183
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800184 tmp = obj->package.elements;
185 if (obj->type == ACPI_TYPE_PACKAGE && obj->package.count == 2 &&
186 tmp[0].type == ACPI_TYPE_INTEGER &&
Simone Gottidcfa9be2014-06-18 16:55:30 +0200187 (tmp[1].type == ACPI_TYPE_STRING ||
188 tmp[1].type == ACPI_TYPE_BUFFER)) {
Jiang Liu2fc59fe2013-12-19 20:38:14 +0800189 /*
190 * The second string element is optional even when
191 * this _DSM is implemented; when not implemented,
192 * this entry must return a null string.
193 */
Simone Gottidcfa9be2014-06-18 16:55:30 +0200194 if (attr == ACPI_ATTR_INDEX_SHOW) {
Jiang Liu2fc59fe2013-12-19 20:38:14 +0800195 scnprintf(buf, PAGE_SIZE, "%llu\n", tmp->integer.value);
Simone Gottidcfa9be2014-06-18 16:55:30 +0200196 } else if (attr == ACPI_ATTR_LABEL_SHOW) {
197 if (tmp[1].type == ACPI_TYPE_STRING)
198 scnprintf(buf, PAGE_SIZE, "%s\n",
199 tmp[1].string.pointer);
200 else if (tmp[1].type == ACPI_TYPE_BUFFER)
201 dsm_label_utf16s_to_utf8s(tmp + 1, buf);
202 }
Jiang Liu2fc59fe2013-12-19 20:38:14 +0800203 len = strlen(buf) > 0 ? strlen(buf) : -1;
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530204 }
Jiang Liu54e5bb42013-12-19 20:38:12 +0800205
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800206 ACPI_FREE(obj);
Jiang Liu54e5bb42013-12-19 20:38:12 +0800207
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800208 return len;
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530209}
210
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400211static bool device_has_dsm(struct device *dev)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530212{
213 acpi_handle handle;
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530214
Rafael J. Wysocki3a83f992013-11-14 23:17:21 +0100215 handle = ACPI_HANDLE(dev);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530216 if (!handle)
Jiang Liu2fc59fe2013-12-19 20:38:14 +0800217 return false;
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530218
Andy Shevchenko94116f82017-06-05 19:40:46 +0300219 return !!acpi_check_dsm(handle, &pci_acpi_dsm_guid, 0x2,
Jiang Liu2fc59fe2013-12-19 20:38:14 +0800220 1 << DEVICE_LABEL_DSM);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530221}
222
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400223static umode_t acpi_index_string_exist(struct kobject *kobj,
224 struct attribute *attr, int n)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530225{
226 struct device *dev;
227
Geliang Tang554a6032015-12-23 20:28:13 +0800228 dev = kobj_to_dev(kobj);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530229
230 if (device_has_dsm(dev))
231 return S_IRUGO;
232
233 return 0;
234}
235
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400236static ssize_t acpilabel_show(struct device *dev,
237 struct device_attribute *attr, char *buf)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530238{
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800239 return dsm_get_label(dev, buf, ACPI_ATTR_LABEL_SHOW);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530240}
241
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400242static ssize_t acpiindex_show(struct device *dev,
243 struct device_attribute *attr, char *buf)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530244{
Jiang Liu1d0fcef2013-12-19 20:38:13 +0800245 return dsm_get_label(dev, buf, ACPI_ATTR_INDEX_SHOW);
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530246}
247
248static struct device_attribute acpi_attr_label = {
249 .attr = {.name = "label", .mode = 0444},
250 .show = acpilabel_show,
251};
252
253static struct device_attribute acpi_attr_index = {
254 .attr = {.name = "acpi_index", .mode = 0444},
255 .show = acpiindex_show,
256};
257
258static struct attribute *acpi_attributes[] = {
259 &acpi_attr_label.attr,
260 &acpi_attr_index.attr,
261 NULL,
262};
263
Arvind Yadavf4841282017-07-11 14:57:08 +0530264static const struct attribute_group acpi_attr_group = {
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530265 .attrs = acpi_attributes,
266 .is_visible = acpi_index_string_exist,
267};
268
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400269static int pci_create_acpi_index_label_files(struct pci_dev *pdev)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530270{
271 return sysfs_create_group(&pdev->dev.kobj, &acpi_attr_group);
272}
273
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400274static int pci_remove_acpi_index_label_files(struct pci_dev *pdev)
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530275{
276 sysfs_remove_group(&pdev->dev.kobj, &acpi_attr_group);
277 return 0;
278}
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700279#else
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400280static inline int pci_create_acpi_index_label_files(struct pci_dev *pdev)
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700281{
282 return -1;
283}
284
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400285static inline int pci_remove_acpi_index_label_files(struct pci_dev *pdev)
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700286{
287 return -1;
288}
289
Ryan Desfosses3c78bc62014-04-18 20:13:49 -0400290static inline bool device_has_dsm(struct device *dev)
Bjorn Helgaas4c859802014-01-13 17:01:11 -0700291{
292 return false;
293}
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530294#endif
295
Narendra K911e1c92010-07-26 05:56:50 -0500296void pci_create_firmware_label_files(struct pci_dev *pdev)
297{
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530298 if (device_has_dsm(&pdev->dev))
299 pci_create_acpi_index_label_files(pdev);
300 else
301 pci_create_smbiosname_file(pdev);
Narendra K911e1c92010-07-26 05:56:50 -0500302}
303
304void pci_remove_firmware_label_files(struct pci_dev *pdev)
305{
Narendra_K@Dell.com60589892011-03-02 22:34:17 +0530306 if (device_has_dsm(&pdev->dev))
307 pci_remove_acpi_index_label_files(pdev);
308 else
309 pci_remove_smbiosname_file(pdev);
Narendra K911e1c92010-07-26 05:56:50 -0500310}