gpu: nvgpu: update doxygen for nvgpu_gr_config_init

Update doxygen for function nvgpu_gr_config_init() and add reasons on
why GR engine configuration initialization could fail.

Bug 3465555
Jira PLCF-2832

Change-Id: Idcb54883c8d086ff8173cae651d8072b4dcd4625
Signed-off-by: Deepak Nibade <dnibade@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2640082
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
GVS: Gerrit_Virtual_Submit
This commit is contained in:
Deepak Nibade
2021-12-07 20:59:27 +05:30
committed by mobile promotions
parent 9446cfa320
commit 8ce1f48e2e

View File

@@ -52,6 +52,12 @@ struct nvgpu_gr_config;
* *
* This unit also exposes APIs to query each of above configuration data. * This unit also exposes APIs to query each of above configuration data.
* *
* If incorrect or unexpected GR engine configuration is read (examples
* below) initialization is aborted and NULL is returned.
* - GPC count is 0.
* - SM count per TPC is 0.
* - PES count per GPC is more than #GK20A_GR_MAX_PES_PER_GPC.
*
* @return pointer to nvgpu_gr_config struct in case of success, * @return pointer to nvgpu_gr_config struct in case of success,
* NULL in case of failure. * NULL in case of failure.
*/ */