xref: /rk3399_rockchip-uboot/drivers/power/pmic/rk8xx.c (revision 5d96bba97e39b7f095cf6cf4e3de9c2d4962f654)
1 /*
2  * Copyright (C) 2015 Google, Inc
3  * Written by Simon Glass <sjg@chromium.org>
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 #include <common.h>
9 #include <dm.h>
10 #include <errno.h>
11 #include <irq-generic.h>
12 #include <power/rk8xx_pmic.h>
13 #include <power/pmic.h>
14 
15 DECLARE_GLOBAL_DATA_PTR;
16 
17 #if defined(CONFIG_IRQ) && !defined(CONFIG_SPL_BUILD)
18 /* RK805 */
19 static const struct virq_reg rk805_irqs[] = {
20 	[RK8XX_IRQ_PWRON_FALL] = {
21 		.mask = RK805_IRQ_PWRON_FALL_MSK,
22 		.reg_offset = 0,
23 	},
24 	[RK8XX_IRQ_PWRON_RISE] = {
25 		.mask = RK805_IRQ_PWRON_RISE_MSK,
26 		.reg_offset = 0,
27 	},
28 };
29 
30 static struct virq_chip rk805_irq_chip = {
31 	.status_base		= RK805_INT_STS_REG,
32 	.mask_base		= RK805_INT_MSK_REG,
33 	.num_regs		= 1,
34 	.i2c_read		= pmic_reg_read,
35 	.i2c_write		= pmic_reg_write,
36 	.irqs			= rk805_irqs,
37 	.num_irqs		= ARRAY_SIZE(rk805_irqs),
38 };
39 
40 /* RK808 */
41 static const struct virq_reg rk808_irqs[] = {
42 	[RK8XX_IRQ_PLUG_OUT] = {
43 		.mask = RK808_IRQ_PLUG_OUT_MSK,
44 		.reg_offset = 1,
45 	},
46 };
47 
48 static struct virq_chip rk808_irq_chip = {
49 	.status_base		= RK808_INT_STS_REG1,
50 	.mask_base		= RK808_INT_MSK_REG1,
51 	.irq_reg_stride		= 2,
52 	.num_regs		= 2,
53 	.i2c_read		= pmic_reg_read,
54 	.i2c_write		= pmic_reg_write,
55 	.irqs			= rk808_irqs,
56 	.num_irqs		= ARRAY_SIZE(rk808_irqs),
57 };
58 
59 /* RK816 */
60 static const struct virq_reg rk816_irqs[] = {
61 	[RK8XX_IRQ_PWRON_FALL] = {
62 		.mask = RK816_IRQ_PWRON_FALL_MSK,
63 		.reg_offset = 0,
64 	},
65 	[RK8XX_IRQ_PWRON_RISE] = {
66 		.mask = RK816_IRQ_PWRON_RISE_MSK,
67 		.reg_offset = 0,
68 	},
69 	[RK8XX_IRQ_PLUG_OUT] = {
70 		.mask = RK816_IRQ_PLUG_OUT_MSK,
71 		.reg_offset = 2,
72 	},
73 	[RK8XX_IRQ_CHG_OK] = {
74 		.mask = RK816_IRQ_CHR_OK_MSK,
75 		.reg_offset = 2,
76 	},
77 };
78 
79 static struct virq_chip rk816_irq_chip = {
80 	.status_base		= RK816_INT_STS_REG1,
81 	.mask_base		= RK816_INT_MSK_REG1,
82 	.irq_unalign_reg_idx	= 1,	/* idx <= 1, stride = 3 */
83 	.irq_unalign_reg_stride	= 3,
84 	.irq_reg_stride		= 2,	/* idx > 1, stride = 2 */
85 	.num_regs		= 3,
86 	.i2c_read		= pmic_reg_read,
87 	.i2c_write		= pmic_reg_write,
88 	.irqs			= rk816_irqs,
89 	.num_irqs		= ARRAY_SIZE(rk816_irqs),
90 };
91 
92 /* RK818 */
93 static const struct virq_reg rk818_irqs[] = {
94 	[RK8XX_IRQ_PLUG_OUT] = {
95 		.mask = RK818_IRQ_PLUG_OUT_MSK,
96 		.reg_offset = 1,
97 	},
98 	[RK8XX_IRQ_CHG_OK] = {
99 		.mask = RK818_IRQ_CHR_OK_MSK,
100 		.reg_offset = 1,
101 	},
102 };
103 
104 static struct virq_chip rk818_irq_chip = {
105 	.status_base		= RK818_INT_STS_REG1,
106 	.mask_base		= RK818_INT_MSK_REG1,
107 	.irq_reg_stride		= 2,
108 	.num_regs		= 2,
109 	.i2c_read		= pmic_reg_read,
110 	.i2c_write		= pmic_reg_write,
111 	.irqs			= rk818_irqs,
112 	.num_irqs		= ARRAY_SIZE(rk818_irqs),
113 };
114 
115 /* RK817/RK809 */
116 static const struct virq_reg rk817_irqs[] = {
117 	[RK8XX_IRQ_PWRON_FALL] = {
118 		.mask = RK817_IRQ_PWRON_FALL_MSK,
119 		.reg_offset = 0,
120 	},
121 	[RK8XX_IRQ_PWRON_RISE] = {
122 		.mask = RK817_IRQ_PWRON_RISE_MSK,
123 		.reg_offset = 0,
124 	},
125 	[RK8XX_IRQ_PLUG_OUT] = {
126 		.mask = RK817_IRQ_PLUG_OUT_MSK,
127 		.reg_offset = 1,
128 	},
129 	[RK8XX_IRQ_PLUG_IN] = {
130 		.mask = RK817_IRQ_PLUG_IN_MSK,
131 		.reg_offset = 1,
132 	},
133 };
134 
135 static struct virq_chip rk817_irq_chip = {
136 	.status_base		= RK817_INT_STS_REG0,
137 	.mask_base		= RK817_INT_MSK_REG0,
138 	.irq_reg_stride		= 2,
139 	.num_regs		= 3,
140 	.i2c_read		= pmic_reg_read,
141 	.i2c_write		= pmic_reg_write,
142 	.irqs			= rk817_irqs,
143 	.num_irqs		= ARRAY_SIZE(rk817_irqs),
144 };
145 #endif
146 
147 static struct reg_data rk817_init_reg[] = {
148 /* enable the under-voltage protection,
149  * the under-voltage protection will shutdown the LDO3 and reset the PMIC
150  */
151 	{ RK817_BUCK4_CMIN, 0x60, 0x60},
152 /*
153  * Only when system suspend while U-Boot charge needs this config support
154  */
155 #ifdef CONFIG_DM_CHARGE_DISPLAY
156 	/* Set pmic_sleep as sleep function */
157 	{ RK817_PMIC_SYS_CFG3, 0x08, 0x18 },
158 	/* Set pmic_int active low */
159 	{ RK817_GPIO_INT_CFG,  0x00, 0x02 },
160 #endif
161 };
162 
163 static struct reg_data rk818_init_current[] = {
164 	{ REG_USB_CTRL, 0x07, 0x0f}, /* 2A */
165 };
166 
167 static const struct pmic_child_info pmic_children_info[] = {
168 	{ .prefix = "DCDC", .driver = "rk8xx_buck"},
169 	{ .prefix = "LDO", .driver = "rk8xx_ldo"},
170 	{ .prefix = "SWITCH", .driver = "rk8xx_switch"},
171 	{ },
172 };
173 
174 static const struct pmic_child_info power_key_info[] = {
175 	{ .prefix = "pwrkey", .driver = "rk8xx_pwrkey"},
176 	{ },
177 };
178 
179 static const struct pmic_child_info rtc_info[] = {
180 	{ .prefix = "rtc", .driver = "rk8xx_rtc"},
181 	{ },
182 };
183 
184 static const struct pmic_child_info fuel_gauge_info[] = {
185 	{ .addr = "1c", .prefix = "battery", .driver = "rk818_fg"},
186 	{ .addr = "20", .prefix = "battery", .driver = "rk817_fg"},
187 	{ .addr = "1a", .prefix = "battery", .driver = "rk816_fg"},
188 	{ },
189 };
190 
191 static const struct pmic_child_info rk817_codec_info[] = {
192 	{ .prefix = "codec", .driver = "rk817_codec"},
193 	{ },
194 };
195 
196 static int rk8xx_reg_count(struct udevice *dev)
197 {
198 	struct rk8xx_priv *priv = dev_get_priv(dev);
199 
200 	switch (priv->variant) {
201 	case RK809_ID:
202 	case RK817_ID:
203 		return RK817_NUM_OF_REGS;
204 	default:
205 		return RK808_NUM_OF_REGS;
206 	}
207 }
208 
209 static int rk8xx_write(struct udevice *dev, uint reg, const uint8_t *buff,
210 			  int len)
211 {
212 	int ret;
213 
214 	ret = dm_i2c_write(dev, reg, buff, len);
215 	if (ret) {
216 		printf("%s: write reg 0x%02x failed, ret=%d\n", __func__, reg, ret);
217 		return ret;
218 	}
219 
220 	return 0;
221 }
222 
223 static int rk8xx_read(struct udevice *dev, uint reg, uint8_t *buff, int len)
224 {
225 	int ret;
226 
227 	ret = dm_i2c_read(dev, reg, buff, len);
228 	if (ret) {
229 		printf("%s: read reg 0x%02x failed, ret=%d\n", __func__, reg, ret);
230 		return ret;
231 	}
232 
233 	return 0;
234 }
235 
236 static int rk8xx_shutdown(struct udevice *dev)
237 {
238 	struct rk8xx_priv *priv = dev_get_priv(dev);
239 	u8 val, dev_off, devctrl_reg;
240 	int ret = 0;
241 
242 	switch (priv->variant) {
243 	case RK808_ID:
244 		devctrl_reg = REG_DEVCTRL;
245 		dev_off = BIT(3);
246 		break;
247 	case RK805_ID:
248 	case RK816_ID:
249 	case RK818_ID:
250 		devctrl_reg = REG_DEVCTRL;
251 		dev_off = BIT(0);
252 		break;
253 	case RK809_ID:
254 	case RK817_ID:
255 		devctrl_reg = RK817_REG_SYS_CFG3;
256 		dev_off = BIT(0);
257 		break;
258 	default:
259 		printf("Unknown PMIC: RK%x\n", priv->variant);
260 		return -EINVAL;
261 	}
262 
263 	ret = dm_i2c_read(dev, devctrl_reg, &val, 1);
264 	if (ret) {
265 		printf("%s: read reg 0x%02x failed, ret=%d\n",
266 		       __func__, devctrl_reg, ret);
267 		return ret;
268 	}
269 
270 	val |= dev_off;
271 	ret = dm_i2c_write(dev, devctrl_reg, &val, 1);
272 	if (ret) {
273 		printf("%s: write reg 0x%02x failed, ret=%d\n",
274 		       __func__, devctrl_reg, ret);
275 		return ret;
276 	}
277 
278 	return 0;
279 }
280 
281 #if CONFIG_IS_ENABLED(PMIC_CHILDREN)
282 static int rk8xx_bind(struct udevice *dev)
283 {
284 	ofnode regulators_node;
285 	int children;
286 
287 	regulators_node = dev_read_subnode(dev, "regulators");
288 	if (!ofnode_valid(regulators_node)) {
289 		debug("%s: %s regulators subnode not found!\n", __func__,
290 		      dev->name);
291 		return -ENXIO;
292 	}
293 
294 	debug("%s: '%s' - found regulators subnode\n", __func__, dev->name);
295 
296 	children = pmic_bind_children(dev, regulators_node, pmic_children_info);
297 	if (!children)
298 		debug("%s: %s - no child found\n", __func__, dev->name);
299 
300 	children = pmic_bind_children(dev, dev->node, power_key_info);
301 	if (!children)
302 		debug("%s: %s - no child found\n", __func__, dev->name);
303 
304 	children = pmic_bind_children(dev, dev->node, rtc_info);
305 	if (!children)
306 		debug("%s: %s - no child found\n", __func__, dev->name);
307 
308 	children = pmic_bind_children(dev, dev->node, fuel_gauge_info);
309 	if (!children)
310 		debug("%s: %s - no child found\n", __func__, dev->name);
311 
312 	children = pmic_bind_children(dev, dev->node, rk817_codec_info);
313 	if (!children)
314 		debug("%s: %s - no child found\n", __func__, dev->name);
315 
316 	/* Always return success for this device */
317 	return 0;
318 }
319 #endif
320 
321 #if defined(CONFIG_IRQ) && !defined(CONFIG_SPL_BUILD)
322 /*
323  * When system suspend during U-Boot charge, make sure the plugout event
324  * be able to wakeup cpu in wfi/wfe state.
325  */
326 #ifdef CONFIG_DM_CHARGE_DISPLAY
327 static void rk8xx_plug_out_handler(int irq, void *data)
328 {
329 	printf("Plug out interrupt\n");
330 }
331 #endif
332 
333 static int rk8xx_ofdata_to_platdata(struct udevice *dev)
334 {
335 	struct rk8xx_priv *rk8xx = dev_get_priv(dev);
336 	u32 interrupt, phandle, val;
337 	int ret;
338 
339 	phandle = dev_read_u32_default(dev, "interrupt-parent", -ENODATA);
340 	if (phandle == -ENODATA) {
341 		printf("Read 'interrupt-parent' failed, ret=%d\n", phandle);
342 		return phandle;
343 	}
344 
345 	ret = dev_read_u32_array(dev, "interrupts", &interrupt, 1);
346 	if (ret) {
347 		printf("Read 'interrupts' failed, ret=%d\n", ret);
348 		return ret;
349 	}
350 
351 	rk8xx->irq = phandle_gpio_to_irq(phandle, interrupt);
352 	if (rk8xx->irq < 0) {
353 		printf("Failed to request rk8xx irq, ret=%d\n", rk8xx->irq);
354 		return rk8xx->irq;
355 	}
356 
357 	val = dev_read_u32_default(dev, "long-press-off-time-sec", 0);
358 	if (val <= 6)
359 		rk8xx->lp_off_time = RK8XX_LP_TIME_6S;
360 	else if (val <= 8)
361 		rk8xx->lp_off_time = RK8XX_LP_TIME_8S;
362 	else if (val <= 10)
363 		rk8xx->lp_off_time = RK8XX_LP_TIME_10S;
364 	else
365 		rk8xx->lp_off_time = RK8XX_LP_TIME_12S;
366 
367 	val = dev_read_u32_default(dev, "long-press-restart", 0);
368 	if (val)
369 		rk8xx->lp_action = RK8XX_LP_RESTART;
370 	else
371 		rk8xx->lp_action = RK8XX_LP_OFF;
372 
373 	return 0;
374 }
375 
376 static int rk8xx_irq_chip_init(struct udevice *dev)
377 {
378 	struct rk8xx_priv *priv = dev_get_priv(dev);
379 	struct virq_chip *irq_chip = NULL;
380 	int ret;
381 
382 	switch (priv->variant) {
383 	case RK808_ID:
384 		irq_chip = &rk808_irq_chip;
385 		break;
386 	case RK805_ID:
387 		irq_chip = &rk805_irq_chip;
388 		break;
389 	case RK816_ID:
390 		irq_chip = &rk816_irq_chip;
391 		break;
392 	case RK818_ID:
393 		irq_chip = &rk818_irq_chip;
394 		break;
395 	case RK809_ID:
396 	case RK817_ID:
397 		irq_chip = &rk817_irq_chip;
398 		break;
399 	default:
400 		return -EINVAL;
401 	}
402 
403 	if (irq_chip) {
404 		ret = virq_add_chip(dev, irq_chip, priv->irq);
405 		if (ret) {
406 			printf("Failed to add irqchip(irq=%d), ret=%d\n",
407 			       priv->irq, ret);
408 			return ret;
409 		}
410 
411 		priv->irq_chip = irq_chip;
412 
413 #ifdef CONFIG_DM_CHARGE_DISPLAY
414 		int irq;
415 
416 		irq = virq_to_irq(irq_chip, RK8XX_IRQ_PLUG_OUT);
417 		if (irq < 0) {
418 			printf("Failed to register plugout irq, ret=%d\n", irq);
419 			return irq;
420 		}
421 		irq_install_handler(irq, rk8xx_plug_out_handler, dev);
422 		irq_handler_enable_suspend_only(irq);
423 #endif
424 	}
425 
426 	return 0;
427 }
428 #else
429 static inline int rk8xx_ofdata_to_platdata(struct udevice *dev) { return 0; }
430 static inline int rk8xx_irq_chip_init(struct udevice *dev) { return 0; }
431 #endif
432 
433 static int rk8xx_probe(struct udevice *dev)
434 {
435 	struct rk8xx_priv *priv = dev_get_priv(dev);
436 	struct reg_data *init_current = NULL;
437 	struct reg_data *init_data = NULL;
438 	int init_current_num = 0;
439 	int init_data_num = 0;
440 	int ret = 0, i, show_variant;
441 	uint8_t msb, lsb, id_msb, id_lsb;
442 	uint8_t on_source = 0, off_source = 0;
443 	uint8_t pwron_key = 0, lp_off_msk = 0, lp_act_msk = 0;
444 	uint8_t power_en0, power_en1, power_en2, power_en3;
445 	uint8_t value;
446 
447 	/* read Chip variant */
448 	if (device_is_compatible(dev, "rockchip,rk817") ||
449 	    device_is_compatible(dev, "rockchip,rk809")) {
450 		id_msb = RK817_ID_MSB;
451 		id_lsb = RK817_ID_LSB;
452 	} else {
453 		id_msb = ID_MSB;
454 		id_lsb = ID_LSB;
455 	}
456 
457 	ret = rk8xx_read(dev, id_msb, &msb, 1);
458 	if (ret)
459 		return ret;
460 	ret = rk8xx_read(dev, id_lsb, &lsb, 1);
461 	if (ret)
462 		return ret;
463 
464 	priv->variant = ((msb << 8) | lsb) & RK8XX_ID_MSK;
465 	show_variant = priv->variant;
466 	switch (priv->variant) {
467 	case RK808_ID:
468 		show_variant = 0x808;	/* RK808 hardware ID is 0 */
469 		pwron_key = RK8XX_DEVCTRL_REG;
470 		lp_off_msk = RK8XX_LP_OFF_MSK;
471 		break;
472 	case RK805_ID:
473 	case RK816_ID:
474 		on_source = RK8XX_ON_SOURCE;
475 		off_source = RK8XX_OFF_SOURCE;
476 		pwron_key = RK8XX_DEVCTRL_REG;
477 		lp_off_msk = RK8XX_LP_OFF_MSK;
478 		lp_act_msk = RK8XX_LP_ACTION_MSK;
479 		break;
480 	case RK818_ID:
481 		on_source = RK8XX_ON_SOURCE;
482 		off_source = RK8XX_OFF_SOURCE;
483 		pwron_key = RK8XX_DEVCTRL_REG;
484 		lp_off_msk = RK8XX_LP_OFF_MSK;
485 		lp_act_msk = RK8XX_LP_ACTION_MSK;
486 		/* set current if no fuel gauge */
487 		if (!ofnode_valid(dev_read_subnode(dev, "battery"))) {
488 			init_current = rk818_init_current;
489 			init_current_num = ARRAY_SIZE(rk818_init_current);
490 		}
491 		break;
492 	case RK809_ID:
493 	case RK817_ID:
494 		on_source = RK817_ON_SOURCE;
495 		off_source = RK817_OFF_SOURCE;
496 		pwron_key = RK817_PWRON_KEY;
497 		lp_off_msk = RK8XX_LP_OFF_MSK;
498 		lp_act_msk = RK8XX_LP_ACTION_MSK;
499 		init_data = rk817_init_reg;
500 		init_data_num = ARRAY_SIZE(rk817_init_reg);
501 		power_en0 = pmic_reg_read(dev, RK817_POWER_EN0);
502 		power_en1 = pmic_reg_read(dev, RK817_POWER_EN1);
503 		power_en2 = pmic_reg_read(dev, RK817_POWER_EN2);
504 		power_en3 = pmic_reg_read(dev, RK817_POWER_EN3);
505 
506 		value = (power_en0 & 0x0f) | ((power_en1 & 0x0f) << 4);
507 		pmic_reg_write(dev, RK817_POWER_EN_SAVE0, value);
508 		value = (power_en2 & 0x0f) | ((power_en3 & 0x0f) << 4);
509 		pmic_reg_write(dev, RK817_POWER_EN_SAVE1, value);
510 		break;
511 	default:
512 		printf("Unknown PMIC: RK%x!!\n", priv->variant);
513 		return -EINVAL;
514 	}
515 
516 	/* common init */
517 	for (i = 0; i < init_data_num; i++) {
518 		ret = pmic_clrsetbits(dev,
519 				      init_data[i].reg,
520 				      init_data[i].mask,
521 				      init_data[i].val);
522 		if (ret < 0) {
523 			printf("%s: i2c set reg 0x%x failed, ret=%d\n",
524 			       __func__, init_data[i].reg, ret);
525 		}
526 	}
527 
528 	/* current init */
529 	for (i = 0; i < init_current_num; i++) {
530 		ret = pmic_clrsetbits(dev,
531 				      init_current[i].reg,
532 				      init_current[i].mask,
533 				      init_current[i].val);
534 		if (ret < 0) {
535 			printf("%s: i2c set reg 0x%x failed, ret=%d\n",
536 			       __func__, init_current[i].reg, ret);
537 		}
538 	}
539 
540 	printf("PMIC:  RK%x ", show_variant);
541 
542 	if (on_source && off_source)
543 		printf("(on=0x%02x, off=0x%02x)",
544 		       pmic_reg_read(dev, on_source),
545 		       pmic_reg_read(dev, off_source));
546 	printf("\n");
547 
548 	if (pwron_key) {
549 		value = pmic_reg_read(dev, pwron_key);
550 		value &= ~(lp_off_msk | lp_act_msk);
551 		if (lp_off_msk)
552 			value |= priv->lp_off_time;
553 		if (lp_act_msk)
554 			value |= priv->lp_action;
555 		pmic_reg_write(dev, pwron_key, value);
556 	}
557 
558 	ret = rk8xx_irq_chip_init(dev);
559 	if (ret) {
560 		printf("IRQ chip initial failed\n");
561 		return ret;
562 	}
563 
564 	return 0;
565 }
566 
567 static struct dm_pmic_ops rk8xx_ops = {
568 	.reg_count = rk8xx_reg_count,
569 	.read = rk8xx_read,
570 	.write = rk8xx_write,
571 	.shutdown = rk8xx_shutdown,
572 };
573 
574 static const struct udevice_id rk8xx_ids[] = {
575 	{ .compatible = "rockchip,rk805" },
576 	{ .compatible = "rockchip,rk808" },
577 	{ .compatible = "rockchip,rk809" },
578 	{ .compatible = "rockchip,rk816" },
579 	{ .compatible = "rockchip,rk817" },
580 	{ .compatible = "rockchip,rk818" },
581 	{ }
582 };
583 
584 U_BOOT_DRIVER(pmic_rk8xx) = {
585 	.name = "rk8xx pmic",
586 	.id = UCLASS_PMIC,
587 	.of_match = rk8xx_ids,
588 #if CONFIG_IS_ENABLED(PMIC_CHILDREN)
589 	.bind = rk8xx_bind,
590 #endif
591 	.ofdata_to_platdata = rk8xx_ofdata_to_platdata,
592 	.priv_auto_alloc_size = sizeof(struct rk8xx_priv),
593 	.probe = rk8xx_probe,
594 	.ops = &rk8xx_ops,
595 };
596