[PATCH 1/4] rpmsg: add THIS_MODULE to rpmsg_driver in rpmsg core

[PATCH 1/4] rpmsg: add THIS_MODULE to rpmsg_driver in rpmsg core

[Andrew F. Davis]

Add register_rpmsg_driver helper macro that adds THIS_MODULE to
rpmsg_driver for the registering driver. We rename and modify
the existing register_rpmsg_driver to enable this.

Signed-off-by: Andrew F. Davis <afd@ti.com>
---
 drivers/rpmsg/virtio_rpmsg_bus.c | 8 +++++---
 include/linux/rpmsg.h            | 8 +++++++-
 2 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/drivers/rpmsg/virtio_rpmsg_bus.c b/drivers/rpmsg/virtio_rpmsg_bus.c
index 1fcd27c..fe03b2a 100644
--- a/drivers/rpmsg/virtio_rpmsg_bus.c
+++ b/drivers/rpmsg/virtio_rpmsg_bus.c
@@ -436,17 +436,19 @@ static struct bus_type rpmsg_bus = {
 };
 
 /**
- * register_rpmsg_driver() - register an rpmsg driver with the rpmsg bus
+ * __register_rpmsg_driver() - register an rpmsg driver with the rpmsg bus
  * @rpdrv: pointer to a struct rpmsg_driver
+ * @owner: owning module/driver
  *
  * Returns 0 on success, and an appropriate error value on failure.
  */
-int register_rpmsg_driver(struct rpmsg_driver *rpdrv)
+int __register_rpmsg_driver(struct rpmsg_driver *rpdrv, struct module *owner)
 {
 	rpdrv->drv.bus = &rpmsg_bus;
+	rpdrv->drv.owner = owner;
 	return driver_register(&rpdrv->drv);
 }
-EXPORT_SYMBOL(register_rpmsg_driver);
+EXPORT_SYMBOL(__register_rpmsg_driver);
 
 /**
  * unregister_rpmsg_driver() - unregister an rpmsg driver from the rpmsg bus
diff --git a/include/linux/rpmsg.h b/include/linux/rpmsg.h
index 82a6739..78e45ce 100644
--- a/include/linux/rpmsg.h
+++ b/include/linux/rpmsg.h
@@ -169,7 +169,7 @@ struct rpmsg_driver {
 
 int register_rpmsg_device(struct rpmsg_channel *dev);
 void unregister_rpmsg_device(struct rpmsg_channel *dev);
-int register_rpmsg_driver(struct rpmsg_driver *drv);
+int __register_rpmsg_driver(struct rpmsg_driver *drv, struct module *owner);
 void unregister_rpmsg_driver(struct rpmsg_driver *drv);
 void rpmsg_destroy_ept(struct rpmsg_endpoint *);
 struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_channel *,
@@ -177,6 +177,12 @@ struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_channel *,
 int
 rpmsg_send_offchannel_raw(struct rpmsg_channel *, u32, u32, void *, int, bool);
 
+/*
+ * use a macro to avoid include chaining to get THIS_MODULE
+ */
+#define register_rpmsg_driver(drv) \
+	__register_rpmsg_driver(drv, THIS_MODULE)
+
 /**
  * rpmsg_send() - send a message across to the remote processor
  * @rpdev: the rpmsg channel
-- 
2.8.2

[PATCH 2/4] rpmsg: drop owner assignment from spi_drivers

[Andrew F. Davis]

An rpmsg_driver does not need to set an owner, it will be populated by
the driver core.

Signed-off-by: Andrew F. Davis <afd@ti.com>
---
 Documentation/rpmsg.txt             | 1 -
 samples/rpmsg/rpmsg_client_sample.c | 1 -
 2 files changed, 2 deletions(-)

diff --git a/Documentation/rpmsg.txt b/Documentation/rpmsg.txt
index f7edc3a..1d88426 100644
--- a/Documentation/rpmsg.txt
+++ b/Documentation/rpmsg.txt
@@ -249,7 +249,6 @@ MODULE_DEVICE_TABLE(rpmsg, rpmsg_driver_sample_id_table);
 
 static struct rpmsg_driver rpmsg_sample_client = {
 	.drv.name	= KBUILD_MODNAME,
-	.drv.owner	= THIS_MODULE,
 	.id_table	= rpmsg_driver_sample_id_table,
 	.probe		= rpmsg_sample_probe,
 	.callback	= rpmsg_sample_cb,
diff --git a/samples/rpmsg/rpmsg_client_sample.c b/samples/rpmsg/rpmsg_client_sample.c
index 59b1344..82ed288 100644
--- a/samples/rpmsg/rpmsg_client_sample.c
+++ b/samples/rpmsg/rpmsg_client_sample.c
@@ -77,7 +77,6 @@ MODULE_DEVICE_TABLE(rpmsg, rpmsg_driver_sample_id_table);
 
 static struct rpmsg_driver rpmsg_sample_client = {
 	.drv.name	= KBUILD_MODNAME,
-	.drv.owner	= THIS_MODULE,
 	.id_table	= rpmsg_driver_sample_id_table,
 	.probe		= rpmsg_sample_probe,
 	.callback	= rpmsg_sample_cb,
-- 
2.8.2

[PATCH 3/4] rpmsg: add helper macro module_rpmsg_driver

[Andrew F. Davis]

This patch introduces the module_rpmsg_driver macro which is a
convenience macro for rpmsg driver modules similar to
module_platform_driver. It is intended to be used by drivers which
init/exit section does nothing but register/unregister the rpmsg driver.
By using this macro it is possible to eliminate a few lines of
boilerplate code per rpmsg driver.

Signed-off-by: Andrew F. Davis <afd@ti.com>
---
 include/linux/rpmsg.h | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/include/linux/rpmsg.h b/include/linux/rpmsg.h
index 78e45ce..ada50ff 100644
--- a/include/linux/rpmsg.h
+++ b/include/linux/rpmsg.h
@@ -177,13 +177,23 @@ struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_channel *,
 int
 rpmsg_send_offchannel_raw(struct rpmsg_channel *, u32, u32, void *, int, bool);
 
-/*
- * use a macro to avoid include chaining to get THIS_MODULE
- */
+/* use a macro to avoid include chaining to get THIS_MODULE */
 #define register_rpmsg_driver(drv) \
 	__register_rpmsg_driver(drv, THIS_MODULE)
 
 /**
+ * module_rpmsg_driver() - Helper macro for registering an rpmsg driver
+ * @__rpmsg_driver: rpmsg_driver struct
+ *
+ * Helper macro for rpmsg 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_rpmsg_driver(__rpmsg_driver) \
+	module_driver(__rpmsg_driver, register_rpmsg_driver, \
+			unregister_rpmsg_driver)
+
+/**
  * rpmsg_send() - send a message across to the remote processor
  * @rpdev: the rpmsg channel
  * @data: payload of message
-- 
2.8.2

[PATCH 4/4] rpmsg: use module_rpmsg_driver in existing drivers and examples

[Andrew F. Davis]

Existing drivers and examples are updated to use the
module_rpmsg_driver helper macro.

Signed-off-by: Andrew F. Davis <afd@ti.com>
---
 Documentation/rpmsg.txt             | 14 +-------------
 samples/rpmsg/rpmsg_client_sample.c | 13 +------------
 2 files changed, 2 insertions(+), 25 deletions(-)

diff --git a/Documentation/rpmsg.txt b/Documentation/rpmsg.txt
index 1d88426..b19700c 100644
--- a/Documentation/rpmsg.txt
+++ b/Documentation/rpmsg.txt
@@ -202,7 +202,6 @@ with the payload of the inbound message).
      a pointer to a previously-registered rpmsg_driver struct.
      Returns 0 on success, and an appropriate error value on failure.
 
-
 3. Typical usage
 
 The following is a simple rpmsg driver, that sends an "hello!" message
@@ -254,18 +253,7 @@ static struct rpmsg_driver rpmsg_sample_client = {
 	.callback	= rpmsg_sample_cb,
 	.remove		= rpmsg_sample_remove,
 };
-
-static int __init init(void)
-{
-	return register_rpmsg_driver(&rpmsg_sample_client);
-}
-module_init(init);
-
-static void __exit fini(void)
-{
-	unregister_rpmsg_driver(&rpmsg_sample_client);
-}
-module_exit(fini);
+module_rpmsg_driver(rpmsg_sample_client);
 
 Note: a similar sample which can be built and loaded can be found
 in samples/rpmsg/.
diff --git a/samples/rpmsg/rpmsg_client_sample.c b/samples/rpmsg/rpmsg_client_sample.c
index 82ed288..d0e249c9 100644
--- a/samples/rpmsg/rpmsg_client_sample.c
+++ b/samples/rpmsg/rpmsg_client_sample.c
@@ -82,18 +82,7 @@ static struct rpmsg_driver rpmsg_sample_client = {
 	.callback	= rpmsg_sample_cb,
 	.remove		= rpmsg_sample_remove,
 };
-
-static int __init rpmsg_client_sample_init(void)
-{
-	return register_rpmsg_driver(&rpmsg_sample_client);
-}
-module_init(rpmsg_client_sample_init);
-
-static void __exit rpmsg_client_sample_fini(void)
-{
-	unregister_rpmsg_driver(&rpmsg_sample_client);
-}
-module_exit(rpmsg_client_sample_fini);
+module_rpmsg_driver(rpmsg_sample_client);
 
 MODULE_DESCRIPTION("Remote processor messaging sample client driver");
 MODULE_LICENSE("GPL v2");
-- 
2.8.2

Re: [PATCH 3/4] rpmsg: add helper macro module_rpmsg_driver

[Suman Anna]

Hi Andrew,

On 05/04/2016 01:34 PM, Andrew F. Davis wrote:
> This patch introduces the module_rpmsg_driver macro which is a
> convenience macro for rpmsg driver modules similar to
> module_platform_driver. It is intended to be used by drivers which
> init/exit section does nothing but register/unregister the rpmsg driver.
> By using this macro it is possible to eliminate a few lines of
> boilerplate code per rpmsg driver.
> 
> Signed-off-by: Andrew F. Davis <afd@ti.com>
> ---
>  include/linux/rpmsg.h | 16 +++++++++++++---
>  1 file changed, 13 insertions(+), 3 deletions(-)
> 
> diff --git a/include/linux/rpmsg.h b/include/linux/rpmsg.h
> index 78e45ce..ada50ff 100644
> --- a/include/linux/rpmsg.h
> +++ b/include/linux/rpmsg.h
> @@ -177,13 +177,23 @@ struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_channel *,
>  int
>  rpmsg_send_offchannel_raw(struct rpmsg_channel *, u32, u32, void *, int, bool);
>  
> -/*
> - * use a macro to avoid include chaining to get THIS_MODULE
> - */
> +/* use a macro to avoid include chaining to get THIS_MODULE */

This change does not belong to this patch, the modified lines were
introduced in patch 1, so please correct it in that patch.

regards
Suman

>  #define register_rpmsg_driver(drv) \
>  	__register_rpmsg_driver(drv, THIS_MODULE)
>  
>  /**
> + * module_rpmsg_driver() - Helper macro for registering an rpmsg driver
> + * @__rpmsg_driver: rpmsg_driver struct
> + *
> + * Helper macro for rpmsg 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_rpmsg_driver(__rpmsg_driver) \
> +	module_driver(__rpmsg_driver, register_rpmsg_driver, \
> +			unregister_rpmsg_driver)
> +
> +/**
>   * rpmsg_send() - send a message across to the remote processor
>   * @rpdev: the rpmsg channel
>   * @data: payload of message
> 

Re: [PATCH 2/4] rpmsg: drop owner assignment from spi_drivers

[Suman Anna]

On 05/04/2016 01:34 PM, Andrew F. Davis wrote:
> An rpmsg_driver does not need to set an owner, it will be populated by
> the driver core.

spi_drivers in patch subject??

regards
Suman

> 
> Signed-off-by: Andrew F. Davis <afd@ti.com>
> ---
>  Documentation/rpmsg.txt             | 1 -
>  samples/rpmsg/rpmsg_client_sample.c | 1 -
>  2 files changed, 2 deletions(-)
> 
> diff --git a/Documentation/rpmsg.txt b/Documentation/rpmsg.txt
> index f7edc3a..1d88426 100644
> --- a/Documentation/rpmsg.txt
> +++ b/Documentation/rpmsg.txt
> @@ -249,7 +249,6 @@ MODULE_DEVICE_TABLE(rpmsg, rpmsg_driver_sample_id_table);
>  
>  static struct rpmsg_driver rpmsg_sample_client = {
>  	.drv.name	= KBUILD_MODNAME,
> -	.drv.owner	= THIS_MODULE,
>  	.id_table	= rpmsg_driver_sample_id_table,
>  	.probe		= rpmsg_sample_probe,
>  	.callback	= rpmsg_sample_cb,
> diff --git a/samples/rpmsg/rpmsg_client_sample.c b/samples/rpmsg/rpmsg_client_sample.c
> index 59b1344..82ed288 100644
> --- a/samples/rpmsg/rpmsg_client_sample.c
> +++ b/samples/rpmsg/rpmsg_client_sample.c
> @@ -77,7 +77,6 @@ MODULE_DEVICE_TABLE(rpmsg, rpmsg_driver_sample_id_table);
>  
>  static struct rpmsg_driver rpmsg_sample_client = {
>  	.drv.name	= KBUILD_MODNAME,
> -	.drv.owner	= THIS_MODULE,
>  	.id_table	= rpmsg_driver_sample_id_table,
>  	.probe		= rpmsg_sample_probe,
>  	.callback	= rpmsg_sample_cb,
> 

Re: [PATCH 1/4] rpmsg: add THIS_MODULE to rpmsg_driver in rpmsg core

[Suman Anna]

On 05/04/2016 01:34 PM, Andrew F. Davis wrote:
> Add register_rpmsg_driver helper macro that adds THIS_MODULE to
> rpmsg_driver for the registering driver. We rename and modify
> the existing register_rpmsg_driver to enable this.
> 
> Signed-off-by: Andrew F. Davis <afd@ti.com>

With the multi-trace comment from patch 3 squashed here properly,
Acked-by: Suman Anna <s-anna@ti.com>

> ---
>  drivers/rpmsg/virtio_rpmsg_bus.c | 8 +++++---
>  include/linux/rpmsg.h            | 8 +++++++-
>  2 files changed, 12 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/rpmsg/virtio_rpmsg_bus.c b/drivers/rpmsg/virtio_rpmsg_bus.c
> index 1fcd27c..fe03b2a 100644
> --- a/drivers/rpmsg/virtio_rpmsg_bus.c
> +++ b/drivers/rpmsg/virtio_rpmsg_bus.c
> @@ -436,17 +436,19 @@ static struct bus_type rpmsg_bus = {
>  };
>  
>  /**
> - * register_rpmsg_driver() - register an rpmsg driver with the rpmsg bus
> + * __register_rpmsg_driver() - register an rpmsg driver with the rpmsg bus
>   * @rpdrv: pointer to a struct rpmsg_driver
> + * @owner: owning module/driver
>   *
>   * Returns 0 on success, and an appropriate error value on failure.
>   */
> -int register_rpmsg_driver(struct rpmsg_driver *rpdrv)
> +int __register_rpmsg_driver(struct rpmsg_driver *rpdrv, struct module *owner)
>  {
>  	rpdrv->drv.bus = &rpmsg_bus;
> +	rpdrv->drv.owner = owner;
>  	return driver_register(&rpdrv->drv);
>  }
> -EXPORT_SYMBOL(register_rpmsg_driver);
> +EXPORT_SYMBOL(__register_rpmsg_driver);
>  
>  /**
>   * unregister_rpmsg_driver() - unregister an rpmsg driver from the rpmsg bus
> diff --git a/include/linux/rpmsg.h b/include/linux/rpmsg.h
> index 82a6739..78e45ce 100644
> --- a/include/linux/rpmsg.h
> +++ b/include/linux/rpmsg.h
> @@ -169,7 +169,7 @@ struct rpmsg_driver {
>  
>  int register_rpmsg_device(struct rpmsg_channel *dev);
>  void unregister_rpmsg_device(struct rpmsg_channel *dev);
> -int register_rpmsg_driver(struct rpmsg_driver *drv);
> +int __register_rpmsg_driver(struct rpmsg_driver *drv, struct module *owner);
>  void unregister_rpmsg_driver(struct rpmsg_driver *drv);
>  void rpmsg_destroy_ept(struct rpmsg_endpoint *);
>  struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_channel *,
> @@ -177,6 +177,12 @@ struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_channel *,
>  int
>  rpmsg_send_offchannel_raw(struct rpmsg_channel *, u32, u32, void *, int, bool);
>  
> +/*
> + * use a macro to avoid include chaining to get THIS_MODULE
> + */
> +#define register_rpmsg_driver(drv) \
> +	__register_rpmsg_driver(drv, THIS_MODULE)
> +
>  /**
>   * rpmsg_send() - send a message across to the remote processor
>   * @rpdev: the rpmsg channel
> 

Re: [PATCH 2/4] rpmsg: drop owner assignment from spi_drivers

[Andrew F. Davis]

On 05/04/2016 01:55 PM, Suman Anna wrote:
> On 05/04/2016 01:34 PM, Andrew F. Davis wrote:
>> An rpmsg_driver does not need to set an owner, it will be populated by
>> the driver core.
> 
> spi_drivers in patch subject??
> 

copy/paste error, this is all based on my SPI patches that do this same
thing to that subsystem. Will fix.

Thanks,
Andrew

> regards
> Suman
> 
>>
>> Signed-off-by: Andrew F. Davis <afd@ti.com>
>> ---
>>  Documentation/rpmsg.txt             | 1 -
>>  samples/rpmsg/rpmsg_client_sample.c | 1 -
>>  2 files changed, 2 deletions(-)
>>
>> diff --git a/Documentation/rpmsg.txt b/Documentation/rpmsg.txt
>> index f7edc3a..1d88426 100644
>> --- a/Documentation/rpmsg.txt
>> +++ b/Documentation/rpmsg.txt
>> @@ -249,7 +249,6 @@ MODULE_DEVICE_TABLE(rpmsg, rpmsg_driver_sample_id_table);
>>  
>>  static struct rpmsg_driver rpmsg_sample_client = {
>>  	.drv.name	= KBUILD_MODNAME,
>> -	.drv.owner	= THIS_MODULE,
>>  	.id_table	= rpmsg_driver_sample_id_table,
>>  	.probe		= rpmsg_sample_probe,
>>  	.callback	= rpmsg_sample_cb,
>> diff --git a/samples/rpmsg/rpmsg_client_sample.c b/samples/rpmsg/rpmsg_client_sample.c
>> index 59b1344..82ed288 100644
>> --- a/samples/rpmsg/rpmsg_client_sample.c
>> +++ b/samples/rpmsg/rpmsg_client_sample.c
>> @@ -77,7 +77,6 @@ MODULE_DEVICE_TABLE(rpmsg, rpmsg_driver_sample_id_table);
>>  
>>  static struct rpmsg_driver rpmsg_sample_client = {
>>  	.drv.name	= KBUILD_MODNAME,
>> -	.drv.owner	= THIS_MODULE,
>>  	.id_table	= rpmsg_driver_sample_id_table,
>>  	.probe		= rpmsg_sample_probe,
>>  	.callback	= rpmsg_sample_cb,
>>
> 

Re: [PATCH 3/4] rpmsg: add helper macro module_rpmsg_driver

[Andrew F. Davis]

On 05/04/2016 01:54 PM, Suman Anna wrote:
> Hi Andrew,
> 
> On 05/04/2016 01:34 PM, Andrew F. Davis wrote:
>> This patch introduces the module_rpmsg_driver macro which is a
>> convenience macro for rpmsg driver modules similar to
>> module_platform_driver. It is intended to be used by drivers which
>> init/exit section does nothing but register/unregister the rpmsg driver.
>> By using this macro it is possible to eliminate a few lines of
>> boilerplate code per rpmsg driver.
>>
>> Signed-off-by: Andrew F. Davis <afd@ti.com>
>> ---
>>  include/linux/rpmsg.h | 16 +++++++++++++---
>>  1 file changed, 13 insertions(+), 3 deletions(-)
>>
>> diff --git a/include/linux/rpmsg.h b/include/linux/rpmsg.h
>> index 78e45ce..ada50ff 100644
>> --- a/include/linux/rpmsg.h
>> +++ b/include/linux/rpmsg.h
>> @@ -177,13 +177,23 @@ struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_channel *,
>>  int
>>  rpmsg_send_offchannel_raw(struct rpmsg_channel *, u32, u32, void *, int, bool);
>>  
>> -/*
>> - * use a macro to avoid include chaining to get THIS_MODULE
>> - */
>> +/* use a macro to avoid include chaining to get THIS_MODULE */
> 
> This change does not belong to this patch, the modified lines were
> introduced in patch 1, so please correct it in that patch.
> 

Ahh, that's what I get for last minute rebasing before submission, will fix.

Thanks,
Andrew

> regards
> Suman
> 
>>  #define register_rpmsg_driver(drv) \
>>  	__register_rpmsg_driver(drv, THIS_MODULE)
>>  
>>  /**
>> + * module_rpmsg_driver() - Helper macro for registering an rpmsg driver
>> + * @__rpmsg_driver: rpmsg_driver struct
>> + *
>> + * Helper macro for rpmsg 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_rpmsg_driver(__rpmsg_driver) \
>> +	module_driver(__rpmsg_driver, register_rpmsg_driver, \
>> +			unregister_rpmsg_driver)
>> +
>> +/**
>>   * rpmsg_send() - send a message across to the remote processor
>>   * @rpdev: the rpmsg channel
>>   * @data: payload of message
>>
>