Commit 0368853e authored by Lee Jones's avatar Lee Jones Committed by Herbert Xu
Browse files

crypto: ux500/hash - Fix worthy kernel-doc headers and remove others 



The ones remove here not only fail to conform to kernel-doc, but also
provide no value, so let's remove them completely in this case.

Fixes the following W=1 kernel build warning(s):

 drivers/crypto/ux500/hash/hash_core.c:368: warning: Function parameter or member 'ctx' not described in 'hash_get_device_data'
 drivers/crypto/ux500/hash/hash_core.c:368: warning: Excess function parameter 'hash_ctx' description in 'hash_get_device_data'
 drivers/crypto/ux500/hash/hash_core.c:551: warning: expecting prototype for hash_init(). Prototype was for ux500_hash_init() instead
 drivers/crypto/ux500/hash/hash_core.c:592: warning: Function parameter or member 'length' not described in 'hash_processblock'
 drivers/crypto/ux500/hash/hash_core.c:1302: warning: expecting prototype for hash_update(). Prototype was for ahash_update() instead
 drivers/crypto/ux500/hash/hash_core.c:1322: warning: expecting prototype for hash_final(). Prototype was for ahash_final() instead
 drivers/crypto/ux500/hash/hash_core.c:1622: warning: Function parameter or member 'device_data' not described in 'ahash_algs_register_all'
 drivers/crypto/ux500/hash/hash_core.c:1622: warning: expecting prototype for hash_algs_register_all(). Prototype was for ahash_algs_register_all() instead
 drivers/crypto/ux500/hash/hash_core.c:1647: warning: Function parameter or member 'device_data' not described in 'ahash_algs_unregister_all'
 drivers/crypto/ux500/hash/hash_core.c:1647: warning: expecting prototype for hash_algs_unregister_all(). Prototype was for ahash_algs_unregister_all() instead
 drivers/crypto/ux500/cryp/cryp.c:19: warning: Incorrect use of kernel-doc format:  * cryp_wait_until_done - wait until the device logic is not busy
 drivers/crypto/ux500/cryp/cryp.c:22: warning: Function parameter or member 'device_data' not described in 'cryp_wait_until_done'
 drivers/crypto/ux500/cryp/cryp.c:22: warning: expecting prototype for ST(). Prototype was for cryp_wait_until_done() instead
 drivers/crypto/ux500/cryp/cryp.c:292: warning: Function parameter or member 'cryp_mode' not described in 'cryp_save_device_context'
 drivers/crypto/ux500/cryp/cryp_irq.c:21: warning: Function parameter or member 'device_data' not described in 'cryp_enable_irq_src'
 drivers/crypto/ux500/cryp/cryp_irq.c:21: warning: Function parameter or member 'irq_src' not described in 'cryp_enable_irq_src'
 drivers/crypto/ux500/cryp/cryp_irq.c:21: warning: expecting prototype for ST(). Prototype was for cryp_enable_irq_src() instead
 drivers/crypto/ux500/cryp/cryp_core.c:42: warning: expecting prototype for ST(). Prototype was for CRYP_MAX_KEY_SIZE() instead
 drivers/crypto/ux500/cryp/cryp_core.c:91: warning: Function parameter or member 'key' not described in 'cryp_ctx'
 drivers/crypto/ux500/cryp/cryp_core.c:91: warning: Function parameter or member 'session_id' not described in 'cryp_ctx'

Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Shujuan Chen <shujuan.chen@stericsson.com>
Cc: Joakim Bech <joakim.xx.bech@stericsson.com>
Cc: Berne Hebark <berne.herbark@stericsson.com>
Cc: Niklas Hernaeus <niklas.hernaeus@stericsson.com>
Cc: Jonas Linde <jonas.linde@stericsson.com>
Cc: Andreas Westin <andreas.westin@stericsson.com>
Cc: linux-crypto@vger.kernel.org
Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarHerbert Xu <herbert@gondor.apana.org.au>
parent 29e5b878

drivers/crypto/ux500/cryp/cryp.c

+3 −2
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-only

/**

/*

 * Copyright (C) ST-Ericsson SA 2010

 * Author: Shujuan Chen <shujuan.chen@stericsson.com> for ST-Ericsson.

 * Author: Jonas Linde <jonas.linde@stericsson.com> for ST-Ericsson.
@@ -15,7 +15,7 @@ 
#include "cryp_p.h"

#include "cryp.h"



/**

/*

 * cryp_wait_until_done - wait until the device logic is not busy

 */

void cryp_wait_until_done(struct cryp_device_data *device_data)
@@ -285,6 +285,7 @@ int cryp_configure_init_vector(struct cryp_device_data *device_data, 
 *				other device context parameter

 * @device_data: Pointer to the device data struct for base address.

 * @ctx: Crypto device context

 * @cryp_mode: Mode: Polling, Interrupt or DMA

 */

void cryp_save_device_context(struct cryp_device_data *device_data,

			      struct cryp_device_context *ctx,

drivers/crypto/ux500/cryp/cryp_core.c

+3 −2
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-only

/**

/*

 * Copyright (C) ST-Ericsson SA 2010

 * Author: Shujuan Chen <shujuan.chen@stericsson.com> for ST-Ericsson.

 * Author: Joakim Bech <joakim.xx.bech@stericsson.com> for ST-Ericsson.
@@ -62,7 +62,7 @@ struct cryp_driver_data { 
/**

 * struct cryp_ctx - Crypto context

 * @config: Crypto mode.

 * @key[CRYP_MAX_KEY_SIZE]: Key.

 * @key: Key array.

 * @keylen: Length of key.

 * @iv: Pointer to initialization vector.

 * @indata: Pointer to indata.
@@ -73,6 +73,7 @@ struct cryp_driver_data { 
 * @updated: Updated flag.

 * @dev_ctx: Device dependent context.

 * @device: Pointer to the device.

 * @session_id: Atomic session ID.

 */

struct cryp_ctx {

	struct cryp_config config;

drivers/crypto/ux500/cryp/cryp_irq.c

+1 −1
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-only

/**

/*

 * Copyright (C) ST-Ericsson SA 2010

 * Author: Shujuan Chen <shujuan.chen@stericsson.com> for ST-Ericsson.

 * Author: Jonas Linde <jonas.linde@stericsson.com> for ST-Ericsson.

drivers/crypto/ux500/hash/hash_core.c

+5 −10
Original line number Diff line number Diff line
@@ -356,7 +356,7 @@ static int hash_enable_power(struct hash_device_data *device_data, 


/**

 * hash_get_device_data - Checks for an available hash device and return it.

 * @hash_ctx:		Structure for the hash context.

 * @ctx:		Structure for the hash context.

 * @device_data:	Structure for the hash device.

 *

 * This function check for an available hash device and return it to
@@ -542,7 +542,7 @@ static bool hash_dma_valid_data(struct scatterlist *sg, int datasize) 
}



/**

 * hash_init - Common hash init function for SHA1/SHA2 (SHA256).

 * ux500_hash_init - Common hash init function for SHA1/SHA2 (SHA256).

 * @req: The hash request for the job.

 *

 * Initialize structures.
@@ -585,6 +585,7 @@ static int ux500_hash_init(struct ahash_request *req) 
 * @device_data:	Structure for the hash device.

 * @message:		Block (512 bits) of message to be written to

 *			the HASH hardware.

 * @length:		Message length

 *

 */

static void hash_processblock(struct hash_device_data *device_data,
@@ -1295,7 +1296,7 @@ void hash_get_digest(struct hash_device_data *device_data, 
}



/**

 * hash_update - The hash update function for SHA1/SHA2 (SHA256).

 * ahash_update - The hash update function for SHA1/SHA2 (SHA256).

 * @req: The hash request for the job.

 */

static int ahash_update(struct ahash_request *req)
@@ -1315,7 +1316,7 @@ static int ahash_update(struct ahash_request *req) 
}



/**

 * hash_final - The hash final function for SHA1/SHA2 (SHA256).

 * ahash_final - The hash final function for SHA1/SHA2 (SHA256).

 * @req:	The hash request for the job.

 */

static int ahash_final(struct ahash_request *req)
@@ -1615,9 +1616,6 @@ static struct hash_algo_template hash_algs[] = { 
	}

};



/**

 * hash_algs_register_all -

 */

static int ahash_algs_register_all(struct hash_device_data *device_data)

{

	int ret;
@@ -1640,9 +1638,6 @@ static int ahash_algs_register_all(struct hash_device_data *device_data) 
	return ret;

}



/**

 * hash_algs_unregister_all -

 */

static void ahash_algs_unregister_all(struct hash_device_data *device_data)

{

	int i;