Skip to content

Update "extract-firmware-nouveau" utilities #918

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update "extract-firmware-nouveau" utilities #918

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c386343
Update extract-firmware-nouveau python
lufog Aug 24, 2025
5082970
Update extract-firmware-nouveau rust
lufog Aug 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 19 additions & 17 deletions nouveau/extract-firmware-nouveau.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,19 +120,20 @@ def bootloader(gpu, fuse):
global version

GPU = gpu.upper()
FUSE = fuse.upper()
filename = f"src/nvidia/generated/g_bindata_kgspGetBinArchiveGspRmBoot_{GPU}.c"

print(f"Creating nvidia/{gpu}/gsp/bootloader-{version}.bin")
os.makedirs(f"{outputpath}/nvidia/{gpu}/gsp/", exist_ok = True)

with open(f"{outputpath}/nvidia/{gpu}/gsp/bootloader-{version}.bin", "wb") as f:
# Extract the actual bootloader firmware
array = f"kgspBinArchiveGspRmBoot_{GPU}_ucode_image{fuse}data"
array = f"kgspBinArchiveGspRmBoot_{GPU}_BINDATA_LABEL_UCODE_IMAGE{FUSE}data"
firmware = getbytes(filename, array)
firmware_size = len(firmware)

# Extract the descriptor (RM_RISCV_UCODE_DESC)
array = f"kgspBinArchiveGspRmBoot_{GPU}_ucode_desc{fuse}data"
array = f"kgspBinArchiveGspRmBoot_{GPU}_BINDATA_LABEL_UCODE_DESC{FUSE}data"
descriptor = getbytes(filename, array)
descriptor_size = len(descriptor)

Expand All @@ -154,6 +155,7 @@ def booter(gpu, load, sigsize, fuse = "prod"):

GPU = gpu.upper()
LOAD = load.capitalize()
FUSE = fuse.upper()

filename = f"src/nvidia/generated/g_bindata_kgspGetBinArchiveBooter{LOAD}Ucode_{GPU}.c"

Expand All @@ -162,12 +164,12 @@ def booter(gpu, load, sigsize, fuse = "prod"):

with open(f"{outputpath}/nvidia/{gpu}/gsp/booter_{load}-{version}.bin", "wb") as f:
# Extract the actual booter firmware
array = f"kgspBinArchiveBooter{LOAD}Ucode_{GPU}_image_{fuse}_data"
array = f"kgspBinArchiveBooter{LOAD}Ucode_{GPU}_BINDATA_LABEL_IMAGE_{FUSE}_data"
firmware = getbytes(filename, array)
firmware_size = len(firmware)

# Extract the signatures
array = f"kgspBinArchiveBooter{LOAD}Ucode_{GPU}_sig_{fuse}_data"
array = f"kgspBinArchiveBooter{LOAD}Ucode_{GPU}_BINDATA_LABEL_SIG_{FUSE}_data"
signatures = getbytes(filename, array)
signatures_size = len(signatures)
if signatures_size % sigsize:
Expand Down Expand Up @@ -195,20 +197,20 @@ def booter(gpu, load, sigsize, fuse = "prod"):
f.write(signatures)

# Extract the patch location
array = f"kgspBinArchiveBooter{LOAD}Ucode_{GPU}_patch_loc_data"
array = f"kgspBinArchiveBooter{LOAD}Ucode_{GPU}_BINDATA_LABEL_PATCH_LOC_data"
bytes = getbytes(filename, array)
patchloc = struct.unpack("<L", bytes)[0]

# Extract the patch meta variables
array = f"kgspBinArchiveBooter{LOAD}Ucode_{GPU}_patch_meta_data"
array = f"kgspBinArchiveBooter{LOAD}Ucode_{GPU}_BINDATA_LABEL_PATCH_META_data"
bytes = getbytes(filename, array)
fuse_ver, engine_id, ucode_id = struct.unpack("<LLL", bytes)

# Fourth, patch_loc[], patch_sig[], fuse_ver, engine_id, ucode_id, and num_sigs
f.write(struct.pack("<6L", patchloc, 0, fuse_ver, engine_id, ucode_id, num_sigs))

# Extract the descriptor (nvkm_gsp_booter_fw_hdr)
array = f"kgspBinArchiveBooter{LOAD}Ucode_{GPU}_header_{fuse}_data"
array = f"kgspBinArchiveBooter{LOAD}Ucode_{GPU}_BINDATA_LABEL_HEADER_{FUSE}_data"
descriptor = getbytes(filename, array)

# Fifth, the descriptor
Expand All @@ -225,20 +227,20 @@ def scrubber(gpu, sigsize, fuse = "prod"):
# Unfortunately, RM breaks convention with the scrubber image and labels
# the files and arrays with AD10X instead of AD102.
GPUX = f"{gpu[:-1].upper()}X"

FUSE = fuse.upper()
filename = f"src/nvidia/generated/g_bindata_ksec2GetBinArchiveSecurescrubUcode_{GPUX}.c"

print(f"Creating nvidia/{gpu}/gsp/scrubber-{version}.bin")
os.makedirs(f"{outputpath}/nvidia/{gpu}/gsp/", exist_ok = True)

with open(f"{outputpath}/nvidia/{gpu}/gsp/scrubber-{version}.bin", "wb") as f:
# Extract the actual scrubber firmware
array = f"ksec2BinArchiveSecurescrubUcode_{GPUX}_image_{fuse}_data[]"
array = f"ksec2BinArchiveSecurescrubUcode_{GPUX}_BINDATA_LABEL_IMAGE_{FUSE}_data[]"
firmware = getbytes(filename, array)
firmware_size = len(firmware)

# Extract the signatures
array = f"ksec2BinArchiveSecurescrubUcode_{GPUX}_sig_{fuse}_data"
array = f"ksec2BinArchiveSecurescrubUcode_{GPUX}_BINDATA_LABEL_SIG_{FUSE}_data"
signatures = getbytes(filename, array)
signatures_size = len(signatures)
if signatures_size % sigsize:
Expand Down Expand Up @@ -266,20 +268,20 @@ def scrubber(gpu, sigsize, fuse = "prod"):
f.write(signatures)

# Extract the patch location
array = f"ksec2BinArchiveSecurescrubUcode_{GPUX}_patch_loc_data"
array = f"ksec2BinArchiveSecurescrubUcode_{GPUX}_BINDATA_LABEL_PATCH_LOC_data"
bytes = getbytes(filename, array)
patchloc = struct.unpack("<L", bytes)[0]

# Extract the patch meta variables
array = f"ksec2BinArchiveSecurescrubUcode_{GPUX}_patch_meta_data"
array = f"ksec2BinArchiveSecurescrubUcode_{GPUX}_BINDATA_LABEL_PATCH_META_data"
bytes = getbytes(filename, array)
fuse_ver, engine_id, ucode_id = struct.unpack("<LLL", bytes)

# Fourth, patch_loc[], patch_sig[], fuse_ver, engine_id, ucode_id, and num_sigs
f.write(struct.pack("<6L", patchloc, 0, fuse_ver, engine_id, ucode_id, num_sigs))

# Extract the descriptor (nvkm_gsp_booter_fw_hdr)
array = f"ksec2BinArchiveSecurescrubUcode_{GPUX}_header_{fuse}_data"
array = f"ksec2BinArchiveSecurescrubUcode_{GPUX}_BINDATA_LABEL_HEADER_{FUSE}_data"
descriptor = getbytes(filename, array)

# Fifth, the descriptor
Expand Down Expand Up @@ -395,19 +397,19 @@ def fmc(gpu, fuse = "Prod"):
print(f"Creating nvidia/{gpu}/gsp/fmc-{version}.bin")
os.makedirs(f"{outputpath}/nvidia/{gpu}/gsp/", exist_ok = True)

array = f"kgspBinArchiveGspRmFmcGfw{fuse}Signed_{GPU}_ucode_hash_data"
array = f"kgspBinArchiveGspRmFmcGfw{fuse}Signed_{GPU}_BINDATA_LABEL_UCODE_HASH_data"
ucode_hash = getbytes(filename, array)
(ucode_hash_size, ucode_hash_padded_size) = sizes(ucode_hash)

array = f"kgspBinArchiveGspRmFmcGfw{fuse}Signed_{GPU}_ucode_sig_data"
array = f"kgspBinArchiveGspRmFmcGfw{fuse}Signed_{GPU}_BINDATA_LABEL_UCODE_SIG_data"
ucode_sig = getbytes(filename, array)
(ucode_sig_size, ucode_sig_padded_size) = sizes(ucode_sig)

array = f"kgspBinArchiveGspRmFmcGfw{fuse}Signed_{GPU}_ucode_pkey_data"
array = f"kgspBinArchiveGspRmFmcGfw{fuse}Signed_{GPU}_BINDATA_LABEL_UCODE_PKEY_data"
ucode_pkey = getbytes(filename, array)
(ucode_pkey_size, ucode_pkey_padded_size) = sizes(ucode_pkey)

array = f"kgspBinArchiveGspRmFmcGfw{fuse}Signed_{GPU}_ucode_image_data"
array = f"kgspBinArchiveGspRmFmcGfw{fuse}Signed_{GPU}_BINDATA_LABEL_UCODE_IMAGE_data"
ucode_image = getbytes(filename, array)
(ucode_image_size, ucode_image_padded_size) = sizes(ucode_image)

Expand Down
25 changes: 13 additions & 12 deletions nouveau/extract-firmware-nouveau/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,7 @@ fn round_up_to_base(x: u32, base: u32) -> u32 {

fn bootloader(output: &Path, version: &str, gpu: &str, prod: &str) -> Result<(), String> {
let gpu_upper = gpu.to_uppercase();
let prod_upper = prod.to_uppercase();
let filename = PathBuf::from(format!(
"src/nvidia/generated/g_bindata_kgspGetBinArchiveGspRmBoot_{gpu_upper}.c"
));
Expand All @@ -415,12 +416,12 @@ fn bootloader(output: &Path, version: &str, gpu: &str, prod: &str) -> Result<(),
.map_err(|err| format!("Could not create nvidia/{gpu}/gsp/: {err}"))?;

// Extract the actual bootloader firmware
let array = format!("kgspBinArchiveGspRmBoot_{gpu_upper}_ucode_image_{prod}data");
let array = format!("kgspBinArchiveGspRmBoot_{gpu_upper}_BINDATA_LABEL_UCODE_IMAGE_{prod_upper}data");
let firmware = get_bytes(&filename, &array, None)?;
let firmware_size: u32 = firmware.len() as u32;

// Extract the descriptor (RM_RISCV_UCODE_DESC)
let array = format!("kgspBinArchiveGspRmBoot_{gpu_upper}_ucode_desc_{prod}data");
let array = format!("kgspBinArchiveGspRmBoot_{gpu_upper}_BINDATA_LABEL_UCODE_DESC_{prod_upper}data");
let descriptor = get_bytes(&filename, &array, None)?;
let descriptor_size: u32 = descriptor.len() as u32;

Expand Down Expand Up @@ -486,12 +487,12 @@ fn booter(output: &Path, version: &str, gpu: &str, load: &str, sigsize: u32) ->
.map_err(|err| format!("Could not create nvidia/{gpu}/gsp/: {err}"))?;

// Extract the actual booter firmware
let array = format!("kgspBinArchiveBooter{load_upper}Ucode_{gpu_upper}_image_prod_data");
let array = format!("kgspBinArchiveBooter{load_upper}Ucode_{gpu_upper}_BINDATA_LABEL_IMAGE_PROD_data");
let firmware = get_bytes(&filename, &array, None)?;
let firmware_size = firmware.len() as u32;

// Extract the signatures
let array = format!("kgspBinArchiveBooter{load_upper}Ucode_{gpu_upper}_sig_prod_data");
let array = format!("kgspBinArchiveBooter{load_upper}Ucode_{gpu_upper}_BINDATA_LABEL_SIG_PROD_data");
let signatures = get_bytes(&filename, &array, None)?;
let signatures_size = signatures.len() as u32;
if (signatures_size % sigsize) != 0 {
Expand All @@ -503,12 +504,12 @@ fn booter(output: &Path, version: &str, gpu: &str, load: &str, sigsize: u32) ->
}

// Extract the patch location
let array = format!("kgspBinArchiveBooter{load_upper}Ucode_{gpu_upper}_patch_loc_data");
let array = format!("kgspBinArchiveBooter{load_upper}Ucode_{gpu_upper}_BINDATA_LABEL_PATCH_LOC_data");
let patch_loc_data = get_bytes(&filename, &array, Some(4))?;
let patch_loc = LittleEndian::read_u32(&patch_loc_data);

// Extract the patch meta variables
let array = format!("kgspBinArchiveBooter{load_upper}Ucode_{gpu_upper}_patch_meta_data");
let array = format!("kgspBinArchiveBooter{load_upper}Ucode_{gpu_upper}_BINDATA_LABEL_PATCH_META_data");
let patch_meta_data = get_bytes(&filename, &array, Some(12))?;

let (fuse_ver, engine_id, ucode_id) = patch_meta_data
Expand Down Expand Up @@ -569,7 +570,7 @@ fn booter(output: &Path, version: &str, gpu: &str, load: &str, sigsize: u32) ->
.map_err(|err| format!("Could not write to {}: {err}", filename.display()))?;

// Extract the descriptor (nvkm_gsp_booter_fw_hdr)
let array = format!("kgspBinArchiveBooter{load_upper}Ucode_{gpu_upper}_header_prod_data");
let array = format!("kgspBinArchiveBooter{load_upper}Ucode_{gpu_upper}_BINDATA_LABEL_HEADER_PROD_data");
let descriptor = get_bytes(&filename, &array, Some(36))?;

// Fifth, the descriptor
Expand Down Expand Up @@ -603,12 +604,12 @@ fn scrubber(output: &Path, version: &str, gpu: &str, sigsize: u32) -> Result<(),
.map_err(|err| format!("Could not create nvidia/{gpu}/gsp/: {err}"))?;

// Extract the actual scrubber firmware
let array = format!("ksec2BinArchiveSecurescrubUcode_{gpux}_image_prod_data");
let array = format!("ksec2BinArchiveSecurescrubUcode_{gpux}_BINDATA_LABEL_IMAGE_PROD_data");
let firmware = get_bytes(&filename, &array, None)?;
let firmware_size = firmware.len() as u32;

// Extract the signatures
let array = format!("ksec2BinArchiveSecurescrubUcode_{gpux}_sig_prod_data");
let array = format!("ksec2BinArchiveSecurescrubUcode_{gpux}_BINDATA_LABEL_SIG_PROD_data");
let signatures = get_bytes(&filename, &array, None)?;
let signatures_size = signatures.len() as u32;
if (signatures_size % sigsize) != 0 {
Expand All @@ -620,12 +621,12 @@ fn scrubber(output: &Path, version: &str, gpu: &str, sigsize: u32) -> Result<(),
}

// Extract the patch location
let array = format!("ksec2BinArchiveSecurescrubUcode_{gpux}_patch_loc_data");
let array = format!("ksec2BinArchiveSecurescrubUcode_{gpux}_BINDATA_LABEL_PATCH_LOC_data");
let patch_loc_data = get_bytes(&filename, &array, Some(4))?;
let patch_loc = LittleEndian::read_u32(&patch_loc_data);

// Extract the patch meta variables
let array = format!("ksec2BinArchiveSecurescrubUcode_{gpux}_patch_meta_data");
let array = format!("ksec2BinArchiveSecurescrubUcode_{gpux}_BINDATA_LABEL_PATCH_META_data");
let patch_meta_data = get_bytes(&filename, &array, Some(12))?;

let (fuse_ver, engine_id, ucode_id) = patch_meta_data
Expand Down Expand Up @@ -686,7 +687,7 @@ fn scrubber(output: &Path, version: &str, gpu: &str, sigsize: u32) -> Result<(),
.map_err(|err| format!("Could not write to {}: {err}", filename.display()))?;

// Extract the descriptor (nvkm_gsp_booter_fw_hdr)
let array = format!("ksec2BinArchiveSecurescrubUcode_{gpux}_header_prod_data");
let array = format!("ksec2BinArchiveSecurescrubUcode_{gpux}_BINDATA_LABEL_HEADER_PROD_data");
let descriptor = get_bytes(&filename, &array, Some(36))?;

// Fifth, the descriptor
Expand Down