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 <rdma/ib_mad.h>
43 struct ib_device *ibdev;
44 struct attribute_group gid_group;
45 struct attribute_group pkey_group;
49 struct port_attribute {
50 struct attribute attr;
51 ssize_t (*show)(struct ib_port *, struct port_attribute *, char *buf);
52 ssize_t (*store)(struct ib_port *, struct port_attribute *,
53 const char *buf, size_t count);
56 #define PORT_ATTR(_name, _mode, _show, _store) \
57 struct port_attribute port_attr_##_name = __ATTR(_name, _mode, _show, _store)
59 #define PORT_ATTR_RO(_name) \
60 struct port_attribute port_attr_##_name = __ATTR_RO(_name)
62 struct port_table_attribute {
63 struct port_attribute attr;
68 static inline int ibdev_is_alive(const struct ib_device *dev)
70 return dev->reg_state == IB_DEV_REGISTERED;
73 static ssize_t port_attr_show(struct kobject *kobj,
74 struct attribute *attr, char *buf)
76 struct port_attribute *port_attr =
77 container_of(attr, struct port_attribute, attr);
78 struct ib_port *p = container_of(kobj, struct ib_port, kobj);
82 if (!ibdev_is_alive(p->ibdev))
85 return port_attr->show(p, port_attr, buf);
88 static struct sysfs_ops port_sysfs_ops = {
89 .show = port_attr_show
92 static ssize_t state_show(struct ib_port *p, struct port_attribute *unused,
95 struct ib_port_attr attr;
98 static const char *state_name[] = {
99 [IB_PORT_NOP] = "NOP",
100 [IB_PORT_DOWN] = "DOWN",
101 [IB_PORT_INIT] = "INIT",
102 [IB_PORT_ARMED] = "ARMED",
103 [IB_PORT_ACTIVE] = "ACTIVE",
104 [IB_PORT_ACTIVE_DEFER] = "ACTIVE_DEFER"
107 ret = ib_query_port(p->ibdev, p->port_num, &attr);
111 return sprintf(buf, "%d: %s\n", attr.state,
112 attr.state >= 0 && attr.state <= ARRAY_SIZE(state_name) ?
113 state_name[attr.state] : "UNKNOWN");
116 static ssize_t lid_show(struct ib_port *p, struct port_attribute *unused,
119 struct ib_port_attr attr;
122 ret = ib_query_port(p->ibdev, p->port_num, &attr);
126 return sprintf(buf, "0x%x\n", attr.lid);
129 static ssize_t lid_mask_count_show(struct ib_port *p,
130 struct port_attribute *unused,
133 struct ib_port_attr attr;
136 ret = ib_query_port(p->ibdev, p->port_num, &attr);
140 return sprintf(buf, "%d\n", attr.lmc);
143 static ssize_t sm_lid_show(struct ib_port *p, struct port_attribute *unused,
146 struct ib_port_attr attr;
149 ret = ib_query_port(p->ibdev, p->port_num, &attr);
153 return sprintf(buf, "0x%x\n", attr.sm_lid);
156 static ssize_t sm_sl_show(struct ib_port *p, struct port_attribute *unused,
159 struct ib_port_attr attr;
162 ret = ib_query_port(p->ibdev, p->port_num, &attr);
166 return sprintf(buf, "%d\n", attr.sm_sl);
169 static ssize_t cap_mask_show(struct ib_port *p, struct port_attribute *unused,
172 struct ib_port_attr attr;
175 ret = ib_query_port(p->ibdev, p->port_num, &attr);
179 return sprintf(buf, "0x%08x\n", attr.port_cap_flags);
182 static ssize_t rate_show(struct ib_port *p, struct port_attribute *unused,
185 struct ib_port_attr attr;
190 ret = ib_query_port(p->ibdev, p->port_num, &attr);
194 switch (attr.active_speed) {
195 case 2: speed = " DDR"; break;
196 case 4: speed = " QDR"; break;
199 rate = 25 * ib_width_enum_to_int(attr.active_width) * attr.active_speed;
203 return sprintf(buf, "%d%s Gb/sec (%dX%s)\n",
204 rate / 10, rate % 10 ? ".5" : "",
205 ib_width_enum_to_int(attr.active_width), speed);
208 static ssize_t phys_state_show(struct ib_port *p, struct port_attribute *unused,
211 struct ib_port_attr attr;
215 ret = ib_query_port(p->ibdev, p->port_num, &attr);
219 switch (attr.phys_state) {
220 case 1: return sprintf(buf, "1: Sleep\n");
221 case 2: return sprintf(buf, "2: Polling\n");
222 case 3: return sprintf(buf, "3: Disabled\n");
223 case 4: return sprintf(buf, "4: PortConfigurationTraining\n");
224 case 5: return sprintf(buf, "5: LinkUp\n");
225 case 6: return sprintf(buf, "6: LinkErrorRecovery\n");
226 case 7: return sprintf(buf, "7: Phy Test\n");
227 default: return sprintf(buf, "%d: <unknown>\n", attr.phys_state);
231 static PORT_ATTR_RO(state);
232 static PORT_ATTR_RO(lid);
233 static PORT_ATTR_RO(lid_mask_count);
234 static PORT_ATTR_RO(sm_lid);
235 static PORT_ATTR_RO(sm_sl);
236 static PORT_ATTR_RO(cap_mask);
237 static PORT_ATTR_RO(rate);
238 static PORT_ATTR_RO(phys_state);
240 static struct attribute *port_default_attrs[] = {
241 &port_attr_state.attr,
243 &port_attr_lid_mask_count.attr,
244 &port_attr_sm_lid.attr,
245 &port_attr_sm_sl.attr,
246 &port_attr_cap_mask.attr,
247 &port_attr_rate.attr,
248 &port_attr_phys_state.attr,
252 static ssize_t show_port_gid(struct ib_port *p, struct port_attribute *attr,
255 struct port_table_attribute *tab_attr =
256 container_of(attr, struct port_table_attribute, attr);
260 ret = ib_query_gid(p->ibdev, p->port_num, tab_attr->index, &gid);
264 return sprintf(buf, "%04x:%04x:%04x:%04x:%04x:%04x:%04x:%04x\n",
265 be16_to_cpu(((__be16 *) gid.raw)[0]),
266 be16_to_cpu(((__be16 *) gid.raw)[1]),
267 be16_to_cpu(((__be16 *) gid.raw)[2]),
268 be16_to_cpu(((__be16 *) gid.raw)[3]),
269 be16_to_cpu(((__be16 *) gid.raw)[4]),
270 be16_to_cpu(((__be16 *) gid.raw)[5]),
271 be16_to_cpu(((__be16 *) gid.raw)[6]),
272 be16_to_cpu(((__be16 *) gid.raw)[7]));
275 static ssize_t show_port_pkey(struct ib_port *p, struct port_attribute *attr,
278 struct port_table_attribute *tab_attr =
279 container_of(attr, struct port_table_attribute, attr);
283 ret = ib_query_pkey(p->ibdev, p->port_num, tab_attr->index, &pkey);
287 return sprintf(buf, "0x%04x\n", pkey);
290 #define PORT_PMA_ATTR(_name, _counter, _width, _offset) \
291 struct port_table_attribute port_pma_attr_##_name = { \
292 .attr = __ATTR(_name, S_IRUGO, show_pma_counter, NULL), \
293 .index = (_offset) | ((_width) << 16) | ((_counter) << 24) \
296 static ssize_t show_pma_counter(struct ib_port *p, struct port_attribute *attr,
299 struct port_table_attribute *tab_attr =
300 container_of(attr, struct port_table_attribute, attr);
301 int offset = tab_attr->index & 0xffff;
302 int width = (tab_attr->index >> 16) & 0xff;
303 struct ib_mad *in_mad = NULL;
304 struct ib_mad *out_mad = NULL;
307 if (!p->ibdev->process_mad)
308 return sprintf(buf, "N/A (no PMA)\n");
310 in_mad = kmalloc(sizeof *in_mad, GFP_KERNEL);
311 out_mad = kmalloc(sizeof *in_mad, GFP_KERNEL);
312 if (!in_mad || !out_mad) {
317 memset(in_mad, 0, sizeof *in_mad);
318 in_mad->mad_hdr.base_version = 1;
319 in_mad->mad_hdr.mgmt_class = IB_MGMT_CLASS_PERF_MGMT;
320 in_mad->mad_hdr.class_version = 1;
321 in_mad->mad_hdr.method = IB_MGMT_METHOD_GET;
322 in_mad->mad_hdr.attr_id = cpu_to_be16(0x12); /* PortCounters */
324 in_mad->data[41] = p->port_num; /* PortSelect field */
326 if ((p->ibdev->process_mad(p->ibdev, IB_MAD_IGNORE_MKEY,
327 p->port_num, NULL, NULL, in_mad, out_mad) &
328 (IB_MAD_RESULT_SUCCESS | IB_MAD_RESULT_REPLY)) !=
329 (IB_MAD_RESULT_SUCCESS | IB_MAD_RESULT_REPLY)) {
336 ret = sprintf(buf, "%u\n", (out_mad->data[40 + offset / 8] >>
337 (offset % 4)) & 0xf);
340 ret = sprintf(buf, "%u\n", out_mad->data[40 + offset / 8]);
343 ret = sprintf(buf, "%u\n",
344 be16_to_cpup((__be16 *)(out_mad->data + 40 + offset / 8)));
347 ret = sprintf(buf, "%u\n",
348 be32_to_cpup((__be32 *)(out_mad->data + 40 + offset / 8)));
361 static PORT_PMA_ATTR(symbol_error , 0, 16, 32);
362 static PORT_PMA_ATTR(link_error_recovery , 1, 8, 48);
363 static PORT_PMA_ATTR(link_downed , 2, 8, 56);
364 static PORT_PMA_ATTR(port_rcv_errors , 3, 16, 64);
365 static PORT_PMA_ATTR(port_rcv_remote_physical_errors, 4, 16, 80);
366 static PORT_PMA_ATTR(port_rcv_switch_relay_errors , 5, 16, 96);
367 static PORT_PMA_ATTR(port_xmit_discards , 6, 16, 112);
368 static PORT_PMA_ATTR(port_xmit_constraint_errors , 7, 8, 128);
369 static PORT_PMA_ATTR(port_rcv_constraint_errors , 8, 8, 136);
370 static PORT_PMA_ATTR(local_link_integrity_errors , 9, 4, 152);
371 static PORT_PMA_ATTR(excessive_buffer_overrun_errors, 10, 4, 156);
372 static PORT_PMA_ATTR(VL15_dropped , 11, 16, 176);
373 static PORT_PMA_ATTR(port_xmit_data , 12, 32, 192);
374 static PORT_PMA_ATTR(port_rcv_data , 13, 32, 224);
375 static PORT_PMA_ATTR(port_xmit_packets , 14, 32, 256);
376 static PORT_PMA_ATTR(port_rcv_packets , 15, 32, 288);
378 static struct attribute *pma_attrs[] = {
379 &port_pma_attr_symbol_error.attr.attr,
380 &port_pma_attr_link_error_recovery.attr.attr,
381 &port_pma_attr_link_downed.attr.attr,
382 &port_pma_attr_port_rcv_errors.attr.attr,
383 &port_pma_attr_port_rcv_remote_physical_errors.attr.attr,
384 &port_pma_attr_port_rcv_switch_relay_errors.attr.attr,
385 &port_pma_attr_port_xmit_discards.attr.attr,
386 &port_pma_attr_port_xmit_constraint_errors.attr.attr,
387 &port_pma_attr_port_rcv_constraint_errors.attr.attr,
388 &port_pma_attr_local_link_integrity_errors.attr.attr,
389 &port_pma_attr_excessive_buffer_overrun_errors.attr.attr,
390 &port_pma_attr_VL15_dropped.attr.attr,
391 &port_pma_attr_port_xmit_data.attr.attr,
392 &port_pma_attr_port_rcv_data.attr.attr,
393 &port_pma_attr_port_xmit_packets.attr.attr,
394 &port_pma_attr_port_rcv_packets.attr.attr,
398 static struct attribute_group pma_group = {
403 static void ib_port_release(struct kobject *kobj)
405 struct ib_port *p = container_of(kobj, struct ib_port, kobj);
409 for (i = 0; (a = p->gid_group.attrs[i]); ++i)
412 kfree(p->gid_group.attrs);
414 for (i = 0; (a = p->pkey_group.attrs[i]); ++i)
417 kfree(p->pkey_group.attrs);
422 static struct kobj_type port_type = {
423 .release = ib_port_release,
424 .sysfs_ops = &port_sysfs_ops,
425 .default_attrs = port_default_attrs
428 static void ib_device_release(struct class_device *cdev)
430 struct ib_device *dev = container_of(cdev, struct ib_device, class_dev);
435 static int ib_device_hotplug(struct class_device *cdev, char **envp,
436 int num_envp, char *buf, int size)
438 struct ib_device *dev = container_of(cdev, struct ib_device, class_dev);
441 if (add_hotplug_env_var(envp, num_envp, &i, buf, size, &len,
442 "NAME=%s", dev->name))
446 * It might be nice to pass the node GUID to hotplug, but
447 * right now the only way to get it is to query the device
448 * provider, and this can crash during device removal because
449 * we are will be running after driver removal has started.
450 * We could add a node_guid field to struct ib_device, or we
451 * could just let the hotplug script read the node GUID from
452 * sysfs when devices are added.
459 static struct attribute **
460 alloc_group_attrs(ssize_t (*show)(struct ib_port *,
461 struct port_attribute *, char *buf),
464 struct attribute **tab_attr;
465 struct port_table_attribute *element;
468 tab_attr = kcalloc(1 + len, sizeof(struct attribute *), GFP_KERNEL);
472 for (i = 0; i < len; i++) {
473 element = kzalloc(sizeof(struct port_table_attribute),
478 if (snprintf(element->name, sizeof(element->name),
479 "%d", i) >= sizeof(element->name))
482 element->attr.attr.name = element->name;
483 element->attr.attr.mode = S_IRUGO;
484 element->attr.attr.owner = THIS_MODULE;
485 element->attr.show = show;
488 tab_attr[i] = &element->attr.attr;
500 static int add_port(struct ib_device *device, int port_num)
503 struct ib_port_attr attr;
507 ret = ib_query_port(device, port_num, &attr);
511 p = kmalloc(sizeof *p, GFP_KERNEL);
514 memset(p, 0, sizeof *p);
517 p->port_num = port_num;
518 p->kobj.ktype = &port_type;
520 p->kobj.parent = kobject_get(&device->ports_parent);
521 if (!p->kobj.parent) {
526 ret = kobject_set_name(&p->kobj, "%d", port_num);
530 ret = kobject_register(&p->kobj);
534 ret = sysfs_create_group(&p->kobj, &pma_group);
538 p->gid_group.name = "gids";
539 p->gid_group.attrs = alloc_group_attrs(show_port_gid, attr.gid_tbl_len);
540 if (!p->gid_group.attrs)
543 ret = sysfs_create_group(&p->kobj, &p->gid_group);
547 p->pkey_group.name = "pkeys";
548 p->pkey_group.attrs = alloc_group_attrs(show_port_pkey,
550 if (!p->pkey_group.attrs)
553 ret = sysfs_create_group(&p->kobj, &p->pkey_group);
557 list_add_tail(&p->kobj.entry, &device->port_list);
562 for (i = 0; i < attr.pkey_tbl_len; ++i)
563 kfree(p->pkey_group.attrs[i]);
565 kfree(p->pkey_group.attrs);
568 sysfs_remove_group(&p->kobj, &p->gid_group);
571 for (i = 0; i < attr.gid_tbl_len; ++i)
572 kfree(p->gid_group.attrs[i]);
574 kfree(p->gid_group.attrs);
577 sysfs_remove_group(&p->kobj, &pma_group);
580 kobject_put(&device->ports_parent);
587 static ssize_t show_node_type(struct class_device *cdev, char *buf)
589 struct ib_device *dev = container_of(cdev, struct ib_device, class_dev);
591 if (!ibdev_is_alive(dev))
594 switch (dev->node_type) {
595 case IB_NODE_CA: return sprintf(buf, "%d: CA\n", dev->node_type);
596 case IB_NODE_SWITCH: return sprintf(buf, "%d: switch\n", dev->node_type);
597 case IB_NODE_ROUTER: return sprintf(buf, "%d: router\n", dev->node_type);
598 default: return sprintf(buf, "%d: <unknown>\n", dev->node_type);
602 static ssize_t show_sys_image_guid(struct class_device *cdev, char *buf)
604 struct ib_device *dev = container_of(cdev, struct ib_device, class_dev);
605 struct ib_device_attr attr;
608 if (!ibdev_is_alive(dev))
611 ret = ib_query_device(dev, &attr);
615 return sprintf(buf, "%04x:%04x:%04x:%04x\n",
616 be16_to_cpu(((__be16 *) &attr.sys_image_guid)[0]),
617 be16_to_cpu(((__be16 *) &attr.sys_image_guid)[1]),
618 be16_to_cpu(((__be16 *) &attr.sys_image_guid)[2]),
619 be16_to_cpu(((__be16 *) &attr.sys_image_guid)[3]));
622 static ssize_t show_node_guid(struct class_device *cdev, char *buf)
624 struct ib_device *dev = container_of(cdev, struct ib_device, class_dev);
625 struct ib_device_attr attr;
628 if (!ibdev_is_alive(dev))
631 ret = ib_query_device(dev, &attr);
635 return sprintf(buf, "%04x:%04x:%04x:%04x\n",
636 be16_to_cpu(((__be16 *) &attr.node_guid)[0]),
637 be16_to_cpu(((__be16 *) &attr.node_guid)[1]),
638 be16_to_cpu(((__be16 *) &attr.node_guid)[2]),
639 be16_to_cpu(((__be16 *) &attr.node_guid)[3]));
642 static CLASS_DEVICE_ATTR(node_type, S_IRUGO, show_node_type, NULL);
643 static CLASS_DEVICE_ATTR(sys_image_guid, S_IRUGO, show_sys_image_guid, NULL);
644 static CLASS_DEVICE_ATTR(node_guid, S_IRUGO, show_node_guid, NULL);
646 static struct class_device_attribute *ib_class_attributes[] = {
647 &class_device_attr_node_type,
648 &class_device_attr_sys_image_guid,
649 &class_device_attr_node_guid
652 static struct class ib_class = {
653 .name = "infiniband",
654 .release = ib_device_release,
655 .hotplug = ib_device_hotplug,
658 int ib_device_register_sysfs(struct ib_device *device)
660 struct class_device *class_dev = &device->class_dev;
664 class_dev->class = &ib_class;
665 class_dev->class_data = device;
666 strlcpy(class_dev->class_id, device->name, BUS_ID_SIZE);
668 INIT_LIST_HEAD(&device->port_list);
670 ret = class_device_register(class_dev);
674 for (i = 0; i < ARRAY_SIZE(ib_class_attributes); ++i) {
675 ret = class_device_create_file(class_dev, ib_class_attributes[i]);
680 device->ports_parent.parent = kobject_get(&class_dev->kobj);
681 if (!device->ports_parent.parent) {
685 ret = kobject_set_name(&device->ports_parent, "ports");
688 ret = kobject_register(&device->ports_parent);
692 if (device->node_type == IB_NODE_SWITCH) {
693 ret = add_port(device, 0);
699 for (i = 1; i <= device->phys_port_cnt; ++i) {
700 ret = add_port(device, i);
710 struct kobject *p, *t;
711 struct ib_port *port;
713 list_for_each_entry_safe(p, t, &device->port_list, entry) {
715 port = container_of(p, struct ib_port, kobj);
716 sysfs_remove_group(p, &pma_group);
717 sysfs_remove_group(p, &port->pkey_group);
718 sysfs_remove_group(p, &port->gid_group);
719 kobject_unregister(p);
723 kobject_put(&class_dev->kobj);
726 class_device_unregister(class_dev);
732 void ib_device_unregister_sysfs(struct ib_device *device)
734 struct kobject *p, *t;
735 struct ib_port *port;
737 list_for_each_entry_safe(p, t, &device->port_list, entry) {
739 port = container_of(p, struct ib_port, kobj);
740 sysfs_remove_group(p, &pma_group);
741 sysfs_remove_group(p, &port->pkey_group);
742 sysfs_remove_group(p, &port->gid_group);
743 kobject_unregister(p);
746 kobject_unregister(&device->ports_parent);
747 class_device_unregister(&device->class_dev);
750 int ib_sysfs_setup(void)
752 return class_register(&ib_class);
755 void ib_sysfs_cleanup(void)
757 class_unregister(&ib_class);