From 48249dad05b9f25d82f7b532bb92747d364a20d9 Mon Sep 17 00:00:00 2001 From: Russell McGuire Date: Thu, 30 Jul 2026 16:16:16 -0700 Subject: [PATCH 1/2] Fix spelling and grammer issues + add CI detection + Also remove node 20 deprecation for checkout@v4 GH actions Signed-off-by: Russell McGuire --- .codespellrc | 7 ++ .../bindings-sysman-python-checks.yml | 2 +- .../bindings-sysman-python-security-scan.yml | 2 +- ...ings-sysman-python-unit-tests-coverage.yml | 2 +- .github/workflows/build-clang.yml | 2 +- .github/workflows/build-msi-package.yml | 2 +- .github/workflows/build-multi-static.yml | 4 +- .github/workflows/build-multi.yml | 4 +- .github/workflows/build-quick-static-n-1.yml | 8 +- .github/workflows/build-quick-static.yml | 4 +- .github/workflows/build-quick.yml | 4 +- .github/workflows/check-abi.yml | 10 +-- .github/workflows/codespell-comment.yml | 84 +++++++++++++++++++ .github/workflows/codespell.yml | 55 ++++++++++++ .github/workflows/scorecard.yml | 2 +- .github/workflows/update-spec.yml | 8 +- CHANGELOG.md | 10 +-- README.md | 4 +- bindings/sysman/python/source/pyzes.py | 2 +- doc/loader_api.md | 4 +- include/layers/zel_tracing_api.h | 2 +- include/ze.py | 18 ++-- include/ze_api.h | 26 +++--- include/zes.py | 14 ++-- include/zes_api.h | 22 ++--- include/zet.py | 2 +- include/zet_api.h | 4 +- scripts/templates/helper.py | 6 +- scripts/templates/ldrddi.cpp.mako | 6 +- .../validation/handle_lifetime.cpp.mako | 2 +- scripts/templates/ze_loader_internal.h.mako | 4 +- source/drivers/null/zes_nullddi.cpp | 8 +- source/layers/validation/CONTRIBUTING.md | 2 +- source/layers/validation/README.md | 2 +- .../basic_leak/zel_basic_leak_checker.cpp | 2 +- .../events_checker/zel_events_checker.cpp | 6 +- .../zes_parameter_validation.cpp | 8 +- .../zes_handle_lifetime.cpp | 8 +- source/layers/validation/zes_valddi.cpp | 16 ++-- source/lib/ze_libapi.cpp | 8 +- source/lib/zes_libapi.cpp | 8 +- source/lib/zet_libapi.cpp | 2 +- source/loader/ze_ldrddi.cpp | 4 +- source/loader/ze_loader.cpp | 3 +- source/loader/ze_loader_internal.h | 4 +- source/loader/zes_ldrddi.cpp | 8 +- source/loader/zes_ldrddi.h | 8 +- source/loader/zes_ldrddi_driver_ddi.cpp | 8 +- test/CMakeLists.txt | 2 +- 49 files changed, 291 insertions(+), 142 deletions(-) create mode 100644 .codespellrc create mode 100644 .github/workflows/codespell-comment.yml create mode 100644 .github/workflows/codespell.yml diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 00000000..36dce665 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,7 @@ +# Configuration for codespell (https://github.com/codespell-project/codespell) +# Shared by the CI workflow and local runs: just run `codespell` from the repo root. +[codespell] +skip = ./.git,./build,./third_party,*.svg +# codespell only flags words from its curated misspelling dictionary, but it is not +# language-aware. Add identifiers/terms that collide with real words here (comma-separated). +ignore-words-list = te,pevents diff --git a/.github/workflows/bindings-sysman-python-checks.yml b/.github/workflows/bindings-sysman-python-checks.yml index f161b6ea..5f1980f0 100644 --- a/.github/workflows/bindings-sysman-python-checks.yml +++ b/.github/workflows/bindings-sysman-python-checks.yml @@ -37,7 +37,7 @@ jobs: steps: - name: Checkout code - uses: actions/checkout@v4 + uses: actions/checkout@v5 - name: Set up Python ${{ env.PYTHON_VERSION }} uses: actions/setup-python@v5 diff --git a/.github/workflows/bindings-sysman-python-security-scan.yml b/.github/workflows/bindings-sysman-python-security-scan.yml index 202216e5..ddcf752d 100644 --- a/.github/workflows/bindings-sysman-python-security-scan.yml +++ b/.github/workflows/bindings-sysman-python-security-scan.yml @@ -34,7 +34,7 @@ jobs: steps: - name: Checkout code - uses: actions/checkout@v4 + uses: actions/checkout@v5 - name: Set up Python uses: actions/setup-python@v5 diff --git a/.github/workflows/bindings-sysman-python-unit-tests-coverage.yml b/.github/workflows/bindings-sysman-python-unit-tests-coverage.yml index 22d07771..2db85abc 100644 --- a/.github/workflows/bindings-sysman-python-unit-tests-coverage.yml +++ b/.github/workflows/bindings-sysman-python-unit-tests-coverage.yml @@ -38,7 +38,7 @@ jobs: steps: - name: Checkout code - uses: actions/checkout@v4 + uses: actions/checkout@v5 with: fetch-depth: 0 # Full history for better coverage comparison diff --git a/.github/workflows/build-clang.yml b/.github/workflows/build-clang.yml index 03360f79..b86e78e1 100644 --- a/.github/workflows/build-clang.yml +++ b/.github/workflows/build-clang.yml @@ -27,7 +27,7 @@ jobs: run: | apt-get update apt-get install -y clang cmake make git - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 - name: Build Loader (${{ matrix.build_type }}) with Clang on ${{ matrix.container }} run: | mkdir build diff --git a/.github/workflows/build-msi-package.yml b/.github/workflows/build-msi-package.yml index 0060a276..d9895fbb 100644 --- a/.github/workflows/build-msi-package.yml +++ b/.github/workflows/build-msi-package.yml @@ -12,7 +12,7 @@ jobs: if: github.repository_owner == 'oneapi-src' runs-on: [windows-latest] steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 - name: Setup Windows build environment uses: ilammy/msvc-dev-cmd@v1 with: diff --git a/.github/workflows/build-multi-static.yml b/.github/workflows/build-multi-static.yml index 9dccedec..2e5f6fd1 100644 --- a/.github/workflows/build-multi-static.yml +++ b/.github/workflows/build-multi-static.yml @@ -19,7 +19,7 @@ jobs: short-sha: ${{ steps.const.outputs.short-sha }} ref-slug: ${{ steps.const.outputs.ref-slug }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 with: clean: true ref: ${{ github.event.pull_request.head.sha }} @@ -86,7 +86,7 @@ jobs: image-name=ghcr.io/${{ github.repository }}/${OS_STRING} ccache-dir=${CCACHE_DIR} EOF - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 with: clean: true fetch-depth: 0 diff --git a/.github/workflows/build-multi.yml b/.github/workflows/build-multi.yml index 5fb33b69..8395993f 100644 --- a/.github/workflows/build-multi.yml +++ b/.github/workflows/build-multi.yml @@ -19,7 +19,7 @@ jobs: short-sha: ${{ steps.const.outputs.short-sha }} ref-slug: ${{ steps.const.outputs.ref-slug }} steps: - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 with: clean: true ref: ${{ github.event.pull_request.head.sha }} @@ -104,7 +104,7 @@ jobs: image-name=ghcr.io/${{ github.repository }}/${OS_STRING} ccache-dir=${CCACHE_DIR} EOF - - uses: actions/checkout@v4 + - uses: actions/checkout@v5 with: clean: true fetch-depth: 0 diff --git a/.github/workflows/build-quick-static-n-1.yml b/.github/workflows/build-quick-static-n-1.yml index 63637e20..3183ea1c 100644 --- a/.github/workflows/build-quick-static-n-1.yml +++ b/.github/workflows/build-quick-static-n-1.yml @@ -14,7 +14,7 @@ jobs: runs-on: ubuntu-latest steps: # Use ccache-action for ccache setup and caching - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 with: fetch-depth: 0 path: pr @@ -22,7 +22,7 @@ jobs: # Checkout master branch for static loader source - name: Checkout master branch for static loader - uses: actions/checkout@v3 + uses: actions/checkout@v5 with: ref: master fetch-depth: 0 @@ -73,14 +73,14 @@ jobs: runs-on: windows-latest steps: # Checkout PR branch (dynamic loader source) - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 with: fetch-depth: 0 path: pr # Checkout master branch for static loader source - name: Checkout master branch for static loader - uses: actions/checkout@v3 + uses: actions/checkout@v5 with: ref: master fetch-depth: 0 diff --git a/.github/workflows/build-quick-static.yml b/.github/workflows/build-quick-static.yml index 0673c2b0..ff0434da 100644 --- a/.github/workflows/build-quick-static.yml +++ b/.github/workflows/build-quick-static.yml @@ -12,7 +12,7 @@ jobs: if: github.repository_owner == 'oneapi-src' runs-on: [ubuntu-latest] steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 - uses: hendrikmuhs/ccache-action@v1 - name: Build Static Loader on Latest Ubuntu run: | @@ -48,7 +48,7 @@ jobs: if: github.repository_owner == 'oneapi-src' runs-on: [windows-latest] steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 - name: Setup Windows build environment uses: ilammy/msvc-dev-cmd@v1 with: diff --git a/.github/workflows/build-quick.yml b/.github/workflows/build-quick.yml index f3f9b241..912e0bd4 100644 --- a/.github/workflows/build-quick.yml +++ b/.github/workflows/build-quick.yml @@ -31,7 +31,7 @@ jobs: apt-get update apt-get install -y build-essential cmake git fi - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 - name: Build Loader on ${{ matrix.container }} run: | mkdir build @@ -71,7 +71,7 @@ jobs: if: github.repository_owner == 'oneapi-src' runs-on: [windows-latest] steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 - name: Setup Windows build environment uses: ilammy/msvc-dev-cmd@v1 with: diff --git a/.github/workflows/check-abi.yml b/.github/workflows/check-abi.yml index eada6188..cd96b741 100644 --- a/.github/workflows/check-abi.yml +++ b/.github/workflows/check-abi.yml @@ -16,7 +16,7 @@ jobs: run: | sudo apt update sudo apt install -y elfutils universal-ctags vtable-dumper - - uses: actions/checkout@v2 + - uses: actions/checkout@v5 with: fetch-depth: 0 # Required due to the way Git works, without it this action won't be able to find any or the correct tags - uses: actions-ecosystem/action-get-latest-tag@v1 @@ -24,13 +24,13 @@ jobs: with: semver_only: true - name: Checkout base - uses: actions/checkout@v3 + uses: actions/checkout@v5 with: ref: ${{ steps.get-latest-tag.outputs.tag }} clean: true path: base - name: Checkout head - uses: actions/checkout@v3 + uses: actions/checkout@v5 with: clean: true path: head @@ -92,13 +92,13 @@ jobs: sudo apt update sudo apt install -y elfutils universal-ctags vtable-dumper - name: Checkout base - uses: actions/checkout@v3 + uses: actions/checkout@v5 with: ref: ${{ github.base_ref }} clean: true path: base - name: Checkout head - uses: actions/checkout@v3 + uses: actions/checkout@v5 with: clean: true path: head diff --git a/.github/workflows/codespell-comment.yml b/.github/workflows/codespell-comment.yml new file mode 100644 index 00000000..377fa754 --- /dev/null +++ b/.github/workflows/codespell-comment.yml @@ -0,0 +1,84 @@ +name: Codespell Comment + +# Posts the codespell report produced by the "Codespell" workflow back onto the +# pull request. Because it is triggered by workflow_run it runs in the base +# repository context with a writable token, so it can comment on fork PRs +# without ever checking out or executing untrusted PR code. +# +# A comment is only created when spelling issues are found; an existing report +# comment is updated in place (and flipped to "resolved" once issues are fixed). +# +# NOTE: workflow_run only triggers from workflow files on the default branch, so +# this begins working once merged to master. + +on: + workflow_run: + workflows: [Codespell] + types: [completed] + +permissions: + contents: read + pull-requests: write + +jobs: + comment: + runs-on: ubuntu-latest + if: github.event.workflow_run.event == 'pull_request' + steps: + - name: Download report + uses: actions/download-artifact@v4 + continue-on-error: true + with: + name: codespell-report + run-id: ${{ github.event.workflow_run.id }} + github-token: ${{ secrets.GITHUB_TOKEN }} + - name: Post or update PR comment + uses: actions/github-script@v7 + with: + script: | + const fs = require('fs'); + const marker = ''; + const { owner, repo } = context.repo; + + if (!fs.existsSync('pr_number.txt')) { + core.info('No report artifact found; nothing to comment on.'); + return; + } + const issue_number = parseInt(fs.readFileSync('pr_number.txt', 'utf8').trim(), 10); + if (!Number.isInteger(issue_number)) { + core.info('Invalid PR number; skipping.'); + return; + } + + const findings = fs.existsSync('codespell.txt') + ? fs.readFileSync('codespell.txt', 'utf8').trim() + : ''; + + const comments = await github.paginate(github.rest.issues.listComments, { + owner, repo, issue_number, per_page: 100, + }); + const existing = comments.find(c => c.body && c.body.includes(marker)); + + let body; + if (!findings) { + if (!existing) return; // nothing to report and nothing to update + body = `${marker}\n:white_check_mark: **codespell** found no spelling issues.`; + } else { + body = [ + marker, + '### :abc: codespell found possible spelling issues', + '', + '```', + findings, + '```', + '', + 'If any are false positives (for example a variable name or acronym), ' + + 'add them to `ignore-words-list` in `.codespellrc`.', + ].join('\n'); + } + + if (existing) { + await github.rest.issues.updateComment({ owner, repo, comment_id: existing.id, body }); + } else { + await github.rest.issues.createComment({ owner, repo, issue_number, body }); + } diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 00000000..16d6ab09 --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,55 @@ +name: Codespell + +# Spell-checks pull requests with codespell. This job runs in the (untrusted) +# pull_request context, so it only produces results that need no write access: +# * inline warning annotations on the changed files, and +# * a failed check so the problem is not easy to miss. +# The PR comment is posted by the companion "Codespell Comment" workflow, which +# runs from the base repo via workflow_run and therefore has a writable token +# even for fork PRs. Configuration (skip/ignore lists) lives in .codespellrc. + +on: + pull_request: + branches: [master] + +permissions: + contents: read + +jobs: + codespell: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v5 + - uses: actions/setup-python@v5 + with: + python-version: '3.x' + - name: Install codespell + run: pip install codespell==2.4.3 + - name: Run codespell + run: | + codespell > codespell.txt 2>&1 || true + cat codespell.txt + # Emit an inline warning annotation for each finding. + awk -F: 'NF>=3 { + f=$1; sub(/^\.\//,"",f); + l=$2; + msg=$0; sub(/^[^:]*:[^:]*: /,"",msg); + printf "::warning file=%s,line=%s::codespell: %s\n", f, l, msg + }' codespell.txt + - name: Save PR number + run: echo "${{ github.event.number }}" > pr_number.txt + - name: Upload report + # Consumed by the "Codespell Comment" workflow to post the PR comment. + uses: actions/upload-artifact@v4 + with: + name: codespell-report + path: | + codespell.txt + pr_number.txt + retention-days: 1 + - name: Fail if spelling issues were found + run: | + if [ -s codespell.txt ]; then + echo "codespell found spelling issues; see the annotations above and the PR comment." + exit 1 + fi diff --git a/.github/workflows/scorecard.yml b/.github/workflows/scorecard.yml index 21dbf0cf..e88e0f8d 100644 --- a/.github/workflows/scorecard.yml +++ b/.github/workflows/scorecard.yml @@ -24,7 +24,7 @@ jobs: id-token: write steps: - name: "Checkout code" - uses: actions/checkout@v4 + uses: actions/checkout@v5 with: persist-credentials: false - name: "Run analysis" diff --git a/.github/workflows/update-spec.yml b/.github/workflows/update-spec.yml index 3d27c597..6e057c93 100644 --- a/.github/workflows/update-spec.yml +++ b/.github/workflows/update-spec.yml @@ -34,12 +34,14 @@ jobs: python-version: '3.x' - name: Install dependencies run: pip install Mako==1.1.0 PyYAML==5.2 - - uses: actions/checkout@v3 + - uses: actions/checkout@v5 with: clean: true fetch-depth: 0 fetch-tags: true - token: ${{ secrets.TOKEN }} + # Fall back to the default token when the push secret is unavailable + # (e.g. pull_request runs), otherwise checkout@v5 rejects an empty token. + token: ${{ secrets.TOKEN || github.token }} - name: Checkout develop branch or create local version if: ${{ github.event_name == 'workflow_dispatch' }} run: git checkout ${{ inputs.branch }} || git checkout -b ${{ inputs.branch }} @@ -47,7 +49,7 @@ jobs: if: ${{ github.event_name == 'workflow_dispatch' }} run: git reset --hard origin/master - name: Checkout spec repository - uses: actions/checkout@v4 + uses: actions/checkout@v5 with: repository: ${{ github.event_name == 'pull_request' && 'oneapi-src/level-zero-spec' || inputs.repository }} clean: true diff --git a/CHANGELOG.md b/CHANGELOG.md index 2ca4dcd1..c42d164c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,12 +8,12 @@ * Fix: .mako drift from actual headers * Fix: Static Analysis Fixes * Feature: Enable System Resource Tracker on Windows -* Removed unnused size_t for to_string in 32b compiles +* Removed unused size_t for to_string in 32b compiles * Use PROJECT_*_DIR instead of CMAKE_*_DIR to support subproject builds ## v1.30.0 * Remove SPDLog from project entirely * Add New custom C++ smaller Logger, to replace SPDLog -* Add future Enhancements to new Logger with available with expiremental =2 settings +* Add future Enhancements to new Logger with available with experimental =2 settings * Fix: Bug where zeInitDrivers was not enabling lifehandle trackers in validation layer ## v1.29.0 * Update to L0 Zero Spec v1.16.24: https://oneapi-src.github.io/level-zero-spec/releases/index.html#level-zero-v1-16-24 @@ -21,7 +21,7 @@ * Add to_string support support for callbacks (#463) ## v1.28.6 * Remove level-zero* (non-Canonical) package names when building DEBs with CPack -* Allow pkgconfig file isntallation with Window MSI Installer +* Allow pkgconfig file installation with Window MSI Installer ## v1.28.5 * Add Canonical Specific packages in CPack (libze1*) * Add CONFLICTS, PROVIDES, REPLACES directives in packages @@ -90,7 +90,7 @@ * fix: Avoid invalid casting into loader objects when DDI extension is supported * Fix potential SIOF issue with checker layers ## v1.23.1 -* Fix Sysman only DDI Init for zesDriver compatability +* Fix Sysman only DDI Init for zesDriver compatibility ## v1.23.0 * fix build for certification checker * Fix missing code gen and add check in sysman device get for context @@ -384,7 +384,7 @@ * Fixed default symbol visibility in Linux builds * Added zeInit call earlier in loader init path to prevent loading drivers that don't match the ze_init_flags_t * Fixed build for certain SLES distros -* Fixed bug that prevented tracers from being reenabled after being disabled. +* Fixed bug that prevented tracers from being re-enabled after being disabled. * Multi Driver Support: Return success if initialization of at least one driver succeeds. * Updated L0 API headers to 1.2.43 which includes: * Clarification to documentation of several APIs diff --git a/README.md b/README.md index 1d98f871..448ff199 100644 --- a/README.md +++ b/README.md @@ -37,11 +37,11 @@ To build the Loader statically one must set `-DBUILD_STATIC=1` during the cmake The build of the static loader creates a ze_loader.a/.lib which will link the source/lib source code into your application or library. -This enables for inclusion of all L0 symbols into your application/library allowing for backwards compatability with older versions of the Loader. +This enables for inclusion of all L0 symbols into your application/library allowing for backwards compatibility with older versions of the Loader. The static loader "shim" dynamically loads the ze_loader.so/.dll on the system enabling plugin like behavior where the init will fail gracefully given a usable loader or L0 driver is not found. -When the `-DBUILD_STATIC=1` is executed, the dynamic loader and layers are not built to avoid conflicts during local test execution which requires the dynamic loader and layers to all be the same version for compatability. +When the `-DBUILD_STATIC=1` is executed, the dynamic loader and layers are not built to avoid conflicts during local test execution which requires the dynamic loader and layers to all be the same version for compatibility. Testing with the static loader requires a build of the dynamic loader or an installation of the dynamic loader to exist in the library path. diff --git a/bindings/sysman/python/source/pyzes.py b/bindings/sysman/python/source/pyzes.py index 5ba6bfaf..25ab2e3d 100644 --- a/bindings/sysman/python/source/pyzes.py +++ b/bindings/sysman/python/source/pyzes.py @@ -33,7 +33,7 @@ class _PrintableStructure(Structure): e.g. class that has _field_ 'hex_value', c_uint could be formatted with _fmt_ = {"hex_value" : "%08X"} to produce nicer output. - Default fomratting string for all fields can be set with key "" like: + Default formatting string for all fields can be set with key "" like: _fmt_ = {"" : "%d MHz"} # e.g all values are numbers in MHz. If not set it's assumed to be just "%s" diff --git a/doc/loader_api.md b/doc/loader_api.md index 2d55d0ea..6f265e07 100644 --- a/doc/loader_api.md +++ b/doc/loader_api.md @@ -30,7 +30,7 @@ The returned `zel_component_version_t` structure contains: ### zelLoaderGetVersions -This API is used to retreive the version information of the loader itself and of any layers that are enabled. +This API is used to retrieve the version information of the loader itself and of any layers that are enabled. - __*num_elems__ Is a pointer to the number of version components to get. - __*versions__ Pointer to address to write version components to. If set to `nullptr`, `num_elems` will be set to the total number of version components available. @@ -45,7 +45,7 @@ There are currently 3 versioned components assigned the following name strings: When a system has multiple L0 drivers, raw handles returned from the L0 drivers are modified by the loader before being returned to the application. This allows the loader to determine which handles belong to which driver and forward API calls appropriately. In most cases the loader will perform this handle translation completely transparently to the application and no manual translation is ever needed. -In some rare cases when the application needs to occasionally bypass the loader, handle conflicts can arise. One such case is when an application wants to call a driver extension function whose address has been retreived with `zeDriverGetExtensionFunctionAddress` +In some rare cases when the application needs to occasionally bypass the loader, handle conflicts can arise. One such case is when an application wants to call a driver extension function whose address has been retrieved with `zeDriverGetExtensionFunctionAddress` To solve this issue, `zelLoaderTranslateHandle` is used to retrieve the raw driver handle associated with a loader handle. diff --git a/include/layers/zel_tracing_api.h b/include/layers/zel_tracing_api.h index 754d654f..24395c7f 100644 --- a/include/layers/zel_tracing_api.h +++ b/include/layers/zel_tracing_api.h @@ -54,7 +54,7 @@ typedef enum _zel_structure_type_t { ZEL_STRUCTURE_TYPE_TRACER_DESC = 0x1 ,///< ::zel_tracer_desc_t // This enumeration value is deprecated. - // Pluse use ZEL_STRUCTURE_TYPE_TRACER_DESC. + // Please use ZEL_STRUCTURE_TYPE_TRACER_DESC. ZEL_STRUCTURE_TYPE_TRACER_EXP_DESC = 0x1 ,///< ::zel_tracer_desc_t ZEL_STRUCTURE_TYPE_FORCE_UINT32 = 0x7fffffff diff --git a/include/ze.py b/include/ze.py index a1ceb12f..9515f384 100644 --- a/include/ze.py +++ b/include/ze.py @@ -939,8 +939,8 @@ class ze_device_module_properties_t(Structure): ############################################################################### ## @brief Supported command queue group property flags class ze_command_queue_group_property_flags_v(IntEnum): - COMPUTE = ZE_BIT(0) ## Command queue group supports enqueing compute commands. - COPY = ZE_BIT(1) ## Command queue group supports enqueing copy commands. + COMPUTE = ZE_BIT(0) ## Command queue group supports enqueuing compute commands. + COPY = ZE_BIT(1) ## Command queue group supports enqueuing copy commands. COOPERATIVE_KERNELS = ZE_BIT(2) ## Command queue group supports cooperative kernels. ## See ::zeCommandListAppendLaunchCooperativeKernel for more details. METRICS = ZE_BIT(3) ## Command queue groups supports metric queries. @@ -2852,7 +2852,7 @@ def __str__(self): ############################################################################### ## @brief Supported device types class ze_power_saving_hint_type_v(IntEnum): - MIN = 0 ## Minumum power savings. The device will make no attempt to save power + MIN = 0 ## Minimum power savings. The device will make no attempt to save power ## while executing work submitted to this context. MAX = 100 ## Maximum power savings. The device will do everything to bring power to ## a minimum while executing work submitted to this context. @@ -3387,7 +3387,7 @@ class ze_fabric_edge_exp_properties_t(Structure): ## structure (i.e. contains stype and pNext). ("uuid", ze_uuid_t), ## [out] universal unique identifier. ("model", c_char * ZE_MAX_FABRIC_EDGE_MODEL_EXP_SIZE), ## [out] Description of fabric edge technology. Will be set to the string - ## "unkown" if this cannot be determined for this edge + ## "unknown" if this cannot be determined for this edge ("bandwidth", c_ulong), ## [out] design bandwidth ("bandwidthUnit", ze_bandwidth_unit_t), ## [out] bandwidth unit ("latency", c_ulong), ## [out] design latency @@ -4360,7 +4360,7 @@ class ze_pitched_alloc_2dimage_linear_pitch_exp_info_t(Structure): ("stype", ze_structure_type_t), ## [in] type of this structure ("pNext", c_void_p), ## [in,out][optional] must be null or a pointer to an extension-specific ## structure (i.e. contains stype and pNext). - ("pitchAlign", c_size_t), ## [out] Required pitch Aligment in Bytes. + ("pitchAlign", c_size_t), ## [out] Required pitch Alignment in Bytes. ("maxSupportedPitch", c_size_t) ## [out] Maximum allowed pitch in Bytes. ] @@ -4377,8 +4377,8 @@ class ze_custom_pitch_exp_desc_t(Structure): ## allocations. This pitch should satisfy the pitchAlign requirement in ## ::ze_pitched_alloc_2dimage_linear_pitch_exp_info_t ("slicePitch", c_size_t) ## [in] user programmed slice pitch , must be multiple of rowPitch. For - ## 2D image arrary or a slice of a 3D image array - this pitch should be - ## >= rowPitch * image_height . For 1D iamge array >= rowPitch. + ## 2D image array or a slice of a 3D image array - this pitch should be + ## >= rowPitch * image_height . For 1D image array >= rowPitch. ] ############################################################################### @@ -4455,7 +4455,7 @@ class ze_mutable_command_id_exp_desc_t(Structure): ## - must be 0 (default, equivalent to setting all flags bar kernel ## instruction), or a valid combination of ::ze_mutable_command_exp_flag_t ## - in order to include kernel instruction mutation, - ## ::ZE_MUTABLE_COMMAND_EXP_FLAG_KERNEL_INSTRUCTION must be explictly included + ## ::ZE_MUTABLE_COMMAND_EXP_FLAG_KERNEL_INSTRUCTION must be explicitly included ] ############################################################################### @@ -5487,7 +5487,7 @@ class ze_device_usablemem_size_ext_properties_t(Structure): ("currUsableMemSize", c_ulonglong) ## [out] Returns the available usable memory at the device level. This is ## typically less than or equal to the available physical memory on the ## device. It important to note that usable memory size reported is - ## transient in nature and cannot be used to reliably guarentee success + ## transient in nature and cannot be used to reliably guarantee success ## of future allocations. The usable memory includes all the memory that ## the clients can allocate for their use and by L0 Core for its internal ## allocations. diff --git a/include/ze_api.h b/include/ze_api.h index 680a0b93..d4660fc6 100644 --- a/include/ze_api.h +++ b/include/ze_api.h @@ -2341,8 +2341,8 @@ zeDeviceGetModuleProperties( typedef uint32_t ze_command_queue_group_property_flags_t; typedef enum _ze_command_queue_group_property_flag_t { - ZE_COMMAND_QUEUE_GROUP_PROPERTY_FLAG_COMPUTE = ZE_BIT(0), ///< Command queue group supports enqueing compute commands. - ZE_COMMAND_QUEUE_GROUP_PROPERTY_FLAG_COPY = ZE_BIT(1), ///< Command queue group supports enqueing copy commands. + ZE_COMMAND_QUEUE_GROUP_PROPERTY_FLAG_COMPUTE = ZE_BIT(0), ///< Command queue group supports enqueuing compute commands. + ZE_COMMAND_QUEUE_GROUP_PROPERTY_FLAG_COPY = ZE_BIT(1), ///< Command queue group supports enqueuing copy commands. ZE_COMMAND_QUEUE_GROUP_PROPERTY_FLAG_COOPERATIVE_KERNELS = ZE_BIT(2), ///< Command queue group supports cooperative kernels. ///< See ::zeCommandListAppendLaunchCooperativeKernel for more details. ZE_COMMAND_QUEUE_GROUP_PROPERTY_FLAG_METRICS = ZE_BIT(3), ///< Command queue groups supports metric queries. @@ -9436,7 +9436,7 @@ zeCommandListAppendLaunchKernelIndirect( /// the Host or device up until execution. /// - This may **only** be called for a command list created with command /// queue group ordinal that supports compute. -/// - The application must enusre the command list, kernel and events were +/// - The application must ensure the command list, kernel and events were /// created, and the memory was allocated, on the same context. /// - This function may **not** be called from simultaneous threads with the /// same command list handle. @@ -11230,7 +11230,7 @@ typedef enum _ze_power_saving_hint_exp_version_t /// @brief Supported device types typedef enum _ze_power_saving_hint_type_t { - ZE_POWER_SAVING_HINT_TYPE_MIN = 0, ///< Minumum power savings. The device will make no attempt to save power + ZE_POWER_SAVING_HINT_TYPE_MIN = 0, ///< Minimum power savings. The device will make no attempt to save power ///< while executing work submitted to this context. ZE_POWER_SAVING_HINT_TYPE_MAX = 100, ///< Maximum power savings. The device will do everything to bring power to ///< a minimum while executing work submitted to this context. @@ -11911,7 +11911,7 @@ typedef struct _ze_memory_free_ext_desc_t /// /// @details /// - Similar to zeMemFree, with added parameter to choose the free policy. -/// - Does not gaurantee memory is freed upon return. See free policy +/// - Does not guarantee memory is freed upon return. See free policy /// descriptions for details. /// - The application must **not** call this function from simultaneous /// threads with the same pointer. @@ -12172,7 +12172,7 @@ typedef struct _ze_fabric_edge_exp_properties_t ///< structure (i.e. contains stype and pNext). ze_uuid_t uuid; ///< [out] universal unique identifier. char model[ZE_MAX_FABRIC_EDGE_MODEL_EXP_SIZE]; ///< [out] Description of fabric edge technology. Will be set to the string - ///< "unkown" if this cannot be determined for this edge + ///< "unknown" if this cannot be determined for this edge uint32_t bandwidth; ///< [out] design bandwidth ze_bandwidth_unit_t bandwidthUnit; ///< [out] bandwidth unit uint32_t latency; ///< [out] design latency @@ -13970,7 +13970,7 @@ typedef struct _ze_pitched_alloc_2dimage_linear_pitch_exp_info_t ze_structure_type_t stype; ///< [in] type of this structure void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific ///< structure (i.e. contains stype and pNext). - size_t pitchAlign; ///< [out] Required pitch Aligment in Bytes. + size_t pitchAlign; ///< [out] Required pitch Alignment in Bytes. size_t maxSupportedPitch; ///< [out] Maximum allowed pitch in Bytes. } ze_pitched_alloc_2dimage_linear_pitch_exp_info_t; @@ -14062,8 +14062,8 @@ typedef struct _ze_custom_pitch_exp_desc_t ///< allocations. This pitch should satisfy the pitchAlign requirement in ///< ::ze_pitched_alloc_2dimage_linear_pitch_exp_info_t size_t slicePitch; ///< [in] user programmed slice pitch , must be multiple of rowPitch. For - ///< 2D image arrary or a slice of a 3D image array - this pitch should be - ///< >= rowPitch * image_height . For 1D iamge array >= rowPitch. + ///< 2D image array or a slice of a 3D image array - this pitch should be + ///< >= rowPitch * image_height . For 1D image array >= rowPitch. } ze_custom_pitch_exp_desc_t; @@ -14305,7 +14305,7 @@ typedef struct _ze_mutable_command_id_exp_desc_t ///< - must be 0 (default, equivalent to setting all flags bar kernel ///< instruction), or a valid combination of ::ze_mutable_command_exp_flag_t ///< - in order to include kernel instruction mutation, - ///< ::ZE_MUTABLE_COMMAND_EXP_FLAG_KERNEL_INSTRUCTION must be explictly included + ///< ::ZE_MUTABLE_COMMAND_EXP_FLAG_KERNEL_INSTRUCTION must be explicitly included } ze_mutable_command_id_exp_desc_t; @@ -15875,9 +15875,9 @@ zeDriverRTASFormatCompatibilityCheckExt( /// - All provided data buffers must be host-accessible. The referenced /// scene data (index- and vertex- buffers) have to be accessible from the /// host, and will **not** be referenced by the build acceleration structure. -/// - The acceleration structure buffer is typicall a host allocation that +/// - The acceleration structure buffer is typically a host allocation that /// is later manually copied to a device allocation. Alternatively one can -/// also use a shared USM allocation as acceration structure buffer and +/// also use a shared USM allocation as acceleration structure buffer and /// skip the copy. /// - A successfully constructed acceleration structure is entirely /// self-contained. There is no requirement for input data to persist @@ -16456,7 +16456,7 @@ typedef struct _ze_device_usablemem_size_ext_properties_t uint64_t currUsableMemSize; ///< [out] Returns the available usable memory at the device level. This is ///< typically less than or equal to the available physical memory on the ///< device. It important to note that usable memory size reported is - ///< transient in nature and cannot be used to reliably guarentee success + ///< transient in nature and cannot be used to reliably guarantee success ///< of future allocations. The usable memory includes all the memory that ///< the clients can allocate for their use and by L0 Core for its internal ///< allocations. diff --git a/include/zes.py b/include/zes.py index 11a13da9..a0c68c3a 100644 --- a/include/zes.py +++ b/include/zes.py @@ -694,7 +694,7 @@ def __str__(self): ############################################################################### -## @brief Overclock V-F curve programing. +## @brief Overclock V-F curve programming. class zes_vf_program_type_v(IntEnum): VF_ARBITRARY = 0 ## Can program an arbitrary number of V-F points up to the maximum number ## and each point can have arbitrary voltage and frequency values within @@ -736,7 +736,7 @@ def __str__(self): ## @brief Overclock properties ## ## @details -## - Information on the overclock domain type and all the contols that are +## - Information on the overclock domain type and all the controls that are ## part of the domain. class zes_overclock_properties_t(Structure): _fields_ = [ @@ -1070,7 +1070,7 @@ def __str__(self): ## @brief Unique identifier for a fabric port ## ## @details -## - This not a universal identifier. The identified is garanteed to be +## - This not a universal identifier. The identified is guaranteed to be ## unique for the current hardware configuration of the system. Changes ## in the hardware may result in a different identifier for a given port. ## - The main purpose of this identifier to build up an instantaneous @@ -1104,7 +1104,7 @@ class zes_fabric_port_properties_t(Structure): ("pNext", c_void_p), ## [in,out][optional] must be null or a pointer to an extension-specific ## structure (i.e. contains stype and pNext). ("model", c_char * ZES_MAX_FABRIC_PORT_MODEL_SIZE), ## [out] Description of port technology. Will be set to the string - ## "unkown" if this cannot be determined for this port. + ## "unknown" if this cannot be determined for this port. ("onSubdevice", ze_bool_t), ## [out] True if the port is located on a sub-device; false means that ## the port is on the device of the calling Sysman handle ("subdeviceId", c_ulong), ## [out] If onSubdevice is true, this gives the ID of the sub-device @@ -1120,7 +1120,7 @@ class zes_fabric_port_properties_t(Structure): class zes_fabric_link_type_t(Structure): _fields_ = [ ("desc", c_char * ZES_MAX_FABRIC_LINK_TYPE_SIZE) ## [out] Description of link technology. Will be set to the string - ## "unkown" if this cannot be determined for this link. + ## "unknown" if this cannot be determined for this link. ] ############################################################################### @@ -1624,7 +1624,7 @@ class zes_mem_properties_t(Structure): ## @brief Memory state - health, allocated ## ## @details -## - Percent free is given by 100 * free / pysical mem size. +## - Percent free is given by 100 * free / physical mem size. class zes_mem_state_t(Structure): _fields_ = [ ("stype", zes_structure_type_t), ## [in] type of this structure @@ -1637,7 +1637,7 @@ class zes_mem_state_t(Structure): ## This member can no longer track the allocatable memory reliably. ## Clients depending on this information can use the ## zeDeviceGetProperties with ze_device_usablemem_size_ext_properties_t - ## extention to get information of the available usable memory. + ## extension to get information of the available usable memory. ] ############################################################################### diff --git a/include/zes_api.h b/include/zes_api.h index 00103a27..822e4d73 100644 --- a/include/zes_api.h +++ b/include/zes_api.h @@ -1633,7 +1633,7 @@ typedef enum _zes_pending_action_t } zes_pending_action_t; /////////////////////////////////////////////////////////////////////////////// -/// @brief Overclock V-F curve programing. +/// @brief Overclock V-F curve programming. typedef enum _zes_vf_program_type_t { ZES_VF_PROGRAM_TYPE_VF_ARBITRARY = 0, ///< Can program an arbitrary number of V-F points up to the maximum number @@ -1672,7 +1672,7 @@ typedef enum _zes_vf_array_type_t /// @brief Overclock properties /// /// @details -/// - Information on the overclock domain type and all the contols that are +/// - Information on the overclock domain type and all the controls that are /// part of the domain. typedef struct _zes_overclock_properties_t { @@ -2233,7 +2233,7 @@ zesOverclockGetControlState( ZE_APIEXPORT ze_result_t ZE_APICALL zesOverclockGetVFPointValues( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. zes_vf_array_type_t VFArrayType, ///< [in] User,Default or Live VF array to read from uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t* PointValue ///< [out] Returns the frequency in 1kHz units or voltage in millivolt @@ -2270,7 +2270,7 @@ zesOverclockGetVFPointValues( ZE_APIEXPORT ze_result_t ZE_APICALL zesOverclockSetVFPointValues( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t PointValue ///< [in] Writes frequency in 1kHz units or voltage in millivolt units to ///< custom V-F curve at the specified zero-based index @@ -3130,7 +3130,7 @@ typedef enum _zes_fabric_port_failure_flag_t /// @brief Unique identifier for a fabric port /// /// @details -/// - This not a universal identifier. The identified is garanteed to be +/// - This not a universal identifier. The identified is guaranteed to be /// unique for the current hardware configuration of the system. Changes /// in the hardware may result in a different identifier for a given port. /// - The main purpose of this identifier to build up an instantaneous @@ -3166,7 +3166,7 @@ typedef struct _zes_fabric_port_properties_t void* pNext; ///< [in,out][optional] must be null or a pointer to an extension-specific ///< structure (i.e. contains stype and pNext). char model[ZES_MAX_FABRIC_PORT_MODEL_SIZE]; ///< [out] Description of port technology. Will be set to the string - ///< "unkown" if this cannot be determined for this port. + ///< "unknown" if this cannot be determined for this port. ze_bool_t onSubdevice; ///< [out] True if the port is located on a sub-device; false means that ///< the port is on the device of the calling Sysman handle uint32_t subdeviceId; ///< [out] If onSubdevice is true, this gives the ID of the sub-device @@ -3183,7 +3183,7 @@ typedef struct _zes_fabric_port_properties_t typedef struct _zes_fabric_link_type_t { char desc[ZES_MAX_FABRIC_LINK_TYPE_SIZE]; ///< [out] Description of link technology. Will be set to the string - ///< "unkown" if this cannot be determined for this link. + ///< "unknown" if this cannot be determined for this link. } zes_fabric_link_type_t; @@ -5279,7 +5279,7 @@ typedef struct _zes_mem_properties_t /// @brief Memory state - health, allocated /// /// @details -/// - Percent free is given by 100 * free / pysical mem size. +/// - Percent free is given by 100 * free / physical mem size. typedef struct _zes_mem_state_t { zes_structure_type_t stype; ///< [in] type of this structure @@ -5292,7 +5292,7 @@ typedef struct _zes_mem_state_t ///< This member can no longer track the allocatable memory reliably. ///< Clients depending on this information can use the ///< zeDeviceGetProperties with ze_device_usablemem_size_ext_properties_t - ///< extention to get information of the available usable memory. + ///< extension to get information of the available usable memory. } zes_mem_state_t; @@ -6900,7 +6900,7 @@ zesSchedulerGetTimesliceModeProperties( ZE_APIEXPORT ze_result_t ZE_APICALL zesSchedulerSetTimeoutMode( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ); @@ -6940,7 +6940,7 @@ zesSchedulerSetTimeoutMode( ZE_APIEXPORT ze_result_t ZE_APICALL zesSchedulerSetTimesliceMode( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ); diff --git a/include/zet.py b/include/zet.py index 9c86340f..4f965a41 100644 --- a/include/zet.py +++ b/include/zet.py @@ -518,7 +518,7 @@ class zet_metric_query_pool_desc_t(Structure): ] ############################################################################### -## @brief Supportted profile features +## @brief Supported profile features class zet_profile_flags_v(IntEnum): REGISTER_REALLOCATION = ZE_BIT(0) ## request the compiler attempt to minimize register usage as much as ## possible to allow for instrumentation diff --git a/include/zet_api.h b/include/zet_api.h index 717f41b5..2bf8cdff 100644 --- a/include/zet_api.h +++ b/include/zet_api.h @@ -925,7 +925,7 @@ zetDebugGetRegisterSetProperties( /// - ::ZE_RESULT_ERROR_NOT_AVAILABLE /// + the thread is running or unavailable /// - ::ZE_RESULT_ERROR_INVALID_ARGUMENT -/// + the thread argument specifies more than one or a non-existant thread +/// + the thread argument specifies more than one or a non-existent thread ZE_APIEXPORT ze_result_t ZE_APICALL zetDebugGetThreadRegisterSetProperties( zet_debug_session_handle_t hDebug, ///< [in] debug session handle @@ -1886,7 +1886,7 @@ zetMetricQueryGetData( #pragma region pin #endif /////////////////////////////////////////////////////////////////////////////// -/// @brief Supportted profile features +/// @brief Supported profile features typedef uint32_t zet_profile_flags_t; typedef enum _zet_profile_flag_t { diff --git a/scripts/templates/helper.py b/scripts/templates/helper.py index 12d294ce..2f6e2b13 100644 --- a/scripts/templates/helper.py +++ b/scripts/templates/helper.py @@ -514,7 +514,7 @@ def is_global(item, tags): """ Public: - substitues each tag['key'] with tag['value'] + substitutes each tag['key'] with tag['value'] if cpp, then remove each tag['key'] if matches namespace if comment, then insert doxygen '::' notation at beginning (for autogen links) """ @@ -1610,8 +1610,8 @@ def make_tracing_func_name(namespace, tags, obj): cname = obj_traits.class_name(obj) x_tag = tags['$x'] r_tag = tags['$r'] - tags['$x'] = '' #temporaly remove namespace tag so funx doesn't contain "ze" - tags['$r'] = '' #temporaly remove namespace tag so funx doesn't contain "zer" + tags['$x'] = '' #temporarily remove namespace tag so funx doesn't contain "ze" + tags['$r'] = '' #temporarily remove namespace tag so funx doesn't contain "zer" fname = subt(namespace, tags, "%s%s"%(cname, obj['name']), cpp=False) fname = "zelTracer" + fname + "RegisterCallback" tags['$x'] = x_tag diff --git a/scripts/templates/ldrddi.cpp.mako b/scripts/templates/ldrddi.cpp.mako index e5c3600b..b2cf31d7 100644 --- a/scripts/templates/ldrddi.cpp.mako +++ b/scripts/templates/ldrddi.cpp.mako @@ -373,14 +373,14 @@ namespace loader ${item['name']} = ( ${item['name']} ) ? reinterpret_cast<${item['obj']}*>( ${item['name']} )->handle : nullptr; %else: %if re.match(r"\w+ImageDestroy$", th.make_func_name(n, tags, obj)): - // remove the handle from the kernel arugment map + // remove the handle from the kernel argument map { std::lock_guard lock(context->image_handle_map_lock); context->image_handle_map.erase(reinterpret_cast(hImage)); } %endif %if re.match(r"\w+SamplerDestroy$", th.make_func_name(n, tags, obj)): - // remove the handle from the kernel arugment map + // remove the handle from the kernel argument map { std::lock_guard lock(context->sampler_handle_map_lock); context->sampler_handle_map.erase(reinterpret_cast(hSampler)); @@ -410,7 +410,7 @@ namespace loader } } %endif - ## Workaround due to incorrect defintion of phWaitEvents in the ze headers which missed the range values. + ## Workaround due to incorrect definition of phWaitEvents in the ze headers which missed the range values. ## To be removed once the headers have been updated in a new spec release. %if re.match(r"\w+CommandListAppendMetricQueryEnd$", th.make_func_name(n, tags, obj)): // convert loader handles to driver handles diff --git a/scripts/templates/validation/handle_lifetime.cpp.mako b/scripts/templates/validation/handle_lifetime.cpp.mako index 899a979d..98c78a2d 100644 --- a/scripts/templates/validation/handle_lifetime.cpp.mako +++ b/scripts/templates/validation/handle_lifetime.cpp.mako @@ -24,7 +24,7 @@ from templates import helper as th namespace validation_layer { %for obj in th.extract_objs(specs, r"function"): - ## don't genrate function if it has no handles as parameters + ## don't generate function if it has no handles as parameters %if th.obj_traits.is_function_with_input_handles(obj): ${x}_result_t ${N}HandleLifetimeValidation::${th.make_func_name(n, tags, obj)}Prologue( diff --git a/scripts/templates/ze_loader_internal.h.mako b/scripts/templates/ze_loader_internal.h.mako index 4056e34a..cf0537a8 100644 --- a/scripts/templates/ze_loader_internal.h.mako +++ b/scripts/templates/ze_loader_internal.h.mako @@ -44,9 +44,9 @@ namespace loader typedef enum _zel_driver_type_t { ZEL_DRIVER_TYPE_DISCRETE_GPU= 0, ///< The driver has Discrete GPUs only - ZEL_DRIVER_TYPE_GPU = 1, ///< The driver has Heterogenous GPU types + ZEL_DRIVER_TYPE_GPU = 1, ///< The driver has Heterogeneous GPU types ZEL_DRIVER_TYPE_INTEGRATED_GPU = 2, ///< The driver has Integrated GPUs only - ZEL_DRIVER_TYPE_MIXED = 3, ///< The driver has Heterogenous driver types not limited to GPU or NPU. + ZEL_DRIVER_TYPE_MIXED = 3, ///< The driver has Heterogeneous driver types not limited to GPU or NPU. ZEL_DRIVER_TYPE_OTHER = 4, ///< The driver has No GPU Devices and has other device types only ZEL_DRIVER_TYPE_NPU = 5, ///< The driver has NPU devices only ZEL_DRIVER_TYPE_FORCE_UINT32 = 0x7fffffff diff --git a/source/drivers/null/zes_nullddi.cpp b/source/drivers/null/zes_nullddi.cpp index 9b765ec4..d1359e8f 100644 --- a/source/drivers/null/zes_nullddi.cpp +++ b/source/drivers/null/zes_nullddi.cpp @@ -832,7 +832,7 @@ namespace driver __zedlllocal ze_result_t ZE_APICALL zesOverclockGetVFPointValues( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. zes_vf_array_type_t VFArrayType, ///< [in] User,Default or Live VF array to read from uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t* PointValue ///< [out] Returns the frequency in 1kHz units or voltage in millivolt @@ -863,7 +863,7 @@ namespace driver __zedlllocal ze_result_t ZE_APICALL zesOverclockSetVFPointValues( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t PointValue ///< [in] Writes frequency in 1kHz units or voltage in millivolt units to ///< custom V-F curve at the specified zero-based index @@ -3548,7 +3548,7 @@ namespace driver __zedlllocal ze_result_t ZE_APICALL zesSchedulerSetTimeoutMode( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) @@ -3577,7 +3577,7 @@ namespace driver __zedlllocal ze_result_t ZE_APICALL zesSchedulerSetTimesliceMode( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) diff --git a/source/layers/validation/CONTRIBUTING.md b/source/layers/validation/CONTRIBUTING.md index 222fd4dc..6bf41ec1 100644 --- a/source/layers/validation/CONTRIBUTING.md +++ b/source/layers/validation/CONTRIBUTING.md @@ -31,7 +31,7 @@ review these for proper alignment with the * * An `EXAMPLE` Checker is located [here](./checkers/template/zel_template_checker.cpp) * Once one has generated the checker files, one can define intercepts for any of the functions in the Level Zero Specification. * Each function allows for Prologue and Epilogue intercepts to check both the pre and post call parameters. -* In your generated class, one can overide any functions with: +* In your generated class, one can override any functions with: * * `Prologue(` * * `Epilogue(` * Once your checker meets your needs, include your checker in the compile by adding your new checker folder to: diff --git a/source/layers/validation/README.md b/source/layers/validation/README.md index 800b9ff5..cf14108c 100644 --- a/source/layers/validation/README.md +++ b/source/layers/validation/README.md @@ -80,7 +80,7 @@ Basic leak checker in the validation layer which tracks the Create and Destroy c zeMemAllocShared = 0 \---> zeMemFree = 1 ``` -### `ZE_ENABLE_THREADING_VALIDATION` (Not yet Implemeneted) +### `ZE_ENABLE_THREADING_VALIDATION` (Not yet Implemented) Validates: - Objects are not concurrently reused in free-threaded API calls diff --git a/source/layers/validation/checkers/basic_leak/zel_basic_leak_checker.cpp b/source/layers/validation/checkers/basic_leak/zel_basic_leak_checker.cpp index 5427260b..45aa181d 100644 --- a/source/layers/validation/checkers/basic_leak/zel_basic_leak_checker.cpp +++ b/source/layers/validation/checkers/basic_leak/zel_basic_leak_checker.cpp @@ -275,7 +275,7 @@ namespace validation_layer { auto it = counts.find(functionName); - // make sure there is no insertion happening during program exeuction + // make sure there is no insertion happening during program execution // as inserting to the map is not thread safe if (it == counts.end()) { return; diff --git a/source/layers/validation/checkers/events_checker/zel_events_checker.cpp b/source/layers/validation/checkers/events_checker/zel_events_checker.cpp index 4393f409..5feb2845 100644 --- a/source/layers/validation/checkers/events_checker/zel_events_checker.cpp +++ b/source/layers/validation/checkers/events_checker/zel_events_checker.cpp @@ -64,7 +64,7 @@ eventsChecker::ZEeventsChecker::zeEventDestroyEpilogue( } if (eventToDagID.find(hEvent) != eventToDagID.end()) { - // Delete event from eventToDagID but not from the dagIDToAction map as it may be needed for printing the discription of the action when printing path in the DAG. + // Delete event from eventToDagID but not from the dagIDToAction map as it may be needed for printing the description of the action when printing path in the DAG. eventToDagID.erase(hEvent); } @@ -283,7 +283,7 @@ eventsChecker::ZEeventsChecker::zeEventHostSignalPrologue( } void eventsChecker::ZEeventsChecker::resetEventInEventToDagID( - const std::string &zeCallDisc, /// action discription + const std::string &zeCallDisc, /// action description const ze_event_handle_t hEvent ///< [in] handle of the event ) { auto it = eventToDagID.find(hEvent); @@ -501,7 +501,7 @@ void eventsChecker::ZEeventsChecker::validateSignalEventOwnership(const std::str } void eventsChecker::ZEeventsChecker::checkForDeadlock( - const std::string &zeCallDisc, /// action discription + const std::string &zeCallDisc, /// action description const ze_event_handle_t hSignalEvent, ///< [in][optional] handle of the event to forming the outgoing edge in the DAG const uint32_t numWaitEvents, ///< [in][optional] number of events that point to this action. const ze_event_handle_t *phWaitEvents ///< [in][optional][range(0, numWaitEvents)] handle of the events that point to this action. diff --git a/source/layers/validation/checkers/parameter_validation/zes_parameter_validation.cpp b/source/layers/validation/checkers/parameter_validation/zes_parameter_validation.cpp index aa9e8c9b..99a089f1 100644 --- a/source/layers/validation/checkers/parameter_validation/zes_parameter_validation.cpp +++ b/source/layers/validation/checkers/parameter_validation/zes_parameter_validation.cpp @@ -543,7 +543,7 @@ namespace validation_layer ze_result_t ZESParameterValidation::zesOverclockGetVFPointValuesPrologue( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. zes_vf_array_type_t VFArrayType, ///< [in] User,Default or Live VF array to read from uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t* PointValue ///< [out] Returns the frequency in 1kHz units or voltage in millivolt @@ -569,7 +569,7 @@ namespace validation_layer ze_result_t ZESParameterValidation::zesOverclockSetVFPointValuesPrologue( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t PointValue ///< [in] Writes frequency in 1kHz units or voltage in millivolt units to ///< custom V-F curve at the specified zero-based index @@ -2239,7 +2239,7 @@ namespace validation_layer ze_result_t ZESParameterValidation::zesSchedulerSetTimeoutModePrologue( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) @@ -2260,7 +2260,7 @@ namespace validation_layer ze_result_t ZESParameterValidation::zesSchedulerSetTimesliceModePrologue( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) diff --git a/source/layers/validation/handle_lifetime_tracking/zes_handle_lifetime.cpp b/source/layers/validation/handle_lifetime_tracking/zes_handle_lifetime.cpp index f0142297..aa6a2b24 100644 --- a/source/layers/validation/handle_lifetime_tracking/zes_handle_lifetime.cpp +++ b/source/layers/validation/handle_lifetime_tracking/zes_handle_lifetime.cpp @@ -382,7 +382,7 @@ namespace validation_layer ze_result_t ZESHandleLifetimeValidation::zesOverclockGetVFPointValuesPrologue( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. zes_vf_array_type_t VFArrayType, ///< [in] User,Default or Live VF array to read from uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t* PointValue ///< [out] Returns the frequency in 1kHz units or voltage in millivolt @@ -398,7 +398,7 @@ namespace validation_layer ze_result_t ZESHandleLifetimeValidation::zesOverclockSetVFPointValuesPrologue( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t PointValue ///< [in] Writes frequency in 1kHz units or voltage in millivolt units to ///< custom V-F curve at the specified zero-based index @@ -1722,7 +1722,7 @@ namespace validation_layer ze_result_t ZESHandleLifetimeValidation::zesSchedulerSetTimeoutModePrologue( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) @@ -1736,7 +1736,7 @@ namespace validation_layer ze_result_t ZESHandleLifetimeValidation::zesSchedulerSetTimesliceModePrologue( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) diff --git a/source/layers/validation/zes_valddi.cpp b/source/layers/validation/zes_valddi.cpp index a9fb5f12..73e91307 100644 --- a/source/layers/validation/zes_valddi.cpp +++ b/source/layers/validation/zes_valddi.cpp @@ -863,7 +863,7 @@ namespace validation_layer VALIDATION_MAYBE_UNUSED static ze_result_t logAndPropagateResult_zesOverclockGetVFPointValues( ze_result_t result, zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. zes_vf_array_type_t VFArrayType, ///< [in] User,Default or Live VF array to read from uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t* PointValue ///< [out] Returns the frequency in 1kHz units or voltage in millivolt @@ -908,7 +908,7 @@ namespace validation_layer VALIDATION_MAYBE_UNUSED static ze_result_t logAndPropagateResult_zesOverclockSetVFPointValues( ze_result_t result, zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t PointValue ///< [in] Writes frequency in 1kHz units or voltage in millivolt units to ///< custom V-F curve at the specified zero-based index @@ -3508,7 +3508,7 @@ namespace validation_layer VALIDATION_MAYBE_UNUSED static ze_result_t logAndPropagateResult_zesSchedulerSetTimeoutMode( ze_result_t result, zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) { @@ -3538,7 +3538,7 @@ namespace validation_layer VALIDATION_MAYBE_UNUSED static ze_result_t logAndPropagateResult_zesSchedulerSetTimesliceMode( ze_result_t result, zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) { @@ -5980,7 +5980,7 @@ namespace validation_layer __zedlllocal ze_result_t ZE_APICALL zesOverclockGetVFPointValues( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. zes_vf_array_type_t VFArrayType, ///< [in] User,Default or Live VF array to read from uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t* PointValue ///< [out] Returns the frequency in 1kHz units or voltage in millivolt @@ -6026,7 +6026,7 @@ namespace validation_layer __zedlllocal ze_result_t ZE_APICALL zesOverclockSetVFPointValues( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t PointValue ///< [in] Writes frequency in 1kHz units or voltage in millivolt units to ///< custom V-F curve at the specified zero-based index @@ -10005,7 +10005,7 @@ namespace validation_layer __zedlllocal ze_result_t ZE_APICALL zesSchedulerSetTimeoutMode( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) @@ -10049,7 +10049,7 @@ namespace validation_layer __zedlllocal ze_result_t ZE_APICALL zesSchedulerSetTimesliceMode( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) diff --git a/source/lib/ze_libapi.cpp b/source/lib/ze_libapi.cpp index e036567c..5fa9a6ed 100644 --- a/source/lib/ze_libapi.cpp +++ b/source/lib/ze_libapi.cpp @@ -11395,7 +11395,7 @@ zeCommandListAppendLaunchKernelIndirect( /// the Host or device up until execution. /// - This may **only** be called for a command list created with command /// queue group ordinal that supports compute. -/// - The application must enusre the command list, kernel and events were +/// - The application must ensure the command list, kernel and events were /// created, and the memory was allocated, on the same context. /// - This function may **not** be called from simultaneous threads with the /// same command list handle. @@ -13678,7 +13678,7 @@ zeModuleInspectLinkageExt( /// /// @details /// - Similar to zeMemFree, with added parameter to choose the free policy. -/// - Does not gaurantee memory is freed upon return. See free policy +/// - Does not guarantee memory is freed upon return. See free policy /// descriptions for details. /// - The application must **not** call this function from simultaneous /// threads with the same pointer. @@ -16578,9 +16578,9 @@ zeDriverRTASFormatCompatibilityCheckExt( /// - All provided data buffers must be host-accessible. The referenced /// scene data (index- and vertex- buffers) have to be accessible from the /// host, and will **not** be referenced by the build acceleration structure. -/// - The acceleration structure buffer is typicall a host allocation that +/// - The acceleration structure buffer is typically a host allocation that /// is later manually copied to a device allocation. Alternatively one can -/// also use a shared USM allocation as acceration structure buffer and +/// also use a shared USM allocation as acceleration structure buffer and /// skip the copy. /// - A successfully constructed acceleration structure is entirely /// self-contained. There is no requirement for input data to persist diff --git a/source/lib/zes_libapi.cpp b/source/lib/zes_libapi.cpp index 13cc9ac5..77f74e76 100644 --- a/source/lib/zes_libapi.cpp +++ b/source/lib/zes_libapi.cpp @@ -1939,7 +1939,7 @@ zesOverclockGetControlState( ze_result_t ZE_APICALL zesOverclockGetVFPointValues( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. zes_vf_array_type_t VFArrayType, ///< [in] User,Default or Live VF array to read from uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t* PointValue ///< [out] Returns the frequency in 1kHz units or voltage in millivolt @@ -2009,7 +2009,7 @@ zesOverclockGetVFPointValues( ze_result_t ZE_APICALL zesOverclockSetVFPointValues( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t PointValue ///< [in] Writes frequency in 1kHz units or voltage in millivolt units to ///< custom V-F curve at the specified zero-based index @@ -8155,7 +8155,7 @@ zesSchedulerGetTimesliceModeProperties( ze_result_t ZE_APICALL zesSchedulerSetTimeoutMode( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) @@ -8228,7 +8228,7 @@ zesSchedulerSetTimeoutMode( ze_result_t ZE_APICALL zesSchedulerSetTimesliceMode( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) diff --git a/source/lib/zet_libapi.cpp b/source/lib/zet_libapi.cpp index 94bb0c8b..678ec6df 100644 --- a/source/lib/zet_libapi.cpp +++ b/source/lib/zet_libapi.cpp @@ -756,7 +756,7 @@ zetDebugGetRegisterSetProperties( /// - ::ZE_RESULT_ERROR_NOT_AVAILABLE /// + the thread is running or unavailable /// - ::ZE_RESULT_ERROR_INVALID_ARGUMENT -/// + the thread argument specifies more than one or a non-existant thread +/// + the thread argument specifies more than one or a non-existent thread ze_result_t ZE_APICALL zetDebugGetThreadRegisterSetProperties( zet_debug_session_handle_t hDebug, ///< [in] debug session handle diff --git a/source/loader/ze_ldrddi.cpp b/source/loader/ze_ldrddi.cpp index 2b51dad8..502154b7 100644 --- a/source/loader/ze_ldrddi.cpp +++ b/source/loader/ze_ldrddi.cpp @@ -4003,7 +4003,7 @@ namespace loader if( nullptr == pfnDestroy ) return ZE_RESULT_ERROR_UNINITIALIZED; - // remove the handle from the kernel arugment map + // remove the handle from the kernel argument map { std::lock_guard lock(context->image_handle_map_lock); context->image_handle_map.erase(reinterpret_cast(hImage)); @@ -5584,7 +5584,7 @@ namespace loader if( nullptr == pfnDestroy ) return ZE_RESULT_ERROR_UNINITIALIZED; - // remove the handle from the kernel arugment map + // remove the handle from the kernel argument map { std::lock_guard lock(context->sampler_handle_map_lock); context->sampler_handle_map.erase(reinterpret_cast(hSampler)); diff --git a/source/loader/ze_loader.cpp b/source/loader/ze_loader.cpp index 14a0ef27..8db843ce 100644 --- a/source/loader/ze_loader.cpp +++ b/source/loader/ze_loader.cpp @@ -19,6 +19,7 @@ namespace loader { + // TEMPORARY codespell CI test: intentionaly misspelled word, remove before merge. ze_handle_t* loaderDispatch = nullptr; zer_dditable_t *defaultZerDdiTable = nullptr; /////////////////////////////////////////////////////////////////////////////// @@ -461,7 +462,7 @@ namespace loader } } - // Sort drivers in ascending order of driver type unless ZE_ENABLE_PCI_ID_DEVICE_ORDER, then in decending order with MIXED and OTHER at the end. + // Sort drivers in ascending order of driver type unless ZE_ENABLE_PCI_ID_DEVICE_ORDER, then in descending order with MIXED and OTHER at the end. std::sort(drivers->begin(), drivers->end(), driverSortComparator); if (debugTraceEnabled) { diff --git a/source/loader/ze_loader_internal.h b/source/loader/ze_loader_internal.h index 45dce29c..27a60761 100644 --- a/source/loader/ze_loader_internal.h +++ b/source/loader/ze_loader_internal.h @@ -35,9 +35,9 @@ namespace loader typedef enum _zel_driver_type_t { ZEL_DRIVER_TYPE_DISCRETE_GPU= 0, ///< The driver has Discrete GPUs only - ZEL_DRIVER_TYPE_GPU = 1, ///< The driver has Heterogenous GPU types + ZEL_DRIVER_TYPE_GPU = 1, ///< The driver has Heterogeneous GPU types ZEL_DRIVER_TYPE_INTEGRATED_GPU = 2, ///< The driver has Integrated GPUs only - ZEL_DRIVER_TYPE_MIXED = 3, ///< The driver has Heterogenous driver types not limited to GPU or NPU. + ZEL_DRIVER_TYPE_MIXED = 3, ///< The driver has Heterogeneous driver types not limited to GPU or NPU. ZEL_DRIVER_TYPE_OTHER = 4, ///< The driver has No GPU Devices and has other device types only ZEL_DRIVER_TYPE_NPU = 5, ///< The driver has NPU devices only ZEL_DRIVER_TYPE_FORCE_UINT32 = 0x7fffffff diff --git a/source/loader/zes_ldrddi.cpp b/source/loader/zes_ldrddi.cpp index 99b19adf..dee1817a 100644 --- a/source/loader/zes_ldrddi.cpp +++ b/source/loader/zes_ldrddi.cpp @@ -975,7 +975,7 @@ namespace loader __zedlllocal ze_result_t ZE_APICALL zesOverclockGetVFPointValues( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. zes_vf_array_type_t VFArrayType, ///< [in] User,Default or Live VF array to read from uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t* PointValue ///< [out] Returns the frequency in 1kHz units or voltage in millivolt @@ -1004,7 +1004,7 @@ namespace loader __zedlllocal ze_result_t ZE_APICALL zesOverclockSetVFPointValues( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t PointValue ///< [in] Writes frequency in 1kHz units or voltage in millivolt units to ///< custom V-F curve at the specified zero-based index @@ -3697,7 +3697,7 @@ namespace loader __zedlllocal ze_result_t ZE_APICALL zesSchedulerSetTimeoutMode( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) @@ -3724,7 +3724,7 @@ namespace loader __zedlllocal ze_result_t ZE_APICALL zesSchedulerSetTimesliceMode( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) diff --git a/source/loader/zes_ldrddi.h b/source/loader/zes_ldrddi.h index 165a2c15..1f985ca4 100644 --- a/source/loader/zes_ldrddi.h +++ b/source/loader/zes_ldrddi.h @@ -274,7 +274,7 @@ namespace loader_driver_ddi __zedlllocal ze_result_t ZE_APICALL zesOverclockGetVFPointValues( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. zes_vf_array_type_t VFArrayType, ///< [in] User,Default or Live VF array to read from uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t* PointValue ///< [out] Returns the frequency in 1kHz units or voltage in millivolt @@ -283,7 +283,7 @@ namespace loader_driver_ddi __zedlllocal ze_result_t ZE_APICALL zesOverclockSetVFPointValues( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t PointValue ///< [in] Writes frequency in 1kHz units or voltage in millivolt units to ///< custom V-F curve at the specified zero-based index @@ -969,14 +969,14 @@ namespace loader_driver_ddi __zedlllocal ze_result_t ZE_APICALL zesSchedulerSetTimeoutMode( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ); __zedlllocal ze_result_t ZE_APICALL zesSchedulerSetTimesliceMode( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ); diff --git a/source/loader/zes_ldrddi_driver_ddi.cpp b/source/loader/zes_ldrddi_driver_ddi.cpp index cb20b4f9..ba80c877 100644 --- a/source/loader/zes_ldrddi_driver_ddi.cpp +++ b/source/loader/zes_ldrddi_driver_ddi.cpp @@ -856,7 +856,7 @@ namespace loader_driver_ddi __zedlllocal ze_result_t ZE_APICALL zesOverclockGetVFPointValues( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. zes_vf_array_type_t VFArrayType, ///< [in] User,Default or Live VF array to read from uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t* PointValue ///< [out] Returns the frequency in 1kHz units or voltage in millivolt @@ -891,7 +891,7 @@ namespace loader_driver_ddi __zedlllocal ze_result_t ZE_APICALL zesOverclockSetVFPointValues( zes_overclock_handle_t hDomainHandle, ///< [in] Handle for the component domain. - zes_vf_type_t VFType, ///< [in] Voltage or Freqency point to read. + zes_vf_type_t VFType, ///< [in] Voltage or Frequency point to read. uint32_t PointIndex, ///< [in] Point index - number between (0, max_num_points - 1). uint32_t PointValue ///< [in] Writes frequency in 1kHz units or voltage in millivolt units to ///< custom V-F curve at the specified zero-based index @@ -3891,7 +3891,7 @@ namespace loader_driver_ddi __zedlllocal ze_result_t ZE_APICALL zesSchedulerSetTimeoutMode( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeout_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) @@ -3924,7 +3924,7 @@ namespace loader_driver_ddi __zedlllocal ze_result_t ZE_APICALL zesSchedulerSetTimesliceMode( zes_sched_handle_t hScheduler, ///< [in] Sysman handle for the component. - zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configurating this mode. + zes_sched_timeslice_properties_t* pProperties, ///< [in] The properties to use when configuring this mode. ze_bool_t* pNeedReload ///< [in,out] Will be set to TRUE if a device driver reload is needed to ///< apply the new scheduler mode. ) diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt index a1fa8dd6..3a8b20a1 100644 --- a/test/CMakeLists.txt +++ b/test/CMakeLists.txt @@ -19,7 +19,7 @@ if(BUILD_STATIC OR NOT WIN32) endif() # For builds on non-Windows platforms, include init_driver_unit_tests -# The tests rely on ablity to locate fake drivers by specific names which is not possible on Windows. +# The tests rely on ability to locate fake drivers by specific names which is not possible on Windows. if(NOT WIN32) target_sources(tests PRIVATE init_driver_unit_tests.cpp) endif() From 252fea522b76e172f2ffb7818caf78398939f744 Mon Sep 17 00:00:00 2001 From: Russell McGuire Date: Thu, 30 Jul 2026 17:11:48 -0700 Subject: [PATCH 2/2] Remove fake spelling error Signed-off-by: Russell McGuire --- source/loader/ze_loader.cpp | 1 - 1 file changed, 1 deletion(-) diff --git a/source/loader/ze_loader.cpp b/source/loader/ze_loader.cpp index 8db843ce..af49e12a 100644 --- a/source/loader/ze_loader.cpp +++ b/source/loader/ze_loader.cpp @@ -19,7 +19,6 @@ namespace loader { - // TEMPORARY codespell CI test: intentionaly misspelled word, remove before merge. ze_handle_t* loaderDispatch = nullptr; zer_dditable_t *defaultZerDdiTable = nullptr; ///////////////////////////////////////////////////////////////////////////////