summaryrefslogtreecommitdiff
path: root/test/button.c
blob: 2e8511df9863209129e230837732c1acee464c08 (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
/* Copyright (c) 2014 The Chromium OS Authors. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 *
 * Test non-keyboard buttons.
*
 * Using GPIOS and buttons[] defined in board/host/board.c
 * Volume down is active low with a debounce time of 30 mSec.
 * Volume up is active high with a debounce time of 60 mSec.
 *
 */

#include "button.h"
#include "common.h"
#include "console.h"
#include "gpio.h"
#include "test_util.h"
#include "timer.h"
#include "keyboard_protocol.h"

#define INDEX_VOL_DOWN 0
#define INDEX_VOL_UP 1
#define UNCHANGED -1

static const struct button_config *button_vol_down = &buttons[INDEX_VOL_DOWN];
static const struct button_config *button_vol_up = &buttons[INDEX_VOL_UP];

static int button_state[CONFIG_BUTTON_COUNT];

/*
 * Callback from the button handling logic.
 * This is normally implemented by a keyboard protocol handler.
 */
void keyboard_update_button(enum keyboard_button_type button, int is_pressed)
{
	int i;

	for (i = 0; i < CONFIG_BUTTON_COUNT; i++) {
		if (buttons[i].type == button) {
			button_state[i] = is_pressed;
			break;
		}
	}
}

/* Test pressing a button */
static int test_button_press(void)
{
	gpio_set_level(button_vol_down->gpio, 0);
	msleep(100);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == 1);

	return EC_SUCCESS;
}

/* Test releasing a button */
static int test_button_release(void)
{
	gpio_set_level(button_vol_up->gpio, 1);
	msleep(100);
	gpio_set_level(button_vol_up->gpio, 0);
	msleep(100);
	TEST_ASSERT(button_state[INDEX_VOL_UP] == 0);

	return EC_SUCCESS;
}

/* A press shorter than the debounce time should not trigger an update */
static int test_button_debounce_short_press(void)
{
	gpio_set_level(button_vol_down->gpio, 0);
	msleep(10);
	gpio_set_level(button_vol_down->gpio, 1);
	msleep(100);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == UNCHANGED);

	return EC_SUCCESS;
}

/* A short bounce while pressing should still result in a button press */
static int test_button_debounce_short_bounce(void)
{
	gpio_set_level(button_vol_down->gpio, 0);
	msleep(10);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == UNCHANGED);
	gpio_set_level(button_vol_down->gpio, 1);
	msleep(10);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == UNCHANGED);
	gpio_set_level(button_vol_down->gpio, 0);
	msleep(20);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == UNCHANGED);
	msleep(20);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == 1);

	return EC_SUCCESS;
}

/* Button level must be stable for the entire debounce interval */
static int test_button_debounce_stability(void)
{
	gpio_set_level(button_vol_down->gpio, 0);
	msleep(20);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == UNCHANGED);
	gpio_set_level(button_vol_down->gpio, 1);
	msleep(20);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == UNCHANGED);
	gpio_set_level(button_vol_down->gpio, 0);
	msleep(20);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == UNCHANGED);
	msleep(20);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == 1);
	msleep(60);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == 1);
	gpio_set_level(button_vol_down->gpio, 1);
	msleep(20);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == 1);
	msleep(20);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == 0);
	msleep(60);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == 0);

	return EC_SUCCESS;
}

/* Test pressing both buttons at different times */
static int test_button_press_both(void)
{
	gpio_set_level(button_vol_down->gpio, 0);
	msleep(10);
	gpio_set_level(button_vol_up->gpio, 1);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == UNCHANGED);
	TEST_ASSERT(button_state[INDEX_VOL_UP] == UNCHANGED);
	msleep(30);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == 1);
	TEST_ASSERT(button_state[INDEX_VOL_UP] == UNCHANGED);
	msleep(40);
	TEST_ASSERT(button_state[INDEX_VOL_DOWN] == 1);
	TEST_ASSERT(button_state[INDEX_VOL_UP] == 1);

	return EC_SUCCESS;
}

static void button_test_init(void)
{
	int i;

	ccprintf("[%T Setting button GPIOs to inactive state.]\n");
	for (i = 0; i < CONFIG_BUTTON_COUNT; i++)
		gpio_set_level(buttons[i].gpio,
			       !(buttons[i].flags & BUTTON_FLAG_ACTIVE_HIGH));

	msleep(100);
	for (i = 0; i < CONFIG_BUTTON_COUNT; i++)
		button_state[i] = UNCHANGED;
}

void run_test(void)
{
	test_reset();

	button_init();

	button_test_init();
	RUN_TEST(test_button_press);

	button_test_init();
	RUN_TEST(test_button_release);

	button_test_init();
	RUN_TEST(test_button_debounce_short_press);

	button_test_init();
	RUN_TEST(test_button_debounce_short_bounce);

	button_test_init();
	RUN_TEST(test_button_debounce_stability);

	button_test_init();
	RUN_TEST(test_button_press_both);

	test_print_result();
}