From fdf9cb603223b344c5e1af4dc64dc6400e5bcaaf Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Mon, 19 Oct 1998 13:27:13 +0000 Subject: Added chapter. --- doc/supplements/template/Makefile | 14 +++-- doc/supplements/template/cputable.t | 111 +++++++++++++++++++++++++++++++++ doc/supplements/template/template.texi | 4 +- 3 files changed, 123 insertions(+), 6 deletions(-) create mode 100644 doc/supplements/template/cputable.t diff --git a/doc/supplements/template/Makefile b/doc/supplements/template/Makefile index 2dd8fa39d6..351d316327 100644 --- a/doc/supplements/template/Makefile +++ b/doc/supplements/template/Makefile @@ -25,10 +25,9 @@ FILES= $(PROJECT).texi preface.texi \ $(COMMON_FILES) $(GENERATED_FILES) GENERATED_FILES=\ cpumodel.texi callconv.texi memmodel.texi intr.texi fatalerr.texi \ - bsp.texi + bsp.texi cputable.texi -# bsp.texi callconv.texi cpumodel.texi cputable.texi fatalerr.texi \ -# intr.texi memmodel.texi preface.texi timetbl.texi timedata.texi wksheets.texi +# timetbl.texi timedata.texi wksheets.texi info: dirs c_$(PROJECT) @echo NEED TO INSTALL THE INFO FILES @@ -48,6 +47,9 @@ $(PROJECT).ps: $(PROJECT).dvi $(PROJECT).dvi: $(FILES) $(TEXI2DVI) $(PROJECT).texi +# +# Chapters which get automatic processing +# cpumodel.texi: cpumodel.t Makefile $(BMENU) -p "Preface" \ -u "Top" \ @@ -82,7 +84,11 @@ bsp.texi: bsp.t Makefile -u "Top" \ -n "" ${*}.t -intr.texi: intr.t Makefile +cputable.texi: cputable.t Makefile + $(BMENU) -p "" \ + -u "Top" \ + -n "" ${*}.t + replace: timedata.texi timetbl.t: ../../common/timetbl.t diff --git a/doc/supplements/template/cputable.t b/doc/supplements/template/cputable.t new file mode 100644 index 0000000000..a2164335aa --- /dev/null +++ b/doc/supplements/template/cputable.t @@ -0,0 +1,111 @@ +@c +@c COPYRIGHT (c) 1988-1998. +@c On-Line Applications Research Corporation (OAR). +@c All rights reserved. +@c +@c $Id$ +@c + +@chapter Processor Dependent Information Table + +@section Introduction + +Any highly processor dependent information required +to describe a processor to RTEMS is provided in the CPU +Dependent Information Table. This table is not required for all +processors supported by RTEMS. This chapter describes the +contents, if any, for a particular processor type. + +@section CPU Dependent Information Table + +The XXX version of the RTEMS CPU Dependent +Information Table contains the information required to interface +a Board Support Package and RTEMS on the XXX. This +information is provided to allow RTEMS to interoperate +effectively with the BSP. The C structure definition is given +here: + +@example +@group +typedef struct @{ + void (*pretasking_hook)( void ); + void (*predriver_hook)( void ); + void (*postdriver_hook)( void ); + void (*idle_task)( void ); + boolean do_zero_of_workspace; + unsigned32 idle_task_stack_size; + unsigned32 interrupt_stack_size; + unsigned32 extra_mpci_receive_server_stack; + void * (*stack_allocate_hook)( unsigned32 ); + void (*stack_free_hook)( void* ); + /* end of fields required on all CPUs */ + + /* XXX CPU family dependent stuff */ +@} rtems_cpu_table; +@end group +@end example + +@table @code +@item pretasking_hook +is the address of the +user provided routine which is invoked once RTEMS initialization +is complete but before interrupts and tasking are enabled. This +field may be NULL to indicate that the hook is not utilized. + +@item predriver_hook +is the address of the user provided +routine which is invoked with tasking enabled immediately before +the MPCI and device drivers are initialized. RTEMS +initialization is complete, interrupts and tasking are enabled, +but no device drivers are initialized. This field may be NULL to +indicate that the hook is not utilized. + +@item postdriver_hook +is the address of the user provided +routine which is invoked with tasking enabled immediately after +the MPCI and device drivers are initialized. RTEMS +initialization is complete, interrupts and tasking are enabled, +and the device drivers are initialized. This field may be NULL +to indicate that the hook is not utilized. + +@item idle_task +is the address of the optional user +provided routine which is used as the system's IDLE task. If +this field is not NULL, then the RTEMS default IDLE task is not +used. This field may be NULL to indicate that the default IDLE +is to be used. + +@item do_zero_of_workspace +indicates whether RTEMS should +zero the Workspace as part of its initialization. If set to +TRUE, the Workspace is zeroed. Otherwise, it is not. + +@item idle_task_stack_size +is the size of the RTEMS idle task stack in bytes. +If this number is less than MINIMUM_STACK_SIZE, then the +idle task's stack will be MINIMUM_STACK_SIZE in byte. + +@item interrupt_stack_size +is the size of the RTEMS +allocated interrupt stack in bytes. This value must be at least +as large as MINIMUM_STACK_SIZE. + +@item extra_mpci_receive_server_stack +is the extra stack space allocated for the RTEMS MPCI receive server task +in bytes. The MPCI receive server may invoke nearly all directives and +may require extra stack space on some targets. + +@item stack_allocate_hook +is the address of the optional user provided routine which allocates +memory for task stacks. If this hook is not NULL, then a stack_free_hook +must be provided as well. + +@item stack_free_hook +is the address of the optional user provided routine which frees +memory for task stacks. If this hook is not NULL, then a stack_allocate_hook +must be provided as well. + +@item XXX +is where the CPU family dependent stuff goes. + +@end table diff --git a/doc/supplements/template/template.texi b/doc/supplements/template/template.texi index 8bc5a801ed..73a594ad9b 100644 --- a/doc/supplements/template/template.texi +++ b/doc/supplements/template/template.texi @@ -70,7 +70,7 @@ END-INFO-DIR-ENTRY @include intr.texi @include fatalerr.texi @include bsp.texi -@c @include cputable.texi +@include cputable.texi @c @include wksheets.texi @c @include ../../common/timing.texi @c @include timedata.texi @@ -89,7 +89,7 @@ Applications Supplement. * Interrupt Processing:: * Default Fatal Error Processing:: * Board Support Packages:: -** Processor Dependent Information Table:: +* Processor Dependent Information Table:: ** Memory Requirements:: ** Timing Specification:: ** MVME136 Timing Data:: -- cgit v1.2.3