diff --git a/drivers/gpu/nvgpu/include/nvgpu/defaults.h b/drivers/gpu/nvgpu/include/nvgpu/defaults.h index 0babea7bd..09ef75c60 100644 --- a/drivers/gpu/nvgpu/include/nvgpu/defaults.h +++ b/drivers/gpu/nvgpu/include/nvgpu/defaults.h @@ -23,13 +23,35 @@ #ifndef NVGPU_DEFAULTS_H #define NVGPU_DEFAULTS_H -/* - * Default timeout used for channel watchdog and ctxsw timeout. +/** + * @defgroup NVGPU_COMMON_DEFAULTS + * + * Default values used in NvGPU for timeouts, inits, etc. + */ + +/** + * @ingroup NVGPU_COMMON_DEFAULTS + * + * The default timeout value defined in msec and used on a silicon + * platform. This timeout value is used for channel watchdog, ctxsw timeouts, gr + * timeouts, etc. */ #define NVGPU_DEFAULT_POLL_TIMEOUT_MS 3000 +/** + * @ingroup NVGPU_COMMON_DEFAULTS + * + * The default timeout value defined in msec and used for railgate delay. This + * defines a value for auto-suspend delay. + */ #define NVGPU_DEFAULT_RAILGATE_IDLE_TIMEOUT 500 +/** + * @ingroup NVGPU_COMMON_DEFAULTS + * + * The default timeout value defined in msec and used on FPGA platform. This + * timeout value is used at places similar to NVGPU_DEFAULT_POLL_TIMEOUT_MS. + */ #define NVGPU_DEFAULT_FPGA_TIMEOUT_MS 100000U /* 100 sec */ #endif /* NVGPU_DEFAULTS_H */