Commit 73f04d3d authored by Aditya Srivastava's avatar Aditya Srivastava Committed by Herbert Xu

crypto: amcc - fix incorrect kernel-doc comment syntax in files

The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
There are certain files in drivers/crypto/amcc, 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
drivers/crypto/amcc/crypto4xx_alg.c at header, and some other lines,
causes these warnings by kernel-doc:

"warning: expecting prototype for AMCC SoC PPC4xx Crypto Driver(). Prototype was for set_dynamic_sa_command_0() instead"
"warning: Function parameter or member 'dir' not described in 'set_dynamic_sa_command_0'"
etc..

Provide a simple fix by replacing such occurrences with general comment
format, i.e. '/*', to prevent kernel-doc from parsing it.
Signed-off-by: default avatarAditya Srivastava <yashsri421@gmail.com>
Acked-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarHerbert Xu <herbert@gondor.apana.org.au>
parent dbb153c0
// SPDX-License-Identifier: GPL-2.0-or-later // SPDX-License-Identifier: GPL-2.0-or-later
/** /*
* AMCC SoC PPC4xx Crypto Driver * AMCC SoC PPC4xx Crypto Driver
* *
* Copyright (c) 2008 Applied Micro Circuits Corporation. * Copyright (c) 2008 Applied Micro Circuits Corporation.
...@@ -115,7 +115,7 @@ int crypto4xx_decrypt_iv_block(struct skcipher_request *req) ...@@ -115,7 +115,7 @@ int crypto4xx_decrypt_iv_block(struct skcipher_request *req)
return crypto4xx_crypt(req, AES_IV_SIZE, true, true); return crypto4xx_crypt(req, AES_IV_SIZE, true, true);
} }
/** /*
* AES Functions * AES Functions
*/ */
static int crypto4xx_setkey_aes(struct crypto_skcipher *cipher, static int crypto4xx_setkey_aes(struct crypto_skcipher *cipher,
...@@ -374,7 +374,7 @@ static int crypto4xx_aead_setup_fallback(struct crypto4xx_ctx *ctx, ...@@ -374,7 +374,7 @@ static int crypto4xx_aead_setup_fallback(struct crypto4xx_ctx *ctx,
return crypto_aead_setkey(ctx->sw_cipher.aead, key, keylen); return crypto_aead_setkey(ctx->sw_cipher.aead, key, keylen);
} }
/** /*
* AES-CCM Functions * AES-CCM Functions
*/ */
...@@ -489,7 +489,7 @@ int crypto4xx_setauthsize_aead(struct crypto_aead *cipher, ...@@ -489,7 +489,7 @@ int crypto4xx_setauthsize_aead(struct crypto_aead *cipher,
return crypto_aead_setauthsize(ctx->sw_cipher.aead, authsize); return crypto_aead_setauthsize(ctx->sw_cipher.aead, authsize);
} }
/** /*
* AES-GCM Functions * AES-GCM Functions
*/ */
...@@ -617,7 +617,7 @@ int crypto4xx_decrypt_aes_gcm(struct aead_request *req) ...@@ -617,7 +617,7 @@ int crypto4xx_decrypt_aes_gcm(struct aead_request *req)
return crypto4xx_crypt_aes_gcm(req, true); return crypto4xx_crypt_aes_gcm(req, true);
} }
/** /*
* HASH SHA1 Functions * HASH SHA1 Functions
*/ */
static int crypto4xx_hash_alg_init(struct crypto_tfm *tfm, static int crypto4xx_hash_alg_init(struct crypto_tfm *tfm,
...@@ -711,7 +711,7 @@ int crypto4xx_hash_digest(struct ahash_request *req) ...@@ -711,7 +711,7 @@ int crypto4xx_hash_digest(struct ahash_request *req)
ctx->sa_len, 0, NULL); ctx->sa_len, 0, NULL);
} }
/** /*
* SHA1 Algorithm * SHA1 Algorithm
*/ */
int crypto4xx_sha1_alg_init(struct crypto_tfm *tfm) int crypto4xx_sha1_alg_init(struct crypto_tfm *tfm)
......
// SPDX-License-Identifier: GPL-2.0-or-later // SPDX-License-Identifier: GPL-2.0-or-later
/** /*
* AMCC SoC PPC4xx Crypto Driver * AMCC SoC PPC4xx Crypto Driver
* *
* Copyright (c) 2008 Applied Micro Circuits Corporation. * Copyright (c) 2008 Applied Micro Circuits Corporation.
...@@ -44,7 +44,7 @@ ...@@ -44,7 +44,7 @@
#define PPC4XX_SEC_VERSION_STR "0.5" #define PPC4XX_SEC_VERSION_STR "0.5"
/** /*
* PPC4xx Crypto Engine Initialization Routine * PPC4xx Crypto Engine Initialization Routine
*/ */
static void crypto4xx_hw_init(struct crypto4xx_device *dev) static void crypto4xx_hw_init(struct crypto4xx_device *dev)
...@@ -159,7 +159,7 @@ void crypto4xx_free_sa(struct crypto4xx_ctx *ctx) ...@@ -159,7 +159,7 @@ void crypto4xx_free_sa(struct crypto4xx_ctx *ctx)
ctx->sa_len = 0; ctx->sa_len = 0;
} }
/** /*
* alloc memory for the gather ring * alloc memory for the gather ring
* no need to alloc buf for the ring * no need to alloc buf for the ring
* gdr_tail, gdr_head and gdr_count are initialized by this function * gdr_tail, gdr_head and gdr_count are initialized by this function
...@@ -268,7 +268,7 @@ static u32 crypto4xx_put_pd_to_pdr(struct crypto4xx_device *dev, u32 idx) ...@@ -268,7 +268,7 @@ static u32 crypto4xx_put_pd_to_pdr(struct crypto4xx_device *dev, u32 idx)
return tail; return tail;
} }
/** /*
* alloc memory for the gather ring * alloc memory for the gather ring
* no need to alloc buf for the ring * no need to alloc buf for the ring
* gdr_tail, gdr_head and gdr_count are initialized by this function * gdr_tail, gdr_head and gdr_count are initialized by this function
...@@ -346,7 +346,7 @@ static inline struct ce_gd *crypto4xx_get_gdp(struct crypto4xx_device *dev, ...@@ -346,7 +346,7 @@ static inline struct ce_gd *crypto4xx_get_gdp(struct crypto4xx_device *dev,
return &dev->gdr[idx]; return &dev->gdr[idx];
} }
/** /*
* alloc memory for the scatter ring * alloc memory for the scatter ring
* need to alloc buf for the ring * need to alloc buf for the ring
* sdr_tail, sdr_head and sdr_count are initialized by this function * sdr_tail, sdr_head and sdr_count are initialized by this function
...@@ -930,7 +930,7 @@ int crypto4xx_build_pd(struct crypto_async_request *req, ...@@ -930,7 +930,7 @@ int crypto4xx_build_pd(struct crypto_async_request *req,
return is_busy ? -EBUSY : -EINPROGRESS; return is_busy ? -EBUSY : -EINPROGRESS;
} }
/** /*
* Algorithm Registration Functions * Algorithm Registration Functions
*/ */
static void crypto4xx_ctx_init(struct crypto4xx_alg *amcc_alg, static void crypto4xx_ctx_init(struct crypto4xx_alg *amcc_alg,
...@@ -1097,7 +1097,7 @@ static void crypto4xx_bh_tasklet_cb(unsigned long data) ...@@ -1097,7 +1097,7 @@ static void crypto4xx_bh_tasklet_cb(unsigned long data)
} while (head != tail); } while (head != tail);
} }
/** /*
* Top Half of isr. * Top Half of isr.
*/ */
static inline irqreturn_t crypto4xx_interrupt_handler(int irq, void *data, static inline irqreturn_t crypto4xx_interrupt_handler(int irq, void *data,
...@@ -1186,7 +1186,7 @@ static int crypto4xx_prng_seed(struct crypto_rng *tfm, const u8 *seed, ...@@ -1186,7 +1186,7 @@ static int crypto4xx_prng_seed(struct crypto_rng *tfm, const u8 *seed,
return 0; return 0;
} }
/** /*
* Supported Crypto Algorithms * Supported Crypto Algorithms
*/ */
static struct crypto4xx_alg_common crypto4xx_alg[] = { static struct crypto4xx_alg_common crypto4xx_alg[] = {
...@@ -1369,7 +1369,7 @@ static struct crypto4xx_alg_common crypto4xx_alg[] = { ...@@ -1369,7 +1369,7 @@ static struct crypto4xx_alg_common crypto4xx_alg[] = {
} }, } },
}; };
/** /*
* Module Initialization Routine * Module Initialization Routine
*/ */
static int crypto4xx_probe(struct platform_device *ofdev) static int crypto4xx_probe(struct platform_device *ofdev)
......
/* SPDX-License-Identifier: GPL-2.0-or-later */ /* SPDX-License-Identifier: GPL-2.0-or-later */
/** /*
* AMCC SoC PPC4xx Crypto Driver * AMCC SoC PPC4xx Crypto Driver
* *
* Copyright (c) 2008 Applied Micro Circuits Corporation. * Copyright (c) 2008 Applied Micro Circuits Corporation.
...@@ -188,7 +188,7 @@ int crypto4xx_hash_final(struct ahash_request *req); ...@@ -188,7 +188,7 @@ int crypto4xx_hash_final(struct ahash_request *req);
int crypto4xx_hash_update(struct ahash_request *req); int crypto4xx_hash_update(struct ahash_request *req);
int crypto4xx_hash_init(struct ahash_request *req); int crypto4xx_hash_init(struct ahash_request *req);
/** /*
* Note: Only use this function to copy items that is word aligned. * Note: Only use this function to copy items that is word aligned.
*/ */
static inline void crypto4xx_memcpy_swab32(u32 *dst, const void *buf, static inline void crypto4xx_memcpy_swab32(u32 *dst, const void *buf,
......
/* SPDX-License-Identifier: GPL-2.0-or-later */ /* SPDX-License-Identifier: GPL-2.0-or-later */
/** /*
* AMCC SoC PPC4xx Crypto Driver * AMCC SoC PPC4xx Crypto Driver
* *
* Copyright (c) 2008 Applied Micro Circuits Corporation. * Copyright (c) 2008 Applied Micro Circuits Corporation.
...@@ -104,7 +104,7 @@ ...@@ -104,7 +104,7 @@
#define CRYPTO4XX_PRNG_LFSR_L 0x00070030 #define CRYPTO4XX_PRNG_LFSR_L 0x00070030
#define CRYPTO4XX_PRNG_LFSR_H 0x00070034 #define CRYPTO4XX_PRNG_LFSR_H 0x00070034
/** /*
* Initialize CRYPTO ENGINE registers, and memory bases. * Initialize CRYPTO ENGINE registers, and memory bases.
*/ */
#define PPC4XX_PDR_POLL 0x3ff #define PPC4XX_PDR_POLL 0x3ff
...@@ -123,7 +123,7 @@ ...@@ -123,7 +123,7 @@
#define PPC4XX_INT_TIMEOUT_CNT 0 #define PPC4XX_INT_TIMEOUT_CNT 0
#define PPC4XX_INT_TIMEOUT_CNT_REVB 0x3FF #define PPC4XX_INT_TIMEOUT_CNT_REVB 0x3FF
#define PPC4XX_INT_CFG 1 #define PPC4XX_INT_CFG 1
/** /*
* all follow define are ad hoc * all follow define are ad hoc
*/ */
#define PPC4XX_RING_RETRY 100 #define PPC4XX_RING_RETRY 100
...@@ -131,7 +131,7 @@ ...@@ -131,7 +131,7 @@
#define PPC4XX_SDR_SIZE PPC4XX_NUM_SD #define PPC4XX_SDR_SIZE PPC4XX_NUM_SD
#define PPC4XX_GDR_SIZE PPC4XX_NUM_GD #define PPC4XX_GDR_SIZE PPC4XX_NUM_GD
/** /*
* Generic Security Association (SA) with all possible fields. These will * Generic Security Association (SA) with all possible fields. These will
* never likely used except for reference purpose. These structure format * never likely used except for reference purpose. These structure format
* can be not changed as the hardware expects them to be layout as defined. * can be not changed as the hardware expects them to be layout as defined.
......
/* SPDX-License-Identifier: GPL-2.0-or-later */ /* SPDX-License-Identifier: GPL-2.0-or-later */
/** /*
* AMCC SoC PPC4xx Crypto Driver * AMCC SoC PPC4xx Crypto Driver
* *
* Copyright (c) 2008 Applied Micro Circuits Corporation. * Copyright (c) 2008 Applied Micro Circuits Corporation.
...@@ -14,7 +14,7 @@ ...@@ -14,7 +14,7 @@
#define AES_IV_SIZE 16 #define AES_IV_SIZE 16
/** /*
* Contents of Dynamic Security Association (SA) with all possible fields * Contents of Dynamic Security Association (SA) with all possible fields
*/ */
union dynamic_sa_contents { union dynamic_sa_contents {
...@@ -122,7 +122,7 @@ union sa_command_0 { ...@@ -122,7 +122,7 @@ union sa_command_0 {
#define SA_AES_KEY_LEN_256 4 #define SA_AES_KEY_LEN_256 4
#define SA_REV2 1 #define SA_REV2 1
/** /*
* The follow defines bits sa_command_1 * The follow defines bits sa_command_1
* In Basic hash mode this bit define simple hash or hmac. * In Basic hash mode this bit define simple hash or hmac.
* In IPsec mode, this bit define muting control. * In IPsec mode, this bit define muting control.
...@@ -172,7 +172,7 @@ struct dynamic_sa_ctl { ...@@ -172,7 +172,7 @@ struct dynamic_sa_ctl {
union sa_command_1 sa_command_1; union sa_command_1 sa_command_1;
} __attribute__((packed)); } __attribute__((packed));
/** /*
* State Record for Security Association (SA) * State Record for Security Association (SA)
*/ */
struct sa_state_record { struct sa_state_record {
...@@ -184,7 +184,7 @@ struct sa_state_record { ...@@ -184,7 +184,7 @@ struct sa_state_record {
}; };
} __attribute__((packed)); } __attribute__((packed));
/** /*
* Security Association (SA) for AES128 * Security Association (SA) for AES128
* *
*/ */
...@@ -213,7 +213,7 @@ struct dynamic_sa_aes192 { ...@@ -213,7 +213,7 @@ struct dynamic_sa_aes192 {
#define SA_AES192_LEN (sizeof(struct dynamic_sa_aes192)/4) #define SA_AES192_LEN (sizeof(struct dynamic_sa_aes192)/4)
#define SA_AES192_CONTENTS 0x3e000062 #define SA_AES192_CONTENTS 0x3e000062
/** /*
* Security Association (SA) for AES256 * Security Association (SA) for AES256
*/ */
struct dynamic_sa_aes256 { struct dynamic_sa_aes256 {
...@@ -228,7 +228,7 @@ struct dynamic_sa_aes256 { ...@@ -228,7 +228,7 @@ struct dynamic_sa_aes256 {
#define SA_AES256_CONTENTS 0x3e000082 #define SA_AES256_CONTENTS 0x3e000082
#define SA_AES_CONTENTS 0x3e000002 #define SA_AES_CONTENTS 0x3e000002
/** /*
* Security Association (SA) for AES128 CCM * Security Association (SA) for AES128 CCM
*/ */
struct dynamic_sa_aes128_ccm { struct dynamic_sa_aes128_ccm {
...@@ -242,7 +242,7 @@ struct dynamic_sa_aes128_ccm { ...@@ -242,7 +242,7 @@ struct dynamic_sa_aes128_ccm {
#define SA_AES128_CCM_CONTENTS 0x3e000042 #define SA_AES128_CCM_CONTENTS 0x3e000042
#define SA_AES_CCM_CONTENTS 0x3e000002 #define SA_AES_CCM_CONTENTS 0x3e000002
/** /*
* Security Association (SA) for AES128_GCM * Security Association (SA) for AES128_GCM
*/ */
struct dynamic_sa_aes128_gcm { struct dynamic_sa_aes128_gcm {
...@@ -258,7 +258,7 @@ struct dynamic_sa_aes128_gcm { ...@@ -258,7 +258,7 @@ struct dynamic_sa_aes128_gcm {
#define SA_AES128_GCM_CONTENTS 0x3e000442 #define SA_AES128_GCM_CONTENTS 0x3e000442
#define SA_AES_GCM_CONTENTS 0x3e000402 #define SA_AES_GCM_CONTENTS 0x3e000402
/** /*
* Security Association (SA) for HASH160: HMAC-SHA1 * Security Association (SA) for HASH160: HMAC-SHA1
*/ */
struct dynamic_sa_hash160 { struct dynamic_sa_hash160 {
......
/* SPDX-License-Identifier: GPL-2.0-or-later */ /* SPDX-License-Identifier: GPL-2.0-or-later */
/** /*
* AMCC SoC PPC4xx Crypto Driver * AMCC SoC PPC4xx Crypto Driver
* *
* Copyright (c) 2008 Applied Micro Circuits Corporation. * Copyright (c) 2008 Applied Micro Circuits Corporation.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment