gpu: nvgpu: fb: update doxygen for BVEC checks

Update doxygen to have boundary value check info for
input params in common.fb.

Jira NVGPU-6183

Change-Id: Ic07a7688c457c68ba7e9ef96ca8b3bf4145b8236
Signed-off-by: Seshendra Gadagottu <sgadagottu@nvidia.com>
(cherry picked from commit 84f7954eaf499f38af8590a4a1309e0c1f7448bf)
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2485995
Reviewed-by: Automatic_Commit_Validation_User
Reviewed-by: Alex Waterman <alexw@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
GVS: Gerrit_Virtual_Submit
This commit is contained in:
Seshendra Gadagottu
2021-02-04 22:43:55 -08:00
committed by mobile promotions
parent f5b6c012cb
commit c021b18fb1

View File

@@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2019-2020, NVIDIA CORPORATION. All rights reserved. * Copyright (c) 2019-2021, NVIDIA CORPORATION. All rights reserved.
* *
* Permission is hereby granted, free of charge, to any person obtaining a * Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"), * copy of this software and associated documentation files (the "Software"),
@@ -335,7 +335,8 @@ struct gops_fb {
* @brief Check if mmu fault buffer is enabled or not * @brief Check if mmu fault buffer is enabled or not
* *
* @param g [in] Pointer to GPU driver struct. * @param g [in] Pointer to GPU driver struct.
* @param index [in] Fault buffer index. * @param index [in] Fault buffer index. Valid index value:
* NVGPU_MMU_FAULT_NONREPLAY_REG_INDX
* *
* This function checks and returns whether fault buffer is enabled * This function checks and returns whether fault buffer is enabled
* for specified index. * for specified index.
@@ -348,7 +349,8 @@ struct gops_fb {
* @brief Setup mmu fault buffer state. * @brief Setup mmu fault buffer state.
* *
* @param g [in] Pointer to GPU driver struct. * @param g [in] Pointer to GPU driver struct.
* @param index [in] Fault buffer index. * @param index [in] Fault buffer index. Valid index value:
* NVGPU_MMU_FAULT_NONREPLAY_REG_INDX
* @param state [in] NVGPU_MMU_FAULT_BUF_ENABLED or * @param state [in] NVGPU_MMU_FAULT_BUF_ENABLED or
* NVGPU_MMU_FAULT_BUF_DISABLED * NVGPU_MMU_FAULT_BUF_DISABLED
* *