Skip to content

Add wdm.h DDI docs for GetRuntimeAttestationReport structures - #1679

Open
John Kennedy (GrantMeStrength) wants to merge 1 commit into
stagingfrom
grantmestrength-docs-runtime-report-structures-wdm
Open

John Kennedy (GrantMeStrength) wants to merge 1 commit into
stagingfrom
grantmestrength-docs-runtime-report-structures-wdm

Conversation

@GrantMeStrength

Copy link
Copy Markdown
Collaborator

Summary

Adds driver-facing DDI reference documentation for the 11 data structures and enumeration used by GetRuntimeAttestationReport, as they appear in the wdm.h driver header. This is the kernel/driver companion to the Win32 PR that documents the same types under winnt.h; field prose matches the app-facing docs in substance, with only header/metadata differing.

All field descriptions are derived faithfully from the source header's inline comments — no invented behavior, values, sizes, or IRQL/usage notes.

New files (wdk-ddi-src/content/wdm/)

File Type
ne-wdm-runtime_report_type.md enum RUNTIME_REPORT_TYPE
ns-wdm-runtime_report_package_header.md RUNTIME_REPORT_PACKAGE_HEADER
ns-wdm-runtime_report_digest_header.md RUNTIME_REPORT_DIGEST_HEADER
ns-wdm-runtime_report_header.md RUNTIME_REPORT_HEADER
ns-wdm-driver_info_entry.md DRIVER_INFO_ENTRY
ns-wdm-driver_runtime_report.md DRIVER_RUNTIME_REPORT
ns-wdm-code_integrity_runtime_report.md CODE_INTEGRITY_RUNTIME_REPORT
ns-wdm-code_integrity_report_generation_header.md CODE_INTEGRITY_REPORT_GENERATION_HEADER
ns-wdm-code_integrity_report_record_header.md CODE_INTEGRITY_REPORT_RECORD_HEADER
ns-wdm-hotpatch_info_entry.md HOTPATCH_INFO_ENTRY
ns-wdm-hotpatch_runtime_report.md HOTPATCH_RUNTIME_REPORT

Notes / for reviewer confirmation

  • tech.root set to kernel (mirrors neighboring general kernel ns-wdm-* structs).
  • req.irql left blank (no IRQL info in header; these are data-structure definitions).
  • req.include-header set to Wdm.h (matches existing samples).
  • RuntimeReportTypeMax documented as a sentinel/count marker (no explicit value in header, = 3), not a real report type.
  • Bitfield Flags unions in DRIVER_INFO_ENTRY and DRIVER_RUNTIME_REPORT documented member-by-member (incl. AsUInt16). Variable-length trailing arrays and the per-driver dynamic buffer layout are explained in ## -remarks.
  • Cross-links added to related wdm structures, the Win32 winnt.h counterparts, and GetRuntimeAttestationReport.

Draft — do not merge.

Add driver-facing DDI reference documentation for the 11 data
structures and enumeration used by GetRuntimeAttestationReport as
they appear in the wdm.h driver header. This is the kernel/driver
companion to the Win32 winnt.h documentation.

New files (wdk-ddi-src/content/wdm/):
- ne-wdm-runtime_report_type.md
- ns-wdm-runtime_report_package_header.md
- ns-wdm-runtime_report_digest_header.md
- ns-wdm-runtime_report_header.md
- ns-wdm-driver_info_entry.md
- ns-wdm-driver_runtime_report.md
- ns-wdm-code_integrity_runtime_report.md
- ns-wdm-code_integrity_report_generation_header.md
- ns-wdm-code_integrity_report_record_header.md
- ns-wdm-hotpatch_info_entry.md
- ns-wdm-hotpatch_runtime_report.md

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: c71365b6-f808-47df-a842-93fd44b2da08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant