gpu: nvgpu: add doxygen comments for CE unit

Add doxygen description for function nvgpu_ce_init_support.

JIRA NVGPU-4143

Change-Id: Ieab26ead55dfe389b30fe4deea9c381c57063132
Signed-off-by: Sagar Kamble <skamble@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/2221661
Reviewed-by: Automatic_Commit_Validation_User
GVS: Gerrit_Virtual_Submit
Reviewed-by: Philip Elcan <pelcan@nvidia.com>
Reviewed-by: Alex Waterman <alexw@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
This commit is contained in:
Sagar Kamble
2019-10-18 15:49:57 +05:30
committed by Alex Waterman
parent 6fe794bc98
commit b66981043e
2 changed files with 49 additions and 0 deletions

View File

@@ -22,8 +22,56 @@
#ifndef NVGPU_CE_H
#define NVGPU_CE_H
/**
* @file
* @page unit-ce Unit CE
*
* Overview
* ========
*
* The CE unit is responsible for initializing the copy engines. The GPU has two
* types of copy engines, GRCE and LCE.
*
* Data Structures
* ===============
* NA
*
* Static Design
* =============
*
* CE Initialization
* -----------------
* The CE unit resets the copy engines at Master Control (MC) level and programs
* the production clock gating and configuration options for copy engines.
*
* External APIs
* -------------
* + nvgpu_ce_init_support()
*
* Dynamic Design
* ==============
* NA
*/
struct gk20a;
/**
* @brief Initialize the CE support.
*
* @param g [in] The GPU driver struct.
*
* This function is invoked during #nvgpu_finalize_poweron to initialize the
* copy engines.
*
* Steps:
* - Get the reset mask for all copy engines.
* - Reset the engines at master control level through mc_enable_r.
* - Load Second Level Clock Gating (SLCG) configuration for copy engine.
* - Load Block Level Clock Gating (BLCG) configuration for copy engine.
* - Initialize configuration options for LCEs. FORCE_BARRIERS_NPL is set.
*
* @return 0 in case of success, < 0 in case of failure.
*/
int nvgpu_ce_init_support(struct gk20a *g);
#endif /*NVGPU_CE_H*/

View File

@@ -33,6 +33,7 @@
* Welcome to the nvgpu unit design documentation. The following pages document
* the major top level units within nvgpu-common:
*
* - @ref unit-ce
* - @ref unit-mm
* - @ref unit-fifo
* - @ref unit-gr