nv-tegra-mirror/linux-nvgpu
1
0
Fork 0
mirror of git://nv-tegra.nvidia.com/linux-nvgpu.git synced 2025-12-23 09:57:08 +03:00
Code Issues Packages Projects Releases Wiki Activity

gpu: nvgpu: update doxygen for error reporting

Browse Source 
This patch updates the doxygen documentation for error reporting
related APIs to address review comments for SDL SWUD.

JIRA NVGPU-6181

Change-Id: Ic937492cd539bdb1bce6eb1bc7b02ec1c07b69e4
Signed-off-by: Rajesh Devaraj <rdevaraj@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2467194
(cherry picked from commit 5b188895c29895042bdd660ba5e10bf161bf21e4)
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2468255
Reviewed-by: Automatic_Commit_Validation_User
Reviewed-by: Dinesh T <dt@nvidia.com>
Reviewed-by: Vaibhav Kachore <vkachore@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
GVS: Gerrit_Virtual_Submit
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
This commit is contained in:
Rajesh Devaraj
2021-01-07 13:31:08 +05:30
committed by mobile promotions
parent 76f766d6ac
commit bf5fd03a10
1 changed files with 42 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
drivers/gpu/nvgpu/include/nvgpu/nvgpu_err.h
View File

@@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2017-2020, NVIDIA CORPORATION. All rights reserved. * Copyright (c) 2017-2021, NVIDIA CORPORATION. All rights reserved.
* *
* Permission is hereby granted, free of charge, to any person obtaining a * Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"), * copy of this software and associated documentation files (the "Software"),
@@ -28,7 +28,7 @@
* *
* Define indices for HW units and errors. Define structures used to carry error * Define indices for HW units and errors. Define structures used to carry error
* information. Declare prototype for APIs that are used to report GPU HW errors * information. Declare prototype for APIs that are used to report GPU HW errors
* to the 3LSS framework. * to the Safety_Services framework.
*/ */
#include <nvgpu/types.h> #include <nvgpu/types.h>
@@ -348,8 +348,11 @@ struct nvgpu_hw_err_inject_info_desc {
* - Performs compile-time assert check to ensure that the size of the error * - Performs compile-time assert check to ensure that the size of the error
* packet does not exceed the maximum allowable size specified in * packet does not exceed the maximum allowable size specified in
* #MAX_ERR_MSG_SIZE. * #MAX_ERR_MSG_SIZE.
* - Sends the error packet to report the error to the 3LSS framework. In case * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into
* of a failure, invokes #nvgpu_sdl_handle_report_failure() api. * error message queue. In case of any failure during this enqueue operation,
* #nvgpu_sdl_handle_report_failure() api is invoked to handle the failure.
* - The error packet will be dequeued from the error message queue and reported
* to Safety_Services by #nvgpu_sdl_worker thread.
* *
* @return None * @return None
*/ */
@@ -388,8 +391,11 @@ void nvgpu_report_host_err(struct gk20a *g, u32 hw_unit,
* - Performs compile-time assert check to ensure that the size of the error * - Performs compile-time assert check to ensure that the size of the error
* packet does not exceed the maximum allowable size specified in * packet does not exceed the maximum allowable size specified in
* #MAX_ERR_MSG_SIZE. * #MAX_ERR_MSG_SIZE.
* - Sends the error packet to report the error to the 3LSS framework. In case * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into
* of a failure, invokes #nvgpu_sdl_handle_report_failure() api. * error message queue. In case of any failure during this enqueue operation,
* #nvgpu_sdl_handle_report_failure() api is invoked to handle the failure.
* - The error packet will be dequeued from the error message queue and reported
* to Safety_Services by #nvgpu_sdl_worker thread.
* *
* @return None * @return None
*/ */
@@ -460,8 +466,11 @@ void nvgpu_report_ce_err(struct gk20a *g, u32 hw_unit,
* - Performs compile-time assert check to ensure that the size of the error * - Performs compile-time assert check to ensure that the size of the error
* packet does not exceed the maximum allowable size specified in * packet does not exceed the maximum allowable size specified in
* #MAX_ERR_MSG_SIZE. * #MAX_ERR_MSG_SIZE.
* - Sends the error packet to report the error to the 3LSS framework. In case * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into
* of a failure, invokes #nvgpu_sdl_handle_report_failure() api. * error message queue. In case of any failure during this enqueue operation,
* #nvgpu_sdl_handle_report_failure() api is invoked to handle the failure.
* - The error packet will be dequeued from the error message queue and reported
* to Safety_Services by #nvgpu_sdl_worker thread.
* *
* @return None * @return None
*/ */
@@ -519,8 +528,11 @@ static inline void nvgpu_report_fb_ecc_err(struct gk20a *g, u32 err_id, u64 err_
* - Performs compile-time assert check to ensure that the size of the error * - Performs compile-time assert check to ensure that the size of the error
* packet does not exceed the maximum allowable size specified in * packet does not exceed the maximum allowable size specified in
* #MAX_ERR_MSG_SIZE. * #MAX_ERR_MSG_SIZE.
* - Sends the error packet to report the error to the 3LSS framework. In case * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into
* of a failure, invokes #nvgpu_sdl_handle_report_failure() api. * error message queue. In case of any failure during this enqueue operation,
* #nvgpu_sdl_handle_report_failure() api is invoked to handle the failure.
* - The error packet will be dequeued from the error message queue and reported
* to Safety_Services by #nvgpu_sdl_worker thread.
* *
* @return None * @return None
*/ */
@@ -570,8 +582,11 @@ void nvgpu_report_ctxsw_err(struct gk20a *g, u32 hw_unit, u32 err_id,
* - Performs compile-time assert check to ensure that the size of the error * - Performs compile-time assert check to ensure that the size of the error
* packet does not exceed the maximum allowable size specified in * packet does not exceed the maximum allowable size specified in
* #MAX_ERR_MSG_SIZE. * #MAX_ERR_MSG_SIZE.
* - Sends the error packet to report the error to the 3LSS framework. In case * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into
* of a failure, invokes #nvgpu_sdl_handle_report_failure() api. * error message queue. In case of any failure during this enqueue operation,
* #nvgpu_sdl_handle_report_failure() api is invoked to handle the failure.
* - The error packet will be dequeued from the error message queue and reported
* to Safety_Services by #nvgpu_sdl_worker thread.
* *
* @return None * @return None
*/ */
@@ -606,8 +621,11 @@ void nvgpu_report_gr_err(struct gk20a *g, u32 hw_unit, u32 inst,
* - Performs compile-time assert check to ensure that the size of the error * - Performs compile-time assert check to ensure that the size of the error
* packet does not exceed the maximum allowable size specified in * packet does not exceed the maximum allowable size specified in
* #MAX_ERR_MSG_SIZE. * #MAX_ERR_MSG_SIZE.
* - Sends the error packet to report the error to the 3LSS framework. In case * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into
* of a failure, invokes #nvgpu_sdl_handle_report_failure() api. * error message queue. In case of any failure during this enqueue operation,
* #nvgpu_sdl_handle_report_failure() api is invoked to handle the failure.
* - The error packet will be dequeued from the error message queue and reported
* to Safety_Services by #nvgpu_sdl_worker thread.
* *
* @return None * @return None
*/ */
@@ -649,8 +667,11 @@ void nvgpu_report_pmu_err(struct gk20a *g, u32 hw_unit, u32 err_id,
* - Performs compile-time assert check to ensure that the size of the error * - Performs compile-time assert check to ensure that the size of the error
* packet does not exceed the maximum allowable size specified in * packet does not exceed the maximum allowable size specified in
* #MAX_ERR_MSG_SIZE. * #MAX_ERR_MSG_SIZE.
* - Sends the error packet to report the error to the 3LSS framework. In case * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into
* of a failure, invokes #nvgpu_sdl_handle_report_failure() api. * error message queue. In case of any failure during this enqueue operation,
* #nvgpu_sdl_handle_report_failure() api is invoked to handle the failure.
* - The error packet will be dequeued from the error message queue and reported
* to Safety_Services by #nvgpu_sdl_worker thread.
* *
* @return None * @return None
*/ */
@@ -687,8 +708,11 @@ void nvgpu_report_pri_err(struct gk20a *g, u32 hw_unit, u32 inst,
* - Performs compile-time assert check to ensure that the size of the error * - Performs compile-time assert check to ensure that the size of the error
* packet does not exceed the maximum allowable size specified in * packet does not exceed the maximum allowable size specified in
* #MAX_ERR_MSG_SIZE. * #MAX_ERR_MSG_SIZE.
* - Sends the error packet to report the error to the 3LSS framework. In case * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into
* of a failure, invokes #nvgpu_sdl_handle_report_failure() api. * error message queue. In case of any failure during this enqueue operation,
* #nvgpu_sdl_handle_report_failure() api is invoked to handle the failure.
* - The error packet will be dequeued from the error message queue and reported
* to Safety_Services by #nvgpu_sdl_worker thread.
* *
* @return None * @return None
*/ */