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>
7 * ABX500 core access functions.
8 * The abx500 interface is used for the Analog Baseband chip
9 * ab3100, ab5500, and ab8500.
11 * Author: Mattias Wallin <mattias.wallin@stericsson.com>
12 * Author: Mattias Nilsson <mattias.i.nilsson@stericsson.com>
13 * Author: Bengt Jonsson <bengt.g.jonsson@stericsson.com>
14 * Author: Rickard Andersson <rickard.andersson@stericsson.com>
17 #include <linux/device.h>
18 #include <linux/regulator/machine.h>
23 #define AB3100_P1A 0xc0
24 #define AB3100_P1B 0xc1
25 #define AB3100_P1C 0xc2
26 #define AB3100_P1D 0xc3
27 #define AB3100_P1E 0xc4
28 #define AB3100_P1F 0xc5
29 #define AB3100_P1G 0xc6
30 #define AB3100_R2A 0xc7
31 #define AB3100_R2B 0xc8
32 #define AB5500_1_0 0x20
33 #define AB5500_1_1 0x21
34 #define AB5500_2_0 0x24
37 * AB3100, EVENTA1, A2 and A3 event register flags
38 * these are catenated into a single 32-bit flag in the code
39 * for event notification broadcasts.
41 #define AB3100_EVENTA1_ONSWA (0x01<<16)
42 #define AB3100_EVENTA1_ONSWB (0x02<<16)
43 #define AB3100_EVENTA1_ONSWC (0x04<<16)
44 #define AB3100_EVENTA1_DCIO (0x08<<16)
45 #define AB3100_EVENTA1_OVER_TEMP (0x10<<16)
46 #define AB3100_EVENTA1_SIM_OFF (0x20<<16)
47 #define AB3100_EVENTA1_VBUS (0x40<<16)
48 #define AB3100_EVENTA1_VSET_USB (0x80<<16)
50 #define AB3100_EVENTA2_READY_TX (0x01<<8)
51 #define AB3100_EVENTA2_READY_RX (0x02<<8)
52 #define AB3100_EVENTA2_OVERRUN_ERROR (0x04<<8)
53 #define AB3100_EVENTA2_FRAMING_ERROR (0x08<<8)
54 #define AB3100_EVENTA2_CHARG_OVERCURRENT (0x10<<8)
55 #define AB3100_EVENTA2_MIDR (0x20<<8)
56 #define AB3100_EVENTA2_BATTERY_REM (0x40<<8)
57 #define AB3100_EVENTA2_ALARM (0x80<<8)
59 #define AB3100_EVENTA3_ADC_TRIG5 (0x01)
60 #define AB3100_EVENTA3_ADC_TRIG4 (0x02)
61 #define AB3100_EVENTA3_ADC_TRIG3 (0x04)
62 #define AB3100_EVENTA3_ADC_TRIG2 (0x08)
63 #define AB3100_EVENTA3_ADC_TRIGVBAT (0x10)
64 #define AB3100_EVENTA3_ADC_TRIGVTX (0x20)
65 #define AB3100_EVENTA3_ADC_TRIG1 (0x40)
66 #define AB3100_EVENTA3_ADC_TRIG0 (0x80)
68 /* AB3100, STR register flags */
69 #define AB3100_STR_ONSWA (0x01)
70 #define AB3100_STR_ONSWB (0x02)
71 #define AB3100_STR_ONSWC (0x04)
72 #define AB3100_STR_DCIO (0x08)
73 #define AB3100_STR_BOOT_MODE (0x10)
74 #define AB3100_STR_SIM_OFF (0x20)
75 #define AB3100_STR_BATT_REMOVAL (0x40)
76 #define AB3100_STR_VBUS (0x80)
79 * AB3100 contains 8 regulators, one external regulator controller
80 * and a buck converter, further the LDO E and buck converter can
81 * have separate settings if they are in sleep mode, this is
82 * modeled as a separate regulator.
84 #define AB3100_NUM_REGULATORS 10
88 * @access_mutex: lock out concurrent accesses to the AB3100 registers
89 * @dev: pointer to the containing device
90 * @i2c_client: I2C client for this chip
91 * @testreg_client: secondary client for test registers
92 * @chip_name: name of this chip variant
93 * @chip_id: 8 bit chip ID for this chip variant
94 * @event_subscribers: event subscribers are listed here
95 * @startup_events: a copy of the first reading of the event registers
96 * @startup_events_read: whether the first events have been read
98 * This struct is PRIVATE and devices using it should NOT
99 * access ANY fields. It is used as a token for calling the
103 struct mutex access_mutex
;
105 struct i2c_client
*i2c_client
;
106 struct i2c_client
*testreg_client
;
109 struct blocking_notifier_head event_subscribers
;
110 u8 startup_events
[3];
111 bool startup_events_read
;
115 * struct ab3100_platform_data
116 * Data supplied to initialize board connections to the AB3100
117 * @reg_constraints: regulator constraints for target board
118 * the order of these constraints are: LDO A, C, D, E,
119 * F, G, H, K, EXT and BUCK.
120 * @reg_initvals: initial values for the regulator registers
121 * plus two sleep settings for LDO E and the BUCK converter.
122 * exactly AB3100_NUM_REGULATORS+2 values must be sent in.
123 * Order: LDO A, C, E, E sleep, F, G, H, K, EXT, BUCK,
124 * BUCK sleep, LDO D. (LDO D need to be initialized last.)
125 * @external_voltage: voltage level of the external regulator.
127 struct ab3100_platform_data
{
128 struct regulator_init_data reg_constraints
[AB3100_NUM_REGULATORS
];
129 u8 reg_initvals
[AB3100_NUM_REGULATORS
+2];
130 int external_voltage
;
133 int ab3100_event_register(struct ab3100
*ab3100
,
134 struct notifier_block
*nb
);
135 int ab3100_event_unregister(struct ab3100
*ab3100
,
136 struct notifier_block
*nb
);
139 * struct abx500_init_setting
140 * Initial value of the registers for driver to use during setup.
142 struct abx500_init_settings
{
148 int abx500_set_register_interruptible(struct device
*dev
, u8 bank
, u8 reg
,
150 int abx500_get_register_interruptible(struct device
*dev
, u8 bank
, u8 reg
,
152 int abx500_get_register_page_interruptible(struct device
*dev
, u8 bank
,
153 u8 first_reg
, u8
*regvals
, u8 numregs
);
154 int abx500_set_register_page_interruptible(struct device
*dev
, u8 bank
,
155 u8 first_reg
, u8
*regvals
, u8 numregs
);
157 * abx500_mask_and_set_register_inerruptible() - Modifies selected bits of a
160 * @dev: The AB sub device.
161 * @bank: The i2c bank number.
162 * @bitmask: The bit mask to use.
163 * @bitvalues: The new bit values.
165 * Updates the value of an AB register:
166 * value -> ((value & ~bitmask) | (bitvalues & bitmask))
168 int abx500_mask_and_set_register_interruptible(struct device
*dev
, u8 bank
,
169 u8 reg
, u8 bitmask
, u8 bitvalues
);
170 int abx500_get_chip_id(struct device
*dev
);
171 int abx500_event_registers_startup_state_get(struct device
*dev
, u8
*event
);
172 int abx500_startup_irq_enabled(struct device
*dev
, unsigned int irq
);
175 int (*get_chip_id
) (struct device
*);
176 int (*get_register
) (struct device
*, u8
, u8
, u8
*);
177 int (*set_register
) (struct device
*, u8
, u8
, u8
);
178 int (*get_register_page
) (struct device
*, u8
, u8
, u8
*, u8
);
179 int (*set_register_page
) (struct device
*, u8
, u8
, u8
*, u8
);
180 int (*mask_and_set_register
) (struct device
*, u8
, u8
, u8
, u8
);
181 int (*event_registers_startup_state_get
) (struct device
*, u8
*);
182 int (*startup_irq_enabled
) (struct device
*, unsigned int);
185 int abx500_register_ops(struct device
*core_dev
, struct abx500_ops
*ops
);
186 void abx500_remove_ops(struct device
*dev
);