summaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
authorDana Conrad <dconrad@fastmail.com>2024-09-13 12:18:01 -0500
committerSolomon Peachy <pizza@shaftnet.org>2024-09-15 14:53:49 -0400
commit018c54ad1c1fdd15759141da11120e00763986cd (patch)
tree1648f2aded848d823f9d4454bd67e68989840659 /manual
parent5ab334f07fcb288aad9ea000717586dc79ec3d0a (diff)
downloadrockbox-018c54ad1c1fdd15759141da11120e00763986cd.tar.gz
rockbox-018c54ad1c1fdd15759141da11120e00763986cd.zip
Manual: Update erosqnative
Update installation instructions, and add a couple things that were missing. Change-Id: I7313285338fe5c4bc05a944e3ba2ff941a796d5b
Diffstat (limited to 'manual')
-rw-r--r--manual/configure_rockbox/sound_settings.tex17
-rw-r--r--manual/getting_started/hibyos_nativeinstall.tex66
-rw-r--r--manual/getting_started/installation.tex29
3 files changed, 104 insertions, 8 deletions
diff --git a/manual/configure_rockbox/sound_settings.tex b/manual/configure_rockbox/sound_settings.tex
index fd69d63317..0aeada59b2 100644
--- a/manual/configure_rockbox/sound_settings.tex
+++ b/manual/configure_rockbox/sound_settings.tex
@@ -44,10 +44,6 @@ change to customise your listening experience.
44 limit, select a volume from the list and the maximum volume will be limited to 44 limit, select a volume from the list and the maximum volume will be limited to
45 the selected value all over the system. 45 the selected value all over the system.
46 \opt{xduoox3}{This setting also applies to the Line Out of the \dap{}, as at full scale the \dap{} overdrives the signal.} 46 \opt{xduoox3}{This setting also applies to the Line Out of the \dap{}, as at full scale the \dap{} overdrives the signal.}
47 \opt{erosqnative}{On the \playertype{}, when using the Line Out without anything connected to the Headphone port,
48 the volume is fixed to the \setting{Volume Limit} value.
49 \note{On the \playertype{}, the Line Out level at -2~dB is approximately +7~dBV, -4~dB is approximately +4~dBu,
50 and -18~dB is approximately -10~dBV.}}
51 47
52\section{Bass} 48\section{Bass}
53 This setting emphasises 49 This setting emphasises
@@ -196,8 +192,7 @@ change to customise your listening experience.
196\opt{erosqnative}{ 192\opt{erosqnative}{
197 \section{Stereo Switch Mode} 193 \section{Stereo Switch Mode}
198 The Eros Q and related devices contain a stereo switch in the audio path. 194 The Eros Q and related devices contain a stereo switch in the audio path.
199 This may be connected differently depending on the hardware revision. This 195 This setting allows the behavior of the stereo switch to be changed if one of
200 setting allows the behavior of the stereo switch to be changed if one of
201 the two outputs (Headphones or Line Out) is not working. There are four modes: 196 the two outputs (Headphones or Line Out) is not working. There are four modes:
202 \begin{description} 197 \begin{description}
203 \item[Normal.] 198 \item[Normal.]
@@ -209,6 +204,16 @@ change to customise your listening experience.
209 \item[Always 1.] 204 \item[Always 1.]
210 Both outputs use a value of 1. 205 Both outputs use a value of 1.
211 \end{description} 206 \end{description}
207
208 \section{DAC filter roll-off}
209 Later versions of the Eros Q and related devices contain a DAC with user-selectable
210 filter roll-off modes. This allows switching between the following modes:
211 \begin{itemize}
212 \item "Sharp"
213 \item "Slow"
214 \item "Short"
215 \item "Bypass"
216 \end{itemize}
212} 217}
213 218
214\opt{dac_power_mode}{ 219\opt{dac_power_mode}{
diff --git a/manual/getting_started/hibyos_nativeinstall.tex b/manual/getting_started/hibyos_nativeinstall.tex
new file mode 100644
index 0000000000..9312a8ec71
--- /dev/null
+++ b/manual/getting_started/hibyos_nativeinstall.tex
@@ -0,0 +1,66 @@
1We will install the bootloader with the original firmware's recovery
2mode. The process is summed up as the following:
3
4\begin{itemize}
5 \item Determine what hardware version your player is and download
6 the correct bootloader update file
7 \item Place the bootloader \fname{update.upt} file on the SD card
8 \item In the original firmware, run the Firmware Update
9 \code{System Settings --> Firmware Update}
10\end{itemize}
11
12\subsubsection{Determine hardware version}\label{ref:determine_hardware_version}
13Determine what hardware version your player is. Go to
14\code{System Settings --> About The Player --> Version} and reference
15the list below. hw1, hw1.5, and hw2 players all use the same update
16file (with one exception), while hw3 players use a different one.
17
18\note{Important: If your player's version is not contained in this list,
19for example if the firmware version is newer than what is listed here,
20we cannot be sure that the hardware is the same. The best thing to do is
21contact the manufacturer and ask them two things: (1) for an update file
22of your version, and (2) if a player with the most recent version listed
23here can be upgraded to the firmware version on your player. If they say
24yes, we can be more certain that the hardware has not changed. These lists
25may not be the most up to date, please see the wiki page at
26\url{https://www.rockbox.org/wiki/AIGOErosQK} for the most up-to-date list.}
27
28\begin{description}
29\item[hw1/hw1.5/hw2 players]
30 \begin{itemize}
31 \item Aigo Eros Q V1.8 - V2.0
32 \item Hifiwalker H2 V1.1 - V1.6
33 \item Surfans F20 V2.2 - V2.7
34 \end{itemize}
35
36 These players use \fname{erosqnative-hw1hw2-erosq.upt} as the update file.
37 The lone exception is the Hifiwalker H2 V1.3, which uses the update file
38 \fname{erosqnative-hw1hw2-eros_h2.upt}.
39\item[hw3 players]
40 \begin{itemize}
41 \item Aigo Eros Q V2.1
42 \item Hifiwalker H2 V1.7 - V1.8
43 \item Surfans F20 V3.0 - V3.3
44 \end{itemize}
45
46 These players use \fname{erosqnative-hw3-erosq.upt} as the update file.
47\end{description}
48
49Download the \fname{.upt} file for these players from \download{bootloader/aigo/native/}.
50
51\note{All players use the same Rockbox build, only the bootloader is different.}
52
53\subsubsection{Place update file on SD card}\label{ref:place_on_sd_card}
54Place the appropriate bootloader file on the root of the SD card and name it
55\emph{exactly} \fname{update.upt}.
56
57\note{This is a good time to ensure that your Rockbox installation \fname{.rockbox}
58is present on your SD card.}
59
60Don't forget to safely eject/unmount your player.
61
62\subsubsection{Run Firmware Update}\label{ref:run_firmware_update}
63In the original firmware, run the firmware updater by going to
64\code{System Settings --> Firmware Update}. At this point, you can delete
65\fname{update.upt} from the SD card if you wish. \emph{Do not delete .rockbox,
66this is your Rockbox installation and needs to stay there!} \ No newline at end of file
diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex
index 661964dd8a..04118680b1 100644
--- a/manual/getting_started/installation.tex
+++ b/manual/getting_started/installation.tex
@@ -118,6 +118,15 @@ of before installing.
118\begin{description} 118\begin{description}
119 \item[Filesystem support.] Rockbox only supports the FAT32 filesystem. Other 119 \item[Filesystem support.] Rockbox only supports the FAT32 filesystem. Other
120 filesystems such as exFAT or NTFS are not supported. 120 filesystems such as exFAT or NTFS are not supported.
121
122 \opt{erosqnative}{\note{Many SD cards come with exFAT on them from the
123 factory. The original firmware can be used to reformat them to FAT
124 by going to \code{System Settings --> Reset --> Format TF Card}.}
125
126 \note{The SD card that sometimes come bundled with these players are usually
127 of substandard quality and are not to be trusted. It is recommended to source
128 a card of a reputable brand, from a reputable source, such as direct from
129 the manufacturer.}}
121 \item[USB DAC.] This feature is not supported by Rockbox, but you can 130 \item[USB DAC.] This feature is not supported by Rockbox, but you can
122 dual-boot the original firmware if you want to use it. 131 dual-boot the original firmware if you want to use it.
123 \opt{shanlingq1,agptekrocker,xduoox3ii,xduoox20,aigoerosq,erosqnative}{\item[Wireless.] There is no support for Bluetooth\opt{shanlingq1}{ or WiFi}. 132 \opt{shanlingq1,agptekrocker,xduoox3ii,xduoox20,aigoerosq,erosqnative}{\item[Wireless.] There is no support for Bluetooth\opt{shanlingq1}{ or WiFi}.
@@ -545,7 +554,8 @@ by Rockbox, in the main directory of your \daps{} drive.
545 \opt{samsungyh}{\input{getting_started/samsungyh_install.tex}} 554 \opt{samsungyh}{\input{getting_started/samsungyh_install.tex}}
546 \opt{xduoox3}{\input{getting_started/xduoox3_install.tex}} 555 \opt{xduoox3}{\input{getting_started/xduoox3_install.tex}}
547 \opt{xduoox3ii,xduoox20,agptekrocker,aigoerosq}{\input{getting_started/hibyos_install.tex}} 556 \opt{xduoox3ii,xduoox20,agptekrocker,aigoerosq}{\input{getting_started/hibyos_install.tex}}
548 \opt{fiiom3k,shanlingq1,erosqnative}{\input{getting_started/jztool_install.tex}} 557 \opt{fiiom3k,shanlingq1}{\input{getting_started/jztool_install.tex}}
558 \opt{erosqnative}{\input{getting_started/hibyos_nativeinstall.tex}}
549 } 559 }
550} 560}
551 561
@@ -807,7 +817,7 @@ completely follow the manual uninstallation instructions below.}}
807 \playerman{} firmware. 817 \playerman{} firmware.
808} 818}
809 819
810\opt{fiiom3k,shanlingq1,erosqnative}{ 820\opt{fiiom3k,shanlingq1}{
811 If you want to remove the Rockbox bootloader, copy an original firmware 821 If you want to remove the Rockbox bootloader, copy an original firmware
812 update to your microSD card and run the \playerman{} update by 822 update to your microSD card and run the \playerman{} update by
813 \opt{erosqnative}{running it from the Original Firmware's System Settings menu.} 823 \opt{erosqnative}{running it from the Original Firmware's System Settings menu.}
@@ -821,6 +831,21 @@ completely follow the manual uninstallation instructions below.}}
821 and enter the recovery menu -- see \reference{ref:jztool_load_bootloader}. 831 and enter the recovery menu -- see \reference{ref:jztool_load_bootloader}.
822} 832}
823 833
834\opt{erosqnative}{
835 If you want to remove the Rockbox bootloader, you will need to acquire the correct
836 update file for your brand player and original firmware version number. The
837 uninstallation procedure can then be done as follows:
838
839 \begin{itemize}
840 \item If the update file is unmodified, use \fname{tools/hibyos_nativepatcher/hibyos_nativepatcher.sh}
841 to mark the original bootloader for updating
842 \item Place the update file on the SD card and ensure it is named \emph{exactly}
843 \fname{update.upt}
844 \item Boot into the Rockbox bootloader menu: With the player off, hold \ButtonVolUp + \ButtonPower
845 \item Select "Aigo Recovery"
846 \end{itemize}
847}
848
824\nopt{gigabeats}{ 849\nopt{gigabeats}{
825 If you wish to clean up your disk, you may also wish to delete the 850 If you wish to clean up your disk, you may also wish to delete the
826 \fname{.rockbox} directory and its contents. 851 \fname{.rockbox} directory and its contents.