summaryrefslogtreecommitdiff
path: root/zephyr/test/drivers/keyboard_8042/src/keyboard_8042.c
blob: 82779bfdb27dbdaa040f33341fec73b5e3e05b16 (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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/* Copyright 2023 The ChromiumOS Authors
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */
#include "console.h"
#include "keyboard_8042.h"
#include "test/drivers/test_mocks.h"
#include "test/drivers/test_state.h"

#include <string.h>

#include <zephyr/drivers/emul.h>
#include <zephyr/drivers/gpio.h>
#include <zephyr/drivers/gpio/gpio_emul.h>
#include <zephyr/fff.h>
#include <zephyr/shell/shell_dummy.h>
#include <zephyr/ztest.h>

ZTEST(keyboard_8042, test_console_cmd__typematic__status)
{
	const char *outbuffer;
	size_t buffer_size;

	/* Set a typematic scan code to verify */
	const uint8_t scan_code[] = { 0x01, 0x02, 0x03 };

	set_typematic_key(scan_code, ARRAY_SIZE(scan_code));

	/* With no args, print current state */
	shell_backend_dummy_clear_output(get_ec_shell());
	zassert_ok(shell_execute_cmd(get_ec_shell(), "8042 typematic"));
	outbuffer =
		shell_backend_dummy_get_output(get_ec_shell(), &buffer_size);

	/* Check for some expected lines based off default typematic state */
	zassert_true(buffer_size > 0);
	zassert_ok(!strstr(outbuffer, "From host:   0x2b"));
	zassert_ok(!strstr(outbuffer, "First delay: 500 ms"));
	zassert_ok(!strstr(outbuffer, "Inter delay:  91 ms"));
	zassert_ok(
		!strstr(outbuffer, "Repeat scan code: {0x01, 0x02, 0x03, }"));
}

ZTEST(keyboard_8042, test_console_cmd__typematic__set_delays)
{
	const char *outbuffer;
	size_t buffer_size;

	/* Set first delay and inter delay */
	shell_backend_dummy_clear_output(get_ec_shell());
	zassert_ok(shell_execute_cmd(get_ec_shell(), "8042 typematic 123 456"));
	outbuffer =
		shell_backend_dummy_get_output(get_ec_shell(), &buffer_size);

	/* Check for some expected lines */
	zassert_true(buffer_size > 0);
	zassert_ok(!strstr(outbuffer, "First delay: 123 ms"));
	zassert_ok(!strstr(outbuffer, "Inter delay: 456 ms"));
}

ZTEST(keyboard_8042, test_console_cmd__codeset__set_codeset1)
{
	const char *outbuffer;
	size_t buffer_size;

	/* Switch to codeset 1 and verify output */
	shell_backend_dummy_clear_output(get_ec_shell());
	zassert_ok(shell_execute_cmd(get_ec_shell(), "8042 codeset 1"));
	outbuffer =
		shell_backend_dummy_get_output(get_ec_shell(), &buffer_size);

	zassert_true(buffer_size > 0);
	zassert_ok(!strstr(outbuffer, "Set: 1"));
}

ZTEST(keyboard_8042, test_console_cmd__codeset__set_invalid)
{
	zassert_equal(EC_ERROR_PARAM1,
		      shell_execute_cmd(get_ec_shell(), "8042 codeset 999"));
}

ZTEST(keyboard_8042, test_console_cmd__ram__writeread)
{
	const char *outbuffer;
	size_t buffer_size;

	/* Write a byte and verify the readback in console output */
	shell_backend_dummy_clear_output(get_ec_shell());
	zassert_ok(shell_execute_cmd(get_ec_shell(), "8042 ctrlram 0x1f 0xaa"));
	outbuffer =
		shell_backend_dummy_get_output(get_ec_shell(), &buffer_size);

	zassert_true(buffer_size > 0);
	zassert_ok(!strstr(outbuffer, "31 = 0xaa"));
}

ZTEST(keyboard_8042, test_console_cmd__ram__invalid)
{
	/* Missing args */
	zassert_equal(EC_ERROR_PARAM_COUNT,
		      shell_execute_cmd(get_ec_shell(), "8042 ctrlram"));

	/* Address out of bounds */
	zassert_equal(EC_ERROR_PARAM1,
		      shell_execute_cmd(get_ec_shell(), "8042 ctrlram 9999"));
}

ZTEST(keyboard_8042, test_console_cmd__enable__true)
{
	const char *outbuffer;
	size_t buffer_size;

	/* Enable the keyboard and verify in console output */
	shell_backend_dummy_clear_output(get_ec_shell());
	zassert_ok(shell_execute_cmd(get_ec_shell(), "8042 kbd y"));
	outbuffer =
		shell_backend_dummy_get_output(get_ec_shell(), &buffer_size);

	zassert_true(buffer_size > 0);
	zassert_ok(!strstr(outbuffer, "Enabled: 1"));
}

ZTEST(keyboard_8042, test_console_cmd__enable__invalid)
{
	/* Non-bool arg */
	zassert_equal(EC_ERROR_PARAM1,
		      shell_execute_cmd(get_ec_shell(), "8042 kbd abc"));
}

ZTEST(keyboard_8042, test_console_cmd__internal)
{
	const char *outbuffer;
	size_t buffer_size;

	uint8_t resend_command[] = { 7, 8, 9 };

	test_keyboard_8042_set_resend_command(resend_command,
					      ARRAY_SIZE(resend_command));

	/* Dump the internal state of the keyboard driver */
	shell_backend_dummy_clear_output(get_ec_shell());
	zassert_ok(shell_execute_cmd(get_ec_shell(), "8042 internal"));
	outbuffer =
		shell_backend_dummy_get_output(get_ec_shell(), &buffer_size);

	zassert_true(buffer_size > 0);
	zassert_ok(!strstr(outbuffer, "keyboard_enabled=0"));
	zassert_ok(!strstr(outbuffer, "i8042_keyboard_irq_enabled=0"));
	zassert_ok(!strstr(outbuffer, "i8042_aux_irq_enabled=0"));
	zassert_ok(!strstr(outbuffer, "keyboard_enabled=0"));
	zassert_ok(!strstr(outbuffer, "keystroke_enabled=0"));
	zassert_ok(!strstr(outbuffer, "aux_chan_enabled=0"));
	zassert_ok(!strstr(outbuffer, "controller_ram_address=0x00"));
	zassert_ok(!strstr(outbuffer, "resend_command[]={0x07, 0x08, 0x09, }"));
	zassert_ok(!strstr(outbuffer, "A20_status=0"));
}

ZTEST(keyboard_8042, test_console_cmd__invalid)
{
	/* Non-existent subcommand */
	zassert_equal(EC_ERROR_PARAM1,
		      shell_execute_cmd(get_ec_shell(), "8042 foobar"));
}

ZTEST(keyboard_8042, test_console_cmd__all)
{
	const char *outbuffer;
	size_t buffer_size;

	/* Run all the subcommands */
	shell_backend_dummy_clear_output(get_ec_shell());
	zassert_ok(shell_execute_cmd(get_ec_shell(), "8042"));
	outbuffer =
		shell_backend_dummy_get_output(get_ec_shell(), &buffer_size);

	/* Just look for the headers since we already tested the individual
	 * subcommands
	 */

	zassert_true(buffer_size > 0);
	zassert_ok(!strstr(outbuffer, "- Typematic:"));
	zassert_ok(!strstr(outbuffer, "- Codeset:"));
	zassert_ok(!strstr(outbuffer, "- Control RAM:"));
	zassert_ok(!strstr(outbuffer, "- Keyboard:"));
	zassert_ok(!strstr(outbuffer, "- Internal:"));
}

static void reset(void *fixture)
{
	ARG_UNUSED(fixture);

	test_keyboard_8042_reset();
}

ZTEST_SUITE(keyboard_8042, drivers_predicate_post_main, NULL, reset, reset,
	    NULL);