summaryrefslogtreecommitdiff
path: root/zephyr/test/drivers/mkbp/src/mkbp_fifo.c
blob: e6a6ba5f04daeb0fd65a609b46da58ebf221be93 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/* 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/kernel.h>
#include <zephyr/ztest_assert.h>
#include <zephyr/drivers/i2c_emul.h>

#include "keyboard_config.h"
#include "mkbp_fifo.h"
#include "test/drivers/test_state.h"

/* Tests for Matrix Keyboard Protocol (MKBP) */

/* Largest event size that we support */
#define KEY_MATRIX_EVENT_DATA_SIZE KEYBOARD_COLS_MAX

#define MAX_EVENT_DATA_SIZE KEY_MATRIX_EVENT_DATA_SIZE

struct mkbp_fifo_fixture {
	uint8_t input_event_data[MAX_EVENT_DATA_SIZE];
};

static void *mkbp_fifo_setup(void)
{
	static struct mkbp_fifo_fixture fixture;

	return &fixture;
}

static void mkbp_fifo_before(void *data)
{
	struct mkbp_fifo_fixture *fixture = data;

	mkbp_clear_fifo();
	memset(fixture->input_event_data, 0, MAX_EVENT_DATA_SIZE);
	mkbp_fifo_depth_update(FIFO_DEPTH);
}

static void mkbp_fifo_after(void *data)
{
	mkbp_clear_fifo();
	mkbp_fifo_depth_update(FIFO_DEPTH);
}

static void fill_array_with_incrementing_numbers(int8_t *dst, int size)
{
	for (int i = 0; i < size; i++) {
		dst[i] = i;
	}
}

ZTEST_F(mkbp_fifo, test_fifo_add_keyboard_key_matrix_event)
{
	uint8_t out[KEY_MATRIX_EVENT_DATA_SIZE + 1];

	memset(out, 0, sizeof(out));

	fill_array_with_incrementing_numbers(fixture->input_event_data,
					     KEY_MATRIX_EVENT_DATA_SIZE);

	/* Keyboard Key Matrix Event */
	zassert_ok(mkbp_fifo_add(EC_MKBP_EVENT_KEY_MATRIX,
				 fixture->input_event_data),
		   NULL);

	int dequeued_data_size =
		mkbp_fifo_get_next_event(out, EC_MKBP_EVENT_KEY_MATRIX);

	zassert_equal(dequeued_data_size, KEY_MATRIX_EVENT_DATA_SIZE, NULL);
	zassert_mem_equal(fixture->input_event_data, out,
			  KEY_MATRIX_EVENT_DATA_SIZE, NULL);
	zassert_equal(out[KEY_MATRIX_EVENT_DATA_SIZE], 0, NULL);
}

ZTEST_F(mkbp_fifo, test_fifo_depth_update)
{
	uint8_t out[KEY_MATRIX_EVENT_DATA_SIZE + 1];
	uint8_t new_depth = 0;

	mkbp_fifo_depth_update(new_depth);
	fill_array_with_incrementing_numbers(fixture->input_event_data,
					     MAX_EVENT_DATA_SIZE);
	zassert_equal(EC_ERROR_OVERFLOW,
		      mkbp_fifo_add(EC_MKBP_EVENT_KEY_MATRIX,
				    fixture->input_event_data),
		      NULL);
	zassert_equal(-1, /* get_next_event explicitly returns -1 */
		      mkbp_fifo_get_next_event(out, EC_MKBP_EVENT_KEY_MATRIX),
		      NULL);

	mkbp_fifo_depth_update(FIFO_DEPTH);
	zassert_ok(mkbp_fifo_add(EC_MKBP_EVENT_KEY_MATRIX,
				 fixture->input_event_data),
		   NULL);
}

ZTEST_SUITE(mkbp_fifo, drivers_predicate_post_main, mkbp_fifo_setup,
	    mkbp_fifo_before, mkbp_fifo_after, NULL);