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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
|
/*
* Copyright (C) 2010 Freescale Semiconductor, Inc. All Rights Reserved.
*/
/*
* The code contained herein is licensed under the GNU General Public
* License. You may obtain a copy of the GNU General Public License
* Version 2 or later at the following locations:
*
* http://www.opensource.org/licenses/gpl-license.html
* http://www.gnu.org/copyleft/gpl.html
*/
/* Includes */
#include <linux/kernel.h>
#include "ddi_bc_internal.h"
/* Variables */
/* This structure holds the current Battery Charger configuration. */
ddi_bc_Cfg_t g_ddi_bc_Configuration;
extern uint32_t g_ddi_bc_u32StateTimer;
extern ddi_bc_BrokenReason_t ddi_bc_gBrokenReason;
extern bool bRestartChargeCycle;
/* Code */
/* brief Report the Battery Charger configuration. */
/* fntype Function */
/* This function reports the Battery Charger configuration. */
/* Note that, if the Battery Charger has not yet been initialized, the data */
/* returned by this function is unknown. */
/* param[in,out] pCfg A pointer to a structure that will receive the data. */
void ddi_bc_QueryCfg(ddi_bc_Cfg_t *pCfg)
{
/* -------------------------------------------------------------------------- */
/* Return the current configuration. */
/* -------------------------------------------------------------------------- */
*pCfg = g_ddi_bc_Configuration;
}
/* brief Shut down the Battery Charger. */
/* fntype Function */
/* This function immediately shuts down the Battery Charger hardware and */
/* returns the state machine to the Uninitialized state. Use this function to */
/* safely mummify the battery charger before retiring it from memory. */
void ddi_bc_ShutDown()
{
/* -------------------------------------------------------------------------- */
/* Reset the current ramp. */
/* -------------------------------------------------------------------------- */
ddi_bc_RampReset();
/* -------------------------------------------------------------------------- */
/* Move to the Uninitialized state. */
/* -------------------------------------------------------------------------- */
g_ddi_bc_State = DDI_BC_STATE_UNINITIALIZED;
}
/* brief Advances the state machine. */
/* fntype Function */
/* This function advances the state machine. */
/* retval DDI_BC_STATUS_SUCCESS If all goes well */
/* retval DDI_BC_STATUS_NOT_INITIALIZED If the Battery Charger is not yet */
/* initialized. */
/* retval DDI_BC_STATUS_BROKEN If the battery violated a time-out */
/* and has been declared broken. */
ddi_bc_Status_t ddi_bc_StateMachine()
{
int ret, state;
/* -------------------------------------------------------------------------- */
/* Check if we've been initialized yet. */
/* -------------------------------------------------------------------------- */
if (g_ddi_bc_State == DDI_BC_STATE_UNINITIALIZED) {
return DDI_BC_STATUS_NOT_INITIALIZED;
}
/* -------------------------------------------------------------------------- */
/* Execute the function for the current state. */
/* -------------------------------------------------------------------------- */
state = g_ddi_bc_State;
ret = (stateFunctionTable[g_ddi_bc_State] ());
if (state != g_ddi_bc_State)
pr_debug("Charger: transit from state %d to %d\n",
state, g_ddi_bc_State);
return ret;
}
/* brief Get the Battery Charger's current state. */
/* fntype Function */
/* This function returns the current state. */
/* retval The current state. */
ddi_bc_State_t ddi_bc_GetState()
{
/* -------------------------------------------------------------------------- */
/* Return the current state. */
/* -------------------------------------------------------------------------- */
return g_ddi_bc_State;
}
/* brief Disable the Battery Charger. */
/* fntype Function */
/* This function forces the Battery Charger into the Disabled state. */
/* retval DDI_BC_STATUS_SUCCESS If all goes well */
/* retval DDI_BC_STATUS_NOT_INITIALIZED If the Battery Charger is not yet */
/* initialized. */
ddi_bc_Status_t ddi_bc_SetDisable()
{
/* -------------------------------------------------------------------------- */
/* Check if we've been initialized yet. */
/* -------------------------------------------------------------------------- */
if (g_ddi_bc_State == DDI_BC_STATE_UNINITIALIZED) {
return DDI_BC_STATUS_NOT_INITIALIZED;
}
/* -------------------------------------------------------------------------- */
/* Check if we've been initialized yet. */
/* -------------------------------------------------------------------------- */
if (g_ddi_bc_State == DDI_BC_STATE_BROKEN) {
return DDI_BC_STATUS_BROKEN;
}
/* -------------------------------------------------------------------------- */
/* Reset the current ramp. This will jam the current to zero and power off */
/* the charging hardware. */
/* -------------------------------------------------------------------------- */
ddi_bc_RampReset();
/* -------------------------------------------------------------------------- */
/* Reset the state timer. */
/* -------------------------------------------------------------------------- */
g_ddi_bc_u32StateTimer = 0;
/* -------------------------------------------------------------------------- */
/* Move to the Disabled state. */
/* -------------------------------------------------------------------------- */
g_ddi_bc_State = DDI_BC_STATE_DISABLED;
/* -------------------------------------------------------------------------- */
/* Return success. */
/* -------------------------------------------------------------------------- */
return DDI_BC_STATUS_SUCCESS;
}
/* brief Enable the Battery Charger. */
/* fntype Function */
/* If the Battery Charger is in the Disabled state, this function moves it to */
/* the Waiting to Charge state. */
/* retval DDI_BC_STATUS_SUCCESS If all goes well */
/* retval DDI_BC_STATUS_NOT_INITIALIZED If the Battery Charger is not yet */
/* initialized. */
/* retval DDI_BC_STATUS_NOT_DISABLED If the Battery Charger is not */
/* disabled. */
ddi_bc_Status_t ddi_bc_SetEnable()
{
/* -------------------------------------------------------------------------- */
/* Check if we've been initialized yet. */
/* -------------------------------------------------------------------------- */
if (g_ddi_bc_State == DDI_BC_STATE_UNINITIALIZED) {
return DDI_BC_STATUS_NOT_INITIALIZED;
}
/* -------------------------------------------------------------------------- */
/* If we're not in the Disabled state, this is pointless. */
/* -------------------------------------------------------------------------- */
if (g_ddi_bc_State != DDI_BC_STATE_DISABLED) {
return DDI_BC_STATUS_NOT_DISABLED;
}
/* -------------------------------------------------------------------------- */
/* Reset the state timer. */
/* -------------------------------------------------------------------------- */
g_ddi_bc_u32StateTimer = 0;
/* -------------------------------------------------------------------------- */
/* Move to the Waiting to Charge state. */
/* -------------------------------------------------------------------------- */
g_ddi_bc_State = DDI_BC_STATE_WAITING_TO_CHARGE;
/* -------------------------------------------------------------------------- */
/* Return success. */
/* -------------------------------------------------------------------------- */
return DDI_BC_STATUS_SUCCESS;
}
/* brief Declare the battery to be broken. */
/* fntype Function */
/* This function forces the Battery Charger into the Broken state. */
/* retval DDI_BC_STATUS_SUCCESS If all goes well */
/* retval DDI_BC_STATUS_NOT_INITIALIZED If the Battery Charger is not yet */
/* initialized. */
ddi_bc_Status_t ddi_bc_SetBroken()
{
/* -------------------------------------------------------------------------- */
/* Check if we've been initialized yet. */
/* -------------------------------------------------------------------------- */
if (g_ddi_bc_State == DDI_BC_STATE_UNINITIALIZED) {
return DDI_BC_STATUS_NOT_INITIALIZED;
}
/* -------------------------------------------------------------------------- */
/* Reset the current ramp. This will jam the current to zero and power off */
/* the charging hardware. */
/* -------------------------------------------------------------------------- */
ddi_bc_RampReset();
/* -------------------------------------------------------------------------- */
/* Reset the state timer. */
/* -------------------------------------------------------------------------- */
g_ddi_bc_u32StateTimer = 0;
/* -------------------------------------------------------------------------- */
/* Move to the Broken state. */
/* -------------------------------------------------------------------------- */
ddi_bc_gBrokenReason = DDI_BC_BROKEN_CHARGING_TIMEOUT;
g_ddi_bc_State = DDI_BC_STATE_BROKEN;
/* -------------------------------------------------------------------------- */
/* Return success. */
/* -------------------------------------------------------------------------- */
return DDI_BC_STATUS_SUCCESS;
}
/* brief Declare the battery to be fixed. */
/* fntype Function */
/* If the Battery Charger is in the Broken state, this function moves it to */
/* the Disabled state. */
/* retval DDI_BC_STATUS_SUCCESS If all goes well */
/* retval DDI_BC_STATUS_NOT_INITIALIZED If the Battery Charger is not yet */
/* initialized. */
/* retval DDI_BC_STATUS_NOT_BROKEN If the Battery Charger is not broken. */
ddi_bc_Status_t ddi_bc_SetFixed()
{
/* -------------------------------------------------------------------------- */
/* Check if we've been initialized yet. */
/* -------------------------------------------------------------------------- */
if (g_ddi_bc_State == DDI_BC_STATE_UNINITIALIZED) {
return DDI_BC_STATUS_NOT_INITIALIZED;
}
/* -------------------------------------------------------------------------- */
/* If we're not in the Broken state, this is pointless. */
/* -------------------------------------------------------------------------- */
if (g_ddi_bc_State != DDI_BC_STATE_BROKEN) {
return DDI_BC_STATUS_NOT_BROKEN;
}
/* -------------------------------------------------------------------------- */
/* Reset the state timer. */
/* -------------------------------------------------------------------------- */
g_ddi_bc_u32StateTimer = 0;
/* -------------------------------------------------------------------------- */
/* Unitialize the Broken Reason */
/* -------------------------------------------------------------------------- */
ddi_bc_gBrokenReason = DDI_BC_BROKEN_UNINITIALIZED;
/* -------------------------------------------------------------------------- */
/* Move to the Disabled state. */
/* -------------------------------------------------------------------------- */
g_ddi_bc_State = DDI_BC_STATE_DISABLED;
/* -------------------------------------------------------------------------- */
/* Return success. */
/* -------------------------------------------------------------------------- */
return DDI_BC_STATUS_SUCCESS;
}
/* brief Set the current limit. */
/* fntype Function */
/* This function applies a limit to the current that the Battery Charger can */
/* draw. */
/* param[in] u16Limit The maximum current the Battery Charger can draw */
/* (in mA). */
/* retval The expressible version of the limit. */
uint16_t ddi_bc_SetCurrentLimit(uint16_t u16Limit)
{
/* -------------------------------------------------------------------------- */
/* Set the limit and return what is actually expressible. */
/* -------------------------------------------------------------------------- */
return ddi_bc_RampSetLimit(u16Limit);
}
/* brief Report the current limit. */
/* fntype Function */
/* This function reports the limit to the current that the Battery Charger can */
/* draw. */
/* retval The current limit. */
uint16_t ddi_bc_GetCurrentLimit(void)
{
/* -------------------------------------------------------------------------- */
/* Set the limit and return what is actually expressible. */
/* -------------------------------------------------------------------------- */
return ddi_bc_RampGetLimit();
}
/* brief Set the battery charger state machine period. */
/* fntype Function */
/* This function sets a new state machine period. The Period and Slope should */
/* be coordinated to achieve the minimal ramp step current which will minimize */
/* transients on the system. */
/* param[in] u32StateMachinePeriod (in milliseconds) */
/* param[in] u16CurrentRampSlope (in mA/s) */
/* retval SUCCESS If all goes well */
/* retval ERROR_DDI_BCM_NOT_INITIALIZED If the Battery Charger is not yet */
/* initialized. */
ddi_bc_Status_t ddi_bc_SetNewPeriodAndSlope(uint32_t u32StateMachinePeriod,
uint16_t u16CurrentRampSlope)
{
/* -------------------------------------------------------------------------- */
/* Check if we've been initialized yet. */
/* -------------------------------------------------------------------------- */
bool bDisableRequired;
if (g_ddi_bc_State == DDI_BC_STATE_UNINITIALIZED) {
return DDI_BC_STATUS_NOT_INITIALIZED;
}
if (g_ddi_bc_State == DDI_BC_STATE_DISABLED)
bDisableRequired = false;
else {
bDisableRequired = true;
ddi_bc_SetDisable();
}
/* Looking at the code, changing the period while the battery charger is running */
/* doesn't seem to have a negative affect. One could wrap this in the mutex */
/* or implement further coordination if it did. */
g_ddi_bc_Configuration.u32StateMachinePeriod = u32StateMachinePeriod;
g_ddi_bc_Configuration.u16CurrentRampSlope = u16CurrentRampSlope;
if (bDisableRequired)
ddi_bc_SetEnable();
return DDI_BC_STATUS_SUCCESS;
}
/* brief Report the state machine period. */
/* fntype Function */
/* This function reports the battery charger period. */
/* retval The battery charger period (in milliseconds). */
uint32_t ddi_bc_GetStateMachinePeriod()
{
return g_ddi_bc_Configuration.u32StateMachinePeriod;
}
/* brief Report the current ramp slope. */
/* fntype Function */
/* This function reports the current ramp slope. */
/* retval The current ramp slope (in mA/s). */
uint32_t ddi_bc_GetCurrentRampSlope()
{
return g_ddi_bc_Configuration.u16CurrentRampSlope;
}
/* brief Report the time spent in the present state (milliseconds) */
/* fntype Function */
/* This function reports the time spent in the present charging state. Note that */
/* for the states that actually charge the battery, this time does not include the */
/* time spent under alarm conditions such as die termperature alarm or battery */
/* temperature alarm. */
/* retval The time spent in the current state in milliseconds. */
uint32_t ddi_bc_GetStateTime(void)
{
return g_ddi_bc_u32StateTimer;
}
/* brief Report the reason for being in the broken state */
/* fntype Function */
/* retval ddi_bc_BrokenReason_t enumeration */
ddi_bc_BrokenReason_t ddi_bc_GetBrokenReason(void)
{
return ddi_bc_gBrokenReason;
}
/* brief Restart the charge cycle */
/* fntype Function */
/* retval SUCCESS */
ddi_bc_Status_t ddi_bc_ForceChargingToStart(void)
{
static int16_t restarts;
if (restarts < DDI_BC_MAX_RESTART_CYCLES) {
restarts++;
bRestartChargeCycle = true;
}
return DDI_BC_STATUS_SUCCESS;
}
/* End of file */
/* @} */
|
