Changeset bd861cc6 in rtems


Ignore:
Timestamp:
Nov 9, 2009, 2:36:14 PM (10 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, master
Children:
2393825
Parents:
3ee8430b
Message:

2009-11-09 Joel Sherrill <joel.sherrill@…>

  • ada_user/Makefile.am, ada_user/ada_user.texi, user/Makefile.am, user/c_user.texi, user/concepts.t, user/overview.t, user/preface.texi, user/schedule.t, user/sem.t: Add table of figures. Add text and graphic of tree illustrating valid combinations of semaphore attributes.
  • user/semaphore_attributes.eps, user/semaphore_attributes.png: New files.
Location:
doc
Files:
2 added
10 edited

Legend:

Unmodified
Added
Removed
  • doc/ChangeLog

    r3ee8430b rbd861cc6  
     12009-11-09      Joel Sherrill <joel.sherrill@oarcorp.com>
     2
     3        * ada_user/Makefile.am, ada_user/ada_user.texi, user/Makefile.am,
     4        user/c_user.texi, user/concepts.t, user/overview.t,
     5        user/preface.texi, user/schedule.t, user/sem.t: Add table of figures.
     6        Add text and graphic of tree illustrating valid combinations of
     7        semaphore attributes.
     8        * user/semaphore_attributes.eps, user/semaphore_attributes.png:
     9        New files.
     10
    1112009-10-14      Joel Sherrill <joel.sherrill@oarcorp.com>
    212
  • doc/ada_user/Makefile.am

    r3ee8430b rbd861cc6  
    3939rtemspie.eps: $(top_srcdir)/user/rtemspie.eps
    4040        $(LN_S) $<
     41semaphore_attributes.eps: $(top_srcdir)/user/semaphore_attributes.eps
     42        $(LN_S) $<
    4143states.eps: $(top_srcdir)/user/states.eps
    4244        $(LN_S) $<
    43 CLEANFILES += rtemspie.eps states.eps rtemsarc.png rtemspie.png states.png \
    44     ObjectId-32Bits.png
     45CLEANFILES += rtrtemspie.eps states.eps rtemsarc.png rtemspie.png states.png \
     46    ObjectId-32Bits.png semaphore_attributes.png
    4547
    4648ObjectId-16Bits.png: $(top_srcdir)/user/ObjectId-16Bits.png
     
    5254rtemspie.png: $(top_srcdir)/user/rtemspie.png
    5355        $(LN_S) $<
     56semaphore_attributes.png: $(top_srcdir)/user/semaphore_attributes.png
     57        $(LN_S) $<
    5458states.png: $(top_srcdir)/user/states.png
    5559        $(LN_S) $<
     
    6064if USE_HTML
    6165html_project_DATA += rtemsarc.png rtemspie.png states.png \
    62     ObjectId-16Bits.png ObjectId-32Bits.png
     66    ObjectId-16Bits.png ObjectId-32Bits.png semaphore_attributes.png
    6367endif
    6468
    6569$(PROJECT).dvi: rtemspie.eps states.eps ObjectId-16Bits.eps \
    66     ObjectId-32Bits.eps
     70    ObjectId-32Bits.eps semaphore_attributes.eps
    6771PDF_IMAGES = rtemspie.pdf states.pdf
    6872
  • doc/ada_user/ada_user.texi

    r3ee8430b rbd861cc6  
    8080@contents
    8181
     82@node List of Figures, Preface, Top, Top
     83@unnumbered List of Figures
     84@listoffloats Figure
     85
    8286@include user/preface.texi
    8387@include user/overview.texi
     
    113117@include user/glossary.texi
    114118@ifinfo
    115 @node Top, Preface, (dir), (dir)
     119@node Top, List of Figures, (dir), (dir)
    116120@top ada_user
    117121
     
    119123
    120124@menu
     125* List of Figures::
    121126* Preface::
    122127* Overview::
  • doc/user/Makefile.am

    r3ee8430b rbd861cc6  
    2929
    3030PNG_FILES = rtemsarc.png rtemspie.png states.png ObjectId-32Bits.png \
    31     ObjectId-16Bits.png
     31    ObjectId-16Bits.png semaphore_attributes.png
    3232
    3333EPS_IMAGES = rtemspie.eps states.eps ObjectId-32Bits.eps \
    34     ObjectId-32Bits.eps
     34    ObjectId-32Bits.eps semaphore_attributes.eps
    3535$(PROJECT).dvi: $(EPS_IMAGES)
    3636
    3737PDF_IMAGES = rtemspie.pdf states.pdf ObjectId-16Bits.pdf \
    38     ObjectId-32Bits.pdf
     38    ObjectId-32Bits.pdf semaphore_attributes.pdf
    3939CLEANFILES += $(PDF_IMAGES)
    4040
  • doc/user/c_user.texi

    r3ee8430b rbd861cc6  
    7979@contents
    8080
     81@node List of Figures, Preface, Top, Top
     82@unnumbered List of Figures
     83@listoffloats Figure
     84
    8185@include preface.texi
    8286@include overview.texi
     
    112116@include glossary.texi
    113117@ifinfo
    114 @node Top, Preface, (dir), (dir)
     118@node Top, List of Figures, (dir), (dir)
    115119@top c_user
    116120
     
    118122
    119123@menu
     124* List of Figures::
    120125* Preface::
    121126* Overview::
  • doc/user/concepts.t

    r3ee8430b rbd861cc6  
    137137
    138138
     139@float Figure,fig:Object-Id-32
     140@caption{Thirty-Two Bit Object Id}
     141
    139142@ifset use-ascii
    140143@example
     
    152155@ifset use-tex
    153156@sp1
    154 @center{@image{ObjectId-32Bits,,2in}}
     157@center{@image{ObjectId-32Bits,,2in,Thirty-Two Bit Object Id}}
    155158@end ifset
    156159
     
    158161@html
    159162<P ALIGN="center"><IMG SRC="ObjectId-32Bits.png"
    160      WIDTH=550 HEIGHT=400 ALT="32 Bit Object Id"></P>
     163     WIDTH=550 HEIGHT=400 ALT="Thirty-Two Bit Object Id"></P>
    161164@end html
    162165@end ifset
     166@end float
    163167
    164168The most significant five bits are the object class.  The next
     
    177181is used to store object IDs.
    178182
     183@float Figure,fig:Object-Id-16
     184@caption{Sixteen Bit Object Id}
     185
    179186
    180187@ifset use-ascii
     
    193200@ifset use-tex
    194201@sp1
    195 @center{@image{ObjectId-16Bits,,2in}}
     202@center{@image{ObjectId-16Bits,,2in,Sixteen Bit Object Id}}
    196203@end ifset
    197204
     
    202209@end html
    203210@end ifset
     211@end float
    204212
    205213The sixteen-bit format is designed to be as similar as possible to the
  • doc/user/overview.t

    r3ee8430b rbd861cc6  
    141141Most hardware dependencies for real-time applications can be
    142142localized to the low level device drivers.
     143
     144@float Figure,fig:RTEMS-App-Arch
     145@caption{RTEMS Application Architecture}
    143146
    144147@ifset use-ascii
     
    215218@end html
    216219@end ifset
     220@end float
    217221
    218222The RTEMS I/O interface manager provides an efficient tool for incorporating
     
    236240environment that promotes the development of efficient real-time
    237241application systems.  The following figure illustrates this organization:
     242
     243@float Figure,fig:rtems-layers
     244@caption{RTEMS Layered Architecture}
    238245
    239246@ifset use-ascii
     
    252259
    253260@ifset use-tex
    254 @c for now use the ascii version
    255 @c @example
    256 @c @group
    257 @c            +-----------------------------------------------+
    258 @c            |          RTEMS Executive Interface            |
    259 @c            +-----------------------------------------------+
    260 @c            |                 RTEMS Core                    |
    261 @c            +-----------------------------------------------+
    262 @c            |              CPU Dependent Code               |
    263 @c            +-----------------------------------------------+
    264 @c @end group
    265 @c @end example
    266 @image{rtemspie,4in,3in}
     261@center{@image{rtemspie,4in,3in, RTEMS Layered Architecture}}
    267262@tex
    268263@end tex
     
    271266@ifset use-html
    272267@html
    273 <IMG SRC="rtemspie.png" WIDTH=500 HEIGHT=300 ALT="RTEMS Architecture">
     268<IMG SRC="rtemspie.png" WIDTH=500 HEIGHT=300 ALT="RTEMS Layered Architecture">
    274269@end html
    275270@end ifset
     271@end float
     272
    276273Subsequent chapters present a detailed description of the capabilities
    277274provided by each of the following RTEMS managers:
  • doc/user/preface.texi

    r3ee8430b rbd861cc6  
    88
    99@ifinfo
    10 @node Preface, Overview, Top, Top
     10@node Preface, Overview, List of Figures, Top
    1111@end ifinfo
    1212@unnumbered Preface
  • doc/user/schedule.t

    r3ee8430b rbd861cc6  
    207207now permitted to be scheduled for the processor and to compete
    208208for other system resources.
     209
     210@float Figure,fig:RTEMS-Task-States
     211@caption{RTEMS Task States}
    209212
    210213@ifset use-ascii
     
    244247@c @page
    245248@example
    246 @image{states,,3in}
    247 @c @group
    248 @c      +-------------------------------------------------------------+
    249 @c      |                         Non-existent                        |
    250 @c      |  +-------------------------------------------------------+  |
    251 @c      |  |                                                       |  |
    252 @c      |  |                                                       |  |
    253 @c      |  |      Creating        +---------+     Deleting         |  |
    254 @c      |  | -------------------> | Dormant | -------------------> |  |
    255 @c      |  |                      +---------+                      |  |
    256 @c      |  |                           |                           |  |
    257 @c      |  |                  Starting |                           |  |
    258 @c      |  |                           |                           |  |
    259 @c      |  |                           V          Deleting         |  |
    260 @c      |  |             +-------> +-------+ ------------------->  |  |
    261 @c      |  |  Yielding  /   +----- | Ready | ------+               |  |
    262 @c      |  |           /   /       +-------+ <--+   \              |  |
    263 @c      |  |          /   /                      \   \ Blocking    |  |
    264 @c      |  |         /   / Dispatching   Readying \   \            |  |
    265 @c      |  |        /   V                          \   V           |  |
    266 @c      |  |      +-----------+    Blocking     +---------+        |  |
    267 @c      |  |      | Executing | --------------> | Blocked |        |  |
    268 @c      |  |      +-----------+                 +---------+        |  |
    269 @c      |  |                                                       |  |
    270 @c      |  |                                                       |  |
    271 @c      |  +-------------------------------------------------------+  |
    272 @c      |                         Non-existent                        |
    273 @c      +-------------------------------------------------------------+
    274 @c @end group
     249@center{@image{states,,3in,RTEMS Task States}}
    275250@end example
    276251@end ifset
     
    281256@end html
    282257@end ifset
     258@end float
    283259
    284260A task occupies the blocked state whenever it is
  • doc/user/sem.t

    r3ee8430b rbd861cc6  
    232232globally, then the attribute_set parameter would be
    233233@code{@value{RPREFIX}GLOBAL @value{OR} @value{RPREFIX}PRIORITY}.
     234
     235Some combinatinos of these attributes are invalid.  For example, priority
     236ordered blocking discipline must be applied to a binary semaphore in order
     237to use either the priority inheritance or priority ceiling functionality.
     238The following tree figure illustrates the valid combinations.
     239
     240@float Figure,fig:semaphore-attributes
     241@caption{Valid Semaphore Attributes Combinations}
     242
     243@ifset use-ascii
     244@example
     245@group
     246Not available in ASCII representation
     247@end group
     248@end example
     249@end ifset
     250
     251@ifset use-tex
     252@example
     253@image{semaphore_attributes,5in,3.5in}
     254@end example
     255@end ifset
     256
     257@ifset use-html
     258@html
     259<IMG SRC="semaphore_attributes.png" WIDTH=550 HEIGHT=400 ALT="Valid Semaphore Attribute Combinations">
     260@end html
     261@end ifset
     262@end float
    234263
    235264@subsection Building a SEMAPHORE_OBTAIN Option Set
     
    469498ceiling (default)
    470499
    471 @item @code{@value{RPREFIX}LOCAL} - local task (default)
    472 
    473 @item @code{@value{RPREFIX}GLOBAL} - global task
     500@item @code{@value{RPREFIX}LOCAL} - local semaphore (default)
     501
     502@item @code{@value{RPREFIX}GLOBAL} - global semaphore
    474503@end itemize
    475504
     
    481510insertion in the local copy of the global object table.
    482511
    483 The total number of global objects, including
    484 semaphores, is limited by the maximum_global_objects field in
    485 the Configuration Table.
     512Note that some combinations of attributes are not valid.  See the
     513earlier discussion on this.
     514
     515The total number of global objects, including semaphores, is limited by
     516the maximum_global_objects field in the Configuration Table.
    486517
    487518@c
Note: See TracChangeset for help on using the changeset viewer.