summaryrefslogtreecommitdiffstats
path: root/doc/bsp_howto
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>1998-10-15 21:18:24 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>1998-10-15 21:18:24 +0000
commit7595ae6749d506e78e74f827f11b15b8c1dd2381 (patch)
tree447b0850bd41c6d105d74c923a57aff306f1e38f /doc/bsp_howto
parentchanged version to 4.0.0-beta4a (diff)
downloadrtems-7595ae6749d506e78e74f827f11b15b8c1dd2381.tar.bz2
Merged bsp structure into target dependent files chapter.
Diffstat (limited to 'doc/bsp_howto')
-rw-r--r--doc/bsp_howto/bspstruct.t45
-rw-r--r--doc/bsp_howto/target.t67
2 files changed, 64 insertions, 48 deletions
diff --git a/doc/bsp_howto/bspstruct.t b/doc/bsp_howto/bspstruct.t
deleted file mode 100644
index b957b1e035..0000000000
--- a/doc/bsp_howto/bspstruct.t
+++ /dev/null
@@ -1,45 +0,0 @@
-@c
-@c COPYRIGHT (c) 1988-1998.
-@c On-Line Applications Research Corporation (OAR).
-@c All rights reserved.
-@c
-@c $Id$
-@c
-
-@chapter Board Support Package Structure
-
-The BSP are all kept in the $RTEMS_ROOT/c/src/lib/libbsp directory. They
-are filed under the processor family (m68k, powerpc, etc.). A given BSP
-consists in the following directories:
-
-@itemize @bullet
-
-@item clock : support for the realtime clock, which provides a regular
-time basis to the kernel,
-
-@item console : rather the serial driver than only a console driver, it
-deals with the board UARTs (i.e. serial devices),
-
-@item include : the include files,
-
-@item startup : the board initialization code,
-
-@item timer : support of timer devices,
-
-@item shmsupp : support of shared memory in a multiprocessor system,
-
-@item network : the KA9Q ethernet driver.
-
-@end itemize
-
-Another important element are the makefiles, which have to be provided by
-the user.
-
-
-Rem : You should have a copy of the gen68340 BSP
-($RTEMS_ROOT/c/src/lib/libbsp/m68k/gen68340) in hand while reading this
-piece of documentation.
-
-Further in this document we'll use the $BSP340_ROOT label for
-$RTEMS_ROOT/c/src/lib/libbsp/m68k/gen68340.
-
diff --git a/doc/bsp_howto/target.t b/doc/bsp_howto/target.t
index c405c7ee52..e18d70d6e6 100644
--- a/doc/bsp_howto/target.t
+++ b/doc/bsp_howto/target.t
@@ -6,9 +6,9 @@
@c $Id$
@c
-@chapter Target Dependent and Board Dependent Files
+@chapter CPU and Board Dependent Files
-RTEMS divides board dependencies into two parts :
+RTEMS divides board dependencies into two parts:
@itemize @bullet
@@ -22,7 +22,6 @@ descriptions of each needed CPU dependant function.
@item the board dependant code : it includes support for a given board,
such as the board initialization code and drivers for the various devices:
-
@end itemize
Porting RTEMS on a new board should raise two questions:
@@ -39,3 +38,65 @@ If the main board CPU is supported, you will only have do write the Board
Support Package. Otherwise you'll have to write both CPU dependant code
and the BSP. One should always start writing a BSP from a similar one.
+@section CPU Dependent Executive Files
+
+XXX
+
+@section CPU Dependent Support Files
+
+XXX
+
+@section Board Support Package Structure
+
+The BSPs are kept in the $RTEMS_ROOT/c/src/lib/libbsp directory. They
+are filed under the processor family (m68k, powerpc, etc.). A given BSP
+consists in the following directories:
+
+@itemize @bullet
+
+@item @b{clock} -
+support for the realtime clock, which provides a regular
+time basis to the kernel,
+
+@item @b{console} -
+rather the serial driver than only a console driver, it
+deals with the board UARTs (i.e. serial devices),
+
+@item @b{include} -
+the include files,
+
+@item @b{startup} -
+the board initialization code,
+
+@item @b{timer} -
+support of timer devices,
+
+@item @b{shmsupp} -
+support of shared memory in a multiprocessor system,
+
+@item @b{network} -
+the Ethernet driver.
+
+@item @b{rtc} -
+the real-time clock driver.
+
+@item @b{wrapup} - XXX
+
+@end itemize
+
+Another important element are the makefiles, which have to be provided by
+the user.
+
+
+@b{NOTE:} This manual refers to the gen68340 BSP for numerous concrete
+examples. You should have a copy of the gen68340 BSP available while
+reading this piece of documentation. This BSP is located in the
+following directory:
+
+@example
+$RTEMS_ROOT/c/src/lib/libbsp/m68k/gen68340
+@end example
+
+Later in this document, the $BSP340_ROOT label will be used
+to refer to this directory.
+