ec: change usage of "sane" per inclusive language

Google is working to change its source code to use more inclusive
language. To that end, replace the terms "sane", "sanity check", and
similar with inclusive/non-stigmatizing alternatives.

BUG=b:161832469
BRANCH=None
TEST=`make buildall -j` succeeds. `grep -Eir "sane|sanity" .` shows
results only in third-party code or documentation.

Signed-off-by: Paul Fagerburg <pfagerburg@chromium.org>
Change-Id: I29e78ab27f84f17b1ded75cfa10868fa4e5ae88c
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2311169
Reviewed-by: Jett Rink <jettrink@chromium.org>

9 files changed, 13 insertions, 13 deletions

diff --git a/common/blink.c b/common/blink.c
index 4231e38195..ed16146f5a 100644
--- a/common/blink.c
+++ b/common/blink.c
@@ -3,7 +3,7 @@
  * found in the LICENSE file.
  */
 
-/* This is a sanity check program for boards that have LEDs. */
+/* This is a confidence check program for boards that have LEDs. */
 
 #include "common.h"
 #include "gpio.h"
diff --git a/common/keyboard_mkbp.c b/common/keyboard_mkbp.c
index 0902a434d7..45cd50f4f5 100644
--- a/common/keyboard_mkbp.c
+++ b/common/keyboard_mkbp.c
@@ -696,7 +696,7 @@ static void keyscan_copy_config(const struct ec_mkbp_config *src,
 	uint8_t new_flags;
 
 	if (valid_mask & EC_MKBP_VALID_FIFO_MAX_DEPTH) {
-		/* Sanity check for fifo depth */
+		/* Validity check for fifo depth */
 		dst->fifo_max_depth = MIN(src->fifo_max_depth,
 					  FIFO_DEPTH);
 	}
diff --git a/common/mag_cal.c b/common/mag_cal.c
index f7b1945933..13beb93af2 100644
--- a/common/mag_cal.c
+++ b/common/mag_cal.c
@@ -41,8 +41,8 @@ static inline fp_t covariance_element(fp_t sq, fp_t a, fp_t b, fp_t inv)
 /*
  * eigen value magnitude and ratio test
  *
- * Using the magnetometer information, caculate the 3 eigen values/vectors
- * for the transformation. Check the eigen values are sane.
+ * Using the magnetometer information, calculate the 3 eigen values/vectors
+ * for the transformation. Check the eigen values are reasonable.
  */
 static int moc_eigen_test(struct mag_cal_t *moc)
 {
diff --git a/common/printf.c b/common/printf.c
index 4a28bac215..f876a1da19 100644
--- a/common/printf.c
+++ b/common/printf.c
@@ -182,7 +182,7 @@ int vfnprintf(int (*addchar)(void *context, int c), void *context,
 			}
 		}
 		if (pad_width < 0 || pad_width > MAX_FORMAT) {
-			/* Sanity check for precision failed */
+			/* Validity check for precision failed */
 			format = error_str;
 			continue;
 		}
@@ -202,7 +202,7 @@ int vfnprintf(int (*addchar)(void *context, int c), void *context,
 				}
 			}
 			if (precision < 0 || precision > MAX_FORMAT) {
-				/* Sanity check for precision failed */
+				/* Validity check for precision failed */
 				format = error_str;
 				continue;
 			}
diff --git a/common/rwsig.c b/common/rwsig.c
index 86d77144d8..e23ca23293 100644
--- a/common/rwsig.c
+++ b/common/rwsig.c
@@ -163,7 +163,7 @@ int rwsig_check_signature(void)
 	    vb21_sig->sig_size != RSANUMBYTES ||
 	    vb21_key->sig_alg != vb21_sig->sig_alg ||
 	    vb21_key->hash_alg != vb21_sig->hash_alg ||
-	    /* Sanity check signature offset and data size. */
+	    /* Validity check signature offset and data size. */
 	    vb21_sig->sig_offset < sizeof(vb21_sig) ||
 	    (vb21_sig->sig_offset + RSANUMBYTES) > CONFIG_RW_SIG_SIZE ||
 	    vb21_sig->data_size > (CONFIG_RW_SIZE - CONFIG_RW_SIG_SIZE)) {
diff --git a/common/temp_sensor.c b/common/temp_sensor.c
index 819da155ac..0f687bb2a2 100644
--- a/common/temp_sensor.c
+++ b/common/temp_sensor.c
@@ -67,8 +67,8 @@ static void temp_sensor_init(void)
 
 	/*
 	 * Initialize memory-mapped data so that if a temperature value is read
-	 * before we actually poll the sensors, we don't end up with an insane
-	 * value.
+	 * before we actually poll the sensors, we don't return an impossible
+	 * or out-of-range value.
 	 */
 	base = host_get_memmap(EC_MEMMAP_TEMP_SENSOR);
 	base_b = host_get_memmap(EC_MEMMAP_TEMP_SENSOR_B);
diff --git a/common/thermal.c b/common/thermal.c
index b39dab04cd..d1cc47e924 100644
--- a/common/thermal.c
+++ b/common/thermal.c
@@ -42,7 +42,7 @@ int thermal_fan_percent(int low, int high, int cur)
 }
 
 /* The logic below is hard-coded for only three thresholds: WARN, HIGH, HALT.
- * This is just a sanity check to be sure we catch any changes in thermal.h
+ * This is just a validity check to be sure we catch any changes in thermal.h
  */
 BUILD_ASSERT(EC_TEMP_THRESH_COUNT == 3);
 
diff --git a/common/vboot/vb21_lib.c b/common/vboot/vb21_lib.c
index a2b6993c13..4e215c14e5 100644
--- a/common/vboot/vb21_lib.c
+++ b/common/vboot/vb21_lib.c
@@ -35,7 +35,7 @@ int vb21_is_signature_valid(const struct vb21_signature *sig,
 		return EC_ERROR_VBOOT_SIG_ALGORITHM;
 	if (key->hash_alg != sig->hash_alg)
 		return EC_ERROR_VBOOT_HASH_ALGORITHM;
-	/* Sanity check signature offset and data size. */
+	/* Validity check signature offset and data size. */
 	if (sig->sig_offset < sizeof(*sig))
 		return EC_ERROR_VBOOT_SIG_OFFSET;
 	if (sig->sig_offset + RSANUMBYTES > CONFIG_RW_SIG_SIZE)
diff --git a/common/vboot_hash.c b/common/vboot_hash.c
index 10de58fcac..a08c707630 100644
--- a/common/vboot_hash.c
+++ b/common/vboot_hash.c
@@ -453,7 +453,7 @@ static void fill_response(struct ec_response_vboot_hash *r,
 }
 
 /**
- * Start computing a hash, with sanity checking on params.
+ * Start computing a hash, with validity checking on params.
  *
  * @return EC_RES_SUCCESS if success, or other result code on error.
  */
@@ -463,7 +463,7 @@ static int host_start_hash(const struct ec_params_vboot_hash *p)
 	int size = p->size;
 	int rv;
 
-	/* Sanity-check input params */
+	/* Validity-check input params */
 	if (p->hash_type != EC_VBOOT_HASH_TYPE_SHA256)
 		return EC_RES_INVALID_PARAM;
 	if (p->nonce_size > sizeof(p->nonce_data))