summaryrefslogtreecommitdiffstats
path: root/doc/porting/preface.texi
diff options
context:
space:
mode:
Diffstat (limited to 'doc/porting/preface.texi')
-rw-r--r--doc/porting/preface.texi42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/porting/preface.texi b/doc/porting/preface.texi
new file mode 100644
index 0000000000..19304f0f11
--- /dev/null
+++ b/doc/porting/preface.texi
@@ -0,0 +1,42 @@
+@c
+@c COPYRIGHT (c) 1988-2002.
+@c On-Line Applications Research Corporation (OAR).
+@c All rights reserved.
+@c
+@c $Id$
+@c
+
+@ifinfo
+@node Preface, Development Tools, Top, Top
+@end ifinfo
+@unnumbered Preface
+
+The purpose of this manual is to provide a roadmap to those people porting
+RTEMS to a new CPU family. This process includes a variety of activities
+including the following:
+
+@itemize @bullet
+
+@item targeting the GNU development tools
+
+@item porting the RTEMS executive code
+
+@item developing a Board Support Package
+
+@item writing an RTEMS CPU Supplement manual for the completed port.
+
+@end itemize
+
+This document focuses on the process of actually porting the RTEMS
+executive code proper. Each of the data structures, routines, and macro
+definitions required of a port of RTEMS is described in this document.
+
+Porting any operating system, including RTEMS, requires knowledge of the
+operating system, target CPU architecture, and debug environment. It is
+very desirable to have a CPU simulator or hardware emulator when debugging
+the port. This manual assumes that the user is familiar with building and
+using RTEMS, the C programming language, and the target CPU architecture.
+It is desirable to be familiar with the assembly language for the target
+CPU family but since only a limited amount of assembly is required to port
+RTEMS.
+