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_VB_MON_REG, MASK_ALL, VB_LO_ACT |
191 static const struct regmap_irq rk808_irqs[] = {
193 [RK808_IRQ_VOUT_LO] = {
194 .mask = RK808_IRQ_VOUT_LO_MSK,
197 [RK808_IRQ_VB_LO] = {
198 .mask = RK808_IRQ_VB_LO_MSK,
201 [RK808_IRQ_PWRON] = {
202 .mask = RK808_IRQ_PWRON_MSK,
205 [RK808_IRQ_PWRON_LP] = {
206 .mask = RK808_IRQ_PWRON_LP_MSK,
209 [RK808_IRQ_HOTDIE] = {
210 .mask = RK808_IRQ_HOTDIE_MSK,
213 [RK808_IRQ_RTC_ALARM] = {
214 .mask = RK808_IRQ_RTC_ALARM_MSK,
217 [RK808_IRQ_RTC_PERIOD] = {
218 .mask = RK808_IRQ_RTC_PERIOD_MSK,
223 [RK808_IRQ_PLUG_IN_INT] = {
224 .mask = RK808_IRQ_PLUG_IN_INT_MSK,
227 [RK808_IRQ_PLUG_OUT_INT] = {
228 .mask = RK808_IRQ_PLUG_OUT_INT_MSK,
233 static struct regmap_irq_chip rk808_irq_chip = {
236 .num_irqs = ARRAY_SIZE(rk808_irqs),
239 .status_base = RK808_INT_STS_REG1,
240 .mask_base = RK808_INT_STS_MSK_REG1,
241 .ack_base = RK808_INT_STS_REG1,
242 .init_ack_masked = true,
245 static const struct regmap_config rk818_regmap_config = {
248 .max_register = RK818_SAVE_DATA19,
249 .cache_type = REGCACHE_RBTREE,
250 .volatile_reg = rk818_is_volatile_reg,
253 static const struct mfd_cell rk818s[] = {
254 { .name = "rk808-clkout", },
255 { .name = "rk818-regulator", },
256 { .name = "rk818-battery", .of_compatible = "rk818-battery", },
257 { .name = "rk818-charger", },
260 .num_resources = ARRAY_SIZE(rtc_resources),
261 .resources = &rtc_resources[0],
265 static const struct rk808_reg_data rk818_pre_init_reg[] = {
266 { RK818_H5V_EN_REG, REF_RDY_CTRL_ENABLE | H5V_EN_MASK,
267 REF_RDY_CTRL_ENABLE | H5V_EN_ENABLE },
268 { RK818_DCDC_EN_REG, BOOST_EN_MASK | SWITCH_EN_MASK,
269 BOOST_EN_ENABLE | SWITCH_EN_ENABLE },
270 { RK818_SLEEP_SET_OFF_REG1, OTG_SLP_SET_MASK, OTG_SLP_SET_OFF },
271 { RK818_BUCK4_CONFIG_REG, BUCK_ILMIN_MASK, BUCK_ILMIN_250MA },
274 static const struct regmap_irq rk818_irqs[] = {
276 [RK818_IRQ_VOUT_LO] = {
277 .mask = VOUT_LO_MASK,
280 [RK818_IRQ_VB_LO] = {
284 [RK818_IRQ_PWRON] = {
288 [RK818_IRQ_PWRON_LP] = {
289 .mask = PWRON_LP_MASK,
292 [RK818_IRQ_HOTDIE] = {
296 [RK818_IRQ_RTC_ALARM] = {
297 .mask = RTC_ALARM_MASK,
300 [RK818_IRQ_RTC_PERIOD] = {
301 .mask = RTC_PERIOD_MASK,
304 [RK818_IRQ_USB_OV] = {
309 [RK818_IRQ_PLUG_IN] = {
310 .mask = PLUG_IN_MASK,
313 [RK818_IRQ_PLUG_OUT] = {
314 .mask = PLUG_OUT_MASK,
317 [RK818_IRQ_CHG_OK] = {
321 [RK818_IRQ_CHG_TE] = {
325 [RK818_IRQ_CHG_TS1] = {
333 [RK818_IRQ_CHG_CVTLIM] = {
334 .mask = CHG_CVTLIM_MASK,
337 [RK818_IRQ_DISCHG_ILIM] = {
338 .mask = DISCHG_ILIM_MASK,
343 static struct regmap_irq_chip rk818_irq_chip = {
346 .num_irqs = ARRAY_SIZE(rk818_irqs),
349 .status_base = RK808_INT_STS_REG1,
350 .mask_base = RK808_INT_STS_MSK_REG1,
351 .ack_base = RK808_INT_STS_REG1,
352 .init_ack_masked = true,
355 static const struct regmap_irq rk805_irqs[] = {
356 [RK805_IRQ_PWRON_RISE] = {
357 .mask = RK805_IRQ_PWRON_RISE_MSK,
360 [RK805_IRQ_VB_LOW] = {
361 .mask = RK805_IRQ_VB_LOW_MSK,
364 [RK805_IRQ_PWRON] = {
365 .mask = RK805_IRQ_PWRON_MSK,
368 [RK805_IRQ_PWRON_LP] = {
369 .mask = RK805_IRQ_PWRON_LP_MSK,
372 [RK805_IRQ_HOTDIE] = {
373 .mask = RK805_IRQ_HOTDIE_MSK,
376 [RK805_IRQ_RTC_ALARM] = {
377 .mask = RK805_IRQ_RTC_ALARM_MSK,
380 [RK805_IRQ_RTC_PERIOD] = {
381 .mask = RK805_IRQ_RTC_PERIOD_MSK,
384 [RK805_IRQ_PWRON_FALL] = {
385 .mask = RK805_IRQ_PWRON_FALL_MSK,
390 static struct regmap_irq_chip rk805_irq_chip = {
393 .num_irqs = ARRAY_SIZE(rk805_irqs),
395 .status_base = RK805_INT_STS_REG,
396 .mask_base = RK805_INT_STS_MSK_REG,
397 .ack_base = RK805_INT_STS_REG,
398 .init_ack_masked = true,
401 static const struct mfd_cell rk805s[] = {
402 { .name = "rk818-regulator", },
403 { .name = "rk8xx-gpio", },
405 .name = "rk8xx-pwrkey",
406 .num_resources = ARRAY_SIZE(pwrkey_resources),
407 .resources = &pwrkey_resources[0],
411 .num_resources = ARRAY_SIZE(rtc_resources),
412 .resources = &rtc_resources[0],
416 static const struct rk808_reg_data rk805_pre_init_reg[] = {
417 {RK805_BUCK4_CONFIG_REG, BUCK_ILMIN_MASK, BUCK_ILMIN_400MA},
418 {RK805_GPIO_IO_POL_REG, SLP_SD_MSK, SLEEP_FUN},
419 {RK805_THERMAL_REG, TEMP_HOTDIE_MSK, TEMP115C},
422 static int (*pm_shutdown)(struct regmap *regmap);
423 static int (*pm_shutdown_prepare)(struct regmap *regmap);
424 static struct i2c_client *rk808_i2c_client;
426 static void rk808_device_shutdown_prepare(void)
429 struct rk808 *rk808 = i2c_get_clientdata(rk808_i2c_client);
432 dev_warn(&rk808_i2c_client->dev,
433 "have no rk808, so do nothing here\n");
437 if (pm_shutdown_prepare) {
438 ret = pm_shutdown_prepare(rk808->regmap);
440 dev_err(&rk808_i2c_client->dev,
441 "power off prepare error!\n");
445 static void rk808_device_shutdown(void)
448 struct rk808 *rk808 = i2c_get_clientdata(rk808_i2c_client);
451 dev_warn(&rk808_i2c_client->dev,
452 "have no rk808, so do nothing here\n");
456 /* close rtc int when power off */
457 regmap_update_bits(rk808->regmap,
458 RK808_INT_STS_MSK_REG1,
459 (0x3 << 5), (0x3 << 5));
460 regmap_update_bits(rk808->regmap,
462 (0x3 << 2), (0x0 << 2));
464 ret = pm_shutdown(rk808->regmap);
466 dev_err(&rk808_i2c_client->dev, "power off error!\n");
470 static const struct of_device_id rk808_of_match[] = {
471 { .compatible = "rockchip,rk805" },
472 { .compatible = "rockchip,rk808" },
473 { .compatible = "rockchip,rk818" },
477 MODULE_DEVICE_TABLE(of, rk808_of_match);
479 static int rk808_probe(struct i2c_client *client,
480 const struct i2c_device_id *id)
482 struct device_node *np = client->dev.of_node;
484 int (*pm_shutdown_fn)(struct regmap *regmap) = NULL;
485 int (*pm_shutdown_prepare_fn)(struct regmap *regmap) = NULL;
486 const struct rk808_reg_data *pre_init_reg;
487 const struct regmap_config *regmap_config;
488 const struct regmap_irq_chip *irq_chip;
489 const struct mfd_cell *cell;
490 u8 on_source = 0, off_source = 0;
491 int msb, lsb, reg_num, cell_num;
492 int ret, i, pm_off = 0;
493 unsigned int on, off;
496 dev_err(&client->dev, "No interrupt support, no core IRQ\n");
500 rk808 = devm_kzalloc(&client->dev, sizeof(*rk808), GFP_KERNEL);
504 /* read Chip variant */
505 msb = i2c_smbus_read_byte_data(client, RK808_ID_MSB);
507 dev_err(&client->dev, "failed to read the chip id at 0x%x\n",
512 lsb = i2c_smbus_read_byte_data(client, RK808_ID_LSB);
514 dev_err(&client->dev, "failed to read the chip id at 0x%x\n",
519 rk808->variant = ((msb << 8) | lsb) & RK8XX_ID_MSK;
520 dev_info(&client->dev, "Pmic Chip id: 0x%lx\n", rk808->variant);
522 /* set Chip platform init data*/
523 switch (rk808->variant) {
526 cell_num = ARRAY_SIZE(rk818s);
527 pre_init_reg = rk818_pre_init_reg;
528 reg_num = ARRAY_SIZE(rk818_pre_init_reg);
529 regmap_config = &rk818_regmap_config;
530 irq_chip = &rk818_irq_chip;
531 pm_shutdown_fn = rk818_shutdown;
532 on_source = RK818_ON_SOURCE_REG;
533 off_source = RK818_OFF_SOURCE_REG;
537 cell_num = ARRAY_SIZE(rk808s);
538 pre_init_reg = rk808_pre_init_reg;
539 reg_num = ARRAY_SIZE(rk808_pre_init_reg);
540 regmap_config = &rk808_regmap_config;
541 irq_chip = &rk808_irq_chip;
542 pm_shutdown_fn = rk808_shutdown;
546 cell_num = ARRAY_SIZE(rk805s);
547 pre_init_reg = rk805_pre_init_reg;
548 reg_num = ARRAY_SIZE(rk805_pre_init_reg);
549 regmap_config = &rk805_regmap_config;
550 irq_chip = &rk805_irq_chip;
551 pm_shutdown_prepare_fn = rk805_shutdown_prepare;
552 on_source = RK805_ON_SOURCE_REG;
553 off_source = RK805_OFF_SOURCE_REG;
556 dev_err(&client->dev, "unsupported RK8XX ID 0x%lx\n",
561 rk808->regmap = devm_regmap_init_i2c(client, regmap_config);
562 if (IS_ERR(rk808->regmap)) {
563 dev_err(&client->dev, "regmap initialization failed\n");
564 return PTR_ERR(rk808->regmap);
567 /* on & off source */
568 if (on_source && off_source) {
569 ret = regmap_read(rk808->regmap, on_source, &on);
571 dev_err(&client->dev, "read 0x%x failed\n", on_source);
575 ret = regmap_read(rk808->regmap, off_source, &off);
577 dev_err(&client->dev, "read 0x%x failed\n", off_source);
581 dev_info(&client->dev, "source: on=0x%02x, off=0x%02x\n",
585 for (i = 0; i < reg_num; i++) {
586 ret = regmap_update_bits(rk808->regmap,
587 pre_init_reg[i].addr,
588 pre_init_reg[i].mask,
589 pre_init_reg[i].value);
591 dev_err(&client->dev,
593 pre_init_reg[i].addr);
598 ret = regmap_add_irq_chip(rk808->regmap, client->irq,
600 irq_chip, &rk808->irq_data);
602 dev_err(&client->dev, "Failed to add irq_chip %d\n", ret);
607 i2c_set_clientdata(client, rk808);
609 ret = mfd_add_devices(&client->dev, -1,
611 NULL, 0, regmap_irq_get_domain(rk808->irq_data));
613 dev_err(&client->dev, "failed to add MFD devices %d\n", ret);
617 pm_off = of_property_read_bool(np,
618 "rockchip,system-power-controller");
620 rk808_i2c_client = client;
621 if (pm_shutdown_prepare_fn) {
622 pm_shutdown_prepare = pm_shutdown_prepare_fn;
623 pm_power_off_prepare = rk808_device_shutdown_prepare;
625 if (pm_shutdown_fn) {
626 pm_shutdown = pm_shutdown_fn;
627 pm_power_off = rk808_device_shutdown;
634 regmap_del_irq_chip(client->irq, rk808->irq_data);
638 static int rk808_remove(struct i2c_client *client)
640 struct rk808 *rk808 = i2c_get_clientdata(client);
642 regmap_del_irq_chip(client->irq, rk808->irq_data);
643 mfd_remove_devices(&client->dev);
644 if (pm_power_off == rk808_device_shutdown)
646 if (pm_power_off_prepare == rk808_device_shutdown_prepare)
647 pm_power_off_prepare = NULL;
652 static const struct i2c_device_id rk808_ids[] = {
658 MODULE_DEVICE_TABLE(i2c, rk808_ids);
660 static struct i2c_driver rk808_i2c_driver = {
663 .of_match_table = rk808_of_match,
665 .probe = rk808_probe,
666 .remove = rk808_remove,
667 .id_table = rk808_ids,
670 module_i2c_driver(rk808_i2c_driver);
672 MODULE_LICENSE("GPL");
673 MODULE_AUTHOR("Chris Zhong <zyw@rock-chips.com>");
674 MODULE_AUTHOR("Zhang Qing <zhangqing@rock-chips.com>");
675 MODULE_AUTHOR("Chen jianhong <chenjh@rock-chips.com>");
676 MODULE_DESCRIPTION("RK808 PMIC driver");