2 * configfs to configure the PCI endpoint
4 * Copyright (C) 2017 Texas Instruments
5 * Author: Kishon Vijay Abraham I <kishon@ti.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 of
9 * the License as published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 #include <linux/module.h>
21 #include <linux/slab.h>
23 #include <linux/pci-epc.h>
24 #include <linux/pci-epf.h>
25 #include <linux/pci-ep-cfs.h>
27 static struct config_group *functions_group;
28 static struct config_group *controllers_group;
30 struct pci_epf_group {
31 struct config_group group;
35 struct pci_epc_group {
36 struct config_group group;
39 unsigned long function_num_map;
42 static inline struct pci_epf_group *to_pci_epf_group(struct config_item *item)
44 return container_of(to_config_group(item), struct pci_epf_group, group);
47 static inline struct pci_epc_group *to_pci_epc_group(struct config_item *item)
49 return container_of(to_config_group(item), struct pci_epc_group, group);
52 static ssize_t pci_epc_start_store(struct config_item *item, const char *page,
58 struct pci_epc_group *epc_group = to_pci_epc_group(item);
62 ret = kstrtobool(page, &start);
71 ret = pci_epc_start(epc);
73 dev_err(&epc->dev, "failed to start endpoint controller\n");
77 epc_group->start = start;
82 static ssize_t pci_epc_start_show(struct config_item *item, char *page)
84 return sprintf(page, "%d\n",
85 to_pci_epc_group(item)->start);
88 CONFIGFS_ATTR(pci_epc_, start);
90 static struct configfs_attribute *pci_epc_attrs[] = {
95 static int pci_epc_epf_link(struct config_item *epc_item,
96 struct config_item *epf_item)
100 struct pci_epf_group *epf_group = to_pci_epf_group(epf_item);
101 struct pci_epc_group *epc_group = to_pci_epc_group(epc_item);
102 struct pci_epc *epc = epc_group->epc;
103 struct pci_epf *epf = epf_group->epf;
105 func_no = find_first_zero_bit(&epc_group->function_num_map,
107 if (func_no >= BITS_PER_LONG)
110 set_bit(func_no, &epc_group->function_num_map);
111 epf->func_no = func_no;
113 ret = pci_epc_add_epf(epc, epf);
117 ret = pci_epf_bind(epf);
124 pci_epc_remove_epf(epc, epf);
127 clear_bit(func_no, &epc_group->function_num_map);
132 static void pci_epc_epf_unlink(struct config_item *epc_item,
133 struct config_item *epf_item)
137 struct pci_epf_group *epf_group = to_pci_epf_group(epf_item);
138 struct pci_epc_group *epc_group = to_pci_epc_group(epc_item);
140 WARN_ON_ONCE(epc_group->start);
142 epc = epc_group->epc;
143 epf = epf_group->epf;
144 clear_bit(epf->func_no, &epc_group->function_num_map);
146 pci_epc_remove_epf(epc, epf);
149 static struct configfs_item_operations pci_epc_item_ops = {
150 .allow_link = pci_epc_epf_link,
151 .drop_link = pci_epc_epf_unlink,
154 static struct config_item_type pci_epc_type = {
155 .ct_item_ops = &pci_epc_item_ops,
156 .ct_attrs = pci_epc_attrs,
157 .ct_owner = THIS_MODULE,
160 struct config_group *pci_ep_cfs_add_epc_group(const char *name)
164 struct config_group *group;
165 struct pci_epc_group *epc_group;
167 epc_group = kzalloc(sizeof(*epc_group), GFP_KERNEL);
173 group = &epc_group->group;
175 config_group_init_type_name(group, name, &pci_epc_type);
176 ret = configfs_register_group(controllers_group, group);
178 pr_err("failed to register configfs group for %s\n", name);
179 goto err_register_group;
182 epc = pci_epc_get(name);
188 epc_group->epc = epc;
193 configfs_unregister_group(group);
201 EXPORT_SYMBOL(pci_ep_cfs_add_epc_group);
203 void pci_ep_cfs_remove_epc_group(struct config_group *group)
205 struct pci_epc_group *epc_group;
210 epc_group = container_of(group, struct pci_epc_group, group);
211 pci_epc_put(epc_group->epc);
212 configfs_unregister_group(&epc_group->group);
215 EXPORT_SYMBOL(pci_ep_cfs_remove_epc_group);
217 #define PCI_EPF_HEADER_R(_name) \
218 static ssize_t pci_epf_##_name##_show(struct config_item *item, char *page) \
220 struct pci_epf *epf = to_pci_epf_group(item)->epf; \
221 if (WARN_ON_ONCE(!epf->header)) \
223 return sprintf(page, "0x%04x\n", epf->header->_name); \
226 #define PCI_EPF_HEADER_W_u32(_name) \
227 static ssize_t pci_epf_##_name##_store(struct config_item *item, \
228 const char *page, size_t len) \
232 struct pci_epf *epf = to_pci_epf_group(item)->epf; \
233 if (WARN_ON_ONCE(!epf->header)) \
235 ret = kstrtou32(page, 0, &val); \
238 epf->header->_name = val; \
242 #define PCI_EPF_HEADER_W_u16(_name) \
243 static ssize_t pci_epf_##_name##_store(struct config_item *item, \
244 const char *page, size_t len) \
248 struct pci_epf *epf = to_pci_epf_group(item)->epf; \
249 if (WARN_ON_ONCE(!epf->header)) \
251 ret = kstrtou16(page, 0, &val); \
254 epf->header->_name = val; \
258 #define PCI_EPF_HEADER_W_u8(_name) \
259 static ssize_t pci_epf_##_name##_store(struct config_item *item, \
260 const char *page, size_t len) \
264 struct pci_epf *epf = to_pci_epf_group(item)->epf; \
265 if (WARN_ON_ONCE(!epf->header)) \
267 ret = kstrtou8(page, 0, &val); \
270 epf->header->_name = val; \
274 static ssize_t pci_epf_msi_interrupts_store(struct config_item *item,
275 const char *page, size_t len)
280 ret = kstrtou8(page, 0, &val);
284 to_pci_epf_group(item)->epf->msi_interrupts = val;
289 static ssize_t pci_epf_msi_interrupts_show(struct config_item *item,
292 return sprintf(page, "%d\n",
293 to_pci_epf_group(item)->epf->msi_interrupts);
296 PCI_EPF_HEADER_R(vendorid)
297 PCI_EPF_HEADER_W_u16(vendorid)
299 PCI_EPF_HEADER_R(deviceid)
300 PCI_EPF_HEADER_W_u16(deviceid)
302 PCI_EPF_HEADER_R(revid)
303 PCI_EPF_HEADER_W_u8(revid)
305 PCI_EPF_HEADER_R(progif_code)
306 PCI_EPF_HEADER_W_u8(progif_code)
308 PCI_EPF_HEADER_R(subclass_code)
309 PCI_EPF_HEADER_W_u8(subclass_code)
311 PCI_EPF_HEADER_R(baseclass_code)
312 PCI_EPF_HEADER_W_u8(baseclass_code)
314 PCI_EPF_HEADER_R(cache_line_size)
315 PCI_EPF_HEADER_W_u8(cache_line_size)
317 PCI_EPF_HEADER_R(subsys_vendor_id)
318 PCI_EPF_HEADER_W_u16(subsys_vendor_id)
320 PCI_EPF_HEADER_R(subsys_id)
321 PCI_EPF_HEADER_W_u16(subsys_id)
323 PCI_EPF_HEADER_R(interrupt_pin)
324 PCI_EPF_HEADER_W_u8(interrupt_pin)
326 CONFIGFS_ATTR(pci_epf_, vendorid);
327 CONFIGFS_ATTR(pci_epf_, deviceid);
328 CONFIGFS_ATTR(pci_epf_, revid);
329 CONFIGFS_ATTR(pci_epf_, progif_code);
330 CONFIGFS_ATTR(pci_epf_, subclass_code);
331 CONFIGFS_ATTR(pci_epf_, baseclass_code);
332 CONFIGFS_ATTR(pci_epf_, cache_line_size);
333 CONFIGFS_ATTR(pci_epf_, subsys_vendor_id);
334 CONFIGFS_ATTR(pci_epf_, subsys_id);
335 CONFIGFS_ATTR(pci_epf_, interrupt_pin);
336 CONFIGFS_ATTR(pci_epf_, msi_interrupts);
338 static struct configfs_attribute *pci_epf_attrs[] = {
339 &pci_epf_attr_vendorid,
340 &pci_epf_attr_deviceid,
342 &pci_epf_attr_progif_code,
343 &pci_epf_attr_subclass_code,
344 &pci_epf_attr_baseclass_code,
345 &pci_epf_attr_cache_line_size,
346 &pci_epf_attr_subsys_vendor_id,
347 &pci_epf_attr_subsys_id,
348 &pci_epf_attr_interrupt_pin,
349 &pci_epf_attr_msi_interrupts,
353 static void pci_epf_release(struct config_item *item)
355 struct pci_epf_group *epf_group = to_pci_epf_group(item);
357 pci_epf_destroy(epf_group->epf);
361 static struct configfs_item_operations pci_epf_ops = {
362 .release = pci_epf_release,
365 static struct config_item_type pci_epf_type = {
366 .ct_item_ops = &pci_epf_ops,
367 .ct_attrs = pci_epf_attrs,
368 .ct_owner = THIS_MODULE,
371 static struct config_group *pci_epf_make(struct config_group *group,
374 struct pci_epf_group *epf_group;
377 epf_group = kzalloc(sizeof(*epf_group), GFP_KERNEL);
379 return ERR_PTR(-ENOMEM);
381 config_group_init_type_name(&epf_group->group, name, &pci_epf_type);
383 epf = pci_epf_create(group->cg_item.ci_name);
385 pr_err("failed to create endpoint function device\n");
386 return ERR_PTR(-EINVAL);
389 epf_group->epf = epf;
391 return &epf_group->group;
394 static void pci_epf_drop(struct config_group *group, struct config_item *item)
396 config_item_put(item);
399 static struct configfs_group_operations pci_epf_group_ops = {
400 .make_group = &pci_epf_make,
401 .drop_item = &pci_epf_drop,
404 static struct config_item_type pci_epf_group_type = {
405 .ct_group_ops = &pci_epf_group_ops,
406 .ct_owner = THIS_MODULE,
409 struct config_group *pci_ep_cfs_add_epf_group(const char *name)
411 struct config_group *group;
413 group = configfs_register_default_group(functions_group, name,
414 &pci_epf_group_type);
416 pr_err("failed to register configfs group for %s function\n",
421 EXPORT_SYMBOL(pci_ep_cfs_add_epf_group);
423 void pci_ep_cfs_remove_epf_group(struct config_group *group)
425 if (IS_ERR_OR_NULL(group))
428 configfs_unregister_default_group(group);
430 EXPORT_SYMBOL(pci_ep_cfs_remove_epf_group);
432 static struct config_item_type pci_functions_type = {
433 .ct_owner = THIS_MODULE,
436 static struct config_item_type pci_controllers_type = {
437 .ct_owner = THIS_MODULE,
440 static struct config_item_type pci_ep_type = {
441 .ct_owner = THIS_MODULE,
444 static struct configfs_subsystem pci_ep_cfs_subsys = {
447 .ci_namebuf = "pci_ep",
448 .ci_type = &pci_ep_type,
451 .su_mutex = __MUTEX_INITIALIZER(pci_ep_cfs_subsys.su_mutex),
454 static int __init pci_ep_cfs_init(void)
457 struct config_group *root = &pci_ep_cfs_subsys.su_group;
459 config_group_init(root);
461 ret = configfs_register_subsystem(&pci_ep_cfs_subsys);
463 pr_err("Error %d while registering subsystem %s\n",
464 ret, root->cg_item.ci_namebuf);
468 functions_group = configfs_register_default_group(root, "functions",
469 &pci_functions_type);
470 if (IS_ERR(functions_group)) {
471 ret = PTR_ERR(functions_group);
472 pr_err("Error %d while registering functions group\n",
474 goto err_functions_group;
478 configfs_register_default_group(root, "controllers",
479 &pci_controllers_type);
480 if (IS_ERR(controllers_group)) {
481 ret = PTR_ERR(controllers_group);
482 pr_err("Error %d while registering controllers group\n",
484 goto err_controllers_group;
489 err_controllers_group:
490 configfs_unregister_default_group(functions_group);
493 configfs_unregister_subsystem(&pci_ep_cfs_subsys);
498 module_init(pci_ep_cfs_init);
500 static void __exit pci_ep_cfs_exit(void)
502 configfs_unregister_default_group(controllers_group);
503 configfs_unregister_default_group(functions_group);
504 configfs_unregister_subsystem(&pci_ep_cfs_subsys);
506 module_exit(pci_ep_cfs_exit);
508 MODULE_DESCRIPTION("PCI EP CONFIGFS");
509 MODULE_AUTHOR("Kishon Vijay Abraham I <kishon@ti.com>");
510 MODULE_LICENSE("GPL v2");