gpu: nvgpu: update doxygen for common.ecc unit

Updated doxygen comments for common.ecc unit functions to better
describe return values.

Jira NVGPU-6248

Change-Id: I36e94d7e41e28072c4bb0699024724e25fe3b35c
Signed-off-by: Antony Clince Alex <aalex@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2456423
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
This commit is contained in:
Antony Clince Alex
2020-12-08 11:52:49 +05:30
committed by Alex Waterman
parent ee7cdf1fff
commit 48265944c4

View File

@@ -275,6 +275,7 @@ struct nvgpu_ecc {
* of struct nvgpu_ecc.
*
* @return 0 in case of success, less than 0 for failure.
* @return -ENOMEM if there is not enough memory to allocate ecc stats.
*/
int nvgpu_ecc_counter_init(struct gk20a *g,
struct nvgpu_ecc_stat **stat, const char *name);
@@ -325,6 +326,8 @@ void nvgpu_ecc_remove_support(struct gk20a *g);
* @param g [in] The GPU driver struct.
*
* Sets ecc.initialized to true.
*
* @return 0 in all cases.
*/
int nvgpu_ecc_finalize_support(struct gk20a *g);