Skip to content

Commit 185e6a7

Browse files
committed
Documentation updates.
1 parent 59c98e3 commit 185e6a7

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This library provides a low-level facility for context switching between multipl
44

55
The low level context switching facility consists of a data type (`avr_context_t`), functions (`avr_getcontext()`, `avr_setcontext()`, `avr_makecontext()`, `avr_swapcontext()`), and macros (`AVR_SAVE_CONTEXT`, `AVR_RESTORE_CONTEXT`, `AVR_SAVE_CONTEXT_GLOBAL_POINTER`, `AVR_RESTORE_CONTEXT_GLOBAL_POINTER`). It is safe to say that this facility provifes implementations (or, rather, substitutes) for `getcontext()`, `setcontext()`, `makecontext()`, and `swapcontext()` which are available on the UNIX-like systems.
66

7-
The asymmetric stackful coroutines facility consists of a data type (`avr_corot_t`), and four functions (`avr_coro_init()`, `avr_coro_resume()`, `avr_coro_yield()`, `avr_coro_state()`). This functionality is implemented on top of the context switching facility.
7+
The asymmetric stackful coroutines facility consists of a data type (`avr_corot_t`), and four functions (`avr_coro_init()`, `avr_coro_resume()`, `avr_coro_yield()`, `avr_coro_state()`). This functionality is implemented on top of the context switching facility. This facility semantics closely follows the semantics of asymmetric stackful coroutines described in the paper ["Ana Lucia De Moura, Roberto Ierusalimschy - Revisiting Coroutines"](http://www.inf.puc-rio.br/~roberto/docs/MCC15-04.pdf).
88

99
One can use the provided functionality in many creative ways. For example, on top of this one can implement:
1010

@@ -438,6 +438,7 @@ Consumed: 10
438438
4. [The Open Group Base Specifications Issue 6: getcontext, setcontext - get and set current user context](https://pubs.opengroup.org/onlinepubs/009695399/functions/getcontext.html)
439439
5. [The Open Group Base Specifications Issue 6: makecontext, swapcontext - manipulate user contexts](https://pubs.opengroup.org/onlinepubs/009695399/functions/makecontext.html)
440440
6. [Ana Lucia De Moura, Roberto Ierusalimschy - Revisiting Coroutines, ACM Transactions on Programming Languages and Systems 31(2), July 2004](http://www.inf.puc-rio.br/~roberto/docs/MCC15-04.pdf)
441+
7. [AVR-GCC: Application Binary Interface](https://gcc.gnu.org/wiki/avr-gcc)
441442

442443
# Copyright
443444

0 commit comments

Comments
 (0)