Skip to content

Commit 98ff4b0

Browse files
Deprecate counter based event pools (#404)
Signed-off-by: Bartosz Dunajski <bartosz.dunajski@intel.com>
1 parent e35ad5a commit 98ff4b0

3 files changed

Lines changed: 8 additions & 5 deletions

File tree

scripts/core/EXT_Exp_CounterBasedEventPools.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ from templates import helper as th
1414
Counter-Based Event Pools Extension
1515
=====================================
1616

17+
- This experimental extension is deprecated and replaced by the :ref:`Counter-based events<counter-based-events>`
18+
1719
API
1820
----
1921

scripts/core/PROG.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,7 @@ The following pseudo-code demonstrates querying properties of a physical memory
460460
461461
ze_physical_mem_handle_t hPhysicalMemory;
462462
463-
${x}PhysicalMemCreate(hContext,hDevice, &alloc_desc,&hPhysicalMemory)
463+
${x}PhysicalMemCreate(hContext, hDevice, &alloc_desc, &hPhysicalMemory)
464464
465465
// Set up the request to export the external memory handle
466466
@@ -507,7 +507,7 @@ The following pseudo-code demonstrates querying properties of a physical memory
507507
.size = 1024
508508
};
509509
510-
${x}PhysicalMemCreate(hContext,hDevice, &alloc_desc,&physicalMemImporter);
510+
${x}PhysicalMemCreate(hContext, hDevice, &alloc_desc, &physicalMemImporter);
511511
512512
513513
Mapping Virtual Memory Pages
@@ -800,7 +800,7 @@ The following pseudo-code demonstrates how to import a Linux dma_buf as an exter
800800
.size = 1024
801801
};
802802
803-
${x}PhysicalMemCreate(hContext,hDevice, &allocDesc,&physicalMemImporter);
803+
${x}PhysicalMemCreate(hContext, hDevice, &allocDesc, &physicalMemImporter);
804804
805805
Command Queues and Command Lists
806806
================================
@@ -1353,6 +1353,7 @@ Driver may select which API calls are applicable for generating interrupts.
13531353
Additionally, user may provide external interrupt id (${X}_EVENT_SYNC_MODE_FLAG_EXTERNAL_INTERRUPT_WAIT). OS methods will be used for Event host synchronization calls, to optimize waiting for completion. Similar to low power mode.
13541354
It can be used only with Counter Based Events.
13551355

1356+
.. _counter-based-events:
13561357
Counter Based Events
13571358
~~~~~~~~~~~~~~~~~~~~~~~
13581359

scripts/core/counterbasedeventpool.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
#
88
--- #--------------------------------------------------------------------------
99
type: header
10-
desc: "Intel $OneApi Level-Zero Extension APIs for Counter-based Event Pools"
10+
desc: "Intel $OneApi Level-Zero Extension APIs for Counter-based Event Pools. @deprecated since 1.15"
1111
version: "1.8"
1212
--- #--------------------------------------------------------------------------
1313
type: macro
@@ -37,7 +37,7 @@ etors:
3737
desc: "Counter-based event pool is for non-immediate command lists"
3838
--- #--------------------------------------------------------------------------
3939
type: struct
40-
desc: "Event pool descriptor for counter-based events. This structure may be passed to $xEventPoolCreate as pNext member of $x_event_pool_desc_t."
40+
desc: "Event pool descriptor for counter-based events. This structure may be passed to $xEventPoolCreate as pNext member of $x_event_pool_desc_t. @deprecated since 1.15"
4141
class: $xEventPool
4242
version: "1.8"
4343
name: $x_event_pool_counter_based_exp_desc_t

0 commit comments

Comments
 (0)