aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNIIBE Yutaka <gniibe@fsij.org>2016-04-22 13:42:01 +0900
committerNIIBE Yutaka <gniibe@fsij.org>2016-04-22 13:42:01 +0900
commit1b12a780548cff613e9eaa5cdef0e4a9429441cb (patch)
tree81289093481837da3064036ddc589071b6401dbf /doc
parent5d40ffbffad4b3f102a6d4cf975d7a49a6dcdb92 (diff)
Modify chopstx_poll API
Diffstat (limited to 'doc')
-rw-r--r--doc/chopstx-api.texi10
-rw-r--r--doc/chopstx.texi4
2 files changed, 12 insertions, 2 deletions
diff --git a/doc/chopstx-api.texi b/doc/chopstx-api.texi
index 6ccf6d8..72f2553 100644
--- a/doc/chopstx-api.texi
+++ b/doc/chopstx-api.texi
@@ -209,3 +209,13 @@ Calling chopstx_setcancelstate sets cancelability state.
Returns old state which is 0 when it was enabled.
@end deftypefun
+@subheading chopstx_poll
+@anchor{chopstx_poll}
+@deftypefun {int} {chopstx_poll} (uint32_t * @var{usec_p}, int @var{n}, @var{...})
+@var{usec_p}: Pointer to usec
+
+@var{n}: Number of poll descriptors
+
+Returns number of active descriptors.
+@end deftypefun
+
diff --git a/doc/chopstx.texi b/doc/chopstx.texi
index e1db02c..bb42256 100644
--- a/doc/chopstx.texi
+++ b/doc/chopstx.texi
@@ -11,7 +11,7 @@
This manual is for Chopstx (version @value{VERSION}).
@noindent
-Copyright @copyright{} 2013, 2015 Flying Stone Technology @*
+Copyright @copyright{} 2013, 2015, 2016 Flying Stone Technology @*
@quotation
Permission is granted to copy, distribute and/or modify this document
@@ -84,7 +84,7 @@ Indexes
@chapter Introduction
Chopstx is an RT thread library for ARM Cortex-M0 and Cortex-M3.
-Specifically, it is used for STM32F030 and STM32F103.
+Specifically, it is used for STM32F030, STM32F103, and MKL27Z.
While most RTOSes come with many features, drivers, and stacks,
Chopstx just offers a RT thread library.