rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-07-03 17:12:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

Change code to code-block.

Browse Source
This commit is contained in:
Chris Johns 2016-02-18 15:41:28 +11:00 committed by Amar Takhar
parent 00d1a0a1fb
commit 25d55d49c3
27 changed files with 213 additions and 267 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
c_user/barrier_manager.rst
View File

@ -164,7 +164,7 @@ BARRIER_CREATE - Create a barrier
.. index:: rtems_barrier_create .. index:: rtems_barrier_create
.. code:: c .. code-block:: c
rtems_status_code rtems_barrier_create( rtems_status_code rtems_barrier_create(
rtems_name name, rtems_name name,
@ -241,7 +241,7 @@ BARRIER_IDENT - Get ID of a barrier
.. index:: rtems_barrier_ident .. index:: rtems_barrier_ident
.. code:: c .. code-block:: c
rtems_status_code rtems_barrier_ident( rtems_status_code rtems_barrier_ident(
rtems_name name, rtems_name name,
@ -282,7 +282,7 @@ BARRIER_DELETE - Delete a barrier
.. index:: rtems_barrier_delete .. index:: rtems_barrier_delete
.. code:: c .. code-block:: c
rtems_status_code rtems_barrier_delete( rtems_status_code rtems_barrier_delete(
rtems_id id rtems_id id
@ -326,7 +326,7 @@ BARRIER_OBTAIN - Acquire a barrier
.. index:: rtems_barrier_wait .. index:: rtems_barrier_wait
.. code:: c .. code-block:: c
rtems_status_code rtems_barrier_wait( rtems_status_code rtems_barrier_wait(
rtems_id id, rtems_id id,
@ -398,7 +398,7 @@ BARRIER_RELEASE - Release a barrier
.. index:: rtems_barrier_release .. index:: rtems_barrier_release
.. code:: c .. code-block:: c
rtems_status_code rtems_barrier_release( rtems_status_code rtems_barrier_release(
rtems_id id, rtems_id id,

36
c_user/clock_manager.rst
View File

@ -70,7 +70,7 @@ and date format:
.. index:: rtems_time_of_day .. index:: rtems_time_of_day
.. code:: c .. code-block:: c
struct rtems_tod_control { struct rtems_tod_control {
uint32_t year; /* greater than 1987 */ uint32_t year; /* greater than 1987 */
@ -213,7 +213,7 @@ CLOCK_SET - Set date and time
.. index:: rtems_clock_set .. index:: rtems_clock_set
.. code:: c .. code-block:: c
rtems_status_code rtems_clock_set( rtems_status_code rtems_clock_set(
rtems_time_of_day *time_buffer rtems_time_of_day *time_buffer
@ -265,7 +265,7 @@ CLOCK_GET - Get date and time information
.. index:: rtems_clock_get .. index:: rtems_clock_get
.. code:: c .. code-block:: c
rtems_status_code rtems_clock_get( rtems_status_code rtems_clock_get(
rtems_clock_get_options option, rtems_clock_get_options option,
@ -333,7 +333,7 @@ CLOCK_GET_TOD - Get date and time in TOD format
.. index:: rtems_clock_get_tod .. index:: rtems_clock_get_tod
.. code:: c .. code-block:: c
rtems_status_code rtems_clock_get_tod( rtems_status_code rtems_clock_get_tod(
rtems_time_of_day *time_buffer rtems_time_of_day *time_buffer
@ -375,7 +375,7 @@ CLOCK_GET_TOD_TIMEVAL - Get date and time in timeval format
.. index:: rtems_clock_get_tod_timeval .. index:: rtems_clock_get_tod_timeval
.. code:: c .. code-block:: c
rtems_status_code rtems_clock_get_tod_interval( rtems_status_code rtems_clock_get_tod_interval(
struct timeval *time struct timeval *time
@ -417,7 +417,7 @@ CLOCK_GET_SECONDS_SINCE_EPOCH - Get seconds since epoch
.. index:: rtems_clock_get_seconds_since_epoch .. index:: rtems_clock_get_seconds_since_epoch
.. code:: c .. code-block:: c
rtems_status_code rtems_clock_get_seconds_since_epoch( rtems_status_code rtems_clock_get_seconds_since_epoch(
rtems_interval *the_interval rtems_interval *the_interval
@ -460,7 +460,7 @@ CLOCK_GET_TICKS_PER_SECOND - Get ticks per second
.. index:: rtems_clock_get_ticks_per_second .. index:: rtems_clock_get_ticks_per_second
.. code:: c .. code-block:: c
rtems_interval rtems_clock_get_ticks_per_second(void); rtems_interval rtems_clock_get_ticks_per_second(void);
@ -490,7 +490,7 @@ CLOCK_GET_TICKS_SINCE_BOOT - Get current ticks counter value
.. index:: rtems_clock_get_ticks_since_boot .. index:: rtems_clock_get_ticks_since_boot
.. code:: c .. code-block:: c
rtems_interval rtems_clock_get_ticks_since_boot(void); rtems_interval rtems_clock_get_ticks_since_boot(void);
@ -521,7 +521,7 @@ CLOCK_TICK_LATER - Get tick value in the future
.. index:: rtems_clock_tick_later .. index:: rtems_clock_tick_later
.. code:: c .. code-block:: c
rtems_interval rtems_clock_tick_later( rtems_interval rtems_clock_tick_later(
rtems_interval delta rtems_interval delta
@ -546,7 +546,7 @@ CLOCK_TICK_LATER_USEC - Get tick value in the future in microseconds
.. index:: rtems_clock_tick_later_usec .. index:: rtems_clock_tick_later_usec
.. code:: c .. code-block:: c
rtems_interval rtems_clock_tick_later_usec( rtems_interval rtems_clock_tick_later_usec(
rtems_interval delta_in_usec rtems_interval delta_in_usec
@ -571,7 +571,7 @@ CLOCK_TICK_BEFORE - Is tick value is before a point in time
.. index:: rtems_clock_tick_before .. index:: rtems_clock_tick_before
.. code:: c .. code-block:: c
rtems_interval rtems_clock_tick_before( rtems_interval rtems_clock_tick_before(
rtems_interval tick rtems_interval tick
@ -590,7 +590,7 @@ This directive will not cause the running task to be preempted.
**EXAMPLE:** **EXAMPLE:**
.. code:: c .. code-block:: c
status busy( void ) status busy( void )
{ {
@ -614,7 +614,7 @@ CLOCK_GET_UPTIME - Get the time since boot
.. index:: rtems_clock_get_uptime .. index:: rtems_clock_get_uptime
.. code:: c .. code-block:: c
rtems_status_code rtems_clock_get_uptime( rtems_status_code rtems_clock_get_uptime(
struct timespec *uptime struct timespec *uptime
@ -649,7 +649,7 @@ CLOCK_GET_UPTIME_TIMEVAL - Get the time since boot in timeval format
.. index:: rtems_clock_get_uptime_timeval .. index:: rtems_clock_get_uptime_timeval
.. code:: c .. code-block:: c
void rtems_clock_get_uptime_timeval( void rtems_clock_get_uptime_timeval(
struct timeval *uptime struct timeval *uptime
@ -680,7 +680,7 @@ CLOCK_GET_UPTIME_SECONDS - Get the seconds since boot
.. index:: rtems_clock_get_uptime_seconds .. index:: rtems_clock_get_uptime_seconds
.. code:: c .. code-block:: c
time_t rtems_clock_get_uptime_seconds(void); time_t rtems_clock_get_uptime_seconds(void);
@ -707,7 +707,7 @@ CLOCK_GET_UPTIME_NANOSECONDS - Get the nanoseconds since boot
.. index:: rtems_clock_get_uptime_nanoseconds .. index:: rtems_clock_get_uptime_nanoseconds
.. code:: c .. code-block:: c
uint64_t rtems_clock_get_uptime_nanoseconds(void); uint64_t rtems_clock_get_uptime_nanoseconds(void);
@ -735,7 +735,7 @@ CLOCK_SET_NANOSECONDS_EXTENSION - Install the nanoseconds since last tick handle
.. index:: rtems_clock_set_nanoseconds_extension .. index:: rtems_clock_set_nanoseconds_extension
.. code:: c .. code-block:: c
rtems_status_code rtems_clock_set_nanoseconds_extension( rtems_status_code rtems_clock_set_nanoseconds_extension(
rtems_nanoseconds_extension_routine routine rtems_nanoseconds_extension_routine routine
@ -778,7 +778,7 @@ CLOCK_TICK - Announce a clock tick
.. index:: rtems_clock_tick .. index:: rtems_clock_tick
.. code:: c .. code-block:: c
rtems_status_code rtems_clock_tick( void ); rtems_status_code rtems_clock_tick( void );

14
c_user/configuring_a_system.rst
View File

@ -217,7 +217,7 @@ In the following example, the configuration information for a system with a
single message queue, four (4) tasks, and a timeslice of fifty (50) single message queue, four (4) tasks, and a timeslice of fifty (50)
milliseconds is as follows: milliseconds is as follows:
.. code:: c .. code-block:: c
#include <bsp.h> #include <bsp.h>
#define CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER #define CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER
@ -375,7 +375,7 @@ The following example demonstrates how the two simple configuration defines for
unlimited objects and unified works areas can replace many seperate unlimited objects and unified works areas can replace many seperate
configuration defines for supported object classes: configuration defines for supported object classes:
.. code:: c .. code-block:: c
#define CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER #define CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
#define CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER #define CONFIGURE_APPLICATION_NEEDS_CONSOLE_DRIVER
@ -409,7 +409,7 @@ RTEMS Workspace if at least half the allocation size of free objects remain
allocated. RTEMS always keeps one allocation block of objects allocated. Here allocated. RTEMS always keeps one allocation block of objects allocated. Here
is an example of using ``rtems_resource_unlimited``: is an example of using ``rtems_resource_unlimited``:
.. code:: c .. code-block:: c
#define CONFIGURE_MAXIMUM_TASKS rtems_resource_unlimited(5) #define CONFIGURE_MAXIMUM_TASKS rtems_resource_unlimited(5)
@ -490,7 +490,7 @@ used. ``CONFIGURE_UNLIMITED_OBJECTS`` does not support varying the allocation
sizes for different objects; users who want that much control can define the sizes for different objects; users who want that much control can define the
``rtems_resource_unlimited`` macros themselves. ``rtems_resource_unlimited`` macros themselves.
.. code:: c .. code-block:: c
#define CONFIGURE_UNLIMITED_OBJECTS #define CONFIGURE_UNLIMITED_OBJECTS
#define CONFIGURE_UNLIMITED_ALLOCATION_SIZE 5 #define CONFIGURE_UNLIMITED_ALLOCATION_SIZE 5
@ -2098,7 +2098,7 @@ configuration with maximum message size and maximum number of pending messages.
The interface for this macro is as follows: The interface for this macro is as follows:
.. code:: c .. code-block:: c
CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE(max_messages, size_per) CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE(max_messages, size_per)
@ -2143,7 +2143,7 @@ pending messages with the message structure defined by the type
``one_message_type``. The other message queue has maximum of 500 pending ``one_message_type``. The other message queue has maximum of 500 pending
messages with the message structure defined by the type ``other_message_type``. messages with the message structure defined by the type ``other_message_type``.
.. code:: c .. code-block:: c
#define CONFIGURE_MESSAGE_BUFFER_MEMORY \ #define CONFIGURE_MESSAGE_BUFFER_MEMORY \
(CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE( \ (CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE( \
@ -4010,7 +4010,7 @@ same application can be used for the normal and high-performance product lines.
The second processor has no scheduler assigned and runs Linux. A hypervisor The second processor has no scheduler assigned and runs Linux. A hypervisor
will ensure that the two systems cannot interfere in an undesirable way. will ensure that the two systems cannot interfere in an undesirable way.
.. code:: c .. code-block:: c
#define CONFIGURE_SMP_MAXIMUM_PROCESSORS 8 #define CONFIGURE_SMP_MAXIMUM_PROCESSORS 8
#define CONFIGURE_MAXIMUM_PRIORITY 255 #define CONFIGURE_MAXIMUM_PRIORITY 255

6
c_user/cpu_usage_statistics.rst
View File

@ -57,7 +57,7 @@ a table with the following information per task:
The following is an example of the report generated: The following is an example of the report generated:
.. code:: c .. code-block:: c
+------------------------------------------------------------------------------+ +------------------------------------------------------------------------------+
|CPU USAGE BY THREAD | |CPU USAGE BY THREAD |
@ -109,7 +109,7 @@ cpu_usage_report - Report CPU Usage Statistics
**CALLING SEQUENCE:** **CALLING SEQUENCE:**
.. code:: c .. code-block:: c
void rtems_cpu_usage_report( void ); void rtems_cpu_usage_report( void );
@ -133,7 +133,7 @@ cpu_usage_reset - Reset CPU Usage Statistics
**CALLING SEQUENCE:** **CALLING SEQUENCE:**
.. code:: c .. code-block:: c
void rtems_cpu_usage_reset( void ); void rtems_cpu_usage_reset( void );

10
c_user/dual_ports_memory_manager.rst
View File

@ -102,7 +102,7 @@ PORT_CREATE - Create a port
.. index:: rtems_port_create .. index:: rtems_port_create
.. code:: c .. code-block:: c
rtems_status_code rtems_port_create( rtems_status_code rtems_port_create(
rtems_name name, rtems_name name,
@ -157,7 +157,7 @@ PORT_IDENT - Get ID of a port
.. index:: rtems_port_ident .. index:: rtems_port_ident
.. code:: c .. code-block:: c
rtems_status_code rtems_port_ident( rtems_status_code rtems_port_ident(
rtems_name name, rtems_name name,
@ -198,7 +198,7 @@ PORT_DELETE - Delete a port
.. index:: rtems_port_delete .. index:: rtems_port_delete
.. code:: c .. code-block:: c
rtems_status_code rtems_port_delete( rtems_status_code rtems_port_delete(
rtems_id id rtems_id id
@ -236,7 +236,7 @@ PORT_EXTERNAL_TO_INTERNAL - Convert external to internal address
.. index:: rtems_port_external_to_internal .. index:: rtems_port_external_to_internal
.. code:: c .. code-block:: c
rtems_status_code rtems_port_external_to_internal( rtems_status_code rtems_port_external_to_internal(
rtems_id id, rtems_id id,
@ -277,7 +277,7 @@ PORT_INTERNAL_TO_EXTERNAL - Convert internal to external address
.. index:: rtems_port_internal_to_external .. index:: rtems_port_internal_to_external
.. code:: c .. code-block:: c
rtems_status_code rtems_port_internal_to_external( rtems_status_code rtems_port_internal_to_external(
rtems_id id, rtems_id id,

4
c_user/event_manager.rst
View File

@ -184,7 +184,7 @@ EVENT_SEND - Send event set to a task
.. index:: rtems_event_send .. index:: rtems_event_send
.. code:: c .. code-block:: c
rtems_status_code rtems_event_send ( rtems_status_code rtems_event_send (
rtems_id id, rtems_id id,
@ -236,7 +236,7 @@ EVENT_RECEIVE - Receive event condition
.. index:: rtems_event_receive .. index:: rtems_event_receive
.. code:: c .. code-block:: c
rtems_status_code rtems_event_receive ( rtems_status_code rtems_event_receive (
rtems_event_set event_in, rtems_event_set event_in,

10
c_user/fatal_error.rst
View File

@ -118,7 +118,7 @@ FATAL_ERROR_OCCURRED - Invoke the fatal error handler
.. index:: rtems_fatal_error_occurred .. index:: rtems_fatal_error_occurred
.. code:: c .. code-block:: c
void rtems_fatal_error_occurred( void rtems_fatal_error_occurred(
uint32_t the_error uint32_t the_error
@ -158,7 +158,7 @@ FATAL - Invoke the fatal error handler with error source
.. index:: rtems_fatal .. index:: rtems_fatal
.. code:: c .. code-block:: c
void rtems_fatal( void rtems_fatal(
rtems_fatal_source source, rtems_fatal_source source,
@ -184,7 +184,7 @@ EXCEPTION_FRAME_PRINT - Prints the exception frame
.. index:: rtems_exception_frame_print .. index:: rtems_exception_frame_print
.. code:: c .. code-block:: c
void rtems_exception_frame_print( void rtems_exception_frame_print(
const rtems_exception_frame *frame const rtems_exception_frame *frame
@ -208,7 +208,7 @@ FATAL_SOURCE_TEXT - Returns a text for a fatal source
.. index:: rtems_fatal_source_text .. index:: rtems_fatal_source_text
.. code:: c .. code-block:: c
const char *rtems_fatal_source_text( const char *rtems_fatal_source_text(
rtems_fatal_source source rtems_fatal_source source
@ -233,7 +233,7 @@ INTERNAL_ERROR_TEXT - Returns a text for an internal error code
.. index:: rtems_internal_error_text .. index:: rtems_internal_error_text
.. code:: c .. code-block:: c
const char *rtems_internal_error_text( const char *rtems_internal_error_text(
rtems_fatal_code error rtems_fatal_code error

4
c_user/initialization.rst
View File

@ -216,7 +216,7 @@ INITIALIZE_EXECUTIVE - Initialize RTEMS
.. index:: rtems_initialize_executive .. index:: rtems_initialize_executive
.. code:: c .. code-block:: c
void rtems_initialize_executive(void); void rtems_initialize_executive(void);
@ -246,7 +246,7 @@ SHUTDOWN_EXECUTIVE - Shutdown RTEMS
.. index:: rtems_shutdown_executive .. index:: rtems_shutdown_executive
.. code:: c .. code-block:: c
void rtems_shutdown_executive( void rtems_shutdown_executive(
uint32_t result uint32_t result

26
c_user/interrupt_manager.rst
View File

@ -65,7 +65,7 @@ a prototype similar to the following:
.. index:: rtems_isr .. index:: rtems_isr
.. code:: c .. code-block:: c
rtems_isr user_isr( rtems_isr user_isr(
rtems_vector_number vector rtems_vector_number vector
@ -268,7 +268,7 @@ INTERRUPT_CATCH - Establish an ISR
.. index:: rtems_interrupt_catch .. index:: rtems_interrupt_catch
.. code:: c .. code-block:: c
rtems_status_code rtems_interrupt_catch( rtems_status_code rtems_interrupt_catch(
rtems_isr_entry new_isr_handler, rtems_isr_entry new_isr_handler,
@ -312,7 +312,7 @@ INTERRUPT_DISABLE - Disable Interrupts
.. index:: rtems_interrupt_disable .. index:: rtems_interrupt_disable
.. code:: c .. code-block:: c
void rtems_interrupt_disable( void rtems_interrupt_disable(
rtems_interrupt_level level rtems_interrupt_level level
@ -350,7 +350,7 @@ INTERRUPT_ENABLE - Enable Interrupts
.. index:: rtems_interrupt_enable .. index:: rtems_interrupt_enable
.. code:: c .. code-block:: c
void rtems_interrupt_enable( void rtems_interrupt_enable(
rtems_interrupt_level level rtems_interrupt_level level
@ -385,7 +385,7 @@ INTERRUPT_FLASH - Flash Interrupts
.. index:: rtems_interrupt_flash .. index:: rtems_interrupt_flash
.. code:: c .. code-block:: c
void rtems_interrupt_flash( void rtems_interrupt_flash(
rtems_interrupt_level level rtems_interrupt_level level
@ -421,7 +421,7 @@ INTERRUPT_LOCAL_DISABLE - Disable Interrupts on Current Processor
.. index:: rtems_interrupt_local_disable .. index:: rtems_interrupt_local_disable
.. code:: c .. code-block:: c
void rtems_interrupt_local_disable( void rtems_interrupt_local_disable(
rtems_interrupt_level level rtems_interrupt_level level
@ -459,7 +459,7 @@ INTERRUPT_LOCAL_ENABLE - Enable Interrupts on Current Processor
.. index:: rtems_interrupt_local_enable .. index:: rtems_interrupt_local_enable
.. code:: c .. code-block:: c
void rtems_interrupt_local_enable( void rtems_interrupt_local_enable(
rtems_interrupt_level level rtems_interrupt_level level
@ -490,7 +490,7 @@ INTERRUPT_LOCK_INITIALIZE - Initialize an ISR Lock
.. index:: rtems_interrupt_lock_initialize .. index:: rtems_interrupt_lock_initialize
.. code:: c .. code-block:: c
void rtems_interrupt_lock_initialize( void rtems_interrupt_lock_initialize(
rtems_interrupt_lock *lock rtems_interrupt_lock *lock
@ -517,7 +517,7 @@ INTERRUPT_LOCK_ACQUIRE - Acquire an ISR Lock
.. index:: rtems_interrupt_lock_acquire .. index:: rtems_interrupt_lock_acquire
.. code:: c .. code-block:: c
void rtems_interrupt_lock_acquire( void rtems_interrupt_lock_acquire(
rtems_interrupt_lock *lock, rtems_interrupt_lock *lock,
@ -547,7 +547,7 @@ INTERRUPT_LOCK_RELEASE - Release an ISR Lock
.. index:: rtems_interrupt_lock_release .. index:: rtems_interrupt_lock_release
.. code:: c .. code-block:: c
void rtems_interrupt_lock_release( void rtems_interrupt_lock_release(
rtems_interrupt_lock *lock, rtems_interrupt_lock *lock,
@ -577,7 +577,7 @@ INTERRUPT_LOCK_ACQUIRE_ISR - Acquire an ISR Lock from ISR
.. index:: rtems_interrupt_lock_acquire_isr .. index:: rtems_interrupt_lock_acquire_isr
.. code:: c .. code-block:: c
void rtems_interrupt_lock_acquire_isr( void rtems_interrupt_lock_acquire_isr(
rtems_interrupt_lock *lock, rtems_interrupt_lock *lock,
@ -611,7 +611,7 @@ INTERRUPT_LOCK_RELEASE_ISR - Release an ISR Lock from ISR
.. index:: rtems_interrupt_lock_release_isr .. index:: rtems_interrupt_lock_release_isr
.. code:: c .. code-block:: c
void rtems_interrupt_lock_release_isr( void rtems_interrupt_lock_release_isr(
rtems_interrupt_lock *lock, rtems_interrupt_lock *lock,
@ -642,7 +642,7 @@ INTERRUPT_IS_IN_PROGRESS - Is an ISR in Progress
.. index:: rtems_interrupt_is_in_progress .. index:: rtems_interrupt_is_in_progress
.. code:: c .. code-block:: c
bool rtems_interrupt_is_in_progress(void); bool rtems_interrupt_is_in_progress(void);

22
c_user/io_manager.rst
View File

@ -152,7 +152,7 @@ application to RTEMS is then passed to the correct device driver entry point.
RTEMS will invoke each device driver entry point assuming it is compatible with RTEMS will invoke each device driver entry point assuming it is compatible with
the following prototype: the following prototype:
.. code:: c .. code-block:: c
rtems_device_driver io_entry( rtems_device_driver io_entry(
rtems_device_major_number major, rtems_device_major_number major,
@ -229,7 +229,7 @@ IO_REGISTER_DRIVER - Register a device driver
.. index:: rtems_io_register_driver .. index:: rtems_io_register_driver
.. code:: c .. code-block:: c
rtems_status_code rtems_io_register_driver( rtems_status_code rtems_io_register_driver(
rtems_device_major_number major, rtems_device_major_number major,
@ -287,7 +287,7 @@ IO_UNREGISTER_DRIVER - Unregister a device driver
.. index:: rtems_io_unregister_driver .. index:: rtems_io_unregister_driver
.. code:: c .. code-block:: c
rtems_status_code rtems_io_unregister_driver( rtems_status_code rtems_io_unregister_driver(
rtems_device_major_number major rtems_device_major_number major
@ -321,7 +321,7 @@ IO_INITIALIZE - Initialize a device driver
.. index:: rtems_io_initialize .. index:: rtems_io_initialize
.. code:: c .. code-block:: c
rtems_status_code rtems_io_initialize( rtems_status_code rtems_io_initialize(
rtems_device_major_number major, rtems_device_major_number major,
@ -365,7 +365,7 @@ IO_REGISTER_NAME - Register a device
.. index:: rtems_io_register_name .. index:: rtems_io_register_name
.. code:: c .. code-block:: c
rtems_status_code rtems_io_register_name( rtems_status_code rtems_io_register_name(
const char *name, const char *name,
@ -401,7 +401,7 @@ IO_LOOKUP_NAME - Lookup a device
.. index:: rtems_io_lookup_name .. index:: rtems_io_lookup_name
.. code:: c .. code-block:: c
rtems_status_code rtems_io_lookup_name( rtems_status_code rtems_io_lookup_name(
const char *name, const char *name,
@ -437,7 +437,7 @@ IO_OPEN - Open a device
.. index:: rtems_io_open .. index:: rtems_io_open
.. code:: c .. code-block:: c
rtems_status_code rtems_io_open( rtems_status_code rtems_io_open(
rtems_device_major_number major, rtems_device_major_number major,
@ -476,7 +476,7 @@ IO_CLOSE - Close a device
.. index:: rtems_io_close .. index:: rtems_io_close
.. code:: c .. code-block:: c
rtems_status_code rtems_io_close( rtems_status_code rtems_io_close(
rtems_device_major_number major, rtems_device_major_number major,
@ -515,7 +515,7 @@ IO_READ - Read from a device
.. index:: rtems_io_read .. index:: rtems_io_read
.. code:: c .. code-block:: c
rtems_status_code rtems_io_read( rtems_status_code rtems_io_read(
rtems_device_major_number major, rtems_device_major_number major,
@ -555,7 +555,7 @@ IO_WRITE - Write to a device
.. index:: rtems_io_write .. index:: rtems_io_write
.. code:: c .. code-block:: c
rtems_status_code rtems_io_write( rtems_status_code rtems_io_write(
rtems_device_major_number major, rtems_device_major_number major,
@ -596,7 +596,7 @@ IO_CONTROL - Special device services
.. index:: rtems_io_control .. index:: rtems_io_control
.. code:: c .. code-block:: c
rtems_status_code rtems_io_control( rtems_status_code rtems_io_control(
rtems_device_major_number major, rtems_device_major_number major,

10
c_user/key_concepts.rst
View File

@ -50,7 +50,7 @@ light to blink might be called "LITE". The ``rtems_build_name`` routine is
provided to build an object name from four ASCII characters. The following provided to build an object name from four ASCII characters. The following
example illustrates this: example illustrates this:
.. code:: c .. code-block:: c
rtems_name my_name; rtems_name my_name;
my_name = rtems_build_name( 'L', 'I', 'T', 'E' ); my_name = rtems_build_name( 'L', 'I', 'T', 'E' );
@ -70,7 +70,7 @@ attempts to convert the name into a printable string.
The following example illustrates the use of this method to print an object The following example illustrates the use of this method to print an object
name: name:
.. code:: c .. code-block:: c
#include <rtems.h> #include <rtems.h>
#include <rtems/bspIo.h> #include <rtems/bspIo.h>
@ -106,7 +106,7 @@ The thirty-two bit format for an object ID is composed of four parts: API,
object class, node, and index. The data type ``rtems_id`` is used to store object class, node, and index. The data type ``rtems_id`` is used to store
object IDs. object IDs.
.. code:: c .. code-block:: c
31 27 26 24 23 16 15 0 31 27 26 24 23 16 15 0
+---------+-------+--------------+-------------------------------+ +---------+-------+--------------+-------------------------------+
@ -129,7 +129,7 @@ Sixteen Bit Object ID Format
The sixteen bit format for an object ID is composed of three parts: API, object The sixteen bit format for an object ID is composed of three parts: API, object
class, and index. The data type ``rtems_id`` is used to store object IDs. class, and index. The data type ``rtems_id`` is used to store object IDs.
.. code:: c .. code-block:: c
15 11 10 8 7 0 15 11 10 8 7 0
+---------+-------+--------------+ +---------+-------+--------------+
@ -179,7 +179,7 @@ prototyped as follows:
.. index:: rtems_object_id_get_node .. index:: rtems_object_id_get_node
.. index:: rtems_object_id_get_index .. index:: rtems_object_id_get_index
.. code:: c .. code-block:: c
uint32_t rtems_object_id_get_api( rtems_id ); uint32_t rtems_object_id_get_api( rtems_id );
uint32_t rtems_object_id_get_class( rtems_id ); uint32_t rtems_object_id_get_class( rtems_id );

18
c_user/message_manager.rst
View File

@ -223,7 +223,7 @@ MESSAGE_QUEUE_CREATE - Create a queue
.. index:: rtems_message_queue_create .. index:: rtems_message_queue_create
.. code:: c .. code-block:: c
rtems_status_code rtems_message_queue_create( rtems_status_code rtems_message_queue_create(
rtems_name name, rtems_name name,
@ -310,7 +310,7 @@ MESSAGE_QUEUE_IDENT - Get ID of a queue
.. index:: rtems_message_queue_ident .. index:: rtems_message_queue_ident
.. code:: c .. code-block:: c
rtems_status_code rtems_message_queue_ident( rtems_status_code rtems_message_queue_ident(
rtems_name name, rtems_name name,
@ -364,7 +364,7 @@ MESSAGE_QUEUE_DELETE - Delete a queue
.. index:: rtems_message_queue_delete .. index:: rtems_message_queue_delete
.. code:: c .. code-block:: c
rtems_status_code rtems_message_queue_delete( rtems_status_code rtems_message_queue_delete(
rtems_id id rtems_id id
@ -422,7 +422,7 @@ MESSAGE_QUEUE_SEND - Put message at rear of a queue
.. index:: rtems_message_queue_send .. index:: rtems_message_queue_send
.. code:: c .. code-block:: c
rtems_status_code rtems_message_queue_send( rtems_status_code rtems_message_queue_send(
rtems_id id, rtems_id id,
@ -480,7 +480,7 @@ MESSAGE_QUEUE_URGENT - Put message at front of a queue
.. index:: rtems_message_queue_urgent .. index:: rtems_message_queue_urgent
.. code:: c .. code-block:: c
rtems_status_code rtems_message_queue_urgent( rtems_status_code rtems_message_queue_urgent(
rtems_id id, rtems_id id,
@ -538,7 +538,7 @@ MESSAGE_QUEUE_BROADCAST - Broadcast N messages to a queue
.. index:: rtems_message_queue_broadcast .. index:: rtems_message_queue_broadcast
.. code:: c .. code-block:: c
rtems_status_code rtems_message_queue_broadcast( rtems_status_code rtems_message_queue_broadcast(
rtems_id id, rtems_id id,
@ -597,7 +597,7 @@ MESSAGE_QUEUE_RECEIVE - Receive message from a queue
.. index:: rtems_message_queue_receive .. index:: rtems_message_queue_receive
.. code:: c .. code-block:: c
rtems_status_code rtems_message_queue_receive( rtems_status_code rtems_message_queue_receive(
rtems_id id, rtems_id id,
@ -683,7 +683,7 @@ MESSAGE_QUEUE_GET_NUMBER_PENDING - Get number of messages pending on a queue
.. index:: rtems_message_queue_get_number_pending .. index:: rtems_message_queue_get_number_pending
.. code:: c .. code-block:: c
rtems_status_code rtems_message_queue_get_number_pending( rtems_status_code rtems_message_queue_get_number_pending(
rtems_id id, rtems_id id,
@ -723,7 +723,7 @@ MESSAGE_QUEUE_FLUSH - Flush all messages on a queue
.. index:: rtems_message_queue_flush .. index:: rtems_message_queue_flush
.. code:: c .. code-block:: c
rtems_status_code rtems_message_queue_flush( rtems_status_code rtems_message_queue_flush(
rtems_id id, rtems_id id,

16
c_user/multiprocessing.rst
View File

@ -272,7 +272,7 @@ following prototype:
.. index:: rtems_mpci_entry .. index:: rtems_mpci_entry
.. code:: c .. code-block:: c
rtems_mpci_entry user_mpci_initialization( rtems_mpci_entry user_mpci_initialization(
rtems_configuration_table *configuration rtems_configuration_table *configuration
@ -296,7 +296,7 @@ The GET_PACKET component of the user-provided MPCI layer is called when RTEMS
must obtain a packet buffer to send or broadcast a message. This component must obtain a packet buffer to send or broadcast a message. This component
should be adhere to the following prototype: should be adhere to the following prototype:
.. code:: c .. code-block:: c
rtems_mpci_entry user_mpci_get_packet( rtems_mpci_entry user_mpci_get_packet(
rtems_packet_prefix **packet rtems_packet_prefix **packet
@ -319,7 +319,7 @@ The RETURN_PACKET component of the user-provided MPCI layer is called when
RTEMS needs to release a packet to the free packet buffer pool. This component RTEMS needs to release a packet to the free packet buffer pool. This component
should be adhere to the following prototype: should be adhere to the following prototype:
.. code:: c .. code-block:: c
rtems_mpci_entry user_mpci_return_packet( rtems_mpci_entry user_mpci_return_packet(
rtems_packet_prefix *packet rtems_packet_prefix *packet
@ -335,7 +335,7 @@ The RECEIVE_PACKET component of the user-provided MPCI layer is called when
RTEMS needs to obtain a packet which has previously arrived. This component RTEMS needs to obtain a packet which has previously arrived. This component
should be adhere to the following prototype: should be adhere to the following prototype:
.. code:: c .. code-block:: c
rtems_mpci_entry user_mpci_receive_packet( rtems_mpci_entry user_mpci_receive_packet(
rtems_packet_prefix **packet rtems_packet_prefix **packet
@ -353,7 +353,7 @@ The SEND_PACKET component of the user-provided MPCI layer is called when RTEMS
needs to send a packet containing a message to another node. This component needs to send a packet containing a message to another node. This component
should be adhere to the following prototype: should be adhere to the following prototype:
.. code:: c .. code-block:: c
rtems_mpci_entry user_mpci_send_packet( rtems_mpci_entry user_mpci_send_packet(
uint32_t node, uint32_t node,
@ -391,7 +391,7 @@ is the order of the bytes which compose a data entity. Processors which place
the least significant byte at the smallest address are classified as little the least significant byte at the smallest address are classified as little
endian processors. Little endian byte-ordering is shown below: endian processors. Little endian byte-ordering is shown below:
.. code:: c .. code-block:: c
+---------------+----------------+---------------+----------------+ +---------------+----------------+---------------+----------------+
| | | | | | | | | |
@ -403,7 +403,7 @@ Conversely, processors which place the most significant byte at the smallest
address are classified as big endian processors. Big endian byte-ordering is address are classified as big endian processors. Big endian byte-ordering is
shown below: shown below:
.. code:: c .. code-block:: c
+---------------+----------------+---------------+----------------+ +---------------+----------------+---------------+----------------+
| | | | | | | | | |
@ -479,7 +479,7 @@ MULTIPROCESSING_ANNOUNCE - Announce the arrival of a packet
.. index:: rtems_multiprocessing_announce .. index:: rtems_multiprocessing_announce
.. code:: c .. code-block:: c
void rtems_multiprocessing_announce( void ); void rtems_multiprocessing_announce( void );

40
c_user/object_services.rst
View File

@ -109,7 +109,7 @@ components. The following services are used to do this:
The following C language example illustrates the decomposition of an Id and The following C language example illustrates the decomposition of an Id and
printing the values. printing the values.
.. code:: c .. code-block:: c
void printObjectId(rtems_id id) void printObjectId(rtems_id id)
{ {
@ -128,7 +128,7 @@ It is also possible to construct an arbitrary Id using the ``rtems_build_id``
service. The following C language example illustrates how to construct the service. The following C language example illustrates how to construct the
"next Id." "next Id."
.. code:: c .. code-block:: c
rtems_id nextObjectId(rtems_id id) rtems_id nextObjectId(rtems_id id)
{ {
@ -153,7 +153,7 @@ information about an object in diagnostic messages.
In the following C language example, an Id is decomposed into its constituent In the following C language example, an Id is decomposed into its constituent
parts and "pretty-printed." parts and "pretty-printed."
.. code:: c .. code-block:: c
void prettyPrintObjectId(rtems_id id) void prettyPrintObjectId(rtems_id id)
{ {
@ -184,7 +184,7 @@ BUILD_NAME - Build object name from characters
.. index:: rtems_build_name .. index:: rtems_build_name
.. code:: c .. code-block:: c
rtems_name rtems_build_name( rtems_name rtems_build_name(
uint8_t c1, uint8_t c1,
@ -218,7 +218,7 @@ OBJECT_GET_CLASSIC_NAME - Lookup name from id
.. index:: rtems_object_get_classic_name .. index:: rtems_object_get_classic_name
.. code:: c .. code-block:: c
rtems_status_code rtems_object_get_classic_name( rtems_status_code rtems_object_get_classic_name(
rtems_id id, rtems_id id,
@ -257,7 +257,7 @@ OBJECT_GET_NAME - Obtain object name as string
.. index:: rtems_object_get_name .. index:: rtems_object_get_name
.. code:: c .. code-block:: c
char* rtems_object_get_name( char* rtems_object_get_name(
rtems_id id, rtems_id id,
@ -290,7 +290,7 @@ OBJECT_SET_NAME - Set object name
.. index:: rtems_object_set_name .. index:: rtems_object_set_name
.. code:: c .. code-block:: c
rtems_status_code rtems_object_set_name( rtems_status_code rtems_object_set_name(
rtems_id id, rtems_id id,
@ -338,7 +338,7 @@ OBJECT_ID_GET_API - Obtain API from Id
.. index:: rtems_object_id_get_api .. index:: rtems_object_id_get_api
.. code:: c .. code-block:: c
int rtems_object_id_get_api( int rtems_object_id_get_api(
rtems_id id rtems_id id
@ -368,7 +368,7 @@ OBJECT_ID_GET_CLASS - Obtain Class from Id
.. index:: rtems_object_id_get_class .. index:: rtems_object_id_get_class
.. code:: c .. code-block:: c
int rtems_object_id_get_class( int rtems_object_id_get_class(
rtems_id id rtems_id id
@ -398,7 +398,7 @@ OBJECT_ID_GET_NODE - Obtain Node from Id
.. index:: rtems_object_id_get_node .. index:: rtems_object_id_get_node
.. code:: c .. code-block:: c
int rtems_object_id_get_node( int rtems_object_id_get_node(
rtems_id id rtems_id id
@ -428,7 +428,7 @@ OBJECT_ID_GET_INDEX - Obtain Index from Id
.. index:: rtems_object_id_get_index .. index:: rtems_object_id_get_index
.. code:: c .. code-block:: c
int rtems_object_id_get_index( int rtems_object_id_get_index(
rtems_id id rtems_id id
@ -458,7 +458,7 @@ BUILD_ID - Build Object Id From Components
.. index:: rtems_build_id .. index:: rtems_build_id
.. code:: c .. code-block:: c
rtems_id rtems_build_id( rtems_id rtems_build_id(
int the_api, int the_api,
@ -493,7 +493,7 @@ OBJECT_ID_API_MINIMUM - Obtain Minimum API Value
.. index:: rtems_object_id_api_minimum .. index:: rtems_object_id_api_minimum
.. code:: c .. code-block:: c
int rtems_object_id_api_minimum(void); int rtems_object_id_api_minimum(void);
@ -519,7 +519,7 @@ OBJECT_ID_API_MAXIMUM - Obtain Maximum API Value
.. index:: rtems_object_id_api_maximum .. index:: rtems_object_id_api_maximum
.. code:: c .. code-block:: c
int rtems_object_id_api_maximum(void); int rtems_object_id_api_maximum(void);
@ -545,7 +545,7 @@ OBJECT_API_MINIMUM_CLASS - Obtain Minimum Class Value
.. index:: rtems_object_api_minimum_class .. index:: rtems_object_api_minimum_class
.. code:: c .. code-block:: c
int rtems_object_api_minimum_class( int rtems_object_api_minimum_class(
int api int api
@ -577,7 +577,7 @@ OBJECT_API_MAXIMUM_CLASS - Obtain Maximum Class Value
.. index:: rtems_object_api_maximum_class .. index:: rtems_object_api_maximum_class
.. code:: c .. code-block:: c
int rtems_object_api_maximum_class( int rtems_object_api_maximum_class(
int api int api
@ -609,7 +609,7 @@ OBJECT_GET_API_NAME - Obtain API Name
.. index:: rtems_object_get_api_name .. index:: rtems_object_get_api_name
.. code:: c .. code-block:: c
const char* rtems_object_get_api_name( const char* rtems_object_get_api_name(
int api int api
@ -642,7 +642,7 @@ OBJECT_GET_API_CLASS_NAME - Obtain Class Name
.. index:: rtems_object_get_api_class_name .. index:: rtems_object_get_api_class_name
.. code:: c .. code-block:: c
const char *rtems_object_get_api_class_name( const char *rtems_object_get_api_class_name(
int the_api, int the_api,
@ -677,7 +677,7 @@ OBJECT_GET_CLASS_INFORMATION - Obtain Class Information
.. index:: rtems_object_get_class_information .. index:: rtems_object_get_class_information
.. code:: c .. code-block:: c
rtems_status_code rtems_object_get_class_information( rtems_status_code rtems_object_get_class_information(
int the_api, int the_api,
@ -705,7 +705,7 @@ information about the specified ``api`` / ``the_class`` pairing.
This service returns information about the object class indicated by the This service returns information about the object class indicated by the
specified ``api`` and ``the_class``. This structure is defined as follows: specified ``api`` and ``the_class``. This structure is defined as follows:
.. code:: c .. code-block:: c
typedef struct { typedef struct {
rtems_id minimum_id; rtems_id minimum_id;

24
c_user/overview.rst
View File

@ -120,20 +120,6 @@ serves as a buffer between the project dependent application code and the
target hardware. Most hardware dependencies for real-time applications can be target hardware. Most hardware dependencies for real-time applications can be
localized to the low level device drivers. localized to the low level device drivers.
.. COMMENT: .. code:: c
.. COMMENT:
.. COMMENT: +-----------------------------------------------------------+
.. COMMENT: | Application Dependent Software |
.. COMMENT: | +----------------------------------------+ |
.. COMMENT: | | Standard Application Components | |
.. COMMENT: | | +-------------+---+ |
.. COMMENT: | +---+-----------+ | | |
.. COMMENT: | | Board Support | | RTEMS | |
.. COMMENT: | | Package | | | |
.. COMMENT: +----+---------------+--------------+-----------------+-----|
.. COMMENT: | Target Hardware |
.. COMMENT: +-----------------------------------------------------------+
.. figure:: rtemsarc.png .. figure:: rtemsarc.png
:width: 488 :width: 488
:height: 100px :height: 100px
@ -160,16 +146,6 @@ routines. Together these components provide a powerful run time environment
that promotes the development of efficient real-time application systems. The that promotes the development of efficient real-time application systems. The
following figure illustrates this organization: following figure illustrates this organization:
.. COMMENT: .. code:: c
.. COMMENT:
.. COMMENT: +-----------------------------------------------+
.. COMMENT: | RTEMS Executive Interface |
.. COMMENT: +-----------------------------------------------+
.. COMMENT: | RTEMS Core |
.. COMMENT: +-----------------------------------------------+
.. COMMENT: | CPU Dependent Code |
.. COMMENT: +-----------------------------------------------+
.. figure:: rtemspie.png .. figure:: rtemspie.png
:width: 70% :width: 70%
:align: center :align: center

10
c_user/partition_manager.rst
View File

@ -137,7 +137,7 @@ PARTITION_CREATE - Create a partition
.. index:: rtems_partition_create .. index:: rtems_partition_create
.. code:: c .. code-block:: c
rtems_status_code rtems_partition_create( rtems_status_code rtems_partition_create(
rtems_name name, rtems_name name,
@ -232,7 +232,7 @@ PARTITION_IDENT - Get ID of a partition
.. index:: rtems_partition_ident .. index:: rtems_partition_ident
.. code:: c .. code-block:: c
rtems_status_code rtems_partition_ident( rtems_status_code rtems_partition_ident(
rtems_name name, rtems_name name,
@ -286,7 +286,7 @@ PARTITION_DELETE - Delete a partition
.. index:: rtems_partition_delete .. index:: rtems_partition_delete
.. code:: c .. code-block:: c
rtems_status_code rtems_partition_delete( rtems_status_code rtems_partition_delete(
rtems_id id rtems_id id
@ -337,7 +337,7 @@ PARTITION_GET_BUFFER - Get buffer from a partition
.. index:: rtems_partition_get_buffer .. index:: rtems_partition_get_buffer
.. code:: c .. code-block:: c
rtems_status_code rtems_partition_get_buffer( rtems_status_code rtems_partition_get_buffer(
rtems_id id, rtems_id id,
@ -385,7 +385,7 @@ PARTITION_RETURN_BUFFER - Return buffer to a partition
.. index:: rtems_partition_return_buffer .. index:: rtems_partition_return_buffer
.. code:: c .. code-block:: c
rtems_status_code rtems_partition_return_buffer( rtems_status_code rtems_partition_return_buffer(
rtems_id id, rtems_id id,

10
c_user/pci_library.rst
View File

@ -292,7 +292,7 @@ slot. Requests made to slots that are not supported by hardware should result
in ``PCISTS_MSTABRT`` and/or data must be ignored (writes) or ``0xFFFFFFFF`` is in ``PCISTS_MSTABRT`` and/or data must be ignored (writes) or ``0xFFFFFFFF`` is
always returned (reads). always returned (reads).
.. code:: c .. code-block:: c
/* Configuration Space Access Read Routines */ /* Configuration Space Access Read Routines */
extern int pci_cfg_r8(pci_dev_t dev, int ofs, uint8_t *data); extern int pci_cfg_r8(pci_dev_t dev, int ofs, uint8_t *data);
@ -316,7 +316,7 @@ to the functions is not the PCI I/O addresses, the caller must have translated
PCI I/O addresses (available in the PCI BARs) into a BSP or host driver custom PCI I/O addresses (available in the PCI BARs) into a BSP or host driver custom
address, see `Access functions`_ for how addresses are translated. address, see `Access functions`_ for how addresses are translated.
.. code:: c .. code-block:: c
/* Read a register over PCI I/O Space */ /* Read a register over PCI I/O Space */
extern uint8_t pci_io_r8(uint32_t adr); extern uint8_t pci_io_r8(uint32_t adr);
@ -340,7 +340,7 @@ swapped back. The below routines makes it possible to access registers over PCI
memory space in a portable way on different architectures, the BSP or memory space in a portable way on different architectures, the BSP or
architecture must provide necessary functions in order to implement this. architecture must provide necessary functions in order to implement this.
.. code:: c .. code-block:: c
static inline uint16_t pci_ld_le16(volatile uint16_t *addr); static inline uint16_t pci_ld_le16(volatile uint16_t *addr);
static inline void pci_st_le16(volatile uint16_t *addr, uint16_t val); static inline void pci_st_le16(volatile uint16_t *addr, uint16_t val);
@ -364,7 +364,7 @@ have the same arguments and return values as the above functions.
The pci_access_func() function defined below can be used to get a function The pci_access_func() function defined below can be used to get a function
pointer of a specific access type. pointer of a specific access type.
.. code:: c .. code-block:: c
/* Get Read/Write function for accessing a register over PCI Memory Space /* Get Read/Write function for accessing a register over PCI Memory Space
* (non-inline functions). * (non-inline functions).
@ -397,7 +397,7 @@ are PCI addresses. The below functions can be used to translate PCI addresses
into CPU accessible addresses or vice versa, translation may be different for into CPU accessible addresses or vice versa, translation may be different for
different PCI spaces/regions. different PCI spaces/regions.
.. code:: c .. code-block:: c
/* Translate PCI address into CPU accessible address */ /* Translate PCI address into CPU accessible address */
static inline int pci_pci2cpu(uint32_t *address, int type); static inline int pci_pci2cpu(uint32_t *address, int type);

30
c_user/rate_monotonic_manager.rst
View File

@ -264,7 +264,7 @@ calculated based upon the period and execution time of each task. The fraction
of processor time spent executing task index is ``Time(index) / of processor time spent executing task index is ``Time(index) /
Period(index)``. The processor utilization can be calculated as follows: Period(index)``. The processor utilization can be calculated as follows:
.. code:: c .. code-block:: c
Utilization = 0 Utilization = 0
for index = 1 to maximum_tasks for index = 1 to maximum_tasks
@ -273,7 +273,7 @@ Period(index)``. The processor utilization can be calculated as follows:
To ensure schedulability even under transient overload, the processor To ensure schedulability even under transient overload, the processor
utilization must adhere to the following rule: utilization must adhere to the following rule:
.. code:: c .. code-block:: c
Utilization = maximum_tasks * (2**(1/maximum_tasks) - 1) Utilization = maximum_tasks * (2**(1/maximum_tasks) - 1)
@ -647,7 +647,7 @@ RATE_MONOTONIC_CREATE - Create a rate monotonic period
.. index:: rtems_rate_monotonic_create .. index:: rtems_rate_monotonic_create
.. code:: c .. code-block:: c
rtems_status_code rtems_rate_monotonic_create( rtems_status_code rtems_rate_monotonic_create(
rtems_name name, rtems_name name,
@ -689,7 +689,7 @@ RATE_MONOTONIC_IDENT - Get ID of a period
.. index:: rtems_rate_monotonic_ident .. index:: rtems_rate_monotonic_ident
.. code:: c .. code-block:: c
rtems_status_code rtems_rate_monotonic_ident( rtems_status_code rtems_rate_monotonic_ident(
rtems_name name, rtems_name name,
@ -728,7 +728,7 @@ RATE_MONOTONIC_CANCEL - Cancel a period
.. index:: rtems_rate_monotonic_cancel .. index:: rtems_rate_monotonic_cancel
.. code:: c .. code-block:: c
rtems_status_code rtems_rate_monotonic_cancel( rtems_status_code rtems_rate_monotonic_cancel(
rtems_id id rtems_id id
@ -768,7 +768,7 @@ RATE_MONOTONIC_DELETE - Delete a rate monotonic period
.. index:: rtems_rate_monotonic_delete .. index:: rtems_rate_monotonic_delete
.. code:: c .. code-block:: c
rtems_status_code rtems_rate_monotonic_delete( rtems_status_code rtems_rate_monotonic_delete(
rtems_id id rtems_id id
@ -809,7 +809,7 @@ RATE_MONOTONIC_PERIOD - Conclude current/Start next period
.. index:: rtems_rate_monotonic_period .. index:: rtems_rate_monotonic_period
.. code:: c .. code-block:: c
rtems_status_code rtems_rate_monotonic_period( rtems_status_code rtems_rate_monotonic_period(
rtems_id id, rtems_id id,
@ -859,7 +859,7 @@ RATE_MONOTONIC_GET_STATUS - Obtain status from a period
.. index:: rtems_rate_monotonic_get_status .. index:: rtems_rate_monotonic_get_status
.. code:: c .. code-block:: c
rtems_status_code rtems_rate_monotonic_get_status( rtems_status_code rtems_rate_monotonic_get_status(
rtems_id id, rtems_id id,
@ -885,7 +885,7 @@ period id in the following data structure:
.. index:: rtems_rate_monotonic_period_status .. index:: rtems_rate_monotonic_period_status
.. code:: c .. code-block:: c
typedef struct { typedef struct {
rtems_id owner; rtems_id owner;
@ -923,7 +923,7 @@ RATE_MONOTONIC_GET_STATISTICS - Obtain statistics from a period
.. index:: rtems_rate_monotonic_get_statistics .. index:: rtems_rate_monotonic_get_statistics
.. code:: c .. code-block:: c
rtems_status_code rtems_rate_monotonic_get_statistics( rtems_status_code rtems_rate_monotonic_get_statistics(
rtems_id id, rtems_id id,
@ -949,7 +949,7 @@ monotonic period id in the following data structure:
.. index:: rtems_rate_monotonic_period_statistics .. index:: rtems_rate_monotonic_period_statistics
.. code:: c .. code-block:: c
typedef struct { typedef struct {
uint32_t count; uint32_t count;
@ -992,7 +992,7 @@ RATE_MONOTONIC_RESET_STATISTICS - Reset statistics for a period
.. index:: rtems_rate_monotonic_reset_statistics .. index:: rtems_rate_monotonic_reset_statistics
.. code:: c .. code-block:: c
rtems_status_code rtems_rate_monotonic_reset_statistics( rtems_status_code rtems_rate_monotonic_reset_statistics(
rtems_id id rtems_id id
@ -1027,7 +1027,7 @@ RATE_MONOTONIC_RESET_ALL_STATISTICS - Reset statistics for all periods
.. index:: rtems_rate_monotonic_reset_all_statistics .. index:: rtems_rate_monotonic_reset_all_statistics
.. code:: c .. code-block:: c
void rtems_rate_monotonic_reset_all_statistics(void); void rtems_rate_monotonic_reset_all_statistics(void);
@ -1055,7 +1055,7 @@ RATE_MONOTONIC_REPORT_STATISTICS - Print period statistics report
.. index:: rtems_rate_monotonic_report_statistics .. index:: rtems_rate_monotonic_report_statistics
.. code:: c .. code-block:: c
void rtems_rate_monotonic_report_statistics(void); void rtems_rate_monotonic_report_statistics(void);
@ -1071,7 +1071,7 @@ directive.
.. index:: rtems_rate_monotonic_period_statistics .. index:: rtems_rate_monotonic_period_statistics
.. code:: c .. code-block:: c
ID OWNER PERIODS MISSED CPU TIME WALL TIME ID OWNER PERIODS MISSED CPU TIME WALL TIME
MIN/MAX/AVG MIN/MAX/AVG MIN/MAX/AVG MIN/MAX/AVG

16
c_user/region_manager.rst
View File

@ -232,7 +232,7 @@ REGION_CREATE - Create a region
.. index:: rtems_region_create .. index:: rtems_region_create
.. code:: c .. code-block:: c
rtems_status_code rtems_region_create( rtems_status_code rtems_region_create(
rtems_name name, rtems_name name,
@ -310,7 +310,7 @@ REGION_IDENT - Get ID of a region
.. index:: rtems_region_ident .. index:: rtems_region_ident
.. code:: c .. code-block:: c
rtems_status_code rtems_region_ident( rtems_status_code rtems_region_ident(
rtems_name name, rtems_name name,
@ -351,7 +351,7 @@ REGION_DELETE - Delete a region
.. index:: rtems_region_delete .. index:: rtems_region_delete
.. code:: c .. code-block:: c
rtems_status_code rtems_region_delete( rtems_status_code rtems_region_delete(
rtems_id id rtems_id id
@ -393,7 +393,7 @@ REGION_EXTEND - Add memory to a region
.. index:: rtems_region_extend .. index:: rtems_region_extend
.. code:: c .. code-block:: c
rtems_status_code rtems_region_extend( rtems_status_code rtems_region_extend(
rtems_id id, rtems_id id,
@ -437,7 +437,7 @@ REGION_GET_SEGMENT - Get segment from a region
.. index:: rtems_region_get_segment .. index:: rtems_region_get_segment
.. code:: c .. code-block:: c
rtems_status_code rtems_region_get_segment( rtems_status_code rtems_region_get_segment(
rtems_id id, rtems_id id,
@ -519,7 +519,7 @@ REGION_RETURN_SEGMENT - Return segment to a region
.. index:: rtems_region_return_segment .. index:: rtems_region_return_segment
.. code:: c .. code-block:: c
rtems_status_code rtems_region_return_segment( rtems_status_code rtems_region_return_segment(
rtems_id id, rtems_id id,
@ -569,7 +569,7 @@ REGION_GET_SEGMENT_SIZE - Obtain size of a segment
.. index:: rtems_region_get_segment_size .. index:: rtems_region_get_segment_size
.. code:: c .. code-block:: c
rtems_status_code rtems_region_get_segment_size( rtems_status_code rtems_region_get_segment_size(
rtems_id id, rtems_id id,
@ -612,7 +612,7 @@ REGION_RESIZE_SEGMENT - Change size of a segment
.. index:: rtems_region_resize_segment .. index:: rtems_region_resize_segment
.. code:: c .. code-block:: c
rtems_status_code rtems_region_resize_segment( rtems_status_code rtems_region_resize_segment(
rtems_id id, rtems_id id,

29
c_user/scheduling_concepts.rst
View File

@ -327,35 +327,6 @@ It will remain in the dormant state until it is started via the
task is now permitted to be scheduled for the processor and to compete for task is now permitted to be scheduled for the processor and to compete for
other system resources. other system resources.
.. COMMENT: .. code:: c
.. COMMENT:
.. COMMENT: +-------------------------------------------------------------+
.. COMMENT: | Non-existent |
.. COMMENT: | +-------------------------------------------------------+ |
.. COMMENT: | | | |
.. COMMENT: | | | |
.. COMMENT: | | Creating +---------+ Deleting | |
.. COMMENT: | | -------------------> | Dormant | -------------------> | |
.. COMMENT: | | +---------+ | |
.. COMMENT: | | | | |
.. COMMENT: | | Starting | | |
.. COMMENT: | | | | |
.. COMMENT: | | V Deleting | |
.. COMMENT: | | +-------> +-------+ -------------------> | |
.. COMMENT: | | Yielding / +----- | Ready | ------+ | |
.. COMMENT: | | / / +-------+ <--+ \\ | |
.. COMMENT: | | / / \\ \\ Blocking | |
.. COMMENT: | | / / Dispatching Readying \\ \\ | |
.. COMMENT: | | / V \\ V | |
.. COMMENT: | | +-----------+ Blocking +---------+ | |
.. COMMENT: | | | Executing | --------------> | Blocked | | |
.. COMMENT: | | +-----------+ +---------+ | |
.. COMMENT: | | | |
.. COMMENT: | | | |
.. COMMENT: | +-------------------------------------------------------+ |
.. COMMENT: | Non-existent |
.. COMMENT: +-------------------------------------------------------------+
.. figure:: states.png .. figure:: states.png
:width: 70% :width: 70%
:align: center :align: center

14
c_user/semaphore_manager.rst
View File

@ -381,7 +381,7 @@ SEMAPHORE_CREATE - Create a semaphore
.. index:: rtems_semaphore_create .. index:: rtems_semaphore_create
.. code:: c .. code-block:: c
rtems_status_code rtems_semaphore_create( rtems_status_code rtems_semaphore_create(
rtems_name name, rtems_name name,
@ -495,7 +495,7 @@ SEMAPHORE_IDENT - Get ID of a semaphore
.. index:: rtems_semaphore_ident .. index:: rtems_semaphore_ident
.. code:: c .. code-block:: c
rtems_status_code rtems_semaphore_ident( rtems_status_code rtems_semaphore_ident(
rtems_name name, rtems_name name,
@ -547,7 +547,7 @@ SEMAPHORE_DELETE - Delete a semaphore
.. index:: rtems_semaphore_delete .. index:: rtems_semaphore_delete
.. code:: c .. code-block:: c
rtems_status_code rtems_semaphore_delete( rtems_status_code rtems_semaphore_delete(
rtems_id id rtems_id id
@ -605,7 +605,7 @@ SEMAPHORE_OBTAIN - Acquire a semaphore
.. index:: rtems_semaphore_obtain .. index:: rtems_semaphore_obtain
.. code:: c .. code-block:: c
rtems_status_code rtems_semaphore_obtain( rtems_status_code rtems_semaphore_obtain(
rtems_id id, rtems_id id,
@ -702,7 +702,7 @@ SEMAPHORE_RELEASE - Release a semaphore
.. index:: rtems_semaphore_release .. index:: rtems_semaphore_release
.. code:: c .. code-block:: c
rtems_status_code rtems_semaphore_release( rtems_status_code rtems_semaphore_release(
rtems_id id rtems_id id
@ -762,7 +762,7 @@ SEMAPHORE_FLUSH - Unblock all tasks waiting on a semaphore
.. index:: rtems_semaphore_flush .. index:: rtems_semaphore_flush
.. code:: c .. code-block:: c
rtems_status_code rtems_semaphore_flush( rtems_status_code rtems_semaphore_flush(
rtems_id id rtems_id id
@ -817,7 +817,7 @@ SEMAPHORE_SET_PRIORITY - Set priority by scheduler for a semaphore
.. index:: rtems_semaphore_set_priority .. index:: rtems_semaphore_set_priority
.. code:: c .. code-block:: c
rtems_status_code rtems_semaphore_set_priority( rtems_status_code rtems_semaphore_set_priority(
rtems_id semaphore_id, rtems_id semaphore_id,

6
c_user/signal_manager.rst
View File

@ -185,7 +185,7 @@ conventions:
.. index:: rtems_asr .. index:: rtems_asr
.. code:: c .. code-block:: c
rtems_asr user_routine( rtems_asr user_routine(
rtems_signal_set signals rtems_signal_set signals
@ -212,7 +212,7 @@ SIGNAL_CATCH - Establish an ASR
.. index:: rtems_signal_catch .. index:: rtems_signal_catch
.. code:: c .. code-block:: c
rtems_status_code rtems_signal_catch( rtems_status_code rtems_signal_catch(
rtems_asr_entry asr_handler, rtems_asr_entry asr_handler,
@ -273,7 +273,7 @@ SIGNAL_SEND - Send signal set to a task
.. index:: rtems_signal_send .. index:: rtems_signal_send
.. code:: c .. code-block:: c
rtems_status_code rtems_signal_send( rtems_status_code rtems_signal_send(
rtems_id id, rtems_id id,

10
c_user/stack_bounds_checker.rst
View File

@ -87,7 +87,7 @@ Table generation, then all that is necessary is to define the macro
``CONFIGURE_STACK_CHECKER_ENABLED`` before including ``<rtems/confdefs.h>`` as ``CONFIGURE_STACK_CHECKER_ENABLED`` before including ``<rtems/confdefs.h>`` as
shown below: shown below:
.. code:: c .. code-block:: c
#define CONFIGURE_STACK_CHECKER_ENABLED #define CONFIGURE_STACK_CHECKER_ENABLED
... ...
@ -109,7 +109,7 @@ system by calling the ``rtems_stack_checker_report_usage`` routine. This
routine prints a table with the peak usage and stack size of every task in the routine prints a table with the peak usage and stack size of every task in the
system. The following is an example of the report generated: system. The following is an example of the report generated:
.. code:: c .. code-block:: c
ID NAME LOW HIGH AVAILABLE USED ID NAME LOW HIGH AVAILABLE USED
0x04010001 IDLE 0x003e8a60 0x003e9667 2952 200 0x04010001 IDLE 0x003e8a60 0x003e9667 2952 200
@ -131,7 +131,7 @@ possible that the message cannot be printed.
The following is an example of the output generated: The following is an example of the output generated:
.. code:: c .. code-block:: c
BLOWN STACK!!! Offending task(0x3eb360): id=0x08010002; name=0x54413120 BLOWN STACK!!! Offending task(0x3eb360): id=0x08010002; name=0x54413120
stack covers range 0x003e5750 - 0x003e7b57 (9224 bytes) stack covers range 0x003e5750 - 0x003e7b57 (9224 bytes)
@ -157,7 +157,7 @@ STACK_CHECKER_IS_BLOWN - Has Current Task Blown Its Stack
**CALLING SEQUENCE:** **CALLING SEQUENCE:**
.. code:: c .. code-block:: c
bool rtems_stack_checker_is_blown( void ); bool rtems_stack_checker_is_blown( void );
@ -190,7 +190,7 @@ STACK_CHECKER_REPORT_USAGE - Report Task Stack Usage
**CALLING SEQUENCE:** **CALLING SEQUENCE:**
.. code:: c .. code-block:: c
void rtems_stack_checker_report_usage( void ); void rtems_stack_checker_report_usage( void );

21
c_user/symmetric_multiprocessing_services.rst
View File

@ -502,7 +502,7 @@ initialization task function is called (just like a global C++ constructor).
To set application specific values, a higher priority constructor function must To set application specific values, a higher priority constructor function must
be used to set up the environment variables. be used to set up the environment variables.
.. code:: c .. code-block:: c
#include <stdlib.h> #include <stdlib.h>
void __attribute__((constructor(1000))) config_libgomp( void ) void __attribute__((constructor(1000))) config_libgomp( void )
@ -628,7 +628,7 @@ processor for I/O tasks, another for computation, etc.. The following
illustrates the code sequence necessary to assign a task an affinity for illustrates the code sequence necessary to assign a task an affinity for
processor with index ``processor_index``. processor with index ``processor_index``.
.. code:: c .. code-block:: c
#include <rtems.h> #include <rtems.h>
#include <assert.h> #include <assert.h>
@ -661,7 +661,7 @@ GET_PROCESSOR_COUNT - Get processor count
**CALLING SEQUENCE:** **CALLING SEQUENCE:**
.. code:: c .. code-block:: c
uint32_t rtems_get_processor_count(void); uint32_t rtems_get_processor_count(void);
@ -690,7 +690,7 @@ GET_CURRENT_PROCESSOR - Get current processor index
**CALLING SEQUENCE:** **CALLING SEQUENCE:**
.. code:: c .. code-block:: c
uint32_t rtems_get_current_processor(void); uint32_t rtems_get_current_processor(void);
@ -722,7 +722,7 @@ SCHEDULER_IDENT - Get ID of a scheduler
**CALLING SEQUENCE:** **CALLING SEQUENCE:**
.. code:: c .. code-block:: c
rtems_status_code rtems_scheduler_ident( rtems_status_code rtems_scheduler_ident(
rtems_name name, rtems_name name,
@ -760,7 +760,7 @@ SCHEDULER_GET_PROCESSOR_SET - Get processor set of a scheduler
**CALLING SEQUENCE:** **CALLING SEQUENCE:**
.. code:: c .. code-block:: c
rtems_status_code rtems_scheduler_get_processor_set( rtems_status_code rtems_scheduler_get_processor_set(
rtems_id scheduler_id, rtems_id scheduler_id,
@ -800,7 +800,7 @@ TASK_GET_SCHEDULER - Get scheduler of a task
**CALLING SEQUENCE:** **CALLING SEQUENCE:**
.. code:: c .. code-block:: c
rtems_status_code rtems_task_get_scheduler( rtems_status_code rtems_task_get_scheduler(
rtems_id task_id, rtems_id task_id,
@ -835,7 +835,7 @@ TASK_SET_SCHEDULER - Set scheduler of a task
**CALLING SEQUENCE:** **CALLING SEQUENCE:**
.. code:: c .. code-block:: c
rtems_status_code rtems_task_set_scheduler( rtems_status_code rtems_task_set_scheduler(
rtems_id task_id, rtems_id task_id,
@ -910,7 +910,7 @@ TASK_GET_AFFINITY - Get task processor affinity
**CALLING SEQUENCE:** **CALLING SEQUENCE:**
.. code:: c .. code-block:: c
rtems_status_code rtems_task_get_affinity( rtems_status_code rtems_task_get_affinity(
rtems_id id, rtems_id id,
@ -950,7 +950,7 @@ TASK_SET_AFFINITY - Set task processor affinity
**CALLING SEQUENCE:** **CALLING SEQUENCE:**
.. code:: c .. code-block:: c
rtems_status_code rtems_task_set_affinity( rtems_status_code rtems_task_set_affinity(
rtems_id id, rtems_id id,
@ -989,4 +989,3 @@ circumstances on these processors since the scheduler ignores them. Some
locking protocols may temporarily use processors that are not included in the locking protocols may temporarily use processors that are not included in the
processor affinity set of the task. It is also not an error if the processor processor affinity set of the task. It is also not an error if the processor
affinity set contains processors that are not part of the system. affinity set contains processors that are not part of the system.

36
c_user/task_manager.rst
View File

@ -234,7 +234,7 @@ accesses it argument is:
.. index:: rtems_task .. index:: rtems_task
.. code:: c .. code-block:: c
rtems_task user_task( rtems_task user_task(
rtems_task_argument argument rtems_task_argument argument
@ -582,7 +582,7 @@ TASK_CREATE - Create a task
.. index:: rtems_task_create .. index:: rtems_task_create
.. code:: c .. code-block:: c
rtems_status_code rtems_task_create( rtems_status_code rtems_task_create(
rtems_name name, rtems_name name,
@ -720,7 +720,7 @@ TASK_IDENT - Get ID of a task
.. index:: rtems_task_ident .. index:: rtems_task_ident
.. code:: c .. code-block:: c
rtems_status_code rtems_task_ident( rtems_status_code rtems_task_ident(
rtems_name name, rtems_name name,
@ -775,7 +775,7 @@ TASK_SELF - Obtain ID of caller
.. index:: rtems_task_self .. index:: rtems_task_self
.. code:: c .. code-block:: c
rtems_id rtems_task_self(void); rtems_id rtems_task_self(void);
@ -802,7 +802,7 @@ TASK_START - Start a task
.. index:: rtems_task_start .. index:: rtems_task_start
.. code:: c .. code-block:: c
rtems_status_code rtems_task_start( rtems_status_code rtems_task_start(
rtems_id id, rtems_id id,
@ -856,7 +856,7 @@ TASK_RESTART - Restart a task
.. index:: rtems_task_restart .. index:: rtems_task_restart
.. code:: c .. code-block:: c
rtems_status_code rtems_task_restart( rtems_status_code rtems_task_restart(
rtems_id id, rtems_id id,
@ -918,7 +918,7 @@ TASK_DELETE - Delete a task
.. index:: rtems_task_delete .. index:: rtems_task_delete
.. code:: c .. code-block:: c
rtems_status_code rtems_task_delete( rtems_status_code rtems_task_delete(
rtems_id id rtems_id id
@ -974,7 +974,7 @@ TASK_SUSPEND - Suspend a task
.. index:: rtems_task_suspend .. index:: rtems_task_suspend
.. code:: c .. code-block:: c
rtems_status_code rtems_task_suspend( rtems_status_code rtems_task_suspend(
rtems_id id rtems_id id
@ -1022,7 +1022,7 @@ TASK_RESUME - Resume a task
.. index:: rtems_task_resume .. index:: rtems_task_resume
.. code:: c .. code-block:: c
rtems_status_code rtems_task_resume( rtems_status_code rtems_task_resume(
rtems_id id rtems_id id
@ -1068,7 +1068,7 @@ TASK_IS_SUSPENDED - Determine if a task is Suspended
.. index:: rtems_task_is_suspended .. index:: rtems_task_is_suspended
.. code:: c .. code-block:: c
rtems_status_code rtems_task_is_suspended( rtems_status_code rtems_task_is_suspended(
rtems_id id rtems_id id
@ -1109,7 +1109,7 @@ TASK_SET_PRIORITY - Set task priority
**CALLING SEQUENCE:** **CALLING SEQUENCE:**
.. code:: c .. code-block:: c
rtems_status_code rtems_task_set_priority( rtems_status_code rtems_task_set_priority(
rtems_id id, rtems_id id,
@ -1175,7 +1175,7 @@ TASK_MODE - Change the current task mode
.. index:: rtems_task_mode .. index:: rtems_task_mode
.. code:: c .. code-block:: c
rtems_status_code rtems_task_mode( rtems_status_code rtems_task_mode(
rtems_mode mode_set, rtems_mode mode_set,
@ -1250,7 +1250,7 @@ TASK_WAKE_AFTER - Wake up after interval
.. index:: rtems_task_wake_after .. index:: rtems_task_wake_after
.. code:: c .. code-block:: c
rtems_status_code rtems_task_wake_after( rtems_status_code rtems_task_wake_after(
rtems_interval ticks rtems_interval ticks
@ -1294,7 +1294,7 @@ TASK_WAKE_WHEN - Wake up when specified
.. index:: rtems_task_wake_when .. index:: rtems_task_wake_when
.. code:: c .. code-block:: c
rtems_status_code rtems_task_wake_when( rtems_status_code rtems_task_wake_when(
rtems_time_of_day *time_buffer rtems_time_of_day *time_buffer
@ -1337,7 +1337,7 @@ ITERATE_OVER_ALL_THREADS - Iterate Over Tasks
.. index:: rtems_iterate_over_all_threads .. index:: rtems_iterate_over_all_threads
.. code:: c .. code-block:: c
typedef void (*rtems_per_thread_routine)(Thread_Control *the_thread); typedef void (*rtems_per_thread_routine)(Thread_Control *the_thread);
void rtems_iterate_over_all_threads( void rtems_iterate_over_all_threads(
@ -1380,7 +1380,7 @@ TASK_VARIABLE_ADD - Associate per task variable
.. index:: rtems_task_variable_add .. index:: rtems_task_variable_add
.. code:: c .. code-block:: c
rtems_status_code rtems_task_variable_add( rtems_status_code rtems_task_variable_add(
rtems_id tid, rtems_id tid,
@ -1442,7 +1442,7 @@ TASK_VARIABLE_GET - Obtain value of a per task variable
.. index:: rtems_task_variable_get .. index:: rtems_task_variable_get
.. code:: c .. code-block:: c
rtems_status_code rtems_task_variable_get( rtems_status_code rtems_task_variable_get(
rtems_id tid, rtems_id tid,
@ -1501,7 +1501,7 @@ TASK_VARIABLE_DELETE - Remove per task variable
.. index:: rtems_task_variable_delete .. index:: rtems_task_variable_delete
.. code:: c .. code-block:: c
rtems_status_code rtems_task_variable_delete( rtems_status_code rtems_task_variable_delete(
rtems_id id, rtems_id id,

22
c_user/timer_manager.rst
View File

@ -88,7 +88,7 @@ prototype similar to the following:
.. index:: rtems_timer_service_routine .. index:: rtems_timer_service_routine
.. code:: c .. code-block:: c
rtems_timer_service_routine user_routine( rtems_timer_service_routine user_routine(
rtems_id timer_id, rtems_id timer_id,
@ -197,7 +197,7 @@ TIMER_CREATE - Create a timer
.. index:: rtems_timer_create .. index:: rtems_timer_create
.. code:: c .. code-block:: c
rtems_status_code rtems_timer_create( rtems_status_code rtems_timer_create(
rtems_name name, rtems_name name,
@ -239,7 +239,7 @@ TIMER_IDENT - Get ID of a timer
.. index:: rtems_timer_ident .. index:: rtems_timer_ident
.. code:: c .. code-block:: c
rtems_status_code rtems_timer_ident( rtems_status_code rtems_timer_ident(
rtems_name name, rtems_name name,
@ -280,7 +280,7 @@ TIMER_CANCEL - Cancel a timer
.. index:: rtems_timer_cancel .. index:: rtems_timer_cancel
.. code:: c .. code-block:: c
rtems_status_code rtems_timer_cancel( rtems_status_code rtems_timer_cancel(
rtems_id id rtems_id id
@ -316,7 +316,7 @@ TIMER_DELETE - Delete a timer
.. index:: rtems_timer_delete .. index:: rtems_timer_delete
.. code:: c .. code-block:: c
rtems_status_code rtems_timer_delete( rtems_status_code rtems_timer_delete(
rtems_id id rtems_id id
@ -354,7 +354,7 @@ TIMER_FIRE_AFTER - Fire timer after interval
.. index:: rtems_timer_fire_after .. index:: rtems_timer_fire_after
.. code:: c .. code-block:: c
rtems_status_code rtems_timer_fire_after( rtems_status_code rtems_timer_fire_after(
rtems_id id, rtems_id id,
@ -398,7 +398,7 @@ TIMER_FIRE_WHEN - Fire timer when specified
.. index:: rtems_timer_fire_when .. index:: rtems_timer_fire_when
.. code:: c .. code-block:: c
rtems_status_code rtems_timer_fire_when( rtems_status_code rtems_timer_fire_when(
rtems_id id, rtems_id id,
@ -446,7 +446,7 @@ TIMER_INITIATE_SERVER - Initiate server for task-based timers
.. index:: rtems_timer_initiate_server .. index:: rtems_timer_initiate_server
.. code:: c .. code-block:: c
rtems_status_code rtems_timer_initiate_server( rtems_status_code rtems_timer_initiate_server(
uint32_t priority, uint32_t priority,
@ -492,7 +492,7 @@ TIMER_SERVER_FIRE_AFTER - Fire task-based timer after interval
.. index:: rtems_timer_server_fire_after .. index:: rtems_timer_server_fire_after
.. code:: c .. code-block:: c
rtems_status_code rtems_timer_server_fire_after( rtems_status_code rtems_timer_server_fire_after(
rtems_id id, rtems_id id,
@ -541,7 +541,7 @@ TIMER_SERVER_FIRE_WHEN - Fire task-based timer when specified
.. index:: rtems_timer_server_fire_when .. index:: rtems_timer_server_fire_when
.. code:: c .. code-block:: c
rtems_status_code rtems_timer_server_fire_when( rtems_status_code rtems_timer_server_fire_when(
rtems_id id, rtems_id id,
@ -594,7 +594,7 @@ TIMER_RESET - Reset an interval timer
.. index:: rtems_timer_reset .. index:: rtems_timer_reset
.. code:: c .. code-block:: c
rtems_status_code rtems_timer_reset( rtems_status_code rtems_timer_reset(
rtems_id id rtems_id id

26
c_user/user_extensions.rst
View File

@ -58,7 +58,7 @@ such as performance monitoring or debugger support. RTEMS is informed of the
entry points which constitute an extension set via the following entry points which constitute an extension set via the following
structure:.. index:: rtems_extensions_table structure:.. index:: rtems_extensions_table
.. code:: c .. code-block:: c
typedef struct { typedef struct {
rtems_task_create_extension thread_create; rtems_task_create_extension thread_create;
@ -116,7 +116,7 @@ created:
.. index:: rtems extensions table index .. index:: rtems extensions table index
.. code:: c .. code-block:: c
index = rtems_object_id_get_index(extension_id); index = rtems_object_id_get_index(extension_id);
@ -161,7 +161,7 @@ following:
.. index:: rtems_task_create_extension .. index:: rtems_task_create_extension
.. index:: rtems_extension .. index:: rtems_extension
.. code:: c .. code-block:: c
bool user_task_create( bool user_task_create(
rtems_tcb *current_task, rtems_tcb *current_task,
@ -190,7 +190,7 @@ RTEMS. The extension should have a prototype similar to the following:
.. index:: rtems_task_start_extension .. index:: rtems_task_start_extension
.. code:: c .. code-block:: c
void user_task_start( void user_task_start(
rtems_tcb *current_task, rtems_tcb *current_task,
@ -213,7 +213,7 @@ similar to the following:
.. index:: rtems_task_restart_extension .. index:: rtems_task_restart_extension
.. code:: c .. code-block:: c
void user_task_restart( void user_task_restart(
rtems_tcb *current_task, rtems_tcb *current_task,
@ -237,7 +237,7 @@ following:
.. index:: rtems_task_delete_extension .. index:: rtems_task_delete_extension
.. code:: c .. code-block:: c
void user_task_delete( void user_task_delete(
rtems_tcb *current_task, rtems_tcb *current_task,
@ -262,7 +262,7 @@ by RTEMS. The extension should have a prototype similar to the following:
.. index:: rtems_task_switch_extension .. index:: rtems_task_switch_extension
.. code:: c .. code-block:: c
void user_task_switch( void user_task_switch(
rtems_tcb *current_task, rtems_tcb *current_task,
@ -285,7 +285,7 @@ following:
.. index:: rtems_task_begin_extension .. index:: rtems_task_begin_extension
.. code:: c .. code-block:: c
void user_task_begin( void user_task_begin(
rtems_tcb *current_task rtems_tcb *current_task
@ -307,7 +307,7 @@ user extension have a prototype similar to the following:
.. index:: rtems_task_exitted_extension .. index:: rtems_task_exitted_extension
.. code:: c .. code-block:: c
void user_task_exitted( void user_task_exitted(
rtems_tcb *current_task rtems_tcb *current_task
@ -335,7 +335,7 @@ following:
.. index:: rtems_fatal_extension .. index:: rtems_fatal_extension
.. code:: c .. code-block:: c
void user_fatal_error( void user_fatal_error(
Internal_errors_Source the_source, Internal_errors_Source the_source,
@ -442,7 +442,7 @@ EXTENSION_CREATE - Create a extension set
.. index:: rtems_extension_create .. index:: rtems_extension_create
.. code:: c .. code-block:: c
rtems_status_code rtems_extension_create( rtems_status_code rtems_extension_create(
rtems_name name, rtems_name name,
@ -485,7 +485,7 @@ EXTENSION_IDENT - Get ID of a extension set
.. index:: rtems_extension_ident .. index:: rtems_extension_ident
.. code:: c .. code-block:: c
rtems_status_code rtems_extension_ident( rtems_status_code rtems_extension_ident(
rtems_name name, rtems_name name,
@ -525,7 +525,7 @@ EXTENSION_DELETE - Delete a extension set
.. index:: rtems_extension_delete .. index:: rtems_extension_delete
.. code:: c .. code-block:: c
rtems_status_code rtems_extension_delete( rtems_status_code rtems_extension_delete(
rtems_id id rtems_id id