[PATCH v2 1/8] firmware: arm_scmi: review protocol registration interface

[Thara Gopinath]

On 11/4/20 11:56 AM, Cristian Marussi wrote:
> Hi Thara,
> 
> thanks for reviewing.
> 
> On Wed, Nov 04, 2020 at 11:16:06AM -0500, Thara Gopinath wrote:
>> Hi Cristian,
>>
>> On 10/28/20 4:29 PM, Cristian Marussi wrote:
>>> Extend common protocol registration routines and provide some new generic
>>> protocols' init/deinit helpers that tracks protocols' users and automatically
>>> perform the proper initialization/de-initialization on demand.
>>>
>>> Convert all protocols to use new registration schema while modifying only Base
>>> protocol to use also the new initialization helpers.
>>>
>>> All other standard protocols' initialization is still umodified and bound to
>>> SCMI devices probing.
>>
>> minor nit : umodified->unmodified.
>>>
> 
> Right.
> 
>>> Signed-off-by: Cristian Marussi <cristian.marussi at arm.com>
>>> ---
>>> v1 --> v2
>>> - made all scmi_protocol refs const
>>> - introduced IDR to handle protocols instead of static array
>>> - refactored code around fast path
>>> ---
>>>    drivers/firmware/arm_scmi/base.c    |  10 +-
>>>    drivers/firmware/arm_scmi/bus.c     |  61 +++++++---
>>>    drivers/firmware/arm_scmi/clock.c   |  10 +-
>>>    drivers/firmware/arm_scmi/common.h  |  31 ++++-
>>>    drivers/firmware/arm_scmi/driver.c  | 168 +++++++++++++++++++++++++++-
>>>    drivers/firmware/arm_scmi/notify.c  |   3 +-
>>>    drivers/firmware/arm_scmi/perf.c    |  10 +-
>>>    drivers/firmware/arm_scmi/power.c   |  10 +-
>>>    drivers/firmware/arm_scmi/reset.c   |  10 +-
>>>    drivers/firmware/arm_scmi/sensors.c |  10 +-
>>>    drivers/firmware/arm_scmi/system.c  |   8 +-
>>>    include/linux/scmi_protocol.h       |   6 +-
>>>    12 files changed, 299 insertions(+), 38 deletions(-)
>>>
>>
>> [...]
>>
>>
>>> diff --git a/drivers/firmware/arm_scmi/driver.c b/drivers/firmware/arm_scmi/driver.c
>>> index 3dfd8b6a0ebf..beae8991422d 100644
>>> --- a/drivers/firmware/arm_scmi/driver.c
>>> +++ b/drivers/firmware/arm_scmi/driver.c
>>> @@ -11,11 +11,12 @@
>>>     * various power domain DVFS including the core/cluster, certain system
>>>     * clocks configuration, thermal sensors and many others.
>>>     *
>>> - * Copyright (C) 2018 ARM Ltd.
>>> + * Copyright (C) 2018-2020 ARM Ltd.
>>>     */
>>>    #include <linux/bitmap.h>
>>>    #include <linux/export.h>
>>> +#include <linux/idr.h>
>>>    #include <linux/io.h>
>>>    #include <linux/kernel.h>
>>>    #include <linux/ktime.h>
>>> @@ -23,6 +24,7 @@
>>>    #include <linux/of_address.h>
>>>    #include <linux/of_device.h>
>>>    #include <linux/processor.h>
>>> +#include <linux/refcount.h>
>>>    #include <linux/slab.h>
>>>    #include "common.h"
>>> @@ -68,6 +70,21 @@ struct scmi_xfers_info {
>>>    	spinlock_t xfer_lock;
>>>    };
>>> +/**
>>> + * struct scmi_protocol_instance  - Describe an initialized protocol instance.
>>> + * @proto: A reference to the protocol descriptor.
>>> + * @gid: A reference for per-protocol devres management.
>>> + * @users: A refcount to track effective users of this protocol.
>>> + *
>>> + * Each protocol is initialized independently once for each SCMI platform in
>>> + * which is defined by DT and implemented by the SCMI server fw.
>>> + */
>>> +struct scmi_protocol_instance {
>>> +	const struct scmi_protocol	*proto;
>>> +	void				*gid;
>>> +	refcount_t			users;
>>> +};
>>
>> Why do you need a separate protocol_instance? Will there be two instances of
>> the same protocol for a single scmi device/instance?
>> Else everything that has been defined in this struct in this patch the
>> following ones can be rolled into scmi_protocol struct, right ?
>>
> 
> Basically scm_protocol represents generically a protocol with all its ops,
> events and stuff, and it is registered during core init or protocol module
> loading with the core so that it appears into the available protocols IDR.
> 
> Each protocol then, if available, is later initialized only on its first usage
> after a get/ops or notify reg by an SCMI driver; now, this SCMI driver operates
> on an handle which represents in fact an SCMI instance (server) and you could
> have more than one instance in theory on the system (multiple SCMI servers
> identified by multiple DT nodes).
> 
> As an example you could have two distinct MCU handling two different set of
> sensors, so you'd have two distinct DT nodes representing each of these SCMI
> servers (with distinct transport channels of course) and you'll endup with two
> instances of the core SCMI platform driver (so 2 distinct handles), creating 2
> distinct devices each for the sensor protocol, so ending up at the end with two
> different running instances of the SCMI Sensor driver (hwmon) using a distinct
> handle to communicate with the correspondent sensors: as a consequence I
> initialize a distinct protocol instance structure for each handle, and keep
> distinct resource accounting (gid an users) while keeping a single reference
> (proto) to the same undelrying protocol descriptor; you could see as the
> scmi_protocol representing a class and the scmi_protocol_instance being an
> instantiated object (for a specific SCMI handle) in our poor C-Based OO world :D
> 
> In this way the two possible SCMI instances stacks are completely separated from
> the lower transport channels up to the SCMI driver users, including the
> intermediate protocols implementation.

Thanks for the explanation. I understand that this is to maintain two 
separate SCMI instances with the same underlying protocol ops. I think 
the confusing part here is why this struct does not have pointer to 
scmi_handle and I see that you have added it as part of patch 2. May be 
you can move that up here to indicate that same protocol can be used by 
two separate scmi server instances.

> 
> 
>>> +
>>>    /**
>>>     * struct scmi_info - Structure representing a SCMI instance
>>>     *
>>> @@ -80,6 +97,10 @@ struct scmi_xfers_info {
>>>     * @rx_minfo: Universal Receive Message management info
>>>     * @tx_idr: IDR object to map protocol id to Tx channel info pointer
>>>     * @rx_idr: IDR object to map protocol id to Rx channel info pointer
>>> + * @protocols: IDR for protocols' instance descriptors initialized for
>>> + *	       this SCMI instance: populated on protocol's first attempted
>>> + *	       usage.
>>> + * @protocols_mtx: A mutex to protect protocols instances initialization.
>>>     * @protocols_imp: List of protocols implemented, currently maximum of
>>>     *	MAX_PROTOCOLS_IMP elements allocated by the base protocol
>>>     * @node: List head
>>> @@ -94,6 +115,9 @@ struct scmi_info {
>>>    	struct scmi_xfers_info rx_minfo;
>>>    	struct idr tx_idr;
>>>    	struct idr rx_idr;
>>> +	struct idr protocols;
>>> +	/* Ensure mutual exclusive access to protocols instance array */
>>> +	struct mutex protocols_mtx;
>>>    	u8 *protocols_imp;
>>>    	struct list_head node;
>>>    	int users;
>>> @@ -519,6 +543,127 @@ int scmi_version_get(const struct scmi_handle *handle, u8 protocol,
>>>    	return ret;
>>>    }
>>> +/**
>>> + * scmi_get_protocol_instance  - Protocol initialization helper.
>>> + * @handle: A reference to the SCMI platform instance.
>>> + * @protocol_id: The protocol being requested.
>>> + *
>>> + * In case the required protocol has never been requested before for this
>>> + * instance, allocate and initialize all the needed structures while handling
>>> + * resource allocation with a dedicated per-protocol devres subgroup.
>>> + *
>>> + * Return: A reference to an initialized protocol instance or error on failure.
>>> + */
>>> +static struct scmi_protocol_instance * __must_check
>>> +scmi_get_protocol_instance(struct scmi_handle *handle, u8 protocol_id)
>>> +{
>>> +	int ret = -ENOMEM;
>>> +	void *gid;
>>> +	struct scmi_protocol_instance *pi;
>>> +	struct scmi_info *info = handle_to_scmi_info(handle);
>>> +
>>> +	mutex_lock(&info->protocols_mtx);
>>> +	pi = idr_find(&info->protocols, protocol_id);
>>> +
>>> +	if (pi) {
>>> +		refcount_inc(&pi->users);
>>> +	} else {
>>> +		const struct scmi_protocol *proto;
>>> +
>>> +		/* Fail if protocol not registered on bus */
>>> +		proto = scmi_get_protocol(protocol_id);
>>> +		if (!proto) {
>>> +			ret = -ENODEV;
>>> +			goto out;
>>> +		}
>>> +
>>> +		/* Protocol specific devres group */
>>> +		gid = devres_open_group(handle->dev, NULL, GFP_KERNEL);
>>> +		if (!gid)
>>> +			goto out;
>>> +
>>> +		pi = devm_kzalloc(handle->dev, sizeof(*pi), GFP_KERNEL);
>>> +		if (!pi)
>>> +			goto clean;
>>> +
>>> +		pi->gid = gid;
>>> +		pi->proto = proto;
>>> +		refcount_set(&pi->users, 1);
>>> +		/* proto->init is assured NON NULL by scmi_protocol_register */
>>> +		ret = pi->proto->init(handle);
>>
>> So init for a protocol will be called twice. Is this intentional ? Once
>> during the device probe via scmi_dev_probe and scmi_protocol_init. And
>> once via scmi_get_protocol_instance which gets called in get_ops apis
>> defined and used in the later patches.
>>
> 
> This is part of the desperate attempt to split this series as much as
> possible :D ... so that in this patch I introduce this code path for
> initialization (and all the related helpers) but I'm using it only for
> the Base protocol (via acquire) ... all the other standard protocols here
> still reliy on the probe based legacy initialization, then later in the
> series I drop all the init at probe code and rely only on this path for
> init and also events registrations.

Ok.. I did not closely check this part in patch 6. If you are removing 
the double init, It should be ok.



-- 
Warm Regards
Thara