SelectRom.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_SelectRom
00034 #define MaximInterface_SelectRom
00035 
00036 #include <MaximInterface/Utilities/Export.h>
00037 #include <MaximInterface/Utilities/Function.hpp>
00038 #include <MaximInterface/Utilities/RomId.hpp>
00039 #include <MaximInterface/Utilities/system_error.hpp>
00040 #include "RomCommands.hpp"
00041 
00042 namespace MaximInterface {
00043 
00044 class OneWireMaster;
00045 
00046 /// Selects a 1-Wire device on the bus for communication.
00047 typedef Function<error_code(OneWireMaster &)> SelectRom;
00048 typedef Function<error_code(OneWireMaster &, const RomId & romId)> SelectRomExt;
00049 
00050 /// Selector for a multidrop 1-Wire bus.
00051 class SelectMatchRom {
00052 public:
00053   typedef SelectRom::argument_type argument_type;
00054   typedef SelectRom::result_type result_type;
00055 
00056   explicit SelectMatchRom(RomId::const_span romId) { setRomId(romId); }
00057 
00058   RomId::const_span romId() const { return romId_; }
00059   
00060   void setRomId(RomId::const_span romId) { copy(romId, make_span(romId_)); }
00061 
00062   MaximInterface_EXPORT error_code operator()(OneWireMaster & master) const;
00063 
00064 private:
00065   RomId::array romId_;
00066 };
00067 
00068 /// @brief
00069 /// Selector for a multidrop 1-Wire bus where slaves support the Resume ROM
00070 /// command.
00071 class SelectMatchRomWithResume {
00072 public:
00073   typedef SelectRom::argument_type argument_type;
00074   typedef SelectRom::result_type result_type;
00075 
00076   struct SharedData {
00077     SharedData() : lastRomId() {}
00078     RomId::array lastRomId;
00079   };
00080 
00081   SelectMatchRomWithResume(SharedData & data, RomId::const_span romId)
00082       : data(&data) {
00083     setRomId(romId);
00084   }
00085 
00086   void setSharedData(SharedData & data) { this->data = &data; }
00087   
00088   RomId::const_span romId() const { return romId_; }
00089   
00090   void setRomId(RomId::const_span romId) { copy(romId, make_span(romId_)); }
00091 
00092   MaximInterface_EXPORT error_code operator()(OneWireMaster & master) const;
00093 
00094 private:
00095   SharedData * data;
00096   RomId::array romId_;
00097 };
00098 
00099 } // namespace MaximInterface
00100 
00101 #endif