Added more info about functionality

Author: TejaX-Alaghari

clang/runtime/dpct-rt/include/dpct/math.hpp

@@ -2056,8 +2056,26 @@ class joint_matrix {
   const size_t num_elements;
 };
 
-/// Loads 1 8x8 b16 matrix from local memory to private memory (32-bits per wi)
-/// Requires the sub-group size of kernel calling this function to be 32
+/// Loads 1 8x8 b16 (128 bytes) matrix from private memory to local memory per
+/// sub-group. Requires the sub-group size of kernel calling this function to
+/// be 32. 'mat' specifies the matrix index to be loaded. The first '(mat + 1) *
+/// 8' work items of sub-group contain the starting address of their respective
+/// matrix row in 'addr'. After distributing addresses to other work items, each
+/// of the 32 work items load 32-bits (2 packed 16-bit data) into 'm' for a
+/// total of 128 bytes. 'trans' specifies to perform a transposed/non-transposed
+/// load by each work item like below
+/// Row Major: Each row of the matrix is loaded by a group of 4 work items(wi)
+/// row-0: wi0 wi0 wi1 wi1 ... wi3 wi3
+/// row-1: wi4 wi4 wi5 wi5 ... wi7 wi7
+/// ...
+/// row-6: wi24 wi24 wi25 wi25 ... wi27 wi27
+/// row-7: wi28 wi28 wi29 wi29 ... wi31 wi31
+/// Col Major: Each col of the matrix is loaded by a group of 4 work items(wi)
+/// row-0: wi0 wi4 wi8 ... wi28
+/// row-1: wi0 wi4 wi8 ... wi28
+/// ...
+/// row-6: wi3 wi7 wi11 ... wi31
+/// row-7: wi3 wi7 wi11 ... wi31
 /// \tparam [in] T The type of result variable
 /// \param [in] addr The address of the matrix in local memory
 /// \param [in] m The private memory to store the matrix
@@ -2111,8 +2129,25 @@ void ldmatrix(uintptr_t addr, T *m, bool trans = false, unsigned mat = 0) {
   }
 }
 
-/// Loads 2 8x8 b16 matrix from local memory to private memory (32-bits per wi)
-/// Requires the sub-group size of kernel calling this function to be 32
+/// Loads 2 8x8 b16 (256 bytes) matrix from private memory to local memory per
+/// sub-group. Requires the sub-group size of kernel calling this function to
+/// be 32. The first 16 work items of sub-group contain the starting address of
+/// their respective matrix row in 'addr'. After distributing addresses to other
+/// work items, each of the 32 work items load 64-bits (32-bits per matrix) into
+/// 'm1' & 'm2' for a total of 256 bytes. 'trans' specifies to perform a
+/// transposed/non-transposed load by each work item like below
+/// Row Major: Each row of the matrices is loaded by a group of 4 work items(wi)
+/// row-0: wi0 wi0 wi1 wi1 ... wi3 wi3
+/// row-1: wi4 wi4 wi5 wi5 ... wi7 wi7
+/// ...
+/// row-6: wi24 wi24 wi25 wi25 ... wi27 wi27
+/// row-7: wi28 wi28 wi29 wi29 ... wi31 wi31
+/// Col Major: Each col of the matrices is loaded by a group of 4 work items(wi)
+/// row-0: wi0 wi4 wi8 ... wi28
+/// row-1: wi0 wi4 wi8 ... wi28
+/// ...
+/// row-6: wi3 wi7 wi11 ... wi31
+/// row-7: wi3 wi7 wi11 ... wi31
 /// \tparam [in] T The type of result variable
 /// \param [in] addr The address of the matrix in local memory
 /// \param [in] m1 The private memory to store data of 1st matrix
@@ -2126,8 +2161,26 @@ void ldmatrix(uintptr_t addr, T *m1, T *m2, bool trans = false) {
   ldmatrix(addr, m2, trans, 1);
 }
 
-/// Loads 4 8x8 b16 matrix from local memory to private memory (32-bits per wi)
-/// Requires the sub-group size of kernel calling this function to be 32
+/// Loads 4 8x8 b16 (512 bytes) matrix from private memory to local memory per
+/// sub-group. Requires the sub-group size of kernel calling this function to
+/// be 32. Each work item of sub-group contains the starting address of their
+/// respective matrix row in 'addr'.
+/// After distributing addresses to other work items, each of the 32 work items
+/// load 128-bits (32-bits per matrix) into 'm1', 'm2', 'm3' & 'm4' for a total
+/// of 512 bytes. 'trans' specifies to perform a transposed/non-transposed load
+/// by each work item like below
+/// Row Major: Each row of the matrices is loaded by a group of 4 work items(wi)
+/// row-0: wi0 wi0 wi1 wi1 ... wi3 wi3
+/// row-1: wi4 wi4 wi5 wi5 ... wi7 wi7
+/// ...
+/// row-6: wi24 wi24 wi25 wi25 ... wi27 wi27
+/// row-7: wi28 wi28 wi29 wi29 ... wi31 wi31
+/// Col Major: Each col of the matrices is loaded by a group of 4 work items(wi)
+/// row-0: wi0 wi4 wi8 ... wi28
+/// row-1: wi0 wi4 wi8 ... wi28
+/// ...
+/// row-6: wi3 wi7 wi11 ... wi31
+/// row-7: wi3 wi7 wi11 ... wi31
 /// \tparam [in] T The type of result variable
 /// \param [in] addr The address of the matrix in local memory
 /// \param [in] m1 The private memory to store data of 1st matrix