annotate ds1307.h @ 21:01e77066f72b default tip

Add TODO item
author Daniel O'Connor <darius@dons.net.au>
date Sun, 15 Feb 2015 16:15:23 +1030
parents b5e4591b6570
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
1 /*
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
2 * DS1307 headers
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
3 *
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
4 * Copyright (c) 2008
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
5 * Daniel O'Connor <darius@dons.net.au>. All rights reserved.
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
6 *
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
7 * Redistribution and use in source and binary forms, with or without
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
8 * modification, are permitted provided that the following conditions
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
9 * are met:
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
10 * 1. Redistributions of source code must retain the above copyright
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
11 * notice, this list of conditions and the following disclaimer.
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
12 * 2. Redistributions in binary form must reproduce the above copyright
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
13 * notice, this list of conditions and the following disclaimer in the
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
14 * documentation and/or other materials provided with the distribution.
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
15 *
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
16 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
19 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
26 * SUCH DAMAGE.
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
27 */
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
28
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
29 #define IIC_STFAIL -1
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
30 #define IIC_FAILARB -2
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
31 #define IIC_SLNAK -3
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
32 #define IIC_NOREPLY -4
8
119688bb743f Don't spin forever waiting for the TWI hardware to do something.
darius@dons.net.au
parents: 0
diff changeset
33 #define IIC_NORESP -5
0
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
34 #define IIC_UNKNOWN -99
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
35
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
36 #define DS1307_ADR 0xd0 // DS1307's TWI address
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
37
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
38 typedef struct {
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
39 uint8_t year;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
40 uint8_t month;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
41 uint8_t day;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
42 uint8_t hour;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
43 uint8_t min;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
44 uint8_t sec;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
45 } ds1307_t;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
46
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
47 typedef union {
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
48 uint8_t raw[8];
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
49 struct {
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
50 uint8_t sec : 4;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
51 uint8_t sec10 : 3; // Seconds (0-59)
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
52 uint8_t ch : 1; // Clock enable (1 = off)
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
53
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
54 uint8_t min : 4;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
55 uint8_t min10 : 3; // Minutes (0-59)
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
56 uint8_t pad0 : 1;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
57
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
58 uint8_t hour : 4;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
59 uint8_t hour10 : 1; // Hours
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
60 uint8_t pmam : 1; // AM/PM => 1 = PM or extra bit for hour10
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
61 uint8_t s1224 : 1; // 1 = 12 hour mode
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
62 uint8_t pad1 : 1;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
63
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
64 uint8_t dow : 3; // Day of the week (1-7)
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
65 uint8_t pad2 : 5;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
66
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
67 uint8_t day : 4;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
68 uint8_t day10 : 2; // Day of the month (1-31)
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
69 uint8_t pad3 : 2;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
70
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
71 uint8_t month : 4;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
72 uint8_t month10 : 1;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
73 uint8_t pad4 : 3; // Month (1-12)
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
74
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
75 uint8_t year : 4;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
76 uint8_t year10 : 4; // Year (0-99)
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
77
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
78 uint8_t rs : 2; // Rate select
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
79 uint8_t pad6 : 2;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
80 uint8_t sqwe : 1; // Square wave enable
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
81 uint8_t pad5 : 2;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
82 uint8_t out : 1; // Output control enable
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
83 } split;
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
84 } ds1307raw_t;
19
b5e4591b6570 - Satisfy new compiler
Daniel O'Connor <darius@dons.net.au>
parents: 8
diff changeset
85
b5e4591b6570 - Satisfy new compiler
Daniel O'Connor <darius@dons.net.au>
parents: 8
diff changeset
86 typedef int32_t time_t;
b5e4591b6570 - Satisfy new compiler
Daniel O'Connor <darius@dons.net.au>
parents: 8
diff changeset
87
0
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
88 int ds1307_init(void);
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
89 int8_t iic_read(uint8_t *data, uint8_t len, uint8_t adr, uint8_t sla);
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
90 int8_t iic_write(uint8_t *data, uint8_t len, uint8_t adr, uint8_t sla);
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
91 int8_t ds1307_gettod(ds1307raw_t *time);
3879f487b661 Initial commit of routines I copy and paste.
darius@Inchoate
parents:
diff changeset
92 int8_t ds1307_settod(char *date);
19
b5e4591b6570 - Satisfy new compiler
Daniel O'Connor <darius@dons.net.au>
parents: 8
diff changeset
93 void ds1307_printtime(ds1307_t *time, const char *leader, const char *trailer);
b5e4591b6570 - Satisfy new compiler
Daniel O'Connor <darius@dons.net.au>
parents: 8
diff changeset
94 void ds1307_printnow(const char *leader, const char *trailer);
b5e4591b6570 - Satisfy new compiler
Daniel O'Connor <darius@dons.net.au>
parents: 8
diff changeset
95 void ds1307_cook(ds1307raw_t *raw, ds1307_t *cooked);
b5e4591b6570 - Satisfy new compiler
Daniel O'Connor <darius@dons.net.au>
parents: 8
diff changeset
96 time_t ds1307_totimet(ds1307_t *time);
b5e4591b6570 - Satisfy new compiler
Daniel O'Connor <darius@dons.net.au>
parents: 8
diff changeset
97 time_t ds1307_time(void);