xref: /linux/drivers/firmware/dmi-id.c (revision 69050f8d6d075dc01af7a5f2f550a8067510366f)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Export SMBIOS/DMI info via sysfs to userspace
4  *
5  * Copyright 2007, Lennart Poettering
6  */
7 
8 #include <linux/module.h>
9 #include <linux/kernel.h>
10 #include <linux/init.h>
11 #include <linux/dmi.h>
12 #include <linux/device.h>
13 #include <linux/slab.h>
14 
15 struct dmi_device_attribute{
16 	struct device_attribute dev_attr;
17 	int field;
18 };
19 #define to_dmi_dev_attr(_dev_attr) \
20 	container_of(_dev_attr, struct dmi_device_attribute, dev_attr)
21 
22 static ssize_t sys_dmi_field_show(struct device *dev,
23 				  struct device_attribute *attr,
24 				  char *page)
25 {
26 	int field = to_dmi_dev_attr(attr)->field;
27 	ssize_t len;
28 	len = scnprintf(page, PAGE_SIZE, "%s\n", dmi_get_system_info(field));
29 	page[len-1] = '\n';
30 	return len;
31 }
32 
33 #define DMI_ATTR(_name, _mode, _show, _field)			\
34 	{ .dev_attr = __ATTR(_name, _mode, _show, NULL),	\
35 	  .field = _field }
36 
37 #define DEFINE_DMI_ATTR_WITH_SHOW(_name, _mode, _field)		\
38 static struct dmi_device_attribute sys_dmi_##_name##_attr =	\
39 	DMI_ATTR(_name, _mode, sys_dmi_field_show, _field);
40 
41 DEFINE_DMI_ATTR_WITH_SHOW(bios_vendor,		0444, DMI_BIOS_VENDOR);
42 DEFINE_DMI_ATTR_WITH_SHOW(bios_version,		0444, DMI_BIOS_VERSION);
43 DEFINE_DMI_ATTR_WITH_SHOW(bios_date,		0444, DMI_BIOS_DATE);
44 DEFINE_DMI_ATTR_WITH_SHOW(sys_vendor,		0444, DMI_SYS_VENDOR);
45 DEFINE_DMI_ATTR_WITH_SHOW(bios_release,		0444, DMI_BIOS_RELEASE);
46 DEFINE_DMI_ATTR_WITH_SHOW(ec_firmware_release,	0444, DMI_EC_FIRMWARE_RELEASE);
47 DEFINE_DMI_ATTR_WITH_SHOW(product_name,		0444, DMI_PRODUCT_NAME);
48 DEFINE_DMI_ATTR_WITH_SHOW(product_version,	0444, DMI_PRODUCT_VERSION);
49 DEFINE_DMI_ATTR_WITH_SHOW(product_serial,	0400, DMI_PRODUCT_SERIAL);
50 DEFINE_DMI_ATTR_WITH_SHOW(product_uuid,		0400, DMI_PRODUCT_UUID);
51 DEFINE_DMI_ATTR_WITH_SHOW(product_sku,		0444, DMI_PRODUCT_SKU);
52 DEFINE_DMI_ATTR_WITH_SHOW(product_family,	0444, DMI_PRODUCT_FAMILY);
53 DEFINE_DMI_ATTR_WITH_SHOW(board_vendor,		0444, DMI_BOARD_VENDOR);
54 DEFINE_DMI_ATTR_WITH_SHOW(board_name,		0444, DMI_BOARD_NAME);
55 DEFINE_DMI_ATTR_WITH_SHOW(board_version,	0444, DMI_BOARD_VERSION);
56 DEFINE_DMI_ATTR_WITH_SHOW(board_serial,		0400, DMI_BOARD_SERIAL);
57 DEFINE_DMI_ATTR_WITH_SHOW(board_asset_tag,	0444, DMI_BOARD_ASSET_TAG);
58 DEFINE_DMI_ATTR_WITH_SHOW(chassis_vendor,	0444, DMI_CHASSIS_VENDOR);
59 DEFINE_DMI_ATTR_WITH_SHOW(chassis_type,		0444, DMI_CHASSIS_TYPE);
60 DEFINE_DMI_ATTR_WITH_SHOW(chassis_version,	0444, DMI_CHASSIS_VERSION);
61 DEFINE_DMI_ATTR_WITH_SHOW(chassis_serial,	0400, DMI_CHASSIS_SERIAL);
62 DEFINE_DMI_ATTR_WITH_SHOW(chassis_asset_tag,	0444, DMI_CHASSIS_ASSET_TAG);
63 
64 static void ascii_filter(char *d, const char *s)
65 {
66 	/* Filter out characters we don't want to see in the modalias string */
67 	for (; *s; s++)
68 		if (*s > ' ' && *s < 127 && *s != ':')
69 			*(d++) = *s;
70 
71 	*d = 0;
72 }
73 
74 static ssize_t get_modalias(char *buffer, size_t buffer_size)
75 {
76 	/*
77 	 * Note new fields need to be added at the end to keep compatibility
78 	 * with udev's hwdb which does matches on "`cat dmi/id/modalias`*".
79 	 */
80 	static const struct mafield {
81 		const char *prefix;
82 		int field;
83 	} fields[] = {
84 		{ "bvn", DMI_BIOS_VENDOR },
85 		{ "bvr", DMI_BIOS_VERSION },
86 		{ "bd",  DMI_BIOS_DATE },
87 		{ "br",  DMI_BIOS_RELEASE },
88 		{ "efr", DMI_EC_FIRMWARE_RELEASE },
89 		{ "svn", DMI_SYS_VENDOR },
90 		{ "pn",  DMI_PRODUCT_NAME },
91 		{ "pvr", DMI_PRODUCT_VERSION },
92 		{ "rvn", DMI_BOARD_VENDOR },
93 		{ "rn",  DMI_BOARD_NAME },
94 		{ "rvr", DMI_BOARD_VERSION },
95 		{ "cvn", DMI_CHASSIS_VENDOR },
96 		{ "ct",  DMI_CHASSIS_TYPE },
97 		{ "cvr", DMI_CHASSIS_VERSION },
98 		{ "sku", DMI_PRODUCT_SKU },
99 		{ "pfa", DMI_PRODUCT_FAMILY },
100 		{ NULL,  DMI_NONE }
101 	};
102 
103 	ssize_t l, left;
104 	char *p;
105 	const struct mafield *f;
106 
107 	strcpy(buffer, "dmi");
108 	p = buffer + 3; left = buffer_size - 4;
109 
110 	for (f = fields; f->prefix && left > 0; f++) {
111 		const char *c;
112 		char *t;
113 
114 		c = dmi_get_system_info(f->field);
115 		if (!c)
116 			continue;
117 
118 		t = kmalloc(strlen(c) + 1, GFP_KERNEL);
119 		if (!t)
120 			break;
121 		ascii_filter(t, c);
122 		l = scnprintf(p, left, ":%s%s", f->prefix, t);
123 		kfree(t);
124 
125 		p += l;
126 		left -= l;
127 	}
128 
129 	p[0] = ':';
130 	p[1] = 0;
131 
132 	return p - buffer + 1;
133 }
134 
135 static ssize_t sys_dmi_modalias_show(struct device *dev,
136 				     struct device_attribute *attr, char *page)
137 {
138 	ssize_t r;
139 	r = get_modalias(page, PAGE_SIZE-1);
140 	page[r] = '\n';
141 	page[r+1] = 0;
142 	return r+1;
143 }
144 
145 static struct device_attribute sys_dmi_modalias_attr =
146 	__ATTR(modalias, 0444, sys_dmi_modalias_show, NULL);
147 
148 static struct attribute *sys_dmi_attributes[DMI_STRING_MAX+2];
149 
150 static struct attribute_group sys_dmi_attribute_group = {
151 	.attrs = sys_dmi_attributes,
152 };
153 
154 static const struct attribute_group* sys_dmi_attribute_groups[] = {
155 	&sys_dmi_attribute_group,
156 	NULL
157 };
158 
159 static int dmi_dev_uevent(const struct device *dev, struct kobj_uevent_env *env)
160 {
161 	ssize_t len;
162 
163 	if (add_uevent_var(env, "MODALIAS="))
164 		return -ENOMEM;
165 	len = get_modalias(&env->buf[env->buflen - 1],
166 			   sizeof(env->buf) - env->buflen);
167 	if (len >= (sizeof(env->buf) - env->buflen))
168 		return -ENOMEM;
169 	env->buflen += len;
170 	return 0;
171 }
172 
173 static void dmi_dev_release(struct device *dev)
174 {
175 	kfree(dev);
176 }
177 
178 static struct class dmi_class = {
179 	.name = "dmi",
180 	.dev_release = dmi_dev_release,
181 	.dev_uevent = dmi_dev_uevent,
182 };
183 
184 static struct device *dmi_dev;
185 
186 /* Initialization */
187 
188 #define ADD_DMI_ATTR(_name, _field) \
189 	if (dmi_get_system_info(_field)) \
190 		sys_dmi_attributes[i++] = &sys_dmi_##_name##_attr.dev_attr.attr;
191 
192 /* In a separate function to keep gcc 3.2 happy - do NOT merge this in
193    dmi_id_init! */
194 static void __init dmi_id_init_attr_table(void)
195 {
196 	int i;
197 
198 	/* Not necessarily all DMI fields are available on all
199 	 * systems, hence let's built an attribute table of just
200 	 * what's available */
201 	i = 0;
202 	ADD_DMI_ATTR(bios_vendor,       DMI_BIOS_VENDOR);
203 	ADD_DMI_ATTR(bios_version,      DMI_BIOS_VERSION);
204 	ADD_DMI_ATTR(bios_date,         DMI_BIOS_DATE);
205 	ADD_DMI_ATTR(bios_release,      DMI_BIOS_RELEASE);
206 	ADD_DMI_ATTR(ec_firmware_release, DMI_EC_FIRMWARE_RELEASE);
207 	ADD_DMI_ATTR(sys_vendor,        DMI_SYS_VENDOR);
208 	ADD_DMI_ATTR(product_name,      DMI_PRODUCT_NAME);
209 	ADD_DMI_ATTR(product_version,   DMI_PRODUCT_VERSION);
210 	ADD_DMI_ATTR(product_serial,    DMI_PRODUCT_SERIAL);
211 	ADD_DMI_ATTR(product_uuid,      DMI_PRODUCT_UUID);
212 	ADD_DMI_ATTR(product_family,    DMI_PRODUCT_FAMILY);
213 	ADD_DMI_ATTR(product_sku,       DMI_PRODUCT_SKU);
214 	ADD_DMI_ATTR(board_vendor,      DMI_BOARD_VENDOR);
215 	ADD_DMI_ATTR(board_name,        DMI_BOARD_NAME);
216 	ADD_DMI_ATTR(board_version,     DMI_BOARD_VERSION);
217 	ADD_DMI_ATTR(board_serial,      DMI_BOARD_SERIAL);
218 	ADD_DMI_ATTR(board_asset_tag,   DMI_BOARD_ASSET_TAG);
219 	ADD_DMI_ATTR(chassis_vendor,    DMI_CHASSIS_VENDOR);
220 	ADD_DMI_ATTR(chassis_type,      DMI_CHASSIS_TYPE);
221 	ADD_DMI_ATTR(chassis_version,   DMI_CHASSIS_VERSION);
222 	ADD_DMI_ATTR(chassis_serial,    DMI_CHASSIS_SERIAL);
223 	ADD_DMI_ATTR(chassis_asset_tag, DMI_CHASSIS_ASSET_TAG);
224 	sys_dmi_attributes[i++] = &sys_dmi_modalias_attr.attr;
225 }
226 
227 static int __init dmi_id_init(void)
228 {
229 	int ret;
230 
231 	if (!dmi_available)
232 		return -ENODEV;
233 
234 	dmi_id_init_attr_table();
235 
236 	ret = class_register(&dmi_class);
237 	if (ret)
238 		return ret;
239 
240 	dmi_dev = kzalloc_obj(*dmi_dev, GFP_KERNEL);
241 	if (!dmi_dev) {
242 		ret = -ENOMEM;
243 		goto fail_class_unregister;
244 	}
245 
246 	dmi_dev->class = &dmi_class;
247 	dev_set_name(dmi_dev, "id");
248 	dmi_dev->groups = sys_dmi_attribute_groups;
249 
250 	ret = device_register(dmi_dev);
251 	if (ret)
252 		goto fail_put_dmi_dev;
253 
254 	return 0;
255 
256 fail_put_dmi_dev:
257 	put_device(dmi_dev);
258 
259 fail_class_unregister:
260 	class_unregister(&dmi_class);
261 
262 	return ret;
263 }
264 
265 arch_initcall(dmi_id_init);
266