Skip to content

Commit e0966b0

Browse files
committed
Rename device global properties
Rename properties to address review comments.
1 parent dd7cdbd commit e0966b0

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

sycl/doc/extensions/DeviceGlobal/SYCL_INTEL_device_global.asciidoc

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -405,8 +405,8 @@ parameter as shown in this example:
405405
----
406406
using namespace sycl::ext::oneapi;
407407
408-
device_global<MyClass, property_list_t<device_image_life::value_t>> dm1;
409-
device_global<int[4], property_list_t<copy_access::value_t<copy_access::access::read>> dm2;
408+
device_global<MyClass, property_list_t<device_image_scope::value_t>> dm1;
409+
device_global<int[4], property_list_t<host_access::value_t<host_access::access::read>> dm2;
410410
----
411411

412412
The following code synopsis shows the set of supported properties, and the
@@ -416,27 +416,27 @@ following table describes their effect.
416416
----
417417
namespace sycl::ext::oneapi {
418418
419-
struct device_image_life {
420-
using value_t = property_value<device_image_life>;
419+
struct device_image_scope {
420+
using value_t = property_value<device_image_scope>;
421421
};
422422
423-
struct copy_access {
423+
struct host_access {
424424
enum class access: /*unspecified*/ {
425425
read,
426426
write,
427427
read_write,
428-
no_access
428+
none
429429
};
430430
template<access A>
431-
using value_t = property_value<copy_access, std::integral_constant<access, A>>;
431+
using value_t = property_value<host_access, std::integral_constant<access, A>>;
432432
433-
struct init_via {
433+
struct init_mode {
434434
enum class trigger: /*unspecified*/ {
435435
reprogram,
436436
reset
437437
};
438438
template<trigger T>
439-
using value_t = property_value<init_via, std::integral_constant<trigger, T>>;
439+
using value_t = property_value<init_mode, std::integral_constant<trigger, T>>;
440440
};
441441
442442
struct implement_in_csr {
@@ -445,13 +445,13 @@ struct implement_in_csr {
445445
};
446446
447447
448-
inline constexpr device_image_life::value_t device_image_life_v;
448+
inline constexpr device_image_scope::value_t device_image_scope_v;
449449
450-
template<copy_access::access A>
451-
inline constexpr copy_access::value_t<A> copy_access_v;
450+
template<host_access::access A>
451+
inline constexpr host_access::value_t<A> host_access_v;
452452
453-
template<init_via::trigger T>
454-
inline constexpr init_via::value_t<T> init_via_v;
453+
template<init_mode::trigger T>
454+
inline constexpr init_mode::value_t<T> init_mode_v;
455455
456456
template<bool Enable>
457457
inline constexpr implement_in_csr::value_t<Enable> implement_in_csr_v;
@@ -466,7 +466,7 @@ inline constexpr implement_in_csr::value_t<Enable> implement_in_csr_v;
466466
a|
467467
[source,c++]
468468
----
469-
device_image_life
469+
device_image_scope
470470
----
471471
a|
472472
This property is most useful for kernels that are submitted to an FPGA device,
@@ -508,7 +508,7 @@ device.
508508
a|
509509
[source,c++]
510510
----
511-
copy_access
511+
host_access
512512
----
513513
a|
514514
This property provides an assertion by the user telling the implementation
@@ -525,7 +525,7 @@ The following values are supported:
525525
* `write`: The user asserts that the host code may copy to (write) the
526526
variable, but it never copy from (read) it. For an FPGA device, only a write
527527
port is exposed.
528-
* `no_access`: The user asserts that the host code will never copy to or copy
528+
* `none`: The user asserts that the host code will never copy to or copy
529529
from the variable. For an FPGA device, no external ports are exposed.
530530
* `read_write`: The user provides no assertions, and the host code may either
531531
copy to or copy from the variable. This is the default. For an FPGA device,
@@ -534,7 +534,7 @@ The following values are supported:
534534
a|
535535
[source,c++]
536536
----
537-
init_via
537+
init_mode
538538
----
539539
a|
540540
This property is only meaningful when used with an FPGA device. It is ignored
@@ -545,7 +545,7 @@ for other devices. The following values are supported:
545545
* `reset`: Initialization is performed by sending a reset signal to the device.
546546
This may increase area but may reduce reprogramming frequency.
547547

548-
If the `init_via` property is not specified it may be set automatically to an
548+
If the `init_mode` property is not specified it may be set automatically to an
549549
implementation defined default.
550550

551551
a|
@@ -569,7 +569,7 @@ to an implementation defined default.
569569
[NOTE]
570570
====
571571
As stated above, the user must understand which _device image_ contains a
572-
kernel in order to use the `device_image_life` property. Each implementation
572+
kernel in order to use the `device_image_scope` property. Each implementation
573573
may have its own rules that determine when two kernels are bundled together
574574
into the same _device image_. For {dpcpp} two kernels _K1_ and _K2_ will be
575575
bundled into the same _device image_ when both of the following conditions are
@@ -855,8 +855,8 @@ void copy(const std::remove_all_extents_t<T> *src,
855855
----
856856
| `T` must be device copyable.
857857

858-
Not available if `PropertyListT` contains the `copy_access` property with
859-
`read` or `no_access` assertions.
858+
Not available if `PropertyListT` contains the `host_access` property with
859+
`read` or `none` assertions.
860860

861861
Copies _count_ elements of type `std::remove_all_extents_t<T>` from the pointer _src_ to the `device_global` _dest_, starting at _startIndex_ elements of _dest_. _src_ may be either a host or USM pointer.
862862
a|
@@ -870,8 +870,8 @@ void copy(const device_global<T, PropertyListT>& src,
870870
----
871871
| `T` must be device copyable.
872872

873-
Not available if `PropertyListT` contains the `copy_access` property with
874-
`write` or `no_access` assertions.
873+
Not available if `PropertyListT` contains the `host_access` property with
874+
`write` or `none` assertions.
875875

876876
Copies _count_ elements of type `std::remove_all_extents_t<T>` from the `device_global` _src_ to the pointer _dest_, starting at _startIndex_ elements of _src_. _dest_ may be either a host or USM pointer.
877877

@@ -884,8 +884,8 @@ void memcpy(device_global<T, PropertyListT>& dest,
884884
----
885885
|`T` must be device copyable.
886886

887-
Not available if `PropertyListT` contains the `copy_access` property with
888-
`read` or `no_access` assertions.
887+
Not available if `PropertyListT` contains the `host_access` property with
888+
`read` or `none` assertions.
889889

890890
Copies _count_ bytes from the pointer _src_ to the `device_global` _dest_, starting at _offset_ bytes. _src_ may be either a host or USM pointer.
891891

@@ -899,8 +899,8 @@ void memcpy(void *dest,
899899
----
900900
|`T` must be device copyable.
901901

902-
Not available if `PropertyListT` contains the `copy_access` property with
903-
`write` or `no_access` assertions.
902+
Not available if `PropertyListT` contains the `host_access` property with
903+
`write` or `none` assertions.
904904

905905
Copies _count_ bytes from the `device_global` _src_ to the pointer _dest_, starting at _offset_ bytes. _dest_ may be either a host or USM pointer.
906906
|====

0 commit comments

Comments
 (0)