Diff: Links/I2CMaster.hpp

Revision:

0:f77ad7f72d04

Child:

3:f818ea5172ed

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Links/I2CMaster.hpp	Mon Nov 06 14:39:18 2017 -0600
@@ -0,0 +1,89 @@
+/*******************************************************************************
+* Copyright (C) 2017 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 MaximInterface_I2CMaster
+#define MaximInterface_I2CMaster
+
+#include <stddef.h>
+#include <stdint.h>
+#include <MaximInterface/Utilities/Export.h>
+#include <MaximInterface/Utilities/system_error.hpp>
+
+namespace MaximInterface {
+
+class I2CMaster {
+public:
+  enum ErrorValue {
+    NackError = 1 ///< Transaction stopped due to a NACK from the slave device.
+  };
+
+  enum AckStatus { Ack = 1, Nack = 0 };
+
+  virtual ~I2CMaster() {}
+
+  virtual error_code start(uint_least8_t address) = 0;
+  virtual error_code stop() = 0;
+  virtual error_code writeByte(uint_least8_t data) = 0;
+  MaximInterface_EXPORT virtual error_code
+  writeBlock(const uint_least8_t * data, size_t dataLen);
+  MaximInterface_EXPORT virtual error_code
+  writePacket(uint_least8_t address, const uint_least8_t * data, size_t dataLen,
+              bool sendStop);
+  error_code writePacket(uint_least8_t address, const uint_least8_t * data,
+                         size_t dataLen) {
+    return writePacket(address, data, dataLen, true);
+  }
+  virtual error_code readByte(AckStatus status, uint_least8_t & data) = 0;
+  MaximInterface_EXPORT virtual error_code
+  readBlock(AckStatus status, uint_least8_t * data, size_t dataLen);
+  MaximInterface_EXPORT virtual error_code readPacket(uint_least8_t address,
+                                                      uint_least8_t * data,
+                                                      size_t dataLen,
+                                                      bool sendStop);
+  error_code readPacket(uint_least8_t address, uint_least8_t * data,
+                        size_t dataLen) {
+    return readPacket(address, data, dataLen, true);
+  }
+
+  MaximInterface_EXPORT static const error_category & errorCategory();
+};
+
+inline error_code make_error_code(I2CMaster::ErrorValue e) {
+  return error_code(e, I2CMaster::errorCategory());
+}
+inline error_condition make_error_condition(I2CMaster::ErrorValue e) {
+  return error_condition(e, I2CMaster::errorCategory());
+}
+
+} // namespace MaximInterface
+
+#endif
\ No newline at end of file