diff options
author | Jean-Louis Biasini <jlbiasini@gmail.com> | 2012-02-21 16:41:35 +0100 |
---|---|---|
committer | Dominik Riebeling <Dominik.Riebeling@gmail.com> | 2012-05-01 20:19:25 +0200 |
commit | 6637e24aed7f4288f82be1eae11f7831086e8091 (patch) | |
tree | 10c70e2e7c463986653a82bd56892041d97ed824 /manual/getting_started | |
parent | 45c5b1fe173471db25b450434c453c929c855874 (diff) | |
download | rockbox-6637e24aed7f4288f82be1eae11f7831086e8091.tar.gz rockbox-6637e24aed7f4288f82be1eae11f7831086e8091.zip |
Update Fuze+ manual (main files) FS#12492
- this patch add all general sections of the manual for the fuze+
- also correct some typos
Change-Id: Idd28675f48c0d01079d8fa01d68d3238ad2a54ce
Reviewed-on: http://gerrit.rockbox.org/116
Reviewed-by: Dominik Riebeling <Dominik.Riebeling@gmail.com>
Diffstat (limited to 'manual/getting_started')
-rw-r--r-- | manual/getting_started/IMX233_install.tex | 77 | ||||
-rw-r--r-- | manual/getting_started/installation.tex | 68 |
2 files changed, 134 insertions, 11 deletions
diff --git a/manual/getting_started/IMX233_install.tex b/manual/getting_started/IMX233_install.tex new file mode 100644 index 0000000000..c2846a85d3 --- /dev/null +++ b/manual/getting_started/IMX233_install.tex | |||
@@ -0,0 +1,77 @@ | |||
1 | % $Id: % | ||
2 | |||
3 | In order to install the bootloader, you will need to download the following | ||
4 | files: | ||
5 | |||
6 | \begin{itemize} | ||
7 | \item An original firmware (OF) from \playerman's website: | ||
8 | \opt{fuzeplus}{ | ||
9 | \url{http://forums.sandisk.com/t5/Fuze/bd-p/Fuzeplus}} | ||
10 | |||
11 | \item The bootloader: | ||
12 | \opt{fuzeplus}{\download{bootloader/sandisk-sansa/fuzeplus/bootloader-fuzeplus.sansa}} | ||
13 | |||
14 | \item The version of mkimxboot for your operating system from Rockbox's server: | ||
15 | \download{bootloader/sandisk-sansa/mkimxboot/} | ||
16 | \end{itemize} | ||
17 | |||
18 | \subsection{Bootloader installation from Windows} | ||
19 | |||
20 | \begin{enumerate} | ||
21 | |||
22 | \item Create a folder called ``rbinstall'' on your desktop, and then extract | ||
23 | the OF, the bootloader and mkimxboot into it. | ||
24 | |||
25 | \item Open a new command prompt, and navigate to the ``rbinstall'' folder. | ||
26 | |||
27 | \item Run mkimxboot.exe, passing according to the following syntax the name | ||
28 | of the OF and bootloader files that you downloaded, in addition to a name for | ||
29 | the output file and the option argument for dualboot. | ||
30 | |||
31 | % The following arguments to the code environment select the correct line out | ||
32 | % of the code block. This is necessary as using \opt{} in the code block would | ||
33 | % create unwanted empty lines. | ||
34 | \begin{code}[firstline=\opt{fuzeplus}{1},% | ||
35 | lastline=\opt{fuzeplus}{1}] | ||
36 | mkimxboot.exe -i firmware.sb -b bootloader-fuzeplus.sansa -o patched.sb -t dualboot | ||
37 | \end{code} | ||
38 | |||
39 | If mkimxboot.exe does not report success, then retry or abort. | ||
40 | |||
41 | \item Copy the output file (``patched.sb'' in the example given above) to the | ||
42 | root of the device and rename it to the same name as the OF file you downloaded earlier | ||
43 | \opt{fuzeplus}{(``firmware.sb''} above). | ||
44 | |||
45 | \end{enumerate} | ||
46 | |||
47 | Please now go to \reference{ref:finish_install} to complete the installation procedure. | ||
48 | |||
49 | \subsection{Bootloader installation from Mac OS X and Linux} | ||
50 | |||
51 | \begin{enumerate} | ||
52 | |||
53 | \item Create a folder called ``rbinstall'' in your home directory, and then | ||
54 | extract the OF, the bootloader and mkimxboot into it. | ||
55 | |||
56 | \item Open a new terminal, and navigate to the ``rbinstall'' folder. | ||
57 | |||
58 | \item Run mkimxboot, passing the name of the OF and bootloader files that you | ||
59 | downloaded, in addition to a name for the output file and the option argument | ||
60 | for dualboot. | ||
61 | |||
62 | % See above for the code environment arguments explanation. | ||
63 | \begin{code}[firstline=\opt{fuzeplus}{1},% | ||
64 | lastline=\opt{fuzeplus}{1}] | ||
65 | ./mkimxboot -i firmware.sb -b bootloader-fuzeplus.sansa -o patched.sb -t dualboot | ||
66 | |||
67 | \end{code} | ||
68 | |||
69 | If mkimxboot does not report success, then retry or abort. | ||
70 | |||
71 | \item Copy the output file (``patched.sb'' in the example given above) to the | ||
72 | root of the device and rename it to the same name as the OF file you downloaded earlier | ||
73 | \opt{fuzeplus}{(``firmware.sb''} above). | ||
74 | \end{enumerate} | ||
75 | |||
76 | Please now go to \reference{ref:finish_install} to complete the installation procedure. | ||
77 | |||
diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex index c3f7ab0daf..5cf1606510 100644 --- a/manual/getting_started/installation.tex +++ b/manual/getting_started/installation.tex | |||
@@ -100,7 +100,7 @@ follow the instructions at | |||
100 | \end{description} | 100 | \end{description} |
101 | } | 101 | } |
102 | 102 | ||
103 | \opt{sansaAMS}{ | 103 | \opt{sansaAMS,fuzeplus}{ |
104 | \begin{description} | 104 | \begin{description} |
105 | \item[DRM capability.] It is possible that installation of the bootloader | 105 | \item[DRM capability.] It is possible that installation of the bootloader |
106 | may lead to you \emph{permanently} losing the ability to playback files | 106 | may lead to you \emph{permanently} losing the ability to playback files |
@@ -147,12 +147,15 @@ follow the instructions at | |||
147 | is intended to be used for USB OTG connections only (digital cameras, memory | 147 | is intended to be used for USB OTG connections only (digital cameras, memory |
148 | sticks, etc.). | 148 | sticks, etc.). |
149 | } | 149 | } |
150 | \opt{sansa,e200v2,clipv1,clipv2}{ | 150 | \opt{sansa,e200v2,clipv1,clipv2,fuzeplus}{ |
151 | \note{The following steps require you to change the setting in | 151 | \note{The following steps require you to change the setting in |
152 | \setting{Settings $\rightarrow$ USB Mode} to \setting{MSC} from within the | 152 | \setting{Settings $\rightarrow$ USB Mode} to \setting{MSC} from within the |
153 | original firmware.} | 153 | original firmware.} |
154 | 154 | ||
155 | \nopt{sansaAMS}{\warn{Never extract files to your \dap{} while it is in recovery mode.}} | 155 | \nopt{sansaAMS,fuzeplus}{ |
156 | \warn{Never extract files to your \dap{} while it | ||
157 | is in recovery mode.} | ||
158 | } | ||
156 | } | 159 | } |
157 | 160 | ||
158 | \opt{fuze,fuzev2,clipplus}{ | 161 | \opt{fuze,fuzev2,clipplus}{ |
@@ -384,6 +387,21 @@ filesystem.\\* | |||
384 | files using \fname{unzip}. | 387 | files using \fname{unzip}. |
385 | } | 388 | } |
386 | 389 | ||
390 | \opt{fuzeplus}{ | ||
391 | Rockbox Utility will ask you for a compatible copy of the original | ||
392 | firmware. This is because for legal reasons we cannot distribute | ||
393 | the bootloader directly. Instead, we have to patch the \playerman{} | ||
394 | firmware with the Rockbox bootloader. | ||
395 | |||
396 | Download a supported version of the \playerman{} firmware for your | ||
397 | \playername{} from the \playerman{} website, links can be found on | ||
398 | \wikilink{SansaFuzePlusPort}. | ||
399 | \note{Although the only tested version of the original firmware is 02.38.6, | ||
400 | Rockbox Utility should be able to patch any newer version.} | ||
401 | \note{If the file that you downloaded is a \fname{.zip} file, use an unzip | ||
402 | utility like mentioned in the prerequisites section to extract the | ||
403 | \fname{firmware.sb} from the \fname{.zip} file to your desktop.} | ||
404 | } | ||
387 | \subsubsection{Choosing a Rockbox version}\label{sec:choosing_version} | 405 | \subsubsection{Choosing a Rockbox version}\label{sec:choosing_version} |
388 | 406 | ||
389 | There are three different versions of Rockbox available from the | 407 | There are three different versions of Rockbox available from the |
@@ -450,14 +468,14 @@ data partition.}} | |||
450 | correct version for your \dap{}.}} | 468 | correct version for your \dap{}.}} |
451 | 469 | ||
452 | \item Connect your \dap{} to the computer via USB | 470 | \item Connect your \dap{} to the computer via USB |
453 | \opt{sansa,sansaAMS,iriverh10,iriverh10_5gb,vibe500}{ in MSC mode } | 471 | \opt{sansa,sansaAMS,iriverh10,iriverh10_5gb,vibe500,fuzeplus}{ in MSC mode } |
454 | \opt{ipod3g,ipod4g,ipodmini,ipodcolor}{ or Firewire }as described in | 472 | \opt{ipod3g,ipod4g,ipodmini,ipodcolor}{ or Firewire }as described in |
455 | the manual that came with your \dap{}. | 473 | the manual that came with your \dap{}. |
456 | 474 | ||
457 | \item Take the \fname{.zip} file that you downloaded and use | 475 | \item Take the \fname{.zip} file that you downloaded and use |
458 | the ``Extract all'' command of your unzip program to extract | 476 | the ``Extract all'' command of your unzip program to extract |
459 | the files onto% | 477 | the files onto |
460 | \opt{gigabeats}{the main data partition of } | 478 | \opt{gigabeats,fuzeplus}{the main data partition of } |
461 | \opt{cowond2}{either an SD card or the internal memory of } | 479 | \opt{cowond2}{either an SD card or the internal memory of } |
462 | \opt{ondavx777}{the MicroSD of } | 480 | \opt{ondavx777}{the MicroSD of } |
463 | your \dap{}. | 481 | your \dap{}. |
@@ -501,6 +519,7 @@ structure that Rockbox needs.\\} | |||
501 | \opt{cowond2}{\input{getting_started/cowond2_install.tex}} | 519 | \opt{cowond2}{\input{getting_started/cowond2_install.tex}} |
502 | \opt{vibe500}{\input{getting_started/vibe500_install.tex}} | 520 | \opt{vibe500}{\input{getting_started/vibe500_install.tex}} |
503 | \opt{ondavx777}{\input{getting_started/ondavx777_install.tex}} | 521 | \opt{ondavx777}{\input{getting_started/ondavx777_install.tex}} |
522 | \opt{IMX233}{\input{getting_started/IMX233_install.tex}} | ||
504 | } | 523 | } |
505 | } | 524 | } |
506 | 525 | ||
@@ -562,6 +581,24 @@ structure that Rockbox needs.\\} | |||
562 | firmware process usually takes a minute or so.). You are now ready to go. | 581 | firmware process usually takes a minute or so.). You are now ready to go. |
563 | \end{itemize} | 582 | \end{itemize} |
564 | } | 583 | } |
584 | \opt{fuzeplus}{ | ||
585 | \warn{Before proceeding further, make sure that your player's battery is enough charged. | ||
586 | Interrupting the next step due to a power failure most likely | ||
587 | will brick your \dap{}. | ||
588 | } | ||
589 | \note{If you are updating/reinstalling the bootloader on a previouslsy | ||
590 | rockbox installed bootloader you will need to boot into the original | ||
591 | firmware in order to perform the following step. See \reference{ref:Dualboot} | ||
592 | for details on how to do so | ||
593 | } | ||
594 | Update your \daps{} firmware with the patched bootloader. To do this, | ||
595 | safely eject /unmount your \dap{}. The update process should start | ||
596 | immediatly. The \playerman{} will display an animation indicating that the | ||
597 | firmware update is in progress with words: ``Updating Fuze+''. | ||
598 | Do \emph{not} interrupt this process. When the firmware update is complete the | ||
599 | player will restart (The update firmware process usually takes one to several | ||
600 | minutes.). You are now ready to go. | ||
601 | } | ||
565 | \opt{mpiohd200}{ | 602 | \opt{mpiohd200}{ |
566 | \begin{itemize} | 603 | \begin{itemize} |
567 | \item Safely eject /unmount your \dap{}. | 604 | \item Safely eject /unmount your \dap{}. |
@@ -664,7 +701,7 @@ The new build will be installed over your current build.\\ | |||
664 | 701 | ||
665 | \section{Uninstalling Rockbox}\index{Installation!uninstall} | 702 | \section{Uninstalling Rockbox}\index{Installation!uninstall} |
666 | 703 | ||
667 | \nopt{gigabeatf,iaudiom3,iaudiom5,iaudiox5,archos,mrobe100,gigabeats}{ | 704 | \nopt{gigabeatf,iaudiom3,iaudiom5,iaudiox5,archos,mrobe100,gigabeats,fuzeplus}{ |
668 | \note{The Rockbox bootloader allows you to choose between Rockbox and | 705 | \note{The Rockbox bootloader allows you to choose between Rockbox and |
669 | the original firmware. (See \reference{ref:Dualboot} for more information.)} | 706 | the original firmware. (See \reference{ref:Dualboot} for more information.)} |
670 | } | 707 | } |
@@ -676,7 +713,7 @@ You can uninstall Rockbox automatically by using Rockbox Utility. If you | |||
676 | installed Rockbox manually you can still use Rockbox Utility for uninstallation | 713 | installed Rockbox manually you can still use Rockbox Utility for uninstallation |
677 | but will not be able to do this selectively. | 714 | but will not be able to do this selectively. |
678 | 715 | ||
679 | \opt{iriverh100,iriverh300}{\note{Rockbox Utility cannot uninstall the bootloader due to | 716 | \opt{iriverh100,iriverh300,fuzeplus}{\note{Rockbox Utility cannot uninstall the bootloader due to |
680 | the fact that it requires a flashing procedure. To uninstall the bootloader | 717 | the fact that it requires a flashing procedure. To uninstall the bootloader |
681 | completely follow the manual uninstallation instructions below.}} | 718 | completely follow the manual uninstallation instructions below.}} |
682 | 719 | ||
@@ -755,9 +792,9 @@ completely follow the manual uninstallation instructions below.}} | |||
755 | } | 792 | } |
756 | } | 793 | } |
757 | 794 | ||
758 | \opt{sansaAMS}{ | 795 | \opt{sansaAMS,fuzeplus}{ |
759 | Copy an unmodified original firmware to your player, and then reboot into | 796 | Copy an unmodified original firmware to your player, and then reboot into |
760 | the Sandisk firmware. | 797 | the Sandisk firmware. See \reference{ref:Dualboot} for more information. |
761 | } | 798 | } |
762 | 799 | ||
763 | \opt{mpiohd200}{ | 800 | \opt{mpiohd200}{ |
@@ -805,6 +842,15 @@ completely follow the manual uninstallation instructions below.}} | |||
805 | please ensure that you are either logged in as an administrator (Windows), or | 842 | please ensure that you are either logged in as an administrator (Windows), or |
806 | you have root rights (Linux)} | 843 | you have root rights (Linux)} |
807 | 844 | ||
845 | \opt{fuzeplus}{ | ||
846 | \item[Immediately loading original firmware.] | ||
847 | If the original firmware is immediately loaded without going into updating | ||
848 | the firmware, then the Rockbox bootloader has not been correctly installed. | ||
849 | The original firmware will only perform the update if the filename is | ||
850 | correct, including case. Make sure that the patched Sansa firmware is called | ||
851 | \fname{firmware.sb} and present in the root directory of your player. | ||
852 | } | ||
853 | |||
808 | \opt{iriverh100,iriverh300}{ | 854 | \opt{iriverh100,iriverh300}{ |
809 | \item[Immediately loading original firmware.] | 855 | \item[Immediately loading original firmware.] |
810 | If the original firmware is immediately | 856 | If the original firmware is immediately |
@@ -847,7 +893,7 @@ then you can try generating \fname{rockbox.tar} instead of | |||
847 | \begin{code} | 893 | \begin{code} |
848 | make tar | 894 | make tar |
849 | \end{code} | 895 | \end{code} |
850 | and copying it to the data partition. During the next boot, the bootloader | 896 | and copying it to the data partition. During the next boot, the bootloader |
851 | will extract it. | 897 | will extract it. |
852 | \end{itemize} | 898 | \end{itemize} |
853 | } | 899 | } |