doc/sgml/user-guide/installation.sgml

   1 <!-- {{{ Banner                         -->
   2
   3 <!-- =============================================================== -->
   4 <!--                                                                 -->
   5 <!--     installation.sgml                                           -->
   6 <!--                                                                 -->
   7 <!--     eCos User Guide                                             -->
   8 <!--                                                                 -->
   9 <!-- =============================================================== -->
  10 <!-- ####COPYRIGHTBEGIN####                                          -->
  11 <!--                                                                 -->
  12 <!-- =============================================================== -->
  13 <!-- Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.  -->
  14 <!-- Copyright (C) 2003 Nick Garnett                                 -->
  15 <!-- This material may be distributed only subject to the terms      -->
  16 <!-- and conditions set forth in the Open Publication License, v1.0  -->
  17 <!-- or later (the latest version is presently available at          -->
  18 <!-- http://www.opencontent.org/openpub/)                            -->
  19 <!-- Distribution of the work or derivative of the work in any       -->
  20 <!-- standard (paper) book form is prohibited unless prior           -->
  21 <!-- permission obtained from the copyright holder                   -->
  22 <!-- =============================================================== -->
  23 <!--                                                                 -->
  24 <!-- ####COPYRIGHTEND####                                            -->
  25 <!-- =============================================================== -->
  26 <!-- #####DESCRIPTIONBEGIN####                                       -->
  27 <!--                                                                 -->
  28 <!-- ####DESCRIPTIONEND####                                          -->
  29 <!-- =============================================================== -->
  30
  31 <!-- }}} -->
  32
  33 <part ID="user-guide-installation">
  34 <TITLE>Installing <productname>eCos</productname></TITLE>
  35
  36 <!-- {{{ System Requirements            -->
  37
  38 <chapter id="user-guide-installation-requirements">
  39 <title>System Requirements</title>
  40
  41 <ITEMIZEDLIST>
  42
  43 <LISTITEM>
  44 <PARA><!-- <conditionaltext> -->Standard Intel architecture PC running
  45  Linux (tested on recent Red Hat, SuSE and Debian distributions),
  46  Microsoft Windows NT (no earlier than 4.0 + SP6a), Windows 2000 and
  47  Windows XP. Linux distributions from other vendors may also work, but
  48  are currently untested. </PARA>
  49 </LISTITEM>
  50
  51 <LISTITEM>
  52 <PARA>Enough <!-- <index></index> --> disk space for the installed
  53 distribution. The <productname>eCos</productname> installation process
  54 will detail the various components of <productname>eCos</productname>
  55 and the compiler toolkit that can be installed, and their disk space
  56 requirements.</PARA>
  57 </LISTITEM>
  58
  59 <LISTITEM>
  60 <PARA>64MB of RAM and a 350MHz or faster Pentium processor.</PARA><!-- <conditionaltext> -->
  61 </LISTITEM>
  62
  63 </ITEMIZEDLIST>
  64
  65 <PARA>If you are downloading the <productname>eCos</productname>
  66 release distribution from <ULINK
  67 URL="http://ecos.sourceware.org">ecos.sourceware.org</ULINK>,
  68 you will also need space to store that image and to compile the
  69 toolchain and <productname>eCos</productname> from source.</PARA>
  70
  71
  72 </chapter>
  73
  74 <!-- }}} -->
  75 <!-- {{{ Installation on Linux          -->
  76
  77 <chapter id="user-guide-installation-linux">
  78 <title>Installation on Linux</title>
  79
  80 <para>
  81 Full instructions for the <ULINK
  82 URL="http://ecos.sourceware.org/getstart.html">downloading and
  83 installation of eCos</ULINK> on Linux hosts are provided on the eCos
  84 website.
  85 </para>
  86
  87 </chapter>
  88
  89 <!-- }}} -->
  90 <!-- {{{ Installation on Windows        -->
  91
  92 <chapter id="user-guide-installation-windows">
  93 <title>Installation on Windows</title>
  94
  95 <para>
  96 Full instructions for the <ULINK
  97 URL="http://ecos.sourceware.org/getstart.html">downloading and
  98 installation of eCos</ULINK> on Windows hosts are provided on the
  99 eCos website.
 100 </para>
 101
 102 </chapter>
 103
 104 <!-- }}} -->
 105 <!-- {{{ Target Setup                   -->
 106
 107 <chapter id="user-guide-installation-target">
 108 <title>Target Setup</title>
 109
 110 <PARA>While <productname>eCos</productname> supports a variety of
 111 targets, communication with all the targets happens in one of four
 112 ways. These are described in general below. Any details or variations
 113 from these descriptions will be found in the
 114 <productname>eCos</productname> documentation for a specific target,
 115 in the appendix.</PARA>
 116
 117 <SECT1 id="connecting-target-serial">
 118 <TITLE><!-- <index></index> -->Connecting Via Serial Line</TITLE>
 119
 120 <PARA>Most targets will have RedBoot or GDB Stubs installed.
 121 These normally waits for GDB to connect at 38400 baud, using 8 data
 122 bit, no parity bit and 1 stop-bit and no hardware flow control. Check
 123 the documentation for your target to ensure it uses this speed. If not,
 124 adjust the following instructions accordingly.</PARA>
 125
 126 <PARA>The following instructions depend on your having selected
 127 the appropriate serial port on the host. That is, the serial port
 128 which connects to the target's (primary) serial port. On
 129 Linux this could be <FILENAME>/dev/ttyS0</FILENAME>,
 130 while the same port on Windows would be named COM1.
 131 Substitute the proper serial port name in the below.</PARA>
 132
 133 <PARA>Connect to the target by issuing the following commands in
 134 GDB console mode:</PARA>
 135
 136 <PROGRAMLISTING>
 137 (gdb) set remotebaud 38400    <!-- <conditionaltext> -->
 138 (gdb) target remote /dev/ttyS0
 139 </PROGRAMLISTING>
 140
 141 <PARA>In Insight, connect by opening the <EMPHASIS>File-&#62;Target
 142 Settings</EMPHASIS> window and enter:</PARA>
 143
 144 <PROGRAMLISTING>
 145 Target: Remote/Serial
 146 Baud Rate: 38400
 147 Port: /dev/ttyS0
 148 </PROGRAMLISTING>
 149
 150 <PARA>Set other options according to preference, close the window
 151 and select
 152 <EMPHASIS>Run-&#62;Connect to target</EMPHASIS>.
 153 </PARA>
 154
 155 </SECT1>
 156
 157 <!-- ==================================================== -->
 158
 159 <SECT1 id="connecting-target-ethernet">
 160 <TITLE><!-- <index></index> -->Connecting Via Ethernet</TITLE>
 161
 162 <PARA>Some targets allow GDB to connect via Ethernet - if so, it will
 163 be mentioned in the document describing the target. Substitute the
 164 target's assigned IP address or hostname for &lt;hostname&#62; in the
 165 following. Depending on how RedBoot has been configured, it will
 166 either have this address allocated statically, or will acquire it via
 167 BOOTP. In both cases RedBoot will report the IP address it is
 168 listening on in its startup message printed on the serial port. The
 169 &lt;port&#62; is the TCP port which RedBoot is listening on, usually
 170 9000. It is also listed in the target document.</PARA>
 171
 172 <PARA>Connect to the target by issuing the following command in
 173 GDB console mode:</PARA>
 174
 175 <PROGRAMLISTING>
 176 (gdb) target remote &lt;hostname&#62;:&lt;port&#62;
 177 </PROGRAMLISTING>
 178
 179 <PARA>In Insight, connect by opening the <EMPHASIS>File-&#62;Target
 180 Settings</EMPHASIS> window and enter:</PARA>
 181
 182 <PROGRAMLISTING>
 183 Target: Remote/TCP
 184 Hostname: &lt;hostname&#62;
 185 Port: &lt;port&#62;
 186 </PROGRAMLISTING>
 187
 188 <PARA><!-- <conditionaltext> -->Set other options according to
 189 preference, close the window and select <EMPHASIS>Run-&#62;Connect to
 190 target</EMPHASIS>.</PARA>
 191
 192 </SECT1>
 193
 194 <!-- ==================================================== -->
 195
 196 <SECT1 id="connecting-target-sim">
 197 <TITLE><!-- <index></index> -->Using A Simulator Target</TITLE>
 198
 199 <PARA>GDB connects to all simulator targets using the same basic
 200 command, although each simulator may require additional options.
 201 These are listed in the document describing the target, and should
 202 be used when connecting.</PARA>
 203
 204 <PARA>Connect to the target by issuing the following command in
 205 GDB console mode:</PARA>
 206
 207 <PROGRAMLISTING>
 208 (gdb) target sim [target specific options]
 209 </PROGRAMLISTING>
 210
 211 <PARA>In Insight, connect by opening the <EMPHASIS>File-&#62;Target
 212 Settings</EMPHASIS> window and enter:</PARA>
 213
 214 <PROGRAMLISTING>
 215 Target: Simulator
 216 Options: [target specific options]
 217 </PROGRAMLISTING>
 218
 219 <PARA>Set other options according to preference, close the window and
 220 select <EMPHASIS>Run-&#62;Connect to target</EMPHASIS>.</PARA>
 221
 222 </SECT1>
 223
 224 <!-- ==================================================== -->
 225
 226 <SECT1 id="connecting-target-synth">
 227 <TITLE>Using A Synthetic Target</TITLE>
 228
 229 <PARA>Synthetic targets are special in that the built tests and
 230 applications actually run as native applications on the host. This
 231 means that there is no target to connect to. The test or application
 232 can be run directly from the GDB console using:</PARA>
 233
 234 <PROGRAMLISTING>
 235 (gdb) run
 236 </PROGRAMLISTING>
 237
 238 <PARA>or from Insight by pressing the <EMPHASIS>Run</EMPHASIS> icon.
 239 There is therefore no need to connect to the target or download the
 240 application, so you should ignore GDB &ldquo;target&rdquo; and
 241 &ldquo;load&rdquo; commands in any instructions found in other places
 242 in the documentation.</PARA>
 243 </SECT1>
 244
 245 </chapter>
 246
 247 <!-- }}} -->
 248
 249 </part>
 250