Skip to content

Commit c00d427

Browse files
[SYCL][Docs] Rename device global variable PI API in design docs (#7914)
This commit renames piextEnqueueDeviceVariableRead and piextEnqueueDeviceVariableWrite to piextEnqueueDeviceGlobalVariableRead and piextEnqueueDeviceGlobalVariableWrite respectively to better reflect the type of variables reachable by the functions. Signed-off-by: Larsen, Steffen <steffen.larsen@intel.com>
1 parent 45b5267 commit c00d427

File tree

1 file changed

+15
-20
lines changed

1 file changed

+15
-20
lines changed

sycl/doc/design/DeviceGlobal.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -563,28 +563,23 @@ instance of a device global variable in a `pi_program`. This functionality is
563563
exposed as two new PI interfaces:
564564

565565
```
566-
pi_result piextEnqueueDeviceVariableRead(pi_queue Queue, pi_program Program,
567-
const char *Name, pi_bool BlockingRead,
568-
size_t Count, size_t Offset, void *Dst,
569-
pi_uint32 NumEventsInWaitList,
570-
const pi_event *EventsWaitList,
571-
pi_event *Event);
572-
573-
pi_result piextEnqueueDeviceVariableWrite(pi_queue Queue, pi_program Program,
574-
const char *Name,
575-
pi_bool BlockingWrite, size_t Count,
576-
size_t Offset, const void *Src,
577-
pi_uint32 NumEventsInWaitList,
578-
const pi_event *EventsWaitList,
579-
pi_event *Event);
566+
pi_result piextEnqueueDeviceGlobalVariableRead(
567+
pi_queue Queue, pi_program Program, const char *Name, pi_bool BlockingRead,
568+
size_t Count, size_t Offset, void *Dst, pi_uint32 NumEventsInWaitList,
569+
const pi_event *EventsWaitList, pi_event *Event);
570+
571+
pi_result piextEnqueueDeviceGlobalVariableWrite(
572+
pi_queue Queue, pi_program Program, const char *Name, pi_bool BlockingWrite,
573+
size_t Count, size_t Offset, const void *Src, pi_uint32 NumEventsInWaitList,
574+
const pi_event *EventsWaitList, pi_event *Event);
580575
```
581576

582-
The `piextEnqueueDeviceVariableRead` function reads `Count` bytes at byte-offset
583-
`Offset` from a device global variable in `Program` identified by the name
584-
`Name`. The read data is stored in `Dst`. Likewise, the
585-
`piextEnqueueDeviceVariableWrite` function reads `Count` bytes from `Dst` and
586-
stores them at byte-offset `Offset` in the device global variable in `Program`
587-
identified by the name `Name`.
577+
The `piextEnqueueDeviceGlobalVariableRead` function reads `Count` bytes at
578+
byte-offset `Offset` from a device global variable in `Program` identified by
579+
the name `Name`. The read data is stored in `Dst`. Likewise, the
580+
`piextEnqueueDeviceGlobalVariableWrite` function reads `Count` bytes from `Dst`
581+
and stores them at byte-offset `Offset` in the device global variable in
582+
`Program` identified by the name `Name`.
588583

589584
Both functions will enqueue the associated memory command on `Queue` where it
590585
will first wait for `NumEventsInWaitList` events in `EventsWaitList` to finish.

0 commit comments

Comments
 (0)