zephyr/doc/kernel
Peter Mitsis d63a4f7bf7 nano_timers: Simplify nano_xxx_timer_test() API family
Simplifies the nanokernel timer API so that the timeout parameter must be
specified when invoking nano_isr_timer_test(), nano_fiber_timer_test(),
nano_task_timer_test() and nano_timer_test().

This obsoletes the following APIs:
	nano_fiber_timer_wait()
	nano_task_timer_wait()
	nano_timer_wait()

Note that even the though the new API requires that the timeout parameter
be specified, there are currentl only two acceptable values:
	TICKS_NONE and TICKS_UNLIMITED

Theoretically, the current implementation would allow one to supply a
finite positive value for the timeout and the system would wait up to
that many ticks for the timer to expire. However, it is thought that
that unnecessarily complicates the nanokernel timer model and so it is
left as an unsupported option.  Should that change, then that feature
could be enabled by updating the documentation.

Change-Id: I8835c5342ab5025d6f70fdfbed54a50add7568d7
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:25:15 -05:00
..
common update documentation to use boards where applicable 2016-02-05 20:25:11 -05:00
devices device: Provide generic API to handle synchronous calls in drivers 2016-02-05 20:24:57 -05:00
microkernel fifo: Simplify task_fifo_get() API family 2016-02-05 20:25:06 -05:00
nanokernel nano_timers: Simplify nano_xxx_timer_test() API family 2016-02-05 20:25:15 -05:00
networking Bluetooth: Rename LE scan & advertising APIs for consistency 2016-02-05 20:25:00 -05:00
overview update documentation to use boards where applicable 2016-02-05 20:25:11 -05:00
kernel.rst device: Provide generic API to handle synchronous calls in drivers 2016-02-05 20:24:57 -05:00