Tweak wording of serial-FIPS202 config

hanno-becker · mkannwischer · commit 43dfe79abd9f · 2025-10-19T16:06:07.000+08:00
Signed-off-by: Hanno Becker &lt;beckphan@amazon.co.uk&gt;
diff --git a/examples/basic_deterministic/mlkem_native/custom_no_randomized_config.h b/examples/basic_deterministic/mlkem_native/custom_no_randomized_config.h
@@ -509,7 +509,11 @@
 /******************************************************************************
  * Name:        MLK_CONFIG_SERIAL_FIPS202_ONLY
  *
- * Description: If this option is set, batched Keccak operations will be
+ * Description: Set this to use a FIPS202 implementation with global state
+ *              that supports only one active Keccak computation at a time
+ *              (e.g. some hardware accelerators).
+ *
+ *              If this option is set, batched Keccak operations are
  *              disabled for rejection sampling during matrix generation.
  *              Instead, matrix entries will be generated one at a time.
  *
diff --git a/mlkem/src/config.h b/mlkem/src/config.h
@@ -509,7 +509,11 @@
 /******************************************************************************
  * Name:        MLK_CONFIG_SERIAL_FIPS202_ONLY
  *
- * Description: If this option is set, batched Keccak operations will be
+ * Description: Set this to use a FIPS202 implementation with global state
+ *              that supports only one active Keccak computation at a time
+ *              (e.g. some hardware accelerators).
+ *
+ *              If this option is set, batched Keccak operations are
  *              disabled for rejection sampling during matrix generation.
  *              Instead, matrix entries will be generated one at a time.
  *
diff --git a/test/break_pct_config.h b/test/break_pct_config.h
@@ -313,7 +313,11 @@ static MLK_INLINE int mlk_break_pct(void)
 /******************************************************************************
  * Name:        MLK_CONFIG_SERIAL_FIPS202_ONLY
  *
- * Description: If this option is set, batched Keccak operations will be
+ * Description: Set this to use a FIPS202 implementation with global state
+ *              that supports only one active Keccak computation at a time
+ *              (e.g. some hardware accelerators).
+ *
+ *              If this option is set, batched Keccak operations are
  *              disabled for rejection sampling during matrix generation.
  *              Instead, matrix entries will be generated one at a time.
  *
diff --git a/test/custom_memcpy_config.h b/test/custom_memcpy_config.h
@@ -466,7 +466,11 @@ static MLK_INLINE void *mlk_memcpy(void *dest, const void *src, size_t n)
 /******************************************************************************
  * Name:        MLK_CONFIG_SERIAL_FIPS202_ONLY
  *
- * Description: If this option is set, batched Keccak operations will be
+ * Description: Set this to use a FIPS202 implementation with global state
+ *              that supports only one active Keccak computation at a time
+ *              (e.g. some hardware accelerators).
+ *
+ *              If this option is set, batched Keccak operations are
  *              disabled for rejection sampling during matrix generation.
  *              Instead, matrix entries will be generated one at a time.
  *
diff --git a/test/custom_memset_config.h b/test/custom_memset_config.h
@@ -465,7 +465,11 @@ static MLK_INLINE void *mlk_memset(void *s, int c, size_t n)
 /******************************************************************************
  * Name:        MLK_CONFIG_SERIAL_FIPS202_ONLY
  *
- * Description: If this option is set, batched Keccak operations will be
+ * Description: Set this to use a FIPS202 implementation with global state
+ *              that supports only one active Keccak computation at a time
+ *              (e.g. some hardware accelerators).
+ *
+ *              If this option is set, batched Keccak operations are
  *              disabled for rejection sampling during matrix generation.
  *              Instead, matrix entries will be generated one at a time.
  *
diff --git a/test/custom_native_capability_config_0.h b/test/custom_native_capability_config_0.h
@@ -366,7 +366,11 @@ static MLK_INLINE int mlk_sys_check_capability(mlk_sys_cap cap)
 /******************************************************************************
  * Name:        MLK_CONFIG_SERIAL_FIPS202_ONLY
  *
- * Description: If this option is set, batched Keccak operations will be
+ * Description: Set this to use a FIPS202 implementation with global state
+ *              that supports only one active Keccak computation at a time
+ *              (e.g. some hardware accelerators).
+ *
+ *              If this option is set, batched Keccak operations are
  *              disabled for rejection sampling during matrix generation.
  *              Instead, matrix entries will be generated one at a time.
  *
diff --git a/test/custom_native_capability_config_1.h b/test/custom_native_capability_config_1.h
@@ -365,7 +365,11 @@ static MLK_INLINE int mlk_sys_check_capability(mlk_sys_cap cap)
 /******************************************************************************
  * Name:        MLK_CONFIG_SERIAL_FIPS202_ONLY
  *
- * Description: If this option is set, batched Keccak operations will be
+ * Description: Set this to use a FIPS202 implementation with global state
+ *              that supports only one active Keccak computation at a time
+ *              (e.g. some hardware accelerators).
+ *
+ *              If this option is set, batched Keccak operations are
  *              disabled for rejection sampling during matrix generation.
  *              Instead, matrix entries will be generated one at a time.
  *
diff --git a/test/custom_native_capability_config_CPUID_AVX2.h b/test/custom_native_capability_config_CPUID_AVX2.h
@@ -397,7 +397,11 @@ static MLK_INLINE int mlk_sys_check_capability(mlk_sys_cap cap)
 /******************************************************************************
  * Name:        MLK_CONFIG_SERIAL_FIPS202_ONLY
  *
- * Description: If this option is set, batched Keccak operations will be
+ * Description: Set this to use a FIPS202 implementation with global state
+ *              that supports only one active Keccak computation at a time
+ *              (e.g. some hardware accelerators).
+ *
+ *              If this option is set, batched Keccak operations are
  *              disabled for rejection sampling during matrix generation.
  *              Instead, matrix entries will be generated one at a time.
  *
diff --git a/test/custom_native_capability_config_ID_AA64PFR1_EL1.h b/test/custom_native_capability_config_ID_AA64PFR1_EL1.h
@@ -384,7 +384,11 @@ static MLK_INLINE int mlk_sys_check_capability(mlk_sys_cap cap)
 /******************************************************************************
  * Name:        MLK_CONFIG_SERIAL_FIPS202_ONLY
  *
- * Description: If this option is set, batched Keccak operations will be
+ * Description: Set this to use a FIPS202 implementation with global state
+ *              that supports only one active Keccak computation at a time
+ *              (e.g. some hardware accelerators).
+ *
+ *              If this option is set, batched Keccak operations are
  *              disabled for rejection sampling during matrix generation.
  *              Instead, matrix entries will be generated one at a time.
  *
diff --git a/test/custom_randombytes_config.h b/test/custom_randombytes_config.h
@@ -362,7 +362,11 @@ static MLK_INLINE void mlk_randombytes(uint8_t *ptr, size_t len)
 /******************************************************************************
  * Name:        MLK_CONFIG_SERIAL_FIPS202_ONLY
  *
- * Description: If this option is set, batched Keccak operations will be
+ * Description: Set this to use a FIPS202 implementation with global state
+ *              that supports only one active Keccak computation at a time
+ *              (e.g. some hardware accelerators).
+ *
+ *              If this option is set, batched Keccak operations are
  *              disabled for rejection sampling during matrix generation.
  *              Instead, matrix entries will be generated one at a time.
  *
diff --git a/test/custom_stdlib_config.h b/test/custom_stdlib_config.h
@@ -472,7 +472,11 @@ static MLK_INLINE void *mlk_memset(void *s, int c, size_t n)
 /******************************************************************************
  * Name:        MLK_CONFIG_SERIAL_FIPS202_ONLY
  *
- * Description: If this option is set, batched Keccak operations will be
+ * Description: Set this to use a FIPS202 implementation with global state
+ *              that supports only one active Keccak computation at a time
+ *              (e.g. some hardware accelerators).
+ *
+ *              If this option is set, batched Keccak operations are
  *              disabled for rejection sampling during matrix generation.
  *              Instead, matrix entries will be generated one at a time.
  *
diff --git a/test/custom_zeroize_config.h b/test/custom_zeroize_config.h
@@ -333,7 +333,11 @@ static MLK_INLINE void mlk_zeroize(void *ptr, size_t len)
 /******************************************************************************
  * Name:        MLK_CONFIG_SERIAL_FIPS202_ONLY
  *
- * Description: If this option is set, batched Keccak operations will be
+ * Description: Set this to use a FIPS202 implementation with global state
+ *              that supports only one active Keccak computation at a time
+ *              (e.g. some hardware accelerators).
+ *
+ *              If this option is set, batched Keccak operations are
  *              disabled for rejection sampling during matrix generation.
  *              Instead, matrix entries will be generated one at a time.
  *
diff --git a/test/no_asm_config.h b/test/no_asm_config.h
@@ -333,7 +333,11 @@ static MLK_INLINE void mlk_zeroize(void *ptr, size_t len)
 /******************************************************************************
  * Name:        MLK_CONFIG_SERIAL_FIPS202_ONLY
  *
- * Description: If this option is set, batched Keccak operations will be
+ * Description: Set this to use a FIPS202 implementation with global state
+ *              that supports only one active Keccak computation at a time
+ *              (e.g. some hardware accelerators).
+ *
+ *              If this option is set, batched Keccak operations are
  *              disabled for rejection sampling during matrix generation.
  *              Instead, matrix entries will be generated one at a time.
  *
diff --git a/test/serial_fips202_config.h b/test/serial_fips202_config.h
@@ -494,7 +494,11 @@
 /******************************************************************************
  * Name:        MLK_CONFIG_SERIAL_FIPS202_ONLY
  *
- * Description: If this option is set, batched Keccak operations will be
+ * Description: Set this to use a FIPS202 implementation with global state
+ *              that supports only one active Keccak computation at a time
+ *              (e.g. some hardware accelerators).
+ *
+ *              If this option is set, batched Keccak operations are
  *              disabled for rejection sampling during matrix generation.
  *              Instead, matrix entries will be generated one at a time.
  *

Original file line number	Diff line number	Diff line change
`@@ -509,7 +509,11 @@`
`509`	`509`	`/******************************************************************************`
`510`	`510`	`* Name: MLK_CONFIG_SERIAL_FIPS202_ONLY`
`511`	`511`	`*`
`512`		`- * Description: If this option is set, batched Keccak operations will be`
	`512`	`+ * Description: Set this to use a FIPS202 implementation with global state`
	`513`	`+ * that supports only one active Keccak computation at a time`
	`514`	`+ * (e.g. some hardware accelerators).`
	`515`	`+ *`
	`516`	`+ * If this option is set, batched Keccak operations are`
`513`	`517`	`* disabled for rejection sampling during matrix generation.`
`514`	`518`	`* Instead, matrix entries will be generated one at a time.`
`515`	`519`	`*`
Original file line number	Diff line number	Diff line change
`@@ -313,7 +313,11 @@ static MLK_INLINE int mlk_break_pct(void)`
`313`	`313`	`/******************************************************************************`
`314`	`314`	`* Name: MLK_CONFIG_SERIAL_FIPS202_ONLY`
`315`	`315`	`*`
`316`		`- * Description: If this option is set, batched Keccak operations will be`
	`316`	`+ * Description: Set this to use a FIPS202 implementation with global state`
	`317`	`+ * that supports only one active Keccak computation at a time`
	`318`	`+ * (e.g. some hardware accelerators).`
	`319`	`+ *`
	`320`	`+ * If this option is set, batched Keccak operations are`
`317`	`321`	`* disabled for rejection sampling during matrix generation.`
`318`	`322`	`* Instead, matrix entries will be generated one at a time.`
`319`	`323`	`*`
Original file line number	Diff line number	Diff line change
`@@ -466,7 +466,11 @@ static MLK_INLINE void mlk_memcpy(void dest, const void *src, size_t n)`
`466`	`466`	`/******************************************************************************`
`467`	`467`	`* Name: MLK_CONFIG_SERIAL_FIPS202_ONLY`
`468`	`468`	`*`
`469`		`- * Description: If this option is set, batched Keccak operations will be`
	`469`	`+ * Description: Set this to use a FIPS202 implementation with global state`
	`470`	`+ * that supports only one active Keccak computation at a time`
	`471`	`+ * (e.g. some hardware accelerators).`
	`472`	`+ *`
	`473`	`+ * If this option is set, batched Keccak operations are`
`470`	`474`	`* disabled for rejection sampling during matrix generation.`
`471`	`475`	`* Instead, matrix entries will be generated one at a time.`
`472`	`476`	`*`
Original file line number	Diff line number	Diff line change
`@@ -465,7 +465,11 @@ static MLK_INLINE void mlk_memset(void s, int c, size_t n)`
`465`	`465`	`/******************************************************************************`
`466`	`466`	`* Name: MLK_CONFIG_SERIAL_FIPS202_ONLY`
`467`	`467`	`*`
`468`		`- * Description: If this option is set, batched Keccak operations will be`
	`468`	`+ * Description: Set this to use a FIPS202 implementation with global state`
	`469`	`+ * that supports only one active Keccak computation at a time`
	`470`	`+ * (e.g. some hardware accelerators).`
	`471`	`+ *`
	`472`	`+ * If this option is set, batched Keccak operations are`
`469`	`473`	`* disabled for rejection sampling during matrix generation.`
`470`	`474`	`* Instead, matrix entries will be generated one at a time.`
`471`	`475`	`*`
Original file line number	Diff line number	Diff line change
`@@ -366,7 +366,11 @@ static MLK_INLINE int mlk_sys_check_capability(mlk_sys_cap cap)`
`366`	`366`	`/******************************************************************************`
`367`	`367`	`* Name: MLK_CONFIG_SERIAL_FIPS202_ONLY`
`368`	`368`	`*`
`369`		`- * Description: If this option is set, batched Keccak operations will be`
	`369`	`+ * Description: Set this to use a FIPS202 implementation with global state`
	`370`	`+ * that supports only one active Keccak computation at a time`
	`371`	`+ * (e.g. some hardware accelerators).`
	`372`	`+ *`
	`373`	`+ * If this option is set, batched Keccak operations are`
`370`	`374`	`* disabled for rejection sampling during matrix generation.`
`371`	`375`	`* Instead, matrix entries will be generated one at a time.`
`372`	`376`	`*`
Original file line number	Diff line number	Diff line change
`@@ -365,7 +365,11 @@ static MLK_INLINE int mlk_sys_check_capability(mlk_sys_cap cap)`
`365`	`365`	`/******************************************************************************`
`366`	`366`	`* Name: MLK_CONFIG_SERIAL_FIPS202_ONLY`
`367`	`367`	`*`
`368`		`- * Description: If this option is set, batched Keccak operations will be`
	`368`	`+ * Description: Set this to use a FIPS202 implementation with global state`
	`369`	`+ * that supports only one active Keccak computation at a time`
	`370`	`+ * (e.g. some hardware accelerators).`
	`371`	`+ *`
	`372`	`+ * If this option is set, batched Keccak operations are`
`369`	`373`	`* disabled for rejection sampling during matrix generation.`
`370`	`374`	`* Instead, matrix entries will be generated one at a time.`
`371`	`375`	`*`
Original file line number	Diff line number	Diff line change
`@@ -397,7 +397,11 @@ static MLK_INLINE int mlk_sys_check_capability(mlk_sys_cap cap)`
`397`	`397`	`/******************************************************************************`
`398`	`398`	`* Name: MLK_CONFIG_SERIAL_FIPS202_ONLY`
`399`	`399`	`*`
`400`		`- * Description: If this option is set, batched Keccak operations will be`
	`400`	`+ * Description: Set this to use a FIPS202 implementation with global state`
	`401`	`+ * that supports only one active Keccak computation at a time`
	`402`	`+ * (e.g. some hardware accelerators).`
	`403`	`+ *`
	`404`	`+ * If this option is set, batched Keccak operations are`
`401`	`405`	`* disabled for rejection sampling during matrix generation.`
`402`	`406`	`* Instead, matrix entries will be generated one at a time.`
`403`	`407`	`*`
Original file line number	Diff line number	Diff line change
`@@ -384,7 +384,11 @@ static MLK_INLINE int mlk_sys_check_capability(mlk_sys_cap cap)`
`384`	`384`	`/******************************************************************************`
`385`	`385`	`* Name: MLK_CONFIG_SERIAL_FIPS202_ONLY`
`386`	`386`	`*`
`387`		`- * Description: If this option is set, batched Keccak operations will be`
	`387`	`+ * Description: Set this to use a FIPS202 implementation with global state`
	`388`	`+ * that supports only one active Keccak computation at a time`
	`389`	`+ * (e.g. some hardware accelerators).`
	`390`	`+ *`
	`391`	`+ * If this option is set, batched Keccak operations are`
`388`	`392`	`* disabled for rejection sampling during matrix generation.`
`389`	`393`	`* Instead, matrix entries will be generated one at a time.`
`390`	`394`	`*`
Original file line number	Diff line number	Diff line change
`@@ -362,7 +362,11 @@ static MLK_INLINE void mlk_randombytes(uint8_t *ptr, size_t len)`
`362`	`362`	`/******************************************************************************`
`363`	`363`	`* Name: MLK_CONFIG_SERIAL_FIPS202_ONLY`
`364`	`364`	`*`
`365`		`- * Description: If this option is set, batched Keccak operations will be`
	`365`	`+ * Description: Set this to use a FIPS202 implementation with global state`
	`366`	`+ * that supports only one active Keccak computation at a time`
	`367`	`+ * (e.g. some hardware accelerators).`
	`368`	`+ *`
	`369`	`+ * If this option is set, batched Keccak operations are`
`366`	`370`	`* disabled for rejection sampling during matrix generation.`
`367`	`371`	`* Instead, matrix entries will be generated one at a time.`
`368`	`372`	`*`