UserInterfaceCommonData.c

Go to the documentation of this file.

/*
    Copyright (C) 2007 Bernd Wisotzki

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

/* -- System wide includes -------------------------------------------------- */
#include <stdint.h> // typedef uint8_t, typedef uint16_t
#include <avr/io.h> // _BV

/* -- Special Includes e.g. Onboard or direct attached Equipment ------------ */
//TODO: cleanup of imports, add comments what is imported
#include "ClockKernel.h" // clock kernel
#include "uart.h" // logging
#include "UserSettings.h"
#include "UserInterfaceCommonData.h"

/* -- global Variables ------------------------------------------------------ */

/* -- ram ------------------------------------------------------------------- */
static uint8_t ucSystemStatus; 
static uint8_t ucEepromStatus; 

/* -- Standard functions ---------------------------------------------------- */

uint8_t UserInterfaceCommonDataInit(void)
{   
    LOG_P("\n\rUserInterfaceCommonDataInit\n\r");

    // get data from eeprom 
    ucEepromStatus = UserSettingsGetEepromStatus();
    //1. Check against erased eeprom and set to meaningfull values
    // Remark 070407: Are there other possible EEPROM errors??
    if (ucEepromStatus >=250) // eeprom empty :-(
    {
        LOG_P("\n\rEEPROM Geloescht.:-((\n\r");

        // set meaningfull values
        ucEepromStatus = 0;
        ucSystemStatus = _BV(SYSTEM_STATUS_DIRTY);
        ClockSetTimeFactor(100); // 1:10
        ClockSetStartTimeMinute(45); // Start:   05:45
        ClockSetStartTimeHour(5);
        ClockSetEndTimeMinute(15);   // End:     18:15
        ClockSetEndTimeHour(18);
        ClockSetPulse(10);
        ClockSetTime((fclock_t) {12, 0});         // Current: 12:00

        // write to eeprom
        UserSettingsSetEepromStatus(ucEepromStatus);
        UserSettingsSetSystemStatus(ucSystemStatus);
        fclock_t clock = ClockGetTime();
        UserSettingsSaveClockValues(ClockReadTimeFactor(), ClockReadPulse(),
                                    ClockReadStartTimeMinute(), ClockReadStartTimeHour(),
                                    ClockReadEndTimeMinute(), ClockReadEndTimeHour(),
                                    clock.minute, clock.hour);

        ucSystemStatus |= _BV(SYSTEM_STATUS_EEPROM_ERASED); //set System status
    }
    //2. normal mode
    else // eeprom ok?? We have to rely on this.
    {
        LOG_P("\n\rEEPROM OK!!:-))\n\r");

        // read from eeprom. eucEEPROMStatus above.
        ucSystemStatus = UserSettingsGetSystemStatus();
        ClockSetTimeFactor(UserSettingsGetFactor());
        ClockSetStartTimeMinute(UserSettingsGetStartMinute());
        ClockSetStartTimeHour(UserSettingsGetStartHour());
        ClockSetEndTimeMinute(UserSettingsGetEndMinute());
        ClockSetEndTimeHour(UserSettingsGetEndHour());
        ClockSetPulse(UserSettingsGetPulse());
        fclock_t clock = { UserSettingsGetCurrentHour(), UserSettingsGetCurrentMinute() };
        ClockSetTime(clock);

        // What to check ucSystemStatus against??
        // 1. Dirtybit
        // 2. 
        // Write back of dirty status.

        //if (ucSystemStatus && _BV(SYSTEM_STATUS_DIRTY == 1)) // original code which looks wrong
        if ((ucSystemStatus & _BV(SYSTEM_STATUS_DIRTY)) != 0)
        {
            ucSystemStatus |= _BV(SYSTEM_STATUS_GOT_DIRTY); // Got dirty from eeprom!!
        }
        else
        {
            ucSystemStatus |= _BV(SYSTEM_STATUS_DIRTY); // now we are dirty.
            UserSettingsSetSystemStatus(ucSystemStatus);// write back.
        }
    }
    // Set (clock) values from these data
    LOG_P("%u, %u\n\r", ucSystemStatus, ClockReadTimeFactor());

    return ucSystemStatus;
}

void UserInterfaceCommonDataShutDown(void)
{
    LOG_P("\n\rUserInterfaceCommonDataShutDown\n\r");

    ucSystemStatus &= _BV(SYSTEM_STATUS_ENDTIME); //clear for shutdown, system ok.

    // write to eeprom
    UserSettingsSetEepromStatus(ucEepromStatus);
    UserSettingsSetSystemStatus(ucSystemStatus);
    fclock_t clock = ClockGetTime();
    UserSettingsSaveClockValues(ClockReadTimeFactor(), ClockReadPulse(),
                                ClockReadStartTimeMinute(), ClockReadStartTimeHour(),
                                ClockReadEndTimeMinute(), ClockReadEndTimeHour(),
                                clock.minute, clock.hour);
}