2 * MFD core driver for Rockchip RK808
4 * Copyright (c) 2014, Fuzhou Rockchip Electronics Co., Ltd
6 * Author: Chris Zhong <zyw@rock-chips.com>
7 * Author: Zhang Qing <zhangqing@rock-chips.com>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms and conditions of the GNU General Public License,
11 * version 2, as published by the Free Software Foundation.
13 * This program is distributed in the hope it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
19 #include <linux/i2c.h>
20 #include <linux/interrupt.h>
21 #include <linux/kernel.h>
22 #include <linux/mfd/rk808.h>
23 #include <linux/mfd/core.h>
24 #include <linux/module.h>
25 #include <linux/of_device.h>
26 #include <linux/regmap.h>
28 struct rk808_reg_data {
34 static bool rk808_is_volatile_reg(struct device *dev, unsigned int reg)
38 * - Technically the ROUND_30s bit makes RTC_CTRL_REG volatile, but
39 * we don't use that feature. It's better to cache.
40 * - It's unlikely we care that RK808_DEVCTRL_REG is volatile since
41 * bits are cleared in case when we shutoff anyway, but better safe.
45 case RK808_SECONDS_REG ... RK808_WEEKS_REG:
46 case RK808_RTC_STATUS_REG:
47 case RK808_VB_MON_REG:
48 case RK808_THERMAL_REG:
49 case RK808_DCDC_UV_STS_REG:
50 case RK808_LDO_UV_STS_REG:
51 case RK808_DCDC_PG_REG:
52 case RK808_LDO_PG_REG:
53 case RK808_DEVCTRL_REG:
54 case RK808_INT_STS_REG1:
55 case RK808_INT_STS_REG2:
62 static int rk808_shutdown(struct regmap *regmap)
66 ret = regmap_update_bits(regmap,
68 DEV_OFF_RST, DEV_OFF_RST);
72 static int rk818_shutdown(struct regmap *regmap)
76 ret = regmap_update_bits(regmap,
82 static int rk805_shutdown_prepare(struct regmap *regmap)
86 /* close rtc int when power off */
87 regmap_update_bits(regmap,
88 RK808_INT_STS_MSK_REG1,
89 (0x3 << 5), (0x3 << 5));
90 regmap_update_bits(regmap,
92 (0x3 << 2), (0x0 << 2));
94 /* pmic sleep shutdown function */
95 ret = regmap_update_bits(regmap,
96 RK805_GPIO_IO_POL_REG,
97 SLP_SD_MSK, SHUTDOWN_FUN);
101 static bool rk818_is_volatile_reg(struct device *dev, unsigned int reg)
105 * - Technically the ROUND_30s bit makes RTC_CTRL_REG volatile, but
106 * we don't use that feature. It's better to cache.
107 * - It's unlikely we care that RK808_DEVCTRL_REG is volatile since
108 * bits are cleared in case when we shutoff anyway, but better safe.
112 case RK808_SECONDS_REG ... RK808_WEEKS_REG:
113 case RK808_RTC_STATUS_REG:
114 case RK808_VB_MON_REG:
115 case RK808_THERMAL_REG:
116 case RK808_DCDC_EN_REG:
117 case RK808_DCDC_UV_STS_REG:
118 case RK808_LDO_UV_STS_REG:
119 case RK808_DCDC_PG_REG:
120 case RK808_LDO_PG_REG:
121 case RK808_DEVCTRL_REG:
122 case RK808_INT_STS_REG1:
123 case RK808_INT_STS_REG2:
124 case RK808_INT_STS_MSK_REG1:
125 case RK808_INT_STS_MSK_REG2:
126 case RK818_SUP_STS_REG ... RK818_SAVE_DATA19:
133 static const struct regmap_config rk808_regmap_config = {
136 .max_register = RK808_IO_POL_REG,
137 .cache_type = REGCACHE_RBTREE,
138 .volatile_reg = rk808_is_volatile_reg,
141 static const struct regmap_config rk805_regmap_config = {
144 .max_register = RK805_OFF_SOURCE_REG,
145 .cache_type = REGCACHE_RBTREE,
146 .volatile_reg = rk808_is_volatile_reg,
149 static struct resource rtc_resources[] = {
151 .start = RK808_IRQ_RTC_ALARM,
152 .end = RK808_IRQ_RTC_ALARM,
153 .flags = IORESOURCE_IRQ,
157 static struct resource pwrkey_resources[] = {
159 .start = RK805_IRQ_PWRON_RISE,
160 .end = RK805_IRQ_PWRON_RISE,
161 .flags = IORESOURCE_IRQ,
164 .start = RK805_IRQ_PWRON_FALL,
165 .end = RK805_IRQ_PWRON_FALL,
166 .flags = IORESOURCE_IRQ,
170 static const struct mfd_cell rk808s[] = {
171 { .name = "rk808-clkout", },
172 { .name = "rk808-regulator", },
175 .num_resources = ARRAY_SIZE(rtc_resources),
176 .resources = &rtc_resources[0],
180 static const struct rk808_reg_data rk808_pre_init_reg[] = {
181 { RK808_BUCK3_CONFIG_REG, BUCK_ILMIN_MASK, BUCK_ILMIN_150MA },
182 { RK808_BUCK4_CONFIG_REG, BUCK_ILMIN_MASK, BUCK_ILMIN_200MA },
183 { RK808_BOOST_CONFIG_REG, BOOST_ILMIN_MASK, BOOST_ILMIN_100MA },
184 { RK808_BUCK1_CONFIG_REG, BUCK1_RATE_MASK, BUCK_ILMIN_200MA },
185 { RK808_BUCK2_CONFIG_REG, BUCK2_RATE_MASK, BUCK_ILMIN_200MA },
186 { RK808_DCDC_UV_ACT_REG, BUCK_UV_ACT_MASK, BUCK_UV_ACT_DISABLE},
187 { RK808_RTC_CTRL_REG, RTC_STOP, RTC_STOP},
188 { RK808_VB_MON_REG, MASK_ALL, VB_LO_ACT |
192 static const struct regmap_irq rk808_irqs[] = {
194 [RK808_IRQ_VOUT_LO] = {
195 .mask = RK808_IRQ_VOUT_LO_MSK,
198 [RK808_IRQ_VB_LO] = {
199 .mask = RK808_IRQ_VB_LO_MSK,
202 [RK808_IRQ_PWRON] = {
203 .mask = RK808_IRQ_PWRON_MSK,
206 [RK808_IRQ_PWRON_LP] = {
207 .mask = RK808_IRQ_PWRON_LP_MSK,
210 [RK808_IRQ_HOTDIE] = {
211 .mask = RK808_IRQ_HOTDIE_MSK,
214 [RK808_IRQ_RTC_ALARM] = {
215 .mask = RK808_IRQ_RTC_ALARM_MSK,
218 [RK808_IRQ_RTC_PERIOD] = {
219 .mask = RK808_IRQ_RTC_PERIOD_MSK,
224 [RK808_IRQ_PLUG_IN_INT] = {
225 .mask = RK808_IRQ_PLUG_IN_INT_MSK,
228 [RK808_IRQ_PLUG_OUT_INT] = {
229 .mask = RK808_IRQ_PLUG_OUT_INT_MSK,
234 static struct regmap_irq_chip rk808_irq_chip = {
237 .num_irqs = ARRAY_SIZE(rk808_irqs),
240 .status_base = RK808_INT_STS_REG1,
241 .mask_base = RK808_INT_STS_MSK_REG1,
242 .ack_base = RK808_INT_STS_REG1,
243 .init_ack_masked = true,
246 static const struct regmap_config rk818_regmap_config = {
249 .max_register = RK818_SAVE_DATA19,
250 .cache_type = REGCACHE_RBTREE,
251 .volatile_reg = rk818_is_volatile_reg,
254 static const struct mfd_cell rk818s[] = {
255 { .name = "rk808-clkout", },
256 { .name = "rk808-regulator", },
257 { .name = "rk818-battery", .of_compatible = "rk818-battery", },
258 { .name = "rk818-charger", },
261 .num_resources = ARRAY_SIZE(rtc_resources),
262 .resources = &rtc_resources[0],
266 static const struct rk808_reg_data rk818_pre_init_reg[] = {
267 { RK818_H5V_EN_REG, REF_RDY_CTRL_ENABLE | H5V_EN_MASK,
268 REF_RDY_CTRL_ENABLE | H5V_EN_ENABLE },
269 { RK818_DCDC_EN_REG, BOOST_EN_MASK | SWITCH_EN_MASK,
270 BOOST_EN_ENABLE | SWITCH_EN_ENABLE },
271 { RK818_SLEEP_SET_OFF_REG1, OTG_SLP_SET_MASK, OTG_SLP_SET_OFF },
272 { RK818_BUCK4_CONFIG_REG, BUCK_ILMIN_MASK, BUCK_ILMIN_250MA },
273 { RK808_RTC_CTRL_REG, RTC_STOP, RTC_STOP},
276 static const struct regmap_irq rk818_irqs[] = {
278 [RK818_IRQ_VOUT_LO] = {
279 .mask = VOUT_LO_MASK,
282 [RK818_IRQ_VB_LO] = {
286 [RK818_IRQ_PWRON] = {
290 [RK818_IRQ_PWRON_LP] = {
291 .mask = PWRON_LP_MASK,
294 [RK818_IRQ_HOTDIE] = {
298 [RK818_IRQ_RTC_ALARM] = {
299 .mask = RTC_ALARM_MASK,
302 [RK818_IRQ_RTC_PERIOD] = {
303 .mask = RTC_PERIOD_MASK,
306 [RK818_IRQ_USB_OV] = {
311 [RK818_IRQ_PLUG_IN] = {
312 .mask = PLUG_IN_MASK,
315 [RK818_IRQ_PLUG_OUT] = {
316 .mask = PLUG_OUT_MASK,
319 [RK818_IRQ_CHG_OK] = {
323 [RK818_IRQ_CHG_TE] = {
327 [RK818_IRQ_CHG_TS1] = {
335 [RK818_IRQ_CHG_CVTLIM] = {
336 .mask = CHG_CVTLIM_MASK,
339 [RK818_IRQ_DISCHG_ILIM] = {
340 .mask = DISCHG_ILIM_MASK,
345 static struct regmap_irq_chip rk818_irq_chip = {
348 .num_irqs = ARRAY_SIZE(rk818_irqs),
351 .status_base = RK808_INT_STS_REG1,
352 .mask_base = RK808_INT_STS_MSK_REG1,
353 .ack_base = RK808_INT_STS_REG1,
354 .init_ack_masked = true,
357 static const struct regmap_irq rk805_irqs[] = {
358 [RK805_IRQ_PWRON_RISE] = {
359 .mask = RK805_IRQ_PWRON_RISE_MSK,
362 [RK805_IRQ_VB_LOW] = {
363 .mask = RK805_IRQ_VB_LOW_MSK,
366 [RK805_IRQ_PWRON] = {
367 .mask = RK805_IRQ_PWRON_MSK,
370 [RK805_IRQ_PWRON_LP] = {
371 .mask = RK805_IRQ_PWRON_LP_MSK,
374 [RK805_IRQ_HOTDIE] = {
375 .mask = RK805_IRQ_HOTDIE_MSK,
378 [RK805_IRQ_RTC_ALARM] = {
379 .mask = RK805_IRQ_RTC_ALARM_MSK,
382 [RK805_IRQ_RTC_PERIOD] = {
383 .mask = RK805_IRQ_RTC_PERIOD_MSK,
386 [RK805_IRQ_PWRON_FALL] = {
387 .mask = RK805_IRQ_PWRON_FALL_MSK,
392 static struct regmap_irq_chip rk805_irq_chip = {
395 .num_irqs = ARRAY_SIZE(rk805_irqs),
397 .status_base = RK805_INT_STS_REG,
398 .mask_base = RK805_INT_STS_MSK_REG,
399 .ack_base = RK805_INT_STS_REG,
400 .init_ack_masked = true,
403 static const struct mfd_cell rk805s[] = {
404 { .name = "rk808-clkout", },
405 { .name = "rk818-regulator", },
406 { .name = "rk8xx-gpio", },
408 .name = "rk8xx-pwrkey",
409 .num_resources = ARRAY_SIZE(pwrkey_resources),
410 .resources = &pwrkey_resources[0],
414 .num_resources = ARRAY_SIZE(rtc_resources),
415 .resources = &rtc_resources[0],
419 static const struct rk808_reg_data rk805_pre_init_reg[] = {
420 {RK805_BUCK4_CONFIG_REG, BUCK_ILMIN_MASK, BUCK_ILMIN_400MA},
421 {RK805_GPIO_IO_POL_REG, SLP_SD_MSK, SLEEP_FUN},
422 {RK808_RTC_CTRL_REG, RTC_STOP, RTC_STOP},
423 {RK805_THERMAL_REG, TEMP_HOTDIE_MSK, TEMP115C},
426 static int (*pm_shutdown)(struct regmap *regmap);
427 static int (*pm_shutdown_prepare)(struct regmap *regmap);
428 static struct i2c_client *rk808_i2c_client;
430 static void rk808_device_shutdown_prepare(void)
433 struct rk808 *rk808 = i2c_get_clientdata(rk808_i2c_client);
436 dev_warn(&rk808_i2c_client->dev,
437 "have no rk808, so do nothing here\n");
441 if (pm_shutdown_prepare) {
442 ret = pm_shutdown_prepare(rk808->regmap);
444 dev_err(&rk808_i2c_client->dev,
445 "power off prepare error!\n");
449 static void rk808_device_shutdown(void)
452 struct rk808 *rk808 = i2c_get_clientdata(rk808_i2c_client);
455 dev_warn(&rk808_i2c_client->dev,
456 "have no rk808, so do nothing here\n");
460 /* close rtc int when power off */
461 regmap_update_bits(rk808->regmap,
462 RK808_INT_STS_MSK_REG1,
463 (0x3 << 5), (0x3 << 5));
464 regmap_update_bits(rk808->regmap,
466 (0x3 << 2), (0x0 << 2));
468 ret = pm_shutdown(rk808->regmap);
470 dev_err(&rk808_i2c_client->dev, "power off error!\n");
474 static ssize_t rk8xx_dbg_store(struct device *dev,
475 struct device_attribute *attr,
476 const char *buf, size_t count)
480 u32 input[2], addr, data;
481 struct rk808 *rk808 = i2c_get_clientdata(rk808_i2c_client);
483 ret = sscanf(buf, "%c ", &cmd);
486 ret = sscanf(buf, "%c %x %x ", &cmd, &input[0], &input[1]);
488 pr_err("erro! cmd format: echo w [addr] [value]\n");
491 addr = input[0] & 0xff;
492 data = input[1] & 0xff;
493 pr_info("cmd : %c %x %x\n\n", cmd, input[0], input[1]);
494 regmap_write(rk808->regmap, addr, data);
495 regmap_read(rk808->regmap, addr, &data);
496 pr_info("new: %x %x\n", addr, data);
499 ret = sscanf(buf, "%c %x ", &cmd, &input[0]);
501 pr_err("erro! cmd format: echo r [addr]\n");
504 pr_info("cmd : %c %x\n\n", cmd, input[0]);
505 addr = input[0] & 0xff;
506 regmap_read(rk808->regmap, addr, &data);
507 pr_info("%x %x\n", input[0], data);
510 pr_err("Unknown command\n");
518 static struct kobject *rk8xx_kobj;
519 static struct device_attribute rk8xx_attrs =
520 __ATTR(rk8xx_dbg, 0200, NULL, rk8xx_dbg_store);
522 static const struct of_device_id rk808_of_match[] = {
523 { .compatible = "rockchip,rk805" },
524 { .compatible = "rockchip,rk808" },
525 { .compatible = "rockchip,rk818" },
529 MODULE_DEVICE_TABLE(of, rk808_of_match);
531 static int rk808_probe(struct i2c_client *client,
532 const struct i2c_device_id *id)
534 struct device_node *np = client->dev.of_node;
536 int (*pm_shutdown_fn)(struct regmap *regmap) = NULL;
537 int (*pm_shutdown_prepare_fn)(struct regmap *regmap) = NULL;
538 const struct rk808_reg_data *pre_init_reg;
539 const struct regmap_config *regmap_config;
540 const struct regmap_irq_chip *irq_chip;
541 const struct mfd_cell *cell;
542 u8 on_source = 0, off_source = 0;
543 int msb, lsb, reg_num, cell_num;
544 int ret, i, pm_off = 0;
545 unsigned int on, off;
548 dev_err(&client->dev, "No interrupt support, no core IRQ\n");
552 rk808 = devm_kzalloc(&client->dev, sizeof(*rk808), GFP_KERNEL);
556 /* read Chip variant */
557 msb = i2c_smbus_read_byte_data(client, RK808_ID_MSB);
559 dev_err(&client->dev, "failed to read the chip id at 0x%x\n",
564 lsb = i2c_smbus_read_byte_data(client, RK808_ID_LSB);
566 dev_err(&client->dev, "failed to read the chip id at 0x%x\n",
571 rk808->variant = ((msb << 8) | lsb) & RK8XX_ID_MSK;
572 dev_info(&client->dev, "Pmic Chip id: 0x%lx\n", rk808->variant);
574 /* set Chip platform init data*/
575 switch (rk808->variant) {
578 cell_num = ARRAY_SIZE(rk818s);
579 pre_init_reg = rk818_pre_init_reg;
580 reg_num = ARRAY_SIZE(rk818_pre_init_reg);
581 regmap_config = &rk818_regmap_config;
582 irq_chip = &rk818_irq_chip;
583 pm_shutdown_fn = rk818_shutdown;
584 on_source = RK818_ON_SOURCE_REG;
585 off_source = RK818_OFF_SOURCE_REG;
589 cell_num = ARRAY_SIZE(rk808s);
590 pre_init_reg = rk808_pre_init_reg;
591 reg_num = ARRAY_SIZE(rk808_pre_init_reg);
592 regmap_config = &rk808_regmap_config;
593 irq_chip = &rk808_irq_chip;
594 pm_shutdown_fn = rk808_shutdown;
598 cell_num = ARRAY_SIZE(rk805s);
599 pre_init_reg = rk805_pre_init_reg;
600 reg_num = ARRAY_SIZE(rk805_pre_init_reg);
601 regmap_config = &rk805_regmap_config;
602 irq_chip = &rk805_irq_chip;
603 pm_shutdown_prepare_fn = rk805_shutdown_prepare;
604 on_source = RK805_ON_SOURCE_REG;
605 off_source = RK805_OFF_SOURCE_REG;
608 dev_err(&client->dev, "unsupported RK8XX ID 0x%lx\n",
613 rk808->regmap = devm_regmap_init_i2c(client, regmap_config);
614 if (IS_ERR(rk808->regmap)) {
615 dev_err(&client->dev, "regmap initialization failed\n");
616 return PTR_ERR(rk808->regmap);
619 /* on & off source */
620 if (on_source && off_source) {
621 ret = regmap_read(rk808->regmap, on_source, &on);
623 dev_err(&client->dev, "read 0x%x failed\n", on_source);
627 ret = regmap_read(rk808->regmap, off_source, &off);
629 dev_err(&client->dev, "read 0x%x failed\n", off_source);
633 dev_info(&client->dev, "source: on=0x%02x, off=0x%02x\n",
637 for (i = 0; i < reg_num; i++) {
638 ret = regmap_update_bits(rk808->regmap,
639 pre_init_reg[i].addr,
640 pre_init_reg[i].mask,
641 pre_init_reg[i].value);
643 dev_err(&client->dev,
645 pre_init_reg[i].addr);
650 ret = regmap_add_irq_chip(rk808->regmap, client->irq,
652 irq_chip, &rk808->irq_data);
654 dev_err(&client->dev, "Failed to add irq_chip %d\n", ret);
659 i2c_set_clientdata(client, rk808);
661 ret = mfd_add_devices(&client->dev, -1,
663 NULL, 0, regmap_irq_get_domain(rk808->irq_data));
665 dev_err(&client->dev, "failed to add MFD devices %d\n", ret);
669 pm_off = of_property_read_bool(np,
670 "rockchip,system-power-controller");
672 rk808_i2c_client = client;
673 if (pm_shutdown_prepare_fn) {
674 pm_shutdown_prepare = pm_shutdown_prepare_fn;
675 pm_power_off_prepare = rk808_device_shutdown_prepare;
677 if (pm_shutdown_fn) {
678 pm_shutdown = pm_shutdown_fn;
679 pm_power_off = rk808_device_shutdown;
683 rk8xx_kobj = kobject_create_and_add("rk8xx", NULL);
685 ret = sysfs_create_file(rk8xx_kobj, &rk8xx_attrs.attr);
687 dev_err(&client->dev, "create rk8xx sysfs error\n");
693 regmap_del_irq_chip(client->irq, rk808->irq_data);
697 static int rk808_remove(struct i2c_client *client)
699 struct rk808 *rk808 = i2c_get_clientdata(client);
701 regmap_del_irq_chip(client->irq, rk808->irq_data);
702 mfd_remove_devices(&client->dev);
703 if (pm_power_off == rk808_device_shutdown)
705 if (pm_power_off_prepare == rk808_device_shutdown_prepare)
706 pm_power_off_prepare = NULL;
711 static const struct i2c_device_id rk808_ids[] = {
717 MODULE_DEVICE_TABLE(i2c, rk808_ids);
719 static struct i2c_driver rk808_i2c_driver = {
722 .of_match_table = rk808_of_match,
724 .probe = rk808_probe,
725 .remove = rk808_remove,
726 .id_table = rk808_ids,
729 module_i2c_driver(rk808_i2c_driver);
731 MODULE_LICENSE("GPL");
732 MODULE_AUTHOR("Chris Zhong <zyw@rock-chips.com>");
733 MODULE_AUTHOR("Zhang Qing <zhangqing@rock-chips.com>");
734 MODULE_AUTHOR("Chen jianhong <chenjh@rock-chips.com>");
735 MODULE_DESCRIPTION("RK808 PMIC driver");