Documentation: Add timers/timers-howto.txt
authorPatrick Pannuto <ppannuto@codeaurora.org>
Mon, 2 Aug 2010 22:01:05 +0000 (15:01 -0700)
committerThomas Gleixner <tglx@linutronix.de>
Wed, 4 Aug 2010 09:00:45 +0000 (11:00 +0200)
commit0fcb80818bc3ade5befd409051089f710adcf7b0
tree697c264a996c5cfb1360d1d59e495c5c459e8dd0
parent5e7f5a178bba45c5aca3448fddecabd4e28f1f6b
Documentation: Add timers/timers-howto.txt

This file seeks to explain the nuances in various delays;
many driver writers are not necessarily familiar with the
various kernel timers, their shortfalls, and quirks. When
faced with

ndelay, udelay, mdelay, usleep_range, msleep, and msleep_interrubtible

the question "How do I just wait 1 ms for my hardware to
latch?" has the non-intuitive "best" answer:
usleep_range(1000,1500)

This patch is followed by a series of checkpatch additions
that seek to help kernel hackers pick the best delay.

Signed-off-by: Patrick Pannuto <ppannuto@codeaurora.org>
Cc: apw@canonical.com
Cc: corbet@lwn.net
Cc: arjan@linux.intel.com
Cc: Randy Dunlap <rdunlap@xenotime.net>
Cc: Andrew Morton <akpm@linux-foundation.org>
LKML-Reference: <1280786467-26999-3-git-send-email-ppannuto@codeaurora.org>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Documentation/timers/timers-howto.txt [new file with mode: 0644]