Skip to content

Commit 58b83b4

Browse files
committed
✨ Add CHILDDEVICES device property
1 parent 2df0093 commit 58b83b4

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

include/qdmi/constants.h

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -393,6 +393,20 @@ enum QDMI_DEVICE_PROPERTY_T {
393393
* @see QDMI_DEVICE_PROPERTY_LENGTSCALEFACTOR
394394
*/
395395
QDMI_DEVICE_PROPERTY_MINATOMDISTANCE = 14,
396+
/**
397+
* @brief `QDMI_Device*` (@ref QDMI_Device list) A list of device handles
398+
* corresponding to the device's child devices managed by this device.
399+
* @details Some devices may manage multiple child devices, e.g., a
400+
* multi-device system or a device with multiple processing units. This
401+
* property provides access to the child devices as separate @ref QDMI_Device
402+
* handles.
403+
* @par
404+
* The property may yield @ref QDMI_ERROR_NOTSUPPORTED if the device does not
405+
* have any child devices.
406+
* @note Devices with child devices may have special job submission handling.
407+
* Check the concrete device's job interface documentation.
408+
*/
409+
QDMI_DEVICE_PROPERTY_CHILDDEVICES = 15,
396410
/**
397411
* @brief The maximum value of the enum.
398412
* @details It can be used by devices for bounds checking and validation of
@@ -401,7 +415,7 @@ enum QDMI_DEVICE_PROPERTY_T {
401415
* @attention This value must remain the last regular member of the enum
402416
* besides the custom members and must be updated when new members are added.
403417
*/
404-
QDMI_DEVICE_PROPERTY_MAX = 15,
418+
QDMI_DEVICE_PROPERTY_MAX = 16,
405419
/**
406420
* @brief This enum value is reserved for a custom property.
407421
* @details The device defines the meaning and the type of this property.

0 commit comments

Comments
 (0)