linux/drivers/rtc/rtc-mv.c
<<
>>
Prefs
   1/*
   2 * Driver for the RTC in Marvell SoCs.
   3 *
   4 * This file is licensed under the terms of the GNU General Public
   5 * License version 2.  This program is licensed "as is" without any
   6 * warranty of any kind, whether express or implied.
   7 */
   8
   9#include <linux/init.h>
  10#include <linux/kernel.h>
  11#include <linux/rtc.h>
  12#include <linux/bcd.h>
  13#include <linux/bitops.h>
  14#include <linux/io.h>
  15#include <linux/platform_device.h>
  16#include <linux/of.h>
  17#include <linux/delay.h>
  18#include <linux/clk.h>
  19#include <linux/gfp.h>
  20#include <linux/module.h>
  21
  22
  23#define RTC_TIME_REG_OFFS       0
  24#define RTC_SECONDS_OFFS        0
  25#define RTC_MINUTES_OFFS        8
  26#define RTC_HOURS_OFFS          16
  27#define RTC_WDAY_OFFS           24
  28#define RTC_HOURS_12H_MODE      BIT(22) /* 12 hour mode */
  29
  30#define RTC_DATE_REG_OFFS       4
  31#define RTC_MDAY_OFFS           0
  32#define RTC_MONTH_OFFS          8
  33#define RTC_YEAR_OFFS           16
  34
  35#define RTC_ALARM_TIME_REG_OFFS 8
  36#define RTC_ALARM_DATE_REG_OFFS 0xc
  37#define RTC_ALARM_VALID         BIT(7)
  38
  39#define RTC_ALARM_INTERRUPT_MASK_REG_OFFS       0x10
  40#define RTC_ALARM_INTERRUPT_CASUE_REG_OFFS      0x14
  41
  42struct rtc_plat_data {
  43        struct rtc_device *rtc;
  44        void __iomem *ioaddr;
  45        int             irq;
  46        struct clk      *clk;
  47};
  48
  49static int mv_rtc_set_time(struct device *dev, struct rtc_time *tm)
  50{
  51        struct rtc_plat_data *pdata = dev_get_drvdata(dev);
  52        void __iomem *ioaddr = pdata->ioaddr;
  53        u32     rtc_reg;
  54
  55        rtc_reg = (bin2bcd(tm->tm_sec) << RTC_SECONDS_OFFS) |
  56                (bin2bcd(tm->tm_min) << RTC_MINUTES_OFFS) |
  57                (bin2bcd(tm->tm_hour) << RTC_HOURS_OFFS) |
  58                (bin2bcd(tm->tm_wday) << RTC_WDAY_OFFS);
  59        writel(rtc_reg, ioaddr + RTC_TIME_REG_OFFS);
  60
  61        rtc_reg = (bin2bcd(tm->tm_mday) << RTC_MDAY_OFFS) |
  62                (bin2bcd(tm->tm_mon + 1) << RTC_MONTH_OFFS) |
  63                (bin2bcd(tm->tm_year % 100) << RTC_YEAR_OFFS);
  64        writel(rtc_reg, ioaddr + RTC_DATE_REG_OFFS);
  65
  66        return 0;
  67}
  68
  69static int mv_rtc_read_time(struct device *dev, struct rtc_time *tm)
  70{
  71        struct rtc_plat_data *pdata = dev_get_drvdata(dev);
  72        void __iomem *ioaddr = pdata->ioaddr;
  73        u32     rtc_time, rtc_date;
  74        unsigned int year, month, day, hour, minute, second, wday;
  75
  76        rtc_time = readl(ioaddr + RTC_TIME_REG_OFFS);
  77        rtc_date = readl(ioaddr + RTC_DATE_REG_OFFS);
  78
  79        second = rtc_time & 0x7f;
  80        minute = (rtc_time >> RTC_MINUTES_OFFS) & 0x7f;
  81        hour = (rtc_time >> RTC_HOURS_OFFS) & 0x3f; /* assume 24 hour mode */
  82        wday = (rtc_time >> RTC_WDAY_OFFS) & 0x7;
  83
  84        day = rtc_date & 0x3f;
  85        month = (rtc_date >> RTC_MONTH_OFFS) & 0x3f;
  86        year = (rtc_date >> RTC_YEAR_OFFS) & 0xff;
  87
  88        tm->tm_sec = bcd2bin(second);
  89        tm->tm_min = bcd2bin(minute);
  90        tm->tm_hour = bcd2bin(hour);
  91        tm->tm_mday = bcd2bin(day);
  92        tm->tm_wday = bcd2bin(wday);
  93        tm->tm_mon = bcd2bin(month) - 1;
  94        /* hw counts from year 2000, but tm_year is relative to 1900 */
  95        tm->tm_year = bcd2bin(year) + 100;
  96
  97        return 0;
  98}
  99
 100static int mv_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alm)
 101{
 102        struct rtc_plat_data *pdata = dev_get_drvdata(dev);
 103        void __iomem *ioaddr = pdata->ioaddr;
 104        u32     rtc_time, rtc_date;
 105        unsigned int year, month, day, hour, minute, second, wday;
 106
 107        rtc_time = readl(ioaddr + RTC_ALARM_TIME_REG_OFFS);
 108        rtc_date = readl(ioaddr + RTC_ALARM_DATE_REG_OFFS);
 109
 110        second = rtc_time & 0x7f;
 111        minute = (rtc_time >> RTC_MINUTES_OFFS) & 0x7f;
 112        hour = (rtc_time >> RTC_HOURS_OFFS) & 0x3f; /* assume 24 hour mode */
 113        wday = (rtc_time >> RTC_WDAY_OFFS) & 0x7;
 114
 115        day = rtc_date & 0x3f;
 116        month = (rtc_date >> RTC_MONTH_OFFS) & 0x3f;
 117        year = (rtc_date >> RTC_YEAR_OFFS) & 0xff;
 118
 119        alm->time.tm_sec = bcd2bin(second);
 120        alm->time.tm_min = bcd2bin(minute);
 121        alm->time.tm_hour = bcd2bin(hour);
 122        alm->time.tm_mday = bcd2bin(day);
 123        alm->time.tm_wday = bcd2bin(wday);
 124        alm->time.tm_mon = bcd2bin(month) - 1;
 125        /* hw counts from year 2000, but tm_year is relative to 1900 */
 126        alm->time.tm_year = bcd2bin(year) + 100;
 127
 128        if (rtc_valid_tm(&alm->time) < 0) {
 129                dev_err(dev, "retrieved alarm date/time is not valid.\n");
 130                rtc_time_to_tm(0, &alm->time);
 131        }
 132
 133        alm->enabled = !!readl(ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS);
 134        return 0;
 135}
 136
 137static int mv_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alm)
 138{
 139        struct rtc_plat_data *pdata = dev_get_drvdata(dev);
 140        void __iomem *ioaddr = pdata->ioaddr;
 141        u32 rtc_reg = 0;
 142
 143        if (alm->time.tm_sec >= 0)
 144                rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_sec))
 145                        << RTC_SECONDS_OFFS;
 146        if (alm->time.tm_min >= 0)
 147                rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_min))
 148                        << RTC_MINUTES_OFFS;
 149        if (alm->time.tm_hour >= 0)
 150                rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_hour))
 151                        << RTC_HOURS_OFFS;
 152
 153        writel(rtc_reg, ioaddr + RTC_ALARM_TIME_REG_OFFS);
 154
 155        if (alm->time.tm_mday >= 0)
 156                rtc_reg = (RTC_ALARM_VALID | bin2bcd(alm->time.tm_mday))
 157                        << RTC_MDAY_OFFS;
 158        else
 159                rtc_reg = 0;
 160
 161        if (alm->time.tm_mon >= 0)
 162                rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_mon + 1))
 163                        << RTC_MONTH_OFFS;
 164
 165        if (alm->time.tm_year >= 0)
 166                rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_year % 100))
 167                        << RTC_YEAR_OFFS;
 168
 169        writel(rtc_reg, ioaddr + RTC_ALARM_DATE_REG_OFFS);
 170        writel(0, ioaddr + RTC_ALARM_INTERRUPT_CASUE_REG_OFFS);
 171        writel(alm->enabled ? 1 : 0,
 172               ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS);
 173
 174        return 0;
 175}
 176
 177static int mv_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
 178{
 179        struct rtc_plat_data *pdata = dev_get_drvdata(dev);
 180        void __iomem *ioaddr = pdata->ioaddr;
 181
 182        if (pdata->irq < 0)
 183                return -EINVAL; /* fall back into rtc-dev's emulation */
 184
 185        if (enabled)
 186                writel(1, ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS);
 187        else
 188                writel(0, ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS);
 189        return 0;
 190}
 191
 192static irqreturn_t mv_rtc_interrupt(int irq, void *data)
 193{
 194        struct rtc_plat_data *pdata = data;
 195        void __iomem *ioaddr = pdata->ioaddr;
 196
 197        /* alarm irq? */
 198        if (!readl(ioaddr + RTC_ALARM_INTERRUPT_CASUE_REG_OFFS))
 199                return IRQ_NONE;
 200
 201        /* clear interrupt */
 202        writel(0, ioaddr + RTC_ALARM_INTERRUPT_CASUE_REG_OFFS);
 203        rtc_update_irq(pdata->rtc, 1, RTC_IRQF | RTC_AF);
 204        return IRQ_HANDLED;
 205}
 206
 207static const struct rtc_class_ops mv_rtc_ops = {
 208        .read_time      = mv_rtc_read_time,
 209        .set_time       = mv_rtc_set_time,
 210};
 211
 212static const struct rtc_class_ops mv_rtc_alarm_ops = {
 213        .read_time      = mv_rtc_read_time,
 214        .set_time       = mv_rtc_set_time,
 215        .read_alarm     = mv_rtc_read_alarm,
 216        .set_alarm      = mv_rtc_set_alarm,
 217        .alarm_irq_enable = mv_rtc_alarm_irq_enable,
 218};
 219
 220static int __init mv_rtc_probe(struct platform_device *pdev)
 221{
 222        struct resource *res;
 223        struct rtc_plat_data *pdata;
 224        u32 rtc_time;
 225        int ret = 0;
 226
 227        pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
 228        if (!pdata)
 229                return -ENOMEM;
 230
 231        res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 232        pdata->ioaddr = devm_ioremap_resource(&pdev->dev, res);
 233        if (IS_ERR(pdata->ioaddr))
 234                return PTR_ERR(pdata->ioaddr);
 235
 236        pdata->clk = devm_clk_get(&pdev->dev, NULL);
 237        /* Not all SoCs require a clock.*/
 238        if (!IS_ERR(pdata->clk))
 239                clk_prepare_enable(pdata->clk);
 240
 241        /* make sure the 24 hour mode is enabled */
 242        rtc_time = readl(pdata->ioaddr + RTC_TIME_REG_OFFS);
 243        if (rtc_time & RTC_HOURS_12H_MODE) {
 244                dev_err(&pdev->dev, "12 Hour mode is enabled but not supported.\n");
 245                ret = -EINVAL;
 246                goto out;
 247        }
 248
 249        /* make sure it is actually functional */
 250        if (rtc_time == 0x01000000) {
 251                ssleep(1);
 252                rtc_time = readl(pdata->ioaddr + RTC_TIME_REG_OFFS);
 253                if (rtc_time == 0x01000000) {
 254                        dev_err(&pdev->dev, "internal RTC not ticking\n");
 255                        ret = -ENODEV;
 256                        goto out;
 257                }
 258        }
 259
 260        pdata->irq = platform_get_irq(pdev, 0);
 261
 262        platform_set_drvdata(pdev, pdata);
 263
 264        if (pdata->irq >= 0) {
 265                device_init_wakeup(&pdev->dev, 1);
 266                pdata->rtc = devm_rtc_device_register(&pdev->dev, pdev->name,
 267                                                 &mv_rtc_alarm_ops,
 268                                                 THIS_MODULE);
 269        } else {
 270                pdata->rtc = devm_rtc_device_register(&pdev->dev, pdev->name,
 271                                                 &mv_rtc_ops, THIS_MODULE);
 272        }
 273        if (IS_ERR(pdata->rtc)) {
 274                ret = PTR_ERR(pdata->rtc);
 275                goto out;
 276        }
 277
 278        if (pdata->irq >= 0) {
 279                writel(0, pdata->ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS);
 280                if (devm_request_irq(&pdev->dev, pdata->irq, mv_rtc_interrupt,
 281                                     IRQF_SHARED,
 282                                     pdev->name, pdata) < 0) {
 283                        dev_warn(&pdev->dev, "interrupt not available.\n");
 284                        pdata->irq = -1;
 285                }
 286        }
 287
 288        return 0;
 289out:
 290        if (!IS_ERR(pdata->clk))
 291                clk_disable_unprepare(pdata->clk);
 292
 293        return ret;
 294}
 295
 296static int __exit mv_rtc_remove(struct platform_device *pdev)
 297{
 298        struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
 299
 300        if (pdata->irq >= 0)
 301                device_init_wakeup(&pdev->dev, 0);
 302
 303        if (!IS_ERR(pdata->clk))
 304                clk_disable_unprepare(pdata->clk);
 305
 306        return 0;
 307}
 308
 309#ifdef CONFIG_OF
 310static const struct of_device_id rtc_mv_of_match_table[] = {
 311        { .compatible = "marvell,orion-rtc", },
 312        {}
 313};
 314MODULE_DEVICE_TABLE(of, rtc_mv_of_match_table);
 315#endif
 316
 317static struct platform_driver mv_rtc_driver = {
 318        .remove         = __exit_p(mv_rtc_remove),
 319        .driver         = {
 320                .name   = "rtc-mv",
 321                .of_match_table = of_match_ptr(rtc_mv_of_match_table),
 322        },
 323};
 324
 325module_platform_driver_probe(mv_rtc_driver, mv_rtc_probe);
 326
 327MODULE_AUTHOR("Saeed Bishara <saeed@marvell.com>");
 328MODULE_DESCRIPTION("Marvell RTC driver");
 329MODULE_LICENSE("GPL");
 330MODULE_ALIAS("platform:rtc-mv");
 331