RomId.h

00001 /******************************************************************//**
00002 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
00003 *
00004 * Permission is hereby granted, free of charge, to any person obtaining a
00005 * copy of this software and associated documentation files (the "Software"),
00006 * to deal in the Software without restriction, including without limitation
00007 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008 * and/or sell copies of the Software, and to permit persons to whom the
00009 * Software is furnished to do so, subject to the following conditions:
00010 *
00011 * The above copyright notice and this permission notice shall be included
00012 * in all copies or substantial portions of the Software.
00013 *
00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020 * OTHER DEALINGS IN THE SOFTWARE.
00021 *
00022 * Except as contained in this notice, the name of Maxim Integrated
00023 * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024 * Products, Inc. Branding Policy.
00025 *
00026 * The mere transfer of this software does not imply any licenses
00027 * of trade secrets, proprietary technology, copyrights, patents,
00028 * trademarks, maskwork rights, or any other form of intellectual
00029 * property whatsoever. Maxim Integrated Products, Inc. retains all
00030 * ownership rights.
00031 **********************************************************************/
00032 
00033 #ifndef OneWire_RomId
00034 #define OneWire_RomId
00035 
00036 #include "Utilities/array.h"
00037 #include "Utilities/crc.h"
00038 
00039 namespace OneWire
00040 {
00041     /// Standard container for a 1-Wire ROM ID.
00042     struct RomId
00043     {
00044         typedef array<uint8_t, 8>  Buffer ;
00045     
00046         /// Direct access to the buffer.
00047         Buffer  buffer;
00048         /// @}
00049 
00050         /// @{
00051         /// Access the Family Code byte.
00052         uint8_t & familyCode () { return buffer.front(); }
00053         const uint8_t & familyCode () const { return buffer.front(); }
00054         /// @}
00055 
00056         /// @{
00057         /// Access the CRC8 byte.
00058         uint8_t & crc8 () { return buffer.back(); }
00059         const uint8_t & crc8 () const { return buffer.back(); }
00060         /// @}
00061 
00062         /// Check if the ROM ID is valid (Family Code and CRC8 are both valid).
00063         /// @returns True if the ROM ID is valid.
00064         bool valid() const
00065         {
00066             return crc::calculateCrc8(buffer.data(), buffer.size() - 1, 0x00) == crc8 ();
00067         }
00068         
00069         bool operator==(const RomId & rhs) const { return (this->buffer == rhs.buffer); }
00070         bool operator!=(const RomId & rhs) const { return !operator==(rhs); }
00071     };
00072 }
00073 
00074 #endif