2 * Copyright (c) 2004, 2005 Topspin Communications. All rights reserved.
3 * Copyright (c) 2005 Mellanox Technologies Ltd. All rights reserved.
4 * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
6 * This software is available to you under a choice of one of two
7 * licenses. You may choose to be licensed under the terms of the GNU
8 * General Public License (GPL) Version 2, available from the file
9 * COPYING in the main directory of this source tree, or the
10 * OpenIB.org BSD license below:
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
16 * - Redistributions of source code must retain the above
17 * copyright notice, this list of conditions and the following
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials
23 * provided with the distribution.
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
34 * $Id: sysfs.c 1349 2004-12-16 21:09:43Z roland $
37 #include "core_priv.h"
39 #include <linux/slab.h>
40 #include <linux/string.h>
42 #include <rdma/ib_mad.h>
46 struct ib_device *ibdev;
47 struct attribute_group gid_group;
48 struct attribute_group pkey_group;
52 struct port_attribute {
53 struct attribute attr;
54 ssize_t (*show)(struct ib_port *, struct port_attribute *, char *buf);
55 ssize_t (*store)(struct ib_port *, struct port_attribute *,
56 const char *buf, size_t count);
59 #define PORT_ATTR(_name, _mode, _show, _store) \
60 struct port_attribute port_attr_##_name = __ATTR(_name, _mode, _show, _store)
62 #define PORT_ATTR_RO(_name) \
63 struct port_attribute port_attr_##_name = __ATTR_RO(_name)
65 struct port_table_attribute {
66 struct port_attribute attr;
71 static inline int ibdev_is_alive(const struct ib_device *dev)
73 return dev->reg_state == IB_DEV_REGISTERED;
76 static ssize_t port_attr_show(struct kobject *kobj,
77 struct attribute *attr, char *buf)
79 struct port_attribute *port_attr =
80 container_of(attr, struct port_attribute, attr);
81 struct ib_port *p = container_of(kobj, struct ib_port, kobj);
85 if (!ibdev_is_alive(p->ibdev))
88 return port_attr->show(p, port_attr, buf);
91 static struct sysfs_ops port_sysfs_ops = {
92 .show = port_attr_show
95 static ssize_t state_show(struct ib_port *p, struct port_attribute *unused,
98 struct ib_port_attr attr;
101 static const char *state_name[] = {
102 [IB_PORT_NOP] = "NOP",
103 [IB_PORT_DOWN] = "DOWN",
104 [IB_PORT_INIT] = "INIT",
105 [IB_PORT_ARMED] = "ARMED",
106 [IB_PORT_ACTIVE] = "ACTIVE",
107 [IB_PORT_ACTIVE_DEFER] = "ACTIVE_DEFER"
110 ret = ib_query_port(p->ibdev, p->port_num, &attr);
114 return sprintf(buf, "%d: %s\n", attr.state,
115 attr.state >= 0 && attr.state <= ARRAY_SIZE(state_name) ?
116 state_name[attr.state] : "UNKNOWN");
119 static ssize_t lid_show(struct ib_port *p, struct port_attribute *unused,
122 struct ib_port_attr attr;
125 ret = ib_query_port(p->ibdev, p->port_num, &attr);
129 return sprintf(buf, "0x%x\n", attr.lid);
132 static ssize_t lid_mask_count_show(struct ib_port *p,
133 struct port_attribute *unused,
136 struct ib_port_attr attr;
139 ret = ib_query_port(p->ibdev, p->port_num, &attr);
143 return sprintf(buf, "%d\n", attr.lmc);
146 static ssize_t sm_lid_show(struct ib_port *p, struct port_attribute *unused,
149 struct ib_port_attr attr;
152 ret = ib_query_port(p->ibdev, p->port_num, &attr);
156 return sprintf(buf, "0x%x\n", attr.sm_lid);
159 static ssize_t sm_sl_show(struct ib_port *p, struct port_attribute *unused,
162 struct ib_port_attr attr;
165 ret = ib_query_port(p->ibdev, p->port_num, &attr);
169 return sprintf(buf, "%d\n", attr.sm_sl);
172 static ssize_t cap_mask_show(struct ib_port *p, struct port_attribute *unused,
175 struct ib_port_attr attr;
178 ret = ib_query_port(p->ibdev, p->port_num, &attr);
182 return sprintf(buf, "0x%08x\n", attr.port_cap_flags);
185 static ssize_t rate_show(struct ib_port *p, struct port_attribute *unused,
188 struct ib_port_attr attr;
193 ret = ib_query_port(p->ibdev, p->port_num, &attr);
197 switch (attr.active_speed) {
198 case 2: speed = " DDR"; break;
199 case 4: speed = " QDR"; break;
202 rate = 25 * ib_width_enum_to_int(attr.active_width) * attr.active_speed;
206 return sprintf(buf, "%d%s Gb/sec (%dX%s)\n",
207 rate / 10, rate % 10 ? ".5" : "",
208 ib_width_enum_to_int(attr.active_width), speed);
211 static ssize_t phys_state_show(struct ib_port *p, struct port_attribute *unused,
214 struct ib_port_attr attr;
218 ret = ib_query_port(p->ibdev, p->port_num, &attr);
222 switch (attr.phys_state) {
223 case 1: return sprintf(buf, "1: Sleep\n");
224 case 2: return sprintf(buf, "2: Polling\n");
225 case 3: return sprintf(buf, "3: Disabled\n");
226 case 4: return sprintf(buf, "4: PortConfigurationTraining\n");
227 case 5: return sprintf(buf, "5: LinkUp\n");
228 case 6: return sprintf(buf, "6: LinkErrorRecovery\n");
229 case 7: return sprintf(buf, "7: Phy Test\n");
230 default: return sprintf(buf, "%d: <unknown>\n", attr.phys_state);
234 static PORT_ATTR_RO(state);
235 static PORT_ATTR_RO(lid);
236 static PORT_ATTR_RO(lid_mask_count);
237 static PORT_ATTR_RO(sm_lid);
238 static PORT_ATTR_RO(sm_sl);
239 static PORT_ATTR_RO(cap_mask);
240 static PORT_ATTR_RO(rate);
241 static PORT_ATTR_RO(phys_state);
243 static struct attribute *port_default_attrs[] = {
244 &port_attr_state.attr,
246 &port_attr_lid_mask_count.attr,
247 &port_attr_sm_lid.attr,
248 &port_attr_sm_sl.attr,
249 &port_attr_cap_mask.attr,
250 &port_attr_rate.attr,
251 &port_attr_phys_state.attr,
255 static ssize_t show_port_gid(struct ib_port *p, struct port_attribute *attr,
258 struct port_table_attribute *tab_attr =
259 container_of(attr, struct port_table_attribute, attr);
263 ret = ib_query_gid(p->ibdev, p->port_num, tab_attr->index, &gid);
267 return sprintf(buf, "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x\n",
268 be16_to_cpu(((__be16 *) gid.raw)[0]),
269 be16_to_cpu(((__be16 *) gid.raw)[1]),
270 be16_to_cpu(((__be16 *) gid.raw)[2]),
271 be16_to_cpu(((__be16 *) gid.raw)[3]),
272 be16_to_cpu(((__be16 *) gid.raw)[4]),
273 be16_to_cpu(((__be16 *) gid.raw)[5]),
274 be16_to_cpu(((__be16 *) gid.raw)[6]),
275 be16_to_cpu(((__be16 *) gid.raw)[7]));
278 static ssize_t show_port_pkey(struct ib_port *p, struct port_attribute *attr,
281 struct port_table_attribute *tab_attr =
282 container_of(attr, struct port_table_attribute, attr);
286 ret = ib_query_pkey(p->ibdev, p->port_num, tab_attr->index, &pkey);
290 return sprintf(buf, "0x%04x\n", pkey);
293 #define PORT_PMA_ATTR(_name, _counter, _width, _offset) \
294 struct port_table_attribute port_pma_attr_##_name = { \
295 .attr = __ATTR(_name, S_IRUGO, show_pma_counter, NULL), \
296 .index = (_offset) | ((_width) << 16) | ((_counter) << 24) \
299 static ssize_t show_pma_counter(struct ib_port *p, struct port_attribute *attr,
302 struct port_table_attribute *tab_attr =
303 container_of(attr, struct port_table_attribute, attr);
304 int offset = tab_attr->index & 0xffff;
305 int width = (tab_attr->index >> 16) & 0xff;
306 struct ib_mad *in_mad = NULL;
307 struct ib_mad *out_mad = NULL;
310 if (!p->ibdev->process_mad)
311 return sprintf(buf, "N/A (no PMA)\n");
313 in_mad = kzalloc(sizeof *in_mad, GFP_KERNEL);
314 out_mad = kmalloc(sizeof *in_mad, GFP_KERNEL);
315 if (!in_mad || !out_mad) {
320 in_mad->mad_hdr.base_version = 1;
321 in_mad->mad_hdr.mgmt_class = IB_MGMT_CLASS_PERF_MGMT;
322 in_mad->mad_hdr.class_version = 1;
323 in_mad->mad_hdr.method = IB_MGMT_METHOD_GET;
324 in_mad->mad_hdr.attr_id = cpu_to_be16(0x12); /* PortCounters */
326 in_mad->data[41] = p->port_num; /* PortSelect field */
328 if ((p->ibdev->process_mad(p->ibdev, IB_MAD_IGNORE_MKEY,
329 p->port_num, NULL, NULL, in_mad, out_mad) &
330 (IB_MAD_RESULT_SUCCESS | IB_MAD_RESULT_REPLY)) !=
331 (IB_MAD_RESULT_SUCCESS | IB_MAD_RESULT_REPLY)) {
338 ret = sprintf(buf, "%u\n", (out_mad->data[40 + offset / 8] >>
339 (offset % 4)) & 0xf);
342 ret = sprintf(buf, "%u\n", out_mad->data[40 + offset / 8]);
345 ret = sprintf(buf, "%u\n",
346 be16_to_cpup((__be16 *)(out_mad->data + 40 + offset / 8)));
349 ret = sprintf(buf, "%u\n",
350 be32_to_cpup((__be32 *)(out_mad->data + 40 + offset / 8)));
363 static PORT_PMA_ATTR(symbol_error , 0, 16, 32);
364 static PORT_PMA_ATTR(link_error_recovery , 1, 8, 48);
365 static PORT_PMA_ATTR(link_downed , 2, 8, 56);
366 static PORT_PMA_ATTR(port_rcv_errors , 3, 16, 64);
367 static PORT_PMA_ATTR(port_rcv_remote_physical_errors, 4, 16, 80);
368 static PORT_PMA_ATTR(port_rcv_switch_relay_errors , 5, 16, 96);
369 static PORT_PMA_ATTR(port_xmit_discards , 6, 16, 112);
370 static PORT_PMA_ATTR(port_xmit_constraint_errors , 7, 8, 128);
371 static PORT_PMA_ATTR(port_rcv_constraint_errors , 8, 8, 136);
372 static PORT_PMA_ATTR(local_link_integrity_errors , 9, 4, 152);
373 static PORT_PMA_ATTR(excessive_buffer_overrun_errors, 10, 4, 156);
374 static PORT_PMA_ATTR(VL15_dropped , 11, 16, 176);
375 static PORT_PMA_ATTR(port_xmit_data , 12, 32, 192);
376 static PORT_PMA_ATTR(port_rcv_data , 13, 32, 224);
377 static PORT_PMA_ATTR(port_xmit_packets , 14, 32, 256);
378 static PORT_PMA_ATTR(port_rcv_packets , 15, 32, 288);
380 static struct attribute *pma_attrs[] = {
381 &port_pma_attr_symbol_error.attr.attr,
382 &port_pma_attr_link_error_recovery.attr.attr,
383 &port_pma_attr_link_downed.attr.attr,
384 &port_pma_attr_port_rcv_errors.attr.attr,
385 &port_pma_attr_port_rcv_remote_physical_errors.attr.attr,
386 &port_pma_attr_port_rcv_switch_relay_errors.attr.attr,
387 &port_pma_attr_port_xmit_discards.attr.attr,
388 &port_pma_attr_port_xmit_constraint_errors.attr.attr,
389 &port_pma_attr_port_rcv_constraint_errors.attr.attr,
390 &port_pma_attr_local_link_integrity_errors.attr.attr,
391 &port_pma_attr_excessive_buffer_overrun_errors.attr.attr,
392 &port_pma_attr_VL15_dropped.attr.attr,
393 &port_pma_attr_port_xmit_data.attr.attr,
394 &port_pma_attr_port_rcv_data.attr.attr,
395 &port_pma_attr_port_xmit_packets.attr.attr,
396 &port_pma_attr_port_rcv_packets.attr.attr,
400 static struct attribute_group pma_group = {
405 static void ib_port_release(struct kobject *kobj)
407 struct ib_port *p = container_of(kobj, struct ib_port, kobj);
411 for (i = 0; (a = p->gid_group.attrs[i]); ++i)
414 kfree(p->gid_group.attrs);
416 for (i = 0; (a = p->pkey_group.attrs[i]); ++i)
419 kfree(p->pkey_group.attrs);
424 static struct kobj_type port_type = {
425 .release = ib_port_release,
426 .sysfs_ops = &port_sysfs_ops,
427 .default_attrs = port_default_attrs
430 static void ib_device_release(struct class_device *cdev)
432 struct ib_device *dev = container_of(cdev, struct ib_device, class_dev);
437 static int ib_device_uevent(struct class_device *cdev, char **envp,
438 int num_envp, char *buf, int size)
440 struct ib_device *dev = container_of(cdev, struct ib_device, class_dev);
443 if (add_uevent_var(envp, num_envp, &i, buf, size, &len,
444 "NAME=%s", dev->name))
448 * It might be nice to pass the node GUID with the event, but
449 * right now the only way to get it is to query the device
450 * provider, and this can crash during device removal because
451 * we are will be running after driver removal has started.
452 * We could add a node_guid field to struct ib_device, or we
453 * could just let userspace read the node GUID from sysfs when
461 static struct attribute **
462 alloc_group_attrs(ssize_t (*show)(struct ib_port *,
463 struct port_attribute *, char *buf),
466 struct attribute **tab_attr;
467 struct port_table_attribute *element;
470 tab_attr = kcalloc(1 + len, sizeof(struct attribute *), GFP_KERNEL);
474 for (i = 0; i < len; i++) {
475 element = kzalloc(sizeof(struct port_table_attribute),
480 if (snprintf(element->name, sizeof(element->name),
481 "%d", i) >= sizeof(element->name))
484 element->attr.attr.name = element->name;
485 element->attr.attr.mode = S_IRUGO;
486 element->attr.attr.owner = THIS_MODULE;
487 element->attr.show = show;
490 tab_attr[i] = &element->attr.attr;
502 static int add_port(struct ib_device *device, int port_num)
505 struct ib_port_attr attr;
509 ret = ib_query_port(device, port_num, &attr);
513 p = kzalloc(sizeof *p, GFP_KERNEL);
518 p->port_num = port_num;
519 p->kobj.ktype = &port_type;
521 p->kobj.parent = kobject_get(&device->ports_parent);
522 if (!p->kobj.parent) {
527 ret = kobject_set_name(&p->kobj, "%d", port_num);
531 ret = kobject_register(&p->kobj);
535 ret = sysfs_create_group(&p->kobj, &pma_group);
539 p->gid_group.name = "gids";
540 p->gid_group.attrs = alloc_group_attrs(show_port_gid, attr.gid_tbl_len);
541 if (!p->gid_group.attrs)
544 ret = sysfs_create_group(&p->kobj, &p->gid_group);
548 p->pkey_group.name = "pkeys";
549 p->pkey_group.attrs = alloc_group_attrs(show_port_pkey,
551 if (!p->pkey_group.attrs)
554 ret = sysfs_create_group(&p->kobj, &p->pkey_group);
558 list_add_tail(&p->kobj.entry, &device->port_list);
563 for (i = 0; i < attr.pkey_tbl_len; ++i)
564 kfree(p->pkey_group.attrs[i]);
566 kfree(p->pkey_group.attrs);
569 sysfs_remove_group(&p->kobj, &p->gid_group);
572 for (i = 0; i < attr.gid_tbl_len; ++i)
573 kfree(p->gid_group.attrs[i]);
575 kfree(p->gid_group.attrs);
578 sysfs_remove_group(&p->kobj, &pma_group);
581 kobject_put(&device->ports_parent);
588 static ssize_t show_node_type(struct class_device *cdev, char *buf)
590 struct ib_device *dev = container_of(cdev, struct ib_device, class_dev);
592 if (!ibdev_is_alive(dev))
595 switch (dev->node_type) {
596 case IB_NODE_CA: return sprintf(buf, "%d: CA\n", dev->node_type);
597 case IB_NODE_SWITCH: return sprintf(buf, "%d: switch\n", dev->node_type);
598 case IB_NODE_ROUTER: return sprintf(buf, "%d: router\n", dev->node_type);
599 default: return sprintf(buf, "%d: <unknown>\n", dev->node_type);
603 static ssize_t show_sys_image_guid(struct class_device *cdev, char *buf)
605 struct ib_device *dev = container_of(cdev, struct ib_device, class_dev);
606 struct ib_device_attr attr;
609 if (!ibdev_is_alive(dev))
612 ret = ib_query_device(dev, &attr);
616 return sprintf(buf, "%04x:%04x:%04x:%04x\n",
617 be16_to_cpu(((__be16 *) &attr.sys_image_guid)[0]),
618 be16_to_cpu(((__be16 *) &attr.sys_image_guid)[1]),
619 be16_to_cpu(((__be16 *) &attr.sys_image_guid)[2]),
620 be16_to_cpu(((__be16 *) &attr.sys_image_guid)[3]));
623 static ssize_t show_node_guid(struct class_device *cdev, char *buf)
625 struct ib_device *dev = container_of(cdev, struct ib_device, class_dev);
626 struct ib_device_attr attr;
629 if (!ibdev_is_alive(dev))
632 ret = ib_query_device(dev, &attr);
636 return sprintf(buf, "%04x:%04x:%04x:%04x\n",
637 be16_to_cpu(((__be16 *) &attr.node_guid)[0]),
638 be16_to_cpu(((__be16 *) &attr.node_guid)[1]),
639 be16_to_cpu(((__be16 *) &attr.node_guid)[2]),
640 be16_to_cpu(((__be16 *) &attr.node_guid)[3]));
643 static CLASS_DEVICE_ATTR(node_type, S_IRUGO, show_node_type, NULL);
644 static CLASS_DEVICE_ATTR(sys_image_guid, S_IRUGO, show_sys_image_guid, NULL);
645 static CLASS_DEVICE_ATTR(node_guid, S_IRUGO, show_node_guid, NULL);
647 static struct class_device_attribute *ib_class_attributes[] = {
648 &class_device_attr_node_type,
649 &class_device_attr_sys_image_guid,
650 &class_device_attr_node_guid
653 static struct class ib_class = {
654 .name = "infiniband",
655 .release = ib_device_release,
656 .uevent = ib_device_uevent,
659 int ib_device_register_sysfs(struct ib_device *device)
661 struct class_device *class_dev = &device->class_dev;
665 class_dev->class = &ib_class;
666 class_dev->class_data = device;
667 strlcpy(class_dev->class_id, device->name, BUS_ID_SIZE);
669 INIT_LIST_HEAD(&device->port_list);
671 ret = class_device_register(class_dev);
675 for (i = 0; i < ARRAY_SIZE(ib_class_attributes); ++i) {
676 ret = class_device_create_file(class_dev, ib_class_attributes[i]);
681 device->ports_parent.parent = kobject_get(&class_dev->kobj);
682 if (!device->ports_parent.parent) {
686 ret = kobject_set_name(&device->ports_parent, "ports");
689 ret = kobject_register(&device->ports_parent);
693 if (device->node_type == IB_NODE_SWITCH) {
694 ret = add_port(device, 0);
700 for (i = 1; i <= device->phys_port_cnt; ++i) {
701 ret = add_port(device, i);
711 struct kobject *p, *t;
712 struct ib_port *port;
714 list_for_each_entry_safe(p, t, &device->port_list, entry) {
716 port = container_of(p, struct ib_port, kobj);
717 sysfs_remove_group(p, &pma_group);
718 sysfs_remove_group(p, &port->pkey_group);
719 sysfs_remove_group(p, &port->gid_group);
720 kobject_unregister(p);
724 kobject_put(&class_dev->kobj);
727 class_device_unregister(class_dev);
733 void ib_device_unregister_sysfs(struct ib_device *device)
735 struct kobject *p, *t;
736 struct ib_port *port;
738 list_for_each_entry_safe(p, t, &device->port_list, entry) {
740 port = container_of(p, struct ib_port, kobj);
741 sysfs_remove_group(p, &pma_group);
742 sysfs_remove_group(p, &port->pkey_group);
743 sysfs_remove_group(p, &port->gid_group);
744 kobject_unregister(p);
747 kobject_unregister(&device->ports_parent);
748 class_device_unregister(&device->class_dev);
751 int ib_sysfs_setup(void)
753 return class_register(&ib_class);
756 void ib_sysfs_cleanup(void)
758 class_unregister(&ib_class);