Commit 6ab6094f authored by Chanwoo Choi's avatar Chanwoo Choi
Browse files

extcon: Correct description to improve the readability 



The extcon files explains the detailed operation for functions and
what is meaning of extcon structure. There are different explanation
even if the same argument.

So, it modifies the description for both functions and structures
in order to improve the readability and guide the role of functions
more well.

Also, this patch fixes the mismatching license info as a GPL v2
and removes the inactive author information.

Signed-off-by: default avatarChanwoo Choi <cw00.choi@samsung.com>
parent dd4ed69a

drivers/extcon/devres.c

+24 −26
Original line number Diff line number Diff line
@@ -59,10 +59,9 @@ static void devm_extcon_dev_notifier_all_unreg(struct device *dev, void *res) 


/**

 * devm_extcon_dev_allocate - Allocate managed extcon device

 * @dev:		device owning the extcon device being created

 * @supported_cable:	Array of supported extcon ending with EXTCON_NONE.

 *			If supported_cable is NULL, cable name related APIs

 *			are disabled.

 * @dev:		the device owning the extcon device being created

 * @supported_cable:	the array of the supported external connectors

 *			ending with EXTCON_NONE.

 *

 * This function manages automatically the memory of extcon device using device

 * resource management and simplify the control of freeing the memory of extcon
@@ -97,8 +96,8 @@ EXPORT_SYMBOL_GPL(devm_extcon_dev_allocate); 


/**

 * devm_extcon_dev_free() - Resource-managed extcon_dev_unregister()

 * @dev:	device the extcon belongs to

 * @edev:	the extcon device to unregister

 * @dev:	the device owning the extcon device being created

 * @edev:	the extcon device to be freed

 *

 * Free the memory that is allocated with devm_extcon_dev_allocate()

 * function.
@@ -112,10 +111,9 @@ EXPORT_SYMBOL_GPL(devm_extcon_dev_free); 


/**

 * devm_extcon_dev_register() - Resource-managed extcon_dev_register()

 * @dev:	device to allocate extcon device

 * @edev:	the new extcon device to register

 * @dev:	the device owning the extcon device being created

 * @edev:	the extcon device to be registered

 *

 * Managed extcon_dev_register() function. If extcon device is attached with

 * this function, that extcon device is automatically unregistered on driver

 * detach. Internally this function calls extcon_dev_register() function.

 * To get more information, refer that function.
@@ -149,8 +147,8 @@ EXPORT_SYMBOL_GPL(devm_extcon_dev_register); 


/**

 * devm_extcon_dev_unregister() - Resource-managed extcon_dev_unregister()

 * @dev:	device the extcon belongs to

 * @edev:	the extcon device to unregister

 * @dev:	the device owning the extcon device being created

 * @edev:	the extcon device to unregistered

 *

 * Unregister extcon device that is registered with devm_extcon_dev_register()

 * function.
@@ -164,10 +162,10 @@ EXPORT_SYMBOL_GPL(devm_extcon_dev_unregister); 


/**

 * devm_extcon_register_notifier() - Resource-managed extcon_register_notifier()

 * @dev:	device to allocate extcon device

 * @edev:	the extcon device that has the external connecotr.

 * @id:		the unique id of each external connector in extcon enumeration.

 * @nb:		a notifier block to be registered.

 * @dev:	the device owning the extcon device being created

 * @edev:	the extcon device

 * @id:		the unique id among the extcon enumeration

 * @nb:		a notifier block to be registered

 *

 * This function manages automatically the notifier of extcon device using

 * device resource management and simplify the control of unregistering
@@ -208,10 +206,10 @@ EXPORT_SYMBOL(devm_extcon_register_notifier); 
/**

 * devm_extcon_unregister_notifier()

			- Resource-managed extcon_unregister_notifier()

 * @dev:	device to allocate extcon device

 * @edev:	the extcon device that has the external connecotr.

 * @id:		the unique id of each external connector in extcon enumeration.

 * @nb:		a notifier block to be registered.

 * @dev:	the device owning the extcon device being created

 * @edev:	the extcon device

 * @id:		the unique id among the extcon enumeration

 * @nb:		a notifier block to be registered

 */

void devm_extcon_unregister_notifier(struct device *dev,

				struct extcon_dev *edev, unsigned int id,
@@ -225,9 +223,9 @@ EXPORT_SYMBOL(devm_extcon_unregister_notifier); 
/**

 * devm_extcon_register_notifier_all()

 *		- Resource-managed extcon_register_notifier_all()

 * @dev:	device to allocate extcon device

 * @edev:	the extcon device that has the external connecotr.

 * @nb:		a notifier block to be registered.

 * @dev:	the device owning the extcon device being created

 * @edev:	the extcon device

 * @nb:		a notifier block to be registered

 *

 * This function manages automatically the notifier of extcon device using

 * device resource management and simplify the control of unregistering
@@ -263,9 +261,9 @@ EXPORT_SYMBOL(devm_extcon_register_notifier_all); 
/**

 * devm_extcon_unregister_notifier_all()

 *		- Resource-managed extcon_unregister_notifier_all()

 * @dev:	device to allocate extcon device

 * @edev:	the extcon device that has the external connecotr.

 * @nb:		a notifier block to be registered.

 * @dev:	the device owning the extcon device being created

 * @edev:	the extcon device

 * @nb:		a notifier block to be registered

 */

void devm_extcon_unregister_notifier_all(struct device *dev,

				struct extcon_dev *edev,

drivers/extcon/extcon.c

+134 −140

File changed.

Preview size limit exceeded, changes collapsed.

include/linux/extcon.h

+32 −40

File changed.

Preview size limit exceeded, changes collapsed.

CRA Git | Maintained and supported by SUSTech CRA and CCSE