Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * max8973-regulator.c -- Maxim max8973A
4 *
5 * Regulator driver for MAXIM 8973A DC-DC step-down switching regulator.
6 *
7 * Copyright (c) 2012, NVIDIA Corporation.
8 *
9 * Author: Laxman Dewangan <ldewangan@nvidia.com>
10 */
11
12#include <linux/kernel.h>
13#include <linux/module.h>
14#include <linux/init.h>
15#include <linux/err.h>
16#include <linux/of.h>
17#include <linux/of_device.h>
18#include <linux/platform_device.h>
19#include <linux/regulator/driver.h>
20#include <linux/regulator/machine.h>
21#include <linux/regulator/max8973-regulator.h>
22#include <linux/regulator/of_regulator.h>
23#include <linux/gpio.h>
24#include <linux/gpio/consumer.h>
25#include <linux/of_gpio.h>
26#include <linux/i2c.h>
27#include <linux/slab.h>
28#include <linux/regmap.h>
29#include <linux/thermal.h>
30#include <linux/irq.h>
31#include <linux/interrupt.h>
32
33/* Register definitions */
34#define MAX8973_VOUT 0x0
35#define MAX8973_VOUT_DVS 0x1
36#define MAX8973_CONTROL1 0x2
37#define MAX8973_CONTROL2 0x3
38#define MAX8973_CHIPID1 0x4
39#define MAX8973_CHIPID2 0x5
40
41#define MAX8973_MAX_VOUT_REG 2
42
43/* MAX8973_VOUT */
44#define MAX8973_VOUT_ENABLE BIT(7)
45#define MAX8973_VOUT_MASK 0x7F
46
47/* MAX8973_VOUT_DVS */
48#define MAX8973_DVS_VOUT_MASK 0x7F
49
50/* MAX8973_CONTROL1 */
51#define MAX8973_SNS_ENABLE BIT(7)
52#define MAX8973_FPWM_EN_M BIT(6)
53#define MAX8973_NFSR_ENABLE BIT(5)
54#define MAX8973_AD_ENABLE BIT(4)
55#define MAX8973_BIAS_ENABLE BIT(3)
56#define MAX8973_FREQSHIFT_9PER BIT(2)
57
58#define MAX8973_RAMP_12mV_PER_US 0x0
59#define MAX8973_RAMP_25mV_PER_US 0x1
60#define MAX8973_RAMP_50mV_PER_US 0x2
61#define MAX8973_RAMP_200mV_PER_US 0x3
62#define MAX8973_RAMP_MASK 0x3
63
64/* MAX8973_CONTROL2 */
65#define MAX8973_WDTMR_ENABLE BIT(6)
66#define MAX8973_DISCH_ENBABLE BIT(5)
67#define MAX8973_FT_ENABLE BIT(4)
68#define MAX77621_T_JUNCTION_120 BIT(7)
69
70#define MAX8973_CKKADV_TRIP_MASK 0xC
71#define MAX8973_CKKADV_TRIP_DISABLE 0xC
72#define MAX8973_CKKADV_TRIP_75mV_PER_US 0x0
73#define MAX8973_CKKADV_TRIP_150mV_PER_US 0x4
74#define MAX8973_CKKADV_TRIP_75mV_PER_US_HIST_DIS 0x8
75#define MAX8973_CONTROL_CLKADV_TRIP_MASK 0x00030000
76
77#define MAX8973_INDUCTOR_MIN_30_PER 0x0
78#define MAX8973_INDUCTOR_NOMINAL 0x1
79#define MAX8973_INDUCTOR_PLUS_30_PER 0x2
80#define MAX8973_INDUCTOR_PLUS_60_PER 0x3
81#define MAX8973_CONTROL_INDUCTOR_VALUE_MASK 0x00300000
82
83#define MAX8973_MIN_VOLATGE 606250
84#define MAX8973_MAX_VOLATGE 1400000
85#define MAX8973_VOLATGE_STEP 6250
86#define MAX8973_BUCK_N_VOLTAGE 0x80
87
88#define MAX77621_CHIPID_TJINT_S BIT(0)
89
90#define MAX77621_NORMAL_OPERATING_TEMP 100000
91#define MAX77621_TJINT_WARNING_TEMP_120 120000
92#define MAX77621_TJINT_WARNING_TEMP_140 140000
93
94enum device_id {
95 MAX8973,
96 MAX77621
97};
98
99/* Maxim 8973 chip information */
100struct max8973_chip {
101 struct device *dev;
102 struct regulator_desc desc;
103 struct regmap *regmap;
104 bool enable_external_control;
105 int dvs_gpio;
106 int lru_index[MAX8973_MAX_VOUT_REG];
107 int curr_vout_val[MAX8973_MAX_VOUT_REG];
108 int curr_vout_reg;
109 int curr_gpio_val;
110 struct regulator_ops ops;
111 enum device_id id;
112 int junction_temp_warning;
113 int irq;
114 struct thermal_zone_device *tz_device;
115};
116
117/*
118 * find_voltage_set_register: Find new voltage configuration register (VOUT).
119 * The finding of the new VOUT register will be based on the LRU mechanism.
120 * Each VOUT register will have different voltage configured . This
121 * Function will look if any of the VOUT register have requested voltage set
122 * or not.
123 * - If it is already there then it will make that register as most
124 * recently used and return as found so that caller need not to set
125 * the VOUT register but need to set the proper gpios to select this
126 * VOUT register.
127 * - If requested voltage is not found then it will use the least
128 * recently mechanism to get new VOUT register for new configuration
129 * and will return not_found so that caller need to set new VOUT
130 * register and then gpios (both).
131 */
132static bool find_voltage_set_register(struct max8973_chip *tps,
133 int req_vsel, int *vout_reg, int *gpio_val)
134{
135 int i;
136 bool found = false;
137 int new_vout_reg = tps->lru_index[MAX8973_MAX_VOUT_REG - 1];
138 int found_index = MAX8973_MAX_VOUT_REG - 1;
139
140 for (i = 0; i < MAX8973_MAX_VOUT_REG; ++i) {
141 if (tps->curr_vout_val[tps->lru_index[i]] == req_vsel) {
142 new_vout_reg = tps->lru_index[i];
143 found_index = i;
144 found = true;
145 goto update_lru_index;
146 }
147 }
148
149update_lru_index:
150 for (i = found_index; i > 0; i--)
151 tps->lru_index[i] = tps->lru_index[i - 1];
152
153 tps->lru_index[0] = new_vout_reg;
154 *gpio_val = new_vout_reg;
155 *vout_reg = MAX8973_VOUT + new_vout_reg;
156 return found;
157}
158
159static int max8973_dcdc_get_voltage_sel(struct regulator_dev *rdev)
160{
161 struct max8973_chip *max = rdev_get_drvdata(rdev);
162 unsigned int data;
163 int ret;
164
165 ret = regmap_read(max->regmap, max->curr_vout_reg, &data);
166 if (ret < 0) {
167 dev_err(max->dev, "register %d read failed, err = %d\n",
168 max->curr_vout_reg, ret);
169 return ret;
170 }
171 return data & MAX8973_VOUT_MASK;
172}
173
174static int max8973_dcdc_set_voltage_sel(struct regulator_dev *rdev,
175 unsigned vsel)
176{
177 struct max8973_chip *max = rdev_get_drvdata(rdev);
178 int ret;
179 bool found = false;
180 int vout_reg = max->curr_vout_reg;
181 int gpio_val = max->curr_gpio_val;
182
183 /*
184 * If gpios are available to select the VOUT register then least
185 * recently used register for new configuration.
186 */
187 if (gpio_is_valid(max->dvs_gpio))
188 found = find_voltage_set_register(max, vsel,
189 &vout_reg, &gpio_val);
190
191 if (!found) {
192 ret = regmap_update_bits(max->regmap, vout_reg,
193 MAX8973_VOUT_MASK, vsel);
194 if (ret < 0) {
195 dev_err(max->dev, "register %d update failed, err %d\n",
196 vout_reg, ret);
197 return ret;
198 }
199 max->curr_vout_reg = vout_reg;
200 max->curr_vout_val[gpio_val] = vsel;
201 }
202
203 /* Select proper VOUT register vio gpios */
204 if (gpio_is_valid(max->dvs_gpio)) {
205 gpio_set_value_cansleep(max->dvs_gpio, gpio_val & 0x1);
206 max->curr_gpio_val = gpio_val;
207 }
208 return 0;
209}
210
211static int max8973_dcdc_set_mode(struct regulator_dev *rdev, unsigned int mode)
212{
213 struct max8973_chip *max = rdev_get_drvdata(rdev);
214 int ret;
215 int pwm;
216
217 /* Enable force PWM mode in FAST mode only. */
218 switch (mode) {
219 case REGULATOR_MODE_FAST:
220 pwm = MAX8973_FPWM_EN_M;
221 break;
222
223 case REGULATOR_MODE_NORMAL:
224 pwm = 0;
225 break;
226
227 default:
228 return -EINVAL;
229 }
230
231 ret = regmap_update_bits(max->regmap, MAX8973_CONTROL1,
232 MAX8973_FPWM_EN_M, pwm);
233 if (ret < 0)
234 dev_err(max->dev, "register %d update failed, err %d\n",
235 MAX8973_CONTROL1, ret);
236 return ret;
237}
238
239static unsigned int max8973_dcdc_get_mode(struct regulator_dev *rdev)
240{
241 struct max8973_chip *max = rdev_get_drvdata(rdev);
242 unsigned int data;
243 int ret;
244
245 ret = regmap_read(max->regmap, MAX8973_CONTROL1, &data);
246 if (ret < 0) {
247 dev_err(max->dev, "register %d read failed, err %d\n",
248 MAX8973_CONTROL1, ret);
249 return ret;
250 }
251 return (data & MAX8973_FPWM_EN_M) ?
252 REGULATOR_MODE_FAST : REGULATOR_MODE_NORMAL;
253}
254
255static int max8973_set_current_limit(struct regulator_dev *rdev,
256 int min_ua, int max_ua)
257{
258 struct max8973_chip *max = rdev_get_drvdata(rdev);
259 unsigned int val;
260 int ret;
261
262 if (max_ua <= 9000000)
263 val = MAX8973_CKKADV_TRIP_75mV_PER_US;
264 else if (max_ua <= 12000000)
265 val = MAX8973_CKKADV_TRIP_150mV_PER_US;
266 else
267 val = MAX8973_CKKADV_TRIP_DISABLE;
268
269 ret = regmap_update_bits(max->regmap, MAX8973_CONTROL2,
270 MAX8973_CKKADV_TRIP_MASK, val);
271 if (ret < 0) {
272 dev_err(max->dev, "register %d update failed: %d\n",
273 MAX8973_CONTROL2, ret);
274 return ret;
275 }
276 return 0;
277}
278
279static int max8973_get_current_limit(struct regulator_dev *rdev)
280{
281 struct max8973_chip *max = rdev_get_drvdata(rdev);
282 unsigned int control2;
283 int ret;
284
285 ret = regmap_read(max->regmap, MAX8973_CONTROL2, &control2);
286 if (ret < 0) {
287 dev_err(max->dev, "register %d read failed: %d\n",
288 MAX8973_CONTROL2, ret);
289 return ret;
290 }
291 switch (control2 & MAX8973_CKKADV_TRIP_MASK) {
292 case MAX8973_CKKADV_TRIP_DISABLE:
293 return 15000000;
294 case MAX8973_CKKADV_TRIP_150mV_PER_US:
295 return 12000000;
296 case MAX8973_CKKADV_TRIP_75mV_PER_US:
297 return 9000000;
298 default:
299 break;
300 }
301 return 9000000;
302}
303
304static const unsigned int max8973_buck_ramp_table[] = {
305 12000, 25000, 50000, 200000
306};
307
308static const struct regulator_ops max8973_dcdc_ops = {
309 .get_voltage_sel = max8973_dcdc_get_voltage_sel,
310 .set_voltage_sel = max8973_dcdc_set_voltage_sel,
311 .list_voltage = regulator_list_voltage_linear,
312 .set_mode = max8973_dcdc_set_mode,
313 .get_mode = max8973_dcdc_get_mode,
314 .set_voltage_time_sel = regulator_set_voltage_time_sel,
315 .set_ramp_delay = regulator_set_ramp_delay_regmap,
316};
317
318static int max8973_init_dcdc(struct max8973_chip *max,
319 struct max8973_regulator_platform_data *pdata)
320{
321 int ret;
322 uint8_t control1 = 0;
323 uint8_t control2 = 0;
324 unsigned int data;
325
326 ret = regmap_read(max->regmap, MAX8973_CONTROL1, &data);
327 if (ret < 0) {
328 dev_err(max->dev, "register %d read failed, err = %d",
329 MAX8973_CONTROL1, ret);
330 return ret;
331 }
332 control1 = data & MAX8973_RAMP_MASK;
333 switch (control1) {
334 case MAX8973_RAMP_12mV_PER_US:
335 max->desc.ramp_delay = 12000;
336 break;
337 case MAX8973_RAMP_25mV_PER_US:
338 max->desc.ramp_delay = 25000;
339 break;
340 case MAX8973_RAMP_50mV_PER_US:
341 max->desc.ramp_delay = 50000;
342 break;
343 case MAX8973_RAMP_200mV_PER_US:
344 max->desc.ramp_delay = 200000;
345 break;
346 }
347
348 if (pdata->control_flags & MAX8973_CONTROL_REMOTE_SENSE_ENABLE)
349 control1 |= MAX8973_SNS_ENABLE;
350
351 if (!(pdata->control_flags & MAX8973_CONTROL_FALLING_SLEW_RATE_ENABLE))
352 control1 |= MAX8973_NFSR_ENABLE;
353
354 if (pdata->control_flags & MAX8973_CONTROL_OUTPUT_ACTIVE_DISCH_ENABLE)
355 control1 |= MAX8973_AD_ENABLE;
356
357 if (pdata->control_flags & MAX8973_CONTROL_BIAS_ENABLE) {
358 control1 |= MAX8973_BIAS_ENABLE;
359 max->desc.enable_time = 20;
360 } else {
361 max->desc.enable_time = 240;
362 }
363
364 if (pdata->control_flags & MAX8973_CONTROL_FREQ_SHIFT_9PER_ENABLE)
365 control1 |= MAX8973_FREQSHIFT_9PER;
366
367 if ((pdata->junction_temp_warning == MAX77621_TJINT_WARNING_TEMP_120) &&
368 (max->id == MAX77621))
369 control2 |= MAX77621_T_JUNCTION_120;
370
371 if (!(pdata->control_flags & MAX8973_CONTROL_PULL_DOWN_ENABLE))
372 control2 |= MAX8973_DISCH_ENBABLE;
373
374 /* Clock advance trip configuration */
375 switch (pdata->control_flags & MAX8973_CONTROL_CLKADV_TRIP_MASK) {
376 case MAX8973_CONTROL_CLKADV_TRIP_DISABLED:
377 control2 |= MAX8973_CKKADV_TRIP_DISABLE;
378 break;
379
380 case MAX8973_CONTROL_CLKADV_TRIP_75mV_PER_US:
381 control2 |= MAX8973_CKKADV_TRIP_75mV_PER_US;
382 break;
383
384 case MAX8973_CONTROL_CLKADV_TRIP_150mV_PER_US:
385 control2 |= MAX8973_CKKADV_TRIP_150mV_PER_US;
386 break;
387
388 case MAX8973_CONTROL_CLKADV_TRIP_75mV_PER_US_HIST_DIS:
389 control2 |= MAX8973_CKKADV_TRIP_75mV_PER_US_HIST_DIS;
390 break;
391 }
392
393 /* Configure inductor value */
394 switch (pdata->control_flags & MAX8973_CONTROL_INDUCTOR_VALUE_MASK) {
395 case MAX8973_CONTROL_INDUCTOR_VALUE_NOMINAL:
396 control2 |= MAX8973_INDUCTOR_NOMINAL;
397 break;
398
399 case MAX8973_CONTROL_INDUCTOR_VALUE_MINUS_30_PER:
400 control2 |= MAX8973_INDUCTOR_MIN_30_PER;
401 break;
402
403 case MAX8973_CONTROL_INDUCTOR_VALUE_PLUS_30_PER:
404 control2 |= MAX8973_INDUCTOR_PLUS_30_PER;
405 break;
406
407 case MAX8973_CONTROL_INDUCTOR_VALUE_PLUS_60_PER:
408 control2 |= MAX8973_INDUCTOR_PLUS_60_PER;
409 break;
410 }
411
412 ret = regmap_write(max->regmap, MAX8973_CONTROL1, control1);
413 if (ret < 0) {
414 dev_err(max->dev, "register %d write failed, err = %d",
415 MAX8973_CONTROL1, ret);
416 return ret;
417 }
418
419 ret = regmap_write(max->regmap, MAX8973_CONTROL2, control2);
420 if (ret < 0) {
421 dev_err(max->dev, "register %d write failed, err = %d",
422 MAX8973_CONTROL2, ret);
423 return ret;
424 }
425
426 /* If external control is enabled then disable EN bit */
427 if (max->enable_external_control && (max->id == MAX8973)) {
428 ret = regmap_update_bits(max->regmap, MAX8973_VOUT,
429 MAX8973_VOUT_ENABLE, 0);
430 if (ret < 0)
431 dev_err(max->dev, "register %d update failed, err = %d",
432 MAX8973_VOUT, ret);
433 }
434 return ret;
435}
436
437static int max8973_thermal_read_temp(struct thermal_zone_device *tz, int *temp)
438{
439 struct max8973_chip *mchip = tz->devdata;
440 unsigned int val;
441 int ret;
442
443 ret = regmap_read(mchip->regmap, MAX8973_CHIPID1, &val);
444 if (ret < 0) {
445 dev_err(mchip->dev, "Failed to read register CHIPID1, %d", ret);
446 return ret;
447 }
448
449 /* +1 degC to trigger cool device */
450 if (val & MAX77621_CHIPID_TJINT_S)
451 *temp = mchip->junction_temp_warning + 1000;
452 else
453 *temp = MAX77621_NORMAL_OPERATING_TEMP;
454
455 return 0;
456}
457
458static irqreturn_t max8973_thermal_irq(int irq, void *data)
459{
460 struct max8973_chip *mchip = data;
461
462 thermal_zone_device_update(mchip->tz_device,
463 THERMAL_EVENT_UNSPECIFIED);
464
465 return IRQ_HANDLED;
466}
467
468static const struct thermal_zone_device_ops max77621_tz_ops = {
469 .get_temp = max8973_thermal_read_temp,
470};
471
472static int max8973_thermal_init(struct max8973_chip *mchip)
473{
474 struct thermal_zone_device *tzd;
475 struct irq_data *irq_data;
476 unsigned long irq_flags = 0;
477 int ret;
478
479 if (mchip->id != MAX77621)
480 return 0;
481
482 tzd = devm_thermal_of_zone_register(mchip->dev, 0, mchip,
483 &max77621_tz_ops);
484 if (IS_ERR(tzd)) {
485 ret = PTR_ERR(tzd);
486 dev_err(mchip->dev, "Failed to register thermal sensor: %d\n",
487 ret);
488 return ret;
489 }
490
491 if (mchip->irq <= 0)
492 return 0;
493
494 irq_data = irq_get_irq_data(mchip->irq);
495 if (irq_data)
496 irq_flags = irqd_get_trigger_type(irq_data);
497
498 ret = devm_request_threaded_irq(mchip->dev, mchip->irq, NULL,
499 max8973_thermal_irq,
500 IRQF_ONESHOT | IRQF_SHARED | irq_flags,
501 dev_name(mchip->dev), mchip);
502 if (ret < 0) {
503 dev_err(mchip->dev, "Failed to request irq %d, %d\n",
504 mchip->irq, ret);
505 return ret;
506 }
507
508 return 0;
509}
510
511static const struct regmap_config max8973_regmap_config = {
512 .reg_bits = 8,
513 .val_bits = 8,
514 .max_register = MAX8973_CHIPID2,
515 .cache_type = REGCACHE_RBTREE,
516};
517
518static struct max8973_regulator_platform_data *max8973_parse_dt(
519 struct device *dev)
520{
521 struct max8973_regulator_platform_data *pdata;
522 struct device_node *np = dev->of_node;
523 int ret;
524 u32 pval;
525 bool etr_enable;
526 bool etr_sensitivity_high;
527
528 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
529 if (!pdata)
530 return NULL;
531
532 pdata->enable_ext_control = of_property_read_bool(np,
533 "maxim,externally-enable");
534 pdata->dvs_gpio = of_get_named_gpio(np, "maxim,dvs-gpio", 0);
535
536 ret = of_property_read_u32(np, "maxim,dvs-default-state", &pval);
537 if (!ret)
538 pdata->dvs_def_state = pval;
539
540 if (of_property_read_bool(np, "maxim,enable-remote-sense"))
541 pdata->control_flags |= MAX8973_CONTROL_REMOTE_SENSE_ENABLE;
542
543 if (of_property_read_bool(np, "maxim,enable-falling-slew-rate"))
544 pdata->control_flags |=
545 MAX8973_CONTROL_FALLING_SLEW_RATE_ENABLE;
546
547 if (of_property_read_bool(np, "maxim,enable-active-discharge"))
548 pdata->control_flags |=
549 MAX8973_CONTROL_OUTPUT_ACTIVE_DISCH_ENABLE;
550
551 if (of_property_read_bool(np, "maxim,enable-frequency-shift"))
552 pdata->control_flags |= MAX8973_CONTROL_FREQ_SHIFT_9PER_ENABLE;
553
554 if (of_property_read_bool(np, "maxim,enable-bias-control"))
555 pdata->control_flags |= MAX8973_CONTROL_BIAS_ENABLE;
556
557 etr_enable = of_property_read_bool(np, "maxim,enable-etr");
558 etr_sensitivity_high = of_property_read_bool(np,
559 "maxim,enable-high-etr-sensitivity");
560 if (etr_sensitivity_high)
561 etr_enable = true;
562
563 if (etr_enable) {
564 if (etr_sensitivity_high)
565 pdata->control_flags |=
566 MAX8973_CONTROL_CLKADV_TRIP_75mV_PER_US;
567 else
568 pdata->control_flags |=
569 MAX8973_CONTROL_CLKADV_TRIP_150mV_PER_US;
570 } else {
571 pdata->control_flags |= MAX8973_CONTROL_CLKADV_TRIP_DISABLED;
572 }
573
574 pdata->junction_temp_warning = MAX77621_TJINT_WARNING_TEMP_140;
575 ret = of_property_read_u32(np, "junction-warn-millicelsius", &pval);
576 if (!ret && (pval <= MAX77621_TJINT_WARNING_TEMP_120))
577 pdata->junction_temp_warning = MAX77621_TJINT_WARNING_TEMP_120;
578
579 return pdata;
580}
581
582static const struct of_device_id of_max8973_match_tbl[] = {
583 { .compatible = "maxim,max8973", .data = (void *)MAX8973, },
584 { .compatible = "maxim,max77621", .data = (void *)MAX77621, },
585 { },
586};
587MODULE_DEVICE_TABLE(of, of_max8973_match_tbl);
588
589static int max8973_probe(struct i2c_client *client)
590{
591 const struct i2c_device_id *id = i2c_client_get_device_id(client);
592 struct max8973_regulator_platform_data *pdata;
593 struct regulator_init_data *ridata;
594 struct regulator_config config = { };
595 struct regulator_dev *rdev;
596 struct max8973_chip *max;
597 bool pdata_from_dt = false;
598 unsigned int chip_id;
599 struct gpio_desc *gpiod;
600 enum gpiod_flags gflags;
601 int ret;
602
603 pdata = dev_get_platdata(&client->dev);
604
605 if (!pdata && client->dev.of_node) {
606 pdata = max8973_parse_dt(&client->dev);
607 pdata_from_dt = true;
608 }
609
610 if (!pdata) {
611 dev_err(&client->dev, "No Platform data");
612 return -EIO;
613 }
614
615 if (pdata->dvs_gpio == -EPROBE_DEFER)
616 return -EPROBE_DEFER;
617
618 max = devm_kzalloc(&client->dev, sizeof(*max), GFP_KERNEL);
619 if (!max)
620 return -ENOMEM;
621
622 max->regmap = devm_regmap_init_i2c(client, &max8973_regmap_config);
623 if (IS_ERR(max->regmap)) {
624 ret = PTR_ERR(max->regmap);
625 dev_err(&client->dev, "regmap init failed, err %d\n", ret);
626 return ret;
627 }
628
629 if (client->dev.of_node) {
630 const struct of_device_id *match;
631
632 match = of_match_device(of_match_ptr(of_max8973_match_tbl),
633 &client->dev);
634 if (!match)
635 return -ENODATA;
636 max->id = (u32)((uintptr_t)match->data);
637 } else {
638 max->id = id->driver_data;
639 }
640
641 ret = regmap_read(max->regmap, MAX8973_CHIPID1, &chip_id);
642 if (ret < 0) {
643 dev_err(&client->dev, "register CHIPID1 read failed, %d", ret);
644 return ret;
645 }
646
647 dev_info(&client->dev, "CHIP-ID OTP: 0x%02x ID_M: 0x%02x\n",
648 (chip_id >> 4) & 0xF, (chip_id >> 1) & 0x7);
649
650 i2c_set_clientdata(client, max);
651 max->ops = max8973_dcdc_ops;
652 max->dev = &client->dev;
653 max->desc.name = id->name;
654 max->desc.id = 0;
655 max->desc.ops = &max->ops;
656 max->desc.type = REGULATOR_VOLTAGE;
657 max->desc.owner = THIS_MODULE;
658 max->desc.min_uV = MAX8973_MIN_VOLATGE;
659 max->desc.uV_step = MAX8973_VOLATGE_STEP;
660 max->desc.n_voltages = MAX8973_BUCK_N_VOLTAGE;
661 max->desc.ramp_reg = MAX8973_CONTROL1;
662 max->desc.ramp_mask = MAX8973_RAMP_MASK;
663 max->desc.ramp_delay_table = max8973_buck_ramp_table;
664 max->desc.n_ramp_values = ARRAY_SIZE(max8973_buck_ramp_table);
665
666 max->dvs_gpio = (pdata->dvs_gpio) ? pdata->dvs_gpio : -EINVAL;
667 max->enable_external_control = pdata->enable_ext_control;
668 max->curr_gpio_val = pdata->dvs_def_state;
669 max->curr_vout_reg = MAX8973_VOUT + pdata->dvs_def_state;
670 max->junction_temp_warning = pdata->junction_temp_warning;
671
672 max->lru_index[0] = max->curr_vout_reg;
673
674 if (gpio_is_valid(max->dvs_gpio)) {
675 int gpio_flags;
676 int i;
677
678 gpio_flags = (pdata->dvs_def_state) ?
679 GPIOF_OUT_INIT_HIGH : GPIOF_OUT_INIT_LOW;
680 ret = devm_gpio_request_one(&client->dev, max->dvs_gpio,
681 gpio_flags, "max8973-dvs");
682 if (ret) {
683 dev_err(&client->dev,
684 "gpio_request for gpio %d failed, err = %d\n",
685 max->dvs_gpio, ret);
686 return ret;
687 }
688
689 /*
690 * Initialize the lru index with vout_reg id
691 * The index 0 will be most recently used and
692 * set with the max->curr_vout_reg */
693 for (i = 0; i < MAX8973_MAX_VOUT_REG; ++i)
694 max->lru_index[i] = i;
695 max->lru_index[0] = max->curr_vout_reg;
696 max->lru_index[max->curr_vout_reg] = 0;
697 } else {
698 /*
699 * If there is no DVS GPIO, the VOUT register
700 * address is fixed.
701 */
702 max->ops.set_voltage_sel = regulator_set_voltage_sel_regmap;
703 max->ops.get_voltage_sel = regulator_get_voltage_sel_regmap;
704 max->desc.vsel_reg = max->curr_vout_reg;
705 max->desc.vsel_mask = MAX8973_VOUT_MASK;
706 }
707
708 if (pdata_from_dt)
709 pdata->reg_init_data = of_get_regulator_init_data(&client->dev,
710 client->dev.of_node, &max->desc);
711
712 ridata = pdata->reg_init_data;
713 switch (max->id) {
714 case MAX8973:
715 if (!pdata->enable_ext_control) {
716 max->desc.enable_reg = MAX8973_VOUT;
717 max->desc.enable_mask = MAX8973_VOUT_ENABLE;
718 max->ops.enable = regulator_enable_regmap;
719 max->ops.disable = regulator_disable_regmap;
720 max->ops.is_enabled = regulator_is_enabled_regmap;
721 break;
722 }
723
724 if (ridata && (ridata->constraints.always_on ||
725 ridata->constraints.boot_on))
726 gflags = GPIOD_OUT_HIGH;
727 else
728 gflags = GPIOD_OUT_LOW;
729 gflags |= GPIOD_FLAGS_BIT_NONEXCLUSIVE;
730 gpiod = devm_gpiod_get_optional(&client->dev,
731 "maxim,enable",
732 gflags);
733 if (IS_ERR(gpiod))
734 return PTR_ERR(gpiod);
735 if (gpiod) {
736 config.ena_gpiod = gpiod;
737 max->enable_external_control = true;
738 }
739
740 break;
741
742 case MAX77621:
743 /*
744 * We do not let the core switch this regulator on/off,
745 * we just leave it on.
746 */
747 gpiod = devm_gpiod_get_optional(&client->dev,
748 "maxim,enable",
749 GPIOD_OUT_HIGH);
750 if (IS_ERR(gpiod))
751 return PTR_ERR(gpiod);
752 if (gpiod)
753 max->enable_external_control = true;
754
755 max->desc.enable_reg = MAX8973_VOUT;
756 max->desc.enable_mask = MAX8973_VOUT_ENABLE;
757 max->ops.enable = regulator_enable_regmap;
758 max->ops.disable = regulator_disable_regmap;
759 max->ops.is_enabled = regulator_is_enabled_regmap;
760 max->ops.set_current_limit = max8973_set_current_limit;
761 max->ops.get_current_limit = max8973_get_current_limit;
762 break;
763 default:
764 break;
765 }
766
767 ret = max8973_init_dcdc(max, pdata);
768 if (ret < 0) {
769 dev_err(max->dev, "Max8973 Init failed, err = %d\n", ret);
770 return ret;
771 }
772
773 config.dev = &client->dev;
774 config.init_data = pdata->reg_init_data;
775 config.driver_data = max;
776 config.of_node = client->dev.of_node;
777 config.regmap = max->regmap;
778
779 /*
780 * Register the regulators
781 * Turn the GPIO descriptor over to the regulator core for
782 * lifecycle management if we pass an ena_gpiod.
783 */
784 if (config.ena_gpiod)
785 devm_gpiod_unhinge(&client->dev, config.ena_gpiod);
786 rdev = devm_regulator_register(&client->dev, &max->desc, &config);
787 if (IS_ERR(rdev)) {
788 ret = PTR_ERR(rdev);
789 dev_err(max->dev, "regulator register failed, err %d\n", ret);
790 return ret;
791 }
792
793 max8973_thermal_init(max);
794 return 0;
795}
796
797static const struct i2c_device_id max8973_id[] = {
798 {.name = "max8973", .driver_data = MAX8973},
799 {.name = "max77621", .driver_data = MAX77621},
800 {},
801};
802MODULE_DEVICE_TABLE(i2c, max8973_id);
803
804static struct i2c_driver max8973_i2c_driver = {
805 .driver = {
806 .name = "max8973",
807 .of_match_table = of_max8973_match_tbl,
808 },
809 .probe_new = max8973_probe,
810 .id_table = max8973_id,
811};
812
813static int __init max8973_init(void)
814{
815 return i2c_add_driver(&max8973_i2c_driver);
816}
817subsys_initcall(max8973_init);
818
819static void __exit max8973_cleanup(void)
820{
821 i2c_del_driver(&max8973_i2c_driver);
822}
823module_exit(max8973_cleanup);
824
825MODULE_AUTHOR("Laxman Dewangan <ldewangan@nvidia.com>");
826MODULE_DESCRIPTION("MAX8973 voltage regulator driver");
827MODULE_LICENSE("GPL v2");
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * max8973-regulator.c -- Maxim max8973A
4 *
5 * Regulator driver for MAXIM 8973A DC-DC step-down switching regulator.
6 *
7 * Copyright (c) 2012, NVIDIA Corporation.
8 *
9 * Author: Laxman Dewangan <ldewangan@nvidia.com>
10 */
11
12#include <linux/kernel.h>
13#include <linux/module.h>
14#include <linux/init.h>
15#include <linux/err.h>
16#include <linux/of.h>
17#include <linux/of_device.h>
18#include <linux/platform_device.h>
19#include <linux/regulator/driver.h>
20#include <linux/regulator/machine.h>
21#include <linux/regulator/max8973-regulator.h>
22#include <linux/regulator/of_regulator.h>
23#include <linux/gpio/consumer.h>
24#include <linux/i2c.h>
25#include <linux/slab.h>
26#include <linux/regmap.h>
27#include <linux/thermal.h>
28#include <linux/irq.h>
29#include <linux/interrupt.h>
30
31/* Register definitions */
32#define MAX8973_VOUT 0x0
33#define MAX8973_VOUT_DVS 0x1
34#define MAX8973_CONTROL1 0x2
35#define MAX8973_CONTROL2 0x3
36#define MAX8973_CHIPID1 0x4
37#define MAX8973_CHIPID2 0x5
38
39#define MAX8973_MAX_VOUT_REG 2
40
41/* MAX8973_VOUT */
42#define MAX8973_VOUT_ENABLE BIT(7)
43#define MAX8973_VOUT_MASK 0x7F
44
45/* MAX8973_VOUT_DVS */
46#define MAX8973_DVS_VOUT_MASK 0x7F
47
48/* MAX8973_CONTROL1 */
49#define MAX8973_SNS_ENABLE BIT(7)
50#define MAX8973_FPWM_EN_M BIT(6)
51#define MAX8973_NFSR_ENABLE BIT(5)
52#define MAX8973_AD_ENABLE BIT(4)
53#define MAX8973_BIAS_ENABLE BIT(3)
54#define MAX8973_FREQSHIFT_9PER BIT(2)
55
56#define MAX8973_RAMP_12mV_PER_US 0x0
57#define MAX8973_RAMP_25mV_PER_US 0x1
58#define MAX8973_RAMP_50mV_PER_US 0x2
59#define MAX8973_RAMP_200mV_PER_US 0x3
60#define MAX8973_RAMP_MASK 0x3
61
62/* MAX8973_CONTROL2 */
63#define MAX8973_WDTMR_ENABLE BIT(6)
64#define MAX8973_DISCH_ENBABLE BIT(5)
65#define MAX8973_FT_ENABLE BIT(4)
66#define MAX77621_T_JUNCTION_120 BIT(7)
67
68#define MAX8973_CKKADV_TRIP_MASK 0xC
69#define MAX8973_CKKADV_TRIP_DISABLE 0xC
70#define MAX8973_CKKADV_TRIP_75mV_PER_US 0x0
71#define MAX8973_CKKADV_TRIP_150mV_PER_US 0x4
72#define MAX8973_CKKADV_TRIP_75mV_PER_US_HIST_DIS 0x8
73#define MAX8973_CONTROL_CLKADV_TRIP_MASK 0x00030000
74
75#define MAX8973_INDUCTOR_MIN_30_PER 0x0
76#define MAX8973_INDUCTOR_NOMINAL 0x1
77#define MAX8973_INDUCTOR_PLUS_30_PER 0x2
78#define MAX8973_INDUCTOR_PLUS_60_PER 0x3
79#define MAX8973_CONTROL_INDUCTOR_VALUE_MASK 0x00300000
80
81#define MAX8973_MIN_VOLATGE 606250
82#define MAX8973_MAX_VOLATGE 1400000
83#define MAX8973_VOLATGE_STEP 6250
84#define MAX8973_BUCK_N_VOLTAGE 0x80
85
86#define MAX77621_CHIPID_TJINT_S BIT(0)
87
88#define MAX77621_NORMAL_OPERATING_TEMP 100000
89#define MAX77621_TJINT_WARNING_TEMP_120 120000
90#define MAX77621_TJINT_WARNING_TEMP_140 140000
91
92enum device_id {
93 MAX8973,
94 MAX77621
95};
96
97/* Maxim 8973 chip information */
98struct max8973_chip {
99 struct device *dev;
100 struct regulator_desc desc;
101 struct regmap *regmap;
102 bool enable_external_control;
103 struct gpio_desc *dvs_gpiod;
104 int lru_index[MAX8973_MAX_VOUT_REG];
105 int curr_vout_val[MAX8973_MAX_VOUT_REG];
106 int curr_vout_reg;
107 int curr_gpio_val;
108 struct regulator_ops ops;
109 enum device_id id;
110 int junction_temp_warning;
111 int irq;
112 struct thermal_zone_device *tz_device;
113};
114
115/*
116 * find_voltage_set_register: Find new voltage configuration register (VOUT).
117 * The finding of the new VOUT register will be based on the LRU mechanism.
118 * Each VOUT register will have different voltage configured . This
119 * Function will look if any of the VOUT register have requested voltage set
120 * or not.
121 * - If it is already there then it will make that register as most
122 * recently used and return as found so that caller need not to set
123 * the VOUT register but need to set the proper gpios to select this
124 * VOUT register.
125 * - If requested voltage is not found then it will use the least
126 * recently mechanism to get new VOUT register for new configuration
127 * and will return not_found so that caller need to set new VOUT
128 * register and then gpios (both).
129 */
130static bool find_voltage_set_register(struct max8973_chip *tps,
131 int req_vsel, int *vout_reg, int *gpio_val)
132{
133 int i;
134 bool found = false;
135 int new_vout_reg = tps->lru_index[MAX8973_MAX_VOUT_REG - 1];
136 int found_index = MAX8973_MAX_VOUT_REG - 1;
137
138 for (i = 0; i < MAX8973_MAX_VOUT_REG; ++i) {
139 if (tps->curr_vout_val[tps->lru_index[i]] == req_vsel) {
140 new_vout_reg = tps->lru_index[i];
141 found_index = i;
142 found = true;
143 goto update_lru_index;
144 }
145 }
146
147update_lru_index:
148 for (i = found_index; i > 0; i--)
149 tps->lru_index[i] = tps->lru_index[i - 1];
150
151 tps->lru_index[0] = new_vout_reg;
152 *gpio_val = new_vout_reg;
153 *vout_reg = MAX8973_VOUT + new_vout_reg;
154 return found;
155}
156
157static int max8973_dcdc_get_voltage_sel(struct regulator_dev *rdev)
158{
159 struct max8973_chip *max = rdev_get_drvdata(rdev);
160 unsigned int data;
161 int ret;
162
163 ret = regmap_read(max->regmap, max->curr_vout_reg, &data);
164 if (ret < 0) {
165 dev_err(max->dev, "register %d read failed, err = %d\n",
166 max->curr_vout_reg, ret);
167 return ret;
168 }
169 return data & MAX8973_VOUT_MASK;
170}
171
172static int max8973_dcdc_set_voltage_sel(struct regulator_dev *rdev,
173 unsigned vsel)
174{
175 struct max8973_chip *max = rdev_get_drvdata(rdev);
176 int ret;
177 bool found = false;
178 int vout_reg = max->curr_vout_reg;
179 int gpio_val = max->curr_gpio_val;
180
181 /*
182 * If gpios are available to select the VOUT register then least
183 * recently used register for new configuration.
184 */
185 if (max->dvs_gpiod)
186 found = find_voltage_set_register(max, vsel,
187 &vout_reg, &gpio_val);
188
189 if (!found) {
190 ret = regmap_update_bits(max->regmap, vout_reg,
191 MAX8973_VOUT_MASK, vsel);
192 if (ret < 0) {
193 dev_err(max->dev, "register %d update failed, err %d\n",
194 vout_reg, ret);
195 return ret;
196 }
197 max->curr_vout_reg = vout_reg;
198 max->curr_vout_val[gpio_val] = vsel;
199 }
200
201 /* Select proper VOUT register vio gpios */
202 if (max->dvs_gpiod) {
203 gpiod_set_value_cansleep(max->dvs_gpiod, gpio_val & 0x1);
204 max->curr_gpio_val = gpio_val;
205 }
206 return 0;
207}
208
209static int max8973_dcdc_set_mode(struct regulator_dev *rdev, unsigned int mode)
210{
211 struct max8973_chip *max = rdev_get_drvdata(rdev);
212 int ret;
213 int pwm;
214
215 /* Enable force PWM mode in FAST mode only. */
216 switch (mode) {
217 case REGULATOR_MODE_FAST:
218 pwm = MAX8973_FPWM_EN_M;
219 break;
220
221 case REGULATOR_MODE_NORMAL:
222 pwm = 0;
223 break;
224
225 default:
226 return -EINVAL;
227 }
228
229 ret = regmap_update_bits(max->regmap, MAX8973_CONTROL1,
230 MAX8973_FPWM_EN_M, pwm);
231 if (ret < 0)
232 dev_err(max->dev, "register %d update failed, err %d\n",
233 MAX8973_CONTROL1, ret);
234 return ret;
235}
236
237static unsigned int max8973_dcdc_get_mode(struct regulator_dev *rdev)
238{
239 struct max8973_chip *max = rdev_get_drvdata(rdev);
240 unsigned int data;
241 int ret;
242
243 ret = regmap_read(max->regmap, MAX8973_CONTROL1, &data);
244 if (ret < 0) {
245 dev_err(max->dev, "register %d read failed, err %d\n",
246 MAX8973_CONTROL1, ret);
247 return ret;
248 }
249 return (data & MAX8973_FPWM_EN_M) ?
250 REGULATOR_MODE_FAST : REGULATOR_MODE_NORMAL;
251}
252
253static int max8973_set_current_limit(struct regulator_dev *rdev,
254 int min_ua, int max_ua)
255{
256 struct max8973_chip *max = rdev_get_drvdata(rdev);
257 unsigned int val;
258 int ret;
259
260 if (max_ua <= 9000000)
261 val = MAX8973_CKKADV_TRIP_75mV_PER_US;
262 else if (max_ua <= 12000000)
263 val = MAX8973_CKKADV_TRIP_150mV_PER_US;
264 else
265 val = MAX8973_CKKADV_TRIP_DISABLE;
266
267 ret = regmap_update_bits(max->regmap, MAX8973_CONTROL2,
268 MAX8973_CKKADV_TRIP_MASK, val);
269 if (ret < 0) {
270 dev_err(max->dev, "register %d update failed: %d\n",
271 MAX8973_CONTROL2, ret);
272 return ret;
273 }
274 return 0;
275}
276
277static int max8973_get_current_limit(struct regulator_dev *rdev)
278{
279 struct max8973_chip *max = rdev_get_drvdata(rdev);
280 unsigned int control2;
281 int ret;
282
283 ret = regmap_read(max->regmap, MAX8973_CONTROL2, &control2);
284 if (ret < 0) {
285 dev_err(max->dev, "register %d read failed: %d\n",
286 MAX8973_CONTROL2, ret);
287 return ret;
288 }
289 switch (control2 & MAX8973_CKKADV_TRIP_MASK) {
290 case MAX8973_CKKADV_TRIP_DISABLE:
291 return 15000000;
292 case MAX8973_CKKADV_TRIP_150mV_PER_US:
293 return 12000000;
294 case MAX8973_CKKADV_TRIP_75mV_PER_US:
295 return 9000000;
296 default:
297 break;
298 }
299 return 9000000;
300}
301
302static const unsigned int max8973_buck_ramp_table[] = {
303 12000, 25000, 50000, 200000
304};
305
306static const struct regulator_ops max8973_dcdc_ops = {
307 .get_voltage_sel = max8973_dcdc_get_voltage_sel,
308 .set_voltage_sel = max8973_dcdc_set_voltage_sel,
309 .list_voltage = regulator_list_voltage_linear,
310 .set_mode = max8973_dcdc_set_mode,
311 .get_mode = max8973_dcdc_get_mode,
312 .set_voltage_time_sel = regulator_set_voltage_time_sel,
313 .set_ramp_delay = regulator_set_ramp_delay_regmap,
314};
315
316static int max8973_init_dcdc(struct max8973_chip *max,
317 struct max8973_regulator_platform_data *pdata)
318{
319 int ret;
320 uint8_t control1 = 0;
321 uint8_t control2 = 0;
322 unsigned int data;
323
324 ret = regmap_read(max->regmap, MAX8973_CONTROL1, &data);
325 if (ret < 0) {
326 dev_err(max->dev, "register %d read failed, err = %d",
327 MAX8973_CONTROL1, ret);
328 return ret;
329 }
330 control1 = data & MAX8973_RAMP_MASK;
331 switch (control1) {
332 case MAX8973_RAMP_12mV_PER_US:
333 max->desc.ramp_delay = 12000;
334 break;
335 case MAX8973_RAMP_25mV_PER_US:
336 max->desc.ramp_delay = 25000;
337 break;
338 case MAX8973_RAMP_50mV_PER_US:
339 max->desc.ramp_delay = 50000;
340 break;
341 case MAX8973_RAMP_200mV_PER_US:
342 max->desc.ramp_delay = 200000;
343 break;
344 }
345
346 if (pdata->control_flags & MAX8973_CONTROL_REMOTE_SENSE_ENABLE)
347 control1 |= MAX8973_SNS_ENABLE;
348
349 if (!(pdata->control_flags & MAX8973_CONTROL_FALLING_SLEW_RATE_ENABLE))
350 control1 |= MAX8973_NFSR_ENABLE;
351
352 if (pdata->control_flags & MAX8973_CONTROL_OUTPUT_ACTIVE_DISCH_ENABLE)
353 control1 |= MAX8973_AD_ENABLE;
354
355 if (pdata->control_flags & MAX8973_CONTROL_BIAS_ENABLE) {
356 control1 |= MAX8973_BIAS_ENABLE;
357 max->desc.enable_time = 20;
358 } else {
359 max->desc.enable_time = 240;
360 }
361
362 if (pdata->control_flags & MAX8973_CONTROL_FREQ_SHIFT_9PER_ENABLE)
363 control1 |= MAX8973_FREQSHIFT_9PER;
364
365 if ((pdata->junction_temp_warning == MAX77621_TJINT_WARNING_TEMP_120) &&
366 (max->id == MAX77621))
367 control2 |= MAX77621_T_JUNCTION_120;
368
369 if (!(pdata->control_flags & MAX8973_CONTROL_PULL_DOWN_ENABLE))
370 control2 |= MAX8973_DISCH_ENBABLE;
371
372 /* Clock advance trip configuration */
373 switch (pdata->control_flags & MAX8973_CONTROL_CLKADV_TRIP_MASK) {
374 case MAX8973_CONTROL_CLKADV_TRIP_DISABLED:
375 control2 |= MAX8973_CKKADV_TRIP_DISABLE;
376 break;
377
378 case MAX8973_CONTROL_CLKADV_TRIP_75mV_PER_US:
379 control2 |= MAX8973_CKKADV_TRIP_75mV_PER_US;
380 break;
381
382 case MAX8973_CONTROL_CLKADV_TRIP_150mV_PER_US:
383 control2 |= MAX8973_CKKADV_TRIP_150mV_PER_US;
384 break;
385
386 case MAX8973_CONTROL_CLKADV_TRIP_75mV_PER_US_HIST_DIS:
387 control2 |= MAX8973_CKKADV_TRIP_75mV_PER_US_HIST_DIS;
388 break;
389 }
390
391 /* Configure inductor value */
392 switch (pdata->control_flags & MAX8973_CONTROL_INDUCTOR_VALUE_MASK) {
393 case MAX8973_CONTROL_INDUCTOR_VALUE_NOMINAL:
394 control2 |= MAX8973_INDUCTOR_NOMINAL;
395 break;
396
397 case MAX8973_CONTROL_INDUCTOR_VALUE_MINUS_30_PER:
398 control2 |= MAX8973_INDUCTOR_MIN_30_PER;
399 break;
400
401 case MAX8973_CONTROL_INDUCTOR_VALUE_PLUS_30_PER:
402 control2 |= MAX8973_INDUCTOR_PLUS_30_PER;
403 break;
404
405 case MAX8973_CONTROL_INDUCTOR_VALUE_PLUS_60_PER:
406 control2 |= MAX8973_INDUCTOR_PLUS_60_PER;
407 break;
408 }
409
410 ret = regmap_write(max->regmap, MAX8973_CONTROL1, control1);
411 if (ret < 0) {
412 dev_err(max->dev, "register %d write failed, err = %d",
413 MAX8973_CONTROL1, ret);
414 return ret;
415 }
416
417 ret = regmap_write(max->regmap, MAX8973_CONTROL2, control2);
418 if (ret < 0) {
419 dev_err(max->dev, "register %d write failed, err = %d",
420 MAX8973_CONTROL2, ret);
421 return ret;
422 }
423
424 /* If external control is enabled then disable EN bit */
425 if (max->enable_external_control && (max->id == MAX8973)) {
426 ret = regmap_update_bits(max->regmap, MAX8973_VOUT,
427 MAX8973_VOUT_ENABLE, 0);
428 if (ret < 0)
429 dev_err(max->dev, "register %d update failed, err = %d",
430 MAX8973_VOUT, ret);
431 }
432 return ret;
433}
434
435static int max8973_thermal_read_temp(struct thermal_zone_device *tz, int *temp)
436{
437 struct max8973_chip *mchip = thermal_zone_device_priv(tz);
438 unsigned int val;
439 int ret;
440
441 ret = regmap_read(mchip->regmap, MAX8973_CHIPID1, &val);
442 if (ret < 0) {
443 dev_err(mchip->dev, "Failed to read register CHIPID1, %d", ret);
444 return ret;
445 }
446
447 /* +1 degC to trigger cool device */
448 if (val & MAX77621_CHIPID_TJINT_S)
449 *temp = mchip->junction_temp_warning + 1000;
450 else
451 *temp = MAX77621_NORMAL_OPERATING_TEMP;
452
453 return 0;
454}
455
456static irqreturn_t max8973_thermal_irq(int irq, void *data)
457{
458 struct max8973_chip *mchip = data;
459
460 thermal_zone_device_update(mchip->tz_device,
461 THERMAL_EVENT_UNSPECIFIED);
462
463 return IRQ_HANDLED;
464}
465
466static const struct thermal_zone_device_ops max77621_tz_ops = {
467 .get_temp = max8973_thermal_read_temp,
468};
469
470static int max8973_thermal_init(struct max8973_chip *mchip)
471{
472 struct thermal_zone_device *tzd;
473 unsigned long irq_flags;
474 int ret;
475
476 if (mchip->id != MAX77621)
477 return 0;
478
479 tzd = devm_thermal_of_zone_register(mchip->dev, 0, mchip,
480 &max77621_tz_ops);
481 if (IS_ERR(tzd)) {
482 ret = PTR_ERR(tzd);
483 dev_err(mchip->dev, "Failed to register thermal sensor: %d\n",
484 ret);
485 return ret;
486 }
487
488 if (mchip->irq <= 0)
489 return 0;
490
491 irq_flags = irq_get_trigger_type(mchip->irq);
492
493 ret = devm_request_threaded_irq(mchip->dev, mchip->irq, NULL,
494 max8973_thermal_irq,
495 IRQF_ONESHOT | IRQF_SHARED | irq_flags,
496 dev_name(mchip->dev), mchip);
497 if (ret < 0) {
498 dev_err(mchip->dev, "Failed to request irq %d, %d\n",
499 mchip->irq, ret);
500 return ret;
501 }
502
503 return 0;
504}
505
506static const struct regmap_config max8973_regmap_config = {
507 .reg_bits = 8,
508 .val_bits = 8,
509 .max_register = MAX8973_CHIPID2,
510 .cache_type = REGCACHE_MAPLE,
511};
512
513static struct max8973_regulator_platform_data *max8973_parse_dt(
514 struct device *dev)
515{
516 struct max8973_regulator_platform_data *pdata;
517 struct device_node *np = dev->of_node;
518 int ret;
519 u32 pval;
520 bool etr_enable;
521 bool etr_sensitivity_high;
522
523 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
524 if (!pdata)
525 return NULL;
526
527 pdata->enable_ext_control = of_property_read_bool(np,
528 "maxim,externally-enable");
529
530 ret = of_property_read_u32(np, "maxim,dvs-default-state", &pval);
531 if (!ret)
532 pdata->dvs_def_state = pval;
533
534 if (of_property_read_bool(np, "maxim,enable-remote-sense"))
535 pdata->control_flags |= MAX8973_CONTROL_REMOTE_SENSE_ENABLE;
536
537 if (of_property_read_bool(np, "maxim,enable-falling-slew-rate"))
538 pdata->control_flags |=
539 MAX8973_CONTROL_FALLING_SLEW_RATE_ENABLE;
540
541 if (of_property_read_bool(np, "maxim,enable-active-discharge"))
542 pdata->control_flags |=
543 MAX8973_CONTROL_OUTPUT_ACTIVE_DISCH_ENABLE;
544
545 if (of_property_read_bool(np, "maxim,enable-frequency-shift"))
546 pdata->control_flags |= MAX8973_CONTROL_FREQ_SHIFT_9PER_ENABLE;
547
548 if (of_property_read_bool(np, "maxim,enable-bias-control"))
549 pdata->control_flags |= MAX8973_CONTROL_BIAS_ENABLE;
550
551 etr_enable = of_property_read_bool(np, "maxim,enable-etr");
552 etr_sensitivity_high = of_property_read_bool(np,
553 "maxim,enable-high-etr-sensitivity");
554 if (etr_sensitivity_high)
555 etr_enable = true;
556
557 if (etr_enable) {
558 if (etr_sensitivity_high)
559 pdata->control_flags |=
560 MAX8973_CONTROL_CLKADV_TRIP_75mV_PER_US;
561 else
562 pdata->control_flags |=
563 MAX8973_CONTROL_CLKADV_TRIP_150mV_PER_US;
564 } else {
565 pdata->control_flags |= MAX8973_CONTROL_CLKADV_TRIP_DISABLED;
566 }
567
568 pdata->junction_temp_warning = MAX77621_TJINT_WARNING_TEMP_140;
569 ret = of_property_read_u32(np, "junction-warn-millicelsius", &pval);
570 if (!ret && (pval <= MAX77621_TJINT_WARNING_TEMP_120))
571 pdata->junction_temp_warning = MAX77621_TJINT_WARNING_TEMP_120;
572
573 return pdata;
574}
575
576static const struct of_device_id of_max8973_match_tbl[] = {
577 { .compatible = "maxim,max8973", .data = (void *)MAX8973, },
578 { .compatible = "maxim,max77621", .data = (void *)MAX77621, },
579 { },
580};
581MODULE_DEVICE_TABLE(of, of_max8973_match_tbl);
582
583static int max8973_probe(struct i2c_client *client)
584{
585 const struct i2c_device_id *id = i2c_client_get_device_id(client);
586 struct max8973_regulator_platform_data *pdata;
587 struct regulator_init_data *ridata;
588 struct regulator_config config = { };
589 struct regulator_dev *rdev;
590 struct max8973_chip *max;
591 bool pdata_from_dt = false;
592 unsigned int chip_id;
593 struct gpio_desc *gpiod;
594 enum gpiod_flags gflags;
595 int ret;
596
597 pdata = dev_get_platdata(&client->dev);
598
599 if (!pdata && client->dev.of_node) {
600 pdata = max8973_parse_dt(&client->dev);
601 pdata_from_dt = true;
602 }
603
604 if (!pdata) {
605 dev_err(&client->dev, "No Platform data");
606 return -EIO;
607 }
608
609 max = devm_kzalloc(&client->dev, sizeof(*max), GFP_KERNEL);
610 if (!max)
611 return -ENOMEM;
612
613 max->dvs_gpiod = devm_gpiod_get_optional(&client->dev, "maxim,dvs",
614 (pdata->dvs_def_state) ? GPIOD_OUT_HIGH : GPIOD_OUT_LOW);
615 if (IS_ERR(max->dvs_gpiod))
616 return dev_err_probe(&client->dev, PTR_ERR(max->dvs_gpiod),
617 "failed to obtain dvs gpio\n");
618 gpiod_set_consumer_name(max->dvs_gpiod, "max8973-dvs");
619
620 max->regmap = devm_regmap_init_i2c(client, &max8973_regmap_config);
621 if (IS_ERR(max->regmap)) {
622 ret = PTR_ERR(max->regmap);
623 dev_err(&client->dev, "regmap init failed, err %d\n", ret);
624 return ret;
625 }
626
627 if (client->dev.of_node) {
628 const struct of_device_id *match;
629
630 match = of_match_device(of_match_ptr(of_max8973_match_tbl),
631 &client->dev);
632 if (!match)
633 return -ENODATA;
634 max->id = (u32)((uintptr_t)match->data);
635 } else {
636 max->id = id->driver_data;
637 }
638
639 ret = regmap_read(max->regmap, MAX8973_CHIPID1, &chip_id);
640 if (ret < 0) {
641 dev_err(&client->dev, "register CHIPID1 read failed, %d", ret);
642 return ret;
643 }
644
645 dev_info(&client->dev, "CHIP-ID OTP: 0x%02x ID_M: 0x%02x\n",
646 (chip_id >> 4) & 0xF, (chip_id >> 1) & 0x7);
647
648 i2c_set_clientdata(client, max);
649 max->ops = max8973_dcdc_ops;
650 max->dev = &client->dev;
651 max->desc.name = id->name;
652 max->desc.id = 0;
653 max->desc.ops = &max->ops;
654 max->desc.type = REGULATOR_VOLTAGE;
655 max->desc.owner = THIS_MODULE;
656 max->desc.min_uV = MAX8973_MIN_VOLATGE;
657 max->desc.uV_step = MAX8973_VOLATGE_STEP;
658 max->desc.n_voltages = MAX8973_BUCK_N_VOLTAGE;
659 max->desc.ramp_reg = MAX8973_CONTROL1;
660 max->desc.ramp_mask = MAX8973_RAMP_MASK;
661 max->desc.ramp_delay_table = max8973_buck_ramp_table;
662 max->desc.n_ramp_values = ARRAY_SIZE(max8973_buck_ramp_table);
663
664 max->enable_external_control = pdata->enable_ext_control;
665 max->curr_gpio_val = pdata->dvs_def_state;
666 max->curr_vout_reg = MAX8973_VOUT + pdata->dvs_def_state;
667 max->junction_temp_warning = pdata->junction_temp_warning;
668
669 max->lru_index[0] = max->curr_vout_reg;
670
671 if (max->dvs_gpiod) {
672 int i;
673
674 /*
675 * Initialize the lru index with vout_reg id
676 * The index 0 will be most recently used and
677 * set with the max->curr_vout_reg */
678 for (i = 0; i < MAX8973_MAX_VOUT_REG; ++i)
679 max->lru_index[i] = i;
680 max->lru_index[0] = max->curr_vout_reg;
681 max->lru_index[max->curr_vout_reg] = 0;
682 } else {
683 /*
684 * If there is no DVS GPIO, the VOUT register
685 * address is fixed.
686 */
687 max->ops.set_voltage_sel = regulator_set_voltage_sel_regmap;
688 max->ops.get_voltage_sel = regulator_get_voltage_sel_regmap;
689 max->desc.vsel_reg = max->curr_vout_reg;
690 max->desc.vsel_mask = MAX8973_VOUT_MASK;
691 }
692
693 if (pdata_from_dt)
694 pdata->reg_init_data = of_get_regulator_init_data(&client->dev,
695 client->dev.of_node, &max->desc);
696
697 ridata = pdata->reg_init_data;
698 switch (max->id) {
699 case MAX8973:
700 if (!pdata->enable_ext_control) {
701 max->desc.enable_reg = MAX8973_VOUT;
702 max->desc.enable_mask = MAX8973_VOUT_ENABLE;
703 max->ops.enable = regulator_enable_regmap;
704 max->ops.disable = regulator_disable_regmap;
705 max->ops.is_enabled = regulator_is_enabled_regmap;
706 break;
707 }
708
709 if (ridata && (ridata->constraints.always_on ||
710 ridata->constraints.boot_on))
711 gflags = GPIOD_OUT_HIGH;
712 else
713 gflags = GPIOD_OUT_LOW;
714 gflags |= GPIOD_FLAGS_BIT_NONEXCLUSIVE;
715 gpiod = devm_gpiod_get_optional(&client->dev,
716 "maxim,enable",
717 gflags);
718 if (IS_ERR(gpiod))
719 return PTR_ERR(gpiod);
720 if (gpiod) {
721 config.ena_gpiod = gpiod;
722 max->enable_external_control = true;
723 }
724
725 break;
726
727 case MAX77621:
728 /*
729 * We do not let the core switch this regulator on/off,
730 * we just leave it on.
731 */
732 gpiod = devm_gpiod_get_optional(&client->dev,
733 "maxim,enable",
734 GPIOD_OUT_HIGH);
735 if (IS_ERR(gpiod))
736 return PTR_ERR(gpiod);
737 if (gpiod)
738 max->enable_external_control = true;
739
740 max->desc.enable_reg = MAX8973_VOUT;
741 max->desc.enable_mask = MAX8973_VOUT_ENABLE;
742 max->ops.enable = regulator_enable_regmap;
743 max->ops.disable = regulator_disable_regmap;
744 max->ops.is_enabled = regulator_is_enabled_regmap;
745 max->ops.set_current_limit = max8973_set_current_limit;
746 max->ops.get_current_limit = max8973_get_current_limit;
747 break;
748 default:
749 break;
750 }
751
752 ret = max8973_init_dcdc(max, pdata);
753 if (ret < 0) {
754 dev_err(max->dev, "Max8973 Init failed, err = %d\n", ret);
755 return ret;
756 }
757
758 config.dev = &client->dev;
759 config.init_data = pdata->reg_init_data;
760 config.driver_data = max;
761 config.of_node = client->dev.of_node;
762 config.regmap = max->regmap;
763
764 /*
765 * Register the regulators
766 * Turn the GPIO descriptor over to the regulator core for
767 * lifecycle management if we pass an ena_gpiod.
768 */
769 if (config.ena_gpiod)
770 devm_gpiod_unhinge(&client->dev, config.ena_gpiod);
771 rdev = devm_regulator_register(&client->dev, &max->desc, &config);
772 if (IS_ERR(rdev)) {
773 ret = PTR_ERR(rdev);
774 dev_err(max->dev, "regulator register failed, err %d\n", ret);
775 return ret;
776 }
777
778 max8973_thermal_init(max);
779 return 0;
780}
781
782static const struct i2c_device_id max8973_id[] = {
783 {.name = "max8973", .driver_data = MAX8973},
784 {.name = "max77621", .driver_data = MAX77621},
785 {},
786};
787MODULE_DEVICE_TABLE(i2c, max8973_id);
788
789static struct i2c_driver max8973_i2c_driver = {
790 .driver = {
791 .name = "max8973",
792 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
793 .of_match_table = of_max8973_match_tbl,
794 },
795 .probe = max8973_probe,
796 .id_table = max8973_id,
797};
798
799static int __init max8973_init(void)
800{
801 return i2c_add_driver(&max8973_i2c_driver);
802}
803subsys_initcall(max8973_init);
804
805static void __exit max8973_cleanup(void)
806{
807 i2c_del_driver(&max8973_i2c_driver);
808}
809module_exit(max8973_cleanup);
810
811MODULE_AUTHOR("Laxman Dewangan <ldewangan@nvidia.com>");
812MODULE_DESCRIPTION("MAX8973 voltage regulator driver");
813MODULE_LICENSE("GPL v2");