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
244
245
246
247
248
249
250
251
|
/* Copyright 2012 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.
*/
/* Charger/battery debug command module for Chrome EC */
#ifndef __CROS_EC_CHARGER_H
#define __CROS_EC_CHARGER_H
#include "common.h"
/* Charger information
* voltage unit: mV
* current unit: mA
*/
struct charger_info {
const char *name;
uint16_t voltage_max;
uint16_t voltage_min;
uint16_t voltage_step;
uint16_t current_max;
uint16_t current_min;
uint16_t current_step;
uint16_t input_current_max;
uint16_t input_current_min;
uint16_t input_current_step;
};
/*
* Parameters common to all chargers. Current is in mA, voltage in mV.
* The status and option values are charger-specific.
*/
struct charger_params {
int current;
int voltage;
int input_current;
int status;
int option;
int flags;
};
struct charger_drv {
/* Function to call during HOOK_INIT after i2c init */
void (*init)(int chgnum);
/* Power state machine post init */
enum ec_error_list (*post_init)(int chgnum);
/* Get charger information */
const struct charger_info * (*get_info)(int chgnum);
/* Get smart battery charger status. Supported flags may vary. */
enum ec_error_list (*get_status)(int chgnum, int *status);
/* Set smart battery charger mode. Supported modes may vary. */
enum ec_error_list (*set_mode)(int chgnum, int mode);
/*
* For chargers that are able to supply output power for OTG dongle,
* this function enables or disables power output.
*/
enum ec_error_list (*enable_otg_power)(int chgnum, int enabled);
/*
* Sets OTG current limit and voltage (independent of whether OTG
* power is currently enabled).
*/
enum ec_error_list (*set_otg_current_voltage)(int chgnum,
int output_current,
int output_voltage);
/* Get/set charge current limit in mA */
enum ec_error_list (*get_current)(int chgnum, int *current);
enum ec_error_list (*set_current)(int chgnum, int current);
/* Get/set charge voltage limit in mV */
enum ec_error_list (*get_voltage)(int chgnum, int *voltage);
enum ec_error_list (*set_voltage)(int chgnum, int voltage);
/* Discharge battery when on AC power. */
enum ec_error_list (*discharge_on_ac)(int chgnum, int enable);
/* Get the VBUS voltage (mV) from the charger */
enum ec_error_list (*get_vbus_voltage)(int chgnum, int port,
int *voltage);
/* Set desired input current value */
enum ec_error_list (*set_input_current)(int chgnum, int input_current);
/* Get actual input current value */
enum ec_error_list (*get_input_current)(int chgnum, int *input_current);
enum ec_error_list (*manufacturer_id)(int chgnum, int *id);
enum ec_error_list (*device_id)(int chgnum, int *id);
enum ec_error_list (*get_option)(int chgnum, int *option);
enum ec_error_list (*set_option)(int chgnum, int option);
/* Charge ramp functions */
enum ec_error_list (*set_hw_ramp)(int chgnum, int enable);
int (*ramp_is_stable)(int chgnum);
int (*ramp_is_detected)(int chgnum);
int (*ramp_get_current_limit)(int chgnum);
};
struct charger_config_t {
int i2c_port;
uint16_t i2c_addr_flags;
const struct charger_drv *drv;
};
/* TODO(b/147672225): structure should be defined in board.c files */
#ifndef CONFIG_CHARGER_RUNTIME_CONFIG
extern const struct charger_config_t chg_chips[];
#else
extern struct charger_config_t chg_chips[];
#endif
extern const unsigned int chg_cnt;
#ifdef CONFIG_CHARGER_SINGLE_CHIP
#define CHARGER_SOLO 0
#endif
/* Get the current charger_params. Failures are reported in .flags */
void charger_get_params(struct charger_params *chg);
/* Bits to indicate which fields of struct charger_params could not be read */
#define CHG_FLAG_BAD_CURRENT 0x00000001
#define CHG_FLAG_BAD_VOLTAGE 0x00000002
#define CHG_FLAG_BAD_INPUT_CURRENT 0x00000004
#define CHG_FLAG_BAD_STATUS 0x00000008
#define CHG_FLAG_BAD_OPTION 0x00000010
/* All of the above CHG_FLAG_BAD_* bits */
#define CHG_FLAG_BAD_ANY 0x0000001f
/**
* Return the closest match the charger can supply to the requested current.
*
* @param current Requested current in mA.
*
* @return Current the charger will actually supply if <current> is requested.
*/
int charger_closest_current(int current);
/**
* Return the closest match the charger can supply to the requested voltage.
*
* @param voltage Requested voltage in mV.
*
* @return Voltage the charger will actually supply if <voltage> is requested.
*/
int charger_closest_voltage(int voltage);
/* Driver wrapper functions */
/*
* TODO(b/147672225): charger_* functions should take chip arg, hardcode
* calls into driver to 0 for now.
*/
/* Power state machine post init */
enum ec_error_list charger_post_init(void);
/* Get charger information. */
const struct charger_info *charger_get_info(void);
/* Get smart battery charger status. Supported flags may vary. */
enum ec_error_list charger_get_status(int *status);
/* Set smart battery charger mode. Supported modes may vary. */
enum ec_error_list charger_set_mode(int mode);
/**
* For chargers that are able to supply output power for OTG dongle, this
* function enables or disables power output.
*/
enum ec_error_list charger_enable_otg_power(int enabled);
/**
* Sets OTG current limit and voltage (independent of whether OTG power is
* currently enabled).
*
* Depending on the charger and use case, one needs to be careful about
* changing the current/voltage while OTG power is enabled, and it might be wise
* to reset the value before enabling OTG power to ensure one does not provide
* excessive voltage to a device.
*
* @param output_current Requested current limit in mA, driver should
* round the value up.
* @param output_voltage Requested voltage in mV, driver should round the
* the value down.
*
* @return EC_SUCCESS on success, an error otherwise.
*/
enum ec_error_list charger_set_otg_current_voltage(int output_current,
int output_voltage);
/**
* Is the charger sourcing VBUS / OTG power?
*
* @param port The Type-C port number.
* @return 1 if sourcing VBUS, 0 if not.
*/
int charger_is_sourcing_otg_power(int port);
/* Get/set charge current limit in mA */
enum ec_error_list charger_get_current(int *current);
enum ec_error_list charger_set_current(int current);
/* Get/set charge voltage limit in mV */
enum ec_error_list charger_get_voltage(int *voltage);
enum ec_error_list charger_set_voltage(int voltage);
/* Discharge battery when on AC power. */
enum ec_error_list charger_discharge_on_ac(int enable);
/* Get the VBUS voltage (mV) from the charger */
enum ec_error_list charger_get_vbus_voltage(int port, int *voltage);
/* Custom board function to discharge battery when on AC power */
int board_discharge_on_ac(int enable);
/*
* Read the current total system power in uW (usually from PSYS).
* Can be negative if the PSYS output is not currently enabled (e.g. AP is off).
*/
int charger_get_system_power(void);
/* Other parameters that may be charger-specific, but are common so far. */
/* Set desired input current value */
enum ec_error_list charger_set_input_current(int input_current);
/*
* Get actual input current value.
* Actual input current may be less than the desired input current set
* due to current ratings of the wall adapter.
*/
enum ec_error_list charger_get_input_current(int *input_current);
enum ec_error_list charger_manufacturer_id(int *id);
enum ec_error_list charger_device_id(int *id);
enum ec_error_list charger_get_option(int *option);
enum ec_error_list charger_set_option(int option);
enum ec_error_list charger_set_hw_ramp(int enable);
/* Print all charger info for debugging purposes */
void print_charger_debug(void);
#endif /* __CROS_EC_CHARGER_H */
|
