Diff: MaximInterfaceCore/Uart.hpp

Revision:

8:5ea891c7d1a1

Parent:

7:9cd16581b578

--- a/MaximInterfaceCore/Uart.hpp	Mon Jul 22 11:44:07 2019 -0500
+++ b/MaximInterfaceCore/Uart.hpp	Mon Sep 16 11:13:37 2019 -0500
@@ -1,5 +1,5 @@
 /*******************************************************************************
-* Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
+* Copyright (C) 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"),
@@ -30,11 +30,12 @@
 * ownership rights.
 *******************************************************************************/
 
-#ifndef MaximInterfaceCore_Uart
-#define MaximInterfaceCore_Uart
+#ifndef MaximInterfaceCore_Uart_hpp
+#define MaximInterfaceCore_Uart_hpp
 
 #include <stdint.h>
 #include "Config.hpp"
+#include "Result.hpp"
 #include "span.hpp"
 #include "system_error.hpp"
 
@@ -51,37 +52,39 @@
   virtual ~Uart() {}
 
   /// Set the baud rate of the port in Hz.
-  virtual error_code setBaudRate(int_least32_t baudRate) = 0;
+  virtual Result<void> setBaudRate(int_least32_t baudRate) = 0;
 
   /// Generate a break condition on the port for a small amount of time.
-  virtual error_code sendBreak() = 0;
+  virtual Result<void> sendBreak() = 0;
 
   /// Clear all received data that was buffered.
-  virtual error_code clearReadBuffer() = 0;
+  virtual Result<void> clearReadBuffer() = 0;
 
   /// Writes a byte of data to the port.
-  virtual error_code writeByte(uint_least8_t data) = 0;
+  virtual Result<void> writeByte(uint_least8_t data) = 0;
 
   /// Writes a block of data to the port.
-  MaximInterfaceCore_EXPORT virtual error_code
+  MaximInterfaceCore_EXPORT virtual Result<void>
   writeBlock(span<const uint_least8_t> data);
 
   /// @brief
   /// Reads a byte of data from the port. Block until data is received or a
   /// timeout is reached.
-  /// @param[out] data Data read from the port if successful.
-  virtual error_code readByte(uint_least8_t & data) = 0;
+  /// @returns Data read from the port if successful.
+  virtual Result<uint_least8_t> readByte() = 0;
 
   /// @brief
   /// Read a block of data from the port. Block until data is received or a
   /// timeout is reached.
   /// @param[out] data Data read from the port if successful.
-  MaximInterfaceCore_EXPORT virtual error_code
+  MaximInterfaceCore_EXPORT virtual Result<void>
   readBlock(span<uint_least8_t> data);
 
   MaximInterfaceCore_EXPORT static const error_category & errorCategory();
 };
 
+template <> struct is_error_code_enum<Uart::ErrorValue> : true_type {};
+
 inline error_code make_error_code(Uart::ErrorValue e) {
   return error_code(e, Uart::errorCategory());
 }