Skip to content

Commit e781858

Browse files
sudeep-hollasudeep-holla
committed
firmware: arm_ffa: Add initial FFA bus support for device enumeration
The Arm FF for Armv8-A specification has concept of endpoints or partitions. In the Normal world, a partition could be a VM when the Virtualization extension is enabled or the kernel itself. In order to handle multiple partitions, we can create a FFA device for each such partition on a dedicated FFA bus. Similarly, different drivers requiring FFA transport can be registered on the same bus. We can match the device and drivers using UUID. This is mostly for the in-kernel users with FFA drivers. Link: https://lore.kernel.org/r/20210521151033.181846-2-sudeep.holla@arm.com Tested-by: Jens Wiklander <jens.wiklander@linaro.org> Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
1 parent 3fdc0cb commit e781858

File tree

7 files changed

+327
-0
lines changed

7 files changed

+327
-0
lines changed

‎MAINTAINERS‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7069,6 +7069,13 @@ F: include/linux/firewire.h
70697069
F: include/uapi/linux/firewire*.h
70707070
F: tools/firewire/
70717071

7072+
FIRMWARE FRAMEWORK FOR ARMV8-A
7073+
M: Sudeep Holla <sudeep.holla@arm.com>
7074+
L: linux-arm-kernel@lists.infradead.org
7075+
S: Maintained
7076+
F: drivers/firmware/arm_ffa/
7077+
F: include/linux/arm_ffa.h
7078+
70727079
FIRMWARE LOADER (request_firmware)
70737080
M: Luis Chamberlain <mcgrof@kernel.org>
70747081
L: linux-kernel@vger.kernel.org

‎drivers/firmware/Kconfig‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,7 @@ config TURRIS_MOX_RWTM
296296
other manufacturing data and also utilize the Entropy Bit Generator
297297
for hardware random number generation.
298298

299+
source "drivers/firmware/arm_ffa/Kconfig"
299300
source "drivers/firmware/broadcom/Kconfig"
300301
source "drivers/firmware/google/Kconfig"
301302
source "drivers/firmware/efi/Kconfig"

‎drivers/firmware/Makefile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ obj-$(CONFIG_TI_SCI_PROTOCOL) += ti_sci.o
2222
obj-$(CONFIG_TRUSTED_FOUNDATIONS) += trusted_foundations.o
2323
obj-$(CONFIG_TURRIS_MOX_RWTM) += turris-mox-rwtm.o
2424

25+
obj-y += arm_ffa/
2526
obj-y += arm_scmi/
2627
obj-y += broadcom/
2728
obj-y += meson/

‎drivers/firmware/arm_ffa/Kconfig‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# SPDX-License-Identifier: GPL-2.0-only
2+
config ARM_FFA_TRANSPORT
3+
tristate "Arm Firmware Framework for Armv8-A"
4+
depends on OF
5+
depends on ARM64
6+
default n
7+
help
8+
This Firmware Framework(FF) for Arm A-profile processors describes
9+
interfaces that standardize communication between the various
10+
software images which includes communication between images in
11+
the Secure world and Normal world. It also leverages the
12+
virtualization extension to isolate software images provided
13+
by an ecosystem of vendors from each other.
14+
15+
This driver provides interface for all the client drivers making
16+
use of the features offered by ARM FF-A.

‎drivers/firmware/arm_ffa/Makefile‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# SPDX-License-Identifier: GPL-2.0-only
2+
ffa-bus-y = bus.o
3+
ffa-module-objs := $(ffa-bus-y)
4+
obj-$(CONFIG_ARM_FFA_TRANSPORT) = ffa-module.o

‎drivers/firmware/arm_ffa/bus.c‎

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
// SPDX-License-Identifier: GPL-2.0
2+
/*
3+
* Copyright (C) 2021 ARM Ltd.
4+
*/
5+
6+
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
7+
8+
#include <linux/arm_ffa.h>
9+
#include <linux/device.h>
10+
#include <linux/fs.h>
11+
#include <linux/kernel.h>
12+
#include <linux/module.h>
13+
#include <linux/slab.h>
14+
#include <linux/types.h>
15+
16+
static int ffa_device_match(struct device *dev, struct device_driver *drv)
17+
{
18+
const struct ffa_device_id *id_table;
19+
struct ffa_device *ffa_dev;
20+
21+
id_table = to_ffa_driver(drv)->id_table;
22+
ffa_dev = to_ffa_dev(dev);
23+
24+
while (!uuid_is_null(&id_table->uuid)) {
25+
if (uuid_equal(&ffa_dev->uuid, &id_table->uuid))
26+
return 1;
27+
id_table++;
28+
}
29+
30+
return 0;
31+
}
32+
33+
static int ffa_device_probe(struct device *dev)
34+
{
35+
struct ffa_driver *ffa_drv = to_ffa_driver(dev->driver);
36+
struct ffa_device *ffa_dev = to_ffa_dev(dev);
37+
38+
if (!ffa_device_match(dev, dev->driver))
39+
return -ENODEV;
40+
41+
return ffa_drv->probe(ffa_dev);
42+
}
43+
44+
static int ffa_device_uevent(struct device *dev, struct kobj_uevent_env *env)
45+
{
46+
struct ffa_device *ffa_dev = to_ffa_dev(dev);
47+
48+
return add_uevent_var(env, "MODALIAS=arm_ffa:%04x:%pUb",
49+
ffa_dev->vm_id, &ffa_dev->uuid);
50+
}
51+
52+
static ssize_t partition_id_show(struct device *dev,
53+
struct device_attribute *attr, char *buf)
54+
{
55+
struct ffa_device *ffa_dev = to_ffa_dev(dev);
56+
57+
return sprintf(buf, "0x%04x\n", ffa_dev->vm_id);
58+
}
59+
static DEVICE_ATTR_RO(partition_id);
60+
61+
static ssize_t uuid_show(struct device *dev, struct device_attribute *attr,
62+
char *buf)
63+
{
64+
struct ffa_device *ffa_dev = to_ffa_dev(dev);
65+
66+
return sprintf(buf, "%pUb\n", &ffa_dev->uuid);
67+
}
68+
static DEVICE_ATTR_RO(uuid);
69+
70+
static struct attribute *ffa_device_attributes_attrs[] = {
71+
&dev_attr_partition_id.attr,
72+
&dev_attr_uuid.attr,
73+
NULL,
74+
};
75+
ATTRIBUTE_GROUPS(ffa_device_attributes);
76+
77+
struct bus_type ffa_bus_type = {
78+
.name = "arm_ffa",
79+
.match = ffa_device_match,
80+
.probe = ffa_device_probe,
81+
.uevent = ffa_device_uevent,
82+
.dev_groups = ffa_device_attributes_groups,
83+
};
84+
EXPORT_SYMBOL_GPL(ffa_bus_type);
85+
86+
int ffa_driver_register(struct ffa_driver *driver, struct module *owner,
87+
const char *mod_name)
88+
{
89+
int ret;
90+
91+
driver->driver.bus = &ffa_bus_type;
92+
driver->driver.name = driver->name;
93+
driver->driver.owner = owner;
94+
driver->driver.mod_name = mod_name;
95+
96+
ret = driver_register(&driver->driver);
97+
if (!ret)
98+
pr_debug("registered new ffa driver %s\n", driver->name);
99+
100+
return ret;
101+
}
102+
EXPORT_SYMBOL_GPL(ffa_driver_register);
103+
104+
void ffa_driver_unregister(struct ffa_driver *driver)
105+
{
106+
driver_unregister(&driver->driver);
107+
}
108+
EXPORT_SYMBOL_GPL(ffa_driver_unregister);
109+
110+
static void ffa_release_device(struct device *dev)
111+
{
112+
struct ffa_device *ffa_dev = to_ffa_dev(dev);
113+
114+
kfree(ffa_dev);
115+
}
116+
117+
static int __ffa_devices_unregister(struct device *dev, void *data)
118+
{
119+
ffa_release_device(dev);
120+
121+
return 0;
122+
}
123+
124+
static void ffa_devices_unregister(void)
125+
{
126+
bus_for_each_dev(&ffa_bus_type, NULL, NULL,
127+
__ffa_devices_unregister);
128+
}
129+
130+
bool ffa_device_is_valid(struct ffa_device *ffa_dev)
131+
{
132+
bool valid = false;
133+
struct device *dev = NULL;
134+
struct ffa_device *tmp_dev;
135+
136+
do {
137+
dev = bus_find_next_device(&ffa_bus_type, dev);
138+
tmp_dev = to_ffa_dev(dev);
139+
if (tmp_dev == ffa_dev) {
140+
valid = true;
141+
break;
142+
}
143+
put_device(dev);
144+
} while (dev);
145+
146+
put_device(dev);
147+
148+
return valid;
149+
}
150+
151+
struct ffa_device *ffa_device_register(const uuid_t *uuid, int vm_id)
152+
{
153+
int ret;
154+
struct device *dev;
155+
struct ffa_device *ffa_dev;
156+
157+
ffa_dev = kzalloc(sizeof(*ffa_dev), GFP_KERNEL);
158+
if (!ffa_dev)
159+
return NULL;
160+
161+
dev = &ffa_dev->dev;
162+
dev->bus = &ffa_bus_type;
163+
dev->release = ffa_release_device;
164+
dev_set_name(&ffa_dev->dev, "arm-ffa-%04x", vm_id);
165+
166+
ffa_dev->vm_id = vm_id;
167+
uuid_copy(&ffa_dev->uuid, uuid);
168+
169+
ret = device_register(&ffa_dev->dev);
170+
if (ret) {
171+
dev_err(dev, "unable to register device %s err=%d\n",
172+
dev_name(dev), ret);
173+
put_device(dev);
174+
return NULL;
175+
}
176+
177+
return ffa_dev;
178+
}
179+
EXPORT_SYMBOL_GPL(ffa_device_register);
180+
181+
void ffa_device_unregister(struct ffa_device *ffa_dev)
182+
{
183+
if (!ffa_dev)
184+
return;
185+
186+
device_unregister(&ffa_dev->dev);
187+
}
188+
EXPORT_SYMBOL_GPL(ffa_device_unregister);
189+
190+
static int __init arm_ffa_bus_init(void)
191+
{
192+
return bus_register(&ffa_bus_type);
193+
}
194+
module_init(arm_ffa_bus_init);
195+
196+
static void __exit arm_ffa_bus_exit(void)
197+
{
198+
ffa_devices_unregister();
199+
bus_unregister(&ffa_bus_type);
200+
}
201+
202+
module_exit(arm_ffa_bus_exit);
203+
204+
MODULE_ALIAS("arm-ffa-bus");
205+
MODULE_AUTHOR("Sudeep Holla <sudeep.holla@arm.com>");
206+
MODULE_DESCRIPTION("Arm FF-A bus driver");
207+
MODULE_LICENSE("GPL v2");

‎include/linux/arm_ffa.h‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
/* SPDX-License-Identifier: GPL-2.0-only */
2+
/*
3+
* Copyright (C) 2021 ARM Ltd.
4+
*/
5+
6+
#ifndef _LINUX_ARM_FFA_H
7+
#define _LINUX_ARM_FFA_H
8+
9+
#include <linux/cdev.h>
10+
#include <linux/device.h>
11+
#include <linux/module.h>
12+
#include <linux/types.h>
13+
#include <linux/uuid.h>
14+
15+
/* FFA Bus/Device/Driver related */
16+
struct ffa_device {
17+
int vm_id;
18+
uuid_t uuid;
19+
struct device dev;
20+
};
21+
22+
#define to_ffa_dev(d) container_of(d, struct ffa_device, dev)
23+
24+
struct ffa_device_id {
25+
uuid_t uuid;
26+
};
27+
28+
struct ffa_driver {
29+
const char *name;
30+
int (*probe)(struct ffa_device *sdev);
31+
void (*remove)(struct ffa_device *sdev);
32+
const struct ffa_device_id *id_table;
33+
34+
struct device_driver driver;
35+
};
36+
37+
#define to_ffa_driver(d) container_of(d, struct ffa_driver, driver)
38+
39+
static inline void ffa_dev_set_drvdata(struct ffa_device *fdev, void *data)
40+
{
41+
fdev->dev.driver_data = data;
42+
}
43+
44+
#if IS_REACHABLE(CONFIG_ARM_FFA_TRANSPORT)
45+
struct ffa_device *ffa_device_register(const uuid_t *uuid, int vm_id);
46+
void ffa_device_unregister(struct ffa_device *ffa_dev);
47+
int ffa_driver_register(struct ffa_driver *driver, struct module *owner,
48+
const char *mod_name);
49+
void ffa_driver_unregister(struct ffa_driver *driver);
50+
bool ffa_device_is_valid(struct ffa_device *ffa_dev);
51+
52+
#else
53+
static inline
54+
struct ffa_device *ffa_device_register(const uuid_t *uuid, int vm_id)
55+
{
56+
return NULL;
57+
}
58+
59+
static inline void ffa_device_unregister(struct ffa_device *dev) {}
60+
61+
static inline int
62+
ffa_driver_register(struct ffa_driver *driver, struct module *owner,
63+
const char *mod_name)
64+
{
65+
return -EINVAL;
66+
}
67+
68+
static inline void ffa_driver_unregister(struct ffa_driver *driver) {}
69+
70+
static inline
71+
bool ffa_device_is_valid(struct ffa_device *ffa_dev) { return false; }
72+
73+
#endif /* CONFIG_ARM_FFA_TRANSPORT */
74+
75+
#define ffa_register(driver) \
76+
ffa_driver_register(driver, THIS_MODULE, KBUILD_MODNAME)
77+
#define ffa_unregister(driver) \
78+
ffa_driver_unregister(driver)
79+
80+
/**
81+
* module_ffa_driver() - Helper macro for registering a psa_ffa driver
82+
* @__ffa_driver: ffa_driver structure
83+
*
84+
* Helper macro for psa_ffa drivers to set up proper module init / exit
85+
* functions. Replaces module_init() and module_exit() and keeps people from
86+
* printing pointless things to the kernel log when their driver is loaded.
87+
*/
88+
#define module_ffa_driver(__ffa_driver) \
89+
module_driver(__ffa_driver, ffa_register, ffa_unregister)
90+
91+
#endif /* _LINUX_ARM_FFA_H */

0 commit comments

Comments
 (0)