Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

crypto: cavium: Fix a bunch of kernel-doc related issues

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

drivers/crypto/cavium/nitrox/nitrox_main.c:41: warning: cannot understand function prototype: 'const struct pci_device_id nitrox_pci_tbl[] = '
drivers/crypto/cavium/nitrox/nitrox_main.c:73: warning: Function parameter or member 'ndev' not described in 'write_to_ucd_unit'
drivers/crypto/cavium/nitrox/nitrox_main.c:73: warning: Function parameter or member 'ucode_size' not described in 'write_to_ucd_unit'
drivers/crypto/cavium/nitrox/nitrox_main.c:73: warning: Function parameter or member 'ucode_data' not described in 'write_to_ucd_unit'
drivers/crypto/cavium/nitrox/nitrox_main.c:73: warning: Function parameter or member 'block_num' not described in 'write_to_ucd_unit'
drivers/crypto/cavium/nitrox/nitrox_reqmgr.c:46: warning: Function parameter or member 'index' not described in 'incr_index'
drivers/crypto/cavium/nitrox/nitrox_reqmgr.c:46: warning: Function parameter or member 'count' not described in 'incr_index'
drivers/crypto/cavium/nitrox/nitrox_reqmgr.c:46: warning: Function parameter or member 'max' not described in 'incr_index'
drivers/crypto/cavium/nitrox/nitrox_reqmgr.c:46: warning: expecting prototype for Response codes from SE microcode(). Prototype was for incr_index() instead
drivers/crypto/cavium/nitrox/nitrox_reqmgr.c:287: warning: Function parameter or member 'cmdq' not described in 'post_se_instr'
drivers/crypto/cavium/nitrox/nitrox_reqmgr.c:381: warning: Function parameter or member 'callback' not described in 'nitrox_process_se_request'
drivers/crypto/cavium/nitrox/nitrox_reqmgr.c:381: warning: Function parameter or member 'cb_arg' not described in 'nitrox_process_se_request'
drivers/crypto/cavium/nitrox/nitrox_reqmgr.c:381: warning: expecting prototype for nitrox_se_request(). Prototype was for nitrox_process_se_request() instead
drivers/crypto/cavium/nitrox/nitrox_reqmgr.c:535: warning: Function parameter or member 'cmdq' not described in 'process_response_list'
drivers/crypto/cavium/nitrox/nitrox_reqmgr.c:535: warning: expecting prototype for process_request_list(). Prototype was for process_response_list() instead
drivers/crypto/cavium/nitrox/nitrox_reqmgr.c:584: warning: Function parameter or member 'data' not described in 'pkt_slc_resp_tasklet'
drivers/crypto/cavium/nitrox/nitrox_mbx.c:14: warning: cannot understand function prototype: 'enum mbx_msg_type '
drivers/crypto/cavium/nitrox/nitrox_mbx.c:24: warning: cannot understand function prototype: 'enum mbx_msg_opcode '
drivers/crypto/cavium/nitrox/nitrox_skcipher.c:26: warning: cannot understand function prototype: 'const struct nitrox_cipher flexi_cipher_table[] = '
drivers/crypto/cavium/cpt/cptpf_main.c:411: warning: Function parameter or member 'cpt' not described in 'cpt_unload_microcode'
drivers/crypto/cavium/cpt/cptpf_main.c:411: warning: expecting prototype for Ensure all cores are disengaged from all groups by(). Prototype was for cpt_unload_microcode() instead
drivers/crypto/cavium/cpt/cptvf_reqmanager.c:17: warning: Function parameter or member 'q' not described in 'get_free_pending_entry'
drivers/crypto/cavium/cpt/cptvf_reqmanager.c:17: warning: Function parameter or member 'qlen' not described in 'get_free_pending_entry'

Cc: George Cherian <gcherian@marvell.com>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: linux-crypto@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>

authored by

Lee Jones and committed by
Herbert Xu
c4d7d318 cb028f16

+15 -13
+1 -1
drivers/crypto/cavium/cpt/cptpf_main.c
··· 401 401 cpt_write_csr64(cpt->reg_base, CPTX_PF_EXE_CTL(0), 0); 402 402 } 403 403 404 - /** 404 + /* 405 405 * Ensure all cores are disengaged from all groups by 406 406 * calling cpt_disable_all_cores() before calling this 407 407 * function.
+2 -2
drivers/crypto/cavium/cpt/cptvf_reqmanager.c
··· 9 9 10 10 /** 11 11 * get_free_pending_entry - get free entry from pending queue 12 - * @param pqinfo: pending_qinfo structure 13 - * @param qno: queue number 12 + * @q: pending queue 13 + * @qlen: queue length 14 14 */ 15 15 static struct pending_entry *get_free_pending_entry(struct pending_queue *q, 16 16 int qlen)
+2 -2
drivers/crypto/cavium/nitrox/nitrox_main.c
··· 35 35 static DEFINE_MUTEX(devlist_lock); 36 36 static unsigned int num_devices; 37 37 38 - /** 38 + /* 39 39 * nitrox_pci_tbl - PCI Device ID Table 40 40 */ 41 41 static const struct pci_device_id nitrox_pci_tbl[] = { ··· 65 65 u64 code[]; 66 66 }; 67 67 68 - /** 68 + /* 69 69 * write_to_ucd_unit - Write Firmware to NITROX UCD unit 70 70 */ 71 71 static void write_to_ucd_unit(struct nitrox_device *ndev, u32 ucode_size,
+2 -2
drivers/crypto/cavium/nitrox/nitrox_mbx.c
··· 8 8 9 9 #define RING_TO_VFNO(_x, _y) ((_x) / (_y)) 10 10 11 - /** 11 + /* 12 12 * mbx_msg_type - Mailbox message types 13 13 */ 14 14 enum mbx_msg_type { ··· 18 18 MBX_MSG_TYPE_NACK, 19 19 }; 20 20 21 - /** 21 + /* 22 22 * mbx_msg_opcode - Mailbox message opcodes 23 23 */ 24 24 enum mbx_msg_opcode {
+7 -5
drivers/crypto/cavium/nitrox/nitrox_reqmgr.c
··· 19 19 #define REQ_BACKLOG 2 20 20 #define REQ_POSTED 3 21 21 22 - /** 22 + /* 23 23 * Response codes from SE microcode 24 24 * 0x00 - Success 25 25 * Completion with no error ··· 279 279 /** 280 280 * post_se_instr - Post SE instruction to Packet Input ring 281 281 * @sr: Request structure 282 + * @cmdq: Command queue structure 282 283 * 283 284 * Returns 0 if successful or a negative error code, 284 285 * if no space in ring. ··· 373 372 * nitrox_process_se_request - Send request to SE core 374 373 * @ndev: NITROX device 375 374 * @req: Crypto request 375 + * @callback: Completion callback 376 + * @cb_arg: Completion callback arguments 376 377 * 377 378 * Returns 0 on success, or a negative error code. 378 379 */ ··· 529 526 } 530 527 531 528 /** 532 - * process_request_list - process completed requests 533 - * @ndev: N5 device 534 - * @qno: queue to operate 529 + * process_response_list - process completed requests 530 + * @cmdq: Command queue structure 535 531 * 536 532 * Returns the number of responses processed. 537 533 */ ··· 580 578 } 581 579 } 582 580 583 - /** 581 + /* 584 582 * pkt_slc_resp_tasklet - post processing of SE responses 585 583 */ 586 584 void pkt_slc_resp_tasklet(unsigned long data)
+1 -1
drivers/crypto/cavium/nitrox/nitrox_skcipher.c
··· 20 20 enum flexi_cipher value; 21 21 }; 22 22 23 - /** 23 + /* 24 24 * supported cipher list 25 25 */ 26 26 static const struct nitrox_cipher flexi_cipher_table[] = {