source: rtems/doc/supplements/mips64orion/cputable.t @ f48b1000

4.104.114.84.95
Last change on this file since f48b1000 was f48b1000, checked in by Joel Sherrill <joel.sherrill@…>, on Nov 23, 1998 at 10:09:47 PM

New files copied from template and personalized.

  • Property mode set to 100644
File size: 3.6 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-1998.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6@c  $Id$
7@c
8
9@chapter Processor Dependent Information Table
10
11@section Introduction
12
13Any highly processor dependent information required
14to describe a processor to RTEMS is provided in the CPU
15Dependent Information Table.  This table is not required for all
16processors supported by RTEMS.  This chapter describes the
17contents, if any, for a particular processor type.
18
19@section CPU Dependent Information Table
20
21The XXX version of the RTEMS CPU Dependent
22Information Table contains the information required to interface
23a Board Support Package and RTEMS on the XXX.  This
24information is provided to allow RTEMS to interoperate
25effectively with the BSP.  The C structure definition is given
26here:
27
28@example
29@group
30typedef struct @{
31  void       (*pretasking_hook)( void );
32  void       (*predriver_hook)( void );
33  void       (*postdriver_hook)( void );
34  void       (*idle_task)( void );
35  boolean      do_zero_of_workspace;
36  unsigned32   idle_task_stack_size;
37  unsigned32   interrupt_stack_size;
38  unsigned32   extra_mpci_receive_server_stack;
39  void *     (*stack_allocate_hook)( unsigned32 );
40  void       (*stack_free_hook)( void* );
41  /* end of fields required on all CPUs */
42
43  /* XXX CPU family dependent stuff */
44@} rtems_cpu_table;
45@end group
46@end example
47
48@table @code
49@item pretasking_hook
50is the address of the user provided routine which is invoked
51once RTEMS APIs are initialized.  This routine will be invoked
52before any system tasks are created.  Interrupts are disabled.
53This field may be NULL to indicate that the hook is not utilized.
54
55@item predriver_hook
56is the address of the user provided
57routine that is invoked immediately before the
58the device drivers and MPCI are initialized. RTEMS
59initialization is complete but interrupts and tasking are disabled.
60This field may be NULL to indicate that the hook is not utilized.
61
62@item postdriver_hook
63is the address of the user provided
64routine that is invoked immediately after the
65the device drivers and MPCI are initialized. RTEMS
66initialization is complete but interrupts and tasking are disabled.
67This field may be NULL to indicate that the hook is not utilized.
68
69@item idle_task
70is the address of the optional user
71provided routine which is used as the system's IDLE task.  If
72this field is not NULL, then the RTEMS default IDLE task is not
73used.  This field may be NULL to indicate that the default IDLE
74is to be used.
75
76@item do_zero_of_workspace
77indicates whether RTEMS should
78zero the Workspace as part of its initialization.  If set to
79TRUE, the Workspace is zeroed.  Otherwise, it is not.
80
81@item idle_task_stack_size
82is the size of the RTEMS idle task stack in bytes. 
83If this number is less than MINIMUM_STACK_SIZE, then the
84idle task's stack will be MINIMUM_STACK_SIZE in byte.
85
86@item interrupt_stack_size
87is the size of the RTEMS
88allocated interrupt stack in bytes.  This value must be at least
89as large as MINIMUM_STACK_SIZE.
90
91@item extra_mpci_receive_server_stack
92is the extra stack space allocated for the RTEMS MPCI receive server task
93in bytes.  The MPCI receive server may invoke nearly all directives and
94may require extra stack space on some targets.
95
96@item stack_allocate_hook
97is the address of the optional user provided routine which allocates
98memory for task stacks.  If this hook is not NULL, then a stack_free_hook
99must be provided as well.
100
101@item stack_free_hook
102is the address of the optional user provided routine which frees
103memory for task stacks.  If this hook is not NULL, then a stack_allocate_hook
104must be provided as well.
105
106@item XXX
107is where the CPU family dependent stuff goes.
108
109@end table
Note: See TracBrowser for help on using the repository browser.