4 * This module exports the DMI tables read-only to userspace through the
7 * Data is currently found below
8 * /sys/firmware/dmi/...
10 * DMI attributes are presented in attribute files with names
11 * formatted using %d-%d, so that the first integer indicates the
12 * structure type (0-255), and the second field is the instance of that
15 * Copyright 2011 Google, Inc.
18 #include <linux/kernel.h>
19 #include <linux/init.h>
20 #include <linux/module.h>
21 #include <linux/types.h>
22 #include <linux/kobject.h>
23 #include <linux/dmi.h>
24 #include <linux/capability.h>
25 #include <linux/slab.h>
26 #include <linux/list.h>
30 #define MAX_ENTRY_TYPE 255 /* Most of these aren't used, but we consider
31 the top entry type is only 8 bits */
33 struct dmi_sysfs_entry
{
38 struct list_head list
;
39 struct kobject
*child
;
43 * Global list of dmi_sysfs_entry. Even though this should only be
44 * manipulated at setup and teardown, the lazy nature of the kobject
45 * system means we get lazy removes.
47 static LIST_HEAD(entry_list
);
48 static DEFINE_SPINLOCK(entry_list_lock
);
50 /* dmi_sysfs_attribute - Top level attribute. used by all entries. */
51 struct dmi_sysfs_attribute
{
52 struct attribute attr
;
53 ssize_t (*show
)(struct dmi_sysfs_entry
*entry
, char *buf
);
56 #define DMI_SYSFS_ATTR(_entry, _name) \
57 struct dmi_sysfs_attribute dmi_sysfs_attr_##_entry##_##_name = { \
58 .attr = {.name = __stringify(_name), .mode = 0400}, \
59 .show = dmi_sysfs_##_entry##_##_name, \
63 * dmi_sysfs_mapped_attribute - Attribute where we require the entry be
64 * mapped in. Use in conjunction with dmi_sysfs_specialize_attr_ops.
66 struct dmi_sysfs_mapped_attribute
{
67 struct attribute attr
;
68 ssize_t (*show
)(struct dmi_sysfs_entry
*entry
,
69 const struct dmi_header
*dh
,
73 #define DMI_SYSFS_MAPPED_ATTR(_entry, _name) \
74 struct dmi_sysfs_mapped_attribute dmi_sysfs_attr_##_entry##_##_name = { \
75 .attr = {.name = __stringify(_name), .mode = 0400}, \
76 .show = dmi_sysfs_##_entry##_##_name, \
79 /*************************************************
80 * Generic DMI entry support.
81 *************************************************/
82 static void dmi_entry_free(struct kobject
*kobj
)
87 static struct dmi_sysfs_entry
*to_entry(struct kobject
*kobj
)
89 return container_of(kobj
, struct dmi_sysfs_entry
, kobj
);
92 static struct dmi_sysfs_attribute
*to_attr(struct attribute
*attr
)
94 return container_of(attr
, struct dmi_sysfs_attribute
, attr
);
97 static ssize_t
dmi_sysfs_attr_show(struct kobject
*kobj
,
98 struct attribute
*_attr
, char *buf
)
100 struct dmi_sysfs_entry
*entry
= to_entry(kobj
);
101 struct dmi_sysfs_attribute
*attr
= to_attr(_attr
);
103 /* DMI stuff is only ever admin visible */
104 if (!capable(CAP_SYS_ADMIN
))
107 return attr
->show(entry
, buf
);
110 static const struct sysfs_ops dmi_sysfs_attr_ops
= {
111 .show
= dmi_sysfs_attr_show
,
114 typedef ssize_t (*dmi_callback
)(struct dmi_sysfs_entry
*,
115 const struct dmi_header
*dh
, void *);
117 struct find_dmi_data
{
118 struct dmi_sysfs_entry
*entry
;
119 dmi_callback callback
;
121 int instance_countdown
;
125 static void find_dmi_entry_helper(const struct dmi_header
*dh
,
128 struct find_dmi_data
*data
= _data
;
129 struct dmi_sysfs_entry
*entry
= data
->entry
;
131 /* Is this the entry we want? */
132 if (dh
->type
!= entry
->dh
.type
)
135 if (data
->instance_countdown
!= 0) {
136 /* try the next instance? */
137 data
->instance_countdown
--;
142 * Don't ever revisit the instance. Short circuit later
143 * instances by letting the instance_countdown run negative
145 data
->instance_countdown
--;
147 /* Found the entry */
148 data
->ret
= data
->callback(entry
, dh
, data
->private);
151 /* State for passing the read parameters through dmi_find_entry() */
152 struct dmi_read_state
{
158 static ssize_t
find_dmi_entry(struct dmi_sysfs_entry
*entry
,
159 dmi_callback callback
, void *private)
161 struct find_dmi_data data
= {
163 .callback
= callback
,
165 .instance_countdown
= entry
->instance
,
166 .ret
= -EIO
, /* To signal the entry disappeared */
170 ret
= dmi_walk(find_dmi_entry_helper
, &data
);
171 /* This shouldn't happen, but just in case. */
178 * Calculate and return the byte length of the dmi entry identified by
179 * dh. This includes both the formatted portion as well as the
180 * unformatted string space, including the two trailing nul characters.
182 static size_t dmi_entry_length(const struct dmi_header
*dh
)
184 const char *p
= (const char *)dh
;
191 return 2 + p
- (const char *)dh
;
194 /*************************************************
195 * Support bits for specialized DMI entry support
196 *************************************************/
197 struct dmi_entry_attr_show_data
{
198 struct attribute
*attr
;
202 static ssize_t
dmi_entry_attr_show_helper(struct dmi_sysfs_entry
*entry
,
203 const struct dmi_header
*dh
,
206 struct dmi_entry_attr_show_data
*data
= _data
;
207 struct dmi_sysfs_mapped_attribute
*attr
;
209 attr
= container_of(data
->attr
,
210 struct dmi_sysfs_mapped_attribute
, attr
);
211 return attr
->show(entry
, dh
, data
->buf
);
214 static ssize_t
dmi_entry_attr_show(struct kobject
*kobj
,
215 struct attribute
*attr
,
218 struct dmi_entry_attr_show_data data
= {
222 /* Find the entry according to our parent and call the
223 * normalized show method hanging off of the attribute */
224 return find_dmi_entry(to_entry(kobj
->parent
),
225 dmi_entry_attr_show_helper
, &data
);
228 static const struct sysfs_ops dmi_sysfs_specialize_attr_ops
= {
229 .show
= dmi_entry_attr_show
,
232 /*************************************************
233 * Specialized DMI entry support.
234 *************************************************/
236 /*** Type 15 - System Event Table ***/
238 #define DMI_SEL_ACCESS_METHOD_IO8 0x00
239 #define DMI_SEL_ACCESS_METHOD_IO2x8 0x01
240 #define DMI_SEL_ACCESS_METHOD_IO16 0x02
241 #define DMI_SEL_ACCESS_METHOD_PHYS32 0x03
242 #define DMI_SEL_ACCESS_METHOD_GPNV 0x04
244 struct dmi_system_event_log
{
245 struct dmi_header header
;
247 u16 header_start_offset
;
248 u16 data_start_offset
;
259 u32 access_method_address
;
262 u8 type_descriptors_supported_count
;
263 u8 per_log_type_descriptor_length
;
264 u8 supported_log_type_descriptos
[0];
267 #define DMI_SYSFS_SEL_FIELD(_field) \
268 static ssize_t dmi_sysfs_sel_##_field(struct dmi_sysfs_entry *entry, \
269 const struct dmi_header *dh, \
272 struct dmi_system_event_log sel; \
273 if (sizeof(sel) > dmi_entry_length(dh)) \
275 memcpy(&sel, dh, sizeof(sel)); \
276 return sprintf(buf, "%u\n", sel._field); \
278 static DMI_SYSFS_MAPPED_ATTR(sel, _field)
280 DMI_SYSFS_SEL_FIELD(area_length
);
281 DMI_SYSFS_SEL_FIELD(header_start_offset
);
282 DMI_SYSFS_SEL_FIELD(data_start_offset
);
283 DMI_SYSFS_SEL_FIELD(access_method
);
284 DMI_SYSFS_SEL_FIELD(status
);
285 DMI_SYSFS_SEL_FIELD(change_token
);
286 DMI_SYSFS_SEL_FIELD(access_method_address
);
287 DMI_SYSFS_SEL_FIELD(header_format
);
288 DMI_SYSFS_SEL_FIELD(type_descriptors_supported_count
);
289 DMI_SYSFS_SEL_FIELD(per_log_type_descriptor_length
);
291 static struct attribute
*dmi_sysfs_sel_attrs
[] = {
292 &dmi_sysfs_attr_sel_area_length
.attr
,
293 &dmi_sysfs_attr_sel_header_start_offset
.attr
,
294 &dmi_sysfs_attr_sel_data_start_offset
.attr
,
295 &dmi_sysfs_attr_sel_access_method
.attr
,
296 &dmi_sysfs_attr_sel_status
.attr
,
297 &dmi_sysfs_attr_sel_change_token
.attr
,
298 &dmi_sysfs_attr_sel_access_method_address
.attr
,
299 &dmi_sysfs_attr_sel_header_format
.attr
,
300 &dmi_sysfs_attr_sel_type_descriptors_supported_count
.attr
,
301 &dmi_sysfs_attr_sel_per_log_type_descriptor_length
.attr
,
306 static struct kobj_type dmi_system_event_log_ktype
= {
307 .release
= dmi_entry_free
,
308 .sysfs_ops
= &dmi_sysfs_specialize_attr_ops
,
309 .default_attrs
= dmi_sysfs_sel_attrs
,
312 typedef u8 (*sel_io_reader
)(const struct dmi_system_event_log
*sel
,
315 static DEFINE_MUTEX(io_port_lock
);
317 static u8
read_sel_8bit_indexed_io(const struct dmi_system_event_log
*sel
,
322 mutex_lock(&io_port_lock
);
323 outb((u8
)offset
, sel
->io
.index_addr
);
324 ret
= inb(sel
->io
.data_addr
);
325 mutex_unlock(&io_port_lock
);
329 static u8
read_sel_2x8bit_indexed_io(const struct dmi_system_event_log
*sel
,
334 mutex_lock(&io_port_lock
);
335 outb((u8
)offset
, sel
->io
.index_addr
);
336 outb((u8
)(offset
>> 8), sel
->io
.index_addr
+ 1);
337 ret
= inb(sel
->io
.data_addr
);
338 mutex_unlock(&io_port_lock
);
342 static u8
read_sel_16bit_indexed_io(const struct dmi_system_event_log
*sel
,
347 mutex_lock(&io_port_lock
);
348 outw((u16
)offset
, sel
->io
.index_addr
);
349 ret
= inb(sel
->io
.data_addr
);
350 mutex_unlock(&io_port_lock
);
354 static sel_io_reader sel_io_readers
[] = {
355 [DMI_SEL_ACCESS_METHOD_IO8
] = read_sel_8bit_indexed_io
,
356 [DMI_SEL_ACCESS_METHOD_IO2x8
] = read_sel_2x8bit_indexed_io
,
357 [DMI_SEL_ACCESS_METHOD_IO16
] = read_sel_16bit_indexed_io
,
360 static ssize_t
dmi_sel_raw_read_io(struct dmi_sysfs_entry
*entry
,
361 const struct dmi_system_event_log
*sel
,
362 char *buf
, loff_t pos
, size_t count
)
366 sel_io_reader io_reader
= sel_io_readers
[sel
->access_method
];
368 while (count
&& pos
< sel
->area_length
) {
370 *(buf
++) = io_reader(sel
, pos
++);
377 static ssize_t
dmi_sel_raw_read_phys32(struct dmi_sysfs_entry
*entry
,
378 const struct dmi_system_event_log
*sel
,
379 char *buf
, loff_t pos
, size_t count
)
384 mapped
= dmi_remap(sel
->access_method_address
, sel
->area_length
);
388 while (count
&& pos
< sel
->area_length
) {
390 *(buf
++) = readb(mapped
+ pos
++);
398 static ssize_t
dmi_sel_raw_read_helper(struct dmi_sysfs_entry
*entry
,
399 const struct dmi_header
*dh
,
402 struct dmi_read_state
*state
= _state
;
403 struct dmi_system_event_log sel
;
405 if (sizeof(sel
) > dmi_entry_length(dh
))
408 memcpy(&sel
, dh
, sizeof(sel
));
410 switch (sel
.access_method
) {
411 case DMI_SEL_ACCESS_METHOD_IO8
:
412 case DMI_SEL_ACCESS_METHOD_IO2x8
:
413 case DMI_SEL_ACCESS_METHOD_IO16
:
414 return dmi_sel_raw_read_io(entry
, &sel
, state
->buf
,
415 state
->pos
, state
->count
);
416 case DMI_SEL_ACCESS_METHOD_PHYS32
:
417 return dmi_sel_raw_read_phys32(entry
, &sel
, state
->buf
,
418 state
->pos
, state
->count
);
419 case DMI_SEL_ACCESS_METHOD_GPNV
:
420 pr_info("dmi-sysfs: GPNV support missing.\n");
423 pr_info("dmi-sysfs: Unknown access method %02x\n",
429 static ssize_t
dmi_sel_raw_read(struct file
*filp
, struct kobject
*kobj
,
430 struct bin_attribute
*bin_attr
,
431 char *buf
, loff_t pos
, size_t count
)
433 struct dmi_sysfs_entry
*entry
= to_entry(kobj
->parent
);
434 struct dmi_read_state state
= {
440 return find_dmi_entry(entry
, dmi_sel_raw_read_helper
, &state
);
443 static struct bin_attribute dmi_sel_raw_attr
= {
444 .attr
= {.name
= "raw_event_log", .mode
= 0400},
445 .read
= dmi_sel_raw_read
,
448 static int dmi_system_event_log(struct dmi_sysfs_entry
*entry
)
452 entry
->child
= kzalloc(sizeof(*entry
->child
), GFP_KERNEL
);
455 ret
= kobject_init_and_add(entry
->child
,
456 &dmi_system_event_log_ktype
,
462 ret
= sysfs_create_bin_file(entry
->child
, &dmi_sel_raw_attr
);
469 kobject_del(entry
->child
);
475 /*************************************************
476 * Generic DMI entry support.
477 *************************************************/
479 static ssize_t
dmi_sysfs_entry_length(struct dmi_sysfs_entry
*entry
, char *buf
)
481 return sprintf(buf
, "%d\n", entry
->dh
.length
);
484 static ssize_t
dmi_sysfs_entry_handle(struct dmi_sysfs_entry
*entry
, char *buf
)
486 return sprintf(buf
, "%d\n", entry
->dh
.handle
);
489 static ssize_t
dmi_sysfs_entry_type(struct dmi_sysfs_entry
*entry
, char *buf
)
491 return sprintf(buf
, "%d\n", entry
->dh
.type
);
494 static ssize_t
dmi_sysfs_entry_instance(struct dmi_sysfs_entry
*entry
,
497 return sprintf(buf
, "%d\n", entry
->instance
);
500 static ssize_t
dmi_sysfs_entry_position(struct dmi_sysfs_entry
*entry
,
503 return sprintf(buf
, "%d\n", entry
->position
);
506 static DMI_SYSFS_ATTR(entry
, length
);
507 static DMI_SYSFS_ATTR(entry
, handle
);
508 static DMI_SYSFS_ATTR(entry
, type
);
509 static DMI_SYSFS_ATTR(entry
, instance
);
510 static DMI_SYSFS_ATTR(entry
, position
);
512 static struct attribute
*dmi_sysfs_entry_attrs
[] = {
513 &dmi_sysfs_attr_entry_length
.attr
,
514 &dmi_sysfs_attr_entry_handle
.attr
,
515 &dmi_sysfs_attr_entry_type
.attr
,
516 &dmi_sysfs_attr_entry_instance
.attr
,
517 &dmi_sysfs_attr_entry_position
.attr
,
521 static ssize_t
dmi_entry_raw_read_helper(struct dmi_sysfs_entry
*entry
,
522 const struct dmi_header
*dh
,
525 struct dmi_read_state
*state
= _state
;
528 entry_length
= dmi_entry_length(dh
);
530 return memory_read_from_buffer(state
->buf
, state
->count
,
531 &state
->pos
, dh
, entry_length
);
534 static ssize_t
dmi_entry_raw_read(struct file
*filp
,
535 struct kobject
*kobj
,
536 struct bin_attribute
*bin_attr
,
537 char *buf
, loff_t pos
, size_t count
)
539 struct dmi_sysfs_entry
*entry
= to_entry(kobj
);
540 struct dmi_read_state state
= {
546 return find_dmi_entry(entry
, dmi_entry_raw_read_helper
, &state
);
549 static const struct bin_attribute dmi_entry_raw_attr
= {
550 .attr
= {.name
= "raw", .mode
= 0400},
551 .read
= dmi_entry_raw_read
,
554 static void dmi_sysfs_entry_release(struct kobject
*kobj
)
556 struct dmi_sysfs_entry
*entry
= to_entry(kobj
);
558 spin_lock(&entry_list_lock
);
559 list_del(&entry
->list
);
560 spin_unlock(&entry_list_lock
);
564 static struct kobj_type dmi_sysfs_entry_ktype
= {
565 .release
= dmi_sysfs_entry_release
,
566 .sysfs_ops
= &dmi_sysfs_attr_ops
,
567 .default_attrs
= dmi_sysfs_entry_attrs
,
570 static struct kset
*dmi_kset
;
572 /* Global count of all instances seen. Only for setup */
573 static int __initdata instance_counts
[MAX_ENTRY_TYPE
+ 1];
575 /* Global positional count of all entries seen. Only for setup */
576 static int __initdata position_count
;
578 static void __init
dmi_sysfs_register_handle(const struct dmi_header
*dh
,
581 struct dmi_sysfs_entry
*entry
;
584 /* If a previous entry saw an error, short circuit */
588 /* Allocate and register a new entry into the entries set */
589 entry
= kzalloc(sizeof(*entry
), GFP_KERNEL
);
596 memcpy(&entry
->dh
, dh
, sizeof(*dh
));
597 entry
->instance
= instance_counts
[dh
->type
]++;
598 entry
->position
= position_count
++;
600 entry
->kobj
.kset
= dmi_kset
;
601 *ret
= kobject_init_and_add(&entry
->kobj
, &dmi_sysfs_entry_ktype
, NULL
,
602 "%d-%d", dh
->type
, entry
->instance
);
609 /* Thread on the global list for cleanup */
610 spin_lock(&entry_list_lock
);
611 list_add_tail(&entry
->list
, &entry_list
);
612 spin_unlock(&entry_list_lock
);
614 /* Handle specializations by type */
616 case DMI_ENTRY_SYSTEM_EVENT_LOG
:
617 *ret
= dmi_system_event_log(entry
);
620 /* No specialization */
626 /* Create the raw binary file to access the entry */
627 *ret
= sysfs_create_bin_file(&entry
->kobj
, &dmi_entry_raw_attr
);
633 kobject_put(entry
->child
);
634 kobject_put(&entry
->kobj
);
638 static void cleanup_entry_list(void)
640 struct dmi_sysfs_entry
*entry
, *next
;
642 /* No locks, we are on our way out */
643 list_for_each_entry_safe(entry
, next
, &entry_list
, list
) {
644 kobject_put(entry
->child
);
645 kobject_put(&entry
->kobj
);
649 static int __init
dmi_sysfs_init(void)
655 pr_debug("dmi-sysfs: dmi entry is absent.\n");
660 dmi_kset
= kset_create_and_add("entries", NULL
, dmi_kobj
);
667 error
= dmi_walk(dmi_sysfs_register_handle
, &val
);
675 pr_debug("dmi-sysfs: loaded.\n");
679 cleanup_entry_list();
680 kset_unregister(dmi_kset
);
684 /* clean up everything. */
685 static void __exit
dmi_sysfs_exit(void)
687 pr_debug("dmi-sysfs: unloading.\n");
688 cleanup_entry_list();
689 kset_unregister(dmi_kset
);
692 module_init(dmi_sysfs_init
);
693 module_exit(dmi_sysfs_exit
);
695 MODULE_AUTHOR("Mike Waychison <mikew@google.com>");
696 MODULE_DESCRIPTION("DMI sysfs support");
697 MODULE_LICENSE("GPL");