Aleksandrs Gumenuks / MaximInterface_Extended

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   mbed_DS28EC20_GPIO

Utilities/RomId.hpp@0:f77ad7f72d04, 2017-11-06 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Nov 06 14:39:18 2017 -0600
Revision:
0:f77ad7f72d04
Child:
6:a8c83a2e6fa4
Initial commit.

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 0:f77ad7f72d04 36 #include "array.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 0:f77ad7f72d04 42 typedef array<uint_least8_t, 8> RomId;
IanBenzMaxim 0:f77ad7f72d04 43
IanBenzMaxim 0:f77ad7f72d04 44 /// @{
IanBenzMaxim 0:f77ad7f72d04 45 /// Access the Family Code byte.
IanBenzMaxim 0:f77ad7f72d04 46 inline RomId::value_type familyCode(const RomId & romId) {
IanBenzMaxim 0:f77ad7f72d04 47 return romId.front();
IanBenzMaxim 0:f77ad7f72d04 48 }
IanBenzMaxim 0:f77ad7f72d04 49 inline void setFamilyCode(RomId & romId, RomId::value_type familyCode) {
IanBenzMaxim 0:f77ad7f72d04 50 romId.front() = familyCode;
IanBenzMaxim 0:f77ad7f72d04 51 }
IanBenzMaxim 0:f77ad7f72d04 52 /// @}
IanBenzMaxim 0:f77ad7f72d04 53
IanBenzMaxim 0:f77ad7f72d04 54 /// @{
IanBenzMaxim 0:f77ad7f72d04 55 /// Access the CRC8 byte.
IanBenzMaxim 0:f77ad7f72d04 56 inline RomId::value_type crc8(const RomId & romId) { return romId.back(); }
IanBenzMaxim 0:f77ad7f72d04 57 inline void setCrc8(RomId & romId, RomId::value_type crc8) {
IanBenzMaxim 0:f77ad7f72d04 58 romId.back() = crc8;
IanBenzMaxim 0:f77ad7f72d04 59 }
IanBenzMaxim 0:f77ad7f72d04 60 /// @}
IanBenzMaxim 0:f77ad7f72d04 61
IanBenzMaxim 0:f77ad7f72d04 62 /// Check if the ROM ID is valid (Family Code and CRC8 are both valid).
IanBenzMaxim 0:f77ad7f72d04 63 /// @returns True if the ROM ID is valid.
IanBenzMaxim 0:f77ad7f72d04 64 inline bool valid(const RomId & romId) {
IanBenzMaxim 0:f77ad7f72d04 65 return calculateCrc8(romId.data(), romId.size() - 1) == crc8(romId);
IanBenzMaxim 0:f77ad7f72d04 66 }
IanBenzMaxim 0:f77ad7f72d04 67
IanBenzMaxim 0:f77ad7f72d04 68 } // namespace MaximInterface
IanBenzMaxim 0:f77ad7f72d04 69
IanBenzMaxim 0:f77ad7f72d04 70 #endif