Extended MaximInterface
Dependents: mbed_DS28EC20_GPIO
Links/SelectRom.hpp@5:3523abdda8ed, 2018-07-24 (annotated)
- Committer:
- reARMnimator
- Date:
- Tue Jul 24 08:33:31 2018 +0000
- Revision:
- 5:3523abdda8ed
- Parent:
- 0:f77ad7f72d04
- Child:
- 8:211d1b8f730c
Added extended selectrom function to pass rom id argument.
Who changed what in which revision?
User | Revision | Line number | New 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_SelectRom |
IanBenzMaxim | 0:f77ad7f72d04 | 34 | #define MaximInterface_SelectRom |
IanBenzMaxim | 0:f77ad7f72d04 | 35 | |
IanBenzMaxim | 0:f77ad7f72d04 | 36 | #include <MaximInterface/Utilities/Export.h> |
IanBenzMaxim | 0:f77ad7f72d04 | 37 | #include <MaximInterface/Utilities/Function.hpp> |
IanBenzMaxim | 0:f77ad7f72d04 | 38 | #include <MaximInterface/Utilities/RomId.hpp> |
IanBenzMaxim | 0:f77ad7f72d04 | 39 | #include <MaximInterface/Utilities/system_error.hpp> |
IanBenzMaxim | 0:f77ad7f72d04 | 40 | #include "RomCommands.hpp" |
IanBenzMaxim | 0:f77ad7f72d04 | 41 | |
IanBenzMaxim | 0:f77ad7f72d04 | 42 | namespace MaximInterface { |
IanBenzMaxim | 0:f77ad7f72d04 | 43 | |
IanBenzMaxim | 0:f77ad7f72d04 | 44 | class OneWireMaster; |
IanBenzMaxim | 0:f77ad7f72d04 | 45 | |
IanBenzMaxim | 0:f77ad7f72d04 | 46 | typedef Function<error_code(OneWireMaster &)> SelectRom; |
reARMnimator | 5:3523abdda8ed | 47 | typedef Function<error_code(OneWireMaster &, const RomId & romId)> SelectRomExt; |
IanBenzMaxim | 0:f77ad7f72d04 | 48 | |
IanBenzMaxim | 0:f77ad7f72d04 | 49 | /// Selector for a multidrop 1-Wire bus. |
IanBenzMaxim | 0:f77ad7f72d04 | 50 | class SelectMatchRom { |
IanBenzMaxim | 0:f77ad7f72d04 | 51 | public: |
IanBenzMaxim | 0:f77ad7f72d04 | 52 | typedef SelectRom::argument_type argument_type; |
IanBenzMaxim | 0:f77ad7f72d04 | 53 | typedef SelectRom::result_type result_type; |
IanBenzMaxim | 0:f77ad7f72d04 | 54 | |
IanBenzMaxim | 0:f77ad7f72d04 | 55 | explicit SelectMatchRom(const RomId & romId = RomId()) : romId_(romId) {} |
IanBenzMaxim | 0:f77ad7f72d04 | 56 | |
IanBenzMaxim | 0:f77ad7f72d04 | 57 | const RomId & romId() const { return romId_; } |
IanBenzMaxim | 0:f77ad7f72d04 | 58 | void setRomId(const RomId & romId) { romId_ = romId; } |
IanBenzMaxim | 0:f77ad7f72d04 | 59 | |
IanBenzMaxim | 0:f77ad7f72d04 | 60 | MaximInterface_EXPORT error_code operator()(OneWireMaster & master) const; |
IanBenzMaxim | 0:f77ad7f72d04 | 61 | |
IanBenzMaxim | 0:f77ad7f72d04 | 62 | private: |
IanBenzMaxim | 0:f77ad7f72d04 | 63 | RomId romId_; |
IanBenzMaxim | 0:f77ad7f72d04 | 64 | }; |
IanBenzMaxim | 0:f77ad7f72d04 | 65 | |
IanBenzMaxim | 0:f77ad7f72d04 | 66 | /// Selector for a multidrop 1-Wire bus where slaves support the Resume ROM command. |
IanBenzMaxim | 0:f77ad7f72d04 | 67 | class SelectMatchRomWithResume { |
IanBenzMaxim | 0:f77ad7f72d04 | 68 | public: |
IanBenzMaxim | 0:f77ad7f72d04 | 69 | typedef SelectRom::argument_type argument_type; |
IanBenzMaxim | 0:f77ad7f72d04 | 70 | typedef SelectRom::result_type result_type; |
IanBenzMaxim | 0:f77ad7f72d04 | 71 | |
IanBenzMaxim | 0:f77ad7f72d04 | 72 | struct SharedData { |
IanBenzMaxim | 0:f77ad7f72d04 | 73 | RomId lastRom; |
IanBenzMaxim | 0:f77ad7f72d04 | 74 | |
IanBenzMaxim | 0:f77ad7f72d04 | 75 | SharedData() : lastRom() {} |
IanBenzMaxim | 0:f77ad7f72d04 | 76 | }; |
IanBenzMaxim | 0:f77ad7f72d04 | 77 | |
IanBenzMaxim | 0:f77ad7f72d04 | 78 | explicit SelectMatchRomWithResume(SharedData & data, |
IanBenzMaxim | 0:f77ad7f72d04 | 79 | const RomId & romId = RomId()) |
IanBenzMaxim | 0:f77ad7f72d04 | 80 | : romId_(romId), data(&data) {} |
IanBenzMaxim | 0:f77ad7f72d04 | 81 | |
IanBenzMaxim | 0:f77ad7f72d04 | 82 | const RomId & romId() const { return romId_; } |
IanBenzMaxim | 0:f77ad7f72d04 | 83 | void setRomId(const RomId & romId) { romId_ = romId; } |
IanBenzMaxim | 0:f77ad7f72d04 | 84 | |
IanBenzMaxim | 0:f77ad7f72d04 | 85 | MaximInterface_EXPORT error_code operator()(OneWireMaster & master) const; |
IanBenzMaxim | 0:f77ad7f72d04 | 86 | |
IanBenzMaxim | 0:f77ad7f72d04 | 87 | private: |
IanBenzMaxim | 0:f77ad7f72d04 | 88 | RomId romId_; |
IanBenzMaxim | 0:f77ad7f72d04 | 89 | SharedData * data; |
IanBenzMaxim | 0:f77ad7f72d04 | 90 | }; |
IanBenzMaxim | 0:f77ad7f72d04 | 91 | |
IanBenzMaxim | 0:f77ad7f72d04 | 92 | } // namespace MaximInterface |
IanBenzMaxim | 0:f77ad7f72d04 | 93 | |
IanBenzMaxim | 0:f77ad7f72d04 | 94 | #endif |