2 * max8973-regulator.c -- Maxim max8973
4 * Regulator driver for MAXIM 8973 DC-DC step-down switching regulator.
6 * Copyright (c) 2012, NVIDIA Corporation.
8 * Author: Laxman Dewangan <ldewangan@nvidia.com>
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License as
12 * published by the Free Software Foundation version 2.
14 * This program is distributed "as is" WITHOUT ANY WARRANTY of any kind,
15 * whether express or implied; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/init.h>
28 #include <linux/err.h>
30 #include <linux/platform_device.h>
31 #include <linux/regulator/driver.h>
32 #include <linux/regulator/machine.h>
33 #include <linux/regulator/max8973-regulator.h>
34 #include <linux/regulator/of_regulator.h>
35 #include <linux/gpio.h>
36 #include <linux/of_gpio.h>
37 #include <linux/i2c.h>
38 #include <linux/slab.h>
39 #include <linux/regmap.h>
41 /* Register definitions */
42 #define MAX8973_VOUT 0x0
43 #define MAX8973_VOUT_DVS 0x1
44 #define MAX8973_CONTROL1 0x2
45 #define MAX8973_CONTROL2 0x3
46 #define MAX8973_CHIPID1 0x4
47 #define MAX8973_CHIPID2 0x5
49 #define MAX8973_MAX_VOUT_REG 2
52 #define MAX8973_VOUT_ENABLE BIT(7)
53 #define MAX8973_VOUT_MASK 0x7F
55 /* MAX8973_VOUT_DVS */
56 #define MAX8973_DVS_VOUT_MASK 0x7F
58 /* MAX8973_CONTROL1 */
59 #define MAX8973_SNS_ENABLE BIT(7)
60 #define MAX8973_FPWM_EN_M BIT(6)
61 #define MAX8973_NFSR_ENABLE BIT(5)
62 #define MAX8973_AD_ENABLE BIT(4)
63 #define MAX8973_BIAS_ENABLE BIT(3)
64 #define MAX8973_FREQSHIFT_9PER BIT(2)
66 #define MAX8973_RAMP_12mV_PER_US 0x0
67 #define MAX8973_RAMP_25mV_PER_US 0x1
68 #define MAX8973_RAMP_50mV_PER_US 0x2
69 #define MAX8973_RAMP_200mV_PER_US 0x3
71 /* MAX8973_CONTROL2 */
72 #define MAX8973_WDTMR_ENABLE BIT(6)
73 #define MAX8973_DISCH_ENBABLE BIT(5)
74 #define MAX8973_FT_ENABLE BIT(4)
76 #define MAX8973_CKKADV_TRIP_DISABLE 0xC
77 #define MAX8973_CKKADV_TRIP_75mV_PER_US 0x0
78 #define MAX8973_CKKADV_TRIP_150mV_PER_US 0x4
79 #define MAX8973_CKKADV_TRIP_75mV_PER_US_HIST_DIS 0x8
80 #define MAX8973_CONTROL_CLKADV_TRIP_MASK 0x00030000
82 #define MAX8973_INDUCTOR_MIN_30_PER 0x0
83 #define MAX8973_INDUCTOR_NOMINAL 0x1
84 #define MAX8973_INDUCTOR_PLUS_30_PER 0x2
85 #define MAX8973_INDUCTOR_PLUS_60_PER 0x3
86 #define MAX8973_CONTROL_INDUCTOR_VALUE_MASK 0x00300000
88 #define MAX8973_MIN_VOLATGE 606250
89 #define MAX8973_MAX_VOLATGE 1400000
90 #define MAX8973_VOLATGE_STEP 6250
91 #define MAX8973_BUCK_N_VOLTAGE 0x80
93 /* Maxim 8973 chip information */
96 struct regulator_desc desc
;
97 struct regmap
*regmap
;
98 bool enable_external_control
;
101 int lru_index
[MAX8973_MAX_VOUT_REG
];
102 int curr_vout_val
[MAX8973_MAX_VOUT_REG
];
105 struct regulator_ops ops
;
109 * find_voltage_set_register: Find new voltage configuration register (VOUT).
110 * The finding of the new VOUT register will be based on the LRU mechanism.
111 * Each VOUT register will have different voltage configured . This
112 * Function will look if any of the VOUT register have requested voltage set
114 * - If it is already there then it will make that register as most
115 * recently used and return as found so that caller need not to set
116 * the VOUT register but need to set the proper gpios to select this
118 * - If requested voltage is not found then it will use the least
119 * recently mechanism to get new VOUT register for new configuration
120 * and will return not_found so that caller need to set new VOUT
121 * register and then gpios (both).
123 static bool find_voltage_set_register(struct max8973_chip
*tps
,
124 int req_vsel
, int *vout_reg
, int *gpio_val
)
128 int new_vout_reg
= tps
->lru_index
[MAX8973_MAX_VOUT_REG
- 1];
129 int found_index
= MAX8973_MAX_VOUT_REG
- 1;
131 for (i
= 0; i
< MAX8973_MAX_VOUT_REG
; ++i
) {
132 if (tps
->curr_vout_val
[tps
->lru_index
[i
]] == req_vsel
) {
133 new_vout_reg
= tps
->lru_index
[i
];
136 goto update_lru_index
;
141 for (i
= found_index
; i
> 0; i
--)
142 tps
->lru_index
[i
] = tps
->lru_index
[i
- 1];
144 tps
->lru_index
[0] = new_vout_reg
;
145 *gpio_val
= new_vout_reg
;
146 *vout_reg
= MAX8973_VOUT
+ new_vout_reg
;
150 static int max8973_dcdc_get_voltage_sel(struct regulator_dev
*rdev
)
152 struct max8973_chip
*max
= rdev_get_drvdata(rdev
);
156 ret
= regmap_read(max
->regmap
, max
->curr_vout_reg
, &data
);
158 dev_err(max
->dev
, "register %d read failed, err = %d\n",
159 max
->curr_vout_reg
, ret
);
162 return data
& MAX8973_VOUT_MASK
;
165 static int max8973_dcdc_set_voltage_sel(struct regulator_dev
*rdev
,
168 struct max8973_chip
*max
= rdev_get_drvdata(rdev
);
171 int vout_reg
= max
->curr_vout_reg
;
172 int gpio_val
= max
->curr_gpio_val
;
175 * If gpios are available to select the VOUT register then least
176 * recently used register for new configuration.
178 if (gpio_is_valid(max
->dvs_gpio
))
179 found
= find_voltage_set_register(max
, vsel
,
180 &vout_reg
, &gpio_val
);
183 ret
= regmap_update_bits(max
->regmap
, vout_reg
,
184 MAX8973_VOUT_MASK
, vsel
);
186 dev_err(max
->dev
, "register %d update failed, err %d\n",
190 max
->curr_vout_reg
= vout_reg
;
191 max
->curr_vout_val
[gpio_val
] = vsel
;
194 /* Select proper VOUT register vio gpios */
195 if (gpio_is_valid(max
->dvs_gpio
)) {
196 gpio_set_value_cansleep(max
->dvs_gpio
, gpio_val
& 0x1);
197 max
->curr_gpio_val
= gpio_val
;
202 static int max8973_dcdc_set_mode(struct regulator_dev
*rdev
, unsigned int mode
)
204 struct max8973_chip
*max
= rdev_get_drvdata(rdev
);
208 /* Enable force PWM mode in FAST mode only. */
210 case REGULATOR_MODE_FAST
:
211 pwm
= MAX8973_FPWM_EN_M
;
214 case REGULATOR_MODE_NORMAL
:
222 ret
= regmap_update_bits(max
->regmap
, MAX8973_CONTROL1
,
223 MAX8973_FPWM_EN_M
, pwm
);
225 dev_err(max
->dev
, "register %d update failed, err %d\n",
226 MAX8973_CONTROL1
, ret
);
230 static unsigned int max8973_dcdc_get_mode(struct regulator_dev
*rdev
)
232 struct max8973_chip
*max
= rdev_get_drvdata(rdev
);
236 ret
= regmap_read(max
->regmap
, MAX8973_CONTROL1
, &data
);
238 dev_err(max
->dev
, "register %d read failed, err %d\n",
239 MAX8973_CONTROL1
, ret
);
242 return (data
& MAX8973_FPWM_EN_M
) ?
243 REGULATOR_MODE_FAST
: REGULATOR_MODE_NORMAL
;
246 static const struct regulator_ops max8973_dcdc_ops
= {
247 .get_voltage_sel
= max8973_dcdc_get_voltage_sel
,
248 .set_voltage_sel
= max8973_dcdc_set_voltage_sel
,
249 .list_voltage
= regulator_list_voltage_linear
,
250 .set_mode
= max8973_dcdc_set_mode
,
251 .get_mode
= max8973_dcdc_get_mode
,
254 static int max8973_init_dcdc(struct max8973_chip
*max
,
255 struct max8973_regulator_platform_data
*pdata
)
258 uint8_t control1
= 0;
259 uint8_t control2
= 0;
261 if (pdata
->control_flags
& MAX8973_CONTROL_REMOTE_SENSE_ENABLE
)
262 control1
|= MAX8973_SNS_ENABLE
;
264 if (!(pdata
->control_flags
& MAX8973_CONTROL_FALLING_SLEW_RATE_ENABLE
))
265 control1
|= MAX8973_NFSR_ENABLE
;
267 if (pdata
->control_flags
& MAX8973_CONTROL_OUTPUT_ACTIVE_DISCH_ENABLE
)
268 control1
|= MAX8973_AD_ENABLE
;
270 if (pdata
->control_flags
& MAX8973_CONTROL_BIAS_ENABLE
) {
271 control1
|= MAX8973_BIAS_ENABLE
;
272 max
->desc
.enable_time
= 20;
274 max
->desc
.enable_time
= 240;
277 if (pdata
->control_flags
& MAX8973_CONTROL_FREQ_SHIFT_9PER_ENABLE
)
278 control1
|= MAX8973_FREQSHIFT_9PER
;
281 if (pdata
->reg_init_data
&&
282 pdata
->reg_init_data
->constraints
.ramp_delay
) {
283 if (pdata
->reg_init_data
->constraints
.ramp_delay
< 25000)
284 control1
|= MAX8973_RAMP_12mV_PER_US
;
285 else if (pdata
->reg_init_data
->constraints
.ramp_delay
< 50000)
286 control1
|= MAX8973_RAMP_25mV_PER_US
;
287 else if (pdata
->reg_init_data
->constraints
.ramp_delay
< 200000)
288 control1
|= MAX8973_RAMP_50mV_PER_US
;
290 control1
|= MAX8973_RAMP_200mV_PER_US
;
292 control1
|= MAX8973_RAMP_12mV_PER_US
;
293 max
->desc
.ramp_delay
= 12500;
296 if (!(pdata
->control_flags
& MAX8973_CONTROL_PULL_DOWN_ENABLE
))
297 control2
|= MAX8973_DISCH_ENBABLE
;
299 /* Clock advance trip configuration */
300 switch (pdata
->control_flags
& MAX8973_CONTROL_CLKADV_TRIP_MASK
) {
301 case MAX8973_CONTROL_CLKADV_TRIP_DISABLED
:
302 control2
|= MAX8973_CKKADV_TRIP_DISABLE
;
305 case MAX8973_CONTROL_CLKADV_TRIP_75mV_PER_US
:
306 control2
|= MAX8973_CKKADV_TRIP_75mV_PER_US
;
309 case MAX8973_CONTROL_CLKADV_TRIP_150mV_PER_US
:
310 control2
|= MAX8973_CKKADV_TRIP_150mV_PER_US
;
313 case MAX8973_CONTROL_CLKADV_TRIP_75mV_PER_US_HIST_DIS
:
314 control2
|= MAX8973_CKKADV_TRIP_75mV_PER_US_HIST_DIS
;
318 /* Configure inductor value */
319 switch (pdata
->control_flags
& MAX8973_CONTROL_INDUCTOR_VALUE_MASK
) {
320 case MAX8973_CONTROL_INDUCTOR_VALUE_NOMINAL
:
321 control2
|= MAX8973_INDUCTOR_NOMINAL
;
324 case MAX8973_CONTROL_INDUCTOR_VALUE_MINUS_30_PER
:
325 control2
|= MAX8973_INDUCTOR_MIN_30_PER
;
328 case MAX8973_CONTROL_INDUCTOR_VALUE_PLUS_30_PER
:
329 control2
|= MAX8973_INDUCTOR_PLUS_30_PER
;
332 case MAX8973_CONTROL_INDUCTOR_VALUE_PLUS_60_PER
:
333 control2
|= MAX8973_INDUCTOR_PLUS_60_PER
;
337 ret
= regmap_write(max
->regmap
, MAX8973_CONTROL1
, control1
);
339 dev_err(max
->dev
, "register %d write failed, err = %d",
340 MAX8973_CONTROL1
, ret
);
344 ret
= regmap_write(max
->regmap
, MAX8973_CONTROL2
, control2
);
346 dev_err(max
->dev
, "register %d write failed, err = %d",
347 MAX8973_CONTROL2
, ret
);
351 /* If external control is enabled then disable EN bit */
352 if (max
->enable_external_control
) {
353 ret
= regmap_update_bits(max
->regmap
, MAX8973_VOUT
,
354 MAX8973_VOUT_ENABLE
, 0);
356 dev_err(max
->dev
, "register %d update failed, err = %d",
362 static const struct regmap_config max8973_regmap_config
= {
365 .max_register
= MAX8973_CHIPID2
,
366 .cache_type
= REGCACHE_RBTREE
,
369 static struct max8973_regulator_platform_data
*max8973_parse_dt(
372 struct max8973_regulator_platform_data
*pdata
;
373 struct device_node
*np
= dev
->of_node
;
377 pdata
= devm_kzalloc(dev
, sizeof(*pdata
), GFP_KERNEL
);
381 pdata
->enable_ext_control
= of_property_read_bool(np
,
382 "maxim,externally-enable");
383 pdata
->enable_gpio
= of_get_named_gpio(np
, "maxim,enable-gpio", 0);
384 pdata
->dvs_gpio
= of_get_named_gpio(np
, "maxim,dvs-gpio", 0);
386 ret
= of_property_read_u32(np
, "maxim,dvs-default-state", &pval
);
388 pdata
->dvs_def_state
= pval
;
390 if (of_property_read_bool(np
, "maxim,enable-remote-sense"))
391 pdata
->control_flags
|= MAX8973_CONTROL_REMOTE_SENSE_ENABLE
;
393 if (of_property_read_bool(np
, "maxim,enable-falling-slew-rate"))
394 pdata
->control_flags
|=
395 MAX8973_CONTROL_FALLING_SLEW_RATE_ENABLE
;
397 if (of_property_read_bool(np
, "maxim,enable-active-discharge"))
398 pdata
->control_flags
|=
399 MAX8973_CONTROL_OUTPUT_ACTIVE_DISCH_ENABLE
;
401 if (of_property_read_bool(np
, "maxim,enable-frequency-shift"))
402 pdata
->control_flags
|= MAX8973_CONTROL_FREQ_SHIFT_9PER_ENABLE
;
404 if (of_property_read_bool(np
, "maxim,enable-bias-control"))
405 pdata
->control_flags
|= MAX8973_BIAS_ENABLE
;
410 static int max8973_probe(struct i2c_client
*client
,
411 const struct i2c_device_id
*id
)
413 struct max8973_regulator_platform_data
*pdata
;
414 struct regulator_init_data
*ridata
;
415 struct regulator_config config
= { };
416 struct regulator_dev
*rdev
;
417 struct max8973_chip
*max
;
418 bool pdata_from_dt
= false;
421 pdata
= dev_get_platdata(&client
->dev
);
423 if (!pdata
&& client
->dev
.of_node
) {
424 pdata
= max8973_parse_dt(&client
->dev
);
425 pdata_from_dt
= true;
429 dev_err(&client
->dev
, "No Platform data");
433 if ((pdata
->dvs_gpio
== -EPROBE_DEFER
) ||
434 (pdata
->enable_gpio
== -EPROBE_DEFER
))
435 return -EPROBE_DEFER
;
437 max
= devm_kzalloc(&client
->dev
, sizeof(*max
), GFP_KERNEL
);
441 max
->regmap
= devm_regmap_init_i2c(client
, &max8973_regmap_config
);
442 if (IS_ERR(max
->regmap
)) {
443 ret
= PTR_ERR(max
->regmap
);
444 dev_err(&client
->dev
, "regmap init failed, err %d\n", ret
);
448 i2c_set_clientdata(client
, max
);
449 max
->ops
= max8973_dcdc_ops
;
450 max
->dev
= &client
->dev
;
451 max
->desc
.name
= id
->name
;
453 max
->desc
.ops
= &max
->ops
;
454 max
->desc
.type
= REGULATOR_VOLTAGE
;
455 max
->desc
.owner
= THIS_MODULE
;
456 max
->desc
.min_uV
= MAX8973_MIN_VOLATGE
;
457 max
->desc
.uV_step
= MAX8973_VOLATGE_STEP
;
458 max
->desc
.n_voltages
= MAX8973_BUCK_N_VOLTAGE
;
460 max
->dvs_gpio
= (pdata
->dvs_gpio
) ? pdata
->dvs_gpio
: -EINVAL
;
461 max
->enable_gpio
= (pdata
->enable_gpio
) ? pdata
->enable_gpio
: -EINVAL
;
462 max
->enable_external_control
= pdata
->enable_ext_control
;
463 max
->curr_gpio_val
= pdata
->dvs_def_state
;
464 max
->curr_vout_reg
= MAX8973_VOUT
+ pdata
->dvs_def_state
;
466 if (gpio_is_valid(max
->enable_gpio
))
467 max
->enable_external_control
= true;
469 if (!pdata
->enable_ext_control
) {
470 max
->desc
.enable_reg
= MAX8973_VOUT
;
471 max
->desc
.enable_mask
= MAX8973_VOUT_ENABLE
;
472 max
->ops
.enable
= regulator_enable_regmap
;
473 max
->ops
.disable
= regulator_disable_regmap
;
474 max
->ops
.is_enabled
= regulator_is_enabled_regmap
;
477 max
->lru_index
[0] = max
->curr_vout_reg
;
479 if (gpio_is_valid(max
->dvs_gpio
)) {
483 gpio_flags
= (pdata
->dvs_def_state
) ?
484 GPIOF_OUT_INIT_HIGH
: GPIOF_OUT_INIT_LOW
;
485 ret
= devm_gpio_request_one(&client
->dev
, max
->dvs_gpio
,
486 gpio_flags
, "max8973-dvs");
488 dev_err(&client
->dev
,
489 "gpio_request for gpio %d failed, err = %d\n",
495 * Initialize the lru index with vout_reg id
496 * The index 0 will be most recently used and
497 * set with the max->curr_vout_reg */
498 for (i
= 0; i
< MAX8973_MAX_VOUT_REG
; ++i
)
499 max
->lru_index
[i
] = i
;
500 max
->lru_index
[0] = max
->curr_vout_reg
;
501 max
->lru_index
[max
->curr_vout_reg
] = 0;
505 pdata
->reg_init_data
= of_get_regulator_init_data(&client
->dev
,
506 client
->dev
.of_node
, &max
->desc
);
508 ret
= max8973_init_dcdc(max
, pdata
);
510 dev_err(max
->dev
, "Max8973 Init failed, err = %d\n", ret
);
514 config
.dev
= &client
->dev
;
515 config
.init_data
= pdata
->reg_init_data
;
516 config
.driver_data
= max
;
517 config
.of_node
= client
->dev
.of_node
;
518 config
.regmap
= max
->regmap
;
520 if (gpio_is_valid(max
->enable_gpio
)) {
521 ridata
= pdata
->reg_init_data
;
522 config
.ena_gpio_flags
= GPIOF_OUT_INIT_LOW
;
523 if (ridata
&& (ridata
->constraints
.always_on
||
524 ridata
->constraints
.boot_on
))
525 config
.ena_gpio_flags
= GPIOF_OUT_INIT_HIGH
;
526 config
.ena_gpio
= max
->enable_gpio
;
529 /* Register the regulators */
530 rdev
= devm_regulator_register(&client
->dev
, &max
->desc
, &config
);
533 dev_err(max
->dev
, "regulator register failed, err %d\n", ret
);
540 static const struct i2c_device_id max8973_id
[] = {
541 {.name
= "max8973",},
545 MODULE_DEVICE_TABLE(i2c
, max8973_id
);
547 static struct i2c_driver max8973_i2c_driver
= {
550 .owner
= THIS_MODULE
,
552 .probe
= max8973_probe
,
553 .id_table
= max8973_id
,
556 static int __init
max8973_init(void)
558 return i2c_add_driver(&max8973_i2c_driver
);
560 subsys_initcall(max8973_init
);
562 static void __exit
max8973_cleanup(void)
564 i2c_del_driver(&max8973_i2c_driver
);
566 module_exit(max8973_cleanup
);
568 MODULE_AUTHOR("Laxman Dewangan <ldewangan@nvidia.com>");
569 MODULE_DESCRIPTION("MAX8973 voltage regulator driver");
570 MODULE_LICENSE("GPL v2");