Changeset 3e916e1 in freewrt for docs

Timestamp:

Jan 3, 2007, 10:22:04 AM (19 years ago)

Author:

Phil Sutter <n0-1@…>

Branches:

freewrt_1_0, freewrt_2_0

Children:

dab34c82

Parents:

e91877d

Message:

Added guide for flashing via web iface of original firmware

git-svn-id: ​svn://www.freewrt.org/branches/freewrt_1_0@1396 afb5a338-a214-0410-bd46-81f09a774fd1

Location:

docs/handbook/user

Files:

• 00-allinone.tex (modified) (2 diffs)
• pics/asus-fw_upgrade.png (added)
• pics/asus-startup.png (added)
• pics/asus-system_setup.png (added)

docs/handbook/user/00-allinone.tex

@@ -319 +319 @@
 
 \subsection{Web Interface Method}
-%TODO: may be filled in by someone who has done this before
+The following text describes how to use the original firmware's web interface
+to flash FreeWRT. The object of demonstration is an Asus WL500gP, but this
+guide should fit more or less fine for other systems, too. 
+
+There are some things that you should have done previously:
+\begin{itemize}
+\item a firmware image has to be built (matching the used hardware, of course)
+\item the router has to be powered on
+\item your computer needs to be connected to one of the LAN ports (using IP
+address 192.168.1.2)
+\end{itemize}
+
+\parbox{17em}{
+After preparation is complete, open your favourite browser and type
+\texttt{192.168.1.1} into the address bar. You should reach the web interface's
+startup page:
+}\hfill\parbox{20em}{\includegraphics[width=20em]{pics/asus-startup.png}} \\ [1em]
+\parbox{17em}{
+Then click \textit{System Setup}:
+}\hfill\parbox{20em}{\includegraphics[width=20em]{pics/asus-system_setup.png}} \\ [1em]
+\parbox{17em}{
+Then click \textit{Firmware Upgrade}, and enter the name of your firmware image
+into the appropriate field:
+}\hfill\parbox{20em}{\includegraphics[width=20em]{pics/asus-fw_upgrade.png}} \\ [1em]
+Finally click \textit{Upload}. As the whole process of writing the image to
+flash and rebooting (don't forget that it creates ssh hostkeys on first boot)
+takes quite long, better go and get coffee.
+
+When everything went good, you can login using ssh.
 
 \subsection{\texttt{mtd} -- The Flash Utility}
+For this method to work, you need to copy the file containing the firmware
+image to the router, preferably into /tmp (the tmpfs should be big enough to
+hold the full image). Then the image is written to flash using
+\texttt{mtd}, optionally giving additional options (see below).
+
 The \texttt{mtd} utility was written with simplicity and code size in mind.
 It's features were derived from the mtd-utils, %TODO: insert \ref to homepage
@@ -827 +860 @@
 Same semantics as above.
 
+\section{Troubleshooting}
+
+\subsection{Failsafe Mode}
+
+Failsafe mode is very useful if you misconfigured your embedded system,
+so that you can not access it anymore. E.g. if you accidentially disabled
+secure shell or misconfigured the firewall, so that you can not login any
+more.
+
+\subsubsection{How It Works}
+
+To get FreeWRT into failsafe mode you need physical access to the device and
+the failsafe utility. The failsafe utility is built inside our ADK and
+is available in the directory bin/ after a successful build.
+
+If you just want to compile the tool and not a complete firmware image,
+use following command:
+
+\begin{Verbatim}
+$ make subdir=tools/failsafe install
+\end{Verbatim}
+
+For some operating systems we provide ready to go binaries of failsafe.
+Take a look at http://www.freewrt.org/downloads/tools/failsafe
+% TODO: \ref fuer link
+
+The tool just opens a network socket and waits for a special UDP packet
+from the embedded device. FreeWRT sends the UDP packet via the first
+recognized network interface (eth0).
+
+\subsubsection{Enabling Failsafe Mode}
+
+Connect your computer to the embedded system via direct or crossed network
+cable. Use the failsafe port (in most cases one of the LAN ports),
+see the device specific page for the exact network port.
+
+Configure your network interface to the IP address 192.168.1.2 with network
+mask 255.255.255.0. Now start the failsafe utility on your computer.
+
+\begin{Verbatim}
+$ ./failsafe
+\end{Verbatim}
+
+After that power on your embedded system and wait for the following message in
+your failsafe application running on your computer:
+
+\begin{Verbatim}
+Press reset now to enter Failsafe!
+\end{Verbatim}
+
+As soon as this message is displayed you should push the reset button of
+your embedded system. You have 2 seconds time to push the button. If you
+successfully enabled the failsafe mode, following message will be displayed:
+
+\begin{Verbatim}
+Entering Failsafe!
+\end{Verbatim}
+
+Now you should be able to login to your embedded system via a telnet
+application. Just use:
+
+\begin{Verbatim}
+$ telnet 192.168.1.1
+\end{Verbatim}
+
+\subsubsection{Repairing Your FreeWRT Configuration}
+
+If you want to repair your configuration, you first need to
+mount the root filesystem via:
+
+\begin{Verbatim}
+# mount_root
+\end{Verbatim}
+
+After that you need to enable the FreeWRT configuration filesystem:
+
+\begin{Verbatim}
+# fwcf setup
+\end{Verbatim}
+
+Now you can change files in /etc and repair your broken configuration.
+Do not forget to commit your changes afterwards. 
+
+\begin{Verbatim}
+# fwcf commit
+\end{Verbatim}
+
+If you want to start over with the default /etc directory, just remove the fwcf
+partition content with following command:
+
+\begin{Verbatim}
+mtd erase fwcf
+\end{Verbatim}
+
+You can either use "reboot -f" or "-r" for mtd to reboot the system.
+