annotate 1wire-config.h @ 7:d111f64eb619

Add example 1wire-config.h file for other people to look at.
author darius@inchoate.localdomain
date Mon, 20 Apr 2009 14:05:20 +0800
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
1 /*
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
2 * Example configuration header for 1-wire bus code.
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
3 *
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
4 * This is the user servicable stuff - how to do delays and how to
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
5 * frob the IO pins.
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
6 *
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
7 * Copyright (c) 2009
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
8 * Daniel O'Connor <darius@dons.net.au>. All rights reserved.
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
9 *
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
10 * Redistribution and use in source and binary forms, with or without
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
11 * modification, are permitted provided that the following conditions
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
12 * are met:
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
13 * 1. Redistributions of source code must retain the above copyright
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
14 * notice, this list of conditions and the following disclaimer.
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
15 * 2. Redistributions in binary form must reproduce the above copyright
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
16 * notice, this list of conditions and the following disclaimer in the
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
17 * documentation and/or other materials provided with the distribution.
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
18 *
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
19 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
22 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
29 * SUCH DAMAGE.
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
30 */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
31
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
32 /*
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
33 * Alter these for your configuration
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
34 *
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
35 * The configuration described here has the 1-wire read on D3,
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
36 * a pulldown transistor on D4 and VPP controlled by D5.
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
37 */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
38 #error You must edit this file to suit your project
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
39
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
40 /* Initialise the DDR pins if necessary */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
41 #define OWBUSINIT() do { \
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
42 DDRD |= _BV(4); \
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
43 DDRD &= ~_BV(3); \
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
44 } while (0)
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
45
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
46 /* Set the port up to allow reading from the 1 wire bus */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
47 #define OWSETREAD() \
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
48 do { \
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
49 } while (0)
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
50
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
51
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
52 /* Read the 1-wire bus, non-inverting logic */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
53 #define OWREADBUS() (PIND & _BV(3) ? 1 : 0)
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
54
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
55 /* Set the 1-wire bus to 0
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
56 * Turns a transistor on to pull it low
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
57 */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
58 #define OWSETBUSLOW() PORTD |= _BV(4)
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
59
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
60 /* Set the 1-wire bus to 1
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
61 * Turn the transistor off to let the pullup do its job
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
62 */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
63 #define OWSETBUSHIGH() PORTD &= ~_BV(4)
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
64
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
65 /* Turn Vpp on (ie put +12V on the bus
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
66 * This is optional, if it is undefined OWProgROM always fails */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
67 #define OWSETVPPON() PORTD |= _BV(5)
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
68 #define OWSETVPPOFF() PORTD &= ~_BV(5)
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
69
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
70 /* _delay_us can only do a delay of 768/clock_freq */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
71 #if F_CPU > 16000000
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
72 #error F_CPU > 16MHz, delays need adjusting
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
73 #endif
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
74
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
75 #define OWDELAY_A _delay_us(6) /* 6 usec */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
76 #define OWDELAY_B do { _delay_us(48); _delay_us(16); } while (0) /* 64 usec */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
77 #define OWDELAY_C do { _delay_us(48); _delay_us(12); } while (0) /* 60 usec */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
78 #define OWDELAY_D _delay_us(10) /* 10 usec */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
79 #define OWDELAY_E _delay_us(9) /* 9 usec */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
80 #define OWDELAY_F do { _delay_us(55); } while (0) /* 55 usec */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
81 #define OWDELAY_G /* 0 usec */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
82 #define OWDELAY_H do { _delay_us(48); _delay_us(48); _delay_us(48); \
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
83 _delay_us(48); _delay_us(48); _delay_us(48); _delay_us(48); \
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
84 _delay_us(48);_delay_us(48); _delay_us(48); } while (0) /* 480 usec */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
85 #define OWDELAY_I do { _delay_us(48); _delay_us(22); } while (0) /* 70 usec */
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
86
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
87 #ifdef OW_DEBUG
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
88 #define OWPUTS(x) puts_P(x)
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
89 #define OWPUTSP(x) puts_P(x)
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
90 #define OWPRINTFP(fmt, ...) printf_P(fmt, ## __VA_ARGS__)
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
91 #else
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
92 #define OWPUTS(x)
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
93 #define OWPUTSP(x)
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
94 #define OWPRINTFP(fmt, ...)
d111f64eb619 Add example 1wire-config.h file for other people to look at.
darius@inchoate.localdomain
parents:
diff changeset
95 #endif