ds1307.h

Go to the documentation of this file.

/*
 * This file is part of the Ultibo project, https://ultibo.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2026 Garry Wood <garry@softoz.com.au>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef _ULTIBO_DS1307_H
#define _ULTIBO_DS1307_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/i2c.h"
#include "ultibo/rtc.h"

#define DS1307_RTC_DESCRIPTION  "Maxim DS1307 Real Time Clock" 
 
#define DS1307_MIN_TIME 125911584000000000 
#define DS1307_MAX_TIME 157469183990000000 

#define DS1307_CHIP_DS1307  0
#define DS1307_CHIP_DS1337  1
#define DS1307_CHIP_DS1338  2
#define DS1307_CHIP_DS1339  3
#define DS1307_CHIP_DS1340  4
#define DS1307_CHIP_DS1388  5
#define DS1307_CHIP_DS3231  6
#define DS1307_CHIP_M41T00  7
#define DS1307_CHIP_MCP794XX    8
#define DS1307_CHIP_RX8025  9

#define DS1307_REG_SECONDS  0x00 
#define DS1307_REG_MINUTE   0x01 
#define DS1307_REG_HOUR 0x02 
#define DS1307_REG_WEEKDAY  0x03 
#define DS1307_REG_DAY  0x04 
#define DS1307_REG_MONTH    0x05 
#define DS1307_REG_YEAR 0x06 

#define DS1307_REG_CONTROL  0x07 
#define DS1337_REG_CONTROL  0x0e
#define DS1340_REG_CONTROL  0x07
#define DS1340_REG_FLAG 0x09
#define DS1337_REG_STATUS   0x0f
#define DS1339_REG_ALARM1_SECONDS   0x07
#define RX8025_REG_CONTROL1 0x0e
#define RX8025_REG_CONTROL2 0x0f

#define DS1307_REG_SECONDS_CH   0x80 
#define DS1340_REG_SECONDS_nEOSC    0x80
#define MCP794XX_REG_SECONDS_ST 0x80 

#define DS1307_REG_HOUR_12HR    0x40 
#define DS1307_REG_HOUR_PM  0x20 
#define DS1340_REG_HOUR_CENTURY_EN  0x80
#define DS1340_REG_HOUR_CENTURY 0x40

#define MCP794XX_REG_WEEKDAY_VBATEN 0x08 

#define DS1337_REG_MONTH_CENTURY    0x80

#define DS1307_REG_CONTROL_OUT  0x80 
#define DS1338_REG_CONTROL_OSF  0x20
#define DS1307_REG_CONTROL_SQWE 0x10 
#define DS1307_REG_CONTROL_RS1  0x02 
#define DS1307_REG_CONTROL_RS0  0x01 

#define DS1337_REG_CONTROL_nEOSC    0x80
#define DS1339_REG_CONTROL_BBSQI    0x20
#define DS3231_REG_CONTROL_BBSQW    0x40 
#define DS1337_REG_CONTROL_RS2  0x10
#define DS1337_REG_CONTROL_RS1  0x08
#define DS1337_REG_CONTROL_INTCN    0x04
#define DS1337_REG_CONTROL_A2IE 0x02
#define DS1337_REG_CONTROL_A1IE 0x01

#define DS1340_REG_CONTROL_OUT  0x80
#define DS1340_REG_CONTROL_FT   0x40
#define DS1340_REG_CONTROL_CALIB_SIGN   0x20
#define DS1340_REG_CONTROL_M_CALIBRATION    0x1f

#define DS1340_REG_FLAG_OSF 0x80

#define DS1337_REG_STATUS_OSF   0x80
#define DS1337_REG_STATUS_A2I   0x02
#define DS1337_REG_STATUS_A1I   0x01

#define RX8025_REG_CONTROL1_2412    0x20

#define RX8025_REG_CONTROL2_PON 0x10
#define RX8025_REG_CONTROL2_VDET    0x40
#define RX8025_REG_CONTROL2_XST 0x20

typedef uint8_t DS1307_RTC_TIME[7];
 
typedef struct _DS1307_RTC_DEVICE DS1307_RTC_DEVICE;
struct _DS1307_RTC_DEVICE
{
    // RTC Properties
    RTC_DEVICE rtc;
    // DS1307 Properties
    I2C_DEVICE *i2c; 
    uint16_t address; 
    uint32_t chip; 
    uint8_t rtcreg; 
    uint8_t nvramreg; 
    uint8_t nvramsize; 
    uint8_t controlreg; 
    // Statistics Properties
    uint32_t readcount; 
    uint32_t writecount; 
};
 


RTC_DEVICE * STDCALL ds1307_rtc_create(char *device, uint16_t address, uint32_t chip);

uint32_t STDCALL ds1307_rtc_destroy(RTC_DEVICE *rtc);
 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_DS1307_H