Commit d6b87eaf authored by Anna-Maria Gleixner's avatar Anna-Maria Gleixner Committed by Thomas Gleixner
Browse files

tick/sched: Update tick_sched struct documentation 



Adapt the documentation order of struct members to the effective order of
struct members and add missing descriptions.

Signed-off-by: default avatarAnna-Maria Gleixner <anna-maria@linutronix.de>
Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
Cc: fweisbec@gmail.com
Cc: peterz@infradead.org
Link: https://lkml.kernel.org/r/20190321120921.16463-2-anna-maria@linutronix.de
parent 1b72d432

kernel/time/tick-sched.h

+10 −3
Original line number Diff line number Diff line
@@ -24,12 +24,19 @@ enum tick_nohz_mode { 
 * struct tick_sched - sched tick emulation and no idle tick control/stats

 * @sched_timer:	hrtimer to schedule the periodic tick in high

 *			resolution mode

 * @check_clocks:	Notification mechanism about clocksource changes

 * @nohz_mode:		Mode - one state of tick_nohz_mode

 * @inidle:		Indicator that the CPU is in the tick idle mode

 * @tick_stopped:	Indicator that the idle tick has been stopped

 * @idle_active:	Indicator that the CPU is actively in the tick idle mode;

 *			it is resetted during irq handling phases.

 * @do_timer_lst:	CPU was the last one doing do_timer before going idle

 * @got_idle_tick:	Tick timer function has run with @inidle set

 * @last_tick:		Store the last tick expiry time when the tick

 *			timer is modified for nohz sleeps. This is necessary

 *			to resume the tick timer operation in the timeline

 *			when the CPU returns from nohz sleep.

 * @next_tick:		Next tick to be fired when in dynticks mode.

 * @tick_stopped:	Indicator that the idle tick has been stopped

 * @idle_jiffies:	jiffies at the entry to idle for idle time accounting

 * @idle_calls:		Total number of idle calls

 * @idle_sleeps:	Number of idle calls, where the sched tick was stopped
@@ -40,8 +47,8 @@ enum tick_nohz_mode { 
 * @iowait_sleeptime:	Sum of the time slept in idle with sched tick stopped, with IO outstanding

 * @timer_expires:	Anticipated timer expiration time (in case sched tick is stopped)

 * @timer_expires_base:	Base time clock monotonic for @timer_expires

 * @do_timer_lst:	CPU was the last one doing do_timer before going idle

 * @got_idle_tick:	Tick timer function has run with @inidle set

 * @next_timer:		Expiry time of next expiring timer for debugging purpose only

 * @tick_dep_mask:	Tick dependency mask - is set, if someone needs the tick

 */

struct tick_sched {

	struct hrtimer			sched_timer;

CRA Git | Maintained and supported by SUSTech CRA and CCSE