nv-tegra-mirror/linux-nvgpu
1
0
Fork 0
mirror of git://nv-tegra.nvidia.com/linux-nvgpu.git synced 2025-12-24 02:22:34 +03:00
Code Issues Packages Projects Releases Wiki Activity

gpu: nvgpu: pmu: update doxygen for gops_pmu

Browse Source 
This changes the doxygen for the gops_pmu to expose only the public APIs
to sphinx by using @cond/@endcond constructs to exclude private APIs.

JIRA NVGPU-4293

Change-Id: I3047dc4ac107f3a890bfedb3e38990c88392fc72
Signed-off-by: Philip Elcan <pelcan@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/2236665
Reviewed-by: Mahantesh Kumbar <mkumbar@nvidia.com>
Reviewed-by: Automatic_Commit_Validation_User
Reviewed-by: Seshendra Gadagottu <sgadagottu@nvidia.com>
GVS: Gerrit_Virtual_Submit
Tested-by: Mahantesh Kumbar <mkumbar@nvidia.com>
Reviewed-by: Vijayakumar Subbu <vsubbu@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
This commit is contained in:
Philip Elcan
2019-11-11 09:57:38 -05:00
committed by Alex Waterman
parent 03c2d969c2
commit c1b8da27f2
1 changed files with 45 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
drivers/gpu/nvgpu/include/nvgpu/gops_pmu.h
View File

@@ -37,6 +37,8 @@ struct nvgpu_hw_err_inject_info_desc;
* @see gpu_ops
*/
struct gops_pmu {
/** @cond DOXYGEN_SHOULD_SKIP_THIS */
/**
* @brief PMU early initialization to allocate memory for PMU unit,
* set PMU Engine h/w properties and set supporting data structs.
@@ -56,7 +58,6 @@ struct gops_pmu {
*/
int (*pmu_early_init)(struct gk20a *g);
/** @cond DOXYGEN_SHOULD_SKIP_THIS */
#ifdef CONFIG_NVGPU_LS_PMU
int (*pmu_rtos_init)(struct gk20a *g);
int (*pmu_destroy)(struct gk20a *g, struct nvgpu_pmu *pmu);
@@ -66,7 +67,6 @@ struct gops_pmu {
struct nvgpu_hw_err_inject_info_desc * (*get_pmu_err_desc)
(struct gk20a *g);
/** @endcond */
/**
* @brief To know PMU Engine complete support is required or not.
@@ -90,15 +90,6 @@ struct gops_pmu {
*/
bool (*is_pmu_supported)(struct gk20a *g);
/**
* @brief Fetch base address of PMU Engine Falcon.
*
* @param void
*
* @return address.
*/
u32 (*falcon_base_addr)(void);
/**
* @brief Reset the PMU Engine.
*
@@ -157,6 +148,37 @@ struct gops_pmu {
*/
void (*write_dmatrfbase)(struct gk20a *g, u32 addr);
/**
* @brief Start PMU falcon CPU in secure mode.
*
* @param g [in] The GPU driver struct.
*
* Start PMU falcon CPU in secure mode by writing true to
* CPUCTL_ALIAS.
*/
void (*secured_pmu_start)(struct gk20a *g);
/**
* @brief Clears the PMU BAR0 error status.
*
* @param g [in] The GPU driver struct.
*
* Clears the PMU BAR0 error status by reading status
* and writing back.
*/
void (*pmu_clear_bar0_host_err_status)(struct gk20a *g);
/** @endcond */
/**
* @brief Fetch base address of PMU Engine Falcon.
*
* @param void
*
* @return address.
*/
u32 (*falcon_base_addr)(void);
/**
* @brief Checks if PMU DEBUG fuse is blown or not
*
@@ -172,16 +194,6 @@ struct gops_pmu {
*/
bool (*is_debug_mode_enabled)(struct gk20a *g);
/**
* @brief Start PMU falcon CPU in secure mode.
*
* @param g [in] The GPU driver struct.
*
* Start PMU falcon CPU in secure mode by writing true to
* CPUCTL_ALIAS.
*/
void (*secured_pmu_start)(struct gk20a *g);
/**
* @brief Setup required configuration for PMU Engine Falcon boot.
*
@@ -196,28 +208,6 @@ struct gops_pmu {
*/
void (*flcn_setup_boot_config)(struct gk20a *g);
/**
* @brief Validate IMEM/DMEM memory integrity.
*
* @param g [in] The GPU driver struct.
*
* Validate IMEM/DMEM memory integrity by checking ECC status
* followed IMEM/DEME error correction status check.
*
* return True if corrected else False.
*/
bool (*validate_mem_integrity)(struct gk20a *g);
/**
* @brief Clears the PMU BAR0 error status.
*
* @param g [in] The GPU driver struct.
*
* Clears the PMU BAR0 error status by reading status
* and writing back.
*/
void (*pmu_clear_bar0_host_err_status)(struct gk20a *g);
/**
* @brief Check for the PMU BAR0 error status.
*
@@ -264,6 +254,18 @@ struct gops_pmu {
int (*bar0_error_status)(struct gk20a *g, u32 *bar0_status,
u32 *etype);
/**
* @brief Validate IMEM/DMEM memory integrity.
*
* @param g [in] The GPU driver struct.
*
* Validate IMEM/DMEM memory integrity by checking ECC status
* followed IMEM/DEME error correction status check.
*
* return True if corrected else False.
*/
bool (*validate_mem_integrity)(struct gk20a *g);
/** @cond DOXYGEN_SHOULD_SKIP_THIS */
#ifdef CONFIG_NVGPU_LS_PMU
/* ISR */