1 // SPDX-License-Identifier: GPL-2.0
3 * configfs to configure the PCI endpoint
5 * Copyright (C) 2017 Texas Instruments
9 #include <linux/module.h>
10 #include <linux/idr.h>
11 #include <linux/slab.h>
13 #include <linux/pci-epc.h>
14 #include <linux/pci-epf.h>
15 #include <linux/pci-ep-cfs.h>
17 static DEFINE_IDR(functions_idr);
18 static DEFINE_MUTEX(functions_mutex);
19 static struct config_group *functions_group;
20 static struct config_group *controllers_group;
22 struct pci_epf_group {
23 struct config_group group;
24 struct config_group primary_epc_group;
25 struct config_group secondary_epc_group;
26 struct delayed_work cfs_work;
31 struct pci_epc_group {
32 struct config_group group;
37 static inline struct pci_epf_group *to_pci_epf_group(struct config_item *item)
39 return container_of(to_config_group(item), struct pci_epf_group, group);
42 static inline struct pci_epc_group *to_pci_epc_group(struct config_item *item)
44 return container_of(to_config_group(item), struct pci_epc_group, group);
47 static int pci_secondary_epc_epf_link(struct config_item *epf_item,
48 struct config_item *epc_item)
51 struct pci_epf_group *epf_group = to_pci_epf_group(epf_item->ci_parent);
52 struct pci_epc_group *epc_group = to_pci_epc_group(epc_item);
53 struct pci_epc *epc = epc_group->epc;
54 struct pci_epf *epf = epf_group->epf;
56 ret = pci_epc_add_epf(epc, epf, SECONDARY_INTERFACE);
60 ret = pci_epf_bind(epf);
62 pci_epc_remove_epf(epc, epf, SECONDARY_INTERFACE);
69 static void pci_secondary_epc_epf_unlink(struct config_item *epc_item,
70 struct config_item *epf_item)
72 struct pci_epf_group *epf_group = to_pci_epf_group(epf_item->ci_parent);
73 struct pci_epc_group *epc_group = to_pci_epc_group(epc_item);
77 WARN_ON_ONCE(epc_group->start);
82 pci_epc_remove_epf(epc, epf, SECONDARY_INTERFACE);
85 static struct configfs_item_operations pci_secondary_epc_item_ops = {
86 .allow_link = pci_secondary_epc_epf_link,
87 .drop_link = pci_secondary_epc_epf_unlink,
90 static const struct config_item_type pci_secondary_epc_type = {
91 .ct_item_ops = &pci_secondary_epc_item_ops,
92 .ct_owner = THIS_MODULE,
95 static struct config_group
96 *pci_ep_cfs_add_secondary_group(struct pci_epf_group *epf_group)
98 struct config_group *secondary_epc_group;
100 secondary_epc_group = &epf_group->secondary_epc_group;
101 config_group_init_type_name(secondary_epc_group, "secondary",
102 &pci_secondary_epc_type);
103 configfs_register_group(&epf_group->group, secondary_epc_group);
105 return secondary_epc_group;
108 static int pci_primary_epc_epf_link(struct config_item *epf_item,
109 struct config_item *epc_item)
112 struct pci_epf_group *epf_group = to_pci_epf_group(epf_item->ci_parent);
113 struct pci_epc_group *epc_group = to_pci_epc_group(epc_item);
114 struct pci_epc *epc = epc_group->epc;
115 struct pci_epf *epf = epf_group->epf;
117 ret = pci_epc_add_epf(epc, epf, PRIMARY_INTERFACE);
121 ret = pci_epf_bind(epf);
123 pci_epc_remove_epf(epc, epf, PRIMARY_INTERFACE);
130 static void pci_primary_epc_epf_unlink(struct config_item *epc_item,
131 struct config_item *epf_item)
133 struct pci_epf_group *epf_group = to_pci_epf_group(epf_item->ci_parent);
134 struct pci_epc_group *epc_group = to_pci_epc_group(epc_item);
138 WARN_ON_ONCE(epc_group->start);
140 epc = epc_group->epc;
141 epf = epf_group->epf;
143 pci_epc_remove_epf(epc, epf, PRIMARY_INTERFACE);
146 static struct configfs_item_operations pci_primary_epc_item_ops = {
147 .allow_link = pci_primary_epc_epf_link,
148 .drop_link = pci_primary_epc_epf_unlink,
151 static const struct config_item_type pci_primary_epc_type = {
152 .ct_item_ops = &pci_primary_epc_item_ops,
153 .ct_owner = THIS_MODULE,
156 static struct config_group
157 *pci_ep_cfs_add_primary_group(struct pci_epf_group *epf_group)
159 struct config_group *primary_epc_group = &epf_group->primary_epc_group;
161 config_group_init_type_name(primary_epc_group, "primary",
162 &pci_primary_epc_type);
163 configfs_register_group(&epf_group->group, primary_epc_group);
165 return primary_epc_group;
168 static ssize_t pci_epc_start_store(struct config_item *item, const char *page,
174 struct pci_epc_group *epc_group = to_pci_epc_group(item);
176 epc = epc_group->epc;
178 if (kstrtobool(page, &start) < 0)
183 epc_group->start = 0;
187 ret = pci_epc_start(epc);
189 dev_err(&epc->dev, "failed to start endpoint controller\n");
193 epc_group->start = start;
198 static ssize_t pci_epc_start_show(struct config_item *item, char *page)
200 return sysfs_emit(page, "%d\n", to_pci_epc_group(item)->start);
203 CONFIGFS_ATTR(pci_epc_, start);
205 static struct configfs_attribute *pci_epc_attrs[] = {
210 static int pci_epc_epf_link(struct config_item *epc_item,
211 struct config_item *epf_item)
214 struct pci_epf_group *epf_group = to_pci_epf_group(epf_item);
215 struct pci_epc_group *epc_group = to_pci_epc_group(epc_item);
216 struct pci_epc *epc = epc_group->epc;
217 struct pci_epf *epf = epf_group->epf;
219 ret = pci_epc_add_epf(epc, epf, PRIMARY_INTERFACE);
223 ret = pci_epf_bind(epf);
225 pci_epc_remove_epf(epc, epf, PRIMARY_INTERFACE);
232 static void pci_epc_epf_unlink(struct config_item *epc_item,
233 struct config_item *epf_item)
237 struct pci_epf_group *epf_group = to_pci_epf_group(epf_item);
238 struct pci_epc_group *epc_group = to_pci_epc_group(epc_item);
240 WARN_ON_ONCE(epc_group->start);
242 epc = epc_group->epc;
243 epf = epf_group->epf;
245 pci_epc_remove_epf(epc, epf, PRIMARY_INTERFACE);
248 static struct configfs_item_operations pci_epc_item_ops = {
249 .allow_link = pci_epc_epf_link,
250 .drop_link = pci_epc_epf_unlink,
253 static const struct config_item_type pci_epc_type = {
254 .ct_item_ops = &pci_epc_item_ops,
255 .ct_attrs = pci_epc_attrs,
256 .ct_owner = THIS_MODULE,
259 struct config_group *pci_ep_cfs_add_epc_group(const char *name)
263 struct config_group *group;
264 struct pci_epc_group *epc_group;
266 epc_group = kzalloc(sizeof(*epc_group), GFP_KERNEL);
272 group = &epc_group->group;
274 config_group_init_type_name(group, name, &pci_epc_type);
275 ret = configfs_register_group(controllers_group, group);
277 pr_err("failed to register configfs group for %s\n", name);
278 goto err_register_group;
281 epc = pci_epc_get(name);
287 epc_group->epc = epc;
292 configfs_unregister_group(group);
300 EXPORT_SYMBOL(pci_ep_cfs_add_epc_group);
302 void pci_ep_cfs_remove_epc_group(struct config_group *group)
304 struct pci_epc_group *epc_group;
309 epc_group = container_of(group, struct pci_epc_group, group);
310 pci_epc_put(epc_group->epc);
311 configfs_unregister_group(&epc_group->group);
314 EXPORT_SYMBOL(pci_ep_cfs_remove_epc_group);
316 #define PCI_EPF_HEADER_R(_name) \
317 static ssize_t pci_epf_##_name##_show(struct config_item *item, char *page) \
319 struct pci_epf *epf = to_pci_epf_group(item)->epf; \
320 if (WARN_ON_ONCE(!epf->header)) \
322 return sysfs_emit(page, "0x%04x\n", epf->header->_name); \
325 #define PCI_EPF_HEADER_W_u32(_name) \
326 static ssize_t pci_epf_##_name##_store(struct config_item *item, \
327 const char *page, size_t len) \
330 struct pci_epf *epf = to_pci_epf_group(item)->epf; \
331 if (WARN_ON_ONCE(!epf->header)) \
333 if (kstrtou32(page, 0, &val) < 0) \
335 epf->header->_name = val; \
339 #define PCI_EPF_HEADER_W_u16(_name) \
340 static ssize_t pci_epf_##_name##_store(struct config_item *item, \
341 const char *page, size_t len) \
344 struct pci_epf *epf = to_pci_epf_group(item)->epf; \
345 if (WARN_ON_ONCE(!epf->header)) \
347 if (kstrtou16(page, 0, &val) < 0) \
349 epf->header->_name = val; \
353 #define PCI_EPF_HEADER_W_u8(_name) \
354 static ssize_t pci_epf_##_name##_store(struct config_item *item, \
355 const char *page, size_t len) \
358 struct pci_epf *epf = to_pci_epf_group(item)->epf; \
359 if (WARN_ON_ONCE(!epf->header)) \
361 if (kstrtou8(page, 0, &val) < 0) \
363 epf->header->_name = val; \
367 static ssize_t pci_epf_msi_interrupts_store(struct config_item *item,
368 const char *page, size_t len)
372 if (kstrtou8(page, 0, &val) < 0)
375 to_pci_epf_group(item)->epf->msi_interrupts = val;
380 static ssize_t pci_epf_msi_interrupts_show(struct config_item *item,
383 return sysfs_emit(page, "%d\n",
384 to_pci_epf_group(item)->epf->msi_interrupts);
387 static ssize_t pci_epf_msix_interrupts_store(struct config_item *item,
388 const char *page, size_t len)
392 if (kstrtou16(page, 0, &val) < 0)
395 to_pci_epf_group(item)->epf->msix_interrupts = val;
400 static ssize_t pci_epf_msix_interrupts_show(struct config_item *item,
403 return sysfs_emit(page, "%d\n",
404 to_pci_epf_group(item)->epf->msix_interrupts);
407 PCI_EPF_HEADER_R(vendorid)
408 PCI_EPF_HEADER_W_u16(vendorid)
410 PCI_EPF_HEADER_R(deviceid)
411 PCI_EPF_HEADER_W_u16(deviceid)
413 PCI_EPF_HEADER_R(revid)
414 PCI_EPF_HEADER_W_u8(revid)
416 PCI_EPF_HEADER_R(progif_code)
417 PCI_EPF_HEADER_W_u8(progif_code)
419 PCI_EPF_HEADER_R(subclass_code)
420 PCI_EPF_HEADER_W_u8(subclass_code)
422 PCI_EPF_HEADER_R(baseclass_code)
423 PCI_EPF_HEADER_W_u8(baseclass_code)
425 PCI_EPF_HEADER_R(cache_line_size)
426 PCI_EPF_HEADER_W_u8(cache_line_size)
428 PCI_EPF_HEADER_R(subsys_vendor_id)
429 PCI_EPF_HEADER_W_u16(subsys_vendor_id)
431 PCI_EPF_HEADER_R(subsys_id)
432 PCI_EPF_HEADER_W_u16(subsys_id)
434 PCI_EPF_HEADER_R(interrupt_pin)
435 PCI_EPF_HEADER_W_u8(interrupt_pin)
437 CONFIGFS_ATTR(pci_epf_, vendorid);
438 CONFIGFS_ATTR(pci_epf_, deviceid);
439 CONFIGFS_ATTR(pci_epf_, revid);
440 CONFIGFS_ATTR(pci_epf_, progif_code);
441 CONFIGFS_ATTR(pci_epf_, subclass_code);
442 CONFIGFS_ATTR(pci_epf_, baseclass_code);
443 CONFIGFS_ATTR(pci_epf_, cache_line_size);
444 CONFIGFS_ATTR(pci_epf_, subsys_vendor_id);
445 CONFIGFS_ATTR(pci_epf_, subsys_id);
446 CONFIGFS_ATTR(pci_epf_, interrupt_pin);
447 CONFIGFS_ATTR(pci_epf_, msi_interrupts);
448 CONFIGFS_ATTR(pci_epf_, msix_interrupts);
450 static struct configfs_attribute *pci_epf_attrs[] = {
451 &pci_epf_attr_vendorid,
452 &pci_epf_attr_deviceid,
454 &pci_epf_attr_progif_code,
455 &pci_epf_attr_subclass_code,
456 &pci_epf_attr_baseclass_code,
457 &pci_epf_attr_cache_line_size,
458 &pci_epf_attr_subsys_vendor_id,
459 &pci_epf_attr_subsys_id,
460 &pci_epf_attr_interrupt_pin,
461 &pci_epf_attr_msi_interrupts,
462 &pci_epf_attr_msix_interrupts,
466 static int pci_epf_vepf_link(struct config_item *epf_pf_item,
467 struct config_item *epf_vf_item)
469 struct pci_epf_group *epf_vf_group = to_pci_epf_group(epf_vf_item);
470 struct pci_epf_group *epf_pf_group = to_pci_epf_group(epf_pf_item);
471 struct pci_epf *epf_pf = epf_pf_group->epf;
472 struct pci_epf *epf_vf = epf_vf_group->epf;
474 return pci_epf_add_vepf(epf_pf, epf_vf);
477 static void pci_epf_vepf_unlink(struct config_item *epf_pf_item,
478 struct config_item *epf_vf_item)
480 struct pci_epf_group *epf_vf_group = to_pci_epf_group(epf_vf_item);
481 struct pci_epf_group *epf_pf_group = to_pci_epf_group(epf_pf_item);
482 struct pci_epf *epf_pf = epf_pf_group->epf;
483 struct pci_epf *epf_vf = epf_vf_group->epf;
485 pci_epf_remove_vepf(epf_pf, epf_vf);
488 static void pci_epf_release(struct config_item *item)
490 struct pci_epf_group *epf_group = to_pci_epf_group(item);
492 mutex_lock(&functions_mutex);
493 idr_remove(&functions_idr, epf_group->index);
494 mutex_unlock(&functions_mutex);
495 pci_epf_destroy(epf_group->epf);
499 static struct configfs_item_operations pci_epf_ops = {
500 .allow_link = pci_epf_vepf_link,
501 .drop_link = pci_epf_vepf_unlink,
502 .release = pci_epf_release,
505 static struct config_group *pci_epf_type_make(struct config_group *group,
508 struct pci_epf_group *epf_group = to_pci_epf_group(&group->cg_item);
509 struct config_group *epf_type_group;
511 epf_type_group = pci_epf_type_add_cfs(epf_group->epf, group);
512 return epf_type_group;
515 static void pci_epf_type_drop(struct config_group *group,
516 struct config_item *item)
518 config_item_put(item);
521 static struct configfs_group_operations pci_epf_type_group_ops = {
522 .make_group = &pci_epf_type_make,
523 .drop_item = &pci_epf_type_drop,
526 static const struct config_item_type pci_epf_type = {
527 .ct_group_ops = &pci_epf_type_group_ops,
528 .ct_item_ops = &pci_epf_ops,
529 .ct_attrs = pci_epf_attrs,
530 .ct_owner = THIS_MODULE,
533 static void pci_epf_cfs_work(struct work_struct *work)
535 struct pci_epf_group *epf_group;
536 struct config_group *group;
538 epf_group = container_of(work, struct pci_epf_group, cfs_work.work);
539 group = pci_ep_cfs_add_primary_group(epf_group);
541 pr_err("failed to create 'primary' EPC interface\n");
545 group = pci_ep_cfs_add_secondary_group(epf_group);
547 pr_err("failed to create 'secondary' EPC interface\n");
552 static struct config_group *pci_epf_make(struct config_group *group,
555 struct pci_epf_group *epf_group;
560 epf_group = kzalloc(sizeof(*epf_group), GFP_KERNEL);
562 return ERR_PTR(-ENOMEM);
564 mutex_lock(&functions_mutex);
565 index = idr_alloc(&functions_idr, epf_group, 0, 0, GFP_KERNEL);
566 mutex_unlock(&functions_mutex);
572 epf_group->index = index;
574 config_group_init_type_name(&epf_group->group, name, &pci_epf_type);
576 epf_name = kasprintf(GFP_KERNEL, "%s.%d",
577 group->cg_item.ci_name, epf_group->index);
583 epf = pci_epf_create(epf_name);
585 pr_err("failed to create endpoint function device\n");
590 epf->group = &epf_group->group;
591 epf_group->epf = epf;
595 INIT_DELAYED_WORK(&epf_group->cfs_work, pci_epf_cfs_work);
596 queue_delayed_work(system_wq, &epf_group->cfs_work,
597 msecs_to_jiffies(1));
599 return &epf_group->group;
605 mutex_lock(&functions_mutex);
606 idr_remove(&functions_idr, epf_group->index);
607 mutex_unlock(&functions_mutex);
615 static void pci_epf_drop(struct config_group *group, struct config_item *item)
617 config_item_put(item);
620 static struct configfs_group_operations pci_epf_group_ops = {
621 .make_group = &pci_epf_make,
622 .drop_item = &pci_epf_drop,
625 static const struct config_item_type pci_epf_group_type = {
626 .ct_group_ops = &pci_epf_group_ops,
627 .ct_owner = THIS_MODULE,
630 struct config_group *pci_ep_cfs_add_epf_group(const char *name)
632 struct config_group *group;
634 group = configfs_register_default_group(functions_group, name,
635 &pci_epf_group_type);
637 pr_err("failed to register configfs group for %s function\n",
642 EXPORT_SYMBOL(pci_ep_cfs_add_epf_group);
644 void pci_ep_cfs_remove_epf_group(struct config_group *group)
646 if (IS_ERR_OR_NULL(group))
649 configfs_unregister_default_group(group);
651 EXPORT_SYMBOL(pci_ep_cfs_remove_epf_group);
653 static const struct config_item_type pci_functions_type = {
654 .ct_owner = THIS_MODULE,
657 static const struct config_item_type pci_controllers_type = {
658 .ct_owner = THIS_MODULE,
661 static const struct config_item_type pci_ep_type = {
662 .ct_owner = THIS_MODULE,
665 static struct configfs_subsystem pci_ep_cfs_subsys = {
668 .ci_namebuf = "pci_ep",
669 .ci_type = &pci_ep_type,
672 .su_mutex = __MUTEX_INITIALIZER(pci_ep_cfs_subsys.su_mutex),
675 static int __init pci_ep_cfs_init(void)
678 struct config_group *root = &pci_ep_cfs_subsys.su_group;
680 config_group_init(root);
682 ret = configfs_register_subsystem(&pci_ep_cfs_subsys);
684 pr_err("Error %d while registering subsystem %s\n",
685 ret, root->cg_item.ci_namebuf);
689 functions_group = configfs_register_default_group(root, "functions",
690 &pci_functions_type);
691 if (IS_ERR(functions_group)) {
692 ret = PTR_ERR(functions_group);
693 pr_err("Error %d while registering functions group\n",
695 goto err_functions_group;
699 configfs_register_default_group(root, "controllers",
700 &pci_controllers_type);
701 if (IS_ERR(controllers_group)) {
702 ret = PTR_ERR(controllers_group);
703 pr_err("Error %d while registering controllers group\n",
705 goto err_controllers_group;
710 err_controllers_group:
711 configfs_unregister_default_group(functions_group);
714 configfs_unregister_subsystem(&pci_ep_cfs_subsys);
719 module_init(pci_ep_cfs_init);
721 static void __exit pci_ep_cfs_exit(void)
723 configfs_unregister_default_group(controllers_group);
724 configfs_unregister_default_group(functions_group);
725 configfs_unregister_subsystem(&pci_ep_cfs_subsys);
727 module_exit(pci_ep_cfs_exit);
729 MODULE_DESCRIPTION("PCI EP CONFIGFS");
731 MODULE_LICENSE("GPL v2");