src/pc80/mc146818rtc.c

   1 #include <console/console.h>
   2 #include <pc80/mc146818rtc.h>
   3 #include <boot/coreboot_tables.h>
   4 #include <string.h>
   5 #if CONFIG_USE_OPTION_TABLE
   6 #include "option_table.h"
   7 #include <cbfs.h>
   8 #endif
   9
  10 /* control registers - Moto names
  11  */
  12 #define RTC_REG_A               10
  13 #define RTC_REG_B               11
  14 #define RTC_REG_C               12
  15 #define RTC_REG_D               13
  16
  17
  18 /**********************************************************************
  19  * register details
  20  **********************************************************************/
  21 #define RTC_FREQ_SELECT RTC_REG_A
  22
  23 /* update-in-progress  - set to "1" 244 microsecs before RTC goes off the bus,
  24  * reset after update (may take 1.984ms @ 32768Hz RefClock) is complete,
  25  * totalling to a max high interval of 2.228 ms.
  26  */
  27 # define RTC_UIP                0x80
  28 # define RTC_DIV_CTL            0x70
  29    /* divider control: refclock values 4.194 / 1.049 MHz / 32.768 kHz */
  30 #  define RTC_REF_CLCK_4MHZ     0x00
  31 #  define RTC_REF_CLCK_1MHZ     0x10
  32 #  define RTC_REF_CLCK_32KHZ    0x20
  33    /* 2 values for divider stage reset, others for "testing purposes only" */
  34 #  define RTC_DIV_RESET1        0x60
  35 #  define RTC_DIV_RESET2        0x70
  36   /* Periodic intr. / Square wave rate select. 0=none, 1=32.8kHz,... 15=2Hz */
  37 # define RTC_RATE_SELECT        0x0F
  38 #  define RTC_RATE_NONE         0x00
  39 #  define RTC_RATE_32786HZ      0x01
  40 #  define RTC_RATE_16384HZ      0x02
  41 #  define RTC_RATE_8192HZ       0x03
  42 #  define RTC_RATE_4096HZ       0x04
  43 #  define RTC_RATE_2048HZ       0x05
  44 #  define RTC_RATE_1024HZ       0x06
  45 #  define RTC_RATE_512HZ        0x07
  46 #  define RTC_RATE_256HZ        0x08
  47 #  define RTC_RATE_128HZ        0x09
  48 #  define RTC_RATE_64HZ         0x0a
  49 #  define RTC_RATE_32HZ         0x0b
  50 #  define RTC_RATE_16HZ         0x0c
  51 #  define RTC_RATE_8HZ          0x0d
  52 #  define RTC_RATE_4HZ          0x0e
  53 #  define RTC_RATE_2HZ          0x0f
  54
  55 /**********************************************************************/
  56 #define RTC_CONTROL     RTC_REG_B
  57 # define RTC_SET 0x80           /* disable updates for clock setting */
  58 # define RTC_PIE 0x40           /* periodic interrupt enable */
  59 # define RTC_AIE 0x20           /* alarm interrupt enable */
  60 # define RTC_UIE 0x10           /* update-finished interrupt enable */
  61 # define RTC_SQWE 0x08          /* enable square-wave output */
  62 # define RTC_DM_BINARY 0x04     /* all time/date values are BCD if clear */
  63 # define RTC_24H 0x02           /* 24 hour mode - else hours bit 7 means pm */
  64 # define RTC_DST_EN 0x01        /* auto switch DST - works f. USA only */
  65
  66 /**********************************************************************/
  67 #define RTC_INTR_FLAGS  RTC_REG_C
  68 /* caution - cleared by read */
  69 # define RTC_IRQF 0x80          /* any of the following 3 is active */
  70 # define RTC_PF 0x40
  71 # define RTC_AF 0x20
  72 # define RTC_UF 0x10
  73
  74 /**********************************************************************/
  75 #define RTC_VALID       RTC_REG_D
  76 # define RTC_VRT 0x80           /* valid RAM and time */
  77 /**********************************************************************/
  78
  79 #if CONFIG_USE_OPTION_TABLE
  80 static int rtc_checksum_valid(int range_start, int range_end, int cks_loc)
  81 {
  82         int i;
  83         unsigned sum, old_sum;
  84         sum = 0;
  85         for(i = range_start; i <= range_end; i++) {
  86                 sum += cmos_read(i);
  87         }
  88         sum = (~sum)&0x0ffff;
  89         old_sum = ((cmos_read(cks_loc)<<8) | cmos_read(cks_loc+1))&0x0ffff;
  90         return sum == old_sum;
  91 }
  92
  93 static void rtc_set_checksum(int range_start, int range_end, int cks_loc)
  94 {
  95         int i;
  96         unsigned sum;
  97         sum = 0;
  98         for(i = range_start; i <= range_end; i++) {
  99                 sum += cmos_read(i);
 100         }
 101         cmos_write(((sum >> 8) & 0x0ff), cks_loc);
 102         cmos_write(((sum >> 0) & 0x0ff), cks_loc+1);
 103 }
 104 #endif
 105
 106 #if CONFIG_ARCH_X86
 107 #define RTC_CONTROL_DEFAULT (RTC_24H)
 108 #define RTC_FREQ_SELECT_DEFAULT (RTC_REF_CLCK_32KHZ | RTC_RATE_1024HZ)
 109 #else
 110 #if CONFIG_ARCH_ALPHA
 111 #define RTC_CONTROL_DEFAULT (RTC_SQWE | RTC_24H)
 112 #define RTC_FREQ_SELECT_DEFAULT (RTC_REF_CLCK_32KHZ | RTC_RATE_1024HZ)
 113 #endif
 114 #endif
 115
 116 void rtc_init(int invalid)
 117 {
 118 #if CONFIG_USE_OPTION_TABLE
 119         unsigned char x;
 120         int cmos_invalid, checksum_invalid;
 121 #endif
 122
 123         printk(BIOS_DEBUG, "RTC Init\n");
 124
 125 #if CONFIG_USE_OPTION_TABLE
 126         /* See if there has been a CMOS power problem. */
 127         x = cmos_read(RTC_VALID);
 128         cmos_invalid = !(x & RTC_VRT);
 129
 130         /* See if there is a CMOS checksum error */
 131         checksum_invalid = !rtc_checksum_valid(PC_CKS_RANGE_START,
 132                         PC_CKS_RANGE_END,PC_CKS_LOC);
 133
 134 #define CLEAR_CMOS 0
 135         if (invalid || cmos_invalid || checksum_invalid) {
 136                 printk(BIOS_WARNING, "RTC:%s%s%s%s\n",
 137                         invalid?" Clear requested":"",
 138                         cmos_invalid?" Power Problem":"",
 139                         checksum_invalid?" Checksum invalid":"",
 140                         CLEAR_CMOS?" zeroing cmos":"");
 141 #if CLEAR_CMOS
 142                 cmos_write(0, 0x01);
 143                 cmos_write(0, 0x03);
 144                 cmos_write(0, 0x05);
 145                 for(i = 10; i < 48; i++) {
 146                         cmos_write(0, i);
 147                 }
 148
 149                 if (cmos_invalid) {
 150                         /* Now setup a default date of Sat 1 January 2000 */
 151                         cmos_write(0, 0x00); /* seconds */
 152                         cmos_write(0, 0x02); /* minutes */
 153                         cmos_write(1, 0x04); /* hours */
 154                         cmos_write(7, 0x06); /* day of week */
 155                         cmos_write(1, 0x07); /* day of month */
 156                         cmos_write(1, 0x08); /* month */
 157                         cmos_write(0, 0x09); /* year */
 158                 }
 159 #endif
 160         }
 161 #endif
 162
 163         /* Setup the real time clock */
 164         cmos_write(RTC_CONTROL_DEFAULT, RTC_CONTROL);
 165         /* Setup the frequency it operates at */
 166         cmos_write(RTC_FREQ_SELECT_DEFAULT, RTC_FREQ_SELECT);
 167
 168 #if CONFIG_USE_OPTION_TABLE
 169         /* See if there is a LB CMOS checksum error */
 170         checksum_invalid = !rtc_checksum_valid(LB_CKS_RANGE_START,
 171                         LB_CKS_RANGE_END,LB_CKS_LOC);
 172         if(checksum_invalid)
 173                 printk(BIOS_DEBUG, "RTC: coreboot checksum invalid\n");
 174
 175         /* Make certain we have a valid checksum */
 176         rtc_set_checksum(PC_CKS_RANGE_START,
 177                         PC_CKS_RANGE_END,PC_CKS_LOC);
 178 #endif
 179
 180         /* Clear any pending interrupts */
 181         (void) cmos_read(RTC_INTR_FLAGS);
 182 }
 183
 184
 185 #if CONFIG_USE_OPTION_TABLE
 186 /* This routine returns the value of the requested bits
 187         input bit = bit count from the beginning of the cmos image
 188               length = number of bits to include in the value
 189               ret = a character pointer to where the value is to be returned
 190         output the value placed in ret
 191               returns 0 = successful, -1 = an error occurred
 192 */
 193 static int get_cmos_value(unsigned long bit, unsigned long length, void *vret)
 194 {
 195         unsigned char *ret;
 196         unsigned long byte,byte_bit;
 197         unsigned long i;
 198         unsigned char uchar;
 199
 200         /* The table is checked when it is built to ensure all
 201                 values are valid. */
 202         ret = vret;
 203         byte=bit/8;     /* find the byte where the data starts */
 204         byte_bit=bit%8; /* find the bit in the byte where the data starts */
 205         if(length<9) {  /* one byte or less */
 206                 uchar = cmos_read(byte); /* load the byte */
 207                 uchar >>= byte_bit;     /* shift the bits to byte align */
 208                 /* clear unspecified bits */
 209                 ret[0] = uchar & ((1 << length) -1);
 210         }
 211         else {  /* more that one byte so transfer the whole bytes */
 212                 for(i=0;length;i++,length-=8,byte++) {
 213                         /* load the byte */
 214                         ret[i]=cmos_read(byte);
 215                 }
 216         }
 217         return 0;
 218 }
 219
 220 int get_option(void *dest, const char *name)
 221 {
 222         struct cmos_option_table *ct;
 223         struct cmos_entries *ce;
 224         size_t namelen;
 225         int found=0;
 226
 227         /* Figure out how long name is */
 228         namelen = strnlen(name, CMOS_MAX_NAME_LENGTH);
 229
 230         /* find the requested entry record */
 231         ct=cbfs_find_file("cmos_layout.bin", CBFS_COMPONENT_CMOS_LAYOUT);
 232         if (!ct) {
 233                 printk(BIOS_ERR, "RTC: cmos_layout.bin could not be found. "
 234                                                 "Options are disabled\n");
 235                 return(-2);
 236         }
 237         ce=(struct cmos_entries*)((unsigned char *)ct + ct->header_length);
 238         for(;ce->tag==LB_TAG_OPTION;
 239                 ce=(struct cmos_entries*)((unsigned char *)ce + ce->size)) {
 240                 if (memcmp(ce->name, name, namelen) == 0) {
 241                         found=1;
 242                         break;
 243                 }
 244         }
 245         if(!found) {
 246                 printk(BIOS_DEBUG, "WARNING: No CMOS option '%s'.\n", name);
 247                 return(-2);
 248         }
 249
 250         if(get_cmos_value(ce->bit, ce->length, dest))
 251                 return(-3);
 252         if(!rtc_checksum_valid(LB_CKS_RANGE_START,
 253                         LB_CKS_RANGE_END,LB_CKS_LOC))
 254                 return(-4);
 255         return(0);
 256 }
 257
 258 static int set_cmos_value(unsigned long bit, unsigned long length, void *vret)
 259 {
 260         unsigned char *ret;
 261         unsigned long byte,byte_bit;
 262         unsigned long i;
 263         unsigned char uchar, mask;
 264         unsigned int chksum_update_needed = 0;
 265
 266         ret = vret;
 267         byte = bit / 8;                 /* find the byte where the data starts */
 268         byte_bit = bit % 8;             /* find the bit in the byte where the data starts */
 269         if(length <= 8) {               /* one byte or less */
 270                 mask = (1 << length) - 1;
 271                 mask <<= byte_bit;
 272
 273                 uchar = cmos_read(byte);
 274                 uchar &= ~mask;
 275                 uchar |= (ret[0] << byte_bit);
 276                 cmos_write(uchar, byte);
 277                 if (byte >= LB_CKS_RANGE_START && byte <= LB_CKS_RANGE_END)
 278                         chksum_update_needed = 1;
 279         } else {                        /* more that one byte so transfer the whole bytes */
 280                 if (byte_bit || length % 8)
 281                         return -1;
 282
 283                 for(i=0; length; i++, length-=8, byte++)
 284                         cmos_write(ret[i], byte);
 285                         if (byte >= LB_CKS_RANGE_START && byte <= LB_CKS_RANGE_END)
 286                                 chksum_update_needed = 1;
 287         }
 288
 289         if (chksum_update_needed) {
 290                 rtc_set_checksum(LB_CKS_RANGE_START,
 291                         LB_CKS_RANGE_END,LB_CKS_LOC);
 292         }
 293         return 0;
 294 }
 295
 296
 297 int set_option(const char *name, void *value)
 298 {
 299         struct cmos_option_table *ct;
 300         struct cmos_entries *ce;
 301         unsigned long length;
 302         size_t namelen;
 303         int found=0;
 304
 305         /* Figure out how long name is */
 306         namelen = strnlen(name, CMOS_MAX_NAME_LENGTH);
 307
 308         /* find the requested entry record */
 309         ct=cbfs_find_file("cmos_layout.bin", CBFS_COMPONENT_CMOS_LAYOUT);
 310         if (!ct) {
 311                 printk(BIOS_ERR, "cmos_layout.bin could not be found. Options are disabled\n");
 312                 return(-2);
 313         }
 314         ce=(struct cmos_entries*)((unsigned char *)ct + ct->header_length);
 315         for(;ce->tag==LB_TAG_OPTION;
 316                 ce=(struct cmos_entries*)((unsigned char *)ce + ce->size)) {
 317                 if (memcmp(ce->name, name, namelen) == 0) {
 318                         found=1;
 319                         break;
 320                 }
 321         }
 322         if(!found) {
 323                 printk(BIOS_DEBUG, "WARNING: No CMOS option '%s'.\n", name);
 324                 return(-2);
 325         }
 326
 327         length = ce->length;
 328         if (ce->config == 's') {
 329                 length = MAX(strlen((const char *)value) * 8, ce->length - 8);
 330                 /* make sure the string is null terminated */
 331                 if ((set_cmos_value(ce->bit + ce->length - 8, 8, &(u8[]){0})))
 332                         return (-3);
 333         }
 334
 335         if ((set_cmos_value(ce->bit, length, value)))
 336                 return (-3);
 337
 338         return 0;
 339 }
 340 #endif /* CONFIG_USE_OPTION_TABLE */