#3580: document cb funcs

tenstorrent · Nov 21, 2023 · 64d742f · 64d742f
1 parent 36a571b
commit 64d742f
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 0 deletions.
diff --git a/docs/source/tt_metal/apis/kernel_apis/compute/binary_op_init_funcs.rst b/docs/source/tt_metal/apis/kernel_apis/compute/binary_op_init_funcs.rst
@@ -0,0 +1,6 @@
+binary_init_funcs
+=================
+
+
+.. doxygenfunction:: binary_op_init_common(uint32_t icb0, uint32_t icb1)
+.. doxygenfunction:: binary_op_specific_init(int op_code)
diff --git a/docs/source/tt_metal/apis/kernel_apis/compute/cb_pop_front.rst b/docs/source/tt_metal/apis/kernel_apis/compute/cb_pop_front.rst
@@ -0,0 +1,6 @@
+
+
+cb_pop_front
+============
+
+.. doxygenfunction:: cb_pop_front(uint32_t cbid, uint32_t ntiles)
diff --git a/docs/source/tt_metal/apis/kernel_apis/compute/cb_push_back.rst b/docs/source/tt_metal/apis/kernel_apis/compute/cb_push_back.rst
@@ -0,0 +1,6 @@
+
+
+cb_push_back
+=============
+
+.. doxygenfunction:: cb_push_back(uint32_t cbid, uint32_t ntiles)
diff --git a/docs/source/tt_metal/apis/kernel_apis/compute/cb_reserve_back.rst b/docs/source/tt_metal/apis/kernel_apis/compute/cb_reserve_back.rst
@@ -0,0 +1,6 @@
+
+
+cb_reserve_back
+===============
+
+.. doxygenfunction:: cb_reserve_back(uint32_t cbid, uint32_t ntiles)
diff --git a/docs/source/tt_metal/apis/kernel_apis/compute/cb_wait_front.rst b/docs/source/tt_metal/apis/kernel_apis/compute/cb_wait_front.rst
@@ -0,0 +1,6 @@
+
+
+cb_wait_front
+=============
+
+.. doxygenfunction:: cb_wait_front(uint32_t cbid, uint32_t ntiles)
diff --git a/tt_metal/include/compute_kernel_api/pack.h b/tt_metal/include/compute_kernel_api/pack.h
@@ -62,6 +62,9 @@ ALWI void pack_reconfig_data_format(const uint32_t new_operand) {
     // NOTE: For wormhole_b0, packer data format reconfig functions don;t yet exist. So skip.
 }
 
+/**
+ * Helper function to reconfigure packer output data format.
+ */
 ALWI void pack_reconfig_data_format(const uint32_t old_operand, const uint32_t new_operand) {
     #ifdef ARCH_GRAYSKULL
         PACK(( llk_pack_reconfig_data_format(old_operand, new_operand) ));