1 // SPDX-License-Identifier: GPL-2.0
3 * configfs to configure the PCI endpoint
5 * Copyright (C) 2017 Texas Instruments
6 * Author: Kishon Vijay Abraham I <kishon@ti.com>
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 ret = kstrtobool(page, &start);
184 epc_group->start = 0;
188 ret = pci_epc_start(epc);
190 dev_err(&epc->dev, "failed to start endpoint controller\n");
194 epc_group->start = start;
199 static ssize_t pci_epc_start_show(struct config_item *item, char *page)
201 return sprintf(page, "%d\n",
202 to_pci_epc_group(item)->start);
205 CONFIGFS_ATTR(pci_epc_, start);
207 static struct configfs_attribute *pci_epc_attrs[] = {
212 static int pci_epc_epf_link(struct config_item *epc_item,
213 struct config_item *epf_item)
216 struct pci_epf_group *epf_group = to_pci_epf_group(epf_item);
217 struct pci_epc_group *epc_group = to_pci_epc_group(epc_item);
218 struct pci_epc *epc = epc_group->epc;
219 struct pci_epf *epf = epf_group->epf;
221 ret = pci_epc_add_epf(epc, epf, PRIMARY_INTERFACE);
225 ret = pci_epf_bind(epf);
227 pci_epc_remove_epf(epc, epf, PRIMARY_INTERFACE);
234 static void pci_epc_epf_unlink(struct config_item *epc_item,
235 struct config_item *epf_item)
239 struct pci_epf_group *epf_group = to_pci_epf_group(epf_item);
240 struct pci_epc_group *epc_group = to_pci_epc_group(epc_item);
242 WARN_ON_ONCE(epc_group->start);
244 epc = epc_group->epc;
245 epf = epf_group->epf;
247 pci_epc_remove_epf(epc, epf, PRIMARY_INTERFACE);
250 static struct configfs_item_operations pci_epc_item_ops = {
251 .allow_link = pci_epc_epf_link,
252 .drop_link = pci_epc_epf_unlink,
255 static const struct config_item_type pci_epc_type = {
256 .ct_item_ops = &pci_epc_item_ops,
257 .ct_attrs = pci_epc_attrs,
258 .ct_owner = THIS_MODULE,
261 struct config_group *pci_ep_cfs_add_epc_group(const char *name)
265 struct config_group *group;
266 struct pci_epc_group *epc_group;
268 epc_group = kzalloc(sizeof(*epc_group), GFP_KERNEL);
274 group = &epc_group->group;
276 config_group_init_type_name(group, name, &pci_epc_type);
277 ret = configfs_register_group(controllers_group, group);
279 pr_err("failed to register configfs group for %s\n", name);
280 goto err_register_group;
283 epc = pci_epc_get(name);
289 epc_group->epc = epc;
294 configfs_unregister_group(group);
302 EXPORT_SYMBOL(pci_ep_cfs_add_epc_group);
304 void pci_ep_cfs_remove_epc_group(struct config_group *group)
306 struct pci_epc_group *epc_group;
311 epc_group = container_of(group, struct pci_epc_group, group);
312 pci_epc_put(epc_group->epc);
313 configfs_unregister_group(&epc_group->group);
316 EXPORT_SYMBOL(pci_ep_cfs_remove_epc_group);
318 #define PCI_EPF_HEADER_R(_name) \
319 static ssize_t pci_epf_##_name##_show(struct config_item *item, char *page) \
321 struct pci_epf *epf = to_pci_epf_group(item)->epf; \
322 if (WARN_ON_ONCE(!epf->header)) \
324 return sprintf(page, "0x%04x\n", epf->header->_name); \
327 #define PCI_EPF_HEADER_W_u32(_name) \
328 static ssize_t pci_epf_##_name##_store(struct config_item *item, \
329 const char *page, size_t len) \
333 struct pci_epf *epf = to_pci_epf_group(item)->epf; \
334 if (WARN_ON_ONCE(!epf->header)) \
336 ret = kstrtou32(page, 0, &val); \
339 epf->header->_name = val; \
343 #define PCI_EPF_HEADER_W_u16(_name) \
344 static ssize_t pci_epf_##_name##_store(struct config_item *item, \
345 const char *page, size_t len) \
349 struct pci_epf *epf = to_pci_epf_group(item)->epf; \
350 if (WARN_ON_ONCE(!epf->header)) \
352 ret = kstrtou16(page, 0, &val); \
355 epf->header->_name = val; \
359 #define PCI_EPF_HEADER_W_u8(_name) \
360 static ssize_t pci_epf_##_name##_store(struct config_item *item, \
361 const char *page, size_t len) \
365 struct pci_epf *epf = to_pci_epf_group(item)->epf; \
366 if (WARN_ON_ONCE(!epf->header)) \
368 ret = kstrtou8(page, 0, &val); \
371 epf->header->_name = val; \
375 static ssize_t pci_epf_msi_interrupts_store(struct config_item *item,
376 const char *page, size_t len)
381 ret = kstrtou8(page, 0, &val);
385 to_pci_epf_group(item)->epf->msi_interrupts = val;
390 static ssize_t pci_epf_msi_interrupts_show(struct config_item *item,
393 return sprintf(page, "%d\n",
394 to_pci_epf_group(item)->epf->msi_interrupts);
397 static ssize_t pci_epf_msix_interrupts_store(struct config_item *item,
398 const char *page, size_t len)
403 ret = kstrtou16(page, 0, &val);
407 to_pci_epf_group(item)->epf->msix_interrupts = val;
412 static ssize_t pci_epf_msix_interrupts_show(struct config_item *item,
415 return sprintf(page, "%d\n",
416 to_pci_epf_group(item)->epf->msix_interrupts);
419 PCI_EPF_HEADER_R(vendorid)
420 PCI_EPF_HEADER_W_u16(vendorid)
422 PCI_EPF_HEADER_R(deviceid)
423 PCI_EPF_HEADER_W_u16(deviceid)
425 PCI_EPF_HEADER_R(revid)
426 PCI_EPF_HEADER_W_u8(revid)
428 PCI_EPF_HEADER_R(progif_code)
429 PCI_EPF_HEADER_W_u8(progif_code)
431 PCI_EPF_HEADER_R(subclass_code)
432 PCI_EPF_HEADER_W_u8(subclass_code)
434 PCI_EPF_HEADER_R(baseclass_code)
435 PCI_EPF_HEADER_W_u8(baseclass_code)
437 PCI_EPF_HEADER_R(cache_line_size)
438 PCI_EPF_HEADER_W_u8(cache_line_size)
440 PCI_EPF_HEADER_R(subsys_vendor_id)
441 PCI_EPF_HEADER_W_u16(subsys_vendor_id)
443 PCI_EPF_HEADER_R(subsys_id)
444 PCI_EPF_HEADER_W_u16(subsys_id)
446 PCI_EPF_HEADER_R(interrupt_pin)
447 PCI_EPF_HEADER_W_u8(interrupt_pin)
449 CONFIGFS_ATTR(pci_epf_, vendorid);
450 CONFIGFS_ATTR(pci_epf_, deviceid);
451 CONFIGFS_ATTR(pci_epf_, revid);
452 CONFIGFS_ATTR(pci_epf_, progif_code);
453 CONFIGFS_ATTR(pci_epf_, subclass_code);
454 CONFIGFS_ATTR(pci_epf_, baseclass_code);
455 CONFIGFS_ATTR(pci_epf_, cache_line_size);
456 CONFIGFS_ATTR(pci_epf_, subsys_vendor_id);
457 CONFIGFS_ATTR(pci_epf_, subsys_id);
458 CONFIGFS_ATTR(pci_epf_, interrupt_pin);
459 CONFIGFS_ATTR(pci_epf_, msi_interrupts);
460 CONFIGFS_ATTR(pci_epf_, msix_interrupts);
462 static struct configfs_attribute *pci_epf_attrs[] = {
463 &pci_epf_attr_vendorid,
464 &pci_epf_attr_deviceid,
466 &pci_epf_attr_progif_code,
467 &pci_epf_attr_subclass_code,
468 &pci_epf_attr_baseclass_code,
469 &pci_epf_attr_cache_line_size,
470 &pci_epf_attr_subsys_vendor_id,
471 &pci_epf_attr_subsys_id,
472 &pci_epf_attr_interrupt_pin,
473 &pci_epf_attr_msi_interrupts,
474 &pci_epf_attr_msix_interrupts,
478 static void pci_epf_release(struct config_item *item)
480 struct pci_epf_group *epf_group = to_pci_epf_group(item);
482 mutex_lock(&functions_mutex);
483 idr_remove(&functions_idr, epf_group->index);
484 mutex_unlock(&functions_mutex);
485 pci_epf_destroy(epf_group->epf);
489 static struct configfs_item_operations pci_epf_ops = {
490 .release = pci_epf_release,
493 static struct config_group *pci_epf_type_make(struct config_group *group,
496 struct pci_epf_group *epf_group = to_pci_epf_group(&group->cg_item);
497 struct config_group *epf_type_group;
499 epf_type_group = pci_epf_type_add_cfs(epf_group->epf, group);
500 return epf_type_group;
503 static void pci_epf_type_drop(struct config_group *group,
504 struct config_item *item)
506 config_item_put(item);
509 static struct configfs_group_operations pci_epf_type_group_ops = {
510 .make_group = &pci_epf_type_make,
511 .drop_item = &pci_epf_type_drop,
514 static const struct config_item_type pci_epf_type = {
515 .ct_group_ops = &pci_epf_type_group_ops,
516 .ct_item_ops = &pci_epf_ops,
517 .ct_attrs = pci_epf_attrs,
518 .ct_owner = THIS_MODULE,
521 static void pci_epf_cfs_work(struct work_struct *work)
523 struct pci_epf_group *epf_group;
524 struct config_group *group;
526 epf_group = container_of(work, struct pci_epf_group, cfs_work.work);
527 group = pci_ep_cfs_add_primary_group(epf_group);
529 pr_err("failed to create 'primary' EPC interface\n");
533 group = pci_ep_cfs_add_secondary_group(epf_group);
535 pr_err("failed to create 'secondary' EPC interface\n");
540 static struct config_group *pci_epf_make(struct config_group *group,
543 struct pci_epf_group *epf_group;
548 epf_group = kzalloc(sizeof(*epf_group), GFP_KERNEL);
550 return ERR_PTR(-ENOMEM);
552 mutex_lock(&functions_mutex);
553 index = idr_alloc(&functions_idr, epf_group, 0, 0, GFP_KERNEL);
554 mutex_unlock(&functions_mutex);
560 epf_group->index = index;
562 config_group_init_type_name(&epf_group->group, name, &pci_epf_type);
564 epf_name = kasprintf(GFP_KERNEL, "%s.%d",
565 group->cg_item.ci_name, epf_group->index);
571 epf = pci_epf_create(epf_name);
573 pr_err("failed to create endpoint function device\n");
578 epf->group = &epf_group->group;
579 epf_group->epf = epf;
583 INIT_DELAYED_WORK(&epf_group->cfs_work, pci_epf_cfs_work);
584 queue_delayed_work(system_wq, &epf_group->cfs_work,
585 msecs_to_jiffies(1));
587 return &epf_group->group;
593 mutex_lock(&functions_mutex);
594 idr_remove(&functions_idr, epf_group->index);
595 mutex_unlock(&functions_mutex);
603 static void pci_epf_drop(struct config_group *group, struct config_item *item)
605 config_item_put(item);
608 static struct configfs_group_operations pci_epf_group_ops = {
609 .make_group = &pci_epf_make,
610 .drop_item = &pci_epf_drop,
613 static const struct config_item_type pci_epf_group_type = {
614 .ct_group_ops = &pci_epf_group_ops,
615 .ct_owner = THIS_MODULE,
618 struct config_group *pci_ep_cfs_add_epf_group(const char *name)
620 struct config_group *group;
622 group = configfs_register_default_group(functions_group, name,
623 &pci_epf_group_type);
625 pr_err("failed to register configfs group for %s function\n",
630 EXPORT_SYMBOL(pci_ep_cfs_add_epf_group);
632 void pci_ep_cfs_remove_epf_group(struct config_group *group)
634 if (IS_ERR_OR_NULL(group))
637 configfs_unregister_default_group(group);
639 EXPORT_SYMBOL(pci_ep_cfs_remove_epf_group);
641 static const struct config_item_type pci_functions_type = {
642 .ct_owner = THIS_MODULE,
645 static const struct config_item_type pci_controllers_type = {
646 .ct_owner = THIS_MODULE,
649 static const struct config_item_type pci_ep_type = {
650 .ct_owner = THIS_MODULE,
653 static struct configfs_subsystem pci_ep_cfs_subsys = {
656 .ci_namebuf = "pci_ep",
657 .ci_type = &pci_ep_type,
660 .su_mutex = __MUTEX_INITIALIZER(pci_ep_cfs_subsys.su_mutex),
663 static int __init pci_ep_cfs_init(void)
666 struct config_group *root = &pci_ep_cfs_subsys.su_group;
668 config_group_init(root);
670 ret = configfs_register_subsystem(&pci_ep_cfs_subsys);
672 pr_err("Error %d while registering subsystem %s\n",
673 ret, root->cg_item.ci_namebuf);
677 functions_group = configfs_register_default_group(root, "functions",
678 &pci_functions_type);
679 if (IS_ERR(functions_group)) {
680 ret = PTR_ERR(functions_group);
681 pr_err("Error %d while registering functions group\n",
683 goto err_functions_group;
687 configfs_register_default_group(root, "controllers",
688 &pci_controllers_type);
689 if (IS_ERR(controllers_group)) {
690 ret = PTR_ERR(controllers_group);
691 pr_err("Error %d while registering controllers group\n",
693 goto err_controllers_group;
698 err_controllers_group:
699 configfs_unregister_default_group(functions_group);
702 configfs_unregister_subsystem(&pci_ep_cfs_subsys);
707 module_init(pci_ep_cfs_init);
709 static void __exit pci_ep_cfs_exit(void)
711 configfs_unregister_default_group(controllers_group);
712 configfs_unregister_default_group(functions_group);
713 configfs_unregister_subsystem(&pci_ep_cfs_subsys);
715 module_exit(pci_ep_cfs_exit);
717 MODULE_DESCRIPTION("PCI EP CONFIGFS");
718 MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>");
719 MODULE_LICENSE("GPL v2");