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
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
|
/*
* intel_mid_battery.c - Intel MID PMIC Battery Driver
*
* Copyright (C) 2009 Intel Corporation
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Author: Nithish Mahalingam <nithish.mahalingam@intel.com>
*/
#include <linux/module.h>
#include <linux/init.h>
#include <linux/err.h>
#include <linux/interrupt.h>
#include <linux/workqueue.h>
#include <linux/jiffies.h>
#include <linux/param.h>
#include <linux/device.h>
#include <linux/spi/spi.h>
#include <linux/platform_device.h>
#include <linux/power_supply.h>
#include <asm/intel_scu_ipc.h>
#define DRIVER_NAME "pmic_battery"
/*********************************************************************
* Generic defines
*********************************************************************/
static int debug;
module_param(debug, int, 0444);
MODULE_PARM_DESC(debug, "Flag to enable PMIC Battery debug messages.");
#define PMIC_BATT_DRV_INFO_UPDATED 1
#define PMIC_BATT_PRESENT 1
#define PMIC_BATT_NOT_PRESENT 0
#define PMIC_USB_PRESENT PMIC_BATT_PRESENT
#define PMIC_USB_NOT_PRESENT PMIC_BATT_NOT_PRESENT
/* pmic battery register related */
#define PMIC_BATT_CHR_SCHRGINT_ADDR 0xD2
#define PMIC_BATT_CHR_SBATOVP_MASK (1 << 1)
#define PMIC_BATT_CHR_STEMP_MASK (1 << 2)
#define PMIC_BATT_CHR_SCOMP_MASK (1 << 3)
#define PMIC_BATT_CHR_SUSBDET_MASK (1 << 4)
#define PMIC_BATT_CHR_SBATDET_MASK (1 << 5)
#define PMIC_BATT_CHR_SDCLMT_MASK (1 << 6)
#define PMIC_BATT_CHR_SUSBOVP_MASK (1 << 7)
#define PMIC_BATT_CHR_EXCPT_MASK 0x86
#define PMIC_BATT_ADC_ACCCHRG_MASK (1 << 31)
#define PMIC_BATT_ADC_ACCCHRGVAL_MASK 0x7FFFFFFF
/* pmic ipc related */
#define PMIC_BATT_CHR_IPC_FCHRG_SUBID 0x4
#define PMIC_BATT_CHR_IPC_TCHRG_SUBID 0x6
/* types of battery charging */
enum batt_charge_type {
BATT_USBOTG_500MA_CHARGE,
BATT_USBOTG_TRICKLE_CHARGE,
};
/* valid battery events */
enum batt_event {
BATT_EVENT_BATOVP_EXCPT,
BATT_EVENT_USBOVP_EXCPT,
BATT_EVENT_TEMP_EXCPT,
BATT_EVENT_DCLMT_EXCPT,
BATT_EVENT_EXCPT
};
/*********************************************************************
* Battery properties
*********************************************************************/
/*
* pmic battery info
*/
struct pmic_power_module_info {
bool is_dev_info_updated;
struct device *dev;
/* pmic battery data */
unsigned long update_time; /* jiffies when data read */
unsigned int usb_is_present;
unsigned int batt_is_present;
unsigned int batt_health;
unsigned int usb_health;
unsigned int batt_status;
unsigned int batt_charge_now; /* in mAS */
unsigned int batt_prev_charge_full; /* in mAS */
unsigned int batt_charge_rate; /* in units per second */
struct power_supply usb;
struct power_supply batt;
int irq; /* GPE_ID or IRQ# */
struct workqueue_struct *monitor_wqueue;
struct delayed_work monitor_battery;
struct work_struct handler;
};
static unsigned int delay_time = 2000; /* in ms */
/*
* pmic ac properties
*/
static enum power_supply_property pmic_usb_props[] = {
POWER_SUPPLY_PROP_PRESENT,
POWER_SUPPLY_PROP_HEALTH,
};
/*
* pmic battery properties
*/
static enum power_supply_property pmic_battery_props[] = {
POWER_SUPPLY_PROP_STATUS,
POWER_SUPPLY_PROP_HEALTH,
POWER_SUPPLY_PROP_PRESENT,
POWER_SUPPLY_PROP_CHARGE_NOW,
POWER_SUPPLY_PROP_CHARGE_FULL,
};
/*
* Glue functions for talking to the IPC
*/
struct battery_property {
u32 capacity; /* Charger capacity */
u8 crnt; /* Quick charge current value*/
u8 volt; /* Fine adjustment of constant charge voltage */
u8 prot; /* CHRGPROT register value */
u8 prot2; /* CHRGPROT1 register value */
u8 timer; /* Charging timer */
};
#define IPCMSG_BATTERY 0xEF
/* Battery coulomb counter accumulator commands */
#define IPC_CMD_CC_WR 0 /* Update coulomb counter value */
#define IPC_CMD_CC_RD 1 /* Read coulomb counter value */
#define IPC_CMD_BATTERY_PROPERTY 2 /* Read Battery property */
/**
* pmic_scu_ipc_battery_cc_read - read battery cc
* @value: battery coulomb counter read
*
* Reads the battery couloumb counter value, returns 0 on success, or
* an error code
*
* This function may sleep. Locking for SCU accesses is handled for
* the caller.
*/
static int pmic_scu_ipc_battery_cc_read(u32 *value)
{
return intel_scu_ipc_command(IPCMSG_BATTERY, IPC_CMD_CC_RD,
NULL, 0, value, 1);
}
/**
* pmic_scu_ipc_battery_property_get - fetch properties
* @prop: battery properties
*
* Retrieve the battery properties from the power management
*
* This function may sleep. Locking for SCU accesses is handled for
* the caller.
*/
static int pmic_scu_ipc_battery_property_get(struct battery_property *prop)
{
u32 data[3];
u8 *p = (u8 *)&data[1];
int err = intel_scu_ipc_command(IPCMSG_BATTERY,
IPC_CMD_BATTERY_PROPERTY, NULL, 0, data, 3);
prop->capacity = data[0];
prop->crnt = *p++;
prop->volt = *p++;
prop->prot = *p++;
prop->prot2 = *p++;
prop->timer = *p++;
return err;
}
/**
* pmic_scu_ipc_set_charger - set charger
* @charger: charger to select
*
* Switch the charging mode for the SCU
*/
static int pmic_scu_ipc_set_charger(int charger)
{
return intel_scu_ipc_simple_command(IPCMSG_BATTERY, charger);
}
/**
* pmic_battery_log_event - log battery events
* @event: battery event to be logged
* Context: can sleep
*
* There are multiple battery events which may be of interest to users;
* this battery function logs the different battery events onto the
* kernel log messages.
*/
static void pmic_battery_log_event(enum batt_event event)
{
printk(KERN_WARNING "pmic-battery: ");
switch (event) {
case BATT_EVENT_BATOVP_EXCPT:
printk(KERN_CONT "battery overvoltage condition\n");
break;
case BATT_EVENT_USBOVP_EXCPT:
printk(KERN_CONT "usb charger overvoltage condition\n");
break;
case BATT_EVENT_TEMP_EXCPT:
printk(KERN_CONT "high battery temperature condition\n");
break;
case BATT_EVENT_DCLMT_EXCPT:
printk(KERN_CONT "over battery charge current condition\n");
break;
default:
printk(KERN_CONT "charger/battery exception %d\n", event);
break;
}
}
/**
* pmic_battery_read_status - read battery status information
* @pbi: device info structure to update the read information
* Context: can sleep
*
* PMIC power source information need to be updated based on the data read
* from the PMIC battery registers.
*
*/
static void pmic_battery_read_status(struct pmic_power_module_info *pbi)
{
unsigned int update_time_intrvl;
unsigned int chrg_val;
u32 ccval;
u8 r8;
struct battery_property batt_prop;
int batt_present = 0;
int usb_present = 0;
int batt_exception = 0;
/* make sure the last batt_status read happened delay_time before */
if (pbi->update_time && time_before(jiffies, pbi->update_time +
msecs_to_jiffies(delay_time)))
return;
update_time_intrvl = jiffies_to_msecs(jiffies - pbi->update_time);
pbi->update_time = jiffies;
/* read coulomb counter registers and schrgint register */
if (pmic_scu_ipc_battery_cc_read(&ccval)) {
dev_warn(pbi->dev, "%s(): ipc config cmd failed\n",
__func__);
return;
}
if (intel_scu_ipc_ioread8(PMIC_BATT_CHR_SCHRGINT_ADDR, &r8)) {
dev_warn(pbi->dev, "%s(): ipc pmic read failed\n",
__func__);
return;
}
/*
* set pmic_power_module_info members based on pmic register values
* read.
|