GCC Code Coverage Report

Directory: ./
File: libfprint/drivers/synaptics/bmkt_message.c
Date: 2025-08-09 07:40:30
Exec Total Coverage
Lines: 87 174 50.0%
Functions: 5 10 50.0%
Branches: 21 60 35.0%
Line Branch Exec Source
1 /*
2 * Copyright (C) 2019 Synaptics Inc
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19 #include <glib.h>
20 #include "bmkt_response.h"
21 #include "bmkt_message.h"
22
23 static uint8_t
24 12 extract8 (const uint8_t *buf, int *offset)
25 {
26 12 uint8_t ret = 0;
27 12 int off = 0;
28
29 12 if (offset)
30 ✗ off = *offset;
31
32 12 ret = *(buf + off);
33
34 12 if (offset)
35 ✗ *offset += 1;
36
37 12 return ret;
38 }
39
40
41 static int
42 1 parse_error_response (bmkt_msg_resp_t *msg_resp, bmkt_response_t *resp)
43 {
44 1 if (msg_resp->payload_len != 2)
45 return BMKT_UNRECOGNIZED_MESSAGE;
46
47 1 resp->result = (msg_resp->payload[0] << 8) | msg_resp->payload[1];
48
49 1 return BMKT_SUCCESS;
50 }
51
52 static int
53 1 parse_init_ok (bmkt_msg_resp_t *msg_resp, bmkt_response_t *resp)
54 {
55 1 bmkt_init_resp_t *init_resp = &resp->response.init_resp;
56
57 1 if (msg_resp->payload_len != 1)
58 return BMKT_UNRECOGNIZED_MESSAGE;
59
60 1 init_resp->finger_presence = extract8 (msg_resp->payload, NULL);
61
62 1 return BMKT_SUCCESS;
63 }
64
65
66 static int
67 ✗ parse_fps_mode_report (bmkt_msg_resp_t *msg_resp, bmkt_response_t *resp)
68 {
69 ✗ int offset = 0;
70 ✗ bmkt_fps_mode_resp_t *fps_mode_resp = &resp->response.fps_mode_resp;
71
72 ✗ if (msg_resp->payload_len != sizeof (bmkt_fps_mode_resp_t))
73 return BMKT_UNRECOGNIZED_MESSAGE;
74
75 ✗ fps_mode_resp->mode = extract8 (msg_resp->payload, &offset);
76 ✗ fps_mode_resp->level2_mode = extract8 (msg_resp->payload, &offset);
77 ✗ fps_mode_resp->cmd_id = extract8 (msg_resp->payload, &offset);
78 ✗ fps_mode_resp->finger_presence = extract8 (msg_resp->payload, &offset);
79
80 ✗ return BMKT_SUCCESS;
81 }
82
83 static int
84 9 parse_enroll_report (bmkt_msg_resp_t *msg_resp, bmkt_response_t *resp)
85 {
86 9 bmkt_enroll_resp_t *enroll_resp = &resp->response.enroll_resp;
87
88 9 if (msg_resp->payload_len != 1)
89 return BMKT_UNRECOGNIZED_MESSAGE;
90
91 9 enroll_resp->progress = extract8 (msg_resp->payload, NULL);
92
93 9 return BMKT_SUCCESS;
94 }
95
96 static int
97 1 parse_enroll_ok (bmkt_msg_resp_t *msg_resp, bmkt_response_t *resp)
98 {
99 1 bmkt_enroll_resp_t *enroll_resp = &resp->response.enroll_resp;
100
101
1/2
✓ Branch 0 (2→3) taken 1 times.
✗ Branch 1 (2→4) not taken.
 1 if (msg_resp->payload_len < 1 || msg_resp->payload_len > (BMKT_MAX_USER_ID_LEN + 1))
102 return BMKT_UNRECOGNIZED_MESSAGE;
103
104 1 enroll_resp->finger_id = msg_resp->payload[0];
105 1 memcpy (enroll_resp->user_id, &msg_resp->payload[1], msg_resp->payload_len - 1);
106
107 1 return BMKT_SUCCESS;
108 }
109
110 static int
111 1 parse_auth_ok (bmkt_msg_resp_t *msg_resp, bmkt_response_t *resp)
112 {
113 1 bmkt_identify_resp_t *id_resp = &resp->response.id_resp;
114
115
1/2
✓ Branch 0 (2→3) taken 1 times.
✗ Branch 1 (2→4) not taken.
 1 if (msg_resp->payload_len < 3 || msg_resp->payload_len > (BMKT_MAX_USER_ID_LEN + 3))
116 return BMKT_UNRECOGNIZED_MESSAGE;
117
118 1 id_resp->match_result = (double) msg_resp->payload[0] + 0.01 * (double) msg_resp->payload[1];
119 1 id_resp->finger_id = msg_resp->payload[2];
120 1 memcpy (id_resp->user_id, &msg_resp->payload[3], msg_resp->payload_len - 3);
121
122 1 return BMKT_SUCCESS;
123 }
124
125 static int
126 ✗ parse_security_level_report (bmkt_msg_resp_t *msg_resp, bmkt_response_t *resp)
127 {
128 ✗ bmkt_set_sec_level_resp_t *sec_level_resp = &resp->response.sec_level_resp;
129
130 ✗ if (msg_resp->payload_len != 1)
131 return BMKT_UNRECOGNIZED_MESSAGE;
132
133 ✗ sec_level_resp->sec_level = extract8 (msg_resp->payload, NULL);
134
135 ✗ return BMKT_SUCCESS;
136 }
137
138 static int
139 2 parse_del_all_users_progress_report (bmkt_msg_resp_t *msg_resp, bmkt_response_t *resp)
140 {
141 2 bmkt_del_all_users_resp_t *del_all_users_resp = &resp->response.del_all_users_resp;
142
143 2 if (msg_resp->payload_len != 1)
144 return BMKT_UNRECOGNIZED_MESSAGE;
145
146 2 del_all_users_resp->progress = extract8 (msg_resp->payload, NULL);
147
148 2 return BMKT_SUCCESS;
149 }
150
151 static int
152 ✗ parse_db_cap_report (bmkt_msg_resp_t *msg_resp, bmkt_response_t *resp)
153 {
154 ✗ bmkt_get_db_capacity_resp_t *db_cap_resp = &resp->response.db_cap_resp;
155 ✗ int offset = 0;
156
157 ✗ if (msg_resp->payload_len < 2 || msg_resp->payload_len > 4)
158 return BMKT_UNRECOGNIZED_MESSAGE;
159
160 ✗ db_cap_resp->total = extract8 (msg_resp->payload, &offset);
161 ✗ db_cap_resp->empty = extract8 (msg_resp->payload, &offset);
162
163 ✗ if (msg_resp->payload_len == 4)
164 {
165 ✗ db_cap_resp->bad_slots = extract8 (msg_resp->payload, &offset);
166 ✗ db_cap_resp->corrupt_templates = extract8 (msg_resp->payload, &offset);
167 }
168
169 return BMKT_SUCCESS;
170 }
171
172 static int
173 ✗ parse_get_enrolled_fingers_report (bmkt_msg_resp_t *msg_resp, bmkt_response_t *resp)
174 {
175 ✗ int offset = 0;
176 ✗ int i = 0;
177
178 ✗ if (msg_resp->payload_len < 2)
179 return BMKT_UNRECOGNIZED_MESSAGE;
180 /* 2 bytes per finger so calculate the total number of fingers to process*/
181 ✗ int num_fingers = (msg_resp->payload_len) / 2;
182
183 ✗ bmkt_enrolled_fingers_resp_t *get_enrolled_fingers_resp = &resp->response.enrolled_fingers_resp;
184
185 ✗ for (i = 0; i < num_fingers; i++)
186 {
187 ✗ get_enrolled_fingers_resp->fingers[i].finger_id = extract8 (msg_resp->payload, &offset);
188 ✗ get_enrolled_fingers_resp->fingers[i].template_status = extract8 (msg_resp->payload, &offset);
189
190 }
191 return BMKT_SUCCESS;
192 }
193 static int
194 ✗ parse_get_enrolled_users_report (bmkt_msg_resp_t *msg_resp, bmkt_response_t *resp)
195 {
196 ✗ int offset = 0;
197 ✗ int i = 0;
198
199 /* the payload is 2 bytes + template data */
200 ✗ if (msg_resp->payload_len < 2)
201 return BMKT_UNRECOGNIZED_MESSAGE;
202
203 ✗ bmkt_enroll_templates_resp_t *get_enroll_templates_resp = &resp->response.enroll_templates_resp;
204
205 ✗ get_enroll_templates_resp->total_query_messages = extract8 (msg_resp->payload, &offset);
206 ✗ get_enroll_templates_resp->query_sequence = extract8 (msg_resp->payload, &offset);
207
208 ✗ int n = 0;
209
210 ✗ for (n = 0; n < BMKT_MAX_NUM_TEMPLATES_INTERNAL_FLASH; n++)
211 {
212 ✗ if (offset >= msg_resp->payload_len)
213 break;
214 ✗ get_enroll_templates_resp->templates[n].user_id_len = extract8 (msg_resp->payload, &offset) - 2;
215 ✗ if(get_enroll_templates_resp->templates[n].user_id_len > BMKT_MAX_USER_ID_LEN)
216 return BMKT_UNRECOGNIZED_MESSAGE;
217 ✗ get_enroll_templates_resp->templates[n].template_status = extract8 (msg_resp->payload, &offset);
218 ✗ get_enroll_templates_resp->templates[n].finger_id = extract8 (msg_resp->payload, &offset);
219 ✗ for (i = 0; i < get_enroll_templates_resp->templates[n].user_id_len; i++)
220 ✗ get_enroll_templates_resp->templates[n].user_id[i] = extract8 (msg_resp->payload, &offset);
221 ✗ get_enroll_templates_resp->templates[n].user_id[i] = '\0';
222 }
223
224 return BMKT_SUCCESS;
225 }
226
227 static int
228 ✗ parse_get_version_report (bmkt_msg_resp_t *msg_resp, bmkt_response_t *resp)
229 {
230 ✗ bmkt_get_version_resp_t *get_version_resp = &resp->response.get_version_resp;
231 ✗ int offset = 0;
232
233 ✗ if (msg_resp->payload_len != 15)
234 return BMKT_UNRECOGNIZED_MESSAGE;
235
236 ✗ memcpy (get_version_resp->part, msg_resp->payload, BMKT_PART_NUM_LEN);
237 ✗ offset += BMKT_PART_NUM_LEN;
238 ✗ get_version_resp->year = extract8 (msg_resp->payload, &offset);
239 ✗ get_version_resp->week = extract8 (msg_resp->payload, &offset);
240 ✗ get_version_resp->patch = extract8 (msg_resp->payload, &offset);
241 ✗ memcpy (get_version_resp->supplier_id, msg_resp->payload + offset, BMKT_SUPPLIER_ID_LEN);
242
243 ✗ return BMKT_SUCCESS;
244 }
245
246 int
247 7 bmkt_compose_message (uint8_t *cmd, int *cmd_len, uint8_t msg_id, uint8_t seq_num,
248 uint8_t payload_size, const uint8_t *payload)
249 {
250 7 int message_len = BMKT_MESSAGE_HEADER_LEN + payload_size;
251
252
1/2
✓ Branch 0 (2→3) taken 7 times.
✗ Branch 1 (2→6) not taken.
 7 if (*cmd_len < message_len)
253 return BMKT_OUT_OF_MEMORY;
254
255 7 cmd[BMKT_MESSAGE_HEADER_ID_FIELD] = BMKT_MESSAGE_HEADER_ID;
256 7 cmd[BMKT_MESSAGE_SEQ_NUM_FIELD] = seq_num;
257 7 cmd[BMKT_MESSAGE_ID_FIELD] = msg_id;
258 7 cmd[BMKT_MESSAGE_PAYLOAD_LEN_FIELD] = payload_size;
259
2/2
✓ Branch 0 (3→4) taken 3 times.
✓ Branch 1 (3→5) taken 4 times.
 7 if (payload_size > 0)
260 3 memcpy (&cmd[BMKT_MESSAGE_PAYLOAD_FIELD], payload, payload_size);
261
262 7 *cmd_len = message_len;
263
264 7 return BMKT_SUCCESS;
265 }
266
267 int
268 52 bmkt_parse_message_header (uint8_t *resp_buf, int resp_len, bmkt_msg_resp_t *msg_resp)
269 {
270
1/2
✓ Branch 0 (2→3) taken 52 times.
✗ Branch 1 (2→7) not taken.
 52 if (resp_buf[BMKT_MESSAGE_HEADER_ID_FIELD] != BMKT_MESSAGE_HEADER_ID)
271 return BMKT_CORRUPT_MESSAGE;
272
273 52 msg_resp->seq_num = resp_buf[BMKT_MESSAGE_SEQ_NUM_FIELD];
274 52 msg_resp->msg_id = resp_buf[BMKT_MESSAGE_ID_FIELD];
275 52 msg_resp->payload_len = resp_buf[BMKT_MESSAGE_PAYLOAD_LEN_FIELD];
276
2/2
✓ Branch 0 (3→4) taken 38 times.
✓ Branch 1 (3→5) taken 14 times.
 52 if (msg_resp->payload_len > 0)
277 38 msg_resp->payload = &resp_buf[BMKT_MESSAGE_PAYLOAD_FIELD];
278 else
279 14 msg_resp->payload = NULL;
280
281 return BMKT_SUCCESS;
282 }
283
284 int
285 52 bmkt_parse_message_payload (bmkt_msg_resp_t *msg_resp, bmkt_response_t *resp)
286 {
287 52 int ret = BMKT_SUCCESS;
288
289 52 memset (resp, 0, sizeof (bmkt_response_t));
290
291 52 resp->response_id = msg_resp->msg_id;
292
293
9/16
✓ Branch 0 (2→3) taken 34 times.
✓ Branch 1 (2→4) taken 1 times.
✓ Branch 2 (2→7) taken 1 times.
✓ Branch 3 (2→10) taken 2 times.
✗ Branch 4 (2→11) not taken.
✗ Branch 5 (2→13) not taken.
✓ Branch 6 (2→16) taken 2 times.
✓ Branch 7 (2→18) taken 9 times.
✓ Branch 8 (2→20) taken 1 times.
✓ Branch 9 (2→21) taken 1 times.
✗ Branch 10 (2→23) not taken.
✗ Branch 11 (2→25) not taken.
✗ Branch 12 (2→27) not taken.
✗ Branch 13 (2→29) not taken.
✗ Branch 14 (2→30) not taken.
✓ Branch 15 (2→32) taken 1 times.
 52 switch(msg_resp->msg_id)
294 {
295 case BMKT_RSP_CONTINUOUS_IMAGE_CAPTURE_FAIL:
296 case BMKT_RSP_SENSOR_MODULE_TEST_FAIL:
297 case BMKT_RSP_FPS_INIT_FAIL:
298 case BMKT_RSP_FPS_MODE_FAIL:
299 case BMKT_RSP_SET_SECURITY_LEVEL_FAIL:
300 case BMKT_RSP_GET_SECURITY_LEVEL_FAIL:
301 case BMKT_RSP_CANCEL_OP_FAIL:
302 case BMKT_RSP_ENROLL_FAIL:
303 case BMKT_RSP_ID_FAIL:
304 case BMKT_RSP_VERIFY_FAIL:
305 case BMKT_RSP_QUERY_FAIL:
306 case BMKT_RSP_DEL_USER_FP_FAIL:
307 case BMKT_RSP_DEL_FULL_DB_FAIL:
308 case BMKT_RSP_REPEAT_LAST_BMKT_RSP_FAIL:
309 case BMKT_RSP_POWER_DOWN_FAIL:
310 case BMKT_RSP_GET_VERSION_FAIL:
311 case BMKT_RSP_DISABLE_PAIRING_FAIL:
312 case BMKT_RSP_QUERY_PAIRING_FAIL:
313 case BMKT_RSP_SENSOR_STATUS_FAIL:
314 case BMKT_RSP_RETRIEVE_FINAL_RESULT_FAIL:
315
1/2
✓ Branch 0 (4→5) taken 1 times.
✗ Branch 1 (4→6) not taken.
 1 ret = parse_error_response (msg_resp, resp);
316 1 resp->complete = 1;
317 1 break;
318
319 case BMKT_RSP_FPS_INIT_OK:
320
1/2
✓ Branch 0 (7→8) taken 1 times.
✗ Branch 1 (7→9) not taken.
 1 ret = parse_init_ok (msg_resp, resp);
321 1 resp->complete = 1;
322 1 break;
323
324 2 case BMKT_RSP_CANCEL_OP_OK:
325 case BMKT_RSP_DEL_FULL_DB_OK:
326 case BMKT_RSP_DEL_USER_FP_OK:
327 /* responses with a payload of 0
328 so the response indicates success */
329 2 resp->result = BMKT_SUCCESS;
330 2 resp->complete = 1;
331 2 break;
332
333 ✗ case BMKT_RSP_FPS_MODE_REPORT:
334 // parse_fps_mode
335 ✗ ret = parse_fps_mode_report (msg_resp, resp);
336 ✗ resp->complete = 1;
337 ✗ break;
338
339 case BMKT_RSP_GET_SECURITY_LEVEL_REPORT:
340 case BMKT_RSP_SET_SECURITY_LEVEL_REPORT:
341 /* parse security level result */
342 ✗ ret = parse_security_level_report (msg_resp, resp);
343 ✗ resp->complete = 1;
344 ✗ break;
345
346 case BMKT_RSP_DELETE_PROGRESS:
347
1/2
✓ Branch 0 (16→17) taken 2 times.
✗ Branch 1 (16→34) not taken.
 2 ret = parse_del_all_users_progress_report (msg_resp, resp);
348 break;
349
350 case BMKT_RSP_CAPTURE_COMPLETE:
351 resp->result = BMKT_SUCCESS;
352 break;
353
354 case BMKT_RSP_ENROLL_READY:
355 resp->result = BMKT_SUCCESS;
356 break;
357
358 case BMKT_RSP_ENROLL_REPORT:
359
1/2
✓ Branch 0 (18→19) taken 9 times.
✗ Branch 1 (18→34) not taken.
 9 ret = parse_enroll_report (msg_resp, resp);
360 break;
361
362 1 case BMKT_RSP_ENROLL_OK:
363 1 resp->complete = 1;
364 1 ret = parse_enroll_ok (msg_resp, resp);
365 1 break;
366
367 1 case BMKT_RSP_ID_OK:
368 case BMKT_RSP_VERIFY_OK:
369 1 ret = parse_auth_ok (msg_resp, resp);
370 1 resp->complete = 1;
371 1 break;
372
373 ✗ case BMKT_RSP_GET_ENROLLED_FINGERS_REPORT:
374 ✗ ret = parse_get_enrolled_fingers_report (msg_resp, resp);
375 ✗ resp->complete = 1;
376 ✗ break;
377
378 ✗ case BMKT_RSP_DATABASE_CAPACITY_REPORT:
379 ✗ resp->complete = 1;
380 ✗ ret = parse_db_cap_report (msg_resp, resp);
381 ✗ break;
382
383 ✗ case BMKT_RSP_TEMPLATE_RECORDS_REPORT:
384 ✗ ret = parse_get_enrolled_users_report (msg_resp, resp);
385 ✗ break;
386
387 ✗ case BMKT_RSP_QUERY_RESPONSE_COMPLETE:
388 ✗ resp->complete = 1;
389 ✗ break;
390
391 ✗ case BMKT_RSP_VERSION_INFO:
392 ✗ ret = parse_get_version_report (msg_resp, resp);
393 ✗ resp->complete = 1;
394 ✗ break;
395
396 1 case BMKT_RSP_POWER_DOWN_READY:
397 1 resp->complete = 1;
398 1 break;
399 }
400
401 52 return ret;
402 }
403