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, 39 insertions, 16 deletions

diff --git a/driver/fingerprint/elan/elan_private.c b/driver/fingerprint/elan/elan_private.c
index 555ad14ba0..bb6fad4972 100644
--- a/driver/fingerprint/elan/elan_private.c
+++ b/driver/fingerprint/elan/elan_private.c
@@ -34,17 +34,17 @@ static struct ec_response_fp_info ec_fp_sensor_info = {
 	.model_id = MID,
 	.version = VERSION,
 	/* Image frame characteristics */
-	.frame_size = FP_SENSOR_RES_X * FP_SENSOR_RES_Y,
+	.frame_size = FP_SENSOR_RES_X_ELAN * FP_SENSOR_RES_Y_ELAN,
 	.pixel_format = V4L2_PIX_FMT_GREY,
-	.width = FP_SENSOR_RES_X,
-	.height = FP_SENSOR_RES_Y,
+	.width = FP_SENSOR_RES_X_ELAN,
+	.height = FP_SENSOR_RES_Y_ELAN,
 	.bpp = FP_SENSOR_RES_BPP,
 };
 
 /**
  * set fingerprint sensor into power saving mode
  */
-void fp_sensor_low_power(void)
+void fp_sensor_low_power_elan(void)
 {
 	elan_woe_mode();
 }
@@ -52,7 +52,7 @@ void fp_sensor_low_power(void)
 /**
  * Reset and initialize the sensor IC
  */
-int fp_sensor_init(void)
+int fp_sensor_init_elan(void)
 {
 	CPRINTF("========%s=======\n", __func__);
 
@@ -70,7 +70,7 @@ int fp_sensor_init(void)
 /**
  * Deinitialize the sensor IC
  */
-int fp_sensor_deinit(void)
+int fp_sensor_deinit_elan(void)
 {
 	CPRINTF("========%s=======\n", __func__);
 	return elan_fp_deinit();
@@ -83,7 +83,7 @@ int fp_sensor_deinit(void)
  *
  * @return EC_SUCCESS on success otherwise error.
  */
-int fp_sensor_get_info(struct ec_response_fp_info *resp)
+int fp_sensor_get_info_elan(struct ec_response_fp_info *resp)
 {
 	int ret = 0;
 
@@ -119,8 +119,8 @@ int fp_sensor_get_info(struct ec_response_fp_info *resp)
  * - EC_MKBP_FP_ERR_MATCH_LOW_COVERAGE when matching could not be performed
  *   due to finger covering too little area of the sensor
  */
-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_elan(void *templ, uint32_t templ_count, uint8_t *image,
+			 int32_t *match_index, uint32_t *update_bitmap)
 {
 	CPRINTF("========%s=======\n", __func__);
 	return elan_match(templ, templ_count, image, match_index,
@@ -133,7 +133,7 @@ int fp_finger_match(void *templ, uint32_t templ_count, uint8_t *image,
  * @return 0 on success.
  *
  */
-int fp_enrollment_begin(void)
+int fp_enrollment_begin_elan(void)
 {
 	CPRINTF("========%s=======\n", __func__);
 	return elan_enrollment_begin();
@@ -149,7 +149,7 @@ int fp_enrollment_begin(void)
  *
  * @return 0 on success or a negative error code.
  */
-int fp_enrollment_finish(void *templ)
+int fp_enrollment_finish_elan(void *templ)
 {
 	CPRINTF("========%s=======\n", __func__);
 	return elan_enrollment_finish(templ);
@@ -170,7 +170,7 @@ int fp_enrollment_finish(void *templ)
  * - EC_MKBP_FP_ERR_ENROLL_LOW_COVERAGE when image could not be used due to
  *   finger covering too little area of the sensor
  */
-int fp_finger_enroll(uint8_t *image, int *completion)
+int fp_finger_enroll_elan(uint8_t *image, int *completion)
 {
 	CPRINTF("========%s=======\n", __func__);
 	return elan_enroll(image, completion);
@@ -182,7 +182,7 @@ int fp_finger_enroll(uint8_t *image, int *completion)
  * fp_sensor_configure_detect needs to be called to restore finger detection
  * functionality.
  */
-void fp_sensor_configure_detect(void)
+void fp_sensor_configure_detect_elan(void)
 {
 	CPRINTF("========%s=======\n", __func__);
 	elan_woe_mode();
@@ -211,7 +211,7 @@ void fp_sensor_configure_detect(void)
  * - FP_SENSOR_TOO_FAST on finger removed before image was captured
  * - FP_SENSOR_LOW_SENSOR_COVERAGE on sensor not fully covered by finger
  */
-int fp_sensor_acquire_image_with_mode(uint8_t *image_data, int mode)
+int fp_sensor_acquire_image_with_mode_elan(uint8_t *image_data, int mode)
 {
 	CPRINTF("========%s=======\n", __func__);
 	return elan_sensor_acquire_image_with_mode(image_data, mode);
@@ -225,7 +225,7 @@ int fp_sensor_acquire_image_with_mode(uint8_t *image_data, int mode)
  * - FINGER_PARTIAL
  * - FINGER_PRESENT
  */
-enum finger_state fp_sensor_finger_status(void)
+enum finger_state fp_sensor_finger_status_elan(void)
 {
 	CPRINTF("========%s=======\n", __func__);
 	return elan_sensor_finger_status();
@@ -240,8 +240,31 @@ enum finger_state fp_sensor_finger_status(void)
  * @return EC_ERROR_HW_INTERNAL on error (such as finger on sensor)
  * @return EC_SUCCESS on success
  */
-int fp_maintenance(void)
+int fp_maintenance_elan(void)
 {
 	CPRINTF("========%s=======\n", __func__);
 	return elan_fp_maintenance(&errors);
 }
+
+struct fp_sensor_interface fp_driver_elan = {
+	.sensor_type = FP_SENSOR_TYPE_ELAN,
+	.fp_sensor_init = &fp_sensor_init_elan,
+	.fp_sensor_deinit = &fp_sensor_deinit_elan,
+	.fp_sensor_get_info = &fp_sensor_get_info_elan,
+	.fp_sensor_low_power = &fp_sensor_low_power_elan,
+	.fp_sensor_configure_detect_ = &fp_sensor_configure_detect_elan,
+	.fp_sensor_finger_status_ = &fp_sensor_finger_status_elan,
+	.fp_sensor_acquire_image_with_mode_ =
+		&fp_sensor_acquire_image_with_mode_elan,
+	.fp_finger_enroll = &fp_finger_enroll_elan,
+	.fp_finger_match = &fp_finger_match_elan,
+	.fp_enrollment_begin = &fp_enrollment_begin_elan,
+	.fp_enrollment_finish = &fp_enrollment_finish_elan,
+	.fp_maintenance = &fp_maintenance_elan,
+	.algorithm_template_size = FP_ALGORITHM_TEMPLATE_SIZE_ELAN,
+	.encrypted_template_size =
+		FP_ALGORITHM_TEMPLATE_SIZE_ELAN + FP_POSITIVE_MATCH_SALT_BYTES +
+		sizeof(struct ec_fp_template_encryption_metadata),
+	.res_x = FP_SENSOR_RES_X_ELAN,
+	.res_y = FP_SENSOR_RES_Y_ELAN
+};