From 8ce1f48e2e4fcbf2326e392485058d114b2c9be5 Mon Sep 17 00:00:00 2001 From: Deepak Nibade Date: Tue, 7 Dec 2021 20:59:27 +0530 Subject: [PATCH] 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 Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2640082 Tested-by: mobile promotions Reviewed-by: mobile promotions GVS: Gerrit_Virtual_Submit --- drivers/gpu/nvgpu/include/nvgpu/gr/config.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/drivers/gpu/nvgpu/include/nvgpu/gr/config.h b/drivers/gpu/nvgpu/include/nvgpu/gr/config.h index 15a2eedd0..4ff84f613 100644 --- a/drivers/gpu/nvgpu/include/nvgpu/gr/config.h +++ b/drivers/gpu/nvgpu/include/nvgpu/gr/config.h @@ -52,6 +52,12 @@ struct nvgpu_gr_config; * * 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, * NULL in case of failure. */