packages/devs/wallclock/sh/sh3/v2_0/src/wallclock_sh3.cxx

   1 //==========================================================================
   2 //
   3 //      devs/wallclock/sh3.cxx
   4 //
   5 //      SH3 RTC module driver.
   6 //
   7 //==========================================================================
   8 //####ECOSGPLCOPYRIGHTBEGIN####
   9 // -------------------------------------------
  10 // This file is part of eCos, the Embedded Configurable Operating System.
  11 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
  12 //
  13 // eCos is free software; you can redistribute it and/or modify it under
  14 // the terms of the GNU General Public License as published by the Free
  15 // Software Foundation; either version 2 or (at your option) any later version.
  16 //
  17 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
  18 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20 // for more details.
  21 //
  22 // You should have received a copy of the GNU General Public License along
  23 // with eCos; if not, write to the Free Software Foundation, Inc.,
  24 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  25 //
  26 // As a special exception, if other files instantiate templates or use macros
  27 // or inline functions from this file, or you compile this file and link it
  28 // with other works to produce a work based on this file, this file does not
  29 // by itself cause the resulting work to be covered by the GNU General Public
  30 // License. However the source code for this file must still be made available
  31 // in accordance with section (3) of the GNU General Public License.
  32 //
  33 // This exception does not invalidate any other reasons why a work based on
  34 // this file might be covered by the GNU General Public License.
  35 //
  36 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
  37 // at http://sources.redhat.com/ecos/ecos-license/
  38 // -------------------------------------------
  39 //####ECOSGPLCOPYRIGHTEND####
  40 //==========================================================================
  41 //#####DESCRIPTIONBEGIN####
  42 //
  43 // Author(s):     jskov
  44 // Contributors:  jskov
  45 // Date:          2000-03-17
  46 // Purpose:       Wallclock driver for SH3 CPU RTC module
  47 //
  48 //####DESCRIPTIONEND####
  49 //
  50 //==========================================================================
  51
  52 #include <pkgconf/wallclock.h>          // Wallclock device config
  53
  54 #include <cyg/hal/hal_io.h>             // IO macros
  55 #include <cyg/infra/cyg_type.h>         // Common type definitions and support
  56
  57 #include <cyg/io/wallclock.hxx>         // The WallClock API
  58 #include <cyg/io/wallclock/wallclock.inl> // Helpers
  59
  60 #include <cyg/hal/sh_regs.h>            // RTC register definitions
  61
  62 #include <cyg/infra/diag.h>             // For debugging
  63
  64
  65
  66 //-----------------------------------------------------------------------------
  67 // Functions for setting and getting the hardware clock counters
  68
  69 // Year must be last two digits of "western calendar year". Leap year when
  70 // divisible by four.
  71 static void
  72 set_sh3_hwclock(cyg_uint32 year, cyg_uint32 month, cyg_uint32 mday,
  73                 cyg_uint32 hour, cyg_uint32 minute, cyg_uint32 second)
  74 {
  75     // Stop RTC
  76     HAL_WRITE_UINT8(CYGARC_REG_RCR2, CYGARC_REG_RCR2_RESET);
  77
  78     // Program it
  79     HAL_WRITE_UINT8(CYGARC_REG_RYRCNT,  TO_BCD(year));
  80     HAL_WRITE_UINT8(CYGARC_REG_RMONCNT, TO_BCD(month));
  81     HAL_WRITE_UINT8(CYGARC_REG_RDAYCNT, TO_BCD(mday));
  82     HAL_WRITE_UINT8(CYGARC_REG_RHRCNT,  TO_BCD(hour));
  83     HAL_WRITE_UINT8(CYGARC_REG_RMINCNT, TO_BCD(minute));
  84     HAL_WRITE_UINT8(CYGARC_REG_RSECCNT, TO_BCD(second));
  85
  86     // Start RTC
  87     HAL_WRITE_UINT8(CYGARC_REG_RCR1, CYGARC_REG_RCR1_CIE);
  88     HAL_WRITE_UINT8(CYGARC_REG_RCR2,
  89                     CYGARC_REG_RCR2_RTCEN | CYGARC_REG_RCR2_START);
  90
  91 }
  92
  93 static void
  94 get_sh3_hwclock(cyg_uint32* year, cyg_uint32* month, cyg_uint32* mday,
  95                 cyg_uint32* hour, cyg_uint32* minute, cyg_uint32* second)
  96 {
  97     cyg_uint8 tmp;
  98
  99     do {
 100         // Clear carry flag
 101         HAL_WRITE_UINT8(CYGARC_REG_RCR1, 0);
 102
 103         // Read time
 104         HAL_READ_UINT8(CYGARC_REG_RYRCNT, tmp);
 105         *year = TO_DEC(tmp);
 106         HAL_READ_UINT8(CYGARC_REG_RMONCNT, tmp);
 107         *month = TO_DEC(tmp);
 108         HAL_READ_UINT8(CYGARC_REG_RDAYCNT, tmp);
 109         *mday = TO_DEC(tmp);
 110         HAL_READ_UINT8(CYGARC_REG_RHRCNT, tmp);
 111         *hour = TO_DEC(tmp);
 112         HAL_READ_UINT8(CYGARC_REG_RMINCNT, tmp);
 113         *minute = TO_DEC(tmp);
 114         HAL_READ_UINT8(CYGARC_REG_RSECCNT, tmp);
 115         *second = TO_DEC(tmp);
 116
 117         // Read carry flag
 118         HAL_READ_UINT8(CYGARC_REG_RCR1, tmp);
 119     } while (CYGARC_REG_RCR1_CF & tmp); // loop if carry set
 120 }
 121
 122 //-----------------------------------------------------------------------------
 123 // Functions required for the hardware-driver API.
 124
 125 // Returns the number of seconds elapsed since 1970-01-01 00:00:00.
 126 cyg_uint32
 127 Cyg_WallClock::get_hw_seconds(void)
 128 {
 129     cyg_uint32 year, month, mday, hour, minute, second;
 130
 131     get_sh3_hwclock(&year, &month, &mday, &hour, &minute, &second);
 132
 133 #if 0
 134     // This will cause the test to eventually fail due to these printouts
 135     // causing timer interrupts to be lost...
 136     diag_printf("year %02d\n", year);
 137     diag_printf("month %02d\n", month);
 138     diag_printf("mday %02d\n", mday);
 139     diag_printf("hour %02d\n", hour);
 140     diag_printf("minute %02d\n", minute);
 141     diag_printf("second %02d\n", second);
 142 #endif
 143
 144 #ifndef CYGSEM_WALLCLOCK_SET_GET_MODE
 145     // We know what we initialized the hardware for : 1970, so by doing this
 146     // the returned time should be OK for 30 years uptime.
 147     year += 1900;
 148 #else
 149     // Need to use sliding window or similar to figure out what the
 150     // century should be... Patent issue is unclear, and since there's
 151     // no battery backup of the clock, there's little point in
 152     // investigating.
 153 # error "Need some magic here to figure out century counter"
 154 #endif
 155
 156     cyg_uint32 now = _simple_mktime(year, month, mday, hour, minute, second);
 157     return now;
 158 }
 159
 160 #ifndef CYGSEM_WALLCLOCK_SET_GET_MODE
 161
 162 void
 163 Cyg_WallClock::init_hw_seconds(void)
 164 {
 165     // This is our base: 1970-01-01 00:00:00
 166     // Set the HW clock - if for nothing else, just to be sure it's in a
 167     // legal range. Any arbitrary base could be used.
 168     // After this the hardware clock is only read.
 169     set_sh3_hwclock(70,1,1,0,0,0);
 170 }
 171
 172 #endif // CYGSEM_WALLCLOCK_SET_GET_MODE
 173
 174 //-----------------------------------------------------------------------------
 175 // End of devs/wallclock/sh3.cxx