crypto: ux500: fix incorrect kernel-doc comment syntax
PATCH 1/1 crypto: ux500: fix incorrect kernel-doc comment syntax
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments.
There are certain files in drivers/crypto/ux500, which follow this syntax, but the content inside does not comply with kernel-doc.
Such lines were probably not meant for kernel-doc parsing, but are parsed due to the presence of kernel-doc like comment syntax(i.e, '/**'), which causes unexpected warnings from kernel-doc.
E.g., presence of kernel-doc like comment in the header lines for drivers/crypto/ux500/cryp/cryp.h at header causes this warning:
"warning: expecting prototype for ST(). Prototype was for _CRYP_H_() instead"
Similarly for other files too.
Provide a simple fix by replacing such occurrences with general comment format, i.e. '/*', to prevent kernel-doc from parsing it.
--- drivers/crypto/ux500/cryp/cryp.c | 2 +- drivers/crypto/ux500/cryp/cryp.h | 2 +- drivers/crypto/ux500/cryp/cryp_core.c | 2 +- drivers/crypto/ux500/cryp/cryp_irq.c | 2 +- drivers/crypto/ux500/cryp/cryp_irq.h | 4 ++-- drivers/crypto/ux500/cryp/cryp_irqp.h | 4 ++-- drivers/crypto/ux500/cryp/cryp_p.h | 14 +++++++------- 7 files changed, 15 insertions(+), 15 deletions(-)
drivers/crypto/ux500/cryp/cryp.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) ST-Ericsson SA 2010 * Author: Shujuan Chen <[email protected]> for ST-Ericsson. * Author: Jonas Linde <[email protected]> for ST-Ericsson.
drivers/crypto/ux500/cryp/cryp.h +1 -1
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) ST-Ericsson SA 2010 * Author: Shujuan Chen <[email protected]> for ST-Ericsson. * Author: Jonas Linde <[email protected]> for ST-Ericsson.
drivers/crypto/ux500/cryp/cryp_core.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) ST-Ericsson SA 2010 * Author: Shujuan Chen <[email protected]> for ST-Ericsson. * Author: Joakim Bech <[email protected]> for ST-Ericsson.
drivers/crypto/ux500/cryp/cryp_irq.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0-only -/** +/* * Copyright (C) ST-Ericsson SA 2010 * Author: Shujuan Chen <[email protected]> for ST-Ericsson. * Author: Jonas Linde <[email protected]> for ST-Ericsson.
drivers/crypto/ux500/cryp/cryp_irq.h +2 -2
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) ST-Ericsson SA 2010 * Author: Shujuan Chen <[email protected]> for ST-Ericsson. * Author: Jonas Linde <[email protected]> for ST-Ericsson.
@@ -19,7 +19,7 @@ enum cryp_irq_src_id { CRYP_IRQ_SRC_ALL = 0x3 }; -/** +/* * M0 Funtions */ void cryp_enable_irq_src (struct cryp_device_data *device_data,u32 irq_src);
drivers/crypto/ux500/cryp/cryp_irqp.h +2 -2
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) ST-Ericsson SA 2010 * Author: Shujuan Chen <[email protected]> for ST-Ericsson. * Author: Jonas Linde <[email protected]> for ST-Ericsson.
@@ -13,7 +13,7 @@#include "cryp_irq.h" -/** +/* * * CRYP Registers - Offset mapping * +-----------------+
drivers/crypto/ux500/cryp/cryp_p.h +7 -7
@@ -1,5 +1,5 @@/* SPDX-License-Identifier: GPL-2.0-only */ -/** +/* * Copyright (C) ST-Ericsson SA 2010 * Author: Shujuan Chen <[email protected]> for ST-Ericsson. * Author: Jonas Linde <[email protected]> for ST-Ericsson.
@@ -17,7 +17,7 @@#include "cryp.h" #include "cryp_irqp.h" -/** +/* * Generic Macros */ #define CRYP_SET_BITS (reg_name, mask) \
@@ -34,7 +34,7 @@writel_relaxed (((readl_relaxed (reg) & ~(mask)) | \ (((u32 )val << shift) & (mask))), reg) -/** +/* * CRYP specific Macros */#define CRYP_PERIPHERAL_ID0 0xE3
@@ -48,7 +48,7 @@#define CRYP_PCELL_ID2 0x05#define CRYP_PCELL_ID3 0xB1 -/** +/* * CRYP register default values */ #define MAX_DEVICE_SUPPORT 2
@@ -62,7 +62,7 @@#define CRYP_KEY_DEFAULT 0x0#define CRYP_INIT_VECT_DEFAULT 0x0 -/** +/* * CRYP Control register specific mask */ #define CRYP_CR_SECURE_MASK BIT(0)
@@ -91,7 +91,7 @@#define CRYP_SR_IFEM_MASK BIT(0)#define CRYP_SR_BUSY_MASK BIT(4) -/** +/* * Bit position used while setting bits in register */ #define CRYP_CR_PRLG_POS 1
@@ -107,7 +107,7 @@#define CRYP_SR_BUSY_POS 4 -/** +/* * CRYP PCRs------PC_NAND control register * BIT_MASK */
Signature · 6 lines
2.17.1 _______________________________________________ Linux-kernel-mentees mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
LGTM. Thanks.
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Herbert Xu
maintainerQuoted 19 lines · Aditya Srivastava
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments.
There are certain files indrivers/crypto/ux500, which follow this syntax, but the content inside does not comply with kernel-doc.
Such lines were probably not meant for kernel-doc parsing, but are parsed due to the presence of kernel-doc like commentsyntax(i.e, '/**'), which causes unexpected warnings from kernel-doc.E.g., presence of kernel-doc like comment in the header lines for
drivers/crypto/ux500/cryp/cryp.hat header causes this warning:"warning: expecting prototype for
ST(). Prototype was for_CRYP_H_()instead"Similarly for other files too.
Provide a simple fix by replacing such occurrences with general comment format, i.e. '/*', to prevent kernel-doc from parsing it.
Signed-off-by Aditya Srivastava <[email protected]>
Quoted 9 lines
--- drivers/crypto/ux500/cryp/cryp.c | 2 +- drivers/crypto/ux500/cryp/cryp.h | 2 +- drivers/crypto/ux500/cryp/cryp_core.c | 2 +- drivers/crypto/ux500/cryp/cryp_irq.c | 2 +- drivers/crypto/ux500/cryp/cryp_irq.h | 4 ++-- drivers/crypto/ux500/cryp/cryp_irqp.h | 4 ++-- drivers/crypto/ux500/cryp/cryp_p.h | 14 +++++++------- 7 files changed, 15 insertions(+), 15 deletions(-)
Patch applied. Thanks.
Signature · 3 lines
Email: Herbert Xu <[email protected]> Home Page: http://gondor.apana.org.au/~herbert/ PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt