Changeset 25d55d4 in rtems-docs


Ignore:
Timestamp:
Feb 18, 2016, 4:41:28 AM (4 years ago)
Author:
Chris Johns <chrisj@…>
Branches:
4.11, master
Children:
f29b7faf
Parents:
00d1a0a
git-author:
Chris Johns <chrisj@…> (02/18/16 04:41:28)
git-committer:
Amar Takhar <verm@…> (05/03/16 00:51:26)
Message:

Change code to code-block.

Location:
c_user
Files:
27 edited

Legend:

Unmodified
Added
Removed
  • c_user/barrier_manager.rst

    r00d1a0a r25d55d4  
    165165.. index:: rtems_barrier_create
    166166
    167 .. code:: c
     167.. code-block:: c
    168168
    169169    rtems_status_code rtems_barrier_create(
     
    242242.. index:: rtems_barrier_ident
    243243
    244 .. code:: c
     244.. code-block:: c
    245245
    246246    rtems_status_code rtems_barrier_ident(
     
    283283.. index:: rtems_barrier_delete
    284284
    285 .. code:: c
     285.. code-block:: c
    286286
    287287    rtems_status_code rtems_barrier_delete(
     
    327327.. index:: rtems_barrier_wait
    328328
    329 .. code:: c
     329.. code-block:: c
    330330
    331331    rtems_status_code rtems_barrier_wait(
     
    399399.. index:: rtems_barrier_release
    400400
    401 .. code:: c
     401.. code-block:: c
    402402
    403403    rtems_status_code rtems_barrier_release(
  • c_user/clock_manager.rst

    r00d1a0a r25d55d4  
    7171.. index:: rtems_time_of_day
    7272
    73 .. code:: c
     73.. code-block:: c
    7474
    7575    struct rtems_tod_control {
     
    214214.. index:: rtems_clock_set
    215215
    216 .. code:: c
     216.. code-block:: c
    217217
    218218    rtems_status_code rtems_clock_set(
     
    266266.. index:: rtems_clock_get
    267267
    268 .. code:: c
     268.. code-block:: c
    269269
    270270    rtems_status_code rtems_clock_get(
     
    334334.. index:: rtems_clock_get_tod
    335335
    336 .. code:: c
     336.. code-block:: c
    337337
    338338    rtems_status_code rtems_clock_get_tod(
     
    376376.. index:: rtems_clock_get_tod_timeval
    377377
    378 .. code:: c
     378.. code-block:: c
    379379
    380380    rtems_status_code rtems_clock_get_tod_interval(
     
    418418.. index:: rtems_clock_get_seconds_since_epoch
    419419
    420 .. code:: c
     420.. code-block:: c
    421421
    422422    rtems_status_code rtems_clock_get_seconds_since_epoch(
     
    461461.. index:: rtems_clock_get_ticks_per_second
    462462
    463 .. code:: c
     463.. code-block:: c
    464464
    465465    rtems_interval rtems_clock_get_ticks_per_second(void);
     
    491491.. index:: rtems_clock_get_ticks_since_boot
    492492
    493 .. code:: c
     493.. code-block:: c
    494494
    495495    rtems_interval rtems_clock_get_ticks_since_boot(void);
     
    522522.. index:: rtems_clock_tick_later
    523523
    524 .. code:: c
     524.. code-block:: c
    525525
    526526    rtems_interval rtems_clock_tick_later(
     
    547547.. index:: rtems_clock_tick_later_usec
    548548
    549 .. code:: c
     549.. code-block:: c
    550550
    551551    rtems_interval rtems_clock_tick_later_usec(
     
    572572.. index:: rtems_clock_tick_before
    573573
    574 .. code:: c
     574.. code-block:: c
    575575
    576576    rtems_interval rtems_clock_tick_before(
     
    591591**EXAMPLE:**
    592592
    593 .. code:: c
     593.. code-block:: c
    594594
    595595    status busy( void )
     
    615615.. index:: rtems_clock_get_uptime
    616616
    617 .. code:: c
     617.. code-block:: c
    618618
    619619    rtems_status_code rtems_clock_get_uptime(
     
    650650.. index:: rtems_clock_get_uptime_timeval
    651651
    652 .. code:: c
     652.. code-block:: c
    653653
    654654    void rtems_clock_get_uptime_timeval(
     
    681681.. index:: rtems_clock_get_uptime_seconds
    682682
    683 .. code:: c
     683.. code-block:: c
    684684
    685685    time_t rtems_clock_get_uptime_seconds(void);
     
    708708.. index:: rtems_clock_get_uptime_nanoseconds
    709709
    710 .. code:: c
     710.. code-block:: c
    711711
    712712    uint64_t rtems_clock_get_uptime_nanoseconds(void);
     
    736736.. index:: rtems_clock_set_nanoseconds_extension
    737737
    738 .. code:: c
     738.. code-block:: c
    739739
    740740    rtems_status_code rtems_clock_set_nanoseconds_extension(
     
    779779.. index:: rtems_clock_tick
    780780
    781 .. code:: c
     781.. code-block:: c
    782782
    783783    rtems_status_code rtems_clock_tick( void );
  • c_user/configuring_a_system.rst

    r00d1a0a r25d55d4  
    218218milliseconds is as follows:
    219219
    220 .. code:: c
     220.. code-block:: c
    221221
    222222    #include <bsp.h>
     
    376376configuration defines for supported object classes:
    377377
    378 .. code:: c
     378.. code-block:: c
    379379
    380380    #define CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
     
    410410is an example of using ``rtems_resource_unlimited``:
    411411
    412 .. code:: c
     412.. code-block:: c
    413413
    414414    #define CONFIGURE_MAXIMUM_TASKS rtems_resource_unlimited(5)
     
    491491``rtems_resource_unlimited`` macros themselves.
    492492
    493 .. code:: c
     493.. code-block:: c
    494494
    495495    #define CONFIGURE_UNLIMITED_OBJECTS
     
    20992099The interface for this macro is as follows:
    21002100
    2101 .. code:: c
     2101.. code-block:: c
    21022102
    21032103    CONFIGURE_MESSAGE_BUFFERS_FOR_QUEUE(max_messages, size_per)
     
    21442144messages with the message structure defined by the type ``other_message_type``.
    21452145
    2146 .. code:: c
     2146.. code-block:: c
    21472147
    21482148    #define CONFIGURE_MESSAGE_BUFFER_MEMORY \
     
    40114011will ensure that the two systems cannot interfere in an undesirable way.
    40124012
    4013 .. code:: c
     4013.. code-block:: c
    40144014
    40154015    #define CONFIGURE_SMP_MAXIMUM_PROCESSORS 8
  • c_user/cpu_usage_statistics.rst

    r00d1a0a r25d55d4  
    5858The following is an example of the report generated:
    5959
    60 .. code:: c
     60.. code-block:: c
    6161
    6262 +------------------------------------------------------------------------------+
     
    110110**CALLING SEQUENCE:**
    111111
    112 .. code:: c
     112.. code-block:: c
    113113
    114114    void rtems_cpu_usage_report( void );
     
    134134**CALLING SEQUENCE:**
    135135
    136 .. code:: c
     136.. code-block:: c
    137137
    138138    void rtems_cpu_usage_reset( void );
  • c_user/dual_ports_memory_manager.rst

    r00d1a0a r25d55d4  
    103103.. index:: rtems_port_create
    104104
    105 .. code:: c
     105.. code-block:: c
    106106
    107107    rtems_status_code rtems_port_create(
     
    158158.. index:: rtems_port_ident
    159159
    160 .. code:: c
     160.. code-block:: c
    161161
    162162    rtems_status_code rtems_port_ident(
     
    199199.. index:: rtems_port_delete
    200200
    201 .. code:: c
     201.. code-block:: c
    202202
    203203    rtems_status_code rtems_port_delete(
     
    237237.. index:: rtems_port_external_to_internal
    238238
    239 .. code:: c
     239.. code-block:: c
    240240
    241241    rtems_status_code rtems_port_external_to_internal(
     
    278278.. index:: rtems_port_internal_to_external
    279279
    280 .. code:: c
     280.. code-block:: c
    281281
    282282    rtems_status_code rtems_port_internal_to_external(
  • c_user/event_manager.rst

    r00d1a0a r25d55d4  
    185185.. index:: rtems_event_send
    186186
    187 .. code:: c
     187.. code-block:: c
    188188
    189189    rtems_status_code rtems_event_send (
     
    237237.. index:: rtems_event_receive
    238238
    239 .. code:: c
     239.. code-block:: c
    240240
    241241    rtems_status_code rtems_event_receive (
  • c_user/fatal_error.rst

    r00d1a0a r25d55d4  
    119119.. index:: rtems_fatal_error_occurred
    120120
    121 .. code:: c
     121.. code-block:: c
    122122
    123123    void rtems_fatal_error_occurred(
     
    159159.. index:: rtems_fatal
    160160
    161 .. code:: c
     161.. code-block:: c
    162162
    163163    void rtems_fatal(
     
    185185.. index:: rtems_exception_frame_print
    186186
    187 .. code:: c
     187.. code-block:: c
    188188
    189189    void rtems_exception_frame_print(
     
    209209.. index:: rtems_fatal_source_text
    210210
    211 .. code:: c
     211.. code-block:: c
    212212
    213213    const char *rtems_fatal_source_text(
     
    234234.. index:: rtems_internal_error_text
    235235
    236 .. code:: c
     236.. code-block:: c
    237237
    238238    const char *rtems_internal_error_text(
  • c_user/initialization.rst

    r00d1a0a r25d55d4  
    217217.. index:: rtems_initialize_executive
    218218
    219 .. code:: c
     219.. code-block:: c
    220220
    221221    void rtems_initialize_executive(void);
     
    247247.. index:: rtems_shutdown_executive
    248248
    249 .. code:: c
     249.. code-block:: c
    250250
    251251    void rtems_shutdown_executive(
  • c_user/interrupt_manager.rst

    r00d1a0a r25d55d4  
    6666.. index:: rtems_isr
    6767
    68 .. code:: c
     68.. code-block:: c
    6969
    7070    rtems_isr user_isr(
     
    269269.. index:: rtems_interrupt_catch
    270270
    271 .. code:: c
     271.. code-block:: c
    272272
    273273    rtems_status_code rtems_interrupt_catch(
     
    313313.. index:: rtems_interrupt_disable
    314314
    315 .. code:: c
     315.. code-block:: c
    316316
    317317    void rtems_interrupt_disable(
     
    351351.. index:: rtems_interrupt_enable
    352352
    353 .. code:: c
     353.. code-block:: c
    354354
    355355    void rtems_interrupt_enable(
     
    386386.. index:: rtems_interrupt_flash
    387387
    388 .. code:: c
     388.. code-block:: c
    389389
    390390    void rtems_interrupt_flash(
     
    422422.. index:: rtems_interrupt_local_disable
    423423
    424 .. code:: c
     424.. code-block:: c
    425425
    426426    void rtems_interrupt_local_disable(
     
    460460.. index:: rtems_interrupt_local_enable
    461461
    462 .. code:: c
     462.. code-block:: c
    463463
    464464    void rtems_interrupt_local_enable(
     
    491491.. index:: rtems_interrupt_lock_initialize
    492492
    493 .. code:: c
     493.. code-block:: c
    494494
    495495    void rtems_interrupt_lock_initialize(
     
    518518.. index:: rtems_interrupt_lock_acquire
    519519
    520 .. code:: c
     520.. code-block:: c
    521521
    522522    void rtems_interrupt_lock_acquire(
     
    548548.. index:: rtems_interrupt_lock_release
    549549
    550 .. code:: c
     550.. code-block:: c
    551551
    552552    void rtems_interrupt_lock_release(
     
    578578.. index:: rtems_interrupt_lock_acquire_isr
    579579
    580 .. code:: c
     580.. code-block:: c
    581581
    582582    void rtems_interrupt_lock_acquire_isr(
     
    612612.. index:: rtems_interrupt_lock_release_isr
    613613
    614 .. code:: c
     614.. code-block:: c
    615615
    616616    void rtems_interrupt_lock_release_isr(
     
    643643.. index:: rtems_interrupt_is_in_progress
    644644
    645 .. code:: c
     645.. code-block:: c
    646646
    647647    bool rtems_interrupt_is_in_progress(void);
  • c_user/io_manager.rst

    r00d1a0a r25d55d4  
    153153the following prototype:
    154154
    155 .. code:: c
     155.. code-block:: c
    156156
    157157    rtems_device_driver io_entry(
     
    230230.. index:: rtems_io_register_driver
    231231
    232 .. code:: c
     232.. code-block:: c
    233233
    234234    rtems_status_code rtems_io_register_driver(
     
    288288.. index:: rtems_io_unregister_driver
    289289
    290 .. code:: c
     290.. code-block:: c
    291291
    292292    rtems_status_code rtems_io_unregister_driver(
     
    322322.. index:: rtems_io_initialize
    323323
    324 .. code:: c
     324.. code-block:: c
    325325
    326326    rtems_status_code rtems_io_initialize(
     
    366366.. index:: rtems_io_register_name
    367367
    368 .. code:: c
     368.. code-block:: c
    369369
    370370    rtems_status_code rtems_io_register_name(
     
    402402.. index:: rtems_io_lookup_name
    403403
    404 .. code:: c
     404.. code-block:: c
    405405
    406406    rtems_status_code rtems_io_lookup_name(
     
    438438.. index:: rtems_io_open
    439439
    440 .. code:: c
     440.. code-block:: c
    441441
    442442    rtems_status_code rtems_io_open(
     
    477477.. index:: rtems_io_close
    478478
    479 .. code:: c
     479.. code-block:: c
    480480
    481481    rtems_status_code rtems_io_close(
     
    516516.. index:: rtems_io_read
    517517
    518 .. code:: c
     518.. code-block:: c
    519519
    520520    rtems_status_code rtems_io_read(
     
    556556.. index:: rtems_io_write
    557557
    558 .. code:: c
     558.. code-block:: c
    559559
    560560    rtems_status_code rtems_io_write(
     
    597597.. index:: rtems_io_control
    598598
    599 .. code:: c
     599.. code-block:: c
    600600
    601601    rtems_status_code rtems_io_control(
  • c_user/key_concepts.rst

    r00d1a0a r25d55d4  
    5151example illustrates this:
    5252
    53 .. code:: c
     53.. code-block:: c
    5454
    5555    rtems_name my_name;
     
    7171name:
    7272
    73 .. code:: c
     73.. code-block:: c
    7474
    7575    #include <rtems.h>
     
    107107object IDs.
    108108
    109 .. code:: c
     109.. code-block:: c
    110110
    111111    31      27 26   24 23          16 15                             0
     
    130130class, and index.  The data type ``rtems_id`` is used to store object IDs.
    131131
    132 .. code:: c
     132.. code-block:: c
    133133
    134134    15      11 10    8 7            0
     
    180180.. index:: rtems_object_id_get_index
    181181
    182 .. code:: c
     182.. code-block:: c
    183183
    184184    uint32_t rtems_object_id_get_api( rtems_id );
  • c_user/message_manager.rst

    r00d1a0a r25d55d4  
    224224.. index:: rtems_message_queue_create
    225225
    226 .. code:: c
     226.. code-block:: c
    227227
    228228    rtems_status_code rtems_message_queue_create(
     
    311311.. index:: rtems_message_queue_ident
    312312
    313 .. code:: c
     313.. code-block:: c
    314314
    315315    rtems_status_code rtems_message_queue_ident(
     
    365365.. index:: rtems_message_queue_delete
    366366
    367 .. code:: c
     367.. code-block:: c
    368368
    369369    rtems_status_code rtems_message_queue_delete(
     
    423423.. index:: rtems_message_queue_send
    424424
    425 .. code:: c
     425.. code-block:: c
    426426
    427427    rtems_status_code rtems_message_queue_send(
     
    481481.. index:: rtems_message_queue_urgent
    482482
    483 .. code:: c
     483.. code-block:: c
    484484
    485485    rtems_status_code rtems_message_queue_urgent(
     
    539539.. index:: rtems_message_queue_broadcast
    540540
    541 .. code:: c
     541.. code-block:: c
    542542
    543543    rtems_status_code rtems_message_queue_broadcast(
     
    598598.. index:: rtems_message_queue_receive
    599599
    600 .. code:: c
     600.. code-block:: c
    601601
    602602    rtems_status_code rtems_message_queue_receive(
     
    684684.. index:: rtems_message_queue_get_number_pending
    685685
    686 .. code:: c
     686.. code-block:: c
    687687
    688688    rtems_status_code rtems_message_queue_get_number_pending(
     
    724724.. index:: rtems_message_queue_flush
    725725
    726 .. code:: c
     726.. code-block:: c
    727727
    728728    rtems_status_code rtems_message_queue_flush(
  • c_user/multiprocessing.rst

    r00d1a0a r25d55d4  
    273273.. index:: rtems_mpci_entry
    274274
    275 .. code:: c
     275.. code-block:: c
    276276
    277277    rtems_mpci_entry user_mpci_initialization(
     
    297297should be adhere to the following prototype:
    298298
    299 .. code:: c
     299.. code-block:: c
    300300
    301301    rtems_mpci_entry user_mpci_get_packet(
     
    320320should be adhere to the following prototype:
    321321
    322 .. code:: c
     322.. code-block:: c
    323323
    324324    rtems_mpci_entry user_mpci_return_packet(
     
    336336should be adhere to the following prototype:
    337337
    338 .. code:: c
     338.. code-block:: c
    339339
    340340    rtems_mpci_entry user_mpci_receive_packet(
     
    354354should be adhere to the following prototype:
    355355
    356 .. code:: c
     356.. code-block:: c
    357357
    358358    rtems_mpci_entry user_mpci_send_packet(
     
    392392endian processors.  Little endian byte-ordering is shown below:
    393393
    394 .. code:: c
     394.. code-block:: c
    395395
    396396    +---------------+----------------+---------------+----------------+
     
    404404shown below:
    405405
    406 .. code:: c
     406.. code-block:: c
    407407
    408408    +---------------+----------------+---------------+----------------+
     
    480480.. index:: rtems_multiprocessing_announce
    481481
    482 .. code:: c
     482.. code-block:: c
    483483
    484484    void rtems_multiprocessing_announce( void );
  • c_user/object_services.rst

    r00d1a0a r25d55d4  
    110110printing the values.
    111111
    112 .. code:: c
     112.. code-block:: c
    113113
    114114    void printObjectId(rtems_id id)
     
    129129"next Id."
    130130
    131 .. code:: c
     131.. code-block:: c
    132132
    133133    rtems_id nextObjectId(rtems_id id)
     
    154154parts and "pretty-printed."
    155155
    156 .. code:: c
     156.. code-block:: c
    157157
    158158    void prettyPrintObjectId(rtems_id id)
     
    185185.. index:: rtems_build_name
    186186
    187 .. code:: c
     187.. code-block:: c
    188188
    189189    rtems_name rtems_build_name(
     
    219219.. index:: rtems_object_get_classic_name
    220220
    221 .. code:: c
     221.. code-block:: c
    222222
    223223    rtems_status_code rtems_object_get_classic_name(
     
    258258.. index:: rtems_object_get_name
    259259
    260 .. code:: c
     260.. code-block:: c
    261261
    262262    char* rtems_object_get_name(
     
    291291.. index:: rtems_object_set_name
    292292
    293 .. code:: c
     293.. code-block:: c
    294294
    295295    rtems_status_code rtems_object_set_name(
     
    339339.. index:: rtems_object_id_get_api
    340340
    341 .. code:: c
     341.. code-block:: c
    342342
    343343    int rtems_object_id_get_api(
     
    369369.. index:: rtems_object_id_get_class
    370370
    371 .. code:: c
     371.. code-block:: c
    372372
    373373    int rtems_object_id_get_class(
     
    399399.. index:: rtems_object_id_get_node
    400400
    401 .. code:: c
     401.. code-block:: c
    402402
    403403    int rtems_object_id_get_node(
     
    429429.. index:: rtems_object_id_get_index
    430430
    431 .. code:: c
     431.. code-block:: c
    432432
    433433    int rtems_object_id_get_index(
     
    459459.. index:: rtems_build_id
    460460
    461 .. code:: c
     461.. code-block:: c
    462462
    463463    rtems_id rtems_build_id(
     
    494494.. index:: rtems_object_id_api_minimum
    495495
    496 .. code:: c
     496.. code-block:: c
    497497
    498498    int rtems_object_id_api_minimum(void);
     
    520520.. index:: rtems_object_id_api_maximum
    521521
    522 .. code:: c
     522.. code-block:: c
    523523
    524524    int rtems_object_id_api_maximum(void);
     
    546546.. index:: rtems_object_api_minimum_class
    547547
    548 .. code:: c
     548.. code-block:: c
    549549
    550550    int rtems_object_api_minimum_class(
     
    578578.. index:: rtems_object_api_maximum_class
    579579
    580 .. code:: c
     580.. code-block:: c
    581581
    582582    int rtems_object_api_maximum_class(
     
    610610.. index:: rtems_object_get_api_name
    611611
    612 .. code:: c
     612.. code-block:: c
    613613
    614614    const char* rtems_object_get_api_name(
     
    643643.. index:: rtems_object_get_api_class_name
    644644
    645 .. code:: c
     645.. code-block:: c
    646646
    647647    const char *rtems_object_get_api_class_name(
     
    678678.. index:: rtems_object_get_class_information
    679679
    680 .. code:: c
     680.. code-block:: c
    681681
    682682    rtems_status_code rtems_object_get_class_information(
     
    706706specified ``api`` and ``the_class``. This structure is defined as follows:
    707707
    708 .. code:: c
     708.. code-block:: c
    709709
    710710    typedef struct {
  • c_user/overview.rst

    r00d1a0a r25d55d4  
    121121localized to the low level device drivers.
    122122
    123 .. COMMENT: .. code:: c
    124 .. COMMENT:
    125 .. COMMENT:     +-----------------------------------------------------------+
    126 .. COMMENT:     |             Application Dependent Software                |
    127 .. COMMENT:     |        +----------------------------------------+         |
    128 .. COMMENT:     |        |    Standard Application Components     |         |
    129 .. COMMENT:     |        |                          +-------------+---+     |
    130 .. COMMENT:     |    +---+-----------+              |                 |     |
    131 .. COMMENT:     |    | Board Support |              |      RTEMS      |     |
    132 .. COMMENT:     |    |    Package    |              |                 |     |
    133 .. COMMENT:     +----+---------------+--------------+-----------------+-----|
    134 .. COMMENT:     |                      Target Hardware                      |
    135 .. COMMENT:     +-----------------------------------------------------------+
    136 
    137123.. figure:: rtemsarc.png
    138124         :width: 488
     
    160146that promotes the development of efficient real-time application systems.  The
    161147following figure illustrates this organization:
    162 
    163 .. COMMENT: .. code:: c
    164 .. COMMENT:
    165 .. COMMENT:     +-----------------------------------------------+
    166 .. COMMENT:     |          RTEMS Executive Interface            |
    167 .. COMMENT:     +-----------------------------------------------+
    168 .. COMMENT:     |                 RTEMS Core                    |
    169 .. COMMENT:     +-----------------------------------------------+
    170 .. COMMENT:     |              CPU Dependent Code               |
    171 .. COMMENT:     +-----------------------------------------------+
    172148
    173149.. figure:: rtemspie.png
  • c_user/partition_manager.rst

    r00d1a0a r25d55d4  
    138138.. index:: rtems_partition_create
    139139
    140 .. code:: c
     140.. code-block:: c
    141141
    142142    rtems_status_code rtems_partition_create(
     
    233233.. index:: rtems_partition_ident
    234234
    235 .. code:: c
     235.. code-block:: c
    236236
    237237    rtems_status_code rtems_partition_ident(
     
    287287.. index:: rtems_partition_delete
    288288
    289 .. code:: c
     289.. code-block:: c
    290290
    291291    rtems_status_code rtems_partition_delete(
     
    338338.. index:: rtems_partition_get_buffer
    339339
    340 .. code:: c
     340.. code-block:: c
    341341
    342342    rtems_status_code rtems_partition_get_buffer(
     
    386386.. index:: rtems_partition_return_buffer
    387387
    388 .. code:: c
     388.. code-block:: c
    389389
    390390    rtems_status_code rtems_partition_return_buffer(
  • c_user/pci_library.rst

    r00d1a0a r25d55d4  
    293293always returned (reads).
    294294
    295 .. code:: c
     295.. code-block:: c
    296296
    297297    /* Configuration Space Access Read Routines */
     
    317317address, see `Access functions`_ for how addresses are translated.
    318318
    319 .. code:: c
     319.. code-block:: c
    320320
    321321    /* Read a register over PCI I/O Space */
     
    341341architecture must provide necessary functions in order to implement this.
    342342
    343 .. code:: c
     343.. code-block:: c
    344344
    345345    static inline uint16_t pci_ld_le16(volatile uint16_t *addr);
     
    365365pointer of a specific access type.
    366366
    367 .. code:: c
     367.. code-block:: c
    368368
    369369    /* Get Read/Write function for accessing a register over PCI Memory Space
     
    398398different PCI spaces/regions.
    399399
    400 .. code:: c
     400.. code-block:: c
    401401
    402402    /* Translate PCI address into CPU accessible address */
  • c_user/rate_monotonic_manager.rst

    r00d1a0a r25d55d4  
    265265Period(index)``.  The processor utilization can be calculated as follows:
    266266
    267 .. code:: c
     267.. code-block:: c
    268268
    269269    Utilization = 0
     
    274274utilization must adhere to the following rule:
    275275
    276 .. code:: c
     276.. code-block:: c
    277277
    278278    Utilization = maximum_tasks * (2**(1/maximum_tasks) - 1)
     
    648648.. index:: rtems_rate_monotonic_create
    649649
    650 .. code:: c
     650.. code-block:: c
    651651
    652652    rtems_status_code rtems_rate_monotonic_create(
     
    690690.. index:: rtems_rate_monotonic_ident
    691691
    692 .. code:: c
     692.. code-block:: c
    693693
    694694    rtems_status_code rtems_rate_monotonic_ident(
     
    729729.. index:: rtems_rate_monotonic_cancel
    730730
    731 .. code:: c
     731.. code-block:: c
    732732
    733733    rtems_status_code rtems_rate_monotonic_cancel(
     
    769769.. index:: rtems_rate_monotonic_delete
    770770
    771 .. code:: c
     771.. code-block:: c
    772772
    773773    rtems_status_code rtems_rate_monotonic_delete(
     
    810810.. index:: rtems_rate_monotonic_period
    811811
    812 .. code:: c
     812.. code-block:: c
    813813
    814814    rtems_status_code rtems_rate_monotonic_period(
     
    860860.. index:: rtems_rate_monotonic_get_status
    861861
    862 .. code:: c
     862.. code-block:: c
    863863
    864864    rtems_status_code rtems_rate_monotonic_get_status(
     
    886886.. index:: rtems_rate_monotonic_period_status
    887887
    888 .. code:: c
     888.. code-block:: c
    889889
    890890    typedef struct {
     
    924924.. index:: rtems_rate_monotonic_get_statistics
    925925
    926 .. code:: c
     926.. code-block:: c
    927927
    928928    rtems_status_code rtems_rate_monotonic_get_statistics(
     
    950950.. index:: rtems_rate_monotonic_period_statistics
    951951
    952 .. code:: c
     952.. code-block:: c
    953953
    954954    typedef struct {
     
    993993.. index:: rtems_rate_monotonic_reset_statistics
    994994
    995 .. code:: c
     995.. code-block:: c
    996996
    997997    rtems_status_code rtems_rate_monotonic_reset_statistics(
     
    10281028.. index:: rtems_rate_monotonic_reset_all_statistics
    10291029
    1030 .. code:: c
     1030.. code-block:: c
    10311031
    10321032    void rtems_rate_monotonic_reset_all_statistics(void);
     
    10561056.. index:: rtems_rate_monotonic_report_statistics
    10571057
    1058 .. code:: c
     1058.. code-block:: c
    10591059
    10601060    void rtems_rate_monotonic_report_statistics(void);
     
    10721072.. index:: rtems_rate_monotonic_period_statistics
    10731073
    1074 .. code:: c
     1074.. code-block:: c
    10751075
    10761076    ID      OWNER   PERIODS  MISSED    CPU TIME    WALL TIME
  • c_user/region_manager.rst

    r00d1a0a r25d55d4  
    233233.. index:: rtems_region_create
    234234
    235 .. code:: c
     235.. code-block:: c
    236236
    237237    rtems_status_code rtems_region_create(
     
    311311.. index:: rtems_region_ident
    312312
    313 .. code:: c
     313.. code-block:: c
    314314
    315315    rtems_status_code rtems_region_ident(
     
    352352.. index:: rtems_region_delete
    353353
    354 .. code:: c
     354.. code-block:: c
    355355
    356356    rtems_status_code rtems_region_delete(
     
    394394.. index:: rtems_region_extend
    395395
    396 .. code:: c
     396.. code-block:: c
    397397
    398398    rtems_status_code rtems_region_extend(
     
    438438.. index:: rtems_region_get_segment
    439439
    440 .. code:: c
     440.. code-block:: c
    441441
    442442    rtems_status_code rtems_region_get_segment(
     
    520520.. index:: rtems_region_return_segment
    521521
    522 .. code:: c
     522.. code-block:: c
    523523
    524524    rtems_status_code rtems_region_return_segment(
     
    570570.. index:: rtems_region_get_segment_size
    571571
    572 .. code:: c
     572.. code-block:: c
    573573
    574574    rtems_status_code rtems_region_get_segment_size(
     
    613613.. index:: rtems_region_resize_segment
    614614
    615 .. code:: c
     615.. code-block:: c
    616616
    617617    rtems_status_code rtems_region_resize_segment(
  • c_user/scheduling_concepts.rst

    r00d1a0a r25d55d4  
    328328other system resources.
    329329
    330 .. COMMENT: .. code:: c
    331 .. COMMENT:
    332 .. COMMENT:     +-------------------------------------------------------------+
    333 .. COMMENT:     |                         Non-existent                        |
    334 .. COMMENT:     |  +-------------------------------------------------------+  |
    335 .. COMMENT:     |  |                                                       |  |
    336 .. COMMENT:     |  |                                                       |  |
    337 .. COMMENT:     |  |      Creating        +---------+     Deleting         |  |
    338 .. COMMENT:     |  | -------------------> | Dormant | -------------------> |  |
    339 .. COMMENT:     |  |                      +---------+                      |  |
    340 .. COMMENT:     |  |                           |                           |  |
    341 .. COMMENT:     |  |                  Starting |                           |  |
    342 .. COMMENT:     |  |                           |                           |  |
    343 .. COMMENT:     |  |                           V          Deleting         |  |
    344 .. COMMENT:     |  |             +-------> +-------+ ------------------->  |  |
    345 .. COMMENT:     |  |  Yielding  /   +----- | Ready | ------+               |  |
    346 .. COMMENT:     |  |           /   /       +-------+ <--+   \\              |  |
    347 .. COMMENT:     |  |          /   /                      \\   \\ Blocking    |  |
    348 .. COMMENT:     |  |         /   / Dispatching   Readying \\   \\            |  |
    349 .. COMMENT:     |  |        /   V                          \\   V           |  |
    350 .. COMMENT:     |  |      +-----------+    Blocking     +---------+        |  |
    351 .. COMMENT:     |  |      | Executing | --------------> | Blocked |        |  |
    352 .. COMMENT:     |  |      +-----------+                 +---------+        |  |
    353 .. COMMENT:     |  |                                                       |  |
    354 .. COMMENT:     |  |                                                       |  |
    355 .. COMMENT:     |  +-------------------------------------------------------+  |
    356 .. COMMENT:     |                         Non-existent                        |
    357 .. COMMENT:     +-------------------------------------------------------------+
    358 
    359330.. figure:: states.png
    360331         :width: 70%
  • c_user/semaphore_manager.rst

    r00d1a0a r25d55d4  
    382382.. index:: rtems_semaphore_create
    383383
    384 .. code:: c
     384.. code-block:: c
    385385
    386386    rtems_status_code rtems_semaphore_create(
     
    496496.. index:: rtems_semaphore_ident
    497497
    498 .. code:: c
     498.. code-block:: c
    499499
    500500    rtems_status_code rtems_semaphore_ident(
     
    548548.. index:: rtems_semaphore_delete
    549549
    550 .. code:: c
     550.. code-block:: c
    551551
    552552    rtems_status_code rtems_semaphore_delete(
     
    606606.. index:: rtems_semaphore_obtain
    607607
    608 .. code:: c
     608.. code-block:: c
    609609
    610610    rtems_status_code rtems_semaphore_obtain(
     
    703703.. index:: rtems_semaphore_release
    704704
    705 .. code:: c
     705.. code-block:: c
    706706
    707707    rtems_status_code rtems_semaphore_release(
     
    763763.. index:: rtems_semaphore_flush
    764764
    765 .. code:: c
     765.. code-block:: c
    766766
    767767    rtems_status_code rtems_semaphore_flush(
     
    818818.. index:: rtems_semaphore_set_priority
    819819
    820 .. code:: c
     820.. code-block:: c
    821821
    822822    rtems_status_code rtems_semaphore_set_priority(
  • c_user/signal_manager.rst

    r00d1a0a r25d55d4  
    186186.. index:: rtems_asr
    187187
    188 .. code:: c
     188.. code-block:: c
    189189
    190190    rtems_asr user_routine(
     
    213213.. index:: rtems_signal_catch
    214214
    215 .. code:: c
     215.. code-block:: c
    216216
    217217    rtems_status_code rtems_signal_catch(
     
    274274.. index:: rtems_signal_send
    275275
    276 .. code:: c
     276.. code-block:: c
    277277
    278278    rtems_status_code rtems_signal_send(
  • c_user/stack_bounds_checker.rst

    r00d1a0a r25d55d4  
    8888shown below:
    8989
    90 .. code:: c
     90.. code-block:: c
    9191
    9292    #define CONFIGURE_STACK_CHECKER_ENABLED
     
    110110system.  The following is an example of the report generated:
    111111
    112 .. code:: c
     112.. code-block:: c
    113113
    114114    ID      NAME       LOW        HIGH     AVAILABLE      USED
     
    132132The following is an example of the output generated:
    133133
    134 .. code:: c
     134.. code-block:: c
    135135
    136136    BLOWN STACK!!! Offending task(0x3eb360): id=0x08010002; name=0x54413120
     
    158158**CALLING SEQUENCE:**
    159159
    160 .. code:: c
     160.. code-block:: c
    161161
    162162    bool rtems_stack_checker_is_blown( void );
     
    191191**CALLING SEQUENCE:**
    192192
    193 .. code:: c
     193.. code-block:: c
    194194
    195195    void rtems_stack_checker_report_usage( void );
  • c_user/symmetric_multiprocessing_services.rst

    r00d1a0a r25d55d4  
    503503be used to set up the environment variables.
    504504
    505 .. code:: c
     505.. code-block:: c
    506506
    507507    #include <stdlib.h>
     
    629629processor with index ``processor_index``.
    630630
    631 .. code:: c
     631.. code-block:: c
    632632
    633633    #include <rtems.h>
     
    662662**CALLING SEQUENCE:**
    663663
    664 .. code:: c
     664.. code-block:: c
    665665
    666666    uint32_t rtems_get_processor_count(void);
     
    691691**CALLING SEQUENCE:**
    692692
    693 .. code:: c
     693.. code-block:: c
    694694
    695695    uint32_t rtems_get_current_processor(void);
     
    723723**CALLING SEQUENCE:**
    724724
    725 .. code:: c
     725.. code-block:: c
    726726
    727727    rtems_status_code rtems_scheduler_ident(
     
    761761**CALLING SEQUENCE:**
    762762
    763 .. code:: c
     763.. code-block:: c
    764764
    765765    rtems_status_code rtems_scheduler_get_processor_set(
     
    801801**CALLING SEQUENCE:**
    802802
    803 .. code:: c
     803.. code-block:: c
    804804
    805805    rtems_status_code rtems_task_get_scheduler(
     
    836836**CALLING SEQUENCE:**
    837837
    838 .. code:: c
     838.. code-block:: c
    839839
    840840    rtems_status_code rtems_task_set_scheduler(
     
    911911**CALLING SEQUENCE:**
    912912
    913 .. code:: c
     913.. code-block:: c
    914914
    915915    rtems_status_code rtems_task_get_affinity(
     
    951951**CALLING SEQUENCE:**
    952952
    953 .. code:: c
     953.. code-block:: c
    954954
    955955    rtems_status_code rtems_task_set_affinity(
     
    990990processor affinity set of the task.  It is also not an error if the processor
    991991affinity set contains processors that are not part of the system.
    992 
  • c_user/task_manager.rst

    r00d1a0a r25d55d4  
    235235.. index:: rtems_task
    236236
    237 .. code:: c
     237.. code-block:: c
    238238
    239239    rtems_task user_task(
     
    583583.. index:: rtems_task_create
    584584
    585 .. code:: c
     585.. code-block:: c
    586586
    587587    rtems_status_code rtems_task_create(
     
    721721.. index:: rtems_task_ident
    722722
    723 .. code:: c
     723.. code-block:: c
    724724
    725725    rtems_status_code rtems_task_ident(
     
    776776.. index:: rtems_task_self
    777777
    778 .. code:: c
     778.. code-block:: c
    779779
    780780    rtems_id rtems_task_self(void);
     
    803803.. index:: rtems_task_start
    804804
    805 .. code:: c
     805.. code-block:: c
    806806
    807807    rtems_status_code rtems_task_start(
     
    857857.. index:: rtems_task_restart
    858858
    859 .. code:: c
     859.. code-block:: c
    860860
    861861    rtems_status_code rtems_task_restart(
     
    919919.. index:: rtems_task_delete
    920920
    921 .. code:: c
     921.. code-block:: c
    922922
    923923    rtems_status_code rtems_task_delete(
     
    975975.. index:: rtems_task_suspend
    976976
    977 .. code:: c
     977.. code-block:: c
    978978
    979979    rtems_status_code rtems_task_suspend(
     
    10231023.. index:: rtems_task_resume
    10241024
    1025 .. code:: c
     1025.. code-block:: c
    10261026
    10271027    rtems_status_code rtems_task_resume(
     
    10691069.. index:: rtems_task_is_suspended
    10701070
    1071 .. code:: c
     1071.. code-block:: c
    10721072
    10731073    rtems_status_code rtems_task_is_suspended(
     
    11101110**CALLING SEQUENCE:**
    11111111
    1112 .. code:: c
     1112.. code-block:: c
    11131113
    11141114    rtems_status_code rtems_task_set_priority(
     
    11761176.. index:: rtems_task_mode
    11771177
    1178 .. code:: c
     1178.. code-block:: c
    11791179
    11801180    rtems_status_code rtems_task_mode(
     
    12511251.. index:: rtems_task_wake_after
    12521252
    1253 .. code:: c
     1253.. code-block:: c
    12541254
    12551255    rtems_status_code rtems_task_wake_after(
     
    12951295.. index:: rtems_task_wake_when
    12961296
    1297 .. code:: c
     1297.. code-block:: c
    12981298
    12991299    rtems_status_code rtems_task_wake_when(
     
    13381338.. index:: rtems_iterate_over_all_threads
    13391339
    1340 .. code:: c
     1340.. code-block:: c
    13411341
    13421342    typedef void (*rtems_per_thread_routine)(Thread_Control *the_thread);
     
    13811381.. index:: rtems_task_variable_add
    13821382
    1383 .. code:: c
     1383.. code-block:: c
    13841384
    13851385    rtems_status_code rtems_task_variable_add(
     
    14431443.. index:: rtems_task_variable_get
    14441444
    1445 .. code:: c
     1445.. code-block:: c
    14461446
    14471447    rtems_status_code rtems_task_variable_get(
     
    15021502.. index:: rtems_task_variable_delete
    15031503
    1504 .. code:: c
     1504.. code-block:: c
    15051505
    15061506    rtems_status_code rtems_task_variable_delete(
  • c_user/timer_manager.rst

    r00d1a0a r25d55d4  
    8989.. index:: rtems_timer_service_routine
    9090
    91 .. code:: c
     91.. code-block:: c
    9292
    9393    rtems_timer_service_routine user_routine(
     
    198198.. index:: rtems_timer_create
    199199
    200 .. code:: c
     200.. code-block:: c
    201201
    202202    rtems_status_code rtems_timer_create(
     
    240240.. index:: rtems_timer_ident
    241241
    242 .. code:: c
     242.. code-block:: c
    243243
    244244    rtems_status_code rtems_timer_ident(
     
    281281.. index:: rtems_timer_cancel
    282282
    283 .. code:: c
     283.. code-block:: c
    284284
    285285    rtems_status_code rtems_timer_cancel(
     
    317317.. index:: rtems_timer_delete
    318318
    319 .. code:: c
     319.. code-block:: c
    320320
    321321    rtems_status_code rtems_timer_delete(
     
    355355.. index:: rtems_timer_fire_after
    356356
    357 .. code:: c
     357.. code-block:: c
    358358
    359359    rtems_status_code rtems_timer_fire_after(
     
    399399.. index:: rtems_timer_fire_when
    400400
    401 .. code:: c
     401.. code-block:: c
    402402
    403403    rtems_status_code rtems_timer_fire_when(
     
    447447.. index:: rtems_timer_initiate_server
    448448
    449 .. code:: c
     449.. code-block:: c
    450450
    451451    rtems_status_code rtems_timer_initiate_server(
     
    493493.. index:: rtems_timer_server_fire_after
    494494
    495 .. code:: c
     495.. code-block:: c
    496496
    497497    rtems_status_code rtems_timer_server_fire_after(
     
    542542.. index:: rtems_timer_server_fire_when
    543543
    544 .. code:: c
     544.. code-block:: c
    545545
    546546    rtems_status_code rtems_timer_server_fire_when(
     
    595595.. index:: rtems_timer_reset
    596596
    597 .. code:: c
     597.. code-block:: c
    598598
    599599    rtems_status_code rtems_timer_reset(
  • c_user/user_extensions.rst

    r00d1a0a r25d55d4  
    5959structure:.. index:: rtems_extensions_table
    6060
    61 .. code:: c
     61.. code-block:: c
    6262
    6363    typedef struct {
     
    117117.. index:: rtems extensions table index
    118118
    119 .. code:: c
     119.. code-block:: c
    120120
    121121    index = rtems_object_id_get_index(extension_id);
     
    162162.. index:: rtems_extension
    163163
    164 .. code:: c
     164.. code-block:: c
    165165
    166166    bool user_task_create(
     
    191191.. index:: rtems_task_start_extension
    192192
    193 .. code:: c
     193.. code-block:: c
    194194
    195195    void user_task_start(
     
    214214.. index:: rtems_task_restart_extension
    215215
    216 .. code:: c
     216.. code-block:: c
    217217
    218218    void user_task_restart(
     
    238238.. index:: rtems_task_delete_extension
    239239
    240 .. code:: c
     240.. code-block:: c
    241241
    242242    void user_task_delete(
     
    263263.. index:: rtems_task_switch_extension
    264264
    265 .. code:: c
     265.. code-block:: c
    266266
    267267    void user_task_switch(
     
    286286.. index:: rtems_task_begin_extension
    287287
    288 .. code:: c
     288.. code-block:: c
    289289
    290290    void user_task_begin(
     
    308308.. index:: rtems_task_exitted_extension
    309309
    310 .. code:: c
     310.. code-block:: c
    311311
    312312    void user_task_exitted(
     
    336336.. index:: rtems_fatal_extension
    337337
    338 .. code:: c
     338.. code-block:: c
    339339
    340340    void user_fatal_error(
     
    443443.. index:: rtems_extension_create
    444444
    445 .. code:: c
     445.. code-block:: c
    446446
    447447    rtems_status_code rtems_extension_create(
     
    486486.. index:: rtems_extension_ident
    487487
    488 .. code:: c
     488.. code-block:: c
    489489
    490490    rtems_status_code rtems_extension_ident(
     
    526526.. index:: rtems_extension_delete
    527527
    528 .. code:: c
     528.. code-block:: c
    529529
    530530    rtems_status_code rtems_extension_delete(
Note: See TracChangeset for help on using the changeset viewer.