Maxim Integrated / OneWire

1-Wire® library for mbed. Complete 1-Wire library that supports our silicon masters along with a bit-bang master on the MAX32600MBED platform with one common interface for mbed. Slave support has also been included and more slaves will be added as time permits.

Dependents:   MAXREFDES131_Qt_Demo MAX32630FTHR_iButton_uSD_Logger MAX32630FTHR_DS18B20_uSD_Logger MAXREFDES130_131_Demo ... more

Superseded by MaximInterface.

Switches/DS2413/DS2413.h@75:8b627804927c, 2016-05-13 (annotated)

Committer:
IanBenzMaxim
Date:
Fri May 13 14:52:50 2016 -0500
Revision:
75:8b627804927c
Parent:
74:23be10c32fa3
Child:
76:84e6c4994e29
Code cleanup.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
j3 19:6d4c039a2d8e 1 /******************************************************************//**
j3 19:6d4c039a2d8e 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
j3 19:6d4c039a2d8e 3 *
j3 19:6d4c039a2d8e 4 * Permission is hereby granted, free of charge, to any person obtaining a
j3 19:6d4c039a2d8e 5 * copy of this software and associated documentation files (the "Software"),
j3 19:6d4c039a2d8e 6 * to deal in the Software without restriction, including without limitation
j3 19:6d4c039a2d8e 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
j3 19:6d4c039a2d8e 8 * and/or sell copies of the Software, and to permit persons to whom the
j3 19:6d4c039a2d8e 9 * Software is furnished to do so, subject to the following conditions:
j3 19:6d4c039a2d8e 10 *
j3 19:6d4c039a2d8e 11 * The above copyright notice and this permission notice shall be included
j3 19:6d4c039a2d8e 12 * in all copies or substantial portions of the Software.
j3 19:6d4c039a2d8e 13 *
j3 19:6d4c039a2d8e 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
j3 19:6d4c039a2d8e 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
j3 19:6d4c039a2d8e 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
j3 19:6d4c039a2d8e 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
j3 19:6d4c039a2d8e 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
j3 19:6d4c039a2d8e 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
j3 19:6d4c039a2d8e 20 * OTHER DEALINGS IN THE SOFTWARE.
j3 19:6d4c039a2d8e 21 *
j3 19:6d4c039a2d8e 22 * Except as contained in this notice, the name of Maxim Integrated
j3 19:6d4c039a2d8e 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
j3 19:6d4c039a2d8e 24 * Products, Inc. Branding Policy.
j3 19:6d4c039a2d8e 25 *
j3 19:6d4c039a2d8e 26 * The mere transfer of this software does not imply any licenses
j3 19:6d4c039a2d8e 27 * of trade secrets, proprietary technology, copyrights, patents,
j3 19:6d4c039a2d8e 28 * trademarks, maskwork rights, or any other form of intellectual
j3 19:6d4c039a2d8e 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
j3 19:6d4c039a2d8e 30 * ownership rights.
j3 19:6d4c039a2d8e 31 **********************************************************************/
j3 19:6d4c039a2d8e 32
IanBenzMaxim 73:2cecc1372acc 33 #ifndef OneWire_Switches_DS2413
IanBenzMaxim 73:2cecc1372acc 34 #define OneWire_Switches_DS2413
j3 19:6d4c039a2d8e 35
IanBenzMaxim 73:2cecc1372acc 36 #include <stdint.h>
IanBenzMaxim 73:2cecc1372acc 37 #include "OneWireSlave.h"
IanBenzMaxim 73:2cecc1372acc 38
IanBenzMaxim 73:2cecc1372acc 39 namespace OneWire
IanBenzMaxim 73:2cecc1372acc 40 {
IanBenzMaxim 74:23be10c32fa3 41 namespace Masters { class OneWireMaster; }
IanBenzMaxim 74:23be10c32fa3 42
IanBenzMaxim 74:23be10c32fa3 43 namespace Switches
IanBenzMaxim 73:2cecc1372acc 44 {
IanBenzMaxim 74:23be10c32fa3 45 class DS2413 : public OneWireSlave
IanBenzMaxim 74:23be10c32fa3 46 {
IanBenzMaxim 74:23be10c32fa3 47 public:
IanBenzMaxim 74:23be10c32fa3 48 enum CmdResult
IanBenzMaxim 74:23be10c32fa3 49 {
IanBenzMaxim 74:23be10c32fa3 50 Success,
IanBenzMaxim 74:23be10c32fa3 51 CommsReadError,
IanBenzMaxim 74:23be10c32fa3 52 CommsWriteError,
IanBenzMaxim 74:23be10c32fa3 53 OpFailure
IanBenzMaxim 74:23be10c32fa3 54 };
IanBenzMaxim 74:23be10c32fa3 55
IanBenzMaxim 74:23be10c32fa3 56 /**********************************************************//**
IanBenzMaxim 74:23be10c32fa3 57 * @brief DS2413 constructor
IanBenzMaxim 74:23be10c32fa3 58 *
IanBenzMaxim 74:23be10c32fa3 59 * @details
IanBenzMaxim 74:23be10c32fa3 60 *
IanBenzMaxim 74:23be10c32fa3 61 * On Entry:
IanBenzMaxim 74:23be10c32fa3 62 * @param[in] owm - reference to 1-wire master
IanBenzMaxim 74:23be10c32fa3 63 *
IanBenzMaxim 74:23be10c32fa3 64 * On Exit:
IanBenzMaxim 74:23be10c32fa3 65 *
IanBenzMaxim 74:23be10c32fa3 66 * @return
IanBenzMaxim 74:23be10c32fa3 67 **************************************************************/
IanBenzMaxim 74:23be10c32fa3 68 DS2413(Masters::OneWireMaster &owm);
IanBenzMaxim 74:23be10c32fa3 69
IanBenzMaxim 74:23be10c32fa3 70 /**********************************************************//**
IanBenzMaxim 74:23be10c32fa3 71 * @brief pio_access_read_chA()
IanBenzMaxim 74:23be10c32fa3 72 *
IanBenzMaxim 74:23be10c32fa3 73 * @details reads state of pio
IanBenzMaxim 74:23be10c32fa3 74 *
IanBenzMaxim 74:23be10c32fa3 75 * On Entry:
IanBenzMaxim 74:23be10c32fa3 76 * @param[in] romId - refernce to ROM # of switch
IanBenzMaxim 74:23be10c32fa3 77 *
IanBenzMaxim 74:23be10c32fa3 78 * On Exit:
IanBenzMaxim 74:23be10c32fa3 79 * @param[out] val - lsb represents the state of the pio
IanBenzMaxim 74:23be10c32fa3 80 *
IanBenzMaxim 74:23be10c32fa3 81 * @return CmdResult - result of operation
IanBenzMaxim 74:23be10c32fa3 82 **************************************************************/
IanBenzMaxim 74:23be10c32fa3 83 CmdResult pio_access_read_chA(uint8_t & val);
j3 19:6d4c039a2d8e 84
IanBenzMaxim 74:23be10c32fa3 85 /**********************************************************//**
IanBenzMaxim 74:23be10c32fa3 86 * @brief pio_access_read_chB()
IanBenzMaxim 74:23be10c32fa3 87 *
IanBenzMaxim 74:23be10c32fa3 88 * @details reads state of pio
IanBenzMaxim 74:23be10c32fa3 89 *
IanBenzMaxim 74:23be10c32fa3 90 * On Entry:
IanBenzMaxim 74:23be10c32fa3 91 * @param[in] romId - refernce to ROM # of switch
IanBenzMaxim 74:23be10c32fa3 92 *
IanBenzMaxim 74:23be10c32fa3 93 * On Exit:
IanBenzMaxim 74:23be10c32fa3 94 * @param[out] val - lsb represents the state of the pio
IanBenzMaxim 74:23be10c32fa3 95 *
IanBenzMaxim 74:23be10c32fa3 96 * @return CmdResult - result of operation
IanBenzMaxim 74:23be10c32fa3 97 **************************************************************/
IanBenzMaxim 74:23be10c32fa3 98 CmdResult pio_access_read_chB(uint8_t & val);
IanBenzMaxim 74:23be10c32fa3 99
IanBenzMaxim 74:23be10c32fa3 100 /**********************************************************//**
IanBenzMaxim 74:23be10c32fa3 101 * @brief pio_acess_write_chA()
IanBenzMaxim 74:23be10c32fa3 102 *
IanBenzMaxim 74:23be10c32fa3 103 * @details writes to pio
IanBenzMaxim 74:23be10c32fa3 104 *
IanBenzMaxim 74:23be10c32fa3 105 * On Entry:
IanBenzMaxim 74:23be10c32fa3 106 * @param[in] romId - refernce to ROM # of switch
IanBenzMaxim 74:23be10c32fa3 107 * @param[in] val - lsb sets state of pio
IanBenzMaxim 74:23be10c32fa3 108 *
IanBenzMaxim 74:23be10c32fa3 109 * On Exit:
IanBenzMaxim 74:23be10c32fa3 110 *
IanBenzMaxim 74:23be10c32fa3 111 * @return CmdResult - result of operation
IanBenzMaxim 74:23be10c32fa3 112 **************************************************************/
IanBenzMaxim 74:23be10c32fa3 113 CmdResult pio_access_write_chA(uint8_t val);
j3 19:6d4c039a2d8e 114
IanBenzMaxim 74:23be10c32fa3 115 /**********************************************************//**
IanBenzMaxim 74:23be10c32fa3 116 * @brief pio_acess_write_chB()
IanBenzMaxim 74:23be10c32fa3 117 *
IanBenzMaxim 74:23be10c32fa3 118 * @details writes to pio
IanBenzMaxim 74:23be10c32fa3 119 *
IanBenzMaxim 74:23be10c32fa3 120 * On Entry:
IanBenzMaxim 74:23be10c32fa3 121 * @param[in] romId - refernce to ROM # of switch
IanBenzMaxim 74:23be10c32fa3 122 * @param[in] val - lsb sets state of pio
IanBenzMaxim 74:23be10c32fa3 123 *
IanBenzMaxim 74:23be10c32fa3 124 * On Exit:
IanBenzMaxim 74:23be10c32fa3 125 *
IanBenzMaxim 74:23be10c32fa3 126 * @return CmdResult - result of operation
IanBenzMaxim 74:23be10c32fa3 127 **************************************************************/
IanBenzMaxim 74:23be10c32fa3 128 CmdResult pio_access_write_chB(uint8_t val);
IanBenzMaxim 74:23be10c32fa3 129
IanBenzMaxim 74:23be10c32fa3 130 /**********************************************************//**
IanBenzMaxim 74:23be10c32fa3 131 * @brief pio_acess_write_chAB()
IanBenzMaxim 74:23be10c32fa3 132 *
IanBenzMaxim 74:23be10c32fa3 133 * @details writes to pio
IanBenzMaxim 74:23be10c32fa3 134 *
IanBenzMaxim 74:23be10c32fa3 135 * On Entry:
IanBenzMaxim 74:23be10c32fa3 136 * @param[in] romId - refernce to ROM # of switch
IanBenzMaxim 74:23be10c32fa3 137 * @param[in] val - Bits 1:0 set PIOB and PIOB respectively
IanBenzMaxim 74:23be10c32fa3 138 *
IanBenzMaxim 74:23be10c32fa3 139 * On Exit:
IanBenzMaxim 74:23be10c32fa3 140 *
IanBenzMaxim 74:23be10c32fa3 141 * @return CmdResult - result of operation
IanBenzMaxim 74:23be10c32fa3 142 **************************************************************/
IanBenzMaxim 74:23be10c32fa3 143 CmdResult pio_access_write_chAB(uint8_t val);
IanBenzMaxim 74:23be10c32fa3 144
IanBenzMaxim 74:23be10c32fa3 145 private:
IanBenzMaxim 74:23be10c32fa3 146
IanBenzMaxim 74:23be10c32fa3 147 CmdResult pio_access_read(uint8_t & val);
IanBenzMaxim 74:23be10c32fa3 148
IanBenzMaxim 74:23be10c32fa3 149 CmdResult pio_access_write(uint8_t val);
IanBenzMaxim 74:23be10c32fa3 150
IanBenzMaxim 74:23be10c32fa3 151 Masters::OneWireMaster &_owm;
IanBenzMaxim 74:23be10c32fa3 152
IanBenzMaxim 74:23be10c32fa3 153 };
IanBenzMaxim 74:23be10c32fa3 154 }
IanBenzMaxim 73:2cecc1372acc 155 }
IanBenzMaxim 73:2cecc1372acc 156
IanBenzMaxim 74:23be10c32fa3 157 #endif