fpsensor: Support building firmware that works for both sensors

This is a refactoring to allow building FPMCU firmware that works for
one FPC sensor and one ELAN sensor.

1. When both drivers implement our common functions, e.g. fp_sensor_init(),
   rename them to fp_sensor_init_fpc() and fp_sensor_init_elan().
2. There are a few functions implemented not in FPC driver but in FPC
   private library, e.g. fp_sensor_finger_status(). I kept this as-is for
   FPC but renamed the one in ELAN driver to fp_sensor_finger_status_elan()
3. If building for ELAN, need to hardcode elan=1 in hatch_fp/board.c
   because the sensor type GPIO always says FPC.

BRANCH=none
BUG=b:175158241
TEST=make run-fpsensor; make run-fpsensor_status;
     make run-fpsensor_crypto
TEST=make -j BOARD=dartmonkey
TEST=add CONFIG_FP_SENSOR_ELAN515 to board/hatch_fp/board.h;
     make -j BOARD=bloonchipper
     Firmware binary fully works on Dragonair (FPC) and Voema (ELAN)
TEST=run device tests with http://crrev/c/2750547 and
	http://crrev/i/3654297 on Dragonclaw, all pass

Change-Id: I789090dbdfe35ac6aefd6a629fa4c7bde89dc437
Signed-off-by: Yicheng Li <yichengli@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2727971
Reviewed-by: Tom Hughes <tomhughes@chromium.org>
Commit-Queue: Tom Hughes <tomhughes@chromium.org>

1 files changed, 40 insertions, 16 deletions

diff --git a/driver/fingerprint/fpc/bep/fpc_private.c b/driver/fingerprint/fpc/bep/fpc_private.c
index 36ca0fe1b9..7df21c223c 100644
--- a/driver/fingerprint/fpc/bep/fpc_private.c
+++ b/driver/fingerprint/fpc/bep/fpc_private.c
@@ -8,6 +8,7 @@
 
 #include "fpc_bio_algorithm.h"
 #include "fpsensor.h"
+#include "fpsensor_fpc.h"
 #include "gpio.h"
 #include "spi.h"
 #include "system.h"
@@ -42,10 +43,10 @@ static struct ec_response_fp_info ec_fp_sensor_info = {
 	.model_id = 1,
 	.version = 1,
 	/* Image frame characteristics */
-	.frame_size = FP_SENSOR_IMAGE_SIZE,
+	.frame_size = FP_SENSOR_IMAGE_SIZE_FPC,
 	.pixel_format = V4L2_PIX_FMT_GREY,
-	.width = FP_SENSOR_RES_X,
-	.height = FP_SENSOR_RES_Y,
+	.width = FP_SENSOR_RES_X_FPC,
+	.height = FP_SENSOR_RES_Y_FPC,
 	.bpp = FP_SENSOR_RES_BPP,
 };
 
@@ -63,12 +64,12 @@ extern const fpc_bep_algorithm_t fpc_bep_algorithm_pfe_1025;
 
 const fpc_sensor_info_t fpc_sensor_info = {
 	.sensor = &fpc_bep_sensor_1025,
-	.image_buffer_size = FP_SENSOR_IMAGE_SIZE,
+	.image_buffer_size = FP_SENSOR_IMAGE_SIZE_FPC,
 };
 
 const fpc_bio_info_t fpc_bio_info = {
 	.algorithm = &fpc_bep_algorithm_pfe_1025,
-	.template_size = FP_ALGORITHM_TEMPLATE_SIZE,
+	.template_size = FP_ALGORITHM_TEMPLATE_SIZE_FPC,
 };
 
 #elif defined(CONFIG_FP_SENSOR_FPC1035)
@@ -109,7 +110,7 @@ static int fpc_send_cmd(const uint8_t cmd)
 			       SPI_READBACK_ALL);
 }
 
-void fp_sensor_low_power(void)
+void fp_sensor_low_power_fpc(void)
 {
 	fpc_send_cmd(FPC_CMD_DEEPSLEEP);
 }
@@ -139,7 +140,7 @@ static int fpc_check_hwid(void)
 }
 
 /* Reset and initialize the sensor IC */
-int fp_sensor_init(void)
+int fp_sensor_init_fpc(void)
 {
 	int rc;
 
@@ -172,13 +173,13 @@ int fp_sensor_init(void)
 	}
 
 	/* Go back to low power */
-	fp_sensor_low_power();
+	fp_sensor_low_power_fpc();
 
 	return EC_SUCCESS;
 }
 
 /* Deinitialize the sensor IC */
-int fp_sensor_deinit(void)
+int fp_sensor_deinit_fpc(void)
 {
 	int rc;
 
@@ -193,7 +194,7 @@ int fp_sensor_deinit(void)
 	return rc;
 }
 
-int fp_sensor_get_info(struct ec_response_fp_info *resp)
+int fp_sensor_get_info_fpc(struct ec_response_fp_info *resp)
 {
 	int rc;
 
@@ -212,8 +213,8 @@ int fp_sensor_get_info(struct ec_response_fp_info *resp)
 	return EC_SUCCESS;
 }
 
-int fp_finger_match(void *templ, uint32_t templ_count, uint8_t *image,
-		    int32_t *match_index, uint32_t *update_bitmap)
+int fp_finger_match_fpc(void *templ, uint32_t templ_count, uint8_t *image,
+			int32_t *match_index, uint32_t *update_bitmap)
 {
 	int rc;
 
@@ -226,7 +227,7 @@ int fp_finger_match(void *templ, uint32_t templ_count, uint8_t *image,
 	return rc;
 }
 
-int fp_enrollment_begin(void)
+int fp_enrollment_begin_fpc(void)
 {
 	int rc;
 	bio_enrollment_t bio_enroll = enroll_ctx;
@@ -238,7 +239,7 @@ int fp_enrollment_begin(void)
 	return rc;
 }
 
-int fp_enrollment_finish(void *templ)
+int fp_enrollment_finish_fpc(void *templ)
 {
 	int rc;
 	bio_enrollment_t bio_enroll = enroll_ctx;
@@ -251,7 +252,7 @@ int fp_enrollment_finish(void *templ)
 	return rc;
 }
 
-int fp_finger_enroll(uint8_t *image, int *completion)
+int fp_finger_enroll_fpc(uint8_t *image, int *completion)
 {
 	int rc;
 	bio_enrollment_t bio_enroll = enroll_ctx;
@@ -268,7 +269,30 @@ int fp_finger_enroll(uint8_t *image, int *completion)
 	return rc;
 }
 
-int fp_maintenance(void)
+int fp_maintenance_fpc(void)
 {
 	return fpc_fp_maintenance(&errors);
 }
+
+struct fp_sensor_interface fp_driver_fpc = {
+	.sensor_type = FP_SENSOR_TYPE_FPC,
+	.fp_sensor_init = &fp_sensor_init_fpc,
+	.fp_sensor_deinit = &fp_sensor_deinit_fpc,
+	.fp_sensor_get_info = &fp_sensor_get_info_fpc,
+	.fp_sensor_low_power = &fp_sensor_low_power_fpc,
+	.fp_sensor_configure_detect_ = &fp_sensor_configure_detect,
+	.fp_sensor_finger_status_ = &fp_sensor_finger_status,
+	.fp_sensor_acquire_image_with_mode_ =
+		&fp_sensor_acquire_image_with_mode,
+	.fp_finger_enroll = &fp_finger_enroll_fpc,
+	.fp_finger_match = &fp_finger_match_fpc,
+	.fp_enrollment_begin = &fp_enrollment_begin_fpc,
+	.fp_enrollment_finish = &fp_enrollment_finish_fpc,
+	.fp_maintenance = &fp_maintenance_fpc,
+	.algorithm_template_size = FP_ALGORITHM_TEMPLATE_SIZE_FPC,
+	.encrypted_template_size =
+		FP_ALGORITHM_TEMPLATE_SIZE_FPC + FP_POSITIVE_MATCH_SALT_BYTES +
+		sizeof(struct ec_fp_template_encryption_metadata),
+	.res_x = FP_SENSOR_RES_X_FPC,
+	.res_y = FP_SENSOR_RES_Y_FPC
+};