Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit ae1cb9a6 authored by Romain Hunault's avatar Romain Hunault 💻
Browse files

Install heimdall using our builds

parent 61923782

_includes/templates/recovery_install_heimdall.md

+1 −1
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ Samsung devices come with a unique boot mode called “Download mode”, which i 
1. Enable OEM unlock in the Developer options under device Settings.

    > It appears sometime that the OEM unlock option is missing from Development options, especially on new devices. Please connect your device to the wifi and check of system updates. After a reboot, the option should appear.



1. Build latest [Heimdall suite](../../how-tos/install-heimdall):

1. Install the [Heimdall suite](../../how-tos/install-heimdall):

1. Power off the device and connect the USB adapter to the computer (but not to the device, yet).

1. Boot into download mode:

    * {{ device.download_boot }}

pages/build-heimdall.md

0 → 100644
+64 −0
Original line number Diff line number Diff line 
---

layout: default

title: Build Heimdall

permalink: how-tos/build-heimdall

---



# Build Heimdall



The Heimdall project does not provide package for the last version. So you need to build it manually from [our fork](https://gitlab.e.foundation/e/tools/heimdall). Bellow the documentation for each platform, extracted from README of Heimdall project.



## Download Heimdall sources



Download from [Heimdall source code repository](https://gitlab.e.foundation/e/tools/heimdall).



## If you are building on Windows (Source: [Heimdall/Win32/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/Win32/README.txt#L518))



Heimdall and Heimdall Frontend both utilise CMake for managing the build process. CMake can generate files for various build systems including GNU Make and Visual Studio. However, official packages are compiled with GNU Make and MinGW-W64 GCC/G++.



**NOTE**: Official builds use MinGW-W64 simply because on-going cross-platform development is simpler when using just the one IDE (Jetbrain's CLion) and similar toolchains.



1. Setup a MinGW-W64 build environment by utilising MSYS2: http://msys2.github.io/

2. After installing MSYS2 a command prompt will launch, enter:

```

Pacman -Syu

Pacman -S mingw-w64-x86_64 mingw-w64-x86_64-clang mingw-w64-x86_64-cmake mingw-w64-x86_64-libusb mingw-w64-x86_64-qt5-static make

 ```

3. Add the MinGW-W64 binaries to your PATH environment variable:

```

export PATH="/mingw64/bin:$PATH"

```

4. Build Heimdall & Heimdall Frontend

```

mkdir build

cd build

cmake -G "MSYS Makefiles" -DCMAKE_BUILD_TYPE=Release -DQt5Widgets_DIR=/c/msys64/mingw64/qt5-static/lib/cmake/Qt5Widgets ..

make

```



## If you are building on Linux (Source: [Heimdall/Linux/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/Linux/README#L475))



1. First make sure you have installed `build-essential`, `cmake`, `zlib1g-dev`, `qt5-default`, `libusb-1.0-0-dev` and `OpenGL` (e.g `libgl1-mesa-glx` and `libgl1-mesa-dev`). **NOTE**: Package names may not be absolutely identical to those above.

2. Open a terminal and navigate to the directory you downloaded, or extracted, Heimdall to.

3. Enter the following commands to compile Heimdall Suite:

```

mkdir build cd build cmake -DCMAKE_BUILD_TYPE=Release .. make

```



## If you are building on Mac OSX (Source : [Heimdall/OSX/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/OSX/README.txt#L480))



1. Apply following patch:

    * [https://gitlab.com/bfabiszewski/Heimdall/commit/49416216c6d131769521c7f2c573cc78455941b2](https://gitlab.com/bfabiszewski/Heimdall/commit/49416216c6d131769521c7f2c573cc78455941b2)

1. Open Terminal and install dependencies using Homebrew (http://brew.sh)

```

brew install libusb qt5 cmake

```

1. Build Heimdall & Heimdall Frontend

```

mkdir build

cd build

cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release -DQt5Widgets_DIR=/usr/local/opt/qt5/lib/cmake/Qt5Widgets ..

make

```



*This documentation "Install Heimdall v1.4.2" is a derivative of [Win32/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/Win32/README.txt), [Linux/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/Linux/README) and [/OSX/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/OSX/README.txt) by [Heimdall Project](ttps://gitlab.com/BenjaminDobell/Heimdall), used under [MIT License](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/LICENSE).*

pages/install-heimdall.md

+42 −40
Original line number Diff line number Diff line
@@ -6,59 +6,61 @@ permalink: how-tos/install-heimdall 


# Install Heimdall



The Heimdall project does not provide package for the last version. So you need to build it manually from [its sources](https://gitlab.com/BenjaminDobell/Heimdall). Bellow the documentation for each platform, extracted from README of Heimdall project.

The Heimdall project does not provide up to date packages. This means that in some cases, it will just not work. Consequently, we provide [patched sources](https://gitlab.e.foundation/e/tools/heimdall](https://gitlab.e.foundation/e/tools/heimdall) and corresponding binaries.



## Download Heimdall sources

> If you prefer to build the Heimdall suite by yourself, you can follow our documentation available [here](build-heimdall)



Download from [Heimdall source code repository](https://gitlab.com/BenjaminDobell/Heimdall)

## Download Heimdall binaries



## If you are building on Windows (Source: [Heimdall/Win32/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/Win32/README.txt#L518))

Download binaries provided by us at [here](https://images.ecloud.global/tools/heimdall/) for you platform.



Heimdall and Heimdall Frontend both utilise CMake for managing the build process. CMake can generate files for various build systems including GNU Make and Visual Studio. However, official packages are compiled with GNU Make and MinGW-W64 GCC/G++.

## Install



**NOTE**: Official builds use MinGW-W64 simply because on-going cross-platform development is simpler when using just the one IDE (Jetbrain's CLion) and similar toolchains.

### On Windows



1. Setup a MinGW-W64 build environment by utilising MSYS2: http://msys2.github.io/

2. After installing MSYS2 a command prompt will launch, enter:

```

Pacman -Syu

Pacman -S mingw-w64-x86_64 mingw-w64-x86_64-clang mingw-w64-x86_64-cmake mingw-w64-x86_64-libusb mingw-w64-x86_64-qt5-static make

 ```

3. Add the MinGW-W64 binaries to your PATH environment variable:

```

export PATH="/mingw64/bin:$PATH"

```

4. Build Heimdall & Heimdall Frontend

```

mkdir build

cd build

cmake -G "MSYS Makefiles" -DCMAKE_BUILD_TYPE=Release -DQt5Widgets_DIR=/c/msys64/mingw64/qt5-static/lib/cmake/Qt5Widgets ..

make

```

At the moment, the Windows build is not available. Please build it by yourself following [our documentation](build-heimdall).



### On Ubuntu



## If you are building on Linux (Source: [Heimdall/Linux/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/Linux/README#L475))

Run the following commands to install heimdall for all users:



1. First make sure you have installed `build-essential`, `cmake`, `zlib1g-dev`, `qt5-default`, `libusb-1.0-0-dev` and `OpenGL` (e.g `libgl1-mesa-glx` and `libgl1-mesa-dev`). **NOTE**: Package names may not be absolutely identical to those above.

2. Open a terminal and navigate to the directory you downloaded, or extracted, Heimdall to.

3. Enter the following commands to compile Heimdall Suite:

```

mkdir build cd build cmake -DCMAKE_BUILD_TYPE=Release .. make

$ unzip /path/to/heimdall_ubuntu.zip -d /tmp

$ cp /tmp/bin/heimdall* /usr/bin/

$ rm -rf /tmp/bin

```



## If you are building on Mac OSX (Source : [Heimdall/OSX/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/OSX/README.txt#L480))

### On MacOSX



Run the following commands to install heimdall for all users:



1. Apply following patch:

    * [https://gitlab.com/bfabiszewski/Heimdall/commit/49416216c6d131769521c7f2c573cc78455941b2](https://gitlab.com/bfabiszewski/Heimdall/commit/49416216c6d131769521c7f2c573cc78455941b2)

1. Open Terminal and install dependencies using Homebrew (http://brew.sh)

```

brew install libusb qt5 cmake

```

1. Build Heimdall & Heimdall Frontend

$ unzip /path/to/heimdall_macos.zip -d /tmp

$ cp /tmp/bin/heimdall /usr/local/bin

$ rm -rf /tmp/bin

```

mkdir build

cd build

cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release -DQt5Widgets_DIR=/usr/local/opt/qt5/lib/cmake/Qt5Widgets ..

make



## Validate



In a terminal, you can run run the following command to check that everything is working properly:



```

$ heimdall info

Heimdall v1.4.2



Copyright (c) 2010-2017 Benjamin Dobell, Glass Echidna

http://www.glassechidna.com.au/



*This documentation "Install Heimdall v1.4.2" is a derivative of [Win32/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/Win32/README.txt), [Linux/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/Linux/README) and [/OSX/README.txt](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/OSX/README.txt) by [Heimdall Project](ttps://gitlab.com/BenjaminDobell/Heimdall), used under [MIT License](https://gitlab.com/BenjaminDobell/Heimdall/blob/master/LICENSE).*
 
This software is provided free of charge. Copying and redistribution is

encouraged.



If you appreciate this software and you would like to support future

development please consider donating:

http://www.glassechidna.com.au/donate/



Heimdall utilises libusbx for all USB communication:

    http://www.libusb.org/



libusbx is licensed under the LGPL-2.1:

    http://www.gnu.org/licenses/licenses.html#LGPL

```