Message-Id: <200908192357.31358.rjw@sisk.pl>
Date:	Wed, 19 Aug 2009 23:57:31 +0200
From:	"Rafael J. Wysocki" <rjw@...k.pl>
To:	Alan Stern <stern@...land.harvard.edu>, Greg KH <gregkh@...e.de>,
	Randy Dunlap <randy.dunlap@...cle.com>
Cc:	"linux-pm" <linux-pm@...ts.linux-foundation.org>,
	"linux-acpi" <linux-acpi@...r.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
	Zhang Rui <rui.zhang@...el.com>, Len Brown <lenb@...nel.org>,
	Arjan van de Ven <arjan@...ux.intel.com>
Subject: Re: [RFC][PATCH 1/7] PM: Update kerneldoc comments in drivers/base/power/main.c

On Monday 17 August 2009, Rafael J. Wysocki wrote:
> From: Rafael J. Wysocki <rjw@...k.pl>
> Subject: PM: Update kerneldoc comments in drivers/base/power/main.c
> 
> The kerneldoc comments in drivers/base/power/main.c are generally
> outdated and some of them don't describe the functions very
> accurately.  Update them and standardize the format to use spaces
> instead of tabs.
> 
> Signed-off-by: Rafael J. Wysocki <rjw@...k.pl>

Any objections to this patch from anyone?  Greg, Alan, Randy?

Best,
Rafael


> ---
>  drivers/base/power/main.c |  169 ++++++++++++++++++++++------------------------
>  1 file changed, 84 insertions(+), 85 deletions(-)
> 
> Index: linux-2.6/drivers/base/power/main.c
> ===================================================================
> --- linux-2.6.orig/drivers/base/power/main.c
> +++ linux-2.6/drivers/base/power/main.c
> @@ -50,7 +50,7 @@ static DEFINE_MUTEX(dpm_list_mtx);
>  static bool transition_started;
>  
>  /**
> - * device_pm_init - Initialize the PM-related part of a device object
> + * device_pm_init - Initialize the PM-related part of a device object.
>   * @dev: Device object being initialized.
>   */
>  void device_pm_init(struct device *dev)
> @@ -61,7 +61,7 @@ void device_pm_init(struct device *dev)
>  }
>  
>  /**
> - *	device_pm_lock - lock the list of active devices used by the PM core
> + * device_pm_lock - Lock the list of active devices used by the PM core.
>   */
>  void device_pm_lock(void)
>  {
> @@ -69,7 +69,7 @@ void device_pm_lock(void)
>  }
>  
>  /**
> - *	device_pm_unlock - unlock the list of active devices used by the PM core
> + * device_pm_unlock - Unlock the list of active devices used by the PM core.
>   */
>  void device_pm_unlock(void)
>  {
> @@ -77,8 +77,8 @@ void device_pm_unlock(void)
>  }
>  
>  /**
> - *	device_pm_add - add a device to the list of active devices
> - *	@dev:	Device to be added to the list
> + * device_pm_add - Add a device to the PM core's list of active devices.
> + * @dev: Device to add to the list.
>   */
>  void device_pm_add(struct device *dev)
>  {
> @@ -104,10 +104,8 @@ void device_pm_add(struct device *dev)
>  }
>  
>  /**
> - *	device_pm_remove - remove a device from the list of active devices
> - *	@dev:	Device to be removed from the list
> - *
> - *	This function also removes the device's PM-related sysfs attributes.
> + * device_pm_remove - Remove a device from the PM core's list of active devices.
> + * @dev: Device to be removed from the list.
>   */
>  void device_pm_remove(struct device *dev)
>  {
> @@ -121,9 +119,9 @@ void device_pm_remove(struct device *dev
>  }
>  
>  /**
> - *	device_pm_move_before - move device in dpm_list
> - *	@deva:  Device to move in dpm_list
> - *	@devb:  Device @deva should come before
> + * device_pm_move_before - Move device in the PM core's list of active devices.
> + * @deva: Device to move in dpm_list.
> + * @devb: Device @deva should come before.
>   */
>  void device_pm_move_before(struct device *deva, struct device *devb)
>  {
> @@ -137,9 +135,9 @@ void device_pm_move_before(struct device
>  }
>  
>  /**
> - *	device_pm_move_after - move device in dpm_list
> - *	@deva:  Device to move in dpm_list
> - *	@devb:  Device @deva should come after
> + * device_pm_move_after - Move device in the PM core's list of active devices.
> + * @deva: Device to move in dpm_list.
> + * @devb: Device @deva should come after.
>   */
>  void device_pm_move_after(struct device *deva, struct device *devb)
>  {
> @@ -153,8 +151,8 @@ void device_pm_move_after(struct device 
>  }
>  
>  /**
> - * 	device_pm_move_last - move device to end of dpm_list
> - * 	@dev:   Device to move in dpm_list
> + * device_pm_move_last - Move device to end of the PM core's list of devices.
> + * @dev: Device to move in dpm_list.
>   */
>  void device_pm_move_last(struct device *dev)
>  {
> @@ -165,10 +163,10 @@ void device_pm_move_last(struct device *
>  }
>  
>  /**
> - *	pm_op - execute the PM operation appropiate for given PM event
> - *	@dev:	Device.
> - *	@ops:	PM operations to choose from.
> - *	@state:	PM transition of the system being carried out.
> + * pm_op - Execute the PM operation appropiate for given PM event.
> + * @dev: Device to handle.
> + * @ops: PM operations to choose from.
> + * @state: PM transition of the system being carried out.
>   */
>  static int pm_op(struct device *dev,
>  		 const struct dev_pm_ops *ops,
> @@ -226,13 +224,13 @@ static int pm_op(struct device *dev,
>  }
>  
>  /**
> - *	pm_noirq_op - execute the PM operation appropiate for given PM event
> - *	@dev:	Device.
> - *	@ops:	PM operations to choose from.
> - *	@state: PM transition of the system being carried out.
> + * pm_noirq_op - Execute the PM operation appropiate for given PM event.
> + * @dev: Device to handle.
> + * @ops: PM operations to choose from.
> + * @state: PM transition of the system being carried out.
>   *
> - *	The operation is executed with interrupts disabled by the only remaining
> - *	functional CPU in the system.
> + * The driver of @dev will not receive interrupts while this fuction is being
> + * executed.
>   */
>  static int pm_noirq_op(struct device *dev,
>  			const struct dev_pm_ops *ops,
> @@ -330,11 +328,12 @@ static void pm_dev_err(struct device *de
>  /*------------------------- Resume routines -------------------------*/
>  
>  /**
> - *	device_resume_noirq - Power on one device (early resume).
> - *	@dev:	Device.
> - *	@state: PM transition of the system being carried out.
> + * device_resume_noirq - Execute an "early resume" callback for given device.
> + * @dev: Device to handle.
> + * @state: PM transition of the system being carried out.
>   *
> - *	Must be called with interrupts disabled.
> + * The driver of @dev will not receive interrupts while this fuction is being
> + * executed.
>   */
>  static int device_resume_noirq(struct device *dev, pm_message_t state)
>  {
> @@ -356,14 +355,11 @@ static int device_resume_noirq(struct de
>  }
>  
>  /**
> - *	dpm_resume_noirq - Power on all regular (non-sysdev) devices.
> - *	@state: PM transition of the system being carried out.
> - *
> - *	Call the "noirq" resume handlers for all devices marked as
> - *	DPM_OFF_IRQ and enable device drivers to receive interrupts.
> + * dpm_resume_noirq - Execute "early resume" callbacks for non-sysdev devices.
> + * @state: PM transition of the system being carried out.
>   *
> - *	Must be called under dpm_list_mtx.  Device drivers should not receive
> - *	interrupts while it's being executed.
> + * Call the "noirq" resume handlers for all devices marked as DPM_OFF_IRQ and
> + * enable device drivers to receive interrupts.
>   */
>  void dpm_resume_noirq(pm_message_t state)
>  {
> @@ -385,9 +381,9 @@ void dpm_resume_noirq(pm_message_t state
>  EXPORT_SYMBOL_GPL(dpm_resume_noirq);
>  
>  /**
> - *	device_resume - Restore state for one device.
> - *	@dev:	Device.
> - *	@state: PM transition of the system being carried out.
> + * device_resume - Execute "resume" callbacks for given device.
> + * @dev: Device to handle.
> + * @state: PM transition of the system being carried out.
>   */
>  static int device_resume(struct device *dev, pm_message_t state)
>  {
> @@ -436,11 +432,11 @@ static int device_resume(struct device *
>  }
>  
>  /**
> - *	dpm_resume - Resume every device.
> - *	@state: PM transition of the system being carried out.
> + * dpm_resume - Execute "resume" callbacks for non-sysdev devices.
> + * @state: PM transition of the system being carried out.
>   *
> - *	Execute the appropriate "resume" callback for all devices the status of
> - *	which indicates that they are inactive.
> + * Execute the appropriate "resume" callback for all devices the status of which
> + * indicates that they are suspended.
>   */
>  static void dpm_resume(pm_message_t state)
>  {
> @@ -477,9 +473,9 @@ static void dpm_resume(pm_message_t stat
>  }
>  
>  /**
> - *	device_complete - Complete a PM transition for given device
> - *	@dev:	Device.
> - *	@state: PM transition of the system being carried out.
> + * device_complete - Complete a PM transition for given device.
> + * @dev: Device to handle.
> + * @state: PM transition of the system being carried out.
>   */
>  static void device_complete(struct device *dev, pm_message_t state)
>  {
> @@ -504,11 +500,11 @@ static void device_complete(struct devic
>  }
>  
>  /**
> - *	dpm_complete - Complete a PM transition for all devices.
> - *	@state: PM transition of the system being carried out.
> + * dpm_complete - Complete a PM transition for all non-sysdev devices.
> + * @state: PM transition of the system being carried out.
>   *
> - *	Execute the ->complete() callbacks for all devices that are not marked
> - *	as DPM_ON.
> + * Execute the ->complete() callbacks for all devices the PM status of which is
> + * not DPM_ON (this allows new devices to be registered).
>   */
>  static void dpm_complete(pm_message_t state)
>  {
> @@ -538,11 +534,11 @@ static void dpm_complete(pm_message_t st
>  }
>  
>  /**
> - *	dpm_resume_end - Restore state of each device in system.
> - *	@state: PM transition of the system being carried out.
> + * dpm_resume_end - Execute "resume" callbacks and complete system transition.
> + * @state: PM transition of the system being carried out.
>   *
> - *	Resume all the devices, unlock them all, and allow new
> - *	devices to be registered once again.
> + * Resume all the devices, unlock them all, and complete the PM transition of
> + * the system.
>   */
>  void dpm_resume_end(pm_message_t state)
>  {
> @@ -556,9 +552,11 @@ EXPORT_SYMBOL_GPL(dpm_resume_end);
>  /*------------------------- Suspend routines -------------------------*/
>  
>  /**
> - *	resume_event - return a PM message representing the resume event
> - *	               corresponding to given sleep state.
> - *	@sleep_state: PM message representing a sleep state.
> + * resume_event - Return a "resume" message for given "suspend" sleep state.
> + * @sleep_state: PM message representing a sleep state.
> + *
> + * Return a PM message representing the resume event corresponding to given
> + * sleep state.
>   */
>  static pm_message_t resume_event(pm_message_t sleep_state)
>  {
> @@ -575,11 +573,12 @@ static pm_message_t resume_event(pm_mess
>  }
>  
>  /**
> - *	device_suspend_noirq - Shut down one device (late suspend).
> - *	@dev:	Device.
> - *	@state: PM transition of the system being carried out.
> + * device_suspend_noirq - Execute a "late suspend" callback for given device.
> + * @dev: Device to handle.
> + * @state: PM transition of the system being carried out.
>   *
> - *	This is called with interrupts off and only a single CPU running.
> + * The driver of @dev will not receive interrupts while this fuction is being
> + * executed.
>   */
>  static int device_suspend_noirq(struct device *dev, pm_message_t state)
>  {
> @@ -596,13 +595,11 @@ static int device_suspend_noirq(struct d
>  }
>  
>  /**
> - *	dpm_suspend_noirq - Power down all regular (non-sysdev) devices.
> - *	@state: PM transition of the system being carried out.
> + * dpm_suspend_noirq - Execute "late suspend" callbacks for non-sysdev devices.
> + * @state: PM transition of the system being carried out.
>   *
> - *	Prevent device drivers from receiving interrupts and call the "noirq"
> - *	suspend handlers.
> - *
> - *	Must be called under dpm_list_mtx.
> + * Prevent device drivers from receiving interrupts and call the "noirq" suspend
> + * handlers for all non-sysdev devices.
>   */
>  int dpm_suspend_noirq(pm_message_t state)
>  {
> @@ -627,9 +624,9 @@ int dpm_suspend_noirq(pm_message_t state
>  EXPORT_SYMBOL_GPL(dpm_suspend_noirq);
>  
>  /**
> - *	device_suspend - Save state of one device.
> - *	@dev:	Device.
> - *	@state: PM transition of the system being carried out.
> + * device_suspend - Execute "suspend" callbacks for given device.
> + * @dev: Device to handle.
> + * @state: PM transition of the system being carried out.
>   */
>  static int device_suspend(struct device *dev, pm_message_t state)
>  {
> @@ -676,10 +673,8 @@ static int device_suspend(struct device 
>  }
>  
>  /**
> - *	dpm_suspend - Suspend every device.
> - *	@state: PM transition of the system being carried out.
> - *
> - *	Execute the appropriate "suspend" callbacks for all devices.
> + * dpm_suspend - Execute "suspend" callbacks for all non-sysdev devices.
> + * @state: PM transition of the system being carried out.
>   */
>  static int dpm_suspend(pm_message_t state)
>  {
> @@ -713,9 +708,12 @@ static int dpm_suspend(pm_message_t stat
>  }
>  
>  /**
> - *	device_prepare - Execute the ->prepare() callback(s) for given device.
> - *	@dev:	Device.
> - *	@state: PM transition of the system being carried out.
> + * device_prepare - Prepare a device for system power transition.
> + * @dev: Device to handle.
> + * @state: PM transition of the system being carried out.
> + *
> + * Execute the ->prepare() callback(s) for given device.  No new children of the
> + * device may be registered after this function has returned.
>   */
>  static int device_prepare(struct device *dev, pm_message_t state)
>  {
> @@ -751,10 +749,10 @@ static int device_prepare(struct device 
>  }
>  
>  /**
> - *	dpm_prepare - Prepare all devices for a PM transition.
> - *	@state: PM transition of the system being carried out.
> + * dpm_prepare - Prepare all non-sysdev devices for a system PM transition.
> + * @state: PM transition of the system being carried out.
>   *
> - *	Execute the ->prepare() callback for all devices.
> + * Execute the ->prepare() callback(s) for all devices.
>   */
>  static int dpm_prepare(pm_message_t state)
>  {
> @@ -805,10 +803,11 @@ static int dpm_prepare(pm_message_t stat
>  }
>  
>  /**
> - *	dpm_suspend_start - Save state and stop all devices in system.
> - *	@state: PM transition of the system being carried out.
> + * dpm_suspend_start - Prepare devices for PM transition and suspend them.
> + * @state: PM transition of the system being carried out.
>   *
> - *	Prepare and suspend all devices.
> + * Prepare all non-sysdev devices for system PM transition and execute "suspend"
> + * callbacks for them.
>   */
>  int dpm_suspend_start(pm_message_t state)
>  {
> --
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/

Powered by blists - more mailing lists