Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b1b73d09 authored by Kusanagi Kouichi's avatar Kusanagi Kouichi Committed by Ingo Molnar
Browse files

time/clocksource: Fix kernel-doc warnings 



Fix various KernelDoc build warnings.

Signed-off-by: default avatarKusanagi Kouichi <slash@ac.auone-net.jp>
Cc: John Stultz <johnstul@us.ibm.com>
Link: http://lkml.kernel.org/r/20111219091320.0D5AF6FC03D@msa105.auone-net.jp


Signed-off-by: default avatarIngo Molnar <mingo@elte.hu>
parent c3b79770

include/linux/clocksource.h

+8 −3
Original line number Diff line number Diff line
@@ -71,7 +71,7 @@ struct timecounter { 


/**

 * cyclecounter_cyc2ns - converts cycle counter cycles to nanoseconds

 * @tc:		Pointer to cycle counter.

 * @cc:		Pointer to cycle counter.

 * @cycles:	Cycles

 *

 * XXX - This could use some mult_lxl_ll() asm optimization. Same code
@@ -114,7 +114,7 @@ extern u64 timecounter_read(struct timecounter *tc); 
 *                        time base as values returned by

 *                        timecounter_read()

 * @tc:		Pointer to time counter.

 * @cycle:	a value returned by tc->cc->read()

 * @cycle_tstamp:	a value returned by tc->cc->read()

 *

 * Cycle counts that are converted correctly as long as they

 * fall into the interval [-1/2 max cycle count, +1/2 max cycle count],
@@ -156,11 +156,12 @@ extern u64 timecounter_cyc2time(struct timecounter *tc, 
 * @mult:		cycle to nanosecond multiplier

 * @shift:		cycle to nanosecond divisor (power of two)

 * @max_idle_ns:	max idle time permitted by the clocksource (nsecs)

 * @maxadj		maximum adjustment value to mult (~11%)

 * @maxadj:		maximum adjustment value to mult (~11%)

 * @flags:		flags describing special properties

 * @archdata:		arch-specific data

 * @suspend:		suspend function for the clocksource, if necessary

 * @resume:		resume function for the clocksource, if necessary

 * @cycle_last:		most recent cycle counter value seen by ::read()

 */

struct clocksource {

	/*
@@ -187,6 +188,7 @@ struct clocksource { 
	void (*suspend)(struct clocksource *cs);

	void (*resume)(struct clocksource *cs);



	/* private: */

#ifdef CONFIG_CLOCKSOURCE_WATCHDOG

	/* Watchdog related data, used by the framework */

	struct list_head wd_list;
@@ -261,6 +263,9 @@ static inline u32 clocksource_hz2mult(u32 hz, u32 shift_constant) 


/**

 * clocksource_cyc2ns - converts clocksource cycles to nanoseconds

 * @cycles:	cycles

 * @mult:	cycle to nanosecond multiplier

 * @shift:	cycle to nanosecond divisor (power of two)

 *

 * Converts cycles to nanoseconds, using the given mult and shift.

 *

kernel/time/clocksource.c

+9 −3
Original line number Diff line number Diff line
@@ -647,7 +647,7 @@ static void clocksource_enqueue(struct clocksource *cs) 


/**

 * __clocksource_updatefreq_scale - Used update clocksource with new freq

 * @t:		clocksource to be registered

 * @cs:		clocksource to be registered

 * @scale:	Scale factor multiplied against freq to get clocksource hz

 * @freq:	clocksource frequency (cycles per second) divided by scale

 *
@@ -699,7 +699,7 @@ EXPORT_SYMBOL_GPL(__clocksource_updatefreq_scale); 


/**

 * __clocksource_register_scale - Used to install new clocksources

 * @t:		clocksource to be registered

 * @cs:		clocksource to be registered

 * @scale:	Scale factor multiplied against freq to get clocksource hz

 * @freq:	clocksource frequency (cycles per second) divided by scale

 *
@@ -727,7 +727,7 @@ EXPORT_SYMBOL_GPL(__clocksource_register_scale); 


/**

 * clocksource_register - Used to install new clocksources

 * @t:		clocksource to be registered

 * @cs:		clocksource to be registered

 *

 * Returns -EBUSY if registration fails, zero otherwise.

 */
@@ -761,6 +761,8 @@ static void __clocksource_change_rating(struct clocksource *cs, int rating) 


/**

 * clocksource_change_rating - Change the rating of a registered clocksource

 * @cs:		clocksource to be changed

 * @rating:	new rating

 */

void clocksource_change_rating(struct clocksource *cs, int rating)

{
@@ -772,6 +774,7 @@ EXPORT_SYMBOL(clocksource_change_rating); 


/**

 * clocksource_unregister - remove a registered clocksource

 * @cs:	clocksource to be unregistered

 */

void clocksource_unregister(struct clocksource *cs)

{
@@ -787,6 +790,7 @@ EXPORT_SYMBOL(clocksource_unregister); 
/**

 * sysfs_show_current_clocksources - sysfs interface for current clocksource

 * @dev:	unused

 * @attr:	unused

 * @buf:	char buffer to be filled with clocksource list

 *

 * Provides sysfs interface for listing current clocksource.
@@ -807,6 +811,7 @@ sysfs_show_current_clocksources(struct sys_device *dev, 
/**

 * sysfs_override_clocksource - interface for manually overriding clocksource

 * @dev:	unused

 * @attr:	unused

 * @buf:	name of override clocksource

 * @count:	length of buffer

 *
@@ -842,6 +847,7 @@ static ssize_t sysfs_override_clocksource(struct sys_device *dev, 
/**

 * sysfs_show_available_clocksources - sysfs interface for listing clocksource

 * @dev:	unused

 * @attr:	unused

 * @buf:	char buffer to be filled with clocksource list

 *

 * Provides sysfs interface for listing registered clocksources