RomId.hpp

00001 /*******************************************************************************
00002 * Copyright (C) 2017 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 MaximInterface_RomId
00034 #define MaximInterface_RomId
00035 
00036 #include "array_span.hpp"
00037 #include "crc.hpp"
00038 
00039 namespace MaximInterface {
00040 
00041 /// Standard container for a 1-Wire ROM ID.
00042 typedef array_span<uint_least8_t, 8> RomId;
00043 
00044 /// @name Family Code
00045 /// @{
00046 
00047 /// Get the Family Code byte.
00048 inline RomId::element familyCode(RomId::const_span romId) {
00049   return romId[0];
00050 }
00051 
00052 /// Set the Family Code byte.
00053 inline void setFamilyCode(RomId::span romId, RomId::element familyCode) {
00054   romId[0] = familyCode;
00055 }
00056 
00057 /// @}
00058 
00059 /// @name CRC8
00060 /// @{
00061 
00062 /// Get the CRC8 byte.
00063 inline RomId::element crc8(RomId::const_span romId) { 
00064   return *romId.last<1>().data();
00065 }
00066 
00067 /// Set the CRC8 byte.
00068 inline void setCrc8(RomId::span romId, RomId::element crc8) {
00069   *romId.last<1>().data() = crc8;
00070 }
00071 
00072 /// @}
00073 
00074 /// @brief Check if the ROM ID is valid (Family Code and CRC8 are both valid).
00075 /// @returns True if the ROM ID is valid.
00076 inline bool valid(RomId::const_span romId) {
00077   return calculateCrc8(romId.first(romId.size() - 1)) == crc8(romId);
00078 }
00079 
00080 } // namespace MaximInterface
00081 
00082 #endif