Dependencies:   mbed

Committer:
gbeardall
Date:
Mon Oct 17 10:42:00 2011 +0000
Revision:
0:2f78e3dca55d

        

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gbeardall 0:2f78e3dca55d 1 /*
gbeardall 0:2f78e3dca55d 2 * OneWireCRC. This is a port to mbed of Jim Studt's Adruino One Wire
gbeardall 0:2f78e3dca55d 3 * library. Please see additional copyrights below this one, including
gbeardall 0:2f78e3dca55d 4 * references to other copyrights.
gbeardall 0:2f78e3dca55d 5 *
gbeardall 0:2f78e3dca55d 6 * Copyright (C) <2009> Petras Saduikis <petras@petras.co.uk>
gbeardall 0:2f78e3dca55d 7 *
gbeardall 0:2f78e3dca55d 8 * This file is part of OneWireCRC.
gbeardall 0:2f78e3dca55d 9 *
gbeardall 0:2f78e3dca55d 10 * OneWireCRC is free software: you can redistribute it and/or modify
gbeardall 0:2f78e3dca55d 11 * it under the terms of the GNU General Public License as published by
gbeardall 0:2f78e3dca55d 12 * the Free Software Foundation, either version 3 of the License, or
gbeardall 0:2f78e3dca55d 13 * (at your option) any later version.
gbeardall 0:2f78e3dca55d 14 *
gbeardall 0:2f78e3dca55d 15 * OneWireCRC is distributed in the hope that it will be useful,
gbeardall 0:2f78e3dca55d 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
gbeardall 0:2f78e3dca55d 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
gbeardall 0:2f78e3dca55d 18 * GNU General Public License for more details.
gbeardall 0:2f78e3dca55d 19 *
gbeardall 0:2f78e3dca55d 20 * You should have received a copy of the GNU General Public License
gbeardall 0:2f78e3dca55d 21 * along with OneWireCRC. If not, see <http://www.gnu.org/licenses/>.
gbeardall 0:2f78e3dca55d 22 */
gbeardall 0:2f78e3dca55d 23 /*
gbeardall 0:2f78e3dca55d 24 Copyright (c) 2007, Jim Studt
gbeardall 0:2f78e3dca55d 25
gbeardall 0:2f78e3dca55d 26 Updated to work with arduino-0008 and to include skip() as of
gbeardall 0:2f78e3dca55d 27 2007/07/06. --RJL20
gbeardall 0:2f78e3dca55d 28
gbeardall 0:2f78e3dca55d 29 Modified to calculate the 8-bit CRC directly, avoiding the need for
gbeardall 0:2f78e3dca55d 30 the 256-byte lookup table to be loaded in RAM. Tested in arduino-0010
gbeardall 0:2f78e3dca55d 31 -- Tom Pollard, Jan 23, 2008
gbeardall 0:2f78e3dca55d 32
gbeardall 0:2f78e3dca55d 33 Permission is hereby granted, free of charge, to any person obtaining
gbeardall 0:2f78e3dca55d 34 a copy of this software and associated documentation files (the
gbeardall 0:2f78e3dca55d 35 "Software"), to deal in the Software without restriction, including
gbeardall 0:2f78e3dca55d 36 without limitation the rights to use, copy, modify, merge, publish,
gbeardall 0:2f78e3dca55d 37 distribute, sublicense, and/or sell copies of the Software, and to
gbeardall 0:2f78e3dca55d 38 permit persons to whom the Software is furnished to do so, subject to
gbeardall 0:2f78e3dca55d 39 the following conditions:
gbeardall 0:2f78e3dca55d 40
gbeardall 0:2f78e3dca55d 41 The above copyright notice and this permission notice shall be
gbeardall 0:2f78e3dca55d 42 included in all copies or substantial portions of the Software.
gbeardall 0:2f78e3dca55d 43
gbeardall 0:2f78e3dca55d 44 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
gbeardall 0:2f78e3dca55d 45 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
gbeardall 0:2f78e3dca55d 46 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
gbeardall 0:2f78e3dca55d 47 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
gbeardall 0:2f78e3dca55d 48 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
gbeardall 0:2f78e3dca55d 49 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
gbeardall 0:2f78e3dca55d 50 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
gbeardall 0:2f78e3dca55d 51
gbeardall 0:2f78e3dca55d 52 Much of the code was inspired by Derek Yerger's code, though I don't
gbeardall 0:2f78e3dca55d 53 think much of that remains. In any event that was..
gbeardall 0:2f78e3dca55d 54 (copyleft) 2006 by Derek Yerger - Free to distribute freely.
gbeardall 0:2f78e3dca55d 55
gbeardall 0:2f78e3dca55d 56 The CRC code was excerpted and inspired by the Dallas Semiconductor
gbeardall 0:2f78e3dca55d 57 sample code bearing this copyright.
gbeardall 0:2f78e3dca55d 58 */
gbeardall 0:2f78e3dca55d 59 //---------------------------------------------------------------------------
gbeardall 0:2f78e3dca55d 60 // Copyright (C) 2000 Dallas Semiconductor Corporation, All Rights Reserved.
gbeardall 0:2f78e3dca55d 61 //
gbeardall 0:2f78e3dca55d 62 // Permission is hereby granted, free of charge, to any person obtaining a
gbeardall 0:2f78e3dca55d 63 // copy of this software and associated documentation files (the "Software"),
gbeardall 0:2f78e3dca55d 64 // to deal in the Software without restriction, including without limitation
gbeardall 0:2f78e3dca55d 65 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
gbeardall 0:2f78e3dca55d 66 // and/or sell copies of the Software, and to permit persons to whom the
gbeardall 0:2f78e3dca55d 67 // Software is furnished to do so, subject to the following conditions:
gbeardall 0:2f78e3dca55d 68 //
gbeardall 0:2f78e3dca55d 69 // The above copyright notice and this permission notice shall be included
gbeardall 0:2f78e3dca55d 70 // in all copies or substantial portions of the Software.
gbeardall 0:2f78e3dca55d 71 //
gbeardall 0:2f78e3dca55d 72 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
gbeardall 0:2f78e3dca55d 73 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
gbeardall 0:2f78e3dca55d 74 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
gbeardall 0:2f78e3dca55d 75 // IN NO EVENT SHALL DALLAS SEMICONDUCTOR BE LIABLE FOR ANY CLAIM, DAMAGES
gbeardall 0:2f78e3dca55d 76 // OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
gbeardall 0:2f78e3dca55d 77 // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
gbeardall 0:2f78e3dca55d 78 // OTHER DEALINGS IN THE SOFTWARE.
gbeardall 0:2f78e3dca55d 79 //
gbeardall 0:2f78e3dca55d 80 // Except as contained in this notice, the name of Dallas Semiconductor
gbeardall 0:2f78e3dca55d 81 // shall not be used except as stated in the Dallas Semiconductor
gbeardall 0:2f78e3dca55d 82 // Branding Policy.
gbeardall 0:2f78e3dca55d 83 //--------------------------------------------------------------------------
gbeardall 0:2f78e3dca55d 84
gbeardall 0:2f78e3dca55d 85 #ifndef SNATCH59_ONEWIRECRC_H
gbeardall 0:2f78e3dca55d 86 #define SNATCH59_ONEWIRECRC_H
gbeardall 0:2f78e3dca55d 87
gbeardall 0:2f78e3dca55d 88 #include <mbed.h>
gbeardall 0:2f78e3dca55d 89
gbeardall 0:2f78e3dca55d 90 // Select the table-lookup method of computing the 8-bit CRC by setting this to 1
gbeardall 0:2f78e3dca55d 91 #ifndef ONEWIRE_CRC8_TABLE
gbeardall 0:2f78e3dca55d 92 #define ONEWIRE_CRC8_TABLE 1
gbeardall 0:2f78e3dca55d 93 #endif
gbeardall 0:2f78e3dca55d 94
gbeardall 0:2f78e3dca55d 95 typedef unsigned char BYTE; // used to be uint8_t : something a byte wide, whatever ....
gbeardall 0:2f78e3dca55d 96
gbeardall 0:2f78e3dca55d 97 enum eSpeed {OVERDRIVE, STANDARD};
gbeardall 0:2f78e3dca55d 98
gbeardall 0:2f78e3dca55d 99 class OneWireCRC
gbeardall 0:2f78e3dca55d 100 {
gbeardall 0:2f78e3dca55d 101 public:
gbeardall 0:2f78e3dca55d 102 OneWireCRC(PinName oneWire, eSpeed);
gbeardall 0:2f78e3dca55d 103
gbeardall 0:2f78e3dca55d 104 // reset, read, write functions
gbeardall 0:2f78e3dca55d 105 int reset();
gbeardall 0:2f78e3dca55d 106 void writeByte(int data);
gbeardall 0:2f78e3dca55d 107 int readByte();
gbeardall 0:2f78e3dca55d 108 int touchByte(int data);
gbeardall 0:2f78e3dca55d 109 void block(BYTE* data, int data_len);
gbeardall 0:2f78e3dca55d 110 int overdriveSkip(BYTE* data, int data_len);
gbeardall 0:2f78e3dca55d 111
gbeardall 0:2f78e3dca55d 112 // address functions
gbeardall 0:2f78e3dca55d 113 void matchROM(BYTE rom[8]);
gbeardall 0:2f78e3dca55d 114 void skipROM();
gbeardall 0:2f78e3dca55d 115
gbeardall 0:2f78e3dca55d 116 // address search functions
gbeardall 0:2f78e3dca55d 117 void resetSearch();
gbeardall 0:2f78e3dca55d 118 BYTE search(BYTE* newAddr);
gbeardall 0:2f78e3dca55d 119
gbeardall 0:2f78e3dca55d 120 // CRC check functions
gbeardall 0:2f78e3dca55d 121 static BYTE crc8(BYTE* addr, BYTE len);
gbeardall 0:2f78e3dca55d 122 static unsigned short crc16(unsigned short* data, unsigned short len);
gbeardall 0:2f78e3dca55d 123
gbeardall 0:2f78e3dca55d 124 private:
gbeardall 0:2f78e3dca55d 125 const int* timing;
gbeardall 0:2f78e3dca55d 126
gbeardall 0:2f78e3dca55d 127 BYTE address[8];
gbeardall 0:2f78e3dca55d 128 int searchJunction; // so we can set to it -1 somewhere
gbeardall 0:2f78e3dca55d 129 bool searchExhausted;
gbeardall 0:2f78e3dca55d 130
gbeardall 0:2f78e3dca55d 131 DigitalInOut oneWirePort;
gbeardall 0:2f78e3dca55d 132
gbeardall 0:2f78e3dca55d 133 // read/write bit functions
gbeardall 0:2f78e3dca55d 134 void writeBit(int bit);
gbeardall 0:2f78e3dca55d 135 int readBit();
gbeardall 0:2f78e3dca55d 136 };
gbeardall 0:2f78e3dca55d 137
gbeardall 0:2f78e3dca55d 138 #endif