blob: e9aa4c9d749d23bb1d17de53fad3c681833d0ce3 [file] [log] [blame]
Linus Walleij14fa5692009-05-21 23:17:06 +02001/*
2 * Copyright (C) 2007-2009 ST-Ericsson AB
3 * License terms: GNU General Public License (GPL) version 2
4 * AB3100 core access functions
5 * Author: Linus Walleij <linus.walleij@stericsson.com>
6 */
7
8#include <linux/device.h>
Samuel Ortiz8aba7212009-08-27 20:49:08 +02009#include <linux/workqueue.h>
Linus Walleijd619bc12009-09-09 11:31:00 +020010#include <linux/regulator/machine.h>
Linus Walleij14fa5692009-05-21 23:17:06 +020011
12#ifndef MFD_AB3100_H
13#define MFD_AB3100_H
14
15#define ABUNKNOWN 0
16#define AB3000 1
17#define AB3100 2
18
19/*
20 * AB3100, EVENTA1, A2 and A3 event register flags
21 * these are catenated into a single 32-bit flag in the code
22 * for event notification broadcasts.
23 */
24#define AB3100_EVENTA1_ONSWA (0x01<<16)
25#define AB3100_EVENTA1_ONSWB (0x02<<16)
26#define AB3100_EVENTA1_ONSWC (0x04<<16)
27#define AB3100_EVENTA1_DCIO (0x08<<16)
28#define AB3100_EVENTA1_OVER_TEMP (0x10<<16)
29#define AB3100_EVENTA1_SIM_OFF (0x20<<16)
30#define AB3100_EVENTA1_VBUS (0x40<<16)
31#define AB3100_EVENTA1_VSET_USB (0x80<<16)
32
33#define AB3100_EVENTA2_READY_TX (0x01<<8)
34#define AB3100_EVENTA2_READY_RX (0x02<<8)
35#define AB3100_EVENTA2_OVERRUN_ERROR (0x04<<8)
36#define AB3100_EVENTA2_FRAMING_ERROR (0x08<<8)
37#define AB3100_EVENTA2_CHARG_OVERCURRENT (0x10<<8)
38#define AB3100_EVENTA2_MIDR (0x20<<8)
39#define AB3100_EVENTA2_BATTERY_REM (0x40<<8)
40#define AB3100_EVENTA2_ALARM (0x80<<8)
41
42#define AB3100_EVENTA3_ADC_TRIG5 (0x01)
43#define AB3100_EVENTA3_ADC_TRIG4 (0x02)
44#define AB3100_EVENTA3_ADC_TRIG3 (0x04)
45#define AB3100_EVENTA3_ADC_TRIG2 (0x08)
46#define AB3100_EVENTA3_ADC_TRIGVBAT (0x10)
47#define AB3100_EVENTA3_ADC_TRIGVTX (0x20)
48#define AB3100_EVENTA3_ADC_TRIG1 (0x40)
49#define AB3100_EVENTA3_ADC_TRIG0 (0x80)
50
51/* AB3100, STR register flags */
52#define AB3100_STR_ONSWA (0x01)
53#define AB3100_STR_ONSWB (0x02)
54#define AB3100_STR_ONSWC (0x04)
55#define AB3100_STR_DCIO (0x08)
56#define AB3100_STR_BOOT_MODE (0x10)
57#define AB3100_STR_SIM_OFF (0x20)
58#define AB3100_STR_BATT_REMOVAL (0x40)
59#define AB3100_STR_VBUS (0x80)
60
Linus Walleijd619bc12009-09-09 11:31:00 +020061/*
62 * AB3100 contains 8 regulators, one external regulator controller
63 * and a buck converter, further the LDO E and buck converter can
64 * have separate settings if they are in sleep mode, this is
65 * modeled as a separate regulator.
66 */
67#define AB3100_NUM_REGULATORS 10
68
Linus Walleij14fa5692009-05-21 23:17:06 +020069/**
70 * struct ab3100
71 * @access_mutex: lock out concurrent accesses to the AB3100 registers
72 * @dev: pointer to the containing device
73 * @i2c_client: I2C client for this chip
74 * @testreg_client: secondary client for test registers
75 * @chip_name: name of this chip variant
76 * @chip_id: 8 bit chip ID for this chip variant
77 * @work: an event handling worker
78 * @event_subscribers: event subscribers are listed here
79 * @startup_events: a copy of the first reading of the event registers
80 * @startup_events_read: whether the first events have been read
81 *
82 * This struct is PRIVATE and devices using it should NOT
83 * access ANY fields. It is used as a token for calling the
84 * AB3100 functions.
85 */
86struct ab3100 {
87 struct mutex access_mutex;
88 struct device *dev;
89 struct i2c_client *i2c_client;
90 struct i2c_client *testreg_client;
91 char chip_name[32];
92 u8 chip_id;
93 struct work_struct work;
94 struct blocking_notifier_head event_subscribers;
95 u32 startup_events;
96 bool startup_events_read;
97};
98
Linus Walleijd619bc12009-09-09 11:31:00 +020099/**
100 * struct ab3100_platform_data
101 * Data supplied to initialize board connections to the AB3100
102 * @reg_constraints: regulator constraints for target board
103 * the order of these constraints are: LDO A, C, D, E,
104 * F, G, H, K, EXT and BUCK.
105 * @reg_initvals: initial values for the regulator registers
106 * plus two sleep settings for LDO E and the BUCK converter.
107 * exactly AB3100_NUM_REGULATORS+2 values must be sent in.
108 * Order: LDO A, C, E, E sleep, F, G, H, K, EXT, BUCK,
109 * BUCK sleep, LDO D. (LDO D need to be initialized last.)
110 * @external_voltage: voltage level of the external regulator.
111 */
112struct ab3100_platform_data {
113 struct regulator_init_data reg_constraints[AB3100_NUM_REGULATORS];
114 u8 reg_initvals[AB3100_NUM_REGULATORS+2];
115 int external_voltage;
116};
117
Linus Walleij956f25a2009-08-13 11:49:23 +0200118int ab3100_set_register_interruptible(struct ab3100 *ab3100, u8 reg, u8 regval);
119int ab3100_get_register_interruptible(struct ab3100 *ab3100, u8 reg, u8 *regval);
120int ab3100_get_register_page_interruptible(struct ab3100 *ab3100,
Linus Walleij14fa5692009-05-21 23:17:06 +0200121 u8 first_reg, u8 *regvals, u8 numregs);
Linus Walleij956f25a2009-08-13 11:49:23 +0200122int ab3100_mask_and_set_register_interruptible(struct ab3100 *ab3100,
Linus Walleij14fa5692009-05-21 23:17:06 +0200123 u8 reg, u8 andmask, u8 ormask);
124u8 ab3100_get_chip_type(struct ab3100 *ab3100);
125int ab3100_event_register(struct ab3100 *ab3100,
126 struct notifier_block *nb);
127int ab3100_event_unregister(struct ab3100 *ab3100,
128 struct notifier_block *nb);
129int ab3100_event_registers_startup_state_get(struct ab3100 *ab3100,
130 u32 *fatevent);
131
132#endif