Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Devices/DS2413.hpp@10:de4b8812877d, 2020-01-06 (annotated)

Committer:
reARMnimator
Date:
Mon Jan 06 15:54:55 2020 +0000
Revision:
10:de4b8812877d
Parent:
7:471901a04573 
Fixed inappropriate include path.

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_DS2413
IanBenzMaxim 0:f77ad7f72d04 34 #define MaximInterface_DS2413
IanBenzMaxim 0:f77ad7f72d04 35
IanBenzMaxim 0:f77ad7f72d04 36 #include <stdint.h>
IanBenzMaxim 0:f77ad7f72d04 37 #include <MaximInterface/Links/SelectRom.hpp>
IanBenzMaxim 0:f77ad7f72d04 38 #include <MaximInterface/Utilities/Export.h>
IanBenzMaxim 6:a8c83a2e6fa4 39 #include <MaximInterface/Utilities/FlagSet.hpp>
IanBenzMaxim 0:f77ad7f72d04 40
IanBenzMaxim 0:f77ad7f72d04 41 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 42
IanBenzMaxim 7:471901a04573 43 /// @brief DS2413 1-Wire Dual Channel Addressable Switch
IanBenzMaxim 0:f77ad7f72d04 44 /// @details The DS2413 is a dual-channel programmable I/O 1-Wire®
IanBenzMaxim 0:f77ad7f72d04 45 /// chip. The PIO outputs are configured as open-drain and provide up
IanBenzMaxim 0:f77ad7f72d04 46 /// to 20mA continuous sink capability and off-state operating voltage
IanBenzMaxim 0:f77ad7f72d04 47 /// up to 28V. Control and sensing of the PIO pins is performed with
IanBenzMaxim 0:f77ad7f72d04 48 /// a dedicated device-level command protocol. To provide a high level
IanBenzMaxim 0:f77ad7f72d04 49 /// of fault tolerance in the end application, the 1-Wire I/O and PIO
IanBenzMaxim 0:f77ad7f72d04 50 /// pins are all capable of withstanding continuous application of
IanBenzMaxim 0:f77ad7f72d04 51 /// voltages up to 28V max. Communication and operation of the DS2413
IanBenzMaxim 0:f77ad7f72d04 52 /// is performed with the single contact Maxim 1-Wire serial interface.
IanBenzMaxim 0:f77ad7f72d04 53 class DS2413 {
IanBenzMaxim 0:f77ad7f72d04 54 public:
IanBenzMaxim 0:f77ad7f72d04 55 enum ErrorValue { CommunicationError = 1 };
IanBenzMaxim 0:f77ad7f72d04 56
IanBenzMaxim 6:a8c83a2e6fa4 57 enum StatusFlags {
IanBenzMaxim 6:a8c83a2e6fa4 58 PioAInputState = 0x1,
IanBenzMaxim 6:a8c83a2e6fa4 59 PioAOutputState = 0x2,
IanBenzMaxim 6:a8c83a2e6fa4 60 PioBInputState = 0x4,
IanBenzMaxim 6:a8c83a2e6fa4 61 PioBOutputState = 0x8
IanBenzMaxim 0:f77ad7f72d04 62 };
IanBenzMaxim 6:a8c83a2e6fa4 63 typedef FlagSet<StatusFlags, 4> Status;
IanBenzMaxim 0:f77ad7f72d04 64
IanBenzMaxim 0:f77ad7f72d04 65 DS2413(OneWireMaster & master, const SelectRom & selectRom)
IanBenzMaxim 0:f77ad7f72d04 66 : selectRom(selectRom), master(&master) {}
IanBenzMaxim 0:f77ad7f72d04 67
IanBenzMaxim 0:f77ad7f72d04 68 void setMaster(OneWireMaster & master) { this->master = &master; }
IanBenzMaxim 6:a8c83a2e6fa4 69
IanBenzMaxim 0:f77ad7f72d04 70 void setSelectRom(const SelectRom & selectRom) {
IanBenzMaxim 0:f77ad7f72d04 71 this->selectRom = selectRom;
IanBenzMaxim 0:f77ad7f72d04 72 }
IanBenzMaxim 0:f77ad7f72d04 73
IanBenzMaxim 0:f77ad7f72d04 74 /// Read the input and output logic states for all PIO pins.
IanBenzMaxim 0:f77ad7f72d04 75 MaximInterface_EXPORT error_code readStatus(Status & status) const;
IanBenzMaxim 0:f77ad7f72d04 76
IanBenzMaxim 0:f77ad7f72d04 77 /// Write the output logic states for all PIO pins.
IanBenzMaxim 0:f77ad7f72d04 78 MaximInterface_EXPORT error_code writeOutputState(bool pioAState,
IanBenzMaxim 0:f77ad7f72d04 79 bool pioBState);
IanBenzMaxim 0:f77ad7f72d04 80
IanBenzMaxim 0:f77ad7f72d04 81 MaximInterface_EXPORT static const error_category & errorCategory();
IanBenzMaxim 0:f77ad7f72d04 82
IanBenzMaxim 0:f77ad7f72d04 83 private:
IanBenzMaxim 0:f77ad7f72d04 84 error_code pioAccessRead(uint_least8_t & val) const;
IanBenzMaxim 0:f77ad7f72d04 85 error_code pioAccessWrite(uint_least8_t val);
IanBenzMaxim 0:f77ad7f72d04 86
IanBenzMaxim 0:f77ad7f72d04 87 SelectRom selectRom;
IanBenzMaxim 0:f77ad7f72d04 88 OneWireMaster * master;
IanBenzMaxim 0:f77ad7f72d04 89 };
IanBenzMaxim 0:f77ad7f72d04 90
IanBenzMaxim 7:471901a04573 91 /// Write the output logic state for only PIOA.
IanBenzMaxim 0:f77ad7f72d04 92 MaximInterface_EXPORT error_code writePioAOutputState(DS2413 & ds2413,
IanBenzMaxim 0:f77ad7f72d04 93 bool pioAState);
IanBenzMaxim 7:471901a04573 94
IanBenzMaxim 7:471901a04573 95 /// Write the output logic state for only PIOB.
IanBenzMaxim 0:f77ad7f72d04 96 MaximInterface_EXPORT error_code writePioBOutputState(DS2413 & ds2413,
IanBenzMaxim 0:f77ad7f72d04 97 bool pioBState);
IanBenzMaxim 0:f77ad7f72d04 98
IanBenzMaxim 0:f77ad7f72d04 99 inline error_code make_error_code(DS2413::ErrorValue e) {
IanBenzMaxim 0:f77ad7f72d04 100 return error_code(e, DS2413::errorCategory());
IanBenzMaxim 0:f77ad7f72d04 101 }
IanBenzMaxim 0:f77ad7f72d04 102
IanBenzMaxim 0:f77ad7f72d04 103 } // namespace MaximInterface
IanBenzMaxim 0:f77ad7f72d04 104
IanBenzMaxim 0:f77ad7f72d04 105 #endif