rtc/ds1306.c

   1 /*
   2  * (C) Copyright 2002 SIXNET, dge@sixnetio.com.
   3  *
   4  * (C) Copyright 2004, Li-Pro.Net <www.li-pro.net>
   5  * Stephan Linz <linz@li-pro.net>
   6  *
   7  * See file CREDITS for list of people who contributed to this
   8  * project.
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License as
  12  * published by the Free Software Foundation; either version 2 of
  13  * the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  23  * MA 02111-1307 USA
  24  */
  25
  26 /*
  27  * Date & Time support for DS1306 RTC using SPI:
  28  *
  29  *    - SXNI855T:    it uses its own soft SPI here in this file
  30  *    - all other:   use the external spi_xfer() function
  31  *                   (see include/spi.h)
  32  */
  33
  34 #include <common.h>
  35 #include <command.h>
  36 #include <rtc.h>
  37 #include <spi.h>
  38
  39 #if defined(CONFIG_RTC_DS1306) && (CONFIG_COMMANDS & CFG_CMD_DATE)
  40
  41 #define RTC_SECONDS             0x00
  42 #define RTC_MINUTES             0x01
  43 #define RTC_HOURS               0x02
  44 #define RTC_DAY_OF_WEEK         0x03
  45 #define RTC_DATE_OF_MONTH       0x04
  46 #define RTC_MONTH               0x05
  47 #define RTC_YEAR                0x06
  48
  49 #define RTC_SECONDS_ALARM0      0x07
  50 #define RTC_MINUTES_ALARM0      0x08
  51 #define RTC_HOURS_ALARM0        0x09
  52 #define RTC_DAY_OF_WEEK_ALARM0  0x0a
  53
  54 #define RTC_SECONDS_ALARM1      0x0b
  55 #define RTC_MINUTES_ALARM1      0x0c
  56 #define RTC_HOURS_ALARM1        0x0d
  57 #define RTC_DAY_OF_WEEK_ALARM1  0x0e
  58
  59 #define RTC_CONTROL             0x0f
  60 #define RTC_STATUS              0x10
  61 #define RTC_TRICKLE_CHARGER     0x11
  62
  63 #define RTC_USER_RAM_BASE       0x20
  64
  65 /*
  66  * External table of chip select functions (see the appropriate board
  67  * support for the actual definition of the table).
  68  */
  69 extern spi_chipsel_type spi_chipsel[];
  70 extern int spi_chipsel_cnt;
  71
  72 static unsigned int bin2bcd (unsigned int n);
  73 static unsigned char bcd2bin (unsigned char c);
  74 static unsigned char rtc_read (unsigned char reg);
  75 static void rtc_write (unsigned char reg, unsigned char val);
  76
  77
  78
  79
  80
  81 /* ************************************************************************* */
  82 #ifdef CONFIG_SXNI855T          /* !!! SHOULD BE CHANGED TO NEW CODE !!! */
  83
  84 static void soft_spi_send (unsigned char n);
  85 static unsigned char soft_spi_read (void);
  86 static void init_spi (void);
  87
  88 /*-----------------------------------------------------------------------
  89  * Definitions
  90  */
  91
  92 #define PB_SPISCK       0x00000002      /* PB 30 */
  93 #define PB_SPIMOSI      0x00000004      /* PB 29 */
  94 #define PB_SPIMISO      0x00000008      /* PB 28 */
  95 #define PB_SPI_CE       0x00010000      /* PB 15 */
  96
  97 /* ------------------------------------------------------------------------- */
  98
  99 /* read clock time from DS1306 and return it in *tmp */
 100 void rtc_get (struct rtc_time *tmp)
 101 {
 102         volatile immap_t *immap = (immap_t *) CFG_IMMR;
 103         unsigned char spi_byte; /* Data Byte */
 104
 105         init_spi ();            /* set port B for software SPI */
 106
 107         /* Now we can enable the DS1306 RTC */
 108         immap->im_cpm.cp_pbdat |= PB_SPI_CE;
 109         udelay (10);
 110
 111         /* Shift out the address (0) of the time in the Clock Chip */
 112         soft_spi_send (0);
 113
 114         /* Put the clock readings into the rtc_time structure */
 115         tmp->tm_sec = bcd2bin (soft_spi_read ());       /* Read seconds */
 116         tmp->tm_min = bcd2bin (soft_spi_read ());       /* Read minutes */
 117
 118         /* Hours are trickier */
 119         spi_byte = soft_spi_read ();    /* Read Hours into temporary value */
 120         if (spi_byte & 0x40) {
 121                 /* 12 hour mode bit is set (time is in 1-12 format) */
 122                 if (spi_byte & 0x20) {
 123                         /* since PM we add 11 to get 0-23 for hours */
 124                         tmp->tm_hour = (bcd2bin (spi_byte & 0x1F)) + 11;
 125                 } else {
 126                         /* since AM we subtract 1 to get 0-23 for hours */
 127                         tmp->tm_hour = (bcd2bin (spi_byte & 0x1F)) - 1;
 128                 }
 129         } else {
 130                 /* Otherwise, 0-23 hour format */
 131                 tmp->tm_hour = (bcd2bin (spi_byte & 0x3F));
 132         }
 133
 134         soft_spi_read ();       /* Read and discard Day of week */
 135         tmp->tm_mday = bcd2bin (soft_spi_read ());      /* Read Day of the Month */
 136         tmp->tm_mon = bcd2bin (soft_spi_read ());       /* Read Month */
 137
 138         /* Read Year and convert to this century */
 139         tmp->tm_year = bcd2bin (soft_spi_read ()) + 2000;
 140
 141         /* Now we can disable the DS1306 RTC */
 142         immap->im_cpm.cp_pbdat &= ~PB_SPI_CE;   /* Disable DS1306 Chip */
 143         udelay (10);
 144
 145         GregorianDay (tmp);     /* Determine the day of week */
 146
 147         debug ("Get DATE: %4d-%02d-%02d (wday=%d)  TIME: %2d:%02d:%02d\n",
 148                tmp->tm_year, tmp->tm_mon, tmp->tm_mday, tmp->tm_wday,
 149                tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
 150 }
 151
 152 /* ------------------------------------------------------------------------- */
 153
 154 /* set clock time in DS1306 RTC and in MPC8xx RTC */
 155 void rtc_set (struct rtc_time *tmp)
 156 {
 157         volatile immap_t *immap = (immap_t *) CFG_IMMR;
 158
 159         init_spi ();            /* set port B for software SPI */
 160
 161         /* Now we can enable the DS1306 RTC */
 162         immap->im_cpm.cp_pbdat |= PB_SPI_CE;    /* Enable DS1306 Chip */
 163         udelay (10);
 164
 165         /* First disable write protect in the clock chip control register */
 166         soft_spi_send (0x8F);   /* send address of the control register */
 167         soft_spi_send (0x00);   /* send control register contents */
 168
 169         /* Now disable the DS1306 to terminate the write */
 170         immap->im_cpm.cp_pbdat &= ~PB_SPI_CE;
 171         udelay (10);
 172
 173         /* Now enable the DS1306 to initiate a new write */
 174         immap->im_cpm.cp_pbdat |= PB_SPI_CE;
 175         udelay (10);
 176
 177         /* Next, send the address of the clock time write registers */
 178         soft_spi_send (0x80);   /* send address of the first time register */
 179
 180         /* Use Burst Mode to send all of the time data to the clock */
 181         bin2bcd (tmp->tm_sec);
 182         soft_spi_send (bin2bcd (tmp->tm_sec));  /* Send Seconds */
 183         soft_spi_send (bin2bcd (tmp->tm_min));  /* Send Minutes */
 184         soft_spi_send (bin2bcd (tmp->tm_hour)); /* Send Hour */
 185         soft_spi_send (bin2bcd (tmp->tm_wday)); /* Send Day of the Week */
 186         soft_spi_send (bin2bcd (tmp->tm_mday)); /* Send Day of Month */
 187         soft_spi_send (bin2bcd (tmp->tm_mon));  /* Send Month */
 188         soft_spi_send (bin2bcd (tmp->tm_year - 2000));  /* Send Year */
 189
 190         /* Now we can disable the Clock chip to terminate the burst write */
 191         immap->im_cpm.cp_pbdat &= ~PB_SPI_CE;   /* Disable DS1306 Chip */
 192         udelay (10);
 193
 194         /* Now we can enable the Clock chip to initiate a new write */
 195         immap->im_cpm.cp_pbdat |= PB_SPI_CE;    /* Enable DS1306 Chip */
 196         udelay (10);
 197
 198         /* First we Enable write protect in the clock chip control register */
 199         soft_spi_send (0x8F);   /* send address of the control register */
 200         soft_spi_send (0x40);   /* send out Control Register contents */
 201
 202         /* Now disable the DS1306 */
 203         immap->im_cpm.cp_pbdat &= ~PB_SPI_CE;   /*  Disable DS1306 Chip */
 204         udelay (10);
 205
 206         /* Set standard MPC8xx clock to the same time so Linux will
 207          * see the time even if it doesn't have a DS1306 clock driver.
 208          * This helps with experimenting with standard kernels.
 209          */
 210         {
 211                 ulong tim;
 212
 213                 tim = mktime (tmp->tm_year, tmp->tm_mon, tmp->tm_mday,
 214                               tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
 215
 216                 immap->im_sitk.sitk_rtck = KAPWR_KEY;
 217                 immap->im_sit.sit_rtc = tim;
 218         }
 219
 220         debug ("Set DATE: %4d-%02d-%02d (wday=%d)  TIME: %2d:%02d:%02d\n",
 221                tmp->tm_year, tmp->tm_mon, tmp->tm_mday, tmp->tm_wday,
 222                tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
 223 }
 224
 225 /* ------------------------------------------------------------------------- */
 226
 227 /* Initialize Port B for software SPI */
 228 static void init_spi (void)
 229 {
 230         volatile immap_t *immap = (immap_t *) CFG_IMMR;
 231
 232         /* Force output pins to begin at logic 0 */
 233         immap->im_cpm.cp_pbdat &= ~(PB_SPI_CE | PB_SPIMOSI | PB_SPISCK);
 234
 235         /* Set these 3 signals as outputs */
 236         immap->im_cpm.cp_pbdir |= (PB_SPIMOSI | PB_SPI_CE | PB_SPISCK);
 237
 238         immap->im_cpm.cp_pbdir &= ~PB_SPIMISO;  /* Make MISO pin an input */
 239         udelay (10);
 240 }
 241
 242 /* ------------------------------------------------------------------------- */
 243
 244 /* NOTE: soft_spi_send() assumes that the I/O lines are configured already */
 245 static void soft_spi_send (unsigned char n)
 246 {
 247         volatile immap_t *immap = (immap_t *) CFG_IMMR;
 248         unsigned char bitpos;   /* bit position to receive */
 249         unsigned char i;        /* Loop Control */
 250
 251         /* bit position to send, start with most significant bit */
 252         bitpos = 0x80;
 253
 254         /* Send 8 bits to software SPI */
 255         for (i = 0; i < 8; i++) {       /* Loop for 8 bits */
 256                 immap->im_cpm.cp_pbdat |= PB_SPISCK;    /* Raise SCK */
 257
 258                 if (n & bitpos)
 259                         immap->im_cpm.cp_pbdat |= PB_SPIMOSI;   /* Set MOSI to 1 */
 260                 else
 261                         immap->im_cpm.cp_pbdat &= ~PB_SPIMOSI;  /* Set MOSI to 0 */
 262                 udelay (10);
 263
 264                 immap->im_cpm.cp_pbdat &= ~PB_SPISCK;   /* Lower SCK */
 265                 udelay (10);
 266
 267                 bitpos >>= 1;   /* Shift for next bit position */
 268         }
 269 }
 270
 271 /* ------------------------------------------------------------------------- */
 272
 273 /* NOTE: soft_spi_read() assumes that the I/O lines are configured already */
 274 static unsigned char soft_spi_read (void)
 275 {
 276         volatile immap_t *immap = (immap_t *) CFG_IMMR;
 277
 278         unsigned char spi_byte = 0;     /* Return value, assume success */
 279         unsigned char bitpos;   /* bit position to receive */
 280         unsigned char i;        /* Loop Control */
 281
 282         /* bit position to receive, start with most significant bit */
 283         bitpos = 0x80;
 284
 285         /* Read 8 bits here */
 286         for (i = 0; i < 8; i++) {       /* Do 8 bits in loop */
 287                 immap->im_cpm.cp_pbdat |= PB_SPISCK;    /* Raise SCK */
 288                 udelay (10);
 289                 if (immap->im_cpm.cp_pbdat & PB_SPIMISO)        /* Get a bit of data */
 290                         spi_byte |= bitpos;     /* Set data accordingly */
 291                 immap->im_cpm.cp_pbdat &= ~PB_SPISCK;   /* Lower SCK */
 292                 udelay (10);
 293                 bitpos >>= 1;   /* Shift for next bit position */
 294         }
 295
 296         return spi_byte;        /* Return the byte read */
 297 }
 298
 299 /* ------------------------------------------------------------------------- */
 300
 301 void rtc_reset (void)
 302 {
 303         return;                 /* nothing to do */
 304 }
 305
 306 #else  /* not CONFIG_SXNI855T */
 307 /* ************************************************************************* */
 308
 309
 310
 311
 312
 313 /* read clock time from DS1306 and return it in *tmp */
 314 void rtc_get (struct rtc_time *tmp)
 315 {
 316         unsigned char sec, min, hour, mday, wday, mon, year;
 317
 318         sec = rtc_read (RTC_SECONDS);
 319         min = rtc_read (RTC_MINUTES);
 320         hour = rtc_read (RTC_HOURS);
 321         mday = rtc_read (RTC_DATE_OF_MONTH);
 322         wday = rtc_read (RTC_DAY_OF_WEEK);
 323         mon = rtc_read (RTC_MONTH);
 324         year = rtc_read (RTC_YEAR);
 325
 326         debug ("Get RTC year: %02x mon: %02x mday: %02x wday: %02x "
 327                "hr: %02x min: %02x sec: %02x\n",
 328                year, mon, mday, wday, hour, min, sec);
 329         debug ("Alarms[0]: wday: %02x hour: %02x min: %02x sec: %02x\n",
 330                rtc_read (RTC_DAY_OF_WEEK_ALARM0),
 331                rtc_read (RTC_HOURS_ALARM0),
 332                rtc_read (RTC_MINUTES_ALARM0), rtc_read (RTC_SECONDS_ALARM0));
 333         debug ("Alarms[1]: wday: %02x hour: %02x min: %02x sec: %02x\n",
 334                rtc_read (RTC_DAY_OF_WEEK_ALARM1),
 335                rtc_read (RTC_HOURS_ALARM1),
 336                rtc_read (RTC_MINUTES_ALARM1), rtc_read (RTC_SECONDS_ALARM1));
 337
 338         tmp->tm_sec = bcd2bin (sec & 0x7F);     /* convert Seconds */
 339         tmp->tm_min = bcd2bin (min & 0x7F);     /* convert Minutes */
 340
 341         /* convert Hours */
 342         tmp->tm_hour = (hour & 0x40)
 343                 ? ((hour & 0x20)        /* 12 hour mode */
 344                    ? bcd2bin (hour & 0x1F) + 11 /* PM */
 345                    : bcd2bin (hour & 0x1F) - 1  /* AM */
 346                 )
 347                 : bcd2bin (hour & 0x3F);        /* 24 hour mode */
 348
 349         tmp->tm_mday = bcd2bin (mday & 0x3F);   /* convert Day of the Month */
 350         tmp->tm_mon = bcd2bin (mon & 0x1F);     /* convert Month */
 351         tmp->tm_year = bcd2bin (year) + 2000;   /* convert Year */
 352         tmp->tm_wday = bcd2bin (wday & 0x07) - 1;       /* convert Day of the Week */
 353         tmp->tm_yday = 0;
 354         tmp->tm_isdst = 0;
 355
 356         debug ("Get DATE: %4d-%02d-%02d (wday=%d)  TIME: %2d:%02d:%02d\n",
 357                tmp->tm_year, tmp->tm_mon, tmp->tm_mday, tmp->tm_wday,
 358                tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
 359 }
 360
 361 /* ------------------------------------------------------------------------- */
 362
 363 /* set clock time from *tmp in DS1306 RTC */
 364 void rtc_set (struct rtc_time *tmp)
 365 {
 366         debug ("Set DATE: %4d-%02d-%02d (wday=%d)  TIME: %2d:%02d:%02d\n",
 367                tmp->tm_year, tmp->tm_mon, tmp->tm_mday, tmp->tm_wday,
 368                tmp->tm_hour, tmp->tm_min, tmp->tm_sec);
 369
 370         rtc_write (RTC_YEAR, bin2bcd (tmp->tm_year - 2000));
 371         rtc_write (RTC_MONTH, bin2bcd (tmp->tm_mon));
 372         rtc_write (RTC_DATE_OF_MONTH, bin2bcd (tmp->tm_mday));
 373         rtc_write (RTC_DAY_OF_WEEK, bin2bcd (tmp->tm_wday + 1));
 374         rtc_write (RTC_HOURS, bin2bcd (tmp->tm_hour));
 375         rtc_write (RTC_MINUTES, bin2bcd (tmp->tm_min));
 376         rtc_write (RTC_SECONDS, bin2bcd (tmp->tm_sec));
 377 }
 378
 379 /* ------------------------------------------------------------------------- */
 380
 381 /* reset the DS1306 */
 382 void rtc_reset (void)
 383 {
 384         /* clear the control register */
 385         rtc_write (RTC_CONTROL, 0x00);  /* 1st step: reset WP */
 386         rtc_write (RTC_CONTROL, 0x00);  /* 2nd step: reset 1Hz, AIE1, AIE0 */
 387
 388         /* reset all alarms */
 389         rtc_write (RTC_SECONDS_ALARM0, 0x00);
 390         rtc_write (RTC_SECONDS_ALARM1, 0x00);
 391         rtc_write (RTC_MINUTES_ALARM0, 0x00);
 392         rtc_write (RTC_MINUTES_ALARM1, 0x00);
 393         rtc_write (RTC_HOURS_ALARM0, 0x00);
 394         rtc_write (RTC_HOURS_ALARM1, 0x00);
 395         rtc_write (RTC_DAY_OF_WEEK_ALARM0, 0x00);
 396         rtc_write (RTC_DAY_OF_WEEK_ALARM1, 0x00);
 397 }
 398
 399 /* ------------------------------------------------------------------------- */
 400
 401 static unsigned char rtc_read (unsigned char reg)
 402 {
 403         unsigned char dout[2];  /* SPI Output Data Bytes */
 404         unsigned char din[2];   /* SPI Input Data Bytes */
 405
 406         dout[0] = reg;
 407
 408         if (spi_xfer (spi_chipsel[CFG_SPI_RTC_DEVID], 16, dout, din) != 0) {
 409                 return 0;
 410         } else {
 411                 return din[1];
 412         }
 413 }
 414
 415 /* ------------------------------------------------------------------------- */
 416
 417 static void rtc_write (unsigned char reg, unsigned char val)
 418 {
 419         unsigned char dout[2];  /* SPI Output Data Bytes */
 420         unsigned char din[2];   /* SPI Input Data Bytes */
 421
 422         dout[0] = 0x80 | reg;
 423         dout[1] = val;
 424
 425         spi_xfer (spi_chipsel[CFG_SPI_RTC_DEVID], 16, dout, din);
 426 }
 427
 428 #endif /* end of code exclusion (see #ifdef CONFIG_SXNI855T above) */
 429
 430 /* ------------------------------------------------------------------------- */
 431
 432 static unsigned char bcd2bin (unsigned char n)
 433 {
 434         return ((((n >> 4) & 0x0F) * 10) + (n & 0x0F));
 435 }
 436
 437 /* ------------------------------------------------------------------------- */
 438
 439 static unsigned int bin2bcd (unsigned int n)
 440 {
 441         return (((n / 10) << 4) | (n % 10));
 442 }
 443 /* ------------------------------------------------------------------------- */
 444
 445 #endif