aboutsummaryrefslogtreecommitdiffstats
path: root/kernel/posix-timers.c
diff options
context:
space:
mode:
authorRichard Cochran <richardcochran@gmail.com>2011-02-01 08:52:15 -0500
committerThomas Gleixner <tglx@linutronix.de>2011-02-02 09:28:18 -0500
commit0061748dd2400d0bcd4d49d258db5d7b5d106ca0 (patch)
tree493582797fa35bc282b44f47597e55c71f7735df /kernel/posix-timers.c
parentbc2c8ea483d73e95fc88f1fc9e7755180f89b892 (diff)
posix-timer: Update comment
Pick the cleanup to the comment in posix-timers.c from Richards all in one conversion patch. Originally-from: Richard Cochran <richardcochran@gmail.com> Signed-off-by: Thomas Gleixner <tglx@linutronix.de> Acked-by: John Stultz <johnstul@us.ibm.com> LKML-Reference: <20110201134419.487708516@linutronix.de>
Diffstat (limited to 'kernel/posix-timers.c')
-rw-r--r--kernel/posix-timers.c25
1 files changed, 7 insertions, 18 deletions
diff --git a/kernel/posix-timers.c b/kernel/posix-timers.c
index ad154dfd7c51..a3fdfd4be0ec 100644
--- a/kernel/posix-timers.c
+++ b/kernel/posix-timers.c
@@ -102,11 +102,7 @@ static DEFINE_SPINLOCK(idr_lock);
102/* 102/*
103 * CLOCKs: The POSIX standard calls for a couple of clocks and allows us 103 * CLOCKs: The POSIX standard calls for a couple of clocks and allows us
104 * to implement others. This structure defines the various 104 * to implement others. This structure defines the various
105 * clocks and allows the possibility of adding others. We 105 * clocks.
106 * provide an interface to add clocks to the table and expect
107 * the "arch" code to add at least one clock that is high
108 * resolution. Here we define the standard CLOCK_REALTIME as a
109 * 1/HZ resolution clock.
110 * 106 *
111 * RESOLUTION: Clock resolution is used to round up timer and interval 107 * RESOLUTION: Clock resolution is used to round up timer and interval
112 * times, NOT to report clock times, which are reported with as 108 * times, NOT to report clock times, which are reported with as
@@ -116,20 +112,13 @@ static DEFINE_SPINLOCK(idr_lock);
116 * necessary code is written. The standard says we should say 112 * necessary code is written. The standard says we should say
117 * something about this issue in the documentation... 113 * something about this issue in the documentation...
118 * 114 *
119 * FUNCTIONS: The CLOCKs structure defines possible functions to handle 115 * FUNCTIONS: The CLOCKs structure defines possible functions to
120 * various clock functions. For clocks that use the standard 116 * handle various clock functions.
121 * system timer code these entries should be NULL. This will
122 * allow dispatch without the overhead of indirect function
123 * calls. CLOCKS that depend on other sources (e.g. WWV or GPS)
124 * must supply functions here, even if the function just returns
125 * ENOSYS. The standard POSIX timer management code assumes the
126 * following: 1.) The k_itimer struct (sched.h) is used for the
127 * timer. 2.) The list, it_lock, it_clock, it_id and it_pid
128 * fields are not modified by timer code.
129 * 117 *
130 * At this time all functions EXCEPT clock_nanosleep can be 118 * The standard POSIX timer management code assumes the
131 * redirected by the CLOCKS structure. Clock_nanosleep is in 119 * following: 1.) The k_itimer struct (sched.h) is used for
132 * there, but the code ignores it. 120 * the timer. 2.) The list, it_lock, it_clock, it_id and
121 * it_pid fields are not modified by timer code.
133 * 122 *
134 * Permissions: It is assumed that the clock_settime() function defined 123 * Permissions: It is assumed that the clock_settime() function defined
135 * for each clock will take care of permission checks. Some 124 * for each clock will take care of permission checks. Some