1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * An RTC driver for Allwinner A31/A23 4 * 5 * Copyright (c) 2014, Chen-Yu Tsai <[email protected]> 6 * 7 * based on rtc-sunxi.c 8 * 9 * An RTC driver for Allwinner A10/A20 10 * 11 * Copyright (c) 2013, Carlo Caione <[email protected]> 12 */ 13 14 #include <linux/clk.h> 15 #include <linux/clk-provider.h> 16 #include <linux/clk/sunxi-ng.h> 17 #include <linux/delay.h> 18 #include <linux/err.h> 19 #include <linux/fs.h> 20 #include <linux/init.h> 21 #include <linux/interrupt.h> 22 #include <linux/io.h> 23 #include <linux/kernel.h> 24 #include <linux/module.h> 25 #include <linux/of.h> 26 #include <linux/of_address.h> 27 #include <linux/of_device.h> 28 #include <linux/platform_device.h> 29 #include <linux/rtc.h> 30 #include <linux/slab.h> 31 #include <linux/types.h> 32 33 /* Control register */ 34 #define SUN6I_LOSC_CTRL 0x0000 35 #define SUN6I_LOSC_CTRL_KEY (0x16aa << 16) 36 #define SUN6I_LOSC_CTRL_AUTO_SWT_BYPASS BIT(15) 37 #define SUN6I_LOSC_CTRL_ALM_DHMS_ACC BIT(9) 38 #define SUN6I_LOSC_CTRL_RTC_HMS_ACC BIT(8) 39 #define SUN6I_LOSC_CTRL_RTC_YMD_ACC BIT(7) 40 #define SUN6I_LOSC_CTRL_EXT_LOSC_EN BIT(4) 41 #define SUN6I_LOSC_CTRL_EXT_OSC BIT(0) 42 #define SUN6I_LOSC_CTRL_ACC_MASK GENMASK(9, 7) 43 44 #define SUN6I_LOSC_CLK_PRESCAL 0x0008 45 46 /* RTC */ 47 #define SUN6I_RTC_YMD 0x0010 48 #define SUN6I_RTC_HMS 0x0014 49 50 /* Alarm 0 (counter) */ 51 #define SUN6I_ALRM_COUNTER 0x0020 52 /* This holds the remaining alarm seconds on older SoCs (current value) */ 53 #define SUN6I_ALRM_COUNTER_HMS 0x0024 54 #define SUN6I_ALRM_EN 0x0028 55 #define SUN6I_ALRM_EN_CNT_EN BIT(0) 56 #define SUN6I_ALRM_IRQ_EN 0x002c 57 #define SUN6I_ALRM_IRQ_EN_CNT_IRQ_EN BIT(0) 58 #define SUN6I_ALRM_IRQ_STA 0x0030 59 #define SUN6I_ALRM_IRQ_STA_CNT_IRQ_PEND BIT(0) 60 61 /* Alarm 1 (wall clock) */ 62 #define SUN6I_ALRM1_EN 0x0044 63 #define SUN6I_ALRM1_IRQ_EN 0x0048 64 #define SUN6I_ALRM1_IRQ_STA 0x004c 65 #define SUN6I_ALRM1_IRQ_STA_WEEK_IRQ_PEND BIT(0) 66 67 /* Alarm config */ 68 #define SUN6I_ALARM_CONFIG 0x0050 69 #define SUN6I_ALARM_CONFIG_WAKEUP BIT(0) 70 71 #define SUN6I_LOSC_OUT_GATING 0x0060 72 #define SUN6I_LOSC_OUT_GATING_EN_OFFSET 0 73 74 /* General-purpose data */ 75 #define SUN6I_GP_DATA 0x0100 76 #define SUN6I_GP_DATA_SIZE 0x20 77 78 /* 79 * Get date values 80 */ 81 #define SUN6I_DATE_GET_DAY_VALUE(x) ((x) & 0x0000001f) 82 #define SUN6I_DATE_GET_MON_VALUE(x) (((x) & 0x00000f00) >> 8) 83 #define SUN6I_DATE_GET_YEAR_VALUE(x) (((x) & 0x003f0000) >> 16) 84 #define SUN6I_LEAP_GET_VALUE(x) (((x) & 0x00400000) >> 22) 85 86 /* 87 * Get time values 88 */ 89 #define SUN6I_TIME_GET_SEC_VALUE(x) ((x) & 0x0000003f) 90 #define SUN6I_TIME_GET_MIN_VALUE(x) (((x) & 0x00003f00) >> 8) 91 #define SUN6I_TIME_GET_HOUR_VALUE(x) (((x) & 0x001f0000) >> 16) 92 93 /* 94 * Set date values 95 */ 96 #define SUN6I_DATE_SET_DAY_VALUE(x) ((x) & 0x0000001f) 97 #define SUN6I_DATE_SET_MON_VALUE(x) ((x) << 8 & 0x00000f00) 98 #define SUN6I_DATE_SET_YEAR_VALUE(x) ((x) << 16 & 0x003f0000) 99 #define SUN6I_LEAP_SET_VALUE(x) ((x) << 22 & 0x00400000) 100 101 /* 102 * Set time values 103 */ 104 #define SUN6I_TIME_SET_SEC_VALUE(x) ((x) & 0x0000003f) 105 #define SUN6I_TIME_SET_MIN_VALUE(x) ((x) << 8 & 0x00003f00) 106 #define SUN6I_TIME_SET_HOUR_VALUE(x) ((x) << 16 & 0x001f0000) 107 108 /* 109 * The year parameter passed to the driver is usually an offset relative to 110 * the year 1900. This macro is used to convert this offset to another one 111 * relative to the minimum year allowed by the hardware. 112 * 113 * The year range is 1970 - 2033. This range is selected to match Allwinner's 114 * driver, even though it is somewhat limited. 115 */ 116 #define SUN6I_YEAR_MIN 1970 117 #define SUN6I_YEAR_OFF (SUN6I_YEAR_MIN - 1900) 118 119 #define SECS_PER_DAY (24 * 3600ULL) 120 121 /* 122 * There are other differences between models, including: 123 * 124 * - number of GPIO pins that can be configured to hold a certain level 125 * - crypto-key related registers (H5, H6) 126 * - boot process related (super standby, secondary processor entry address) 127 * registers (R40, H6) 128 * - SYS power domain controls (R40) 129 * - DCXO controls (H6) 130 * - RC oscillator calibration (H6) 131 * 132 * These functions are not covered by this driver. 133 */ 134 struct sun6i_rtc_clk_data { 135 unsigned long rc_osc_rate; 136 unsigned int fixed_prescaler : 16; 137 unsigned int has_prescaler : 1; 138 unsigned int has_out_clk : 1; 139 unsigned int export_iosc : 1; 140 unsigned int has_losc_en : 1; 141 unsigned int has_auto_swt : 1; 142 }; 143 144 #define RTC_LINEAR_DAY BIT(0) 145 146 struct sun6i_rtc_dev { 147 struct rtc_device *rtc; 148 const struct sun6i_rtc_clk_data *data; 149 void __iomem *base; 150 int irq; 151 time64_t alarm; 152 unsigned long flags; 153 154 struct clk_hw hw; 155 struct clk_hw *int_osc; 156 struct clk *losc; 157 struct clk *ext_losc; 158 159 spinlock_t lock; 160 }; 161 162 static struct sun6i_rtc_dev *sun6i_rtc; 163 164 static unsigned long sun6i_rtc_osc_recalc_rate(struct clk_hw *hw, 165 unsigned long parent_rate) 166 { 167 struct sun6i_rtc_dev *rtc = container_of(hw, struct sun6i_rtc_dev, hw); 168 u32 val = 0; 169 170 val = readl(rtc->base + SUN6I_LOSC_CTRL); 171 if (val & SUN6I_LOSC_CTRL_EXT_OSC) 172 return parent_rate; 173 174 if (rtc->data->fixed_prescaler) 175 parent_rate /= rtc->data->fixed_prescaler; 176 177 if (rtc->data->has_prescaler) { 178 val = readl(rtc->base + SUN6I_LOSC_CLK_PRESCAL); 179 val &= GENMASK(4, 0); 180 } 181 182 return parent_rate / (val + 1); 183 } 184 185 static u8 sun6i_rtc_osc_get_parent(struct clk_hw *hw) 186 { 187 struct sun6i_rtc_dev *rtc = container_of(hw, struct sun6i_rtc_dev, hw); 188 189 return readl(rtc->base + SUN6I_LOSC_CTRL) & SUN6I_LOSC_CTRL_EXT_OSC; 190 } 191 192 static int sun6i_rtc_osc_set_parent(struct clk_hw *hw, u8 index) 193 { 194 struct sun6i_rtc_dev *rtc = container_of(hw, struct sun6i_rtc_dev, hw); 195 unsigned long flags; 196 u32 val; 197 198 if (index > 1) 199 return -EINVAL; 200 201 spin_lock_irqsave(&rtc->lock, flags); 202 val = readl(rtc->base + SUN6I_LOSC_CTRL); 203 val &= ~SUN6I_LOSC_CTRL_EXT_OSC; 204 val |= SUN6I_LOSC_CTRL_KEY; 205 val |= index ? SUN6I_LOSC_CTRL_EXT_OSC : 0; 206 if (rtc->data->has_losc_en) { 207 val &= ~SUN6I_LOSC_CTRL_EXT_LOSC_EN; 208 val |= index ? SUN6I_LOSC_CTRL_EXT_LOSC_EN : 0; 209 } 210 writel(val, rtc->base + SUN6I_LOSC_CTRL); 211 spin_unlock_irqrestore(&rtc->lock, flags); 212 213 return 0; 214 } 215 216 static const struct clk_ops sun6i_rtc_osc_ops = { 217 .recalc_rate = sun6i_rtc_osc_recalc_rate, 218 219 .get_parent = sun6i_rtc_osc_get_parent, 220 .set_parent = sun6i_rtc_osc_set_parent, 221 }; 222 223 static void __init sun6i_rtc_clk_init(struct device_node *node, 224 const struct sun6i_rtc_clk_data *data) 225 { 226 struct clk_hw_onecell_data *clk_data; 227 struct sun6i_rtc_dev *rtc; 228 struct clk_init_data init = { 229 .ops = &sun6i_rtc_osc_ops, 230 .name = "losc", 231 }; 232 const char *iosc_name = "rtc-int-osc"; 233 const char *clkout_name = "osc32k-out"; 234 const char *parents[2]; 235 u32 reg; 236 237 rtc = kzalloc(sizeof(*rtc), GFP_KERNEL); 238 if (!rtc) 239 return; 240 241 rtc->data = data; 242 clk_data = kzalloc(struct_size(clk_data, hws, 3), GFP_KERNEL); 243 if (!clk_data) { 244 kfree(rtc); 245 return; 246 } 247 248 spin_lock_init(&rtc->lock); 249 250 rtc->base = of_io_request_and_map(node, 0, of_node_full_name(node)); 251 if (IS_ERR(rtc->base)) { 252 pr_crit("Can't map RTC registers"); 253 goto err; 254 } 255 256 reg = SUN6I_LOSC_CTRL_KEY; 257 if (rtc->data->has_auto_swt) { 258 /* Bypass auto-switch to int osc, on ext losc failure */ 259 reg |= SUN6I_LOSC_CTRL_AUTO_SWT_BYPASS; 260 writel(reg, rtc->base + SUN6I_LOSC_CTRL); 261 } 262 263 /* Switch to the external, more precise, oscillator, if present */ 264 if (of_get_property(node, "clocks", NULL)) { 265 reg |= SUN6I_LOSC_CTRL_EXT_OSC; 266 if (rtc->data->has_losc_en) 267 reg |= SUN6I_LOSC_CTRL_EXT_LOSC_EN; 268 } 269 writel(reg, rtc->base + SUN6I_LOSC_CTRL); 270 271 /* Yes, I know, this is ugly. */ 272 sun6i_rtc = rtc; 273 274 /* Only read IOSC name from device tree if it is exported */ 275 if (rtc->data->export_iosc) 276 of_property_read_string_index(node, "clock-output-names", 2, 277 &iosc_name); 278 279 rtc->int_osc = clk_hw_register_fixed_rate_with_accuracy(NULL, 280 iosc_name, 281 NULL, 0, 282 rtc->data->rc_osc_rate, 283 300000000); 284 if (IS_ERR(rtc->int_osc)) { 285 pr_crit("Couldn't register the internal oscillator\n"); 286 goto err; 287 } 288 289 parents[0] = clk_hw_get_name(rtc->int_osc); 290 /* If there is no external oscillator, this will be NULL and ... */ 291 parents[1] = of_clk_get_parent_name(node, 0); 292 293 rtc->hw.init = &init; 294 295 init.parent_names = parents; 296 /* ... number of clock parents will be 1. */ 297 init.num_parents = of_clk_get_parent_count(node) + 1; 298 of_property_read_string_index(node, "clock-output-names", 0, 299 &init.name); 300 301 rtc->losc = clk_register(NULL, &rtc->hw); 302 if (IS_ERR(rtc->losc)) { 303 pr_crit("Couldn't register the LOSC clock\n"); 304 goto err_register; 305 } 306 307 of_property_read_string_index(node, "clock-output-names", 1, 308 &clkout_name); 309 rtc->ext_losc = clk_register_gate(NULL, clkout_name, init.name, 310 0, rtc->base + SUN6I_LOSC_OUT_GATING, 311 SUN6I_LOSC_OUT_GATING_EN_OFFSET, 0, 312 &rtc->lock); 313 if (IS_ERR(rtc->ext_losc)) { 314 pr_crit("Couldn't register the LOSC external gate\n"); 315 goto err_register; 316 } 317 318 clk_data->num = 2; 319 clk_data->hws[0] = &rtc->hw; 320 clk_data->hws[1] = __clk_get_hw(rtc->ext_losc); 321 if (rtc->data->export_iosc) { 322 clk_data->hws[2] = rtc->int_osc; 323 clk_data->num = 3; 324 } 325 of_clk_add_hw_provider(node, of_clk_hw_onecell_get, clk_data); 326 return; 327 328 err_register: 329 clk_hw_unregister_fixed_rate(rtc->int_osc); 330 err: 331 kfree(clk_data); 332 } 333 334 static const struct sun6i_rtc_clk_data sun6i_a31_rtc_data = { 335 .rc_osc_rate = 667000, /* datasheet says 600 ~ 700 KHz */ 336 .has_prescaler = 1, 337 }; 338 339 static void __init sun6i_a31_rtc_clk_init(struct device_node *node) 340 { 341 sun6i_rtc_clk_init(node, &sun6i_a31_rtc_data); 342 } 343 CLK_OF_DECLARE_DRIVER(sun6i_a31_rtc_clk, "allwinner,sun6i-a31-rtc", 344 sun6i_a31_rtc_clk_init); 345 346 static const struct sun6i_rtc_clk_data sun8i_a23_rtc_data = { 347 .rc_osc_rate = 667000, /* datasheet says 600 ~ 700 KHz */ 348 .has_prescaler = 1, 349 .has_out_clk = 1, 350 }; 351 352 static void __init sun8i_a23_rtc_clk_init(struct device_node *node) 353 { 354 sun6i_rtc_clk_init(node, &sun8i_a23_rtc_data); 355 } 356 CLK_OF_DECLARE_DRIVER(sun8i_a23_rtc_clk, "allwinner,sun8i-a23-rtc", 357 sun8i_a23_rtc_clk_init); 358 359 static const struct sun6i_rtc_clk_data sun8i_h3_rtc_data = { 360 .rc_osc_rate = 16000000, 361 .fixed_prescaler = 32, 362 .has_prescaler = 1, 363 .has_out_clk = 1, 364 .export_iosc = 1, 365 }; 366 367 static void __init sun8i_h3_rtc_clk_init(struct device_node *node) 368 { 369 sun6i_rtc_clk_init(node, &sun8i_h3_rtc_data); 370 } 371 CLK_OF_DECLARE_DRIVER(sun8i_h3_rtc_clk, "allwinner,sun8i-h3-rtc", 372 sun8i_h3_rtc_clk_init); 373 /* As far as we are concerned, clocks for H5 are the same as H3 */ 374 CLK_OF_DECLARE_DRIVER(sun50i_h5_rtc_clk, "allwinner,sun50i-h5-rtc", 375 sun8i_h3_rtc_clk_init); 376 377 /* 378 * The R40 user manual is self-conflicting on whether the prescaler is 379 * fixed or configurable. The clock diagram shows it as fixed, but there 380 * is also a configurable divider in the RTC block. 381 */ 382 static const struct sun6i_rtc_clk_data sun8i_r40_rtc_data = { 383 .rc_osc_rate = 16000000, 384 .fixed_prescaler = 512, 385 }; 386 static void __init sun8i_r40_rtc_clk_init(struct device_node *node) 387 { 388 sun6i_rtc_clk_init(node, &sun8i_r40_rtc_data); 389 } 390 CLK_OF_DECLARE_DRIVER(sun8i_r40_rtc_clk, "allwinner,sun8i-r40-rtc", 391 sun8i_r40_rtc_clk_init); 392 393 static const struct sun6i_rtc_clk_data sun8i_v3_rtc_data = { 394 .rc_osc_rate = 32000, 395 .has_out_clk = 1, 396 }; 397 398 static void __init sun8i_v3_rtc_clk_init(struct device_node *node) 399 { 400 sun6i_rtc_clk_init(node, &sun8i_v3_rtc_data); 401 } 402 CLK_OF_DECLARE_DRIVER(sun8i_v3_rtc_clk, "allwinner,sun8i-v3-rtc", 403 sun8i_v3_rtc_clk_init); 404 405 static irqreturn_t sun6i_rtc_alarmirq(int irq, void *id) 406 { 407 struct sun6i_rtc_dev *chip = (struct sun6i_rtc_dev *) id; 408 irqreturn_t ret = IRQ_NONE; 409 u32 val; 410 411 spin_lock(&chip->lock); 412 val = readl(chip->base + SUN6I_ALRM_IRQ_STA); 413 414 if (val & SUN6I_ALRM_IRQ_STA_CNT_IRQ_PEND) { 415 val |= SUN6I_ALRM_IRQ_STA_CNT_IRQ_PEND; 416 writel(val, chip->base + SUN6I_ALRM_IRQ_STA); 417 418 rtc_update_irq(chip->rtc, 1, RTC_AF | RTC_IRQF); 419 420 ret = IRQ_HANDLED; 421 } 422 spin_unlock(&chip->lock); 423 424 return ret; 425 } 426 427 static void sun6i_rtc_setaie(int to, struct sun6i_rtc_dev *chip) 428 { 429 u32 alrm_val = 0; 430 u32 alrm_irq_val = 0; 431 u32 alrm_wake_val = 0; 432 unsigned long flags; 433 434 if (to) { 435 alrm_val = SUN6I_ALRM_EN_CNT_EN; 436 alrm_irq_val = SUN6I_ALRM_IRQ_EN_CNT_IRQ_EN; 437 alrm_wake_val = SUN6I_ALARM_CONFIG_WAKEUP; 438 } else { 439 writel(SUN6I_ALRM_IRQ_STA_CNT_IRQ_PEND, 440 chip->base + SUN6I_ALRM_IRQ_STA); 441 } 442 443 spin_lock_irqsave(&chip->lock, flags); 444 writel(alrm_val, chip->base + SUN6I_ALRM_EN); 445 writel(alrm_irq_val, chip->base + SUN6I_ALRM_IRQ_EN); 446 writel(alrm_wake_val, chip->base + SUN6I_ALARM_CONFIG); 447 spin_unlock_irqrestore(&chip->lock, flags); 448 } 449 450 static int sun6i_rtc_gettime(struct device *dev, struct rtc_time *rtc_tm) 451 { 452 struct sun6i_rtc_dev *chip = dev_get_drvdata(dev); 453 u32 date, time; 454 455 /* 456 * read again in case it changes 457 */ 458 do { 459 date = readl(chip->base + SUN6I_RTC_YMD); 460 time = readl(chip->base + SUN6I_RTC_HMS); 461 } while ((date != readl(chip->base + SUN6I_RTC_YMD)) || 462 (time != readl(chip->base + SUN6I_RTC_HMS))); 463 464 if (chip->flags & RTC_LINEAR_DAY) { 465 /* 466 * Newer chips store a linear day number, the manual 467 * does not mandate any epoch base. The BSP driver uses 468 * the UNIX epoch, let's just copy that, as it's the 469 * easiest anyway. 470 */ 471 rtc_time64_to_tm((date & 0xffff) * SECS_PER_DAY, rtc_tm); 472 } else { 473 rtc_tm->tm_mday = SUN6I_DATE_GET_DAY_VALUE(date); 474 rtc_tm->tm_mon = SUN6I_DATE_GET_MON_VALUE(date) - 1; 475 rtc_tm->tm_year = SUN6I_DATE_GET_YEAR_VALUE(date); 476 477 /* 478 * switch from (data_year->min)-relative offset to 479 * a (1900)-relative one 480 */ 481 rtc_tm->tm_year += SUN6I_YEAR_OFF; 482 } 483 484 rtc_tm->tm_sec = SUN6I_TIME_GET_SEC_VALUE(time); 485 rtc_tm->tm_min = SUN6I_TIME_GET_MIN_VALUE(time); 486 rtc_tm->tm_hour = SUN6I_TIME_GET_HOUR_VALUE(time); 487 488 return 0; 489 } 490 491 static int sun6i_rtc_getalarm(struct device *dev, struct rtc_wkalrm *wkalrm) 492 { 493 struct sun6i_rtc_dev *chip = dev_get_drvdata(dev); 494 unsigned long flags; 495 u32 alrm_st; 496 u32 alrm_en; 497 498 spin_lock_irqsave(&chip->lock, flags); 499 alrm_en = readl(chip->base + SUN6I_ALRM_IRQ_EN); 500 alrm_st = readl(chip->base + SUN6I_ALRM_IRQ_STA); 501 spin_unlock_irqrestore(&chip->lock, flags); 502 503 wkalrm->enabled = !!(alrm_en & SUN6I_ALRM_EN_CNT_EN); 504 wkalrm->pending = !!(alrm_st & SUN6I_ALRM_EN_CNT_EN); 505 rtc_time64_to_tm(chip->alarm, &wkalrm->time); 506 507 return 0; 508 } 509 510 static int sun6i_rtc_setalarm(struct device *dev, struct rtc_wkalrm *wkalrm) 511 { 512 struct sun6i_rtc_dev *chip = dev_get_drvdata(dev); 513 struct rtc_time *alrm_tm = &wkalrm->time; 514 struct rtc_time tm_now; 515 time64_t time_set; 516 u32 counter_val, counter_val_hms; 517 int ret; 518 519 time_set = rtc_tm_to_time64(alrm_tm); 520 521 if (chip->flags & RTC_LINEAR_DAY) { 522 /* 523 * The alarm registers hold the actual alarm time, encoded 524 * in the same way (linear day + HMS) as the current time. 525 */ 526 counter_val_hms = SUN6I_TIME_SET_SEC_VALUE(alrm_tm->tm_sec) | 527 SUN6I_TIME_SET_MIN_VALUE(alrm_tm->tm_min) | 528 SUN6I_TIME_SET_HOUR_VALUE(alrm_tm->tm_hour); 529 /* The division will cut off the H:M:S part of alrm_tm. */ 530 counter_val = div_u64(rtc_tm_to_time64(alrm_tm), SECS_PER_DAY); 531 } else { 532 /* The alarm register holds the number of seconds left. */ 533 time64_t time_now; 534 535 ret = sun6i_rtc_gettime(dev, &tm_now); 536 if (ret < 0) { 537 dev_err(dev, "Error in getting time\n"); 538 return -EINVAL; 539 } 540 541 time_now = rtc_tm_to_time64(&tm_now); 542 if (time_set <= time_now) { 543 dev_err(dev, "Date to set in the past\n"); 544 return -EINVAL; 545 } 546 if ((time_set - time_now) > U32_MAX) { 547 dev_err(dev, "Date too far in the future\n"); 548 return -EINVAL; 549 } 550 551 counter_val = time_set - time_now; 552 } 553 554 sun6i_rtc_setaie(0, chip); 555 writel(0, chip->base + SUN6I_ALRM_COUNTER); 556 if (chip->flags & RTC_LINEAR_DAY) 557 writel(0, chip->base + SUN6I_ALRM_COUNTER_HMS); 558 usleep_range(100, 300); 559 560 writel(counter_val, chip->base + SUN6I_ALRM_COUNTER); 561 if (chip->flags & RTC_LINEAR_DAY) 562 writel(counter_val_hms, chip->base + SUN6I_ALRM_COUNTER_HMS); 563 chip->alarm = time_set; 564 565 sun6i_rtc_setaie(wkalrm->enabled, chip); 566 567 return 0; 568 } 569 570 static int sun6i_rtc_wait(struct sun6i_rtc_dev *chip, int offset, 571 unsigned int mask, unsigned int ms_timeout) 572 { 573 const unsigned long timeout = jiffies + msecs_to_jiffies(ms_timeout); 574 u32 reg; 575 576 do { 577 reg = readl(chip->base + offset); 578 reg &= mask; 579 580 if (!reg) 581 return 0; 582 583 } while (time_before(jiffies, timeout)); 584 585 return -ETIMEDOUT; 586 } 587 588 static int sun6i_rtc_settime(struct device *dev, struct rtc_time *rtc_tm) 589 { 590 struct sun6i_rtc_dev *chip = dev_get_drvdata(dev); 591 u32 date = 0; 592 u32 time = 0; 593 594 time = SUN6I_TIME_SET_SEC_VALUE(rtc_tm->tm_sec) | 595 SUN6I_TIME_SET_MIN_VALUE(rtc_tm->tm_min) | 596 SUN6I_TIME_SET_HOUR_VALUE(rtc_tm->tm_hour); 597 598 if (chip->flags & RTC_LINEAR_DAY) { 599 /* The division will cut off the H:M:S part of rtc_tm. */ 600 date = div_u64(rtc_tm_to_time64(rtc_tm), SECS_PER_DAY); 601 } else { 602 rtc_tm->tm_year -= SUN6I_YEAR_OFF; 603 rtc_tm->tm_mon += 1; 604 605 date = SUN6I_DATE_SET_DAY_VALUE(rtc_tm->tm_mday) | 606 SUN6I_DATE_SET_MON_VALUE(rtc_tm->tm_mon) | 607 SUN6I_DATE_SET_YEAR_VALUE(rtc_tm->tm_year); 608 609 if (is_leap_year(rtc_tm->tm_year + SUN6I_YEAR_MIN)) 610 date |= SUN6I_LEAP_SET_VALUE(1); 611 } 612 613 /* Check whether registers are writable */ 614 if (sun6i_rtc_wait(chip, SUN6I_LOSC_CTRL, 615 SUN6I_LOSC_CTRL_ACC_MASK, 50)) { 616 dev_err(dev, "rtc is still busy.\n"); 617 return -EBUSY; 618 } 619 620 writel(time, chip->base + SUN6I_RTC_HMS); 621 622 /* 623 * After writing the RTC HH-MM-SS register, the 624 * SUN6I_LOSC_CTRL_RTC_HMS_ACC bit is set and it will not 625 * be cleared until the real writing operation is finished 626 */ 627 628 if (sun6i_rtc_wait(chip, SUN6I_LOSC_CTRL, 629 SUN6I_LOSC_CTRL_RTC_HMS_ACC, 50)) { 630 dev_err(dev, "Failed to set rtc time.\n"); 631 return -ETIMEDOUT; 632 } 633 634 writel(date, chip->base + SUN6I_RTC_YMD); 635 636 /* 637 * After writing the RTC YY-MM-DD register, the 638 * SUN6I_LOSC_CTRL_RTC_YMD_ACC bit is set and it will not 639 * be cleared until the real writing operation is finished 640 */ 641 642 if (sun6i_rtc_wait(chip, SUN6I_LOSC_CTRL, 643 SUN6I_LOSC_CTRL_RTC_YMD_ACC, 50)) { 644 dev_err(dev, "Failed to set rtc time.\n"); 645 return -ETIMEDOUT; 646 } 647 648 return 0; 649 } 650 651 static int sun6i_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled) 652 { 653 struct sun6i_rtc_dev *chip = dev_get_drvdata(dev); 654 655 if (!enabled) 656 sun6i_rtc_setaie(enabled, chip); 657 658 return 0; 659 } 660 661 static const struct rtc_class_ops sun6i_rtc_ops = { 662 .read_time = sun6i_rtc_gettime, 663 .set_time = sun6i_rtc_settime, 664 .read_alarm = sun6i_rtc_getalarm, 665 .set_alarm = sun6i_rtc_setalarm, 666 .alarm_irq_enable = sun6i_rtc_alarm_irq_enable 667 }; 668 669 static int sun6i_rtc_nvmem_read(void *priv, unsigned int offset, void *_val, size_t bytes) 670 { 671 struct sun6i_rtc_dev *chip = priv; 672 u32 *val = _val; 673 int i; 674 675 for (i = 0; i < bytes / 4; ++i) 676 val[i] = readl(chip->base + SUN6I_GP_DATA + offset + 4 * i); 677 678 return 0; 679 } 680 681 static int sun6i_rtc_nvmem_write(void *priv, unsigned int offset, void *_val, size_t bytes) 682 { 683 struct sun6i_rtc_dev *chip = priv; 684 u32 *val = _val; 685 int i; 686 687 for (i = 0; i < bytes / 4; ++i) 688 writel(val[i], chip->base + SUN6I_GP_DATA + offset + 4 * i); 689 690 return 0; 691 } 692 693 static struct nvmem_config sun6i_rtc_nvmem_cfg = { 694 .type = NVMEM_TYPE_BATTERY_BACKED, 695 .reg_read = sun6i_rtc_nvmem_read, 696 .reg_write = sun6i_rtc_nvmem_write, 697 .size = SUN6I_GP_DATA_SIZE, 698 .word_size = 4, 699 .stride = 4, 700 }; 701 702 #ifdef CONFIG_PM_SLEEP 703 /* Enable IRQ wake on suspend, to wake up from RTC. */ 704 static int sun6i_rtc_suspend(struct device *dev) 705 { 706 struct sun6i_rtc_dev *chip = dev_get_drvdata(dev); 707 708 if (device_may_wakeup(dev)) 709 enable_irq_wake(chip->irq); 710 711 return 0; 712 } 713 714 /* Disable IRQ wake on resume. */ 715 static int sun6i_rtc_resume(struct device *dev) 716 { 717 struct sun6i_rtc_dev *chip = dev_get_drvdata(dev); 718 719 if (device_may_wakeup(dev)) 720 disable_irq_wake(chip->irq); 721 722 return 0; 723 } 724 #endif 725 726 static SIMPLE_DEV_PM_OPS(sun6i_rtc_pm_ops, 727 sun6i_rtc_suspend, sun6i_rtc_resume); 728 729 static void sun6i_rtc_bus_clk_cleanup(void *data) 730 { 731 struct clk *bus_clk = data; 732 733 clk_disable_unprepare(bus_clk); 734 } 735 736 static int sun6i_rtc_probe(struct platform_device *pdev) 737 { 738 struct sun6i_rtc_dev *chip = sun6i_rtc; 739 struct device *dev = &pdev->dev; 740 struct clk *bus_clk; 741 int ret; 742 743 bus_clk = devm_clk_get_optional(dev, "bus"); 744 if (IS_ERR(bus_clk)) 745 return PTR_ERR(bus_clk); 746 747 if (bus_clk) { 748 ret = clk_prepare_enable(bus_clk); 749 if (ret) 750 return ret; 751 752 ret = devm_add_action_or_reset(dev, sun6i_rtc_bus_clk_cleanup, 753 bus_clk); 754 if (ret) 755 return ret; 756 } 757 758 if (!chip) { 759 chip = devm_kzalloc(&pdev->dev, sizeof(*chip), GFP_KERNEL); 760 if (!chip) 761 return -ENOMEM; 762 763 spin_lock_init(&chip->lock); 764 765 chip->base = devm_platform_ioremap_resource(pdev, 0); 766 if (IS_ERR(chip->base)) 767 return PTR_ERR(chip->base); 768 769 if (IS_REACHABLE(CONFIG_SUN6I_RTC_CCU)) { 770 ret = sun6i_rtc_ccu_probe(dev, chip->base); 771 if (ret) 772 return ret; 773 } 774 } 775 776 platform_set_drvdata(pdev, chip); 777 778 chip->flags = (unsigned long)of_device_get_match_data(&pdev->dev); 779 780 chip->irq = platform_get_irq(pdev, 0); 781 if (chip->irq < 0) 782 return chip->irq; 783 784 ret = devm_request_irq(&pdev->dev, chip->irq, sun6i_rtc_alarmirq, 785 0, dev_name(&pdev->dev), chip); 786 if (ret) { 787 dev_err(&pdev->dev, "Could not request IRQ\n"); 788 return ret; 789 } 790 791 /* clear the alarm counter value */ 792 writel(0, chip->base + SUN6I_ALRM_COUNTER); 793 794 /* disable counter alarm */ 795 writel(0, chip->base + SUN6I_ALRM_EN); 796 797 /* disable counter alarm interrupt */ 798 writel(0, chip->base + SUN6I_ALRM_IRQ_EN); 799 800 /* disable week alarm */ 801 writel(0, chip->base + SUN6I_ALRM1_EN); 802 803 /* disable week alarm interrupt */ 804 writel(0, chip->base + SUN6I_ALRM1_IRQ_EN); 805 806 /* clear counter alarm pending interrupts */ 807 writel(SUN6I_ALRM_IRQ_STA_CNT_IRQ_PEND, 808 chip->base + SUN6I_ALRM_IRQ_STA); 809 810 /* clear week alarm pending interrupts */ 811 writel(SUN6I_ALRM1_IRQ_STA_WEEK_IRQ_PEND, 812 chip->base + SUN6I_ALRM1_IRQ_STA); 813 814 /* disable alarm wakeup */ 815 writel(0, chip->base + SUN6I_ALARM_CONFIG); 816 817 clk_prepare_enable(chip->losc); 818 819 device_init_wakeup(&pdev->dev, 1); 820 821 chip->rtc = devm_rtc_allocate_device(&pdev->dev); 822 if (IS_ERR(chip->rtc)) 823 return PTR_ERR(chip->rtc); 824 825 chip->rtc->ops = &sun6i_rtc_ops; 826 if (chip->flags & RTC_LINEAR_DAY) 827 chip->rtc->range_max = (65536 * SECS_PER_DAY) - 1; 828 else 829 chip->rtc->range_max = 2019686399LL; /* 2033-12-31 23:59:59 */ 830 831 ret = devm_rtc_register_device(chip->rtc); 832 if (ret) 833 return ret; 834 835 sun6i_rtc_nvmem_cfg.priv = chip; 836 ret = devm_rtc_nvmem_register(chip->rtc, &sun6i_rtc_nvmem_cfg); 837 if (ret) 838 return ret; 839 840 dev_info(&pdev->dev, "RTC enabled\n"); 841 842 return 0; 843 } 844 845 /* 846 * As far as RTC functionality goes, all models are the same. The 847 * datasheets claim that different models have different number of 848 * registers available for non-volatile storage, but experiments show 849 * that all SoCs have 16 registers available for this purpose. 850 */ 851 static const struct of_device_id sun6i_rtc_dt_ids[] = { 852 { .compatible = "allwinner,sun6i-a31-rtc" }, 853 { .compatible = "allwinner,sun8i-a23-rtc" }, 854 { .compatible = "allwinner,sun8i-h3-rtc" }, 855 { .compatible = "allwinner,sun8i-r40-rtc" }, 856 { .compatible = "allwinner,sun8i-v3-rtc" }, 857 { .compatible = "allwinner,sun50i-h5-rtc" }, 858 { .compatible = "allwinner,sun50i-h6-rtc" }, 859 { .compatible = "allwinner,sun50i-h616-rtc", 860 .data = (void *)RTC_LINEAR_DAY }, 861 { /* sentinel */ }, 862 }; 863 MODULE_DEVICE_TABLE(of, sun6i_rtc_dt_ids); 864 865 static struct platform_driver sun6i_rtc_driver = { 866 .probe = sun6i_rtc_probe, 867 .driver = { 868 .name = "sun6i-rtc", 869 .of_match_table = sun6i_rtc_dt_ids, 870 .pm = &sun6i_rtc_pm_ops, 871 }, 872 }; 873 builtin_platform_driver(sun6i_rtc_driver); 874