diff mbox series

[v7,1/5] staging: vc04_services: vchiq_arm: Add new bus type and device type

Message ID 20230620134152.383569-2-umang.jain@ideasonboard.com
State New
Headers
Series staging: vc04_services: vchiq: Register devices with a custom bus_type |

Commit Message

Umang Jain June 20, 2023, 1:41 p.m. UTC 
  The devices that the vchiq interface registers (bcm2835-audio,
bcm2835-camera) are implemented and exposed by the VC04 firmware.
The device tree describes the VC04 itself with the resources required
to communicate with it through a mailbox interface. However, the
vchiq interface registers these devices as platform devices. This
also means the specific drivers for these devices are getting
registered as platform drivers. This is not correct and a blatant
abuse of platform device/driver.

Add a new bus type, vchiq_bus_type and device type (struct vchiq_device)
which will be used to migrate child devices that the vchiq interfaces
creates/registers from the platform device/driver.

Signed-off-by: Umang Jain <umang.jain@ideasonboard.com>
---
 drivers/staging/vc04_services/Makefile        |  1 +
 .../interface/vchiq_arm/vchiq_device.c        | 78 +++++++++++++++++++
 .../interface/vchiq_arm/vchiq_device.h        | 43 ++++++++++
 3 files changed, 122 insertions(+)
 create mode 100644 drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c
 create mode 100644 drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.h

Comments

Greg KH June 20, 2023, 2:17 p.m. UTC | #1 
On Tue, Jun 20, 2023 at 07:11:48PM +0530, Umang Jain wrote:
> The devices that the vchiq interface registers (bcm2835-audio,
> bcm2835-camera) are implemented and exposed by the VC04 firmware.
> The device tree describes the VC04 itself with the resources required
> to communicate with it through a mailbox interface. However, the
> vchiq interface registers these devices as platform devices. This
> also means the specific drivers for these devices are getting
> registered as platform drivers. This is not correct and a blatant
> abuse of platform device/driver.
> 
> Add a new bus type, vchiq_bus_type and device type (struct vchiq_device)
> which will be used to migrate child devices that the vchiq interfaces
> creates/registers from the platform device/driver.
> 
> Signed-off-by: Umang Jain <umang.jain@ideasonboard.com>
> ---
>  drivers/staging/vc04_services/Makefile        |  1 +
>  .../interface/vchiq_arm/vchiq_device.c        | 78 +++++++++++++++++++
>  .../interface/vchiq_arm/vchiq_device.h        | 43 ++++++++++
>  3 files changed, 122 insertions(+)
>  create mode 100644 drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c
>  create mode 100644 drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.h
> 
> diff --git a/drivers/staging/vc04_services/Makefile b/drivers/staging/vc04_services/Makefile
> index 44794bdf6173..2d071e55e175 100644
> --- a/drivers/staging/vc04_services/Makefile
> +++ b/drivers/staging/vc04_services/Makefile
> @@ -5,6 +5,7 @@ vchiq-objs := \
>     interface/vchiq_arm/vchiq_core.o  \
>     interface/vchiq_arm/vchiq_arm.o \
>     interface/vchiq_arm/vchiq_debugfs.o \
> +   interface/vchiq_arm/vchiq_device.o \
>     interface/vchiq_arm/vchiq_connected.o \
>  
>  ifdef CONFIG_VCHIQ_CDEV
> diff --git a/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c b/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c
> new file mode 100644
> index 000000000000..e16279a25126
> --- /dev/null
> +++ b/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c
> @@ -0,0 +1,78 @@
> +// SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause

Code that directly interacts with the driver core can, for obvious
reasons, not be BSD-3 licensed, sorry.

Also, why is any of this dual licensed?  What good is any of that?  In
order for me to accept new dual-licensed code, it needs to be documented
in the changelog very very well as to exactly why this is required, as
the legal issues involved in maintaining dual-licensed code like this is
tricky and easy to get wrong (as proven here already in this patch...)

thanks,

greg k-h
Laurent Pinchart June 20, 2023, 6:20 p.m. UTC | #2 
On Tue, Jun 20, 2023 at 04:17:05PM +0200, Greg KH wrote:
> On Tue, Jun 20, 2023 at 07:11:48PM +0530, Umang Jain wrote:
> > The devices that the vchiq interface registers (bcm2835-audio,
> > bcm2835-camera) are implemented and exposed by the VC04 firmware.
> > The device tree describes the VC04 itself with the resources required
> > to communicate with it through a mailbox interface. However, the
> > vchiq interface registers these devices as platform devices. This
> > also means the specific drivers for these devices are getting
> > registered as platform drivers. This is not correct and a blatant
> > abuse of platform device/driver.
> > 
> > Add a new bus type, vchiq_bus_type and device type (struct vchiq_device)
> > which will be used to migrate child devices that the vchiq interfaces
> > creates/registers from the platform device/driver.
> > 
> > Signed-off-by: Umang Jain <umang.jain@ideasonboard.com>
> > ---
> >  drivers/staging/vc04_services/Makefile        |  1 +
> >  .../interface/vchiq_arm/vchiq_device.c        | 78 +++++++++++++++++++
> >  .../interface/vchiq_arm/vchiq_device.h        | 43 ++++++++++
> >  3 files changed, 122 insertions(+)
> >  create mode 100644 drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c
> >  create mode 100644 drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.h
> > 
> > diff --git a/drivers/staging/vc04_services/Makefile b/drivers/staging/vc04_services/Makefile
> > index 44794bdf6173..2d071e55e175 100644
> > --- a/drivers/staging/vc04_services/Makefile
> > +++ b/drivers/staging/vc04_services/Makefile
> > @@ -5,6 +5,7 @@ vchiq-objs := \
> >     interface/vchiq_arm/vchiq_core.o  \
> >     interface/vchiq_arm/vchiq_arm.o \
> >     interface/vchiq_arm/vchiq_debugfs.o \
> > +   interface/vchiq_arm/vchiq_device.o \
> >     interface/vchiq_arm/vchiq_connected.o \
> >  
> >  ifdef CONFIG_VCHIQ_CDEV
> > diff --git a/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c b/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c
> > new file mode 100644
> > index 000000000000..e16279a25126
> > --- /dev/null
> > +++ b/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c
> > @@ -0,0 +1,78 @@
> > +// SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
> 
> Code that directly interacts with the driver core can, for obvious
> reasons, not be BSD-3 licensed, sorry.
> 
> Also, why is any of this dual licensed?  What good is any of that?  In
> order for me to accept new dual-licensed code, it needs to be documented
> in the changelog very very well as to exactly why this is required, as
> the legal issues involved in maintaining dual-licensed code like this is
> tricky and easy to get wrong (as proven here already in this patch...)

The whole vchiq_arm layer is dual licensed GPL-2.0 + BSD-3. I assume
this is why Umang used the same licensing terms. We can use GPL-2.0 only
if this patch qualifies as original work and not derived work of the
existing code.

This being said, I have no objection changing the license of the whole
vchiq_arm layer to GPL-2.0 only. Dave, any opinion on this ?
Greg KH June 20, 2023, 6:36 p.m. UTC | #3 
On Tue, Jun 20, 2023 at 09:20:54PM +0300, Laurent Pinchart wrote:
> On Tue, Jun 20, 2023 at 04:17:05PM +0200, Greg KH wrote:
> > On Tue, Jun 20, 2023 at 07:11:48PM +0530, Umang Jain wrote:
> > > The devices that the vchiq interface registers (bcm2835-audio,
> > > bcm2835-camera) are implemented and exposed by the VC04 firmware.
> > > The device tree describes the VC04 itself with the resources required
> > > to communicate with it through a mailbox interface. However, the
> > > vchiq interface registers these devices as platform devices. This
> > > also means the specific drivers for these devices are getting
> > > registered as platform drivers. This is not correct and a blatant
> > > abuse of platform device/driver.
> > > 
> > > Add a new bus type, vchiq_bus_type and device type (struct vchiq_device)
> > > which will be used to migrate child devices that the vchiq interfaces
> > > creates/registers from the platform device/driver.
> > > 
> > > Signed-off-by: Umang Jain <umang.jain@ideasonboard.com>
> > > ---
> > >  drivers/staging/vc04_services/Makefile        |  1 +
> > >  .../interface/vchiq_arm/vchiq_device.c        | 78 +++++++++++++++++++
> > >  .../interface/vchiq_arm/vchiq_device.h        | 43 ++++++++++
> > >  3 files changed, 122 insertions(+)
> > >  create mode 100644 drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c
> > >  create mode 100644 drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.h
> > > 
> > > diff --git a/drivers/staging/vc04_services/Makefile b/drivers/staging/vc04_services/Makefile
> > > index 44794bdf6173..2d071e55e175 100644
> > > --- a/drivers/staging/vc04_services/Makefile
> > > +++ b/drivers/staging/vc04_services/Makefile
> > > @@ -5,6 +5,7 @@ vchiq-objs := \
> > >     interface/vchiq_arm/vchiq_core.o  \
> > >     interface/vchiq_arm/vchiq_arm.o \
> > >     interface/vchiq_arm/vchiq_debugfs.o \
> > > +   interface/vchiq_arm/vchiq_device.o \
> > >     interface/vchiq_arm/vchiq_connected.o \
> > >  
> > >  ifdef CONFIG_VCHIQ_CDEV
> > > diff --git a/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c b/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c
> > > new file mode 100644
> > > index 000000000000..e16279a25126
> > > --- /dev/null
> > > +++ b/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c
> > > @@ -0,0 +1,78 @@
> > > +// SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
> > 
> > Code that directly interacts with the driver core can, for obvious
> > reasons, not be BSD-3 licensed, sorry.
> > 
> > Also, why is any of this dual licensed?  What good is any of that?  In
> > order for me to accept new dual-licensed code, it needs to be documented
> > in the changelog very very well as to exactly why this is required, as
> > the legal issues involved in maintaining dual-licensed code like this is
> > tricky and easy to get wrong (as proven here already in this patch...)
> 
> The whole vchiq_arm layer is dual licensed GPL-2.0 + BSD-3. I assume
> this is why Umang used the same licensing terms. We can use GPL-2.0 only
> if this patch qualifies as original work and not derived work of the
> existing code.

This is most certainly original work, not related to the original code
here, and can never work in a BSD-3 licensed environment.

thanks,

greg k-h
diff mbox series

Patch

diff --git a/drivers/staging/vc04_services/Makefile b/drivers/staging/vc04_services/Makefile
index 44794bdf6173..2d071e55e175 100644
--- a/drivers/staging/vc04_services/Makefile
+++ b/drivers/staging/vc04_services/Makefile
@@ -5,6 +5,7 @@  vchiq-objs := \
    interface/vchiq_arm/vchiq_core.o  \
    interface/vchiq_arm/vchiq_arm.o \
    interface/vchiq_arm/vchiq_debugfs.o \
+   interface/vchiq_arm/vchiq_device.o \
    interface/vchiq_arm/vchiq_connected.o \
 
 ifdef CONFIG_VCHIQ_CDEV
diff --git a/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c b/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c
new file mode 100644
index 000000000000..e16279a25126
--- /dev/null
+++ b/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.c
@@ -0,0 +1,78 @@ 
+// SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
+/*
+ * vchiq_device.c - VCHIQ generic device and bus-type
+ *
+ * Copyright (c) 2023 Ideas On Board Oy
+ */
+
+#include <linux/device/bus.h>
+#include <linux/slab.h>
+#include <linux/string.h>
+
+#include "vchiq_device.h"
+
+static int vchiq_bus_type_match(struct device *dev, struct device_driver *drv);
+
+struct bus_type vchiq_bus_type = {
+	.name   = "vchiq-bus",
+	.match  = vchiq_bus_type_match,
+};
+
+static int vchiq_bus_type_match(struct device *dev, struct device_driver *drv)
+{
+	if (dev->bus == &vchiq_bus_type &&
+	    strcmp(dev_name(dev), drv->name) == 0)
+		return 1;
+	return 0;
+}
+
+static void vchiq_device_release(struct device *dev)
+{
+	struct vchiq_device *device;
+
+	device = container_of(dev, struct vchiq_device, dev);
+	kfree(device);
+}
+
+int vchiq_device_register(struct device *parent, const char *name)
+{
+	struct vchiq_device *device = NULL;
+	int ret;
+
+	device = kzalloc(sizeof(*device), GFP_KERNEL);
+	if (!device)
+		return -ENOMEM;
+
+	device->dev.init_name = name;
+	device->dev.parent = parent;
+	device->dev.bus = &vchiq_bus_type;
+	device->dev.release = vchiq_device_release;
+
+	ret = device_register(&device->dev);
+	if (ret) {
+		put_device(&device->dev);
+		return -EINVAL;
+	}
+
+	return 0;
+}
+
+int vchiq_device_unregister(struct device *dev, void *data)
+{
+	device_unregister(dev);
+	return 0;
+}
+
+int vchiq_driver_register(struct vchiq_driver *vchiq_drv)
+{
+	vchiq_drv->driver.bus = &vchiq_bus_type;
+
+	return driver_register(&vchiq_drv->driver);
+}
+EXPORT_SYMBOL_GPL(vchiq_driver_register);
+
+void vchiq_driver_unregister(struct vchiq_driver *vchiq_drv)
+{
+	driver_unregister(&vchiq_drv->driver);
+}
+EXPORT_SYMBOL_GPL(vchiq_driver_unregister);
diff --git a/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.h b/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.h
new file mode 100644
index 000000000000..55d242b230f9
--- /dev/null
+++ b/drivers/staging/vc04_services/interface/vchiq_arm/vchiq_device.h
@@ -0,0 +1,43 @@ 
+/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
+/*
+ * Copyright (c) 2023 Ideas On Board Oy
+ */
+
+#ifndef _VCHIQ_DEVICE_H
+#define _VCHIQ_DEVICE_H
+
+#include <linux/device.h>
+
+struct vchiq_device {
+	struct device dev;
+};
+
+struct vchiq_driver {
+        int                     (*probe)(struct vchiq_device *device);
+        void                    (*remove)(struct vchiq_device *device);
+        int                     (*resume)(struct vchiq_device *device);
+        int                     (*suspend)(struct vchiq_device *device,
+					   pm_message_t state);
+	struct device_driver driver;
+};
+
+extern struct bus_type vchiq_bus_type;
+
+int vchiq_device_register(struct device *parent, const char *name);
+int vchiq_device_unregister(struct device *dev, void *data);
+
+int vchiq_driver_register(struct vchiq_driver *vchiq_drv);
+void vchiq_driver_unregister(struct vchiq_driver *vchiq_drv);
+
+/**
+ * module_vchiq_driver() - Helper macro for registering a vchiq driver
+ * @__vchiq_driver: vchiq driver struct
+ *
+ * Helper macro for vchiq drivers which do not do anything special in
+ * module init/exit. This eliminates a lot of boilerplate. Each module may only
+ * use this macro once, and calling it replaces module_init() and module_exit()
+ */
+#define module_vchiq_driver(__vchiq_driver) \
+	module_driver(__vchiq_driver, vchiq_driver_register, vchiq_driver_unregister)
+
+#endif /* _VCHIQ_DEVICE_H */