From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.3 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_1 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id DF26DC43603 for ; Wed, 20 Jan 2021 11:51:36 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id B41B12333B for ; Wed, 20 Jan 2021 11:51:36 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1731275AbhATLhh (ORCPT ); Wed, 20 Jan 2021 06:37:37 -0500 Received: from mga02.intel.com ([134.134.136.20]:4415 "EHLO mga02.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1733147AbhATKhO (ORCPT ); Wed, 20 Jan 2021 05:37:14 -0500 IronPort-SDR: 3IDOPV8olUSDF0jRD9TYFnx+0TNaBs84x0X44ikKBdGD926knsWgAXspor1Le3VV8qhg1BFY3O cFT5a74vtwcA== X-IronPort-AV: E=McAfee;i="6000,8403,9869"; a="166174424" X-IronPort-AV: E=Sophos;i="5.79,360,1602572400"; d="scan'208";a="166174424" Received: from orsmga004.jf.intel.com ([10.7.209.38]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Jan 2021 02:35:08 -0800 IronPort-SDR: EMqAeSkP4cjpPhGjGiHEbQHQU23wbArSooWLinKNTAh5xEQkYn7wkEIBkmgYqhcF7DcIIfYKqn tWetqbXaFEWg== X-IronPort-AV: E=Sophos;i="5.79,360,1602572400"; d="scan'208";a="501552439" Received: from paasikivi.fi.intel.com ([10.237.72.42]) by orsmga004-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Jan 2021 02:35:06 -0800 Received: by paasikivi.fi.intel.com (Postfix, from userid 1000) id 8895120503; Wed, 20 Jan 2021 12:35:04 +0200 (EET) Date: Wed, 20 Jan 2021 12:35:04 +0200 From: Sakari Ailus To: Daniel Scally Cc: gregkh@linuxfoundation.org, rafael@kernel.org, linux-kernel@vger.kernel.org, heikki.krogerus@linux.intel.com, andriy.shevchenko@linux.intel.com, rdunlap@infradead.org Subject: Re: [PATCH v3] software_node: Add kernel-doc comments to exported symbols Message-ID: <20210120103504.GH11878@paasikivi.fi.intel.com> References: <20210120000339.471117-1-djrscally@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20210120000339.471117-1-djrscally@gmail.com> User-Agent: Mutt/1.10.1 (2018-07-13) Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hi Dan, On Wed, Jan 20, 2021 at 12:03:39AM +0000, Daniel Scally wrote: > A number of functions which are exported via EXPORT_SYMBOL_GPL() lack any > kernel-doc comments; add those in so all exported symbols are documented. > > Reviewed-by: Andy Shevchenko > Reviewed-by: Heikki Krogerus > Reviewed-by: Randy Dunlap > Reviewed-by: Sakari Ailus > Signed-off-by: Daniel Scally > --- > Changelog for v3: > > - s/passed to @parent/passed as @parent > - Wrapped a long summary line - TIL that you can do that, thanks > Sakari > > drivers/base/swnode.c | 54 +++++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 54 insertions(+) > > diff --git a/drivers/base/swnode.c b/drivers/base/swnode.c > index 4a4b2008fbc2..39fbb653c58a 100644 > --- a/drivers/base/swnode.c > +++ b/drivers/base/swnode.c > @@ -33,6 +33,13 @@ static struct kset *swnode_kset; > > static const struct fwnode_operations software_node_ops; > > +/** > + * is_software_node() - check if given fwnode was created from a software_node > + * @fwnode: The &struct fwnode_handle to check > + * > + * This function is used to check whether a given firmware node handle was > + * created by registering a &struct software_node or not. > + */ > bool is_software_node(const struct fwnode_handle *fwnode) > { > return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &software_node_ops; > @@ -71,6 +78,15 @@ software_node_to_swnode(const struct software_node *node) > return swnode; > } > > +/** > + * to_software_node() - Fetch the software node used to create a firmware > + * node handle > + * @fwnode: The pointer to a &struct fwnode_handle to parse > + * > + * This function attempts to fetch a pointer to the &struct software_node which > + * was used to create the given @fwnode. Note that this will only work if the > + * software node has **not** been released. > + */ > const struct software_node *to_software_node(const struct fwnode_handle *fwnode) > { > const struct swnode *swnode = to_swnode(fwnode); > @@ -79,6 +95,14 @@ const struct software_node *to_software_node(const struct fwnode_handle *fwnode) > } > EXPORT_SYMBOL_GPL(to_software_node); > > +/** > + * software_node_fwnode() - Fetch firmware node associated with a given software node > + * @node: The pointer to a &struct software_node to parse > + * > + * This function attempts to fetch a pointer to the &struct fwnode_handle which > + * was created from the given @node. Note that this will only work after the > + * software node has been registered. > + */ > struct fwnode_handle *software_node_fwnode(const struct software_node *node) > { > struct swnode *swnode = software_node_to_swnode(node); > @@ -800,6 +824,27 @@ void software_node_unregister(const struct software_node *node) > } > EXPORT_SYMBOL_GPL(software_node_unregister); > > +/** > + * fwnode_create_software_node() - Create and register a new software_node > + * @properties: NULL terminated array of properties to assign to the new node > + * @parent: Pointer to a &struct fwnode_handle to assign as parent to the new > + * node > + * > + * NOTE: The pointer passed as @parent **must** be to a firmware node handle > + * that was created by registering a software node, meaning is_software_node() > + * must return true when passed that pointer. > + * > + * This function creates a new instance of &struct software_node, assigns it a > + * copy of the given array of properties and registers it as a new fwnode_handle. > + * Freeing of the allocated memory when the fwnode_handle is no longer needed is > + * handled via software_node_release() and does not need to be done separately. Please wrap all lines over 80 unless there's a reason to keep them longer. > + * > + * Returns: > + * * fwnode_handle * - On success > + * * -EINVAL - When @parent is not associated with a software_node > + * * -ENOMEM - When memory allocation fails > + * * -Other - Propagated errors from sub-functions > + */ > struct fwnode_handle * > fwnode_create_software_node(const struct property_entry *properties, > const struct fwnode_handle *parent) > @@ -832,6 +877,15 @@ fwnode_create_software_node(const struct property_entry *properties, > } > EXPORT_SYMBOL_GPL(fwnode_create_software_node); > > +/** > + * fwnode_remove_software_node() - Put a reference to a registered software_node > + * @fwnode: The pointer to the &struct fwnode_handle you want to release > + * > + * Release a reference to a registered &struct software_node. This function > + * differs from software_node_put() in that it takes no action if the > + * firmware node handle passed to @fwnode turns out not to have been created by > + * registering a software_node. > + */ > void fwnode_remove_software_node(struct fwnode_handle *fwnode) > { > struct swnode *swnode = to_swnode(fwnode); > -- > 2.25.1 > -- Sakari Ailus