Unverified Commit c6563be1 authored by openeuler-ci-bot's avatar openeuler-ci-bot Committed by Gitee
Browse files

!9598 fpga: manager: add owner module and take its refcount 

Merge Pull Request from: @ci-robot 
 
PR sync from: Liu Chuang <liuchuang40@huawei.com>
https://mailweb.openeuler.org/hyperkitty/list/kernel@openeuler.org/message/Q6G3ZV6NMCLN5VM4BMFVOUXJZLUO2KFY/ 
 
https://gitee.com/src-openeuler/kernel/issues/IA7YM1 
 
Link:https://gitee.com/openeuler/kernel/pulls/9598

 

Reviewed-by: default avatarYe Weihua <yeweihua4@huawei.com>
Signed-off-by: default avatarZhang Peng <zhangpeng362@huawei.com>
parents b53be02f 55693549

Documentation/driver-api/fpga/fpga-mgr.rst

+20 −14
Original line number Diff line number Diff line
@@ -24,7 +24,8 @@ How to support a new FPGA device 
--------------------------------



To add another FPGA manager, write a driver that implements a set of ops.  The

probe function calls fpga_mgr_register() or fpga_mgr_register_full(), such as::

probe function calls ``fpga_mgr_register()`` or ``fpga_mgr_register_full()``,

such as::



	static const struct fpga_manager_ops socfpga_fpga_ops = {

		.write_init = socfpga_fpga_ops_configure_init,
@@ -69,10 +70,11 @@ probe function calls fpga_mgr_register() or fpga_mgr_register_full(), such as:: 
	}



Alternatively, the probe function could call one of the resource managed

register functions, devm_fpga_mgr_register() or devm_fpga_mgr_register_full().

When these functions are used, the parameter syntax is the same, but the call

to fpga_mgr_unregister() should be removed. In the above example, the

socfpga_fpga_remove() function would not be required.

register functions, ``devm_fpga_mgr_register()`` or

``devm_fpga_mgr_register_full()``.  When these functions are used, the

parameter syntax is the same, but the call to ``fpga_mgr_unregister()`` should be

removed. In the above example, the ``socfpga_fpga_remove()`` function would not be

required.



The ops will implement whatever device specific register writes are needed to

do the programming sequence for this particular FPGA.  These ops return 0 for
@@ -125,15 +127,19 @@ API for implementing a new FPGA Manager driver 
* struct fpga_manager -  the FPGA manager struct

* struct fpga_manager_ops -  Low level FPGA manager driver ops

* struct fpga_manager_info -  Parameter structure for fpga_mgr_register_full()

* fpga_mgr_register_full() -  Create and register an FPGA manager using the

* __fpga_mgr_register_full() -  Create and register an FPGA manager using the

  fpga_mgr_info structure to provide the full flexibility of options

* fpga_mgr_register() -  Create and register an FPGA manager using standard

* __fpga_mgr_register() -  Create and register an FPGA manager using standard

  arguments

* devm_fpga_mgr_register_full() -  Resource managed version of

  fpga_mgr_register_full()

* devm_fpga_mgr_register() -  Resource managed version of fpga_mgr_register()

* __devm_fpga_mgr_register_full() -  Resource managed version of

  __fpga_mgr_register_full()

* __devm_fpga_mgr_register() -  Resource managed version of __fpga_mgr_register()

* fpga_mgr_unregister() -  Unregister an FPGA manager



Helper macros ``fpga_mgr_register_full()``, ``fpga_mgr_register()``,

``devm_fpga_mgr_register_full()``, and ``devm_fpga_mgr_register()`` are available

to ease the registration.



.. kernel-doc:: include/linux/fpga/fpga-mgr.h

   :functions: fpga_mgr_states
@@ -147,16 +153,16 @@ API for implementing a new FPGA Manager driver 
   :functions: fpga_manager_info



.. kernel-doc:: drivers/fpga/fpga-mgr.c

   :functions: fpga_mgr_register_full

   :functions: __fpga_mgr_register_full



.. kernel-doc:: drivers/fpga/fpga-mgr.c

   :functions: fpga_mgr_register

   :functions: __fpga_mgr_register



.. kernel-doc:: drivers/fpga/fpga-mgr.c

   :functions: devm_fpga_mgr_register_full

   :functions: __devm_fpga_mgr_register_full



.. kernel-doc:: drivers/fpga/fpga-mgr.c

   :functions: devm_fpga_mgr_register

   :functions: __devm_fpga_mgr_register



.. kernel-doc:: drivers/fpga/fpga-mgr.c

   :functions: fpga_mgr_unregister

drivers/fpga/fpga-mgr.c

+49 −33
Original line number Diff line number Diff line
@@ -664,20 +664,16 @@ static struct attribute *fpga_mgr_attrs[] = { 
};

ATTRIBUTE_GROUPS(fpga_mgr);



static struct fpga_manager *__fpga_mgr_get(struct device *dev)

static struct fpga_manager *__fpga_mgr_get(struct device *mgr_dev)

{

	struct fpga_manager *mgr;



	mgr = to_fpga_manager(dev);

	mgr = to_fpga_manager(mgr_dev);



	if (!try_module_get(dev->parent->driver->owner))

		goto err_dev;

	if (!try_module_get(mgr->mops_owner))

		mgr = ERR_PTR(-ENODEV);



	return mgr;



err_dev:

	put_device(dev);

	return ERR_PTR(-ENODEV);

}



static int fpga_mgr_dev_match(struct device *dev, const void *data)
@@ -693,12 +689,18 @@ static int fpga_mgr_dev_match(struct device *dev, const void *data) 
 */

struct fpga_manager *fpga_mgr_get(struct device *dev)

{

	struct device *mgr_dev = class_find_device(&fpga_mgr_class, NULL, dev,

						   fpga_mgr_dev_match);

	struct fpga_manager *mgr;

	struct device *mgr_dev;



	mgr_dev = class_find_device(&fpga_mgr_class, NULL, dev, fpga_mgr_dev_match);

	if (!mgr_dev)

		return ERR_PTR(-ENODEV);



	return __fpga_mgr_get(mgr_dev);

	mgr = __fpga_mgr_get(mgr_dev);

	if (IS_ERR(mgr))

		put_device(mgr_dev);



	return mgr;

}

EXPORT_SYMBOL_GPL(fpga_mgr_get);
@@ -711,13 +713,18 @@ EXPORT_SYMBOL_GPL(fpga_mgr_get); 
 */

struct fpga_manager *of_fpga_mgr_get(struct device_node *node)

{

	struct device *dev;

	struct fpga_manager *mgr;

	struct device *mgr_dev;



	dev = class_find_device_by_of_node(&fpga_mgr_class, node);

	if (!dev)

	mgr_dev = class_find_device_by_of_node(&fpga_mgr_class, node);

	if (!mgr_dev)

		return ERR_PTR(-ENODEV);



	return __fpga_mgr_get(dev);

	mgr = __fpga_mgr_get(mgr_dev);

	if (IS_ERR(mgr))

		put_device(mgr_dev);



	return mgr;

}

EXPORT_SYMBOL_GPL(of_fpga_mgr_get);
@@ -727,7 +734,7 @@ EXPORT_SYMBOL_GPL(of_fpga_mgr_get); 
 */

void fpga_mgr_put(struct fpga_manager *mgr)

{

	module_put(mgr->dev.parent->driver->owner);

	module_put(mgr->mops_owner);

	put_device(&mgr->dev);

}

EXPORT_SYMBOL_GPL(fpga_mgr_put);
@@ -766,9 +773,10 @@ void fpga_mgr_unlock(struct fpga_manager *mgr) 
EXPORT_SYMBOL_GPL(fpga_mgr_unlock);



/**

 * fpga_mgr_register_full - create and register an FPGA Manager device

 * __fpga_mgr_register_full - create and register an FPGA Manager device

 * @parent:	fpga manager device from pdev

 * @info:	parameters for fpga manager

 * @owner:	owner module containing the ops

 *

 * The caller of this function is responsible for calling fpga_mgr_unregister().

 * Using devm_fpga_mgr_register_full() instead is recommended.
@@ -776,7 +784,8 @@ EXPORT_SYMBOL_GPL(fpga_mgr_unlock); 
 * Return: pointer to struct fpga_manager pointer or ERR_PTR()

 */

struct fpga_manager *

fpga_mgr_register_full(struct device *parent, const struct fpga_manager_info *info)

__fpga_mgr_register_full(struct device *parent, const struct fpga_manager_info *info,

			 struct module *owner)

{

	const struct fpga_manager_ops *mops = info->mops;

	struct fpga_manager *mgr;
@@ -804,6 +813,8 @@ fpga_mgr_register_full(struct device *parent, const struct fpga_manager_info *in 


	mutex_init(&mgr->ref_mutex);



	mgr->mops_owner = owner;



	mgr->name = info->name;

	mgr->mops = info->mops;

	mgr->priv = info->priv;
@@ -841,14 +852,15 @@ fpga_mgr_register_full(struct device *parent, const struct fpga_manager_info *in 


	return ERR_PTR(ret);

}

EXPORT_SYMBOL_GPL(fpga_mgr_register_full);

EXPORT_SYMBOL_GPL(__fpga_mgr_register_full);



/**

 * fpga_mgr_register - create and register an FPGA Manager device

 * __fpga_mgr_register - create and register an FPGA Manager device

 * @parent:	fpga manager device from pdev

 * @name:	fpga manager name

 * @mops:	pointer to structure of fpga manager ops

 * @priv:	fpga manager private data

 * @owner:	owner module containing the ops

 *

 * The caller of this function is responsible for calling fpga_mgr_unregister().

 * Using devm_fpga_mgr_register() instead is recommended. This simple
@@ -859,8 +871,8 @@ EXPORT_SYMBOL_GPL(fpga_mgr_register_full); 
 * Return: pointer to struct fpga_manager pointer or ERR_PTR()

 */

struct fpga_manager *

fpga_mgr_register(struct device *parent, const char *name,

		  const struct fpga_manager_ops *mops, void *priv)

__fpga_mgr_register(struct device *parent, const char *name,

		    const struct fpga_manager_ops *mops, void *priv, struct module *owner)

{

	struct fpga_manager_info info = { 0 };
@@ -868,9 +880,9 @@ fpga_mgr_register(struct device *parent, const char *name, 
	info.mops = mops;

	info.priv = priv;



	return fpga_mgr_register_full(parent, &info);

	return __fpga_mgr_register_full(parent, &info, owner);

}

EXPORT_SYMBOL_GPL(fpga_mgr_register);

EXPORT_SYMBOL_GPL(__fpga_mgr_register);



/**

 * fpga_mgr_unregister - unregister an FPGA manager
@@ -900,9 +912,10 @@ static void devm_fpga_mgr_unregister(struct device *dev, void *res) 
}



/**

 * devm_fpga_mgr_register_full - resource managed variant of fpga_mgr_register()

 * __devm_fpga_mgr_register_full - resource managed variant of fpga_mgr_register()

 * @parent:	fpga manager device from pdev

 * @info:	parameters for fpga manager

 * @owner:	owner module containing the ops

 *

 * Return:  fpga manager pointer on success, negative error code otherwise.

 *
@@ -910,7 +923,8 @@ static void devm_fpga_mgr_unregister(struct device *dev, void *res) 
 * function will be called automatically when the managing device is detached.

 */

struct fpga_manager *

devm_fpga_mgr_register_full(struct device *parent, const struct fpga_manager_info *info)

__devm_fpga_mgr_register_full(struct device *parent, const struct fpga_manager_info *info,

			      struct module *owner)

{

	struct fpga_mgr_devres *dr;

	struct fpga_manager *mgr;
@@ -919,7 +933,7 @@ devm_fpga_mgr_register_full(struct device *parent, const struct fpga_manager_inf 
	if (!dr)

		return ERR_PTR(-ENOMEM);



	mgr = fpga_mgr_register_full(parent, info);

	mgr = __fpga_mgr_register_full(parent, info, owner);

	if (IS_ERR(mgr)) {

		devres_free(dr);

		return mgr;
@@ -930,14 +944,15 @@ devm_fpga_mgr_register_full(struct device *parent, const struct fpga_manager_inf 


	return mgr;

}

EXPORT_SYMBOL_GPL(devm_fpga_mgr_register_full);

EXPORT_SYMBOL_GPL(__devm_fpga_mgr_register_full);



/**

 * devm_fpga_mgr_register - resource managed variant of fpga_mgr_register()

 * __devm_fpga_mgr_register - resource managed variant of fpga_mgr_register()

 * @parent:	fpga manager device from pdev

 * @name:	fpga manager name

 * @mops:	pointer to structure of fpga manager ops

 * @priv:	fpga manager private data

 * @owner:	owner module containing the ops

 *

 * Return:  fpga manager pointer on success, negative error code otherwise.

 *
@@ -946,8 +961,9 @@ EXPORT_SYMBOL_GPL(devm_fpga_mgr_register_full); 
 * device is detached.

 */

struct fpga_manager *

devm_fpga_mgr_register(struct device *parent, const char *name,

		       const struct fpga_manager_ops *mops, void *priv)

__devm_fpga_mgr_register(struct device *parent, const char *name,

			 const struct fpga_manager_ops *mops, void *priv,

			 struct module *owner)

{

	struct fpga_manager_info info = { 0 };
@@ -955,9 +971,9 @@ devm_fpga_mgr_register(struct device *parent, const char *name, 
	info.mops = mops;

	info.priv = priv;



	return devm_fpga_mgr_register_full(parent, &info);

	return __devm_fpga_mgr_register_full(parent, &info, owner);

}

EXPORT_SYMBOL_GPL(devm_fpga_mgr_register);

EXPORT_SYMBOL_GPL(__devm_fpga_mgr_register);



static void fpga_mgr_dev_release(struct device *dev)

{

include/linux/fpga/fpga-mgr.h

+20 −6
Original line number Diff line number Diff line
@@ -201,6 +201,7 @@ struct fpga_manager_ops { 
 * @state: state of fpga manager

 * @compat_id: FPGA manager id for compatibility check.

 * @mops: pointer to struct of fpga manager ops

 * @mops_owner: module containing the mops

 * @priv: low level driver private date

 */

struct fpga_manager {
@@ -210,6 +211,7 @@ struct fpga_manager { 
	enum fpga_mgr_states state;

	struct fpga_compat_id *compat_id;

	const struct fpga_manager_ops *mops;

	struct module *mops_owner;

	void *priv;

};
@@ -230,18 +232,30 @@ struct fpga_manager *fpga_mgr_get(struct device *dev); 


void fpga_mgr_put(struct fpga_manager *mgr);



#define fpga_mgr_register_full(parent, info) \

	__fpga_mgr_register_full(parent, info, THIS_MODULE)

struct fpga_manager *

fpga_mgr_register_full(struct device *parent, const struct fpga_manager_info *info);

__fpga_mgr_register_full(struct device *parent, const struct fpga_manager_info *info,

			 struct module *owner);



#define fpga_mgr_register(parent, name, mops, priv) \

	__fpga_mgr_register(parent, name, mops, priv, THIS_MODULE)

struct fpga_manager *

fpga_mgr_register(struct device *parent, const char *name,

		  const struct fpga_manager_ops *mops, void *priv);

__fpga_mgr_register(struct device *parent, const char *name,

		    const struct fpga_manager_ops *mops, void *priv, struct module *owner);



void fpga_mgr_unregister(struct fpga_manager *mgr);



#define devm_fpga_mgr_register_full(parent, info) \

	__devm_fpga_mgr_register_full(parent, info, THIS_MODULE)

struct fpga_manager *

devm_fpga_mgr_register_full(struct device *parent, const struct fpga_manager_info *info);

__devm_fpga_mgr_register_full(struct device *parent, const struct fpga_manager_info *info,

			      struct module *owner);

#define devm_fpga_mgr_register(parent, name, mops, priv) \

	__devm_fpga_mgr_register(parent, name, mops, priv, THIS_MODULE)

struct fpga_manager *

devm_fpga_mgr_register(struct device *parent, const char *name,

		       const struct fpga_manager_ops *mops, void *priv);

__devm_fpga_mgr_register(struct device *parent, const char *name,

			 const struct fpga_manager_ops *mops, void *priv,

			 struct module *owner);



#endif /*_LINUX_FPGA_MGR_H */