From 48a7fa31f918a6fc88719b3c9393a9ba2829f42a Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Tue, 15 Nov 2016 10:37:59 -0600 Subject: Remove texinfo format documentation. Replaced by Sphinx formatted documentation. closes #2812. --- doc/common/wksheets.t | 406 -------------------------------------------------- 1 file changed, 406 deletions(-) delete mode 100644 doc/common/wksheets.t (limited to 'doc/common/wksheets.t') 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 -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ComponentIncludedNot IncludedSize
CoreRTEMS_CORE_CODE_SIZENA
InitializationRTEMS_INITIALIZATION_CODE_SIZENA
TaskRTEMS_TASK_CODE_SIZENA
InterruptRTEMS_INTERRUPT_CODE_SIZENA
ClockRTEMS_CLOCK_CODE_SIZENA
TimerRTEMS_TIMER_CODE_SIZERTEMS_TIMER_CODE_OPTSIZE
SemaphoreRTEMS_SEMAPHORE_CODE_SIZERTEMS_SEMAPHORE_CODE_OPTSIZE
MessageRTEMS_MESSAGE_CODE_SIZERTEMS_MESSAGE_CODE_OPTSIZE
EventRTEMS_EVENT_CODE_SIZERTEMS_EVENT_CODE_OPTSIZE
SignalRTEMS_SIGNAL_CODE_SIZERTEMS_SIGNAL_CODE_OPTSIZE
PartitionRTEMS_PARTITION_CODE_SIZERTEMS_PARTITION_CODE_OPTSIZE
RegionRTEMS_REGION_CODE_SIZERTEMS_REGION_CODE_OPTSIZE
Dual Ported MemoryRTEMS_DPMEM_CODE_SIZERTEMS_DPMEM_CODE_OPTSIZE
I/ORTEMS_IO_CODE_SIZERTEMS_IO_CODE_OPTSIZE
Fatal ErrorRTEMS_FATAL_ERROR_CODE_SIZENA
Rate MonotonicRTEMS_RATE_MONOTONIC_CODE_SIZERTEMS_RATE_MONOTONIC_CODE_OPTSIZE
MultiprocessingRTEMS_MULTIPROCESSING_CODE_SIZERTEMS_MULTIPROCESSING_CODE_OPTSIZE
- Total Code Space Requirements
-
-@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 -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
DescriptionEquationBytes Required
maximum_tasks* RTEMS_BYTES_PER_TASK =
maximum_timers* RTEMS_BYTES_PER_TIMER =
maximum_semaphores* RTEMS_BYTES_PER_SEMAPHORE =
maximum_message_queues* RTEMS_BYTES_PER_MESSAGE_QUEUE =
maximum_regions* RTEMS_BYTES_PER_REGION =
maximum_partitions* RTEMS_BYTES_PER_PARTITION =
maximum_ports* RTEMS_BYTES_PER_PORT =
maximum_periods* RTEMS_BYTES_PER_PERIOD =
maximum_extensions* RTEMS_BYTES_PER_EXTENSION =
Floating Point Tasks* RTEMS_BYTES_PER_FP_TASK =
Task Stacks
- Total Single Processor Requirements
DescriptionEquationBytes Required
maximum_nodes* RTEMS_BYTES_PER_NODE =
maximum_global_objects* RTEMS_BYTES_PER_GLOBAL_OBJECT =
maximum_proxies* RTEMS_BYTES_PER_PROXY =
- Total Multiprocessing Requirements
Fixed System RequirementsRTEMS_BYTES_OF_FIXED_SYSTEM_REQUIREMENTS
Total Single Processor Requirements
Total Multiprocessing Requirements
- Minimum Bytes for RTEMS Workspace
-
-@end html -@end ifset - -- cgit v1.2.3