source: final-system/mips/colo.xml@ d649544

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;
]>

<sect1 id="ch-system-colo" role="wrap">
  <?dbhtml filename="colo.html"?>

  <title>Colo-&colo-version;</title>

  <indexterm zone="ch-system-colo">
    <primary sortas="a-Colo">Colo</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The Colo package contains the Cobalt Boot Loader.</para>

    <segmentedlist>
      <segtitle>&dependencies;</segtitle>

      <seglistitem>
        <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc,
        Grep, Make, Ncurses, Sed</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Colo</title>

  <note os="a">
    <para>This bootloader is for the MIPS based cobalt servers RaQ,
    RaQ2, Qube, or the Qube2.</para>
  </note>

    <para os="b">Compile the Colo package:</para>

<screen><userinput>make</userinput></screen>

    <para os="c">Install the package:</para>

<screen os="d"><userinput>install -d  /usr/lib/colo/examples
install binaries/colo-chain.elf /usr/lib/colo
install binaries/colo-rom-image.bin /usr/lib/colo
install tools/colo-perm/colo-perm /sbin
install tools/colo-perm/colo-perm.8 /usr/man/man8
install tools/elf2rfx/elf2rfx /sbin
install tools/flash-tool/flash-tool /sbin
install tools/flash-tool/flash-tool.8 /usr/man/man8
install tools/lcdtools/e2fsck-lcd/e2fsck-lcd /sbin
install tools/lcdtools/e2fsck-lcd/e2fsck-lcd.8 /usr/man/man8
install tools/lcdtools/liblcd/liblcd.a /lib
install tools/lcdtools/paneld/paneld /sbin
install tools/lcdtools/paneld/paneld.8 /usr/man/man8
install tools/lcdtools/putlcd/putlcd /sbin
install tools/lcdtools/putlcd/putlcd.8 /usr/man/man8
install examples/menu.colo /usr/lib/colo/examples
install examples/simple.colo /usr/lib/colo/examples
cp binaries/colo-chain.elf /boot/vmlinux
gzip -9 /boot/vmlinux</userinput></screen>

  </sect2>

  <sect2 id="contents-colo" role="content">
    <title>Contents of Colo</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>

      <seglistitem>
        <seg>colo-chain.elf, colo-rom-image.bin, colo-perm, elf2rfx,
        flash-tool, e2fsck-lcd, paneld and putlcd</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="colo-chain.elf">
        <term><command>colo</command></term>
        <listitem>
          <para>Is the Cobalt Bootloader's chain mode executeable. This
          file gets gzipped and renamed to <filename>vmlinux.gz</filename>,
          so it can be booted automatically by the Cobalt's existing
          firmware</para>
          <indexterm zone="ch-system-colo colo-chain.elf">
            <primary sortas="b-colo-chain.elf">colo-chain.elf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="colo-rom-image.bin">
        <term><command>colo-rom-image.bin</command></term>
        <listitem>
          <para>Is a replacement firmware for the Cobalt's standard
          firmware</para>
          <indexterm zone="ch-system-colo colo-rom-image.bin">
            <primary sortas="b-colo-rom-image.bin">colo-rom-image.bin</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="colo-perm">
        <term><command>colo-perm</command></term>
        <listitem>
          <para>Is a tool which looks in the ROM of a Cobalt machine for a
          magic string identifying CoLo. This way, it can be determined if
          the original Cobalt firmware is used or whether CoLo has been
          flashed to the ROM</para>
          <indexterm zone="ch-system-colo colo-perm">
            <primary sortas="b-colo-perm">colo-perm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="elf2rfx">
        <term><command>elf2rfx</command></term>
        <listitem>
          <para>UNKNOWN</para>
          <indexterm zone="ch-system-colo elf2rfx">
            <primary sortas="b-elf2rfx">elf2rfx</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="flash-tool">
        <term><command>flash-tool</command></term>
        <listitem>
          <para>Read or write Cobalt's firmware flash memory</para>
          <indexterm zone="ch-system-colo flash-tool">
            <primary sortas="b-flash-tool">flash-tool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="e2fsck-lcd">
        <term><command>e2fsck-lcd</command></term>
        <listitem>
          <para>Will output file system check progress information on the
          Cobalt LCD</para>
          <indexterm zone="ch-system-colo e2fsck-lcd">
            <primary sortas="b-e2fsck-lcd">e2fsck-lcd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="paneld">
        <term><command>paneld</command></term>
        <listitem>
          <para>Is an admin tool for the LCD panel of Cobalt machines. By
          default, it will display the current time and optionally a message.
          When you hold the enter or select button for a couple of seconds
          you will get an admin menu. The menu will allow you to either halt
          or reboot your Cobalt machine</para>
          <indexterm zone="ch-system-colo paneld">
            <primary sortas="b-paneld">paneld</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="putlcd">
        <term><command>putlcd</command></term>
        <listitem>
          <para>Is a tool to display text on the LCD display of Cobalt
          machines</para>
          <indexterm zone="ch-system-colo putlcd">
            <primary sortas="b-putlcd">putlcd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="md5rom">
        <term><command>md5rom</command></term>
        <listitem>
          <para>Will output the MD5 checksum of a Cobalt's ROM</para>
          <indexterm zone="ch-system-colo md5rom">
            <primary sortas="b-md5rom">md5rom</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>