1 // SPDX-License-Identifier: GPL-2.0
3 * fsl-mc object allocator driver
5 * Copyright (C) 2013-2016 Freescale Semiconductor, Inc.
9 #include <linux/module.h>
10 #include <linux/msi.h>
11 #include <linux/fsl/mc.h>
13 #include "fsl-mc-private.h"
15 static bool __must_check
fsl_mc_is_allocatable(struct fsl_mc_device
*mc_dev
)
17 return is_fsl_mc_bus_dpbp(mc_dev
) ||
18 is_fsl_mc_bus_dpmcp(mc_dev
) ||
19 is_fsl_mc_bus_dpcon(mc_dev
);
23 * fsl_mc_resource_pool_add_device - add allocatable object to a resource
24 * pool of a given fsl-mc bus
26 * @mc_bus: pointer to the fsl-mc bus
27 * @pool_type: pool type
28 * @mc_dev: pointer to allocatable fsl-mc device
30 static int __must_check
fsl_mc_resource_pool_add_device(struct fsl_mc_bus
37 struct fsl_mc_resource_pool
*res_pool
;
38 struct fsl_mc_resource
*resource
;
39 struct fsl_mc_device
*mc_bus_dev
= &mc_bus
->mc_dev
;
42 if (pool_type
< 0 || pool_type
>= FSL_MC_NUM_POOL_TYPES
)
44 if (!fsl_mc_is_allocatable(mc_dev
))
49 res_pool
= &mc_bus
->resource_pools
[pool_type
];
50 if (res_pool
->type
!= pool_type
)
52 if (res_pool
->mc_bus
!= mc_bus
)
55 mutex_lock(&res_pool
->mutex
);
57 if (res_pool
->max_count
< 0)
59 if (res_pool
->free_count
< 0 ||
60 res_pool
->free_count
> res_pool
->max_count
)
63 resource
= devm_kzalloc(&mc_bus_dev
->dev
, sizeof(*resource
),
67 dev_err(&mc_bus_dev
->dev
,
68 "Failed to allocate memory for fsl_mc_resource\n");
72 resource
->type
= pool_type
;
73 resource
->id
= mc_dev
->obj_desc
.id
;
74 resource
->data
= mc_dev
;
75 resource
->parent_pool
= res_pool
;
76 INIT_LIST_HEAD(&resource
->node
);
77 list_add_tail(&resource
->node
, &res_pool
->free_list
);
78 mc_dev
->resource
= resource
;
79 res_pool
->free_count
++;
80 res_pool
->max_count
++;
83 mutex_unlock(&res_pool
->mutex
);
89 * fsl_mc_resource_pool_remove_device - remove an allocatable device from a
92 * @mc_dev: pointer to allocatable fsl-mc device
94 * It permanently removes an allocatable fsl-mc device from the resource
95 * pool. It's an error if the device is in use.
97 static int __must_check
fsl_mc_resource_pool_remove_device(struct fsl_mc_device
100 struct fsl_mc_device
*mc_bus_dev
;
101 struct fsl_mc_bus
*mc_bus
;
102 struct fsl_mc_resource_pool
*res_pool
;
103 struct fsl_mc_resource
*resource
;
106 if (!fsl_mc_is_allocatable(mc_dev
))
109 resource
= mc_dev
->resource
;
110 if (!resource
|| resource
->data
!= mc_dev
)
113 mc_bus_dev
= to_fsl_mc_device(mc_dev
->dev
.parent
);
114 mc_bus
= to_fsl_mc_bus(mc_bus_dev
);
115 res_pool
= resource
->parent_pool
;
116 if (res_pool
!= &mc_bus
->resource_pools
[resource
->type
])
119 mutex_lock(&res_pool
->mutex
);
121 if (res_pool
->max_count
<= 0)
123 if (res_pool
->free_count
<= 0 ||
124 res_pool
->free_count
> res_pool
->max_count
)
128 * If the device is currently allocated, its resource is not
129 * in the free list and thus, the device cannot be removed.
131 if (list_empty(&resource
->node
)) {
133 dev_err(&mc_bus_dev
->dev
,
134 "Device %s cannot be removed from resource pool\n",
135 dev_name(&mc_dev
->dev
));
139 list_del_init(&resource
->node
);
140 res_pool
->free_count
--;
141 res_pool
->max_count
--;
143 devm_kfree(&mc_bus_dev
->dev
, resource
);
144 mc_dev
->resource
= NULL
;
147 mutex_unlock(&res_pool
->mutex
);
152 static const char *const fsl_mc_pool_type_strings
[] = {
153 [FSL_MC_POOL_DPMCP
] = "dpmcp",
154 [FSL_MC_POOL_DPBP
] = "dpbp",
155 [FSL_MC_POOL_DPCON
] = "dpcon",
156 [FSL_MC_POOL_IRQ
] = "irq",
159 static int __must_check
object_type_to_pool_type(const char *object_type
,
160 enum fsl_mc_pool_type
165 for (i
= 0; i
< ARRAY_SIZE(fsl_mc_pool_type_strings
); i
++) {
166 if (strcmp(object_type
, fsl_mc_pool_type_strings
[i
]) == 0) {
175 int __must_check
fsl_mc_resource_allocate(struct fsl_mc_bus
*mc_bus
,
176 enum fsl_mc_pool_type pool_type
,
177 struct fsl_mc_resource
**new_resource
)
179 struct fsl_mc_resource_pool
*res_pool
;
180 struct fsl_mc_resource
*resource
;
181 struct fsl_mc_device
*mc_bus_dev
= &mc_bus
->mc_dev
;
184 BUILD_BUG_ON(ARRAY_SIZE(fsl_mc_pool_type_strings
) !=
185 FSL_MC_NUM_POOL_TYPES
);
187 *new_resource
= NULL
;
188 if (pool_type
< 0 || pool_type
>= FSL_MC_NUM_POOL_TYPES
)
191 res_pool
= &mc_bus
->resource_pools
[pool_type
];
192 if (res_pool
->mc_bus
!= mc_bus
)
195 mutex_lock(&res_pool
->mutex
);
196 resource
= list_first_entry_or_null(&res_pool
->free_list
,
197 struct fsl_mc_resource
, node
);
201 dev_err(&mc_bus_dev
->dev
,
202 "No more resources of type %s left\n",
203 fsl_mc_pool_type_strings
[pool_type
]);
207 if (resource
->type
!= pool_type
)
209 if (resource
->parent_pool
!= res_pool
)
211 if (res_pool
->free_count
<= 0 ||
212 res_pool
->free_count
> res_pool
->max_count
)
215 list_del_init(&resource
->node
);
217 res_pool
->free_count
--;
220 mutex_unlock(&res_pool
->mutex
);
221 *new_resource
= resource
;
225 EXPORT_SYMBOL_GPL(fsl_mc_resource_allocate
);
227 void fsl_mc_resource_free(struct fsl_mc_resource
*resource
)
229 struct fsl_mc_resource_pool
*res_pool
;
231 res_pool
= resource
->parent_pool
;
232 if (resource
->type
!= res_pool
->type
)
235 mutex_lock(&res_pool
->mutex
);
236 if (res_pool
->free_count
< 0 ||
237 res_pool
->free_count
>= res_pool
->max_count
)
240 if (!list_empty(&resource
->node
))
243 list_add_tail(&resource
->node
, &res_pool
->free_list
);
244 res_pool
->free_count
++;
246 mutex_unlock(&res_pool
->mutex
);
248 EXPORT_SYMBOL_GPL(fsl_mc_resource_free
);
251 * fsl_mc_object_allocate - Allocates an fsl-mc object of the given
252 * pool type from a given fsl-mc bus instance
254 * @mc_dev: fsl-mc device which is used in conjunction with the
256 * @pool_type: pool type
257 * @new_mc_dev: pointer to area where the pointer to the allocated device
260 * Allocatable objects are always used in conjunction with some functional
261 * device. This function allocates an object of the specified type from
262 * the DPRC containing the functional device.
264 * NOTE: pool_type must be different from FSL_MC_POOL_MCP, since MC
265 * portals are allocated using fsl_mc_portal_allocate(), instead of
268 int __must_check
fsl_mc_object_allocate(struct fsl_mc_device
*mc_dev
,
269 enum fsl_mc_pool_type pool_type
,
270 struct fsl_mc_device
**new_mc_adev
)
272 struct fsl_mc_device
*mc_bus_dev
;
273 struct fsl_mc_bus
*mc_bus
;
274 struct fsl_mc_device
*mc_adev
;
276 struct fsl_mc_resource
*resource
= NULL
;
279 if (mc_dev
->flags
& FSL_MC_IS_DPRC
)
282 if (!dev_is_fsl_mc(mc_dev
->dev
.parent
))
285 if (pool_type
== FSL_MC_POOL_DPMCP
)
288 mc_bus_dev
= to_fsl_mc_device(mc_dev
->dev
.parent
);
289 mc_bus
= to_fsl_mc_bus(mc_bus_dev
);
290 error
= fsl_mc_resource_allocate(mc_bus
, pool_type
, &resource
);
294 mc_adev
= resource
->data
;
300 mc_adev
->consumer_link
= device_link_add(&mc_dev
->dev
,
302 DL_FLAG_AUTOREMOVE_CONSUMER
);
303 if (!mc_adev
->consumer_link
) {
308 *new_mc_adev
= mc_adev
;
312 fsl_mc_resource_free(resource
);
316 EXPORT_SYMBOL_GPL(fsl_mc_object_allocate
);
319 * fsl_mc_object_free - Returns an fsl-mc object to the resource
320 * pool where it came from.
321 * @mc_adev: Pointer to the fsl-mc device
323 void fsl_mc_object_free(struct fsl_mc_device
*mc_adev
)
325 struct fsl_mc_resource
*resource
;
327 resource
= mc_adev
->resource
;
328 if (resource
->type
== FSL_MC_POOL_DPMCP
)
330 if (resource
->data
!= mc_adev
)
333 fsl_mc_resource_free(resource
);
335 mc_adev
->consumer_link
= NULL
;
337 EXPORT_SYMBOL_GPL(fsl_mc_object_free
);
340 * A DPRC and the devices in the DPRC all share the same GIC-ITS device
341 * ID. A block of IRQs is pre-allocated and maintained in a pool
342 * from which devices can allocate them when needed.
346 * Initialize the interrupt pool associated with an fsl-mc bus.
347 * It allocates a block of IRQs from the GIC-ITS.
349 int fsl_mc_populate_irq_pool(struct fsl_mc_device
*mc_bus_dev
,
350 unsigned int irq_count
)
353 struct msi_desc
*msi_desc
;
354 struct fsl_mc_device_irq
*irq_resources
;
355 struct fsl_mc_device_irq
*mc_dev_irq
;
357 struct fsl_mc_bus
*mc_bus
= to_fsl_mc_bus(mc_bus_dev
);
358 struct fsl_mc_resource_pool
*res_pool
=
359 &mc_bus
->resource_pools
[FSL_MC_POOL_IRQ
];
361 /* do nothing if the IRQ pool is already populated */
362 if (mc_bus
->irq_resources
)
365 if (irq_count
== 0 ||
366 irq_count
> FSL_MC_IRQ_POOL_MAX_TOTAL_IRQS
)
369 error
= fsl_mc_msi_domain_alloc_irqs(&mc_bus_dev
->dev
, irq_count
);
373 irq_resources
= devm_kcalloc(&mc_bus_dev
->dev
,
374 irq_count
, sizeof(*irq_resources
),
376 if (!irq_resources
) {
378 goto cleanup_msi_irqs
;
381 for (i
= 0; i
< irq_count
; i
++) {
382 mc_dev_irq
= &irq_resources
[i
];
385 * NOTE: This mc_dev_irq's MSI addr/value pair will be set
386 * by the fsl_mc_msi_write_msg() callback
388 mc_dev_irq
->resource
.type
= res_pool
->type
;
389 mc_dev_irq
->resource
.data
= mc_dev_irq
;
390 mc_dev_irq
->resource
.parent_pool
= res_pool
;
391 INIT_LIST_HEAD(&mc_dev_irq
->resource
.node
);
392 list_add_tail(&mc_dev_irq
->resource
.node
, &res_pool
->free_list
);
395 for_each_msi_entry(msi_desc
, &mc_bus_dev
->dev
) {
396 mc_dev_irq
= &irq_resources
[msi_desc
->fsl_mc
.msi_index
];
397 mc_dev_irq
->msi_desc
= msi_desc
;
398 mc_dev_irq
->resource
.id
= msi_desc
->irq
;
401 res_pool
->max_count
= irq_count
;
402 res_pool
->free_count
= irq_count
;
403 mc_bus
->irq_resources
= irq_resources
;
407 fsl_mc_msi_domain_free_irqs(&mc_bus_dev
->dev
);
410 EXPORT_SYMBOL_GPL(fsl_mc_populate_irq_pool
);
413 * Teardown the interrupt pool associated with an fsl-mc bus.
414 * It frees the IRQs that were allocated to the pool, back to the GIC-ITS.
416 void fsl_mc_cleanup_irq_pool(struct fsl_mc_device
*mc_bus_dev
)
418 struct fsl_mc_bus
*mc_bus
= to_fsl_mc_bus(mc_bus_dev
);
419 struct fsl_mc_resource_pool
*res_pool
=
420 &mc_bus
->resource_pools
[FSL_MC_POOL_IRQ
];
422 if (!mc_bus
->irq_resources
)
425 if (res_pool
->max_count
== 0)
428 if (res_pool
->free_count
!= res_pool
->max_count
)
431 INIT_LIST_HEAD(&res_pool
->free_list
);
432 res_pool
->max_count
= 0;
433 res_pool
->free_count
= 0;
434 mc_bus
->irq_resources
= NULL
;
435 fsl_mc_msi_domain_free_irqs(&mc_bus_dev
->dev
);
437 EXPORT_SYMBOL_GPL(fsl_mc_cleanup_irq_pool
);
440 * Allocate the IRQs required by a given fsl-mc device.
442 int __must_check
fsl_mc_allocate_irqs(struct fsl_mc_device
*mc_dev
)
446 int res_allocated_count
= 0;
448 struct fsl_mc_device_irq
**irqs
= NULL
;
449 struct fsl_mc_bus
*mc_bus
;
450 struct fsl_mc_resource_pool
*res_pool
;
455 irq_count
= mc_dev
->obj_desc
.irq_count
;
459 if (is_fsl_mc_bus_dprc(mc_dev
))
460 mc_bus
= to_fsl_mc_bus(mc_dev
);
462 mc_bus
= to_fsl_mc_bus(to_fsl_mc_device(mc_dev
->dev
.parent
));
464 if (!mc_bus
->irq_resources
)
467 res_pool
= &mc_bus
->resource_pools
[FSL_MC_POOL_IRQ
];
468 if (res_pool
->free_count
< irq_count
) {
469 dev_err(&mc_dev
->dev
,
470 "Not able to allocate %u irqs for device\n", irq_count
);
474 irqs
= devm_kcalloc(&mc_dev
->dev
, irq_count
, sizeof(irqs
[0]),
479 for (i
= 0; i
< irq_count
; i
++) {
480 struct fsl_mc_resource
*resource
;
482 error
= fsl_mc_resource_allocate(mc_bus
, FSL_MC_POOL_IRQ
,
485 goto error_resource_alloc
;
487 irqs
[i
] = to_fsl_mc_irq(resource
);
488 res_allocated_count
++;
490 irqs
[i
]->mc_dev
= mc_dev
;
491 irqs
[i
]->dev_irq_index
= i
;
497 error_resource_alloc
:
498 for (i
= 0; i
< res_allocated_count
; i
++) {
499 irqs
[i
]->mc_dev
= NULL
;
500 fsl_mc_resource_free(&irqs
[i
]->resource
);
505 EXPORT_SYMBOL_GPL(fsl_mc_allocate_irqs
);
508 * Frees the IRQs that were allocated for an fsl-mc device.
510 void fsl_mc_free_irqs(struct fsl_mc_device
*mc_dev
)
514 struct fsl_mc_bus
*mc_bus
;
515 struct fsl_mc_device_irq
**irqs
= mc_dev
->irqs
;
520 irq_count
= mc_dev
->obj_desc
.irq_count
;
522 if (is_fsl_mc_bus_dprc(mc_dev
))
523 mc_bus
= to_fsl_mc_bus(mc_dev
);
525 mc_bus
= to_fsl_mc_bus(to_fsl_mc_device(mc_dev
->dev
.parent
));
527 if (!mc_bus
->irq_resources
)
530 for (i
= 0; i
< irq_count
; i
++) {
531 irqs
[i
]->mc_dev
= NULL
;
532 fsl_mc_resource_free(&irqs
[i
]->resource
);
537 EXPORT_SYMBOL_GPL(fsl_mc_free_irqs
);
539 void fsl_mc_init_all_resource_pools(struct fsl_mc_device
*mc_bus_dev
)
542 struct fsl_mc_bus
*mc_bus
= to_fsl_mc_bus(mc_bus_dev
);
544 for (pool_type
= 0; pool_type
< FSL_MC_NUM_POOL_TYPES
; pool_type
++) {
545 struct fsl_mc_resource_pool
*res_pool
=
546 &mc_bus
->resource_pools
[pool_type
];
548 res_pool
->type
= pool_type
;
549 res_pool
->max_count
= 0;
550 res_pool
->free_count
= 0;
551 res_pool
->mc_bus
= mc_bus
;
552 INIT_LIST_HEAD(&res_pool
->free_list
);
553 mutex_init(&res_pool
->mutex
);
557 static void fsl_mc_cleanup_resource_pool(struct fsl_mc_device
*mc_bus_dev
,
558 enum fsl_mc_pool_type pool_type
)
560 struct fsl_mc_resource
*resource
;
561 struct fsl_mc_resource
*next
;
562 struct fsl_mc_bus
*mc_bus
= to_fsl_mc_bus(mc_bus_dev
);
563 struct fsl_mc_resource_pool
*res_pool
=
564 &mc_bus
->resource_pools
[pool_type
];
567 list_for_each_entry_safe(resource
, next
, &res_pool
->free_list
, node
) {
569 devm_kfree(&mc_bus_dev
->dev
, resource
);
573 void fsl_mc_cleanup_all_resource_pools(struct fsl_mc_device
*mc_bus_dev
)
577 for (pool_type
= 0; pool_type
< FSL_MC_NUM_POOL_TYPES
; pool_type
++)
578 fsl_mc_cleanup_resource_pool(mc_bus_dev
, pool_type
);
582 * fsl_mc_allocator_probe - callback invoked when an allocatable device is
583 * being added to the system
585 static int fsl_mc_allocator_probe(struct fsl_mc_device
*mc_dev
)
587 enum fsl_mc_pool_type pool_type
;
588 struct fsl_mc_device
*mc_bus_dev
;
589 struct fsl_mc_bus
*mc_bus
;
592 if (!fsl_mc_is_allocatable(mc_dev
))
595 mc_bus_dev
= to_fsl_mc_device(mc_dev
->dev
.parent
);
596 if (!dev_is_fsl_mc(&mc_bus_dev
->dev
))
599 mc_bus
= to_fsl_mc_bus(mc_bus_dev
);
600 error
= object_type_to_pool_type(mc_dev
->obj_desc
.type
, &pool_type
);
604 error
= fsl_mc_resource_pool_add_device(mc_bus
, pool_type
, mc_dev
);
608 dev_dbg(&mc_dev
->dev
,
609 "Allocatable fsl-mc device bound to fsl_mc_allocator driver");
614 * fsl_mc_allocator_remove - callback invoked when an allocatable device is
615 * being removed from the system
617 static int fsl_mc_allocator_remove(struct fsl_mc_device
*mc_dev
)
621 if (!fsl_mc_is_allocatable(mc_dev
))
624 if (mc_dev
->resource
) {
625 error
= fsl_mc_resource_pool_remove_device(mc_dev
);
630 dev_dbg(&mc_dev
->dev
,
631 "Allocatable fsl-mc device unbound from fsl_mc_allocator driver");
635 static const struct fsl_mc_device_id match_id_table
[] = {
637 .vendor
= FSL_MC_VENDOR_FREESCALE
,
641 .vendor
= FSL_MC_VENDOR_FREESCALE
,
645 .vendor
= FSL_MC_VENDOR_FREESCALE
,
651 static struct fsl_mc_driver fsl_mc_allocator_driver
= {
653 .name
= "fsl_mc_allocator",
656 .match_id_table
= match_id_table
,
657 .probe
= fsl_mc_allocator_probe
,
658 .remove
= fsl_mc_allocator_remove
,
661 int __init
fsl_mc_allocator_driver_init(void)
663 return fsl_mc_driver_register(&fsl_mc_allocator_driver
);
666 void fsl_mc_allocator_driver_exit(void)
668 fsl_mc_driver_unregister(&fsl_mc_allocator_driver
);