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

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: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarHerbert Xu <herbert@gondor.apana.org.au>
parent cb028f16

drivers/crypto/cavium/cpt/cptpf_main.c

+1 −1
Original line number Diff line number Diff line
@@ -401,7 +401,7 @@ static void cpt_disable_all_cores(struct cpt_device *cpt) 
	cpt_write_csr64(cpt->reg_base, CPTX_PF_EXE_CTL(0), 0);

}



/**

/*

 * Ensure all cores are disengaged from all groups by

 * calling cpt_disable_all_cores() before calling this

 * function.

drivers/crypto/cavium/cpt/cptvf_reqmanager.c

+2 −2
Original line number Diff line number Diff line
@@ -9,8 +9,8 @@ 


/**

 * get_free_pending_entry - get free entry from pending queue

 * @param pqinfo: pending_qinfo structure

 * @param qno: queue number

 * @q: pending queue

 * @qlen: queue length

 */

static struct pending_entry *get_free_pending_entry(struct pending_queue *q,

						    int qlen)

drivers/crypto/cavium/nitrox/nitrox_main.c

+2 −2
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ static LIST_HEAD(ndevlist); 
static DEFINE_MUTEX(devlist_lock);

static unsigned int num_devices;



/**

/*

 * nitrox_pci_tbl - PCI Device ID Table

 */

static const struct pci_device_id nitrox_pci_tbl[] = {
@@ -65,7 +65,7 @@ struct ucode { 
	u64 code[];

};



/**

/*

 * write_to_ucd_unit - Write Firmware to NITROX UCD unit

 */

static void write_to_ucd_unit(struct nitrox_device *ndev, u32 ucode_size,

drivers/crypto/cavium/nitrox/nitrox_mbx.c

+2 −2
Original line number Diff line number Diff line
@@ -8,7 +8,7 @@ 


#define RING_TO_VFNO(_x, _y)	((_x) / (_y))



/**

/*

 * mbx_msg_type - Mailbox message types

 */

enum mbx_msg_type {
@@ -18,7 +18,7 @@ enum mbx_msg_type { 
	MBX_MSG_TYPE_NACK,

};



/**

/*

 * mbx_msg_opcode - Mailbox message opcodes

 */

enum mbx_msg_opcode {

drivers/crypto/cavium/nitrox/nitrox_reqmgr.c

+7 −5
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ 
#define REQ_BACKLOG    2

#define REQ_POSTED     3



/**

/*

 * Response codes from SE microcode

 * 0x00 - Success

 *   Completion with no error
@@ -279,6 +279,7 @@ static inline bool cmdq_full(struct nitrox_cmdq *cmdq, int qlen) 
/**

 * post_se_instr - Post SE instruction to Packet Input ring

 * @sr: Request structure

 * @cmdq: Command queue structure

 *

 * Returns 0 if successful or a negative error code,

 * if no space in ring.
@@ -372,6 +373,8 @@ static int nitrox_enqueue_request(struct nitrox_softreq *sr) 
 * nitrox_process_se_request - Send request to SE core

 * @ndev: NITROX device

 * @req: Crypto request

 * @callback: Completion callback

 * @cb_arg: Completion callback arguments

 *

 * Returns 0 on success, or a negative error code.

 */
@@ -526,9 +529,8 @@ static bool sr_completed(struct nitrox_softreq *sr) 
}



/**

 * process_request_list - process completed requests

 * @ndev: N5 device

 * @qno: queue to operate

 * process_response_list - process completed requests

 * @cmdq: Command queue structure

 *

 * Returns the number of responses processed.

 */
@@ -578,7 +580,7 @@ static void process_response_list(struct nitrox_cmdq *cmdq) 
	}

}



/**

/*

 * pkt_slc_resp_tasklet - post processing of SE responses

 */

void pkt_slc_resp_tasklet(unsigned long data)