diff options
author | Tom Hughes <tomhughes@chromium.org> | 2022-09-21 14:10:01 -0700 |
---|---|---|
committer | Tom Hughes <tomhughes@chromium.org> | 2022-09-22 12:49:33 -0700 |
commit | 2bcf863b492fe7ed8105c853814dba6ed32ba719 (patch) | |
tree | fcf6ce5810f9ff9e3c8cce434812dd75492269ed /zephyr/test/drivers/keyboard_scan/src/mkbp_event.c | |
parent | e5fb0b9ba488614b5684e640530f00821ab7b943 (diff) | |
parent | 28712dae9d7ed1e694f7622cc083afa71090d4d5 (diff) | |
download | chrome-ec-firmware-fpmcu-bloonchipper-release.tar.gz |
Merge remote-tracking branch cros/main into firmware-fpmcu-bloonchipper-releasefirmware-fpmcu-bloonchipper-release
Generated by: ./util/update_release_branch.py --board bloonchipper
--relevant_paths_file ./util/fingerprint-relevant-paths.txt firmware-
fpmcu-bloonchipper-release
Relevant changes:
git log --oneline e5fb0b9ba4..28712dae9d -- board/hatch_fp
board/bloonchipper common/fpsensor docs/fingerprint driver/fingerprint
util/getversion.sh
ded9307b79 util/getversion.sh: Fix version when not in a git repo
956055e692 board: change Google USB vendor info
71b2ef709d Update license boilerplate text in source code files
33e11afda0 Revert "fpsensor: Build fpsensor source file with C++"
c8d0360723 fpsensor: Build fpsensor source file with C++
bc113abd53 fpsensor: Fix g++ compiler error
150a58a0dc fpsensor: Fix fp_set_sensor_mode return type
b33b5ce85b fpsensor: Remove nested designators for C++ compatibility
2e864b2539 tree-wide: const-ify argv for console commands
56d8b360f9 test: Add test for get ikm failure when seed not set
3a3d6c3690 test: Add test for fpsensor trivial key failure
233e6bbd08 fpsensor_crypto: Abstract calls to hmac_SHA256
0a041b285b docs/fingerprint: Typo correction
c03fab67e2 docs/fingerprint: Fix the path of fputils.py
0b5d4baf5a util/getversion.sh: Fix empty file list handling
6e128fe760 FPMCU dev board environment with Satlab
3eb29b6aa5 builtin: Move ssize_t to sys/types.h
345d62ebd1 docs/fingerprint: Update power numbers for latest dartmonkey release
c25ffdb316 common: Conditionally support printf %l and %i modifiers
9a3c514b45 test: Add a test to check if the debugger is connected
54e603413f Move standard library tests to their own file
43fa6b4bf8 docs/fingerprint: Update power numbers for latest bloonchipper release
25536f9a84 driver/fingerprint/fpc/bep/fpc_sensor_spi.c: Format with clang-format
4face99efd driver/fingerprint/fpc/libfp/fpc_sensor_pal.h: Format with clang-format
738de2b575 trng: Rename rand to trng_rand
14b8270edd docs/fingerprint: Update dragonclaw power numbers
0b268f93d1 driver/fingerprint/fpc/libfp/fpc_private.c: Format with clang-format
f80da163f2 driver/fingerprint/fpc/libfp/fpc_private.h: Format with clang-format
5e9c85c9b1 driver/fingerprint/fpc/libfp/fpc_sensor_pal.c: Format with clang-format
c1f9dd3cf8 driver/fingerprint/fpc/libfp/fpc_bio_algorithm.h: Format with clang-format
eb1e1bed8d driver/fingerprint/fpc/libfp/fpc1145_private.h: Format with clang-format
6e7b611821 driver/fingerprint/fpc/bep/fpc_bio_algorithm.h: Format with clang-format
e0589cd5e2 driver/fingerprint/fpc/bep/fpc1035_private.h: Format with clang-format
7905e556a0 common/fpsensor/fpsensor_crypto.c: Format with clang-format
21289d170c driver/fingerprint/fpc/bep/fpc1025_private.h: Format with clang-format
98a20f937e common/fpsensor/fpsensor_state.c: Format with clang-format
a2d255d8af common/fpsensor/fpsensor.c: Format with clang-format
73055eeb3f driver/fingerprint/fpc/bep/fpc_private.c: Format with clang-format
0f7b5cb509 common/fpsensor/fpsensor_private.h: Format with clang-format
1ceade6e65 driver/fingerprint/fpc/bep/fpc_private.h: Format with clang-format
dc3e9008b8 board/hatch_fp/board.h: Format with clang-format
dca9d74321 Revert "trng: Rename rand to trng_rand"
a6b0b3554f trng: Rename rand to trng_rand
28d0b75b70 third_party/boringssl: Remove unused header
BRANCH=None
BUG=b:246424843 b:234181908 b:244781166 b:234181908 b:244387210
BUG=b:242720240 chromium:1098010 b:180945056 b:236025198 b:234181908
BUG=b:234181908 b:237344361 b:131913998 b:236386294 b:234143158
BUG=b:234781655 b:215613183 b:242720910
TEST=`make -j buildall`
TEST=./test/run_device_tests.py --board bloonchipper
Test "aes": PASSED
Test "cec": PASSED
Test "cortexm_fpu": PASSED
Test "crc": PASSED
Test "flash_physical": PASSED
Test "flash_write_protect": PASSED
Test "fpsensor_hw": PASSED
Test "fpsensor_spi_ro": PASSED
Test "fpsensor_spi_rw": PASSED
Test "fpsensor_uart_ro": PASSED
Test "fpsensor_uart_rw": PASSED
Test "mpu_ro": PASSED
Test "mpu_rw": PASSED
Test "mutex": PASSED
Test "pingpong": PASSED
Test "printf": PASSED
Test "queue": PASSED
Test "rollback_region0": PASSED
Test "rollback_region1": PASSED
Test "rollback_entropy": PASSED
Test "rtc": PASSED
Test "sha256": PASSED
Test "sha256_unrolled": PASSED
Test "static_if": PASSED
Test "stdlib": PASSED
Test "system_is_locked_wp_on": PASSED
Test "system_is_locked_wp_off": PASSED
Test "timer_dos": PASSED
Test "utils": PASSED
Test "utils_str": PASSED
Test "stm32f_rtc": PASSED
Test "panic_data_bloonchipper_v2.0.4277": PASSED
Test "panic_data_bloonchipper_v2.0.5938": PASSED
Force-Relevant-Builds: all
Signed-off-by: Tom Hughes <tomhughes@chromium.org>
Change-Id: I264ad0ffe7afcd507a1e483c6e934a9c4fea47c3
Diffstat (limited to 'zephyr/test/drivers/keyboard_scan/src/mkbp_event.c')
-rw-r--r-- | zephyr/test/drivers/keyboard_scan/src/mkbp_event.c | 189 |
1 files changed, 189 insertions, 0 deletions
diff --git a/zephyr/test/drivers/keyboard_scan/src/mkbp_event.c b/zephyr/test/drivers/keyboard_scan/src/mkbp_event.c new file mode 100644 index 0000000000..dee2ba2d1b --- /dev/null +++ b/zephyr/test/drivers/keyboard_scan/src/mkbp_event.c @@ -0,0 +1,189 @@ +/* Copyright 2022 The ChromiumOS Authors + * Use of this source code is governed by a BSD-style license that can be + * found in the LICENSE file. + */ +#include <zephyr/ztest.h> +#include <zephyr/drivers/emul.h> +#include <zephyr/drivers/gpio.h> +#include <zephyr/drivers/gpio/gpio_emul.h> +#include <zephyr/fff.h> +#include <emul/emul_kb_raw.h> + +#include "console.h" +#include "host_command.h" +#include "mkbp_event.h" +#include "mkbp_fifo.h" +#include "test/drivers/test_mocks.h" +#include "test/drivers/test_state.h" + +/** + * @brief FFF fake that will be registered as a callback to monitor the EC->AP + * interrupt pin. Implements `gpio_callback_handler_t`. + */ +FAKE_VOID_FUNC(interrupt_gpio_monitor, const struct device *, + struct gpio_callback *, gpio_port_pins_t); + +/** + * @brief Fixture to hold state while the suite is running. + */ +struct event_fixture { + /** Configuration for the interrupt pin change callback */ + struct gpio_callback callback_config; +}; + +static struct event_fixture fixture; + +ZTEST(mkbp_event, host_command_get_events__empty) +{ + /* Issue a host command to get the next event (from any source) */ + uint16_t ret; + struct ec_response_get_next_event response; + struct host_cmd_handler_args args = + BUILD_HOST_COMMAND_RESPONSE(EC_CMD_GET_NEXT_EVENT, 0, response); + + ret = host_command_process(&args); + zassert_equal(EC_RES_UNAVAILABLE, ret, + "Expected EC_RES_UNAVAILABLE but got %d", ret); +} + +ZTEST(mkbp_event, host_command_get_events__get_event) +{ + /* Dispatch a fake keyboard event and ensure it gets returned by the + * host command. + */ + int ret; + + struct ec_response_get_next_event expected_event = { + .event_type = EC_MKBP_EVENT_KEY_MATRIX, + .data.key_matrix = { + /* Arbitrary key matrix data (uint8_t[13]) */ + 0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x9, 0xa, 0xb, + 0xc, 0xd + }, + }; + + /* Add the above event to the MKBP keyboard FIFO and raise the event */ + + ret = mkbp_fifo_add(expected_event.event_type, + (const uint8_t *)&expected_event.data.key_matrix); + activate_mkbp_with_events(BIT(expected_event.event_type)); + + zassert_equal(EC_SUCCESS, ret, "Got %d when adding to FIFO", ret); + + /* Retrieve this event via host command */ + + struct ec_response_get_next_event response; + struct host_cmd_handler_args args = + BUILD_HOST_COMMAND_RESPONSE(EC_CMD_GET_NEXT_EVENT, 0, response); + + ret = host_command_process(&args); + zassert_equal(EC_RES_SUCCESS, ret, "Expected EC_RES_SUCCESS but got %d", + ret); + + /* Compare event data in response */ + zassert_equal(expected_event.event_type, response.event_type, + "Got event type 0x%02x", response.event_type); + zassert_mem_equal(&expected_event.data.key_matrix, + &response.data.key_matrix, + sizeof(expected_event.data.key_matrix), + "Event data payload does not match."); + + /* Check for two pin change events (initial assertion when the event + * was sent, and a de-assertion once we retrieved it through the host + * command) + */ + + zassert_equal(2, interrupt_gpio_monitor_fake.call_count, + "Only %d pin events", + interrupt_gpio_monitor_fake.call_count); +} + +ZTEST(mkbp_event, no_ap_response) +{ + /* Cause an event but do not send any host commands. This should cause + * the EC to send the interrupt to the AP 3 times before giving up. + * Use the GPIO emulator to monitor for interrupts. + */ + + int ret; + + struct ec_response_get_next_event expected_event = { + .event_type = EC_MKBP_EVENT_KEY_MATRIX, + }; + + ret = mkbp_fifo_add(expected_event.event_type, + (uint8_t *)&expected_event.data.key_matrix); + activate_mkbp_with_events(BIT(expected_event.event_type)); + zassert_equal(EC_SUCCESS, ret, "Got %d when adding to FIFO", ret); + + /* EC will attempt to signal the interrupt 3 times. Each attempt lasts + * 1 second, so sleep for 5 and then count the number of times the + * interrupt pin was asserted. (It does not get de-asserted) + */ + + k_sleep(K_SECONDS(5)); + + zassert_equal(3, interrupt_gpio_monitor_fake.call_count, + "Interrupt pin asserted only %d times.", + interrupt_gpio_monitor_fake.call_count); +} + +/* Set up a mock for mkbp_send_event(). This function is called by the MKBP + * event sources to signal that a new event is available for servicing. Since we + * are unit testing just event handling code, we do not want the various event + * source tasks to raise unexpected events during testing and throw us off. + * This mock will essentially cause mkbp_send_event() to become a no-op and + * block the reset of the EC code from raising events and interfering. The test + * code will bypass this by calling mkbp_event.c's internal + * `activate_mkbp_with_events()` directly. + */ +FAKE_VALUE_FUNC(int, mkbp_send_event, uint8_t); + +static void *setup(void) +{ + /* Add a callback to the EC->AP interrupt pin so we can log interrupt + * attempts with an FFF fake. + */ + + const struct gpio_dt_spec *interrupt_pin = + GPIO_DT_FROM_NODELABEL(gpio_ap_ec_int_l); + + fixture.callback_config = (struct gpio_callback){ + .pin_mask = BIT(interrupt_pin->pin), + .handler = interrupt_gpio_monitor, + }; + + zassume_ok(gpio_add_callback(interrupt_pin->port, + &fixture.callback_config), + "Could not configure GPIO callback."); + + return &fixture; +} + +static void teardown(void *data) +{ + /* Remove the GPIO callback on the interrupt pin */ + + struct event_fixture *f = (struct event_fixture *)data; + const struct gpio_dt_spec *interrupt_pin = + GPIO_DT_FROM_NODELABEL(gpio_ap_ec_int_l); + + gpio_remove_callback(interrupt_pin->port, &f->callback_config); +} + +static void reset_events(void *data) +{ + /* Clear any keyboard scan events (type EC_MKBP_EVENT_KEY_MATRIX) */ + mkbp_clear_fifo(); + + /* Clear pending events */ + mkbp_event_clear_all(); + + /* Mock reset */ + RESET_FAKE(interrupt_gpio_monitor); + RESET_FAKE(mkbp_send_event); + mkbp_send_event_fake.return_val = 1; +} + +ZTEST_SUITE(mkbp_event, drivers_predicate_post_main, setup, reset_events, + reset_events, teardown); |