1wire.h
author darius@Inchoate
Mon, 19 Jan 2009 22:54:19 +1030
changeset 71 553c061fda7c
parent 48 94f71ddb0cda
permissions -rw-r--r--
Keep the newer GCC happy.
     1 /*
     2  * 1 wire header which defines functions and constants
     3  *
     4  * $Id$
     5  *
     6  * Copyright (c) 2004
     7  *      Daniel O'Connor <darius@dons.net.au>.  All rights reserved.
     8  *
     9  * Redistribution and use in source and binary forms, with or without
    10  * modification, are permitted provided that the following conditions
    11  * are met:
    12  * 1. Redistributions of source code must retain the above copyright
    13  *    notice, this list of conditions and the following disclaimer.
    14  * 2. Redistributions in binary form must reproduce the above copyright
    15  *    notice, this list of conditions and the following disclaimer in the
    16  *    documentation and/or other materials provided with the distribution.
    17  *
    18  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
    19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    21  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
    22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    28  * SUCH DAMAGE.
    29  */
    30 
    31 void		OWInit(void);
    32 uint8_t		OWTouchReset(void);
    33 void		OWWriteBit(uint8_t bit);
    34 uint8_t		OWReadBit(void);
    35 void		OWWriteByte(uint8_t data);
    36 uint8_t		OWReadByte(void);
    37 uint8_t		OWTouchByte(uint8_t data);
    38 void		OWBlock(uint8_t *data, int len);
    39 uint8_t		OWFirst(uint8_t *ROM, uint8_t do_reset, uint8_t alarm_only);
    40 uint8_t		OWNext(uint8_t *ROM, uint8_t do_reset, uint8_t alarm_only);
    41 void		OWCRC(uint8_t x, uint8_t *crc);
    42 void		OWSendCmd(uint8_t *ROM, uint8_t cmd);
    43 uint8_t		OWProgROM(uint8_t *ROM, uint8_t start, uint8_t len, uint8_t *data, uint8_t exact, uint8_t status);
    44 int16_t		OWGetTemp(uint8_t *ROM);
    45 extern const PROGMEM char *OWProgROM_Status[];
    46 
    47 
    48 /* Return codes for OWFirst()/OWNext() */
    49 #define OW_BADWIRE		-3
    50 #define OW_BADCRC		-2
    51 #define OW_NOPRESENCE		-1
    52 #define OW_NOMODULES		0
    53 #define OW_FOUND		1
    54 
    55 /* General 1 wire commands */
    56 #define OW_OVRDRV_SKIP_CMD	0x3c
    57 #define OW_SEARCH_ALRM_CMD	0xec
    58 #define OW_SEARCH_ROM_CMD	0xf0
    59 #define OW_READ_ROM_CMD		0x33
    60 #define OW_MATCH_ROM_CMD	0x55
    61 #define OW_SKIP_ROM_CMD		0xcc
    62 
    63 /* DS1820 commands */
    64 #define OW_CONVERTT_CMD		0x44
    65 #define OW_RD_SCR_CMD		0xbe
    66 #define OW_WR_SCR_CMD		0x4e
    67 #define OW_CPY_SCR_CMD		0x48
    68 #define OW_RECALL_CMD		0xb8
    69 #define OW_RD_PSU_CMD		0xb4
    70 
    71 /* DS2502 commands */
    72 #define OW_READ_MEMORY		0xf0
    73 #define OW_READ_STATUS		0xaa
    74 #define OW_GEN_CRC		0xc3
    75 #define OW_WRITE_MEMORY		0x0f
    76 #define OW_WRITE_STATUS		0x55
    77 
    78 /* Family codes */
    79 #define OW_FAMILY_ROM		0x09
    80 #define OW_FAMILY_TEMP		0x10
    81 
    82 /* Return codes for OWGetTemp */
    83 /* XXX: make bigger otherwise we can't handle stuff below -10C */
    84 #define OW_TEMP_BADVAL		-1000
    85 #define OW_TEMP_WRONG_FAM	-1000
    86 #define OW_TEMP_CRC_ERR		-1001
    87 #define OW_TEMP_NO_ROM		-1002
    88 
    89 /* Helpers for OWGetTemp's number system */
    90 #define GETWHOLE(x)	((x) / 100)
    91 #define GETFRAC(x)	abs((x) - (GETWHOLE(x) * 100))