From bf5fd03a10ca618a43739c7a4b971ac82391c00d Mon Sep 17 00:00:00 2001 From: Rajesh Devaraj Date: Thu, 7 Jan 2021 13:31:08 +0530 Subject: [PATCH] gpu: nvgpu: update doxygen for error reporting 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 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 Reviewed-by: Vaibhav Kachore Reviewed-by: mobile promotions GVS: Gerrit_Virtual_Submit Tested-by: mobile promotions --- drivers/gpu/nvgpu/include/nvgpu/nvgpu_err.h | 60 ++++++++++++++------- 1 file changed, 42 insertions(+), 18 deletions(-) diff --git a/drivers/gpu/nvgpu/include/nvgpu/nvgpu_err.h b/drivers/gpu/nvgpu/include/nvgpu/nvgpu_err.h index 205d51dc7..b7b4a2f7c 100644 --- a/drivers/gpu/nvgpu/include/nvgpu/nvgpu_err.h +++ b/drivers/gpu/nvgpu/include/nvgpu/nvgpu_err.h @@ -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 * 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 * information. Declare prototype for APIs that are used to report GPU HW errors - * to the 3LSS framework. + * to the Safety_Services framework. */ #include @@ -348,8 +348,11 @@ struct nvgpu_hw_err_inject_info_desc { * - Performs compile-time assert check to ensure that the size of the error * packet does not exceed the maximum allowable size specified in * #MAX_ERR_MSG_SIZE. - * - Sends the error packet to report the error to the 3LSS framework. In case - * of a failure, invokes #nvgpu_sdl_handle_report_failure() api. + * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into + * 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 */ @@ -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 * packet does not exceed the maximum allowable size specified in * #MAX_ERR_MSG_SIZE. - * - Sends the error packet to report the error to the 3LSS framework. In case - * of a failure, invokes #nvgpu_sdl_handle_report_failure() api. + * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into + * 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 */ @@ -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 * packet does not exceed the maximum allowable size specified in * #MAX_ERR_MSG_SIZE. - * - Sends the error packet to report the error to the 3LSS framework. In case - * of a failure, invokes #nvgpu_sdl_handle_report_failure() api. + * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into + * 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 */ @@ -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 * packet does not exceed the maximum allowable size specified in * #MAX_ERR_MSG_SIZE. - * - Sends the error packet to report the error to the 3LSS framework. In case - * of a failure, invokes #nvgpu_sdl_handle_report_failure() api. + * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into + * 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 */ @@ -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 * packet does not exceed the maximum allowable size specified in * #MAX_ERR_MSG_SIZE. - * - Sends the error packet to report the error to the 3LSS framework. In case - * of a failure, invokes #nvgpu_sdl_handle_report_failure() api. + * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into + * 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 */ @@ -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 * packet does not exceed the maximum allowable size specified in * #MAX_ERR_MSG_SIZE. - * - Sends the error packet to report the error to the 3LSS framework. In case - * of a failure, invokes #nvgpu_sdl_handle_report_failure() api. + * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into + * 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 */ @@ -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 * packet does not exceed the maximum allowable size specified in * #MAX_ERR_MSG_SIZE. - * - Sends the error packet to report the error to the 3LSS framework. In case - * of a failure, invokes #nvgpu_sdl_handle_report_failure() api. + * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into + * 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 */ @@ -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 * packet does not exceed the maximum allowable size specified in * #MAX_ERR_MSG_SIZE. - * - Sends the error packet to report the error to the 3LSS framework. In case - * of a failure, invokes #nvgpu_sdl_handle_report_failure() api. + * - Invokes #nvgpu_sdl_report_error_rmos() to enqueue the error packet into + * 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 */