gpu: nvgpu: update doxygen comments for utils

Update the doxygen comments for common utils unit.

Jira NVGPU-6236

Change-Id: I2d842baaf2efea66673f700b6926c6a16b468bbd
Signed-off-by: ajesh <akv@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2457841
(cherry picked from commit 88b83544696c350933082c8c88bce985837213ac)
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2459913
GVS: Gerrit_Virtual_Submit
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
Reviewed-by: Rajesh Devaraj <rdevaraj@nvidia.com>
Reviewed-by: Vaibhav Kachore <vkachore@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
This commit is contained in:
ajesh
2020-12-10 08:39:22 +03:00
committed by mobile promotions
parent 65111b64f2
commit d0e76cc4a3
5 changed files with 74 additions and 31 deletions

View File

@@ -221,7 +221,10 @@ enum enum_enabled_flags {
* @param g [in] The GPU.
* @param flag [in] Which flag to check.
*
* @retrun true if the passed \a flag is true; false otherwise.
* @return Boolean value to indicate the status of the bit.
*
* @retval TRUE if the flag bit is enabled.
* @retval FALSE if the flag bit is not enabled.
*/
bool nvgpu_is_enabled(struct gk20a *g, u32 flag);
@@ -248,6 +251,7 @@ void nvgpu_set_enabled(struct gk20a *g, u32 flag, bool state);
* @param g [in] The GPU superstructure.
*
* @return 0 for success, < 0 for error.
*
* @retval -ENOMEM if fails to allocate the necessary memory.
*/
int nvgpu_init_enabled_flags(struct gk20a *g);