diff options
author | Joel Sherrill <joel@rtems.org> | 2016-11-15 10:37:59 -0600 |
---|---|---|
committer | Joel Sherrill <joel@rtems.org> | 2017-01-11 12:13:21 -0600 |
commit | 48a7fa31f918a6fc88719b3c9393a9ba2829f42a (patch) | |
tree | 10bf638de133099fcabe5fe713ca98a546a27ab2 /doc/common | |
parent | Remove obsolete __RTEMS_HAVE_SYS_CPUSET_H__ (diff) | |
download | rtems-48a7fa31f918a6fc88719b3c9393a9ba2829f42a.tar.bz2 |
Remove texinfo format documentation. Replaced by Sphinx formatted documentation.
closes #2812.
Diffstat (limited to '')
-rw-r--r-- | doc/common/cpright.texi | 39 | ||||
-rw-r--r-- | doc/common/opengroup_manpage_acknowledgement.texi | 32 | ||||
-rw-r--r-- | doc/common/opengroup_preface_acknowledgement.texi | 37 | ||||
-rw-r--r-- | doc/common/rtems.texi.in | 6 | ||||
-rw-r--r-- | doc/common/setup.texi | 60 | ||||
-rw-r--r-- | doc/common/treedef.tex | 317 | ||||
-rw-r--r-- | doc/common/wksheets.t | 406 |
7 files changed, 0 insertions, 897 deletions
diff --git a/doc/common/cpright.texi b/doc/common/cpright.texi deleted file mode 100644 index 5a0bd426a0..0000000000 --- a/doc/common/cpright.texi +++ /dev/null @@ -1,39 +0,0 @@ -@c -@c COPYRIGHT (c) 1988-2015. -@c On-Line Applications Research Corporation (OAR). -@c All rights reserved. - -@c -@c The following puts a space somewhere on an otherwise empty page so we -@c can force the copyright description onto a left hand page. -@c - -@tex -{\parskip=0pt \hfill On-Line Applications Research Corporation\par \hfill -\TeX{}info \texinfoversion\par } -@end tex - -@vskip 0pt plus 1filll -COPYRIGHT @copyright{} 1988 - 2015.@* -On-Line Applications Research Corporation (OAR).@* - -The authors have used their best efforts in preparing -this material. These efforts include the development, research, -and testing of the theories and programs to determine their -effectiveness. No warranty of any kind, expressed or implied, -with regard to the software or the material contained in this -document is provided. No liability arising out of the -application or use of any product described in this document is -assumed. The authors reserve the right to revise this material -and to make changes from time to time in the content hereof -without obligation to notify anyone of such revision or changes. - -The RTEMS Project is hosted at @uref{http://www.rtems.org}. Any -inquiries concerning RTEMS, its related support components, or its -documentation should be directed to the Community Project hosted at -@uref{http://www.rtems.org}. - -Any inquiries for commercial services including training, support, custom -development, application development assistance should be directed to -@uref{http://www.rtems.com}. - diff --git a/doc/common/opengroup_manpage_acknowledgement.texi b/doc/common/opengroup_manpage_acknowledgement.texi deleted file mode 100644 index d840fff5fa..0000000000 --- a/doc/common/opengroup_manpage_acknowledgement.texi +++ /dev/null @@ -1,32 +0,0 @@ -@c -@c COPYRIGHT (c) 1988-2009. -@c On-Line Applications Research Corporation (OAR). -@c All rights reserved. - -@c -@c The RTEMS Project has been granted permission from The Open Group -@c IEEE to excerpt and use portions of the POSIX standards documents -@c in the RTEMS POSIX API User's Guide and RTEMS Shell User's Guide. -@c We have to include a specific acknowledgement paragraph in these -@c documents (e.g. preface or copyright page) and another slightly -@c different paragraph for each manual page that excerpts and uses -@c text from the standards. -@c -@c This file should help ensure that the paragraphs are consistent -@c and not duplicated. -@c - -@quotation -Portions of this text are reprinted and reproduced in electronic -form from IEEE Std 1003.1, 2004 Edition, Standard for Information -Technology — Operating System Interface (POSIX), The Open -Group Base Specifications Issue 6, Copyright © 2001-2004 by the -Institute of Electrical and Electronics Engineers, Inc and The -Open Group. In the event of any discrepancy between this version -and the original IEEE and The Open Group Standard, the original -IEEE and The Open Group Standard is the referee document. The -original Standard can be obtained online at -@uref{http://www.opengroup.org/unix/online.html, -http://www.opengroup.org/unix/online.html}. -@end quotation - diff --git a/doc/common/opengroup_preface_acknowledgement.texi b/doc/common/opengroup_preface_acknowledgement.texi deleted file mode 100644 index e740114db2..0000000000 --- a/doc/common/opengroup_preface_acknowledgement.texi +++ /dev/null @@ -1,37 +0,0 @@ -@c -@c COPYRIGHT (c) 1988-2009. -@c On-Line Applications Research Corporation (OAR). -@c All rights reserved. - -@c -@c The RTEMS Project has been granted permission from The Open Group -@c IEEE to excerpt and use portions of the POSIX standards documents -@c in the RTEMS POSIX API User's Guide and RTEMS Shell User's Guide. -@c We have to include a specific acknowledgement paragraph in these -@c documents (e.g. preface or copyright page) and another slightly -@c different paragraph for each manual page that excerpts and uses -@c text from the standards. -@c -@c This file should help ensure that the paragraphs are consistent -@c and not duplicated -@c - -@quotation -The Institute of Electrical and Electronics Engineers, Inc and The -Open Group, have given us permission to reprint portions of their -documentation. - -Portions of this text are reprinted and reproduced in electronic -form from IEEE Std 1003.1, 2004 Edition, Standard for Information -Technology — Operating System Interface (POSIX), The Open -Group Base Specifications Issue 6, Copyright © 2001-2004 by the -Institute of Electrical and Electronics Engineers, Inc and The -Open Group. In the event of any discrepancy between this version -and the original IEEE and The Open Group Standard, the original -IEEE and The Open Group Standard is the referee document. The -original Standard can be obtained online at -@uref{http://www.opengroup.org/unix/online.html, -http://www.opengroup.org/unix/online.html}. - -This notice shall appear on any product containing this material. -@end quotation diff --git a/doc/common/rtems.texi.in b/doc/common/rtems.texi.in deleted file mode 100644 index 063e5e90ee..0000000000 --- a/doc/common/rtems.texi.in +++ /dev/null @@ -1,6 +0,0 @@ -@set RTEMSUSERS users@@rtems.org -@set RTEMSDEVEL devel@@rtems.org -@set RTEMSHTTPURL http://www.rtems.org -@set RTEMSPREFIX @RTEMSPREFIX@ -@set RTEMSAPI @RTEMSAPI@ -@set RTEMSRPMPREFIX @RTEMSRPMPREFIX@ diff --git a/doc/common/setup.texi b/doc/common/setup.texi deleted file mode 100644 index 1e34e8e44d..0000000000 --- a/doc/common/setup.texi +++ /dev/null @@ -1,60 +0,0 @@ -@c -@c COPYRIGHT (c) 1988-2002. -@c On-Line Applications Research Corporation (OAR). -@c All rights reserved. - -@c -@c The following determines which set of the tables and figures we will use. -@c We default to ASCII but if available TeX or HTML versions will -@c be used instead. -@c - -@set use-ascii -@c @clear use-html -@c @clear use-tex - -@iftex -@clear use-ascii -@clear use-html -@set use-tex -@end iftex - -@ifhtml -@clear use-ascii -@clear use-tex -@set use-html -@end ifhtml - -@c -@c The following variable says to use texinfo or html for the two column -@c texinfo tables. For somethings the format does not look good in html. -@c With our adjustment to the left column in TeX, it nearly always looks -@c good printed. -@c -@ifset use-ascii -@set use-texinfo-tables -@end ifset -@ifset use-tex -@set use-texinfo-tables -@end ifset -@ifset use-html -@clear use-texinfo-tables -@end ifset - -@c -@c Custom whitespace adjustments. We could fiddle a bit more. -@c -@tex -\global\parindent 0in -\global\chapheadingskip = 15pt plus 4pt minus 2pt -\global\secheadingskip = 12pt plus 4pt minus 2pt -\global\subsecheadingskip = 9pt plus 4pt minus 2pt -\global\hbadness = 10000 -\global\tolerance = 6000 -\global\tableindent = 1.5in -\global\itemindent = 0.5in - -@ifclear smallbook -\global\parskip 6pt plus 1pt -@end ifclear -@end tex diff --git a/doc/common/treedef.tex b/doc/common/treedef.tex deleted file mode 100644 index 26eda0c28c..0000000000 --- a/doc/common/treedef.tex +++ /dev/null @@ -1,317 +0,0 @@ -% treedef.tex -% -% These definitions for tree macros are taken from "Trees in TeX", -% by David Eppstein, as published in TUGboat 6#1, March 1985. -% David Eppstein's address (as of 15 June 1988) is -% Computer Science Department -% Columbia University -% New York, NY 10027 -% Eppstein@cs.Columbia.edu -% -% Tree -- a macro to make aligned (horizontal) trees in TeX -% -% Input is of the form -% \tree -% item -% \subtree -% \leaf{item} -% . -% . -% . -% \endsubtree -% \subtree -% . -% . -% . -% \endsubtree -% \endsubtree -% \endtree -% -% Nesting is to any level. \leaf is defined as a subtree of one item: -% \def\leaf#1{\subtree#1\endsubtree}. -% -% A structure: -% \subtree -% item_part1 -% item_part2 -% . -% . -% . -% -% will print item_part2 directly below item_part1 as a single item -% as if they were in a \box. -% -% The macro is a 3-pass macro. On the first pass it sets up a data -% structure from the \subtree ... \endsubtree definitions. On the second pass -% it recursively calculates the width of each level of the tree. On the third -% pass it sets up the boxes, glue and rules. -% -% By David Eppstein, TUGboat, vol. 6 (1985), no. 1, pp. 31--35. -% Transcribed by Margaret Kromer (peg), Feb., 1986. -% -% Pass 1 -% At the end of pass 1, the tree is coded as a nested collection of \hboxes -% and \vboxes. -\newbox\treebox\newcount\treeboxcnt -\def\tree{\message{Begin tree}\treeboxcnt=1\global\setbox\treebox=\boxtree} -\def\subtree{\ettext \advance\treeboxcnt by 1 \boxtree} -\def\leaf#1{\subtree#1\endsubtree} -\def\endsubtree{\ettext \egroup \advance\treeboxcnt-1{}% - \ifnum\treeboxcnt=-1 \treeerrora\fi} -\def\endtree{\endsubtree \ifnum\treeboxcnt>0 \treeerrorb\fi% - \settreesizes \typesettree \message{-- end tree}} -% Error messages for unbalanced tree -\def\treeerrora{\errhelp=\treeerrorahelp% - \errmessage{Unbalanced tree -- too many endsubtrees}} -\newhelp\treeerrorahelp{There are more subtrees closed than opened} -\def\treeerrorb{\errhelp=\treeerrorbhelp% - \errmessage{Unbalanced tree -- not enough endsubtrees}} -\newhelp\treeerrorbhelp{Not all the subtrees of the tree are closed. -If you continue, you'll get some mysterious secondary errors.} -% Set up \vbox containing root of tree -\newif\iftreetext\treetextfalse % Whether still aligning text -\def\boxtree{\hbox\bgroup % Start outer box of tree or subtree - \baselineskip 2.5ex % Narrow line spacing slightly - \tabskip 0pt % No spurious glue in alignment - \vbox\bgroup % Start inner text \vbox - \treetexttrue % Remember for \ettext - \let\par\crcr \obeylines % New line breaks without explicit \cr - \halign\bgroup##\hfil\cr} % Start alignment with simple template -\def\ettext{\iftreetext % Are we still in inner text \vbox? - \crcr\egroup \egroup \fi} % Yes, end alignment and box -% Pass 2 -% Recursively calculate widths of tree with \setsizes; keep results in -% \treesizes; \treewidth contains total width calculated so far. \treeworkbox -% is workspace containing subtree being sized. -\newbox\treeworkbox -\def\cons#1#2{\edef#2{\xmark #1#2}} % Add something to start of list -\def\car#1{\expandafter\docar#1\docar} % Take first element of list -\def\docar\xmark#1\xmark#2\docar{#1} % ..by ignoring rest in expansion -\def\cdr#1{\expandafter\docdr#1\docdr#1}% Similarly, drop first element -\def\docdr\xmark#1\xmark#2\docdr#3{\def#3{\xmark #2}} -\def\xmark{\noexpand\xmark} % List separator expands to self -\def\nil{\xmark} % Empty list is just separator -\def\settreesizes{\setbox\treeworkbox=\copy\treebox% - \global\let\treesizes\nil \setsizes} -\newdimen\treewidth % Width of this part of the tree -\def\setsizes{\setbox\treeworkbox=\hbox\bgroup% Get a horiz list as a workspace - \unhbox\treeworkbox\unskip % Take tree, unpack it into horiz list - \inittreewidth % Get old width at this level - \sizesubtrees % Recurse through all subtrees - \sizelevel % Now set width from remaining \vbox - \egroup} % All done, finish our \hbox -\def\inittreewidth{\ifx\treesizes\nil % If this is the first at this level - \treewidth=0pt % ..then we have no previous max width - \else \treewidth=\car\treesizes % Otherwise take old max level width - \global\cdr\treesizes % ..and advance level width storage - \fi} % ..in preparation for next level. -\def\sizesubtrees{\loop % For each box in horiz list (subtree) - \setbox\treeworkbox=\lastbox \unskip % ..pull it off list and flush glue - \ifhbox\treeworkbox \setsizes % If hbox, it's a subtree - recurse - \repeat} % ..and loop; end loop on tree text -\def\sizelevel{% - \ifdim\treewidth<\wd\treeworkbox % If greater than previous maximum - \treewidth=\wd\treeworkbox \fi % Then set max to new high - \global\cons{\the\treewidth}\treesizes}% In either case, put back on list -% Pass 3 -% Recursively typeset tree with \maketree by adding an \hbox containing -% a subtree (in \treebox) to the horizontal list. -\newdimen\treeheight % Height of this part of the tree -\newif\ifleaf % Tree has no subtrees (is a leaf) -\newif\ifbotsub % Bottom subtree of parent -\newif\iftopsub % Top subtree of parent -\def\typesettree{\medskip\maketree\medskip} % Make whole tree -\def\maketree{\hbox{\treewidth=\car\treesizes % Get width at this level - \cdr\treesizes % Set up width list for recursion - \makesubtreebox\unskip % Set \treebox to text, make subtrees - \ifleaf \makeleaf % No subtrees, add glue - \else \makeparent \fi}} % Have subtrees, stick them at right -{\catcode`@=11 % Be able to use \voidb@x -\gdef\makesubtreebox{\unhbox\treebox % Open up tree or subtree - \unskip\global\setbox\treebox\lastbox % Pick up very last box - \ifvbox\treebox % If we're already at the \vbox - \global\leaftrue \let\next\relax % ..then this is a leaf - \else \botsubtrue % Otherwise, we have subtrees - \setbox\treeworkbox\box\voidb@x % Init stack of processed subs - \botsubtrue \let\next\makesubtree % ..and call \maketree on them - \fi \next}} % Finish up for whichever it was -\def\makesubtree{\setbox1\maketree % Call \maketree on this subtree - \unskip\global\setbox\treebox\lastbox % Pick up box before it - \treeheight=\ht1 % Get height of subtree we made - \advance\treeheight 2ex % Add some room around the edges - \ifhbox\treebox \topsubfalse % If picked up box is a \vbox, - \else \topsubtrue \fi % ..this is the top, otherwise not - \addsubtreebox % Stack subtree with the rest - \iftopsub \global\leaffalse % If top, remember not a leaf - \let\next\relax \else % ..(after recursion), set return - \botsubfalse \let\next\makesubtree % Otherwise, we have more subtrees - \fi \next} % Do tail recursion or return -\def\addsubtreebox{\setbox\treeworkbox=\vbox{\subtreebox\unvbox\treeworkbox}} -\def\subtreebox{\hbox\bgroup % Start \hbox of tree and lines - \vbox to \treeheight\bgroup % Start \vbox for vertical rules - \ifbotsub \iftopsub \vfil % If both bottom and top subtree - \hrule width 0.4pt % ..vertical rule is just a dot - \else \treehalfrule \fi \vfil % Bottom gets half-height rule - \else \iftopsub \vfil \treehalfrule % Top gets half-height the other way - \else \hrule width 0.4pt height \treeheight \fi\fi % Middle, full height - \egroup % Finish vertical rule \vbox - \treectrbox{\hrule width 1em}\hskip 0.2em\treectrbox{\box1}\egroup} -\def\treectrbox#1{\vbox to \treeheight{\vfil #1\vfil}} -\def\treehalfrule{\dimen\treeworkbox=\treeheight % Get total height - \divide\dimen\treeworkbox 2% - \advance\dimen\treeworkbox 0.2pt % Divide by two, add half horiz height - \hrule width 0.4pt height \dimen\treeworkbox}% Make a vertical rule that high -\def\makeleaf{\box\treebox} % Add leaf box to horiz list -\def\makeparent{\ifdim\ht\treebox>% - \ht\treeworkbox % If text is higher than subtrees - \treeheight=\ht\treebox % ..use that height - \else \treeheight=\ht\treeworkbox \fi % Otherwise use height of subtrees - \advance\treewidth-\wd\treebox % Take remainder of level width - \advance\treewidth 1em % ..after accounting for text and glue - \treectrbox{\box\treebox}\hskip 0.2em % Add text, space before connection -\treectrbox{\hrule width \treewidth}% - \treectrbox{\box\treeworkbox}} % Add \hrule, subs - -************************************************ -% Plain TeX driver for tree.tex - -\def\uncatcodespecials{\catcode`@=12\def\do##1{\catcode`##1=12}\dospecials} -\def\setupverbatim{\tt\obeylines\uncatcodespecials\obeyspaces} -{\obeyspaces\global\let =\ } -\def\beginshowoff{\par\begingroup\setupverbatim\doverbatim} -{\catcode`\!=0 \catcode`\\=12 -!obeylines!gdef!doverbatim^^M#1\endshowoff{#1!endgroup!medbreak!filbreak% -!smallskip}} - -% see The TeXbook, exercise 22.14 -%\input tree.tex -\centerline{\bf TREE TREE} -\bigskip -\tree - {Tree} - Uses - \subtree - Computer - Science - \subtree - Data - Structures - \leaf{Search Tree} - \leaf{Priority Queue} - \endsubtree - \subtree - Parsing - \leaf{Parse Tree} - \leaf{Symbol Table} - \endsubtree - \subtree - Structured - Programming - \endsubtree - \endsubtree - \subtree - Genealogy - \leaf{Ancestors} - \leaf{Descendants} - \endsubtree - \subtree - Electrical - Engineering - \subtree - Paper - \leaf{{\it Vitae}} - \leaf{Announcements} - \leaf{Proposals} - \leaf{\TeX{} Samples} - \endsubtree - \endsubtree - \subtree - Construction - \leaf{Fences} - \subtree - Buildings - \subtree - Houses - \leaf{Human} - \leaf{Dog} - \leaf{Bird} - \leaf{Tree} - \endsubtree - \leaf{Barns} - \leaf{Other} - \endsubtree - \leaf{\dots} - \endsubtree - \subtree - Taxonomies - \leaf{Tree Uses} - \endsubtree -\endtree - -\vskip.5truein -\beginshowoff -% see The TeXbook, exercise 22.14 -\input tree.tex -\centerline{TREE TREE} -\bigskip -\tree - Tree - Uses - \subtree - Computer - Science - \subtree - Data - Structures - \leaf{Search Tree} - \leaf{Priority Queue} - \endsubtree - \subtree - Parsing - \leaf{Parse Tree} - \leaf{Symbol Table} - \endsubtree - \subtree - Structured - Programming - \endsubtree - \endsubtree - \subtree - Genealogy - \leaf{Ancestors} - \leaf{Descendants} - \endsubtree - \subtree - Electrical - Engineering - \subtree - Paper - \leaf{{\it Vitae}} - \leaf{Announcements} - \leaf{Proposals} - \leaf{\TeX{} Samples} - \endsubtree - \endsubtree - \subtree - Construction - \leaf{Fences} - \subtree - Buildings - \subtree - Houses - \leaf{Human} - \leaf{Dog} - \leaf{Bird} - \leaf{Tree} - \endsubtree - \leaf{Barns} - \leaf{Other} - \endsubtree - \leaf{\dots} - \endsubtree - \subtree - Taxonomies - \leaf{Tree Uses} - \endsubtree -\endtree -\endshowoff diff --git a/doc/common/wksheets.t b/doc/common/wksheets.t deleted file mode 100644 index 61a3d7485e..0000000000 --- a/doc/common/wksheets.t +++ /dev/null @@ -1,406 +0,0 @@ -@c ****** This comment is here to remind you not to edit the wksheets.t -@c ****** in any directory but common. -@c -@c Figures ... -@c RTEMS RAM Workspace Worksheet -@c RTEMS Code Space Worksheet -@c -@c COPYRIGHT (c) 1988-2002. -@c On-Line Applications Research Corporation (OAR). -@c All rights reserved. - -@chapter Memory Requirements - -@section Introduction - -Memory is typically a limited resource in real-time -embedded systems, therefore, RTEMS can be configured to utilize -the minimum amount of memory while meeting all of the -applications requirements. Worksheets are provided which allow -the RTEMS application developer to determine the amount of RTEMS -code and RAM workspace which is required by the particular -configuration. Also provided are the minimum code space, -maximum code space, and the constant data space required by -RTEMS. - -@section Data Space Requirements - -RTEMS requires a small amount of memory for its -private variables. This data area must be in RAM and is -separate from the RTEMS RAM Workspace. The following -illustrates the data space required for all configurations of -RTEMS: - -@itemize @bullet -@item Data Space: RTEMS_DATA_SPACE -@end itemize - -@section Minimum and Maximum Code Space Requirements - -A maximum configuration of RTEMS includes the core -and all managers, including the multiprocessing manager. -Conversely, a minimum configuration of RTEMS includes only the -core and the following managers: initialization, task, interrupt -and fatal error. The following illustrates the code space -required by these configurations of RTEMS: - -@itemize @bullet -@item Minimum Configuration: RTEMS_MINIMUM_CONFIGURATION -@item Maximum Configuration: RTEMS_MAXIMUM_CONFIGURATION -@end itemize - -@section RTEMS Code Space Worksheet - -The RTEMS Code Space Worksheet is a tool provided to -aid the RTEMS application designer to accurately calculate the -memory required by the RTEMS run-time environment. RTEMS allows -the custom configuration of the executive by optionally -excluding managers which are not required by a particular -application. This worksheet provides the included and excluded -size of each manager in tabular form allowing for the quick -calculation of any custom configuration of RTEMS. The RTEMS -Code Space Worksheet is below: - -@ifset use-ascii -@page -@end ifset -@ifset use-tex -@page -@end ifset - -@page -@center @b{RTEMS Code Space Worksheet} -@sp 1 - -@ifset use-ascii - -The following is a list of the components of the RTEMS code space. The first -number in parentheses is the size when the component is included, -while the second number indicates its size when not included. If the second -number is "NA", then the component must always be included. - -@itemize @bullet -@item Core (RTEMS_CORE_CODE_SIZE, NA) -@item Initialization (RTEMS_INITIALIZATION_CODE_SIZE, NA) -@item Task (RTEMS_TASK_CODE_SIZE, NA) -@item Interrupt (RTEMS_INTERRUPT_CODE_SIZE, NA) -@item Clock (RTEMS_CLOCK_CODE_SIZE, NA) -@item Timer (RTEMS_TIMER_CODE_SIZE, RTEMS_TIMER_CODE_OPTSIZE) -@item Semaphore (RTEMS_SEMAPHORE_CODE_SIZE, RTEMS_SEMAPHORE_CODE_OPTSIZE) -@item Message (RTEMS_MESSAGE_CODE_SIZE, RTEMS_MESSAGE_CODE_OPTSIZE) -@item Event (RTEMS_EVENT_CODE_SIZE, RTEMS_EVENT_CODE_OPTSIZE) -@item Signal (RTEMS_SIGNAL_CODE_SIZE, RTEMS_SIGNAL_CODE_OPTSIZE) -@item Partition (RTEMS_PARTITION_CODE_SIZE, RTEMS_PARTITION_CODE_OPTSIZE) -@item Region (RTEMS_REGION_CODE_SIZE, RTEMS_REGION_CODE_OPTSIZE) -@item Dual Ported Memory (RTEMS_DPMEM_CODE_SIZE, RTEMS_DPMEM_CODE_OPTSIZE) -@item I/O (RTEMS_IO_CODE_SIZE, RTEMS_IO_CODE_OPTSIZE) -@item Fatal Error (RTEMS_FATAL_ERROR_CODE_SIZE, NA) -@item Rate Monotonic (RTEMS_RATE_MONOTONIC_CODE_SIZE, RTEMS_RATE_MONOTONIC_CODE_OPTSIZE) -@item Multiprocessing (RTEMS_MULTIPROCESSING_CODE_SIZE, RTEMS_MULTIPROCESSING_CODE_OPTSIZE) -@end itemize -@end ifset - -@ifset use-tex - -@tex -\line{\hskip 0.50in\vbox{\offinterlineskip\halign{ -\vrule\strut#& -\hbox to 2.25in{\enskip\hfil#\hfil}& -\vrule#& -\hbox to 1.00in{\enskip\hfil#\hfil}& -\vrule#& -\hbox to 1.00in{\enskip\hfil#\hfil}& -\vrule#& -\hbox to 1.25in{\enskip\hfil#\hfil}& -\vrule#\cr -\noalign{\hrule} -&\bf Component && \bf Included && \bf Not Included && \bf Size &\cr\noalign{\hrule} -&Core && RTEMS_CORE_CODE_SIZE && NA && &\cr\noalign{\hrule} -&Initialization && RTEMS_INITIALIZATION_CODE_SIZE && NA && &\cr\noalign{\hrule} -&Task && RTEMS_TASK_CODE_SIZE && NA && &\cr\noalign{\hrule} -&Interrupt && RTEMS_INTERRUPT_CODE_SIZE && NA && &\cr\noalign{\hrule} -&Clock && RTEMS_CLOCK_CODE_SIZE && NA && &\cr\noalign{\hrule} -&Timer && RTEMS_TIMER_CODE_SIZE && RTEMS_TIMER_CODE_OPTSIZE && &\cr\noalign{\hrule} -&Semaphore && RTEMS_SEMAPHORE_CODE_SIZE && RTEMS_SEMAPHORE_CODE_OPTSIZE && &\cr\noalign{\hrule} -&Message && RTEMS_MESSAGE_CODE_SIZE && RTEMS_MESSAGE_CODE_OPTSIZE && &\cr\noalign{\hrule} -&Event && RTEMS_EVENT_CODE_SIZE && RTEMS_EVENT_CODE_OPTSIZE && &\cr\noalign{\hrule} -&Signal && RTEMS_SIGNAL_CODE_SIZE && RTEMS_SIGNAL_CODE_OPTSIZE && &\cr\noalign{\hrule} -&Partition && RTEMS_PARTITION_CODE_SIZE && RTEMS_PARTITION_CODE_OPTSIZE && &\cr\noalign{\hrule} -&Region && RTEMS_REGION_CODE_SIZE && RTEMS_REGION_CODE_OPTSIZE && &\cr\noalign{\hrule} -&Dual Ported Memory && RTEMS_DPMEM_CODE_SIZE && RTEMS_DPMEM_CODE_OPTSIZE && &\cr\noalign{\hrule} -&I/O && RTEMS_IO_CODE_SIZE && RTEMS_IO_CODE_OPTSIZE && &\cr\noalign{\hrule} -&Fatal Error && RTEMS_FATAL_ERROR_CODE_SIZE && NA && &\cr\noalign{\hrule} -&Rate Monotonic && RTEMS_RATE_MONOTONIC_CODE_SIZE && RTEMS_RATE_MONOTONIC_CODE_OPTSIZE && &\cr\noalign{\hrule} -&Multiprocessing && RTEMS_MULTIPROCESSING_CODE_SIZE && RTEMS_MULTIPROCESSING_CODE_OPTSIZE && &\cr\noalign{\hrule} -&\multispan 5 \bf\hfil Total Code Space Requirements\qquad\hfil&&&\cr\noalign{\hrule} -}}\hfil} -@end tex -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=4 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=center><STRONG>Component</STRONG></TD> - <TD ALIGN=center><STRONG>Included</STRONG></TD> - <TD ALIGN=center><STRONG>Not Included</STRONG></TD> - <TD ALIGN=center><STRONG>Size</STRONG></TD></TR> -<TR><TD ALIGN=center>Core</TD> - <TD ALIGN=center>RTEMS_CORE_CODE_SIZE</TD> - <TD ALIGN=center>NA</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Initialization</TD> - <TD ALIGN=center>RTEMS_INITIALIZATION_CODE_SIZE</TD> - <TD ALIGN=center>NA</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Task</TD> - <TD ALIGN=center>RTEMS_TASK_CODE_SIZE</TD> - <TD ALIGN=center>NA</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Interrupt</TD> - <TD ALIGN=center>RTEMS_INTERRUPT_CODE_SIZE</TD> - <TD ALIGN=center>NA</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Clock</TD> - <TD ALIGN=center>RTEMS_CLOCK_CODE_SIZE</TD> - <TD ALIGN=center>NA</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Timer</TD> - <TD ALIGN=center>RTEMS_TIMER_CODE_SIZE</TD> - <TD ALIGN=center>RTEMS_TIMER_CODE_OPTSIZE</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Semaphore</TD> - <TD ALIGN=center>RTEMS_SEMAPHORE_CODE_SIZE</TD> - <TD ALIGN=center>RTEMS_SEMAPHORE_CODE_OPTSIZE</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Message</TD> - <TD ALIGN=center>RTEMS_MESSAGE_CODE_SIZE</TD> - <TD ALIGN=center>RTEMS_MESSAGE_CODE_OPTSIZE</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Event</TD> - <TD ALIGN=center>RTEMS_EVENT_CODE_SIZE</TD> - <TD ALIGN=center>RTEMS_EVENT_CODE_OPTSIZE</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Signal</TD> - <TD ALIGN=center>RTEMS_SIGNAL_CODE_SIZE</TD> - <TD ALIGN=center>RTEMS_SIGNAL_CODE_OPTSIZE</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Partition</TD> - <TD ALIGN=center>RTEMS_PARTITION_CODE_SIZE</TD> - <TD ALIGN=center>RTEMS_PARTITION_CODE_OPTSIZE</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Region</TD> - <TD ALIGN=center>RTEMS_REGION_CODE_SIZE</TD> - <TD ALIGN=center>RTEMS_REGION_CODE_OPTSIZE</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Dual Ported Memory</TD> - <TD ALIGN=center>RTEMS_DPMEM_CODE_SIZE</TD> - <TD ALIGN=center>RTEMS_DPMEM_CODE_OPTSIZE</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>I/O</TD> - <TD ALIGN=center>RTEMS_IO_CODE_SIZE</TD> - <TD ALIGN=center>RTEMS_IO_CODE_OPTSIZE</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Fatal Error</TD> - <TD ALIGN=center>RTEMS_FATAL_ERROR_CODE_SIZE</TD> - <TD ALIGN=center>NA</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Rate Monotonic</TD> - <TD ALIGN=center>RTEMS_RATE_MONOTONIC_CODE_SIZE</TD> - <TD ALIGN=center>RTEMS_RATE_MONOTONIC_CODE_OPTSIZE</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center>Multiprocessing</TD> - <TD ALIGN=center>RTEMS_MULTIPROCESSING_CODE_SIZE</TD> - <TD ALIGN=center>RTEMS_MULTIPROCESSING_CODE_OPTSIZE</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=center COLSPAN=3> - <STRONG>Total Code Space Requirements</STRONG></TD> - <TD><BR></TD></TR> - </TABLE> -</CENTER> -@end html -@end ifset - -@page - -@c ****** Next node is set by a sed script in the document Makefile. -@c ****** This comment is here to remind you not to edit the wksheets.t -@c ****** in any directory but common. - -@section RTEMS RAM Workspace Worksheet - -The RTEMS RAM Workspace Worksheet is a tool provided -to aid the RTEMS application designer to accurately calculate -the minimum memory block to be reserved for RTEMS use. This -worksheet provides equations for calculating the amount of -memory required based upon the number of objects configured, -whether for single or multiple processor versions of the -executive. This information is presented in tabular form, along -with the fixed system requirements, allowing for quick -calculation of any application defined configuration of RTEMS. -The RTEMS RAM Workspace Worksheet is provided below: - -@ifset use-ascii -@page -@end ifset -@ifset use-tex -@sp 2 -@end ifset - -@center @b{RTEMS RAM Workspace Worksheet} -@sp 2 - -@ifset use-ascii -The total RTEMS RAM Workspace required is the sum of the following: - -@itemize @bullet -@item maximum_tasks * RTEMS_BYTES_PER_TASK -@item maximum_timers * RTEMS_BYTES_PER_TIMER -@item maximum_semaphores * RTEMS_BYTES_PER_SEMAPHORE -@item maximum_message_queues * RTEMS_BYTES_PER_MESSAGE_QUEUE -@item maximum_regions * RTEMS_BYTES_PER_REGION -@item maximum_partitions * RTEMS_BYTES_PER_PARTITION -@item maximum_ports * RTEMS_BYTES_PER_PORT -@item maximum_periods * RTEMS_BYTES_PER_PERIOD -@item maximum_extensions * RTEMS_BYTES_PER_EXTENSION -@item Floating Point Tasks * RTEMS_BYTES_PER_FP_TASK -@item Task Stacks -@item maximum_nodes * RTEMS_BYTES_PER_NODE -@item maximum_global_objects * RTEMS_BYTES_PER_GLOBAL_OBJECT -@item maximum_proxies * RTEMS_BYTES_PER_PROXY -@item Fixed System Requirements of RTEMS_BYTES_OF_FIXED_SYSTEM_REQUIREMENTS -@end itemize -@end ifset - -@ifset use-tex -@tex -\line{\hskip 0.75in\vbox{\offinterlineskip\halign{ -\vrule\strut#& -\hbox to 3.0in{\enskip\hfil#\hfil}& -\vrule#& -\hbox to 0.75in{\enskip\hfil#\hfil}& -\vrule#& -\hbox to 1.25in{\enskip\hfil#\hfil}& -\vrule#\cr -\noalign{\hrule} -& \bf Description && \bf Equation && \bf Bytes Required &\cr\noalign{\hrule} -& maximum\_tasks && * RTEMS_BYTES_PER_TASK = &&&\cr\noalign{\hrule} -& maximum\_timers && * RTEMS_BYTES_PER_TIMER = &&&\cr\noalign{\hrule} -& maximum\_semaphores && * RTEMS_BYTES_PER_SEMAPHORE = &&&\cr\noalign{\hrule} -& maximum\_message\_queues && * RTEMS_BYTES_PER_MESSAGE_QUEUE = &&&\cr\noalign{\hrule} -& maximum\_regions && * RTEMS_BYTES_PER_REGION = &&&\cr\noalign{\hrule} -& maximum\_partitions && * RTEMS_BYTES_PER_PARTITION = &&&\cr\noalign{\hrule} -& maximum\_ports && * RTEMS_BYTES_PER_PORT = &&&\cr\noalign{\hrule} -& maximum\_periods && * RTEMS_BYTES_PER_PERIOD = &&&\cr\noalign{\hrule} -& maximum\_extensions && * RTEMS_BYTES_PER_EXTENSION = &&&\cr\noalign{\hrule} -& Floating Point Tasks && * RTEMS_BYTES_PER_FP_TASK = &&&\cr\noalign{\hrule} -& Task Stacks &&\hskip 2.3em=&&&\cr\noalign{\hrule} -& Total Single Processor Requirements &&&&&\cr\noalign{\hrule} -}}\hfil} - -\line{\hskip 0.75in\vbox{\offinterlineskip\halign{ -\vrule\strut#& -\hbox to 3.0in{\enskip\hfil#\hfil}& -\vrule#& -\hbox to 0.75in{\enskip\hfil#\hfil}& -\vrule#& -\hbox to 1.25in{\enskip\hfil#\hfil}& -\vrule#\cr -\noalign{\hrule} -& \bf Description && \bf Equation && \bf Bytes Required &\cr\noalign{\hrule} -& maximum\_nodes && * RTEMS_BYTES_PER_NODE = &&&\cr\noalign{\hrule} -& maximum\_global\_objects && * RTEMS_BYTES_PER_GLOBAL_OBJECT = &&&\cr\noalign{\hrule} -& maximum\_proxies && * RTEMS_BYTES_PER_PROXY = &&&\cr\noalign{\hrule} -}}\hfil} - -\line{\hskip 0.75in\vbox{\offinterlineskip\halign{ -\vrule\strut#& -\hbox to 3.0in{\enskip\hfil#\hfil}& -\vrule#& -\hbox to 0.75in{\enskip\hfil#\hfil}& -\vrule#& -\hbox to 1.25in{\enskip\hfil#\hfil}& -\vrule#\cr -\noalign{\hrule} -& Total Multiprocessing Requirements &&&&&\cr\noalign{\hrule} -& Fixed System Requirements && RTEMS_BYTES_OF_FIXED_SYSTEM_REQUIREMENTS &&&\cr\noalign{\hrule} -& Total Single Processor Requirements &&&&&\cr\noalign{\hrule} -& Total Multiprocessing Requirements &&&&&\cr\noalign{\hrule} -& Minimum Bytes for RTEMS Workspace &&&&&\cr\noalign{\hrule} -}}\hfil} -@end tex -@end ifset - -@ifset use-html -@html -<CENTER> - <TABLE COLS=3 WIDTH="80%" BORDER=2> -<TR><TD ALIGN=center><STRONG>Description</STRONG></TD> - <TD ALIGN=center><STRONG>Equation</STRONG></TD> - <TD ALIGN=center><STRONG>Bytes Required</STRONG></TD></TR> -<TR><TD ALIGN=left>maximum_tasks</TD> - <TD ALIGN=right>* RTEMS_BYTES_PER_TASK =</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left>maximum_timers</TD> - <TD ALIGN=right>* RTEMS_BYTES_PER_TIMER =</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left>maximum_semaphores</TD> - <TD ALIGN=right>* RTEMS_BYTES_PER_SEMAPHORE =</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left>maximum_message_queues</TD> - <TD ALIGN=right>* RTEMS_BYTES_PER_MESSAGE_QUEUE =</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left>maximum_regions</TD> - <TD ALIGN=right>* RTEMS_BYTES_PER_REGION =</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left>maximum_partitions</TD> - <TD ALIGN=right>* RTEMS_BYTES_PER_PARTITION =</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left>maximum_ports</TD> - <TD ALIGN=right>* RTEMS_BYTES_PER_PORT =</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left>maximum_periods</TD> - <TD ALIGN=right>* RTEMS_BYTES_PER_PERIOD =</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left>maximum_extensions</TD> - <TD ALIGN=right>* RTEMS_BYTES_PER_EXTENSION =</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left>Floating Point Tasks</TD> - <TD ALIGN=right>* RTEMS_BYTES_PER_FP_TASK =</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left COLSPAN=2>Task Stacks</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left COLSPAN=2> - <STRONG>Total Single Processor Requirements</STRONG></TD> - <TD><BR></TD></TR> -<TR></TR> -<TR><TD ALIGN=center><STRONG>Description</STRONG></TD> - <TD ALIGN=center><STRONG>Equation</STRONG></TD> - <TD ALIGN=center><STRONG>Bytes Required</STRONG></TD></TR> -<TR><TD ALIGN=left>maximum_nodes</TD> - <TD ALIGN=right>* RTEMS_BYTES_PER_NODE =</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left>maximum_global_objects</TD> - <TD ALIGN=right>* RTEMS_BYTES_PER_GLOBAL_OBJECT =</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left>maximum_proxies</TD> - <TD ALIGN=right>* RTEMS_BYTES_PER_PROXY =</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left COLSPAN=2> - <STRONG>Total Multiprocessing Requirements</STRONG></TD> - <TD><BR></TD></TR> -<TR></TR> -<TR><TD ALIGN=left COLSPAN=2>Fixed System Requirements</TD> - <TD ALIGN=center>RTEMS_BYTES_OF_FIXED_SYSTEM_REQUIREMENTS</TD></TR> -<TR><TD ALIGN=left COLSPAN=2>Total Single Processor Requirements</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left COLSPAN=2>Total Multiprocessing Requirements</TD> - <TD><BR></TD></TR> -<TR><TD ALIGN=left COLSPAN=2> - <STRONG>Minimum Bytes for RTEMS Workspace</STRONG></TD> - <TD><BR></TD></TR> - </TABLE> -</CENTER> -@end html -@end ifset - |