Skip to contentSkip to conversation

habanalabs: add comments on INFO IOCTL

PATCH In review Oded Gabbay 2 participants 2 messages Jul 16, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 habanalabs: add comments on INFO IOCTL

This patch adds some in-code documentation on the different opcodes of the INFO IOCTL.

---
 include/uapi/misc/habanalabs.h | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)
include/uapi/misc/habanalabs.h +13 -1
index 3956c226ca35..a5a1d0e7ec82 100644
@@ -75,7 +75,19 @@ enum hl_device_status {
 	HL_DEVICE_STATUS_MALFUNCTION
 };
 
-/* Opcode for management ioctl */
+/* Opcode for management ioctl
+ *
+ * HW_IP_INFO         - Receive information about different IP blocks in the
+ *                      device.
+ * HL_INFO_HW_EVENTS  - Receive an array describing how many times each event
+ *                      occurred since the last hard reset.
+ * HL_INFO_DRAM_USAGE - Retrieve the dram usage inside the device and of the
+ *                      specific context. This is relevant only for GOYA device.
+ * HL_INFO_HW_IDLE    - Retrieve information about the idle status of each
+ *                      internal engine.
+ * HL_INFO_DEVICE_STATUS - Retrieve the device's status. This opcode doesn't
+ *                         require an open context.
+ */
 #define HL_INFO_HW_IP_INFO	0
 #define HL_INFO_HW_EVENTS	1
 #define HL_INFO_DRAM_USAGE	2
Signature · 1 line
2.17.1