Diff: OneWire_Masters/OneWireMastersShared.h

Revision:

5:ce108eeb878d

diff -r ca27db159b10 -r ce108eeb878d OneWire_Masters/OneWireMastersShared.h
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/OneWire_Masters/OneWireMastersShared.h	Tue Feb 09 03:30:22 2016 +0000
@@ -0,0 +1,70 @@
+/******************************************************************//**
+* @file OneWireMastersShared.h
+*
+* @author Justin Jordan
+*
+* @version 0.0.0
+*
+* Started: 08FEB16
+*
+* Updated: 
+*
+* @brief Header file for functions shared between masters, that should
+* be implemented by each master, only one implementation 
+***********************************************************************
+* 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 ONEWIREMASTERSSHARED_H
+#define ONEWIREMASTERSSHARED_H
+
+
+#include "mbed.h"
+
+
+/**********************************************************//**
+* @brief calc_crc8()
+* 
+* @details Calculate the CRC8 of the byte value provided with the 
+*          current global 'crc8' value.
+*
+* On Entry:
+*     @param[in] data
+*     @param[in] crc8
+*
+* On Exit:
+*    @return current global crc8 value
+**************************************************************/
+uint8_t OWCalc_crc8(uint8_t data, uint8_t crc8);
+
+
+#endif /*ONEWIREMASTERSSHARED_H*/
\ No newline at end of file