<!-- Copyright (C) 2003 Red Hat, Inc. -->
|
<!-- Copyright (C) 2003 Red Hat, Inc. -->
|
<!-- This material may be distributed only subject to the terms -->
|
<!-- This material may be distributed only subject to the terms -->
|
<!-- and conditions set forth in the Open Publication License, v1.0 -->
|
<!-- and conditions set forth in the Open Publication License, v1.0 -->
|
<!-- or later (the latest version is presently available at -->
|
<!-- or later (the latest version is presently available at -->
|
<!-- http://www.opencontent.org/openpub/). -->
|
<!-- http://www.opencontent.org/openpub/). -->
|
<!-- Distribution of the work or derivative of the work in any -->
|
<!-- Distribution of the work or derivative of the work in any -->
|
<!-- standard (paper) book form is prohibited unless prior -->
|
<!-- standard (paper) book form is prohibited unless prior -->
|
<!-- permission is obtained from the copyright holder. -->
|
<!-- permission is obtained from the copyright holder. -->
|
<HTML
|
<HTML
|
><HEAD
|
><HEAD
|
><TITLE
|
><TITLE
|
> Porting Guide</TITLE
|
> Porting Guide</TITLE
|
><meta name="MSSmartTagsPreventParsing" content="TRUE">
|
><meta name="MSSmartTagsPreventParsing" content="TRUE">
|
<META
|
<META
|
NAME="GENERATOR"
|
NAME="GENERATOR"
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
|
"><LINK
|
"><LINK
|
REL="HOME"
|
REL="HOME"
|
TITLE="eCos Reference Manual"
|
TITLE="eCos Reference Manual"
|
HREF="ecos-ref.html"><LINK
|
HREF="ecos-ref.html"><LINK
|
REL="UP"
|
REL="UP"
|
TITLE="The eCos Hardware Abstraction Layer (HAL)"
|
TITLE="The eCos Hardware Abstraction Layer (HAL)"
|
HREF="the-ecos-hardware-abstraction-layer.html"><LINK
|
HREF="the-ecos-hardware-abstraction-layer.html"><LINK
|
REL="PREVIOUS"
|
REL="PREVIOUS"
|
TITLE="Default Interrupt Handling"
|
TITLE="Default Interrupt Handling"
|
HREF="hal-default-interrupt-handling.html"><LINK
|
HREF="hal-default-interrupt-handling.html"><LINK
|
REL="NEXT"
|
REL="NEXT"
|
TITLE="HAL Structure"
|
TITLE="HAL Structure"
|
HREF="hal-porting-structure.html"></HEAD
|
HREF="hal-porting-structure.html"></HEAD
|
><BODY
|
><BODY
|
CLASS="CHAPTER"
|
CLASS="CHAPTER"
|
BGCOLOR="#FFFFFF"
|
BGCOLOR="#FFFFFF"
|
TEXT="#000000"
|
TEXT="#000000"
|
LINK="#0000FF"
|
LINK="#0000FF"
|
VLINK="#840084"
|
VLINK="#840084"
|
ALINK="#0000FF"
|
ALINK="#0000FF"
|
><DIV
|
><DIV
|
CLASS="NAVHEADER"
|
CLASS="NAVHEADER"
|
><TABLE
|
><TABLE
|
SUMMARY="Header navigation table"
|
SUMMARY="Header navigation table"
|
WIDTH="100%"
|
WIDTH="100%"
|
BORDER="0"
|
BORDER="0"
|
CELLPADDING="0"
|
CELLPADDING="0"
|
CELLSPACING="0"
|
CELLSPACING="0"
|
><TR
|
><TR
|
><TH
|
><TH
|
COLSPAN="3"
|
COLSPAN="3"
|
ALIGN="center"
|
ALIGN="center"
|
>eCos Reference Manual</TH
|
>eCos Reference Manual</TH
|
></TR
|
></TR
|
><TR
|
><TR
|
><TD
|
><TD
|
WIDTH="10%"
|
WIDTH="10%"
|
ALIGN="left"
|
ALIGN="left"
|
VALIGN="bottom"
|
VALIGN="bottom"
|
><A
|
><A
|
HREF="hal-default-interrupt-handling.html"
|
HREF="hal-default-interrupt-handling.html"
|
ACCESSKEY="P"
|
ACCESSKEY="P"
|
>Prev</A
|
>Prev</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="80%"
|
WIDTH="80%"
|
ALIGN="center"
|
ALIGN="center"
|
VALIGN="bottom"
|
VALIGN="bottom"
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="10%"
|
WIDTH="10%"
|
ALIGN="right"
|
ALIGN="right"
|
VALIGN="bottom"
|
VALIGN="bottom"
|
><A
|
><A
|
HREF="hal-porting-structure.html"
|
HREF="hal-porting-structure.html"
|
ACCESSKEY="N"
|
ACCESSKEY="N"
|
>Next</A
|
>Next</A
|
></TD
|
></TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
><HR
|
><HR
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
WIDTH="100%"></DIV
|
WIDTH="100%"></DIV
|
><DIV
|
><DIV
|
CLASS="CHAPTER"
|
CLASS="CHAPTER"
|
><H1
|
><H1
|
><A
|
><A
|
NAME="HAL-PORTING-GUIDE">Chapter 11. Porting Guide</H1
|
NAME="HAL-PORTING-GUIDE">Chapter 11. Porting Guide</H1
|
><DIV
|
><DIV
|
CLASS="TOC"
|
CLASS="TOC"
|
><DL
|
><DL
|
><DT
|
><DT
|
><B
|
><B
|
>Table of Contents</B
|
>Table of Contents</B
|
></DT
|
></DT
|
><DT
|
><DT
|
><A
|
><A
|
HREF="hal-porting-guide.html#HAL-PORTING-INTRO"
|
HREF="hal-porting-guide.html#HAL-PORTING-INTRO"
|
>Introduction</A
|
>Introduction</A
|
></DT
|
></DT
|
><DT
|
><DT
|
><A
|
><A
|
HREF="hal-porting-structure.html"
|
HREF="hal-porting-structure.html"
|
>HAL Structure</A
|
>HAL Structure</A
|
></DT
|
></DT
|
><DT
|
><DT
|
><A
|
><A
|
HREF="hal-calling-if.html"
|
HREF="hal-calling-if.html"
|
>Virtual Vectors (eCos/ROM Monitor Calling Interface)</A
|
>Virtual Vectors (eCos/ROM Monitor Calling Interface)</A
|
></DT
|
></DT
|
><DT
|
><DT
|
><A
|
><A
|
HREF="hal-porting-coding-conventions.html"
|
HREF="hal-porting-coding-conventions.html"
|
>HAL Coding Conventions</A
|
>HAL Coding Conventions</A
|
></DT
|
></DT
|
><DT
|
><DT
|
><A
|
><A
|
HREF="hal-porting-platform.html"
|
HREF="hal-porting-platform.html"
|
>Platform HAL Porting</A
|
>Platform HAL Porting</A
|
></DT
|
></DT
|
><DT
|
><DT
|
><A
|
><A
|
HREF="hal-porting-variant.html"
|
HREF="hal-porting-variant.html"
|
>Variant HAL Porting</A
|
>Variant HAL Porting</A
|
></DT
|
></DT
|
><DT
|
><DT
|
><A
|
><A
|
HREF="hal-porting-architecture.html"
|
HREF="hal-porting-architecture.html"
|
>Architecture HAL Porting</A
|
>Architecture HAL Porting</A
|
></DT
|
></DT
|
></DL
|
></DL
|
></DIV
|
></DIV
|
><DIV
|
><DIV
|
CLASS="SECTION"
|
CLASS="SECTION"
|
><H1
|
><H1
|
CLASS="SECTION"
|
CLASS="SECTION"
|
><A
|
><A
|
NAME="HAL-PORTING-INTRO">Introduction</H1
|
NAME="HAL-PORTING-INTRO">Introduction</H1
|
><P
|
><P
|
>eCos has been designed to be fairly easy to port to new targets. A
|
>eCos has been designed to be fairly easy to port to new targets. A
|
target is a specific platform (board) using a given architecture (CPU
|
target is a specific platform (board) using a given architecture (CPU
|
type). The porting is facilitated by the hierarchical layering of the
|
type). The porting is facilitated by the hierarchical layering of the
|
eCos sources - all architecture and platform specific code is
|
eCos sources - all architecture and platform specific code is
|
implemented in a HAL (hardware abstraction layer).</P
|
implemented in a HAL (hardware abstraction layer).</P
|
><P
|
><P
|
>By porting the eCos HAL to a new target the core functionality of eCos
|
>By porting the eCos HAL to a new target the core functionality of eCos
|
(infra, kernel, uITRON, etc) will be able to run on the target. It may
|
(infra, kernel, uITRON, etc) will be able to run on the target. It may
|
be necessary to add further platform specific code such as serial
|
be necessary to add further platform specific code such as serial
|
drivers, display drivers, ethernet drivers, etc. to get a fully
|
drivers, display drivers, ethernet drivers, etc. to get a fully
|
capable system.</P
|
capable system.</P
|
><P
|
><P
|
>This document is intended as a help to the HAL porting process. Due to
|
>This document is intended as a help to the HAL porting process. Due to
|
the nature of a porting job, it is impossible to give a complete
|
the nature of a porting job, it is impossible to give a complete
|
description of what has to be done for each and every potential
|
description of what has to be done for each and every potential
|
target. This should not be considered a clear-cut recipe - you will
|
target. This should not be considered a clear-cut recipe - you will
|
probably need to make some implementation decisions, tweak a few
|
probably need to make some implementation decisions, tweak a few
|
things, and just plain have to rely on common sense.</P
|
things, and just plain have to rely on common sense.</P
|
><P
|
><P
|
>However, what is covered here should be a large part of the
|
>However, what is covered here should be a large part of the
|
process. If you get stuck, you are advised to read the
|
process. If you get stuck, you are advised to read the
|
<A
|
<A
|
HREF="http://sourceware.cygnus.com/ml/ecos-discuss/"
|
HREF="http://sourceware.cygnus.com/ml/ecos-discuss/"
|
TARGET="_top"
|
TARGET="_top"
|
>ecos-discuss archive</A
|
>ecos-discuss archive</A
|
>
|
>
|
where you may find discussions which apply to the problem at
|
where you may find discussions which apply to the problem at
|
hand. You are also invited to ask questions on the
|
hand. You are also invited to ask questions on the
|
<A
|
<A
|
HREF="http://sourceware.cygnus.com/ecos/intouch.html"
|
HREF="http://sourceware.cygnus.com/ecos/intouch.html"
|
TARGET="_top"
|
TARGET="_top"
|
>ecos-discuss mailing list</A
|
>ecos-discuss mailing list</A
|
>
|
>
|
to help you resolve problems - but as is always the case
|
to help you resolve problems - but as is always the case
|
with community lists, do not consider it an oracle for any and all
|
with community lists, do not consider it an oracle for any and all
|
questions. Use common sense - if you ask too many questions which
|
questions. Use common sense - if you ask too many questions which
|
could have been answered by reading the
|
could have been answered by reading the
|
<A
|
<A
|
HREF="http://sourceware.cygnus.com/ecos/docs-latest/"
|
HREF="http://sourceware.cygnus.com/ecos/docs-latest/"
|
TARGET="_top"
|
TARGET="_top"
|
>documentation</A
|
>documentation</A
|
>,
|
>,
|
<A
|
<A
|
HREF="http://sourceware.cygnus.com/fom/ecos"
|
HREF="http://sourceware.cygnus.com/fom/ecos"
|
TARGET="_top"
|
TARGET="_top"
|
>FAQ</A
|
>FAQ</A
|
> or
|
> or
|
<A
|
<A
|
HREF="http://sourceware.cygnus.com/cgi-bin/cvsweb.cgi/ecos/packages/?cvsroot=ecos"
|
HREF="http://sourceware.cygnus.com/cgi-bin/cvsweb.cgi/ecos/packages/?cvsroot=ecos"
|
TARGET="_top"
|
TARGET="_top"
|
>source code</A
|
>source code</A
|
>, you are likely to be ignored.</P
|
>, you are likely to be ignored.</P
|
><P
|
><P
|
>This document will be continually improved by Red Hat engineers as
|
>This document will be continually improved by Red Hat engineers as
|
time allows. Feedback and help with improving the document is sought,
|
time allows. Feedback and help with improving the document is sought,
|
so if you have any comments at all, please do not hesitate to post
|
so if you have any comments at all, please do not hesitate to post
|
them on
|
them on
|
<A
|
<A
|
HREF="mailto:ecos-discuss@sourceware.cygnus.com?subject=[porting]<subject>"
|
HREF="mailto:ecos-discuss@sourceware.cygnus.com?subject=[porting]<subject>"
|
TARGET="_top"
|
TARGET="_top"
|
>ecos-discuss</A
|
>ecos-discuss</A
|
>
|
>
|
(please prefix the subject with [porting]).</P
|
(please prefix the subject with [porting]).</P
|
><P
|
><P
|
>At the moment this document is mostly an outline. There are many
|
>At the moment this document is mostly an outline. There are many
|
details to fill in before it becomes complete. Many places you'll just
|
details to fill in before it becomes complete. Many places you'll just
|
find a list of keywords / concepts that should be described (please
|
find a list of keywords / concepts that should be described (please
|
post on ecos-discuss if there are areas you think are not covered).</P
|
post on ecos-discuss if there are areas you think are not covered).</P
|
><P
|
><P
|
>All pages or sections where the caption ends in [TBD] contain little
|
>All pages or sections where the caption ends in [TBD] contain little
|
more than key words and/or random thoughts - there has been no work
|
more than key words and/or random thoughts - there has been no work
|
done as such on the content. The word FIXME may appear in the text to
|
done as such on the content. The word FIXME may appear in the text to
|
highlight places where information is missing.</P
|
highlight places where information is missing.</P
|
></DIV
|
></DIV
|
></DIV
|
></DIV
|
><DIV
|
><DIV
|
CLASS="NAVFOOTER"
|
CLASS="NAVFOOTER"
|
><HR
|
><HR
|
ALIGN="LEFT"
|
ALIGN="LEFT"
|
WIDTH="100%"><TABLE
|
WIDTH="100%"><TABLE
|
SUMMARY="Footer navigation table"
|
SUMMARY="Footer navigation table"
|
WIDTH="100%"
|
WIDTH="100%"
|
BORDER="0"
|
BORDER="0"
|
CELLPADDING="0"
|
CELLPADDING="0"
|
CELLSPACING="0"
|
CELLSPACING="0"
|
><TR
|
><TR
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="left"
|
ALIGN="left"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="hal-default-interrupt-handling.html"
|
HREF="hal-default-interrupt-handling.html"
|
ACCESSKEY="P"
|
ACCESSKEY="P"
|
>Prev</A
|
>Prev</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="34%"
|
WIDTH="34%"
|
ALIGN="center"
|
ALIGN="center"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="ecos-ref.html"
|
HREF="ecos-ref.html"
|
ACCESSKEY="H"
|
ACCESSKEY="H"
|
>Home</A
|
>Home</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="right"
|
ALIGN="right"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="hal-porting-structure.html"
|
HREF="hal-porting-structure.html"
|
ACCESSKEY="N"
|
ACCESSKEY="N"
|
>Next</A
|
>Next</A
|
></TD
|
></TD
|
></TR
|
></TR
|
><TR
|
><TR
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="left"
|
ALIGN="left"
|
VALIGN="top"
|
VALIGN="top"
|
>Default Interrupt Handling</TD
|
>Default Interrupt Handling</TD
|
><TD
|
><TD
|
WIDTH="34%"
|
WIDTH="34%"
|
ALIGN="center"
|
ALIGN="center"
|
VALIGN="top"
|
VALIGN="top"
|
><A
|
><A
|
HREF="the-ecos-hardware-abstraction-layer.html"
|
HREF="the-ecos-hardware-abstraction-layer.html"
|
ACCESSKEY="U"
|
ACCESSKEY="U"
|
>Up</A
|
>Up</A
|
></TD
|
></TD
|
><TD
|
><TD
|
WIDTH="33%"
|
WIDTH="33%"
|
ALIGN="right"
|
ALIGN="right"
|
VALIGN="top"
|
VALIGN="top"
|
>HAL Structure</TD
|
>HAL Structure</TD
|
></TR
|
></TR
|
></TABLE
|
></TABLE
|
></DIV
|
></DIV
|
></BODY
|
></BODY
|
></HTML
|
></HTML
|
|
|
