Diff: OneWire_Masters/OneWireMaster.h

Revision:

15:f6cb0d906fb6

Parent:

5:ce108eeb878d

Child:

17:b646b1e3970b

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/OneWire_Masters/OneWireMaster.h	Wed Mar 16 01:19:45 2016 +0000
@@ -0,0 +1,114 @@
+/******************************************************************//**
+* @file OneWireMaster.h
+*
+* @author Justin Jordan
+*
+* @version 0.0.0
+*
+* Started: 08FEB16
+*
+* Updated: 
+*
+* @brief Header file for functions shared between masters, that should
+* be implemented only once.
+***********************************************************************
+* Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
+*
+* Permission is hereby granted, free of charge, to any person obtaining a
+* copy of this software and associated documentation files (the "Software"),
+* to deal in the Software without restriction, including without limitation
+* the rights to use, copy, modify, merge, publish, distribute, sublicense,
+* and/or sell copies of the Software, and to permit persons to whom the
+* Software is furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included
+* in all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+* IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
+* OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+* OTHER DEALINGS IN THE SOFTWARE.
+*
+* Except as contained in this notice, the name of Maxim Integrated
+* Products, Inc. shall not be used except as stated in the Maxim Integrated
+* Products, Inc. Branding Policy.
+*
+* The mere transfer of this software does not imply any licenses
+* of trade secrets, proprietary technology, copyrights, patents,
+* trademarks, maskwork rights, or any other form of intellectual
+* property whatsoever. Maxim Integrated Products, Inc. retains all
+* ownership rights.
+**********************************************************************/
+
+
+#ifndef ONEWIREMASTER_H
+#define ONEWIREMASTER_H
+
+
+#include "mbed.h"
+#include "OneWireInterface.h"
+
+
+class OneWireMaster: public OneWireInterface
+{
+    public:
+    
+    //Part of OneWireInterface that should only be implemented once
+    //See OneWireInterface.h for documentation
+    
+    virtual void OWWriteBit(uint8_t sendbit);
+    
+    virtual uint8_t OWReadBit();
+
+    virtual uint8_t OWTouchByte(uint8_t sendbyte);
+
+    virtual void OWBlock(uint8_t *tran_buf, uint8_t tran_len);
+    
+    virtual void OWWriteBlock(const uint8_t *tran_buf, uint8_t tran_len);
+    
+    virtual void OWReadBlock(uint8_t *recv_buf, uint8_t recv_len);
+
+    virtual bool OWFirst(void);
+
+    virtual bool OWNext(void);
+
+    virtual bool OWVerify(void);
+
+    virtual void OWTargetSetup(uint8_t family_code);
+
+    virtual void OWFamilySkipSetup(void);
+    
+    virtual bool OWReadROM(void);
+    
+    virtual bool OWSkipROM(void);
+    
+    virtual bool OWMatchROM(void);
+    
+    virtual bool OWOverdriveSkipROM(void);
+    
+    virtual bool OWOverdriveMatchROM(void);
+    
+    virtual bool OWResume(void);
+
+    virtual const uint8_t (&OWgetROMnumber() const)[ROMnumberLen];
+    
+    static uint8_t OWCalc_crc8(uint8_t data, uint8_t crc8);
+    
+    protected:
+    
+    // Search state
+    uint8_t _rom_number[ROMnumberLen];
+    uint8_t _last_discrepancy;
+    uint8_t _last_family_discrepancy;
+    uint8_t _last_device_flag;
+    uint8_t _crc8;   
+};
+
+
+
+
+
+#endif /*ONEWIREMASTERSSHARED_H*/
\ No newline at end of file