ClockKernel.h

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
*/

#ifndef CLOCKKERNEL_H_
#define CLOCKKERNEL_H_

#include <stdint.h>        // typedef uint8_t, typedef uint16_t

#ifdef __cplusplus
extern "C" {
#endif

/* -- Defines --------------------------------------------------------------- */

typedef struct {
    uint8_t hour;   
    uint8_t minute; 
} fclock_t;

#define CLOCK_MIDNIGHT { 0, 0 }     
// CLOCK_MIDNIGHT should be defined as 'const fclock_t', but C sucks:
// extern const fclock_t CLOCK_MIDNIGHT;

//TODO: should we define status_t as bit field and use on ClockSetStatus, ... ?

#define CLOCK_STATUS_RUN 0

#define CLOCK_STATUS_TIME 1

//#define CLOCK_STATUS_XXX 2-7      //reserved for future use

#define CLOCK_TIME_FACTOR_MIN 10    
#define CLOCK_TIME_FACTOR_MAX 119   

#define CLOCK_PULSE_WIDTH_MIN 5     
#define CLOCK_PULSE_WIDTH_MAX 19    

/*-- FunctionPrototypes ----------------------------------------------------- */

// for comment see ClockKernel.c
void ClockKernelInit(void);

// for comment see ClockKernel.c
void SysTimerUserInterrupt(void);

// for comment see ClockKernel.c
void SysTimerUserInterrupt10(void);

// for comment see ClockKernel.c
void SysTimerUserInterrupt100(void);

/* Initalize clock */
//void ClockInit(void);

// for comment see ClockKernel.c
void ClockSetStatus(uint8_t ucStatus);

// for comment see ClockKernel.c
uint8_t ClockReadStatus(void);

// for comment see ClockKernel.c
uint8_t ClockIsRunning(void); //FIXME: replace by: const uint8_t CLOCK_IS_RUNNING = _BV(CLOCK_STATUS_RUN) | _BV(CLOCK_STATUS_TIME;

// for comment see ClockKernel.c
void ClockSetPeriod(uint16_t uiPeriod);

// for comment see ClockKernel.c
uint16_t ClockReadPeriod(void);

// for comment see ClockKernel.c
void ClockSetPulse(uint16_t uiPulse);

// for comment see ClockKernel.c
uint16_t ClockReadPulse(void);

// for comment see ClockKernel.c
void ClockSetTime(fclock_t newValue);

// for comment see ClockKernel.c
fclock_t ClockGetTime(void);

// for comment see ClockKernel.c
void ClockSetTimeFactor(uint8_t ucFactor);

// for comment see ClockKernel.c
uint8_t ClockReadTimeFactor(void);

//TODO: use fclock_t for the following functions instead of two
//      separate minute/hour functions

// for comment see ClockKernel.c
void ClockSetStartTimeMinute(uint8_t ucMinute);

// for comment see ClockKernel.c
uint8_t ClockReadStartTimeMinute(void);

// for comment see ClockKernel.c
void ClockSetStartTimeHour(uint8_t ucHour);

// for comment see ClockKernel.c
uint8_t ClockReadStartTimeHour(void);

// for comment see ClockKernel.c
void ClockSetEndTimeMinute(uint8_t ucMinute);

// for comment see ClockKernel.c
uint8_t ClockReadEndTimeMinute(void);

// for comment see ClockKernel.c
void ClockSetEndTimeHour(uint8_t ucHour);

// for comment see ClockKernel.c
uint8_t ClockReadEndTimeHour(void);

#ifdef __cplusplus
}
#endif

#endif /* CLOCKKERNEL_H_ */