On Thu, Oct 04, 2018 at 09:05:21PM +0530, Manish Narani wrote: > There are some comments which can be updated for better readability of > the driver. Update abbreviations to capital letters in the comments. > > Signed-off-by: Manish Narani <manish.narani@xxxxxxxxxx> > --- > drivers/edac/synopsys_edac.c | 98 ++++++++++++++++++++++---------------------- > 1 file changed, 48 insertions(+), 50 deletions(-) From: Manish Narani <manish.narani@xxxxxxxxxx> Date: Thu, 4 Oct 2018 21:05:21 +0530 Subject: [PATCH 2/2] EDAC, synopsys: Correct comments Spellcheck and improve/correct comments. Signed-off-by: Manish Narani <manish.narani@xxxxxxxxxx> Signed-off-by: Borislav Petkov <bp@xxxxxxx> CC: Mauro Carvalho Chehab <mchehab@xxxxxxxxxx> CC: Michal Simek <michal.simek@xxxxxxxxxx> CC: amit.kucheria@xxxxxxxxxx CC: devicetree@xxxxxxxxxxxxxxx CC: leoyang.li@xxxxxxx CC: linux-arm-kernel@xxxxxxxxxxxxxxxxxxx CC: linux-edac <linux-edac@xxxxxxxxxxxxxxx> CC: mark.rutland@xxxxxxx CC: michal.simek@xxxxxxxxxx CC: robh+dt@xxxxxxxxxx CC: sudeep.holla@xxxxxxx Link: http://lkml.kernel.org/r/1538667328-9465-4-git-send-email-manish.narani@xxxxxxxxxx --- drivers/edac/synopsys_edac.c | 104 +++++++++++++++++------------------ 1 file changed, 51 insertions(+), 53 deletions(-) diff --git a/drivers/edac/synopsys_edac.c b/drivers/edac/synopsys_edac.c index fbaf33540ce3..b4666310a5f6 100644 --- a/drivers/edac/synopsys_edac.c +++ b/drivers/edac/synopsys_edac.c @@ -96,12 +96,12 @@ #define SCRUB_MODE_SECDED 0x4 /** - * struct ecc_error_info - ECC error log information - * @row: Row number - * @col: Column number - * @bank: Bank number - * @bitpos: Bit position - * @data: Data causing the error + * struct ecc_error_info - ECC error log information. + * @row: Row number. + * @col: Column number. + * @bank: Bank number. + * @bitpos: Bit position. + * @data: Data causing the error. */ struct ecc_error_info { u32 row; @@ -112,11 +112,11 @@ struct ecc_error_info { }; /** - * struct synps_ecc_status - ECC status information to report - * @ce_cnt: Correctable error count - * @ue_cnt: Uncorrectable error count - * @ceinfo: Correctable error log information - * @ueinfo: Uncorrectable error log information + * struct synps_ecc_status - ECC status information to report. + * @ce_cnt: Correctable error count. + * @ue_cnt: Uncorrectable error count. + * @ceinfo: Correctable error log information. + * @ueinfo: Uncorrectable error log information. */ struct synps_ecc_status { u32 ce_cnt; @@ -126,12 +126,12 @@ struct synps_ecc_status { }; /** - * struct synps_edac_priv - DDR memory controller private instance data - * @baseaddr: Base address of the DDR controller - * @message: Buffer for framing the event specific info - * @stat: ECC status information - * @ce_cnt: Correctable Error count - * @ue_cnt: Uncorrectable Error count + * struct synps_edac_priv - DDR memory controller private instance data. + * @baseaddr: Base address of the DDR controller. + * @message: Buffer for framing the event specific info. + * @stat: ECC status information. + * @ce_cnt: Correctable Error count. + * @ue_cnt: Uncorrectable Error count. */ struct synps_edac_priv { void __iomem *baseaddr; @@ -142,13 +142,11 @@ struct synps_edac_priv { }; /** - * get_error_info - Get the current ecc error info - * @base: Pointer to the base address of the ddr memory controller - * @p: Pointer to the synopsys ecc status structure + * get_error_info - Get the current ECC error info. + * @base: Base address of the DDR memory controller. + * @p: Synopsys ECC status structure. * - * Determines there is any ecc error or not - * - * Return: one if there is no error otherwise returns zero + * Return: one if there is no error otherwise zero. */ static int get_error_info(void __iomem *base, struct synps_ecc_status *p) { @@ -195,11 +193,11 @@ static int get_error_info(void __iomem *base, struct synps_ecc_status *p) } /** - * handle_error - Handle controller error types CE and UE - * @mci: Pointer to the edac memory controller instance - * @p: Pointer to the synopsys ecc status structure + * handle_error - Handle Correctable and Uncorrectable errors. + * @mci: EDAC memory controller instance. + * @p: Synopsys ECC status structure. * - * Handles the controller ECC correctable and uncorrectable error. + * Handles ECC correctable and uncorrectable errors. */ static void handle_error(struct mem_ctl_info *mci, struct synps_ecc_status *p) { @@ -230,10 +228,10 @@ static void handle_error(struct mem_ctl_info *mci, struct synps_ecc_status *p) } /** - * check_errors - Check controller for ECC errors - * @mci: Pointer to the edac memory controller instance + * check_errors - Check controller for ECC errors. + * @mci: EDAC memory controller instance. * - * Used to check and post ECC errors. Called by the polling thread + * Check and post ECC errors. Called by the polling thread. */ static void check_errors(struct mem_ctl_info *mci) { @@ -253,8 +251,8 @@ static void check_errors(struct mem_ctl_info *mci) } /** - * get_dtype - Return the controller memory width - * @base: Pointer to the ddr memory controller base address + * get_dtype - Return the controller memory width. + * @base: DDR memory controller base address. * * Get the EDAC device type width appropriate for the current controller * configuration. @@ -284,12 +282,12 @@ static enum dev_type get_dtype(const void __iomem *base) } /** - * get_ecc_state - Return the controller ECC enable/disable status - * @base: Pointer to the DDR memory controller base address + * get_ecc_state - Return the controller ECC enable/disable status. + * @base: DDR memory controller base address. * - * Get the ECC enable/disable status for the controller. + * Get the ECC enable/disable status of the controller. * - * Return: a ECC status boolean i.e true/false - enabled/disabled. + * Return: true if enabled, otherwise false. */ static bool get_ecc_state(void __iomem *base) { @@ -309,9 +307,9 @@ static bool get_ecc_state(void __iomem *base) } /** - * get_memsize - reads the size of the attached memory device + * get_memsize - Read the size of the attached memory device. * - * Return: the memory size in bytes + * Return: the memory size in bytes. */ static u32 get_memsize(void) { @@ -323,8 +321,8 @@ static u32 get_memsize(void) } /** - * get_mtype - Returns controller memory type - * @base: pointer to the synopsys ecc status structure + * get_mtype - Return the controller memory type. + * @base: Synopsys ECC status structure. * * Get the EDAC memory type appropriate for the current controller * configuration. @@ -347,11 +345,11 @@ static enum mem_type get_mtype(const void __iomem *base) } /** - * init_csrows - Initialize the cs row data - * @mci: Pointer to the edac memory controller instance + * init_csrows - Initialize the csrow data. + * @mci: EDAC memory controller instance. * - * Initializes the chip select rows associated with the EDAC memory - * controller instance + * Initialize the chip select rows associated with the EDAC memory + * controller instance. * * Return: Unconditionally 0. */ @@ -381,11 +379,11 @@ static int init_csrows(struct mem_ctl_info *mci) } /** - * mc_init - Initialize driver instance - * @mci: Pointer to the edac memory controller instance - * @pdev: Pointer to the platform_device struct + * mc_init - Initialize one driver instance. + * @mci: EDAC memory controller instance. + * @pdev: platform device. * - * Performs initialization of the EDAC memory controller instance and + * Perform initialization of the EDAC memory controller instance and * related driver-private data associated with the memory controller the * instance is bound to. * @@ -421,10 +419,10 @@ static int mc_init(struct mem_ctl_info *mci, struct platform_device *pdev) } /** - * mc_probe - Check controller and bind driver - * @pdev: Pointer to the platform_device struct + * mc_probe - Check controller and bind driver. + * @pdev: platform device. * - * Probes a specific controller instance for binding with the driver. + * Probe a specific controller instance for binding with the driver. * * Return: 0 if the controller instance was successfully bound to the * driver; otherwise, < 0 on error. @@ -493,8 +491,8 @@ static int mc_probe(struct platform_device *pdev) } /** - * mc_remove - Unbind driver from controller - * @pdev: Pointer to the platform_device struct + * mc_remove - Unbind driver from controller. + * @pdev: Platform device. * * Return: Unconditionally 0 */ -- 2.19.0.271.gfe8321ec057f -- Regards/Gruss, Boris. Good mailing practices for 400: avoid top-posting and trim the reply.
