Qualcomm Image Loader (QIL)

Overview

Qualcomm Image Loader (QIL) is a tool for building and managing Qualcomm device images. This project supports multiple platforms including Windows (ARM64 and x64) and Linux.

Build Instructions for Windows

Windows One Time Setup

1. Download Visual Studio Build Tools:

   • Visit https://aka.ms/vs/stable/vs_BuildTools.exe NOTE: Only Visual Studio Build Tools are required.

2. Run the installer and select "Individual components"

3. Install required components based on your target architecture:

   • For x64 builds, select:

     • MSVC build tools for x64/x86 (latest)
     • C++ CMake Tools for Windows
     • Windows 11 SDK (10.0.22621.0)
     • MSVC v142 - VS 2019 C++ x64/x86 build tools

   • For ARM64 builds, select:

     • MSVC build tools for ARM64/ARM64EC (latest)
     • C++ CMake Tools for Windows
     • Windows 11 SDK (10.0.22621.0)
     • MSVC v142 - VS 2019 C++ ARM64 build tools

4. Verify installation:

   cmake --version

   You should see the CMake version and the MSVC compiler information.

   If CMake is not found, ensure you've added it to your system PATH as mentioned in the requirements section. You can add it by:

   1. Open System Properties (Win + Pause/Break)
   2. Click "Advanced system settings"
   3. Click "Environment Variables"
   4. Under "System variables", find and select "Path"
   5. Click "Edit"
   6. Click "New"
   7. Add the CMake bin directory path
   8. Click "OK" to save
   9. Restart any open command prompts for the changes to take effect

Building on Windows (x64/ARM64)

1. Open a Command Prompt
2. Navigate to the project directory:

   cd path\to\project

3. Create and navigate to a build directory:

   mkdir build
   cd build

4. Configure with CMake:
   • For x64:

     cmake .. -A x64

   • For ARM64:

     cmake .. -A ARM64

5. Build the project:

   cmake --build . --config Release

Build Output

Windows (x64)

build/Windows/x64/Release/bin/

Windows (ARM64)

build/Windows/ARM64/Release/bin/

Build Instructions for Linux

Linux One Time Setup

1. Install required development packages:

   sudo apt update
   sudo apt install \
     cmake \
     libusb-1.0-0-dev \
     libudev-dev \
     uuid-dev \
     pkg-config \
     zlib1g-dev \
     build-essential \
     libxml2-dev

2. Verify installation:

   cmake --version
   gcc --version

Building on Linux

1. Navigate to the project directory:

   cd path/to/project

2. Create and navigate to a build directory:

   mkdir build
   cd build

3. Configure and build:

   cmake .. -DCMAKE_BUILD_TYPE=Release 
   cmake --build .

Build Output

build/Linux/x86_64/Release/bin/

Project Structure

.
├── CMakeLists.txt          # Main CMake configuration file
├── src/                    # Source code directory
│   ├── callback/           # Callback implementations
│   ├── cli/                # Command-line interface
│   ├── communication/      # Communication protocols
│   ├── device/             # Device management
│   ├── exports/            # Export definitions
│   ├── external/           # External dependencies
│   │   ├── kLogger/        # Logging library
│   │   ├── libiconv-win-build/  # Character encoding conversion library
│   │   └── libxml2-win-build/   # XML parsing library
│   ├── function/           # Function implementations
│   ├── platform/           # Platform-specific abstractions
│   ├── protocol/           # Protocol implementations
│   │   └── firehose-loader/     # Firehose loader protocol
│   ├── qds/                # Qualcomm Device Service
│   │   ├── common/         # Common utilities
│   │   ├── libusb/         # USB library interface
│   │   ├── qds_lnx/        # Linux-specific implementations
│   │   └── qds_win/        # Windows-specific implementations
│   ├── report/             # Reporting functionality
│   ├── rpc/                # Remote procedure call implementations
│   ├── tracker/            # Function tracking
│   └── util/               # Utility functions
├── doc/                    # Documentation
└── build/                  # Build output directory

Troubleshooting

Common Issues

Windows

1. "CMake not found"

   • Ensure CMake is installed and added to PATH
   • Restart the Command Prompt

2. "MSVC compiler not found"

   • Verify Visual Studio Build Tools installation

3. Missing Windows SDK

   • Rerun the Visual Studio installer
   • Select and install the Windows 11 SDK (10.0.22621.0)

Linux

1. Missing development packages

   • Ensure all required packages are installed (see Linux One Time Setup section)
   • If you see errors about missing libraries, install the missing package

2. Build errors related to C++17

   • Ensure your compiler supports C++17
   • On older systems, you may need to install or upgrade GCC/G++

Getting in Contact

How to contact maintainers. E.g. GitHub Issues, GitHub Discussions could be indicated for many cases. However a mail list or list of Maintainer e-mails could be shared for other types of discussions. E.g.

• Report an Issue on GitHub
• Open a Discussion on GitHub

License

Qualcomm Image Loader and BSD 3-Clause Clear License Qualcomm Image Loader is licensed under the BSD-3-Clause-Clear License. See LICENSE.txt for the full license text.

Third-Party Components

qil incorporates third-party libraries under their own licenses. In particular it dynamically links libusb-1.0 (https://libusb.info), which is licensed under the GNU Lesser General Public License v2.1 or later (LGPL-2.1-or-later).

• A verbatim copy of the LGPL-2.1 license text is at LICENSES/libusb-1.0-LGPL-2.1.txt.
• A full inventory of third-party components and their licenses is in THIRD_PARTY_NOTICES.md.
• Guidance on how qil itself complies with LGPL §6 and what downstream redistributors of qil binaries must do is in doc/LGPL-COMPLIANCE.md.

The exact libusb version used by qil, and its corresponding source, are recorded in THIRD_PARTY_NOTICES.md (currently libusb 1.0.27, unmodified, from https://github.com/libusb/libusb/releases/tag/v1.0.27).