Mercurial > ~darius > hgwebdir.cgi > avr

annotate ds1307.h @ 61:0910ab6f0095

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