diff options
| author | NIIBE Yutaka <gniibe@fsij.org> | 2016-05-18 16:52:00 +0900 |
|---|---|---|
| committer | NIIBE Yutaka <gniibe@fsij.org> | 2016-05-18 16:52:00 +0900 |
| commit | db413813b6cd8a0891805a1111824ffd4d5a3737 (patch) | |
| tree | c69366352fc31f9b7bc8953bed056a579caafae9 /doc | |
| parent | 7f009dbb5d44ae67d7bb3529973f2eee2e186612 (diff) | |
eventflag rewrite
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/chopstx-api.texi | 37 |
1 files changed, 23 insertions, 14 deletions
diff --git a/doc/chopstx-api.texi b/doc/chopstx-api.texi index 7c5f5a2..17b2de8 100644 --- a/doc/chopstx-api.texi +++ b/doc/chopstx-api.texi @@ -7,16 +7,6 @@ When it detects a coding error, this function will be called to stop further execution of code. It never returns. @end deftypefun -@subheading chopstx_main_init -@anchor{chopstx_main_init} -@deftypefun {void} {chopstx_main_init} (chopstx_prio_t @var{prio}) -@var{prio}: priority - -Initialize main thread with @var{prio}. -The thread main is created with priority CHX_PRIO_MAIN_INIT, -and it runs with that priority until this routine will is called. -@end deftypefun - @subheading chopstx_create @anchor{chopstx_create} @deftypefun {chopstx_t} {chopstx_create} (uint32_t @var{flags_and_prio}, uint32_t @var{stack_addr}, size_t @var{stack_size}, voidfunc @var{thread_entry}, void * @var{arg}) @@ -40,6 +30,8 @@ Create a thread. Returns thread ID. Sleep for micro seconds, specified by @var{var}. Another thread can clear @var{var} to stop the caller going into sleep. + +This function is DEPRECATED. Please use chopstx_poll. @end deftypefun @subheading chopstx_usec_wait @@ -150,10 +142,10 @@ clean-up will be executed. @deftypefun {void} {chopstx_exit} (void * @var{retval}) @var{retval}: Return value (to be caught by a joining thread) -Calling this function terminates the execution of thread, after -calling clean up functions. If the calling thread still holds -mutexes, they will be released. If the calling thread claiming -IRQ, it will be released, too. This function never returns. +Calling this function terminates the execution of running thread, +after calling clean up functions. If the calling thread still +holds mutexes, they will be released. This function never +returns. @end deftypefun @subheading chopstx_join @@ -174,6 +166,9 @@ Returns 0 on success, 1 when waiting is interrupted. Canceling the timer, wake up the sleeping thread. No return value. + +This function is DEPRECATED. Please use chopstx_cond_signal, +where sleeping process calls chopstx_poll. @end deftypefun @subheading chopstx_cancel @@ -214,3 +209,17 @@ Returns old state which is 0 when it was enabled. Returns number of active descriptors. @end deftypefun +@subheading chopstx_setpriority +@anchor{chopstx_setpriority} +@deftypefun {void} {chopstx_setpriority} (chopstx_prio_t @var{prio}) +@var{prio}: priority + +Change the schedule priority with @var{prio}. + +In general, it is not recommended to use this function because +dynamically changing schedule priorities complicates the system. +Only a possible valid usage of this function is in the main thread +which starts its execution with priority of CHX_PRIO_MAIN_INIT, and +let it change its priority after initialization of other threads. +@end deftypefun + |