diff options
| author | Joel Sherrill <joel.sherrill@OARcorp.com> | 2009-01-29 14:57:22 +0000 |
|---|---|---|
| committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 2009-01-29 14:57:22 +0000 |
| commit | 8d5038068e02766021fb2ad693572c392b158b4c (patch) | |
| tree | a1cbbce2f89b8d761e391b3f9b94b76f18a5636f /doc | |
| parent | 2009-01-29 Eric Norum <norume@aps.anl.gov> (diff) | |
| download | rtems-8d5038068e02766021fb2ad693572c392b158b4c.tar.bz2 | |
2009-01-29 Sebastian Huber <sebastian.huber@embedded-brains.de>
* bsp_howto/console.t: Clarify interrupt transmit process.
* user/concepts.t: Typo.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/bsp_howto/console.t | 10 | ||||
| -rw-r--r-- | doc/user/concepts.t | 6 |
3 files changed, 17 insertions, 4 deletions
diff --git a/doc/ChangeLog b/doc/ChangeLog index dab569d7ae..9fa9388ee2 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2009-01-29 Sebastian Huber <sebastian.huber@embedded-brains.de> + + * bsp_howto/console.t: Clarify interrupt transmit process. + * user/concepts.t: Typo. + 2008-12-19 Joel Sherrill <joel.sherrill@oarcorp.com> * index.html.in: Remove manuals that are dead. diff --git a/doc/bsp_howto/console.t b/doc/bsp_howto/console.t index d23b66a79f..c855e0e180 100644 --- a/doc/bsp_howto/console.t +++ b/doc/bsp_howto/console.t @@ -370,7 +370,15 @@ static void my_driver_interrupt_handler( The @code{my_driver_interrupt_write} function is responsible for telling the device that the @code{n} characters at @code{buf} are to be transmitted. The -return value may be arbitrary since it is not checked from Termios. +return value may be arbitrary since it is not checked from Termios. It is +guaranteed that @code{n} is greater than zero. This routine is invoked either +from task context with disabled interrupts to start a new transmission process +with exactly one character in case of an idle output state or from the +interrupt handler to refill the transmitter. If the routine is invoked to +start the transmit process the output state will become busy and Termios starts +to fill the output buffer. If the transmit interrupt arises before Termios was +able to fill the transmit buffer you will end up with one interrupt per +character. @example @group diff --git a/doc/user/concepts.t b/doc/user/concepts.t index eea77fdd4d..0d5ffab51e 100644 --- a/doc/user/concepts.t +++ b/doc/user/concepts.t @@ -85,9 +85,9 @@ approach would be to name them the binary values one through one-hundred, respectively. @ifset is-C -@findex rtems_get_object_name +@findex rtems_object_get_name -RTEMS provides a helper routine, @code{@value{DIRPREFIX}get_object_name}, +RTEMS provides a helper routine, @code{@value{DIRPREFIX}object_get_name}, which can be used to obtain the name of any RTEMS object using just its ID. This routine attempts to convert the name into a printable string. @@ -103,7 +103,7 @@ void print_name(rtems_id the_object) char buffer[10]; /* name assumed to be 10 characters or less */ char *result; - result = rtems_get_object_name( id, sizeof(buffer), buffer ); + result = rtems_object_get_name( id, sizeof(buffer), buffer ); printk( "ID=0x%08x name=%s\n", id, ((result) ? result : "no name") ); @} @end example |