/* dcf77.h
 * decoding of the dcf77-stream
 *
 * by: Clemens Helfmeier
 * This code converts the bitstream from the DCF77-sender into a standard
 * Timestamp
 */

#ifndef _DCF77_H_
#define _DCF77_H_

#include <stdint.h>

/* definition for io-pin */
#define bdec_BIT		(1<<PIND3)
#define bdec_PORT		PORTD
#define bdec_PIN		PIND
#define bdec_DIR		DDRD

#define bdec_EMPTY		0x00
#define bdec_SYNC		0x01
#define bdec_ZERO		0x02
#define bdec_ONE		0x03
#define bdec_OVF		0xF0

#define Parity			(1<<0)
#define ParityError		(1<<1)
#define LastValid		(1<<2)
#define SecureValid		(1<<3)
#define CurrentValid	(1<<4)

#define ParityBit1		28
#define ParityBit2		35
#define ParityBit3		58
#define MonthBit		50
#define DayBit			42
#define SyncBit			59


/* Timestamp definition */
typedef struct {
	uint16_t year;
	uint8_t month;
	uint8_t day;
	uint8_t hour;
	uint8_t minute;
	uint8_t second;
} sTimeStamp, *pTimeStamp;

extern volatile uint8_t u8Status;


/** initialize the binary decoder
 */
void dcf77_init(void);

/* get one bit from the stream.
 * return values are:
 * 0x00 no bit in stream available
 * 0x01 sync bit read
 * 0x02 "0" read
 * 0x03 "1" read
 * 0xF0 overflow occured (bits lost)
 */
uint8_t bdec_getBit( void );

/* this procedure must be called regularily
 * with an exact frequency.
 */
void bdec_timer( void );

/** get the current time
 * @return	Possible return values are:
 * 			0x00 on success,
 * 			0x01 on success, but not secure
 * 			0x02 no time available
 * 			0xFF invalid parameter
 */
uint8_t dcf77_getTime( pTimeStamp ts );

/** Convert the given value from BCD (Binary Packed Decimal) to
 * normal binary (hex) numbers.
 */
uint8_t dcf77_bcd2hex( uint8_t bcd );

/** Input one bit into the decoder
 * @param bit	zero means a bit of value 0, any other
 *				value is interpreted as a bit of value 1.
 */
void dcf77_putBit( uint8_t bit );

/** input the synchronizeation bit into the decoder
 */
void dcf77_putSync( void );

/** increase the given timestamp by one second.
 */
void dcf77_incTS( sTimeStamp *ts );

/** Should be called regularily with exactly 1 Hz. It keeps track of the time.
 */
void dcf77_timer( void );

#endif