Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Links/RomCommands.hpp@7:471901a04573, 2019-03-04 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Mar 04 08:10:00 2019 -0600
Revision:
7:471901a04573
Parent:
6:a8c83a2e6fa4 
Updated to 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 6:a8c83a2e6fa4 33 /// @file
IanBenzMaxim 7:471901a04573 34 /// @brief ROM Commands for enumerating and selecting 1-Wire devices.
IanBenzMaxim 0:f77ad7f72d04 35
IanBenzMaxim 0:f77ad7f72d04 36 #ifndef MaximInterface_RomCommands
IanBenzMaxim 0:f77ad7f72d04 37 #define MaximInterface_RomCommands
IanBenzMaxim 0:f77ad7f72d04 38
IanBenzMaxim 0:f77ad7f72d04 39 #include <stdint.h>
IanBenzMaxim 0:f77ad7f72d04 40 #include <MaximInterface/Utilities/Export.h>
IanBenzMaxim 0:f77ad7f72d04 41 #include <MaximInterface/Utilities/RomId.hpp>
IanBenzMaxim 0:f77ad7f72d04 42 #include "OneWireMaster.hpp"
IanBenzMaxim 0:f77ad7f72d04 43
IanBenzMaxim 0:f77ad7f72d04 44 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 45
IanBenzMaxim 0:f77ad7f72d04 46 /// State used by Search ROM command.
IanBenzMaxim 0:f77ad7f72d04 47 struct SearchRomState {
IanBenzMaxim 6:a8c83a2e6fa4 48 RomId::array romId;
IanBenzMaxim 0:f77ad7f72d04 49 int_least8_t lastDiscrepancy;
IanBenzMaxim 0:f77ad7f72d04 50 int_least8_t lastFamilyDiscrepancy;
IanBenzMaxim 0:f77ad7f72d04 51 bool lastDevice;
IanBenzMaxim 0:f77ad7f72d04 52
IanBenzMaxim 0:f77ad7f72d04 53 SearchRomState()
IanBenzMaxim 0:f77ad7f72d04 54 : romId(), lastDiscrepancy(0), lastFamilyDiscrepancy(0),
IanBenzMaxim 0:f77ad7f72d04 55 lastDevice(false) {}
IanBenzMaxim 0:f77ad7f72d04 56
IanBenzMaxim 6:a8c83a2e6fa4 57 explicit SearchRomState(RomId::const_span romId)
IanBenzMaxim 6:a8c83a2e6fa4 58 : lastDiscrepancy(64), lastFamilyDiscrepancy(0), lastDevice(false) {
IanBenzMaxim 6:a8c83a2e6fa4 59 copy(romId, make_span(this->romId));
IanBenzMaxim 6:a8c83a2e6fa4 60 }
IanBenzMaxim 0:f77ad7f72d04 61
IanBenzMaxim 6:a8c83a2e6fa4 62 explicit SearchRomState(RomId::element familyCode)
IanBenzMaxim 0:f77ad7f72d04 63 : romId(), lastDiscrepancy(64), lastFamilyDiscrepancy(0),
IanBenzMaxim 0:f77ad7f72d04 64 lastDevice(false) {
IanBenzMaxim 0:f77ad7f72d04 65 setFamilyCode(romId, familyCode);
IanBenzMaxim 0:f77ad7f72d04 66 }
IanBenzMaxim 0:f77ad7f72d04 67 };
IanBenzMaxim 0:f77ad7f72d04 68
IanBenzMaxim 7:471901a04573 69 /// @brief
IanBenzMaxim 0:f77ad7f72d04 70 /// Set the search state to skip the current device family on the next
IanBenzMaxim 0:f77ad7f72d04 71 /// Search ROM command.
IanBenzMaxim 0:f77ad7f72d04 72 MaximInterface_EXPORT void skipCurrentFamily(SearchRomState & searchState);
IanBenzMaxim 0:f77ad7f72d04 73
IanBenzMaxim 0:f77ad7f72d04 74 /// Verify that the device with the specified ROM ID is present.
IanBenzMaxim 0:f77ad7f72d04 75 MaximInterface_EXPORT error_code verifyRom(OneWireMaster & master,
IanBenzMaxim 6:a8c83a2e6fa4 76 RomId::const_span romId);
IanBenzMaxim 0:f77ad7f72d04 77
IanBenzMaxim 7:471901a04573 78 /// @brief Use Read ROM command to read ROM ID from device on bus.
IanBenzMaxim 7:471901a04573 79 /// @note
IanBenzMaxim 7:471901a04573 80 /// Only use this command with a single-drop bus.
IanBenzMaxim 7:471901a04573 81 /// Data collisions will occur if there is more than one device on the bus.
IanBenzMaxim 7:471901a04573 82 /// @param master 1-Wire master for operation.
IanBenzMaxim 0:f77ad7f72d04 83 /// @param[out] romId ROM ID read from device.
IanBenzMaxim 6:a8c83a2e6fa4 84 MaximInterface_EXPORT error_code readRom(OneWireMaster & master,
IanBenzMaxim 6:a8c83a2e6fa4 85 RomId::span romId);
IanBenzMaxim 0:f77ad7f72d04 86
IanBenzMaxim 7:471901a04573 87 /// @brief Issue Skip ROM command on bus.
IanBenzMaxim 7:471901a04573 88 /// @note
IanBenzMaxim 7:471901a04573 89 /// Only use this command with a single-drop bus.
IanBenzMaxim 7:471901a04573 90 /// Data collisions will occur if there is more than one device on the bus.
IanBenzMaxim 0:f77ad7f72d04 91 MaximInterface_EXPORT error_code skipRom(OneWireMaster & master);
IanBenzMaxim 0:f77ad7f72d04 92
IanBenzMaxim 7:471901a04573 93 /// @brief Use the Match ROM command to select the device by its known ID.
IanBenzMaxim 7:471901a04573 94 /// @note
IanBenzMaxim 7:471901a04573 95 /// This command causes all devices supporting Overdrive mode to switch to
IanBenzMaxim 7:471901a04573 96 /// Overdrive timing.
IanBenzMaxim 7:471901a04573 97 /// @param master 1-Wire master for operation.
IanBenzMaxim 0:f77ad7f72d04 98 /// @param[in] romId ROM ID of device to select.
IanBenzMaxim 0:f77ad7f72d04 99 MaximInterface_EXPORT error_code matchRom(OneWireMaster & master,
IanBenzMaxim 6:a8c83a2e6fa4 100 RomId::const_span romId);
IanBenzMaxim 0:f77ad7f72d04 101
IanBenzMaxim 7:471901a04573 102 /// @brief Issue Overdrive Skip ROM command on bus.
IanBenzMaxim 7:471901a04573 103 /// @note
IanBenzMaxim 7:471901a04573 104 /// This command causes all devices supporting Overdrive mode to switch to
IanBenzMaxim 7:471901a04573 105 /// Overdrive timing.
IanBenzMaxim 7:471901a04573 106 /// @note
IanBenzMaxim 7:471901a04573 107 /// Only use this command with a single-drop bus.
IanBenzMaxim 7:471901a04573 108 /// Data collisions will occur if there is more than one device on the bus.
IanBenzMaxim 0:f77ad7f72d04 109 MaximInterface_EXPORT error_code overdriveSkipRom(OneWireMaster & master);
IanBenzMaxim 0:f77ad7f72d04 110
IanBenzMaxim 7:471901a04573 111 /// @brief
IanBenzMaxim 0:f77ad7f72d04 112 /// Use the Overdrive Match ROM command to select the device by its known ID.
IanBenzMaxim 7:471901a04573 113 /// @param master 1-Wire master for operation.
IanBenzMaxim 0:f77ad7f72d04 114 /// @param[in] romId ROM ID of device to select.
IanBenzMaxim 0:f77ad7f72d04 115 MaximInterface_EXPORT error_code overdriveMatchRom(OneWireMaster & master,
IanBenzMaxim 6:a8c83a2e6fa4 116 RomId::const_span romId);
IanBenzMaxim 0:f77ad7f72d04 117
IanBenzMaxim 7:471901a04573 118 /// @brief Perform a Resume ROM command on bus.
IanBenzMaxim 7:471901a04573 119 /// @details
IanBenzMaxim 7:471901a04573 120 /// Resumes communication with the last device selected through a Match ROM or
IanBenzMaxim 7:471901a04573 121 /// Search ROM operation.
IanBenzMaxim 0:f77ad7f72d04 122 MaximInterface_EXPORT error_code resumeRom(OneWireMaster & master);
IanBenzMaxim 0:f77ad7f72d04 123
IanBenzMaxim 7:471901a04573 124 /// @brief Find device on the 1-Wire bus.
IanBenzMaxim 0:f77ad7f72d04 125 /// @details
IanBenzMaxim 0:f77ad7f72d04 126 /// This command uses the Search ROM command to enumerate all 1-Wire devices in
IanBenzMaxim 0:f77ad7f72d04 127 /// sequence. Begin with a new search state and continue using the same search
IanBenzMaxim 0:f77ad7f72d04 128 /// state until the last device flag is set which indicates that all devices
IanBenzMaxim 0:f77ad7f72d04 129 /// have been discovered.
IanBenzMaxim 0:f77ad7f72d04 130 MaximInterface_EXPORT error_code searchRom(OneWireMaster & master,
IanBenzMaxim 0:f77ad7f72d04 131 SearchRomState & searchState);
IanBenzMaxim 0:f77ad7f72d04 132
IanBenzMaxim 0:f77ad7f72d04 133 } // namespace MaximInterface
IanBenzMaxim 0:f77ad7f72d04 134
IanBenzMaxim 0:f77ad7f72d04 135 #endif