Arnd Bergmann 0e3fd810c4
Documentation: document ktime_get_*() APIs ...
As Dave Chinner points out, we don't have a proper documentation for the
ktime_get() family of interfaces, making it rather unclear which of the
over 30 (!) interfaces one should actually use in a driver or elsewhere
in the kernel.
I wrote up an explanation from how I personally see the interfaces,
documenting what each of the functions do and hopefully making it a bit
clearer which should be used where.
This is the first time I tried writing .rst format documentation, so
in addition to any mistakes in the content, I probably also introduce
nonstandard formatting ;-)
I first tried to add an extra section to
Documentation/timers/timekeeping.txt, but this is currently not included
in the generated API, and it seems useful to have the API docs as part
of what gets generated in
https://www.kernel.org/doc/html/latest/core-api/index.html#core-utilities
instead, so I started a new file there.
I also considered adding the documentation inline in the
include/linux/timekeeping.h header, but couldn't figure out how to do
that in a way that would result both in helpful inline comments as
well as readable html output, so I settled for the latter, with
a small note pointing to it from the header.
Cc: Dave Chinner <david@fromorbit.com >
Cc: John Stultz <john.stultz@linaro.org >
Cc: Thomas Gleixner <tglx@linutronix.de >
Cc: Stephen Boyd <sboyd@kernel.org >
Tested-by: Randy Dunlap <rdunlap@infradead.org >
Reviewed-by: Randy Dunlap <rdunlap@infradead.org >
Reviewed-by: Linus Walleij <linus.walleij@linaro.org >
Signed-off-by: Arnd Bergmann <arnd@arndb.de >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2018-07-23 09:16:56 -06:00
2018-05-14 07:05:16 -07:00
2018-06-04 20:46:00 +02:00
2018-05-30 12:48:49 -07:00
2018-05-29 10:15:33 +05:30
2018-05-25 18:23:56 +02:00
2018-05-28 23:05:11 -04:00
2018-05-23 14:01:03 +02:00
2018-06-24 14:23:21 +01:00
2018-06-11 10:21:06 -07:00
2018-05-13 15:59:01 +02:00
2018-05-16 07:24:30 +02:00
2018-06-11 07:23:19 -07:00
2018-05-10 16:08:25 -04:00
2018-06-07 13:04:07 -07:00
2018-06-06 18:39:49 -07:00
2018-06-08 10:39:20 -07:00
2018-06-11 14:24:32 -07:00
2018-05-21 18:07:05 +01:00
2018-05-17 16:11:39 -04:00
2018-06-17 05:25:18 +09:00
2018-04-25 23:11:47 +02:00
2018-06-05 10:48:09 -04:00
2018-06-07 14:23:08 +01:00
2018-06-03 17:37:15 -07:00
2018-06-07 17:34:35 -07:00
2018-06-11 18:19:45 -07:00
2018-05-11 21:48:07 +05:30
2018-05-11 11:34:41 +09:00
2018-06-12 10:09:03 -07:00
2018-06-06 09:08:38 -07:00
2018-06-25 21:30:12 +08:00
2018-06-02 19:29:27 -05:00
2018-05-26 09:16:44 +02:00
2018-05-31 17:34:01 +01:00
2018-06-15 18:10:01 -03:00
2018-06-15 18:10:01 -03:00
2018-05-16 07:23:35 +02:00
2018-06-17 08:27:01 +09:00
2018-04-27 09:48:44 +02:00
2018-05-14 17:45:21 -04:00
2018-06-22 12:08:07 -06:00
2018-04-30 13:25:14 +01:00
2018-05-23 13:23:39 -04:00
2018-06-08 13:36:19 -07:00
2018-06-02 20:35:00 -06:00
2018-06-14 17:01:45 +02:00
2018-06-26 12:18:27 -06:00
2018-05-30 12:38:40 +02:00
2018-04-30 10:55:56 +02:00
2018-05-30 12:38:40 +02:00
2018-05-26 19:46:15 -04:00
2018-05-28 17:41:02 +02:00
2018-06-15 23:47:15 +02:00
2018-05-23 13:23:40 -04:00
2018-06-05 09:43:09 -04:00
2018-05-29 13:00:25 -06:00
2018-05-29 13:00:25 -06:00
2018-05-09 17:25:13 +02:00
2018-06-01 18:37:33 -07:00
2018-06-05 18:06:24 +01:00
2018-04-26 14:29:05 -07:00
2018-04-26 14:29:05 -07:00
2018-06-15 18:10:01 -03:00
2018-06-09 12:06:24 -07:00
2018-06-25 23:21:13 +09:00
2018-06-25 23:21:12 +09:00
2018-05-31 16:41:41 -07:00
2018-06-25 23:21:12 +09:00
2018-05-31 16:41:41 -07:00
2018-06-04 17:28:20 -04:00
2018-05-14 16:19:59 +02:00
2018-05-14 08:57:47 +02:00
2018-05-03 13:55:47 +02:00
2018-05-23 10:37:08 +02:00
2018-05-30 23:13:00 +02:00
2018-05-14 13:46:04 -04:00
2018-06-28 11:16:44 -07:00
2018-05-11 15:36:37 -04:00
2018-04-27 14:34:51 +02:00
2018-05-22 23:18:31 -07:00
2018-06-06 17:27:14 -07:00
2018-06-14 08:50:37 +02:00
2018-05-08 13:02:42 +02:00
2018-05-19 08:46:12 +02:00
2018-05-03 12:38:39 +02:00
2018-05-13 15:59:00 +02:00
2018-05-28 12:48:25 +02:00
2018-05-19 08:46:12 +02:00
2018-05-14 08:57:48 +02:00
2018-06-01 07:38:16 -06:00
2018-04-27 11:53:02 -04:00
2018-05-17 22:44:57 +09:00
2018-06-21 12:46:06 +09:00
2018-05-14 16:44:41 +02:00
2018-06-28 10:40:47 -07:00
2018-06-11 10:16:13 -07:00
2018-06-11 10:16:13 -07:00
2018-05-18 14:58:22 +02:00
2018-06-15 18:10:01 -03:00
2018-04-26 09:02:01 -06:00
2018-06-07 17:34:38 -07:00
2018-07-02 11:25:47 -06:00
2018-06-08 10:25:50 +02:00
2018-06-07 17:34:37 -07:00
2018-05-18 21:51:37 +02:00
2018-04-26 14:53:32 +02:00
2018-05-24 12:04:32 -07:00
2018-06-10 13:01:12 -07:00
2018-05-22 13:42:16 +02:00
2018-06-04 10:58:12 -07:00
2018-05-25 14:37:20 -04:00
2018-06-03 11:00:52 -04:00
2018-05-29 10:12:45 -04:00
2018-05-15 16:34:52 +02:00
2018-05-14 11:25:28 +02:00
2018-06-01 18:37:33 -07:00
2018-05-09 06:55:44 +02:00
2018-06-04 14:20:39 -04:00
2018-05-09 12:21:46 -05:00
2018-05-14 11:25:27 +02:00
2018-04-26 22:26:39 +02:00
2018-06-22 14:22:00 +02:00
2018-06-22 14:22:02 +02:00
2018-05-13 15:59:00 +02:00
2018-05-14 13:46:04 -04:00
2018-06-15 07:55:24 +09:00
2018-06-21 17:39:18 +02:00
2018-06-07 17:34:36 -07:00
2018-05-03 07:38:05 +02:00
2018-06-01 19:18:26 +02:00
2018-06-10 13:01:12 -07:00
2018-06-01 07:43:53 -06:00
2018-06-13 00:03:17 +09:00
2018-05-04 12:48:54 -07:00
2018-06-05 08:50:16 -04:00
2018-06-15 07:55:25 +09:00
2018-06-07 17:34:35 -07:00
2018-06-07 17:34:36 -07:00
2018-06-21 16:14:45 +02:00
2018-05-14 13:14:23 -06:00
2018-06-08 17:21:52 -07:00
2018-06-07 17:34:37 -07:00
2018-06-12 16:19:22 -07:00
2018-06-18 13:43:09 +09:00
2018-06-07 17:34:39 -07:00
2018-06-05 12:26:41 -04:00
2018-05-13 15:58:59 +02:00
2018-05-15 08:11:15 +02:00
2018-06-15 15:27:09 +01:00
2018-06-28 10:40:47 -07:00
2018-05-23 14:48:44 -04:00
2018-06-05 12:42:19 -04:00
2018-06-12 19:12:43 +02:00
2018-05-31 15:03:11 -04:00
2018-06-19 09:25:27 -04:00
2018-05-25 18:12:11 -07:00
2018-05-05 00:51:44 +02:00
2018-05-30 10:11:34 +02:00
2018-05-14 16:27:08 +02:00
2018-06-01 14:37:35 +02:00
2018-05-14 16:20:48 +02:00
2018-05-02 08:31:07 -07:00
2018-05-03 16:25:08 +02:00
2018-05-30 11:35:13 -05:00
2018-05-11 17:28:45 -07:00
2018-06-05 12:16:51 -07:00
2018-06-07 17:34:36 -07:00
2018-06-07 17:34:37 -07:00
2018-06-04 12:08:06 -05:00
2018-06-06 16:10:45 -05:00
2018-05-30 11:35:23 -05:00
2018-05-15 15:51:38 +01:00
2018-05-18 16:40:50 +01:00
2018-06-07 12:45:58 -07:00
2018-05-16 11:45:16 +02:00
2018-06-06 18:39:49 -07:00
2018-06-07 17:34:35 -07:00
2018-05-24 15:35:58 -04:00
2018-05-09 11:51:46 +10:00
2018-05-30 15:33:32 -06:00
2018-05-03 16:22:18 +02:00
2018-06-25 09:41:37 +02:00
2018-05-09 10:15:21 +05:30
2018-06-12 10:24:13 +02:00
2018-06-28 10:40:47 -07:00
2018-05-24 18:14:27 +02:00
2018-05-18 11:46:15 +01:00
2018-05-17 12:47:21 +02:00
2018-05-31 00:13:56 +08:00
2018-06-05 16:57:31 -07:00
2018-04-30 10:50:44 +01:00
2018-05-11 17:28:45 -07:00
2018-05-11 17:28:45 -07:00
2018-06-15 18:10:01 -03:00
2018-05-31 14:59:19 -04:00
2018-06-10 06:14:01 +02:00
2018-05-22 16:12:26 -07:00
2018-05-22 16:12:26 -07:00
2018-06-12 23:33:25 +02:00
2018-05-25 18:35:59 +01:00
2018-04-25 16:43:55 -07:00
2018-06-04 17:28:20 -04:00
2018-06-05 10:33:35 -07:00
2018-06-03 17:37:11 -07:00
2018-05-16 21:08:42 +02:00
2018-05-16 11:45:16 +02:00
2018-05-24 11:00:39 -06:00
2018-06-29 08:48:06 -06:00
2018-06-22 19:04:22 +02:00
2018-05-10 10:49:40 +01:00
2018-05-05 00:51:44 +02:00
2018-05-04 12:48:54 -07:00
2018-05-16 07:24:30 +02:00
2018-04-30 05:14:55 -07:00
2018-06-07 17:34:35 -07:00
2018-04-26 19:51:14 -05:00
2018-05-17 12:46:54 -04:00
2018-06-28 10:40:47 -07:00
2018-06-07 17:34:34 -07:00
2018-06-15 07:55:23 +09:00
2018-06-28 11:16:44 -07:00
2018-05-03 15:55:23 -07:00
2018-05-05 11:41:58 -04:00
2018-06-12 23:33:24 +02:00
2018-05-15 10:27:56 -07:00
2018-05-30 10:11:34 +02:00
2018-05-30 10:11:34 +02:00
2018-06-14 12:21:18 +09:00
2018-06-05 16:57:31 -07:00
2018-05-15 21:47:09 +03:00
2018-05-15 08:32:42 +02:00
2018-04-28 15:01:14 -07:00
2018-06-04 17:45:38 -07:00
2018-06-25 23:21:13 +09:00
2018-05-18 11:40:27 -04:00
2018-05-30 14:46:17 +08:00
2018-05-25 12:27:53 +01:00
2018-05-19 13:57:31 +02:00
2018-05-19 13:57:31 +02:00
2018-04-26 14:53:32 +02:00
2018-05-19 13:57:32 +02:00
2018-07-23 09:16:56 -06:00
2018-04-29 08:45:53 -07:00
2018-06-06 18:39:49 -07:00
2018-06-15 18:10:01 -03:00
2018-05-16 07:24:30 +02:00
2018-06-05 16:14:12 -07:00
2018-06-07 17:34:38 -07:00
2018-05-07 23:25:24 -04:00
2018-04-26 15:08:04 -04:00
2018-05-14 16:16:35 +02:00
2018-05-22 23:17:03 -07:00
2018-05-23 13:23:39 -04:00
2018-05-31 12:48:17 +02:00
2018-06-07 17:34:38 -07:00
2018-06-07 16:15:38 -04:00
2018-06-07 20:54:23 +03:00
2018-06-05 12:16:51 -07:00
2018-05-03 09:25:47 -06:00
2018-05-18 08:47:13 -07:00
2018-05-14 09:51:34 -04:00
0e3fd810c4