Commit 04cb788e authored by Randy Dunlap's avatar Randy Dunlap Committed by Herbert Xu
Browse files

crypto: jitter - drop kernel-doc notation 



Drop "begin kernel-doc (/**)" entries in jitterentropy.c
since they are not in kernel-doc format and they cause
many complaints (warnings) from scripts/kernel-doc.

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Stephan Mueller <smueller@chronox.de>
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 avatarHerbert Xu <herbert@gondor.apana.org.au>
parent 6880fa6c

crypto/jitterentropy.c

+12 −12
Original line number Diff line number Diff line
@@ -125,7 +125,7 @@ struct rand_data { 
 * This test complies with SP800-90B section 4.4.2.

 ***************************************************************************/



/**

/*

 * Reset the APT counter

 *

 * @ec [in] Reference to entropy collector
@@ -138,7 +138,7 @@ static void jent_apt_reset(struct rand_data *ec, unsigned int delta_masked) 
	ec->apt_observations = 0;

}



/**

/*

 * Insert a new entropy event into APT

 *

 * @ec [in] Reference to entropy collector
@@ -182,7 +182,7 @@ static void jent_apt_insert(struct rand_data *ec, unsigned int delta_masked) 
 * the end. The caller of the Jitter RNG is informed with an error code.

 ***************************************************************************/



/**

/*

 * Repetition Count Test as defined in SP800-90B section 4.4.1

 *

 * @ec [in] Reference to entropy collector
@@ -223,7 +223,7 @@ static void jent_rct_insert(struct rand_data *ec, int stuck) 
	}

}



/**

/*

 * Is there an RCT health test failure?

 *

 * @ec [in] Reference to entropy collector
@@ -246,7 +246,7 @@ static inline __u64 jent_delta(__u64 prev, __u64 next) 
			       (JENT_UINT64_MAX - prev + 1 + next);

}



/**

/*

 * Stuck test by checking the:

 * 	1st derivative of the jitter measurement (time delta)

 * 	2nd derivative of the jitter measurement (delta of time deltas)
@@ -288,7 +288,7 @@ static int jent_stuck(struct rand_data *ec, __u64 current_delta) 
	return 0;

}



/**

/*

 * Report any health test failures

 *

 * @ec [in] Reference to entropy collector
@@ -310,7 +310,7 @@ static int jent_health_failure(struct rand_data *ec) 
 * Noise sources

 ***************************************************************************/



/**

/*

 * Update of the loop count used for the next round of

 * an entropy collection.

 *
@@ -353,7 +353,7 @@ static __u64 jent_loop_shuffle(struct rand_data *ec, 
	return (shuffle + (1<<min));

}



/**

/*

 * CPU Jitter noise source -- this is the noise source based on the CPU

 *			      execution time jitter

 *
@@ -435,7 +435,7 @@ static void jent_lfsr_time(struct rand_data *ec, __u64 time, __u64 loop_cnt, 
		ec->data = new;

}



/**

/*

 * Memory Access noise source -- this is a noise source based on variations in

 *				 memory access times

 *
@@ -500,7 +500,7 @@ static void jent_memaccess(struct rand_data *ec, __u64 loop_cnt) 
/***************************************************************************

 * Start of entropy processing logic

 ***************************************************************************/

/**

/*

 * This is the heart of the entropy generation: calculate time deltas and

 * use the CPU jitter in the time deltas. The jitter is injected into the

 * entropy pool.
@@ -539,7 +539,7 @@ static int jent_measure_jitter(struct rand_data *ec) 
	return stuck;

}



/**

/*

 * Generator of one 64 bit random number

 * Function fills rand_data->data

 *
@@ -566,7 +566,7 @@ static void jent_gen_entropy(struct rand_data *ec) 
	}

}



/**

/*

 * Entry function: Obtain entropy for the caller.

 *

 * This function invokes the entropy gathering logic as often to generate