FirmwareKit.Comm.EDL
1.1.0
.NET 8.0
This package targets .NET 8.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
dotnet add package FirmwareKit.Comm.EDL --version 1.1.0
NuGet\Install-Package FirmwareKit.Comm.EDL -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="FirmwareKit.Comm.EDL" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FirmwareKit.Comm.EDL" Version="1.1.0" />
<PackageReference Include="FirmwareKit.Comm.EDL" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add FirmwareKit.Comm.EDL --version 1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: FirmwareKit.Comm.EDL, 1.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package FirmwareKit.Comm.EDL@1.1.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=FirmwareKit.Comm.EDL&version=1.1.0
#tool nuget:?package=FirmwareKit.Comm.EDL&version=1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
FirmwareKit.Comm.EDL
The main library of the FirmwareKit EDL stack: a modern .NET client for Qualcomm devices in EDL (Emergency Download Mode / 9008).
EdlDriver is the facade — a sealed partial class that wires together the protocol and transport layers and exposes a clean async API for everything from device detection to partition flashing.
Features
- Sahara — boot the firehose programmer, handshake, memory debug dump/read, mode switching.
- Firehose — configure, program (with digest table / VIP), erase, read, patch, wipe, UFS reset/provision, GPT read/fix.
- Transports — USB, Serial, HS-UART and HDLC framing behind
IEdlTransport. - Firmware bundles — flash multiple images from
rawprogram0.xml/patch0.xmlviaFlashBundleOrchestrator. - Events & progress — state transitions, log messages and progress callbacks.
- AOT-friendly, multi-targets
netstandard2.0,netstandard2.1,net8.0,net10.0.
Quick start
using FirmwareKit.Comm.EDL;
var driver = new EdlDriver();
driver.SetResponseTimeoutSeconds(10);
// Detect a device in EDL mode
var devices = EdlDriver.DetectDevices();
if (devices.Count == 0) return;
// Boot firehose programmer and configure the session
await using var programmer = File.OpenRead("prog_firehose_ddr.elf");
await driver.ConnectAsync();
await driver.SaharaHandshakeAsync(programmer);
await driver.ConfigureFirehoseAsync();
// Flash a partition
await using var image = File.OpenRead("boot.img");
await driver.FlashPartitionAsync("boot", image);
Key API
| Member | Purpose |
|---|---|
EdlDriver.DetectDevices() / WaitForEdlDeviceAsync |
Enumerate / wait for EDL devices over USB. |
ConnectAsync / Connect / Disconnect |
Open and close the transport session. |
SaharaHandshakeAsync / SaharaSwitchModeAsync |
Load programmer image, switch to Firehose mode. |
ConfigureFirehoseAsync |
Negotiate payload size and sector size with the target. |
FlashPartitionAsync / FlashRawImageAsync |
Program images to a partition or raw sector range. |
ReadPartitionAsync / ReadPartitionToFileAsync |
Read partition contents. |
ErasePartitionAsync / WipeAsync |
Erase a partition or wipe the partition head. |
PeekAsync / PokeAsync |
Read/write target memory over Firehose. |
SaharaDumpMemoryAsync / SaharaReadMemoryAsync |
Memory debug dump / read over Sahara. |
ReadGptTableAsync / GptFix |
Read / repair the GPT partition table. |
UfsProvisionAsync / UfsResetAsync |
Provision UFS LUNs / reset the UFS device. |
License
MIT — see the LICENSE at the repository root.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- FirmwareKit.Comm.EDL.Backend (>= 1.1.0)
- FirmwareKit.Comm.EDL.Core (>= 1.1.0)
- FirmwareKit.Comm.EDL.Firehose (>= 1.1.0)
- FirmwareKit.Comm.EDL.FirmwareBundle (>= 1.1.0)
- FirmwareKit.Comm.EDL.Hsuart (>= 1.1.0)
- FirmwareKit.Comm.EDL.Sahara (>= 1.1.0)
-
.NETStandard 2.1
- FirmwareKit.Comm.EDL.Backend (>= 1.1.0)
- FirmwareKit.Comm.EDL.Core (>= 1.1.0)
- FirmwareKit.Comm.EDL.Firehose (>= 1.1.0)
- FirmwareKit.Comm.EDL.FirmwareBundle (>= 1.1.0)
- FirmwareKit.Comm.EDL.Hsuart (>= 1.1.0)
- FirmwareKit.Comm.EDL.Sahara (>= 1.1.0)
-
net10.0
- FirmwareKit.Comm.EDL.Backend (>= 1.1.0)
- FirmwareKit.Comm.EDL.Core (>= 1.1.0)
- FirmwareKit.Comm.EDL.Firehose (>= 1.1.0)
- FirmwareKit.Comm.EDL.FirmwareBundle (>= 1.1.0)
- FirmwareKit.Comm.EDL.Hsuart (>= 1.1.0)
- FirmwareKit.Comm.EDL.Sahara (>= 1.1.0)
-
net8.0
- FirmwareKit.Comm.EDL.Backend (>= 1.1.0)
- FirmwareKit.Comm.EDL.Core (>= 1.1.0)
- FirmwareKit.Comm.EDL.Firehose (>= 1.1.0)
- FirmwareKit.Comm.EDL.FirmwareBundle (>= 1.1.0)
- FirmwareKit.Comm.EDL.Hsuart (>= 1.1.0)
- FirmwareKit.Comm.EDL.Sahara (>= 1.1.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.