summaryrefslogtreecommitdiff
path: root/test/battery_get_params_smart.c
blob: 48273c4be00c37a64c3f9e140b1b9987044994a3 (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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
/* Copyright 2014 The ChromiumOS Authors
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 *
 * Test the logic of battery_get_params() to be sure it sets the correct flags
 * when i2c reads fail.
 */

#include "battery.h"
#include "battery_smart.h"
#include "common.h"
#include "console.h"
#include "i2c.h"
#include "test_util.h"
#include "util.h"

/* Test state */
static int fail_on_first, fail_on_last;
static int read_count, write_count;
struct batt_params batt;
static int cmd_to_fail;

void battery_compensate_params(struct batt_params *batt)
{
}

void board_battery_compensate_params(struct batt_params *batt)
{
}

static void reset_counters(int first, int last)
{
	read_count = write_count = 0;
	fail_on_first = first;
	fail_on_last = last;
}

static void reset_and_fail_on(int first, int last, int cmd)
{
	/* We're not initializing the fake battery, so everything reads zero */
	memset(&batt, 0, sizeof(typeof(batt)));
	cmd_to_fail = cmd;
	reset_counters(first, last);
}

/* Mocked functions */
int sb_read(int cmd, int *param)
{
	read_count++;
	if (read_count >= fail_on_first && read_count <= fail_on_last)
		return EC_ERROR_UNKNOWN;

	if (cmd == cmd_to_fail)
		return EC_ERROR_UNKNOWN;

	return i2c_read16(I2C_PORT_BATTERY, BATTERY_ADDR_FLAGS, cmd, param);
}

int sb_write(int cmd, int param)
{
	write_count++;
	return i2c_write16(I2C_PORT_BATTERY, BATTERY_ADDR_FLAGS, cmd, param);
}

/* Tests */
static int test_param_failures(void)
{
	int i, num_reads;

	/* No failures */
	reset_and_fail_on(0, 0, -1);
	battery_get_params(&batt);
	TEST_ASSERT(batt.flags & BATT_FLAG_RESPONSIVE);
	TEST_ASSERT(!(batt.flags & BATT_FLAG_BAD_ANY));

	/* Save the max number of reads. */
	num_reads = read_count;

	/* Just a single failure */
	for (i = 1; i <= num_reads; i++) {
		reset_and_fail_on(i, i, -1);
		battery_get_params(&batt);
		TEST_ASSERT(batt.flags & BATT_FLAG_BAD_ANY);
		TEST_ASSERT(batt.flags & BATT_FLAG_RESPONSIVE);
	}

	/* Once it fails, it keeps failing */
	for (i = 1; i <= num_reads; i++) {
		reset_and_fail_on(i, num_reads, -1);
		battery_get_params(&batt);
		TEST_ASSERT(batt.flags & BATT_FLAG_BAD_ANY);
		if (i == 1)
			/* If every read fails, it's not responsive */
			TEST_ASSERT(!(batt.flags & BATT_FLAG_RESPONSIVE));
		else
			TEST_ASSERT(batt.flags & BATT_FLAG_RESPONSIVE);
	}

	return EC_SUCCESS;
}

/**
 * Test if battery_get_params sets a flag properly for a SB command.
 *
 * @param cmd   SB command to fail.
 * @param flag  Flag expected to be set when <cmd> fails.
 * @return  EC_SUCCESS
 */
static int test_flag(int cmd, int flag)
{
	reset_and_fail_on(0, 0, cmd);
	battery_get_params(&batt);
	TEST_ASSERT(batt.flags & flag);
	TEST_ASSERT(!((batt.flags & ~flag) & BATT_FLAG_BAD_ANY));
	TEST_ASSERT(batt.flags & BATT_FLAG_RESPONSIVE);

	/*
	 * When SB_CHARGING_VOLTAGE, SB_CHARGING_CURRENT, or
	 * SB_RELATIVE_STATE_OF_CHARGE fails, WANT_CHARGE should be cleared.
	 */
	switch (cmd) {
	case SB_RELATIVE_STATE_OF_CHARGE:
	case SB_CHARGING_VOLTAGE:
	case SB_CHARGING_CURRENT:
		TEST_ASSERT(!(batt.flags & BATT_FLAG_WANT_CHARGE));
		TEST_ASSERT(batt.desired_voltage == 0);
		TEST_ASSERT(batt.desired_current == 0);
		break;
	default:
		TEST_ASSERT(batt.flags & BATT_FLAG_WANT_CHARGE);
		TEST_ASSERT(batt.desired_voltage == 100);
		TEST_ASSERT(batt.desired_current == 100);
	}

	/*
	 * Failure is recovered. <flag> should be cleared. WANT_CHARGE should be
	 * set.
	 */
	cmd_to_fail = -1;
	battery_get_params(&batt);
	TEST_ASSERT(!(batt.flags & flag));
	TEST_ASSERT(batt.flags & BATT_FLAG_WANT_CHARGE);

	return EC_SUCCESS;
}

static int test_flags(void)
{
	sb_write(SB_CHARGING_VOLTAGE, 100);
	sb_write(SB_CHARGING_CURRENT, 100);
	sb_write(SB_RELATIVE_STATE_OF_CHARGE, 50);

	/* Test each command-flag pair. */
	test_flag(SB_TEMPERATURE, BATT_FLAG_BAD_TEMPERATURE);
	test_flag(SB_RELATIVE_STATE_OF_CHARGE, BATT_FLAG_BAD_STATE_OF_CHARGE);
	test_flag(SB_VOLTAGE, BATT_FLAG_BAD_VOLTAGE);
	test_flag(SB_CURRENT, BATT_FLAG_BAD_CURRENT);
	test_flag(SB_AVERAGE_CURRENT, BATT_FLAG_BAD_AVERAGE_CURRENT);
	test_flag(SB_CHARGING_VOLTAGE, BATT_FLAG_BAD_DESIRED_VOLTAGE);
	test_flag(SB_CHARGING_CURRENT, BATT_FLAG_BAD_DESIRED_CURRENT);
	test_flag(SB_REMAINING_CAPACITY, BATT_FLAG_BAD_REMAINING_CAPACITY);
	test_flag(SB_FULL_CHARGE_CAPACITY, BATT_FLAG_BAD_FULL_CAPACITY);
	test_flag(SB_BATTERY_STATUS, BATT_FLAG_BAD_STATUS);

	/*
	 * All reads succeed. BATT_FLAG_RESPONSIVE should be set. Then, all
	 * reads fail. BATT_FLAG_RESPONSIVE should be cleared.
	 */
	reset_and_fail_on(0, 0, -1);
	battery_get_params(&batt);
	TEST_ASSERT(batt.flags & BATT_FLAG_RESPONSIVE);

	reset_counters(1, read_count);
	battery_get_params(&batt);
	TEST_ASSERT(!(batt.flags & BATT_FLAG_RESPONSIVE));

	/* Test WANT_CHARGE is explicitly cleared. */
	reset_and_fail_on(0, 0, SB_RELATIVE_STATE_OF_CHARGE);
	batt.flags |= BATT_FLAG_WANT_CHARGE;
	battery_get_params(&batt);
	TEST_ASSERT(!(batt.flags & BATT_FLAG_WANT_CHARGE));

	return EC_SUCCESS;
}

static int test_full_state_of_charge(void)
{
	/*
	 * When SoC is full, BATT_FLAG_WANT_CHARGE should be cleared and
	 * desired voltage and current are also cleared.
	 */
	sb_write(SB_CHARGING_VOLTAGE, 100);
	sb_write(SB_CHARGING_CURRENT, 100);
	sb_write(SB_RELATIVE_STATE_OF_CHARGE, 100);

	reset_and_fail_on(0, 0, -1);
	battery_get_params(&batt);
	TEST_ASSERT(!(batt.flags & BATT_FLAG_WANT_CHARGE));
	TEST_ASSERT(batt.desired_voltage == 0);
	TEST_ASSERT(batt.desired_current == 0);
	TEST_ASSERT(batt.state_of_charge == 100);

	return EC_SUCCESS;
}

static int test_voltage(void)
{
	sb_write(SB_VOLTAGE, 100);
	reset_and_fail_on(0, 0, -1);

	battery_get_params(&batt);
	TEST_ASSERT(batt.voltage == 100);

	return EC_SUCCESS;
}

static int test_current(void)
{
	/* Test positive (charge) current. */
	sb_write(SB_CURRENT, 100);
	reset_and_fail_on(0, 0, -1);
	battery_get_params(&batt);
	TEST_ASSERT(batt.current == 100);

	/* Test negative (discharge) current. */
	sb_write(SB_CURRENT, -100);
	reset_and_fail_on(0, 0, -1);
	battery_get_params(&batt);
	TEST_ASSERT(batt.current == -100);

	return EC_SUCCESS;
}

void run_test(int argc, const char **argv)
{
	RUN_TEST(test_param_failures);
	RUN_TEST(test_flags);
	RUN_TEST(test_full_state_of_charge);
	RUN_TEST(test_voltage);
	RUN_TEST(test_current);

	test_print_result();
}