Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Utilities/RomId.hpp@8:211d1b8f730c, 2019-04-03 (annotated)

Committer:
reARMnimator
Date:
Wed Apr 03 12:33:10 2019 +0000
Revision:
8:211d1b8f730c
Parent:
7:471901a04573 
Merge with version 1.7;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 0:f77ad7f72d04 1 /*******************************************************************************
IanBenzMaxim 0:f77ad7f72d04 2 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 0:f77ad7f72d04 3 *
IanBenzMaxim 0:f77ad7f72d04 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 0:f77ad7f72d04 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 0:f77ad7f72d04 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 0:f77ad7f72d04 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 0:f77ad7f72d04 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 0:f77ad7f72d04 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 0:f77ad7f72d04 10 *
IanBenzMaxim 0:f77ad7f72d04 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 0:f77ad7f72d04 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 0:f77ad7f72d04 13 *
IanBenzMaxim 0:f77ad7f72d04 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 0:f77ad7f72d04 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 0:f77ad7f72d04 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 0:f77ad7f72d04 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 0:f77ad7f72d04 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 0:f77ad7f72d04 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 0:f77ad7f72d04 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 0:f77ad7f72d04 21 *
IanBenzMaxim 0:f77ad7f72d04 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 0:f77ad7f72d04 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 0:f77ad7f72d04 24 * Products, Inc. Branding Policy.
IanBenzMaxim 0:f77ad7f72d04 25 *
IanBenzMaxim 0:f77ad7f72d04 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 0:f77ad7f72d04 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 0:f77ad7f72d04 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 0:f77ad7f72d04 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 0:f77ad7f72d04 30 * ownership rights.
IanBenzMaxim 0:f77ad7f72d04 31 *******************************************************************************/
IanBenzMaxim 0:f77ad7f72d04 32
IanBenzMaxim 0:f77ad7f72d04 33 #ifndef MaximInterface_RomId
IanBenzMaxim 0:f77ad7f72d04 34 #define MaximInterface_RomId
IanBenzMaxim 0:f77ad7f72d04 35
IanBenzMaxim 6:a8c83a2e6fa4 36 #include "array_span.hpp"
IanBenzMaxim 0:f77ad7f72d04 37 #include "crc.hpp"
IanBenzMaxim 0:f77ad7f72d04 38
IanBenzMaxim 0:f77ad7f72d04 39 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 40
IanBenzMaxim 0:f77ad7f72d04 41 /// Standard container for a 1-Wire ROM ID.
IanBenzMaxim 6:a8c83a2e6fa4 42 typedef array_span<uint_least8_t, 8> RomId;
IanBenzMaxim 0:f77ad7f72d04 43
IanBenzMaxim 7:471901a04573 44 /// @name Family Code
IanBenzMaxim 0:f77ad7f72d04 45 /// @{
IanBenzMaxim 7:471901a04573 46
IanBenzMaxim 7:471901a04573 47 /// Get the Family Code byte.
IanBenzMaxim 6:a8c83a2e6fa4 48 inline RomId::element familyCode(RomId::const_span romId) {
IanBenzMaxim 6:a8c83a2e6fa4 49 return romId[0];
IanBenzMaxim 0:f77ad7f72d04 50 }
IanBenzMaxim 6:a8c83a2e6fa4 51
IanBenzMaxim 7:471901a04573 52 /// Set the Family Code byte.
IanBenzMaxim 6:a8c83a2e6fa4 53 inline void setFamilyCode(RomId::span romId, RomId::element familyCode) {
IanBenzMaxim 6:a8c83a2e6fa4 54 romId[0] = familyCode;
IanBenzMaxim 0:f77ad7f72d04 55 }
IanBenzMaxim 7:471901a04573 56
IanBenzMaxim 0:f77ad7f72d04 57 /// @}
IanBenzMaxim 0:f77ad7f72d04 58
IanBenzMaxim 7:471901a04573 59 /// @name CRC8
IanBenzMaxim 0:f77ad7f72d04 60 /// @{
IanBenzMaxim 7:471901a04573 61
IanBenzMaxim 7:471901a04573 62 /// Get the CRC8 byte.
IanBenzMaxim 6:a8c83a2e6fa4 63 inline RomId::element crc8(RomId::const_span romId) {
IanBenzMaxim 6:a8c83a2e6fa4 64 return *romId.last<1>().data();
IanBenzMaxim 6:a8c83a2e6fa4 65 }
IanBenzMaxim 6:a8c83a2e6fa4 66
IanBenzMaxim 7:471901a04573 67 /// Set the CRC8 byte.
IanBenzMaxim 6:a8c83a2e6fa4 68 inline void setCrc8(RomId::span romId, RomId::element crc8) {
IanBenzMaxim 6:a8c83a2e6fa4 69 *romId.last<1>().data() = crc8;
IanBenzMaxim 0:f77ad7f72d04 70 }
IanBenzMaxim 7:471901a04573 71
IanBenzMaxim 0:f77ad7f72d04 72 /// @}
IanBenzMaxim 0:f77ad7f72d04 73
IanBenzMaxim 7:471901a04573 74 /// @brief Check if the ROM ID is valid (Family Code and CRC8 are both valid).
IanBenzMaxim 0:f77ad7f72d04 75 /// @returns True if the ROM ID is valid.
IanBenzMaxim 6:a8c83a2e6fa4 76 inline bool valid(RomId::const_span romId) {
IanBenzMaxim 6:a8c83a2e6fa4 77 return calculateCrc8(romId.first(romId.size() - 1)) == crc8(romId);
IanBenzMaxim 0:f77ad7f72d04 78 }
IanBenzMaxim 0:f77ad7f72d04 79
IanBenzMaxim 0:f77ad7f72d04 80 } // namespace MaximInterface
IanBenzMaxim 0:f77ad7f72d04 81
IanBenzMaxim 0:f77ad7f72d04 82 #endif