gpu: nvgpu: Update Doxygen comments for gr units

Update  struct nvgpu_fecs_ecc_status comments for doxygen.

Move structures for method, mailbox and cond outside
the nvgpu_fecs_method_op struct, for better doxygen
format. Defining sturct within struct doesnot look
good in doxygen.

Jira NVGPU-4107

Change-Id: I34b2249119e5578c568139f958e6edab9d75d7c8
Signed-off-by: Vinod G <vinodg@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/2219748
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
This commit is contained in:
Vinod G
2019-10-16 16:39:50 -07:00
committed by Alex Waterman
parent 835ef0f3f7
commit 6907aee633
2 changed files with 42 additions and 35 deletions

View File

@@ -85,6 +85,35 @@ enum wait_ucode_status {
/** Mailbox value in case of successful operation. */
#define FALCON_UCODE_HANDSHAKE_INIT_COMPLETE 1U
struct fecs_mthd_op_method {
/** Method address to send to FECS microcontroller. */
u32 addr;
/** Method data to send to FECS microcontroller. */
u32 data;
};
struct fecs_mthd_op_mailbox {
/** Mailbox ID to perform operation. */
u32 id;
/** Mailbox data to be written. */
u32 data;
/** Mailbox clear value. */
u32 clr;
/** Last read mailbox value. */
u32 *ret;
/** Mailbox value in case of operation success. */
u32 ok;
/** Mailbox value in case of operation failure. */
u32 fail;
};
struct fecs_mthd_op_cond {
/** Operation success condition. */
u32 ok;
/** Operation fail condition. */
u32 fail;
};
/**
* FECS method operation structure.
*
@@ -92,34 +121,12 @@ enum wait_ucode_status {
* microcontroller.
*/
struct nvgpu_fecs_method_op {
struct {
/** Method address to send to FECS microcontroller. */
u32 addr;
/** Method data to send to FECS microcontroller. */
u32 data;
} method;
struct {
/** Mailbox ID to perform operation. */
u32 id;
/** Mailbox data to be written. */
u32 data;
/** Mailbox clear value. */
u32 clr;
/** Last read mailbox value. */
u32 *ret;
/** Mailbox value in case of operation success. */
u32 ok;
/** Mailbox value in case of operation failure. */
u32 fail;
} mailbox;
struct {
/** Operation success condition. */
u32 ok;
/** Operation fail condition. */
u32 fail;
} cond;
/** Method struct */
struct fecs_mthd_op_method method;
/** Mailbox struct */
struct fecs_mthd_op_mailbox mailbox;
/** Condition struct */
struct fecs_mthd_op_cond cond;
};
/**

View File

@@ -138,19 +138,19 @@ struct nvgpu_fecs_host_intr_status {
* Book keeping for ECC errors originating from FECS.
*/
struct nvgpu_fecs_ecc_status {
/* This flag is set if IMEM corrected error is hit. */
/** This flag is set if IMEM corrected error is hit. */
bool imem_corrected_err;
/* This flag is set if IMEM uncorrected error is hit. */
/** This flag is set if IMEM uncorrected error is hit. */
bool imem_uncorrected_err;
/* This flag is set if DMEM corrected error is hit. */
/** This flag is set if DMEM corrected error is hit. */
bool dmem_corrected_err;
/* This flag is set if DMEM uncorrected error is hit. */
/** This flag is set if DMEM uncorrected error is hit. */
bool dmem_uncorrected_err;
/* Address of memory where ECC error occurred. */
/** Address of memory where ECC error occurred. */
u32 ecc_addr;
/* Number of corrected ECC errors. */
/** Number of corrected ECC errors. */
u32 corrected_delta;
/* Number of uncorrected ECC errors. */
/** Number of uncorrected ECC errors. */
u32 uncorrected_delta;
};