Implementation of Virtual Bus
Subsystems (2)
PATCH v7 1/1 Implementation of Virtual Bus
From: Dave Ertman <[email protected]>
This is the initial implementation of the Virtual Bus, virtbus_device and virtbus_driver. The virtual bus is a software based bus intended to support registering virtbus_devices and virtbus_drivers and provide matching between them and probing of the registered drivers.
The bus will support probe/remove shutdown and
suspend/resume callbacks.
Kconfig and Makefile alterations are included
--- Documentation/driver-api/virtual_bus.rst | 62 ++++++ drivers/bus/Kconfig | 10 + drivers/bus/Makefile | 1 + drivers/bus/virtual_bus.c | 270 +++++++++++++++++++++++ include/linux/mod_devicetable.h | 8 + include/linux/virtual_bus.h | 53 +++++ scripts/mod/devicetable-offsets.c | 3 + scripts/mod/file2alias.c | 8 + 8 files changed, 415 insertions(+) create mode 100644 Documentation/driver-api/virtual_bus.rst create mode 100644 drivers/bus/virtual_bus.c create mode 100644 include/linux/virtual_bus.h
Documentation/driver-api/virtual_bus.rst new file +62 -0
@@ -0,0 +1,62 @@ +=============================== +Virtual Bus Devices and Drivers +=============================== + +See <linux/virtual_bus.h> for the models for virtbus_device and virtbus_driver. +This bus is meant to be a lightweight software based bus to attach generic +devices and drivers to so that a chunk of data can be passed between them. + +One use case example is an RDMA driver needing to connect with several +different types of PCI LAN devices to be able to request resources from +them (queue sets). Each LAN driver that supports RDMA will register a +virtbus_device on the virtual bus for each physical function. The RDMA +driver will register as a virtbus_driver on the virtual bus to be +matched up with multiple virtbus_devices and receive a pointer to a +struct containing the callbacks that the PCI LAN drivers support for +registering with them. + +Sections in this document: + Virtbus devices + Virtbus drivers + Device Enumeration + Device naming and driver binding + Virtual Bus API entry points + +Virtbus devices +~~~~~~~~~~~~~~~ +Virtbus_devices support the minimal device functionality. Devices will +accept a name, and then, when added to the virtual bus, an automatically +generated index is concatenated onto it for the virtbus_device->name. + +Virtbus drivers +~~~~~~~~~~~~~~~ +Virtbus drivers register with the virtual bus to be matched with virtbus +devices. They expect to be registered with a probe and remove callback, +and also support shutdown, suspend, and resume callbacks. They otherwise +follow the standard driver behavior of having discovery and enumeration +handled in the bus infrastructure. + +Virtbus drivers register themselves with the API entry point +virtbus_register_driver and unregister with virtbus_unregister_driver. + +Device Enumeration +~~~~~~~~~~~~~~~~~~ +Enumeration is handled automatically by the bus infrastructure via the +ida_simple methods. + +Device naming and driver binding +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The virtbus_device.dev.name is the canonical name for the device. It is +built from two other parts: + + - virtbus_device.name (also used for matching). + - virtbus_device.id (generated automatically from ida_simple calls) + +Virtbus device IDs are always in "<name>.<instance>" format. Instances are +automatically selected through an ida_simple_get so are positive integers. +Name is taken from the device name field. + +Driver IDs are simple <name>. + +Need to extract the name from the Virtual Device compare to name of the +driver.
drivers/bus/Kconfig +10 -0
@@ -202,4 +202,14 @@ config DA8XX_MSTPRI source "drivers/bus/fsl-mc/Kconfig" +config VIRTUAL_BUS + tristate "Software based Virtual Bus" + help + Provides a software bus for virtbus_devices to be added to it + and virtbus_drivers to be registered on it. It matches driver + and device based on id and calls the driver's pobe routine. + One example is the irdma driver needing to connect with various + PCI LAN drivers to request resources (queues) to be able to perform + its function. + endmenu
drivers/bus/Makefile +1 -0
@@ -34,3 +34,4 @@ obj-$(CONFIG_UNIPHIER_SYSTEM_BUS) += uniphier-system-bus.o obj-$(CONFIG_VEXPRESS_CONFIG) += vexpress-config.o obj-$(CONFIG_DA8XX_MSTPRI) += da8xx-mstpri.o +obj-$(CONFIG_VIRTUAL_BUS) += virtual_bus.o
drivers/bus/virtual_bus.c new file +270 -0
270 lines not on this page · raw message
include/linux/mod_devicetable.h +8 -0
@@ -821,4 +821,12 @@ struct wmi_device_id { const void *context; }; +#define VIRTBUS_NAME_SIZE 20 +#define VIRTBUS_MODULE_PREFIX "virtbus:" + +struct virtbus_dev_id { +char name[VIRTBUS_NAME_SIZE ]; +kernel_ulong_t driver_data; +}; +#endif /* LINUX_MOD_DEVICETABLE_H */
include/linux/virtual_bus.h new file +53 -0
53 lines not on this page · raw message
scripts/mod/devicetable-offsets.c +3 -0
@@ -231,5 +231,8 @@ int main(void)DEVID (wmi_device_id);DEVID_FIELD (wmi_device_id, guid_string); +DEVID (virtbus_dev_id); +DEVID_FIELD (virtbus_dev_id, name); +return 0 ; }
scripts/mod/file2alias.c +8 -0
@@ -1335,6 +1335,13 @@ static int do_wmi_entry(const char *filename, void *symval, char *alias)return 1 ; } +static int do_virtbus_entry (const char *filename,void *symval,char *alias) +{ +DEF_FIELD_ADDR (symval, virtbus_dev_id, name); +sprintf (alias,VIRTBUS_MODULE_PREFIX "%s" , *name); +return 1 ; +} +/* Does namelen bytes of name exactly match the symbol? */ static bool sym_is (const char *name,unsigned namelen,const char *symbol) {
@@ -1407,6 +1414,7 @@ static const struct devtable devtable[] = { {"typec", SIZE_typec_device_id, do_typec_entry}, {"tee", SIZE_tee_client_device_id, do_tee_entry}, {"wmi", SIZE_wmi_device_id, do_wmi_entry}, + {"virtbus", SIZE_virtbus_dev_id, do_virtbus_entry}, };/* Create MODULE_ALIAS() statements.
Signature · 1 line
2.24.1
Bowers
PATCH v7 1/1 Implementation of Virtual Bus
Quoted 33 lines
-----Original Message-----
From: Intel-wired-lan [mailto:intel-wired-lan-bounces at osuosl.org] On Behalf Of Jeff Kirsher
Sent: Monday, March 2, 2020 1:30 PM
To: intel-wired-lan at lists.osuosl.org
Subject: [Intel-wired-lan] [next-queue v7] Implementation of Virtual BusFrom: Dave Ertman <[email protected]>
This is the initial implementation of the Virtual Bus,
virtbus_deviceandvirtbus_driver. The virtual bus is a software based bus intended to support registeringvirtbus_devicesandvirtbus_driversand provide matching between them and probing of the registered drivers.The bus will support probe/remove shutdown and suspend/resume callbacks.
KconfigandMakefilealterations are includedSigned-off-by Dave Ertman <[email protected]>Signed-off-by Kiran Patil <[email protected]>--- Documentation/driver-api/virtual_bus.rst | 62 ++++++ drivers/bus/Kconfig | 10 + drivers/bus/Makefile | 1 + drivers/bus/virtual_bus.c | 270 +++++++++++++++++++++++ include/linux/mod_devicetable.h | 8 + include/linux/virtual_bus.h | 53 +++++ scripts/mod/devicetable-offsets.c | 3 + scripts/mod/file2alias.c | 8 + 8 files changed, 415 insertions(+) create mode 100644 Documentation/driver-api/virtual_bus.rst create mode 100644 drivers/bus/virtual_bus.c create mode 100644
Quoted 1 line
include/linux/virtual_bus.h