Uart.hpp

00001 /*******************************************************************************
00002 * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
00003 *
00004 * Permission is hereby granted, free of charge, to any person obtaining a
00005 * copy of this software and associated documentation files (the "Software"),
00006 * to deal in the Software without restriction, including without limitation
00007 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
00008 * and/or sell copies of the Software, and to permit persons to whom the
00009 * Software is furnished to do so, subject to the following conditions:
00010 *
00011 * The above copyright notice and this permission notice shall be included
00012 * in all copies or substantial portions of the Software.
00013 *
00014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00015 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00017 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
00018 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00019 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00020 * OTHER DEALINGS IN THE SOFTWARE.
00021 *
00022 * Except as contained in this notice, the name of Maxim Integrated
00023 * Products, Inc. shall not be used except as stated in the Maxim Integrated
00024 * Products, Inc. Branding Policy.
00025 *
00026 * The mere transfer of this software does not imply any licenses
00027 * of trade secrets, proprietary technology, copyrights, patents,
00028 * trademarks, maskwork rights, or any other form of intellectual
00029 * property whatsoever. Maxim Integrated Products, Inc. retains all
00030 * ownership rights.
00031 *******************************************************************************/
00032 
00033 #ifndef MaximInterface_Uart
00034 #define MaximInterface_Uart
00035 
00036 #include <stdint.h>
00037 #include <MaximInterface/Utilities/Export.h>
00038 #include <MaximInterface/Utilities/span.hpp>
00039 #include <MaximInterface/Utilities/system_error.hpp>
00040 
00041 namespace MaximInterface {
00042 
00043 /// Universal asynchronous receiver-transmitter interface.
00044 class Uart {
00045 public:
00046   enum ErrorValue  {
00047     TimeoutError = 1, ///< Read operation aborted due to timeout.
00048     OverrunError      ///< Received data lost due to read buffer overrun.
00049   };
00050 
00051   virtual ~Uart() {}
00052 
00053   /// Set the baud rate of the port in Hz.
00054   virtual error_code setBaudRate(int_least32_t baudRate) = 0;
00055   
00056   /// Generate a break condition on the port for a small amount of time.
00057   virtual error_code sendBreak() = 0;
00058   
00059   /// Clear all received data that was buffered.
00060   virtual error_code clearReadBuffer() = 0;
00061   
00062   /// Writes a byte of data to the port.
00063   virtual error_code writeByte(uint_least8_t data) = 0;
00064   
00065   /// Writes a block of data to the port.
00066   MaximInterface_EXPORT virtual error_code
00067   writeBlock(span<const uint_least8_t> data);
00068   
00069   /// @brief
00070   /// Reads a byte of data from the port. Block until data is received or a
00071   /// timeout is reached.
00072   /// @param[out] data Data read from the port if successful.
00073   virtual error_code readByte(uint_least8_t & data) = 0;
00074   
00075   /// @brief
00076   /// Read a block of data from the port. Block until data is received or a
00077   /// timeout is reached.
00078   /// @param[out] data Data read from the port if successful.
00079   MaximInterface_EXPORT virtual error_code readBlock(span<uint_least8_t> data);
00080 
00081   MaximInterface_EXPORT static const error_category & errorCategory();
00082 };
00083 
00084 inline error_code make_error_code(Uart::ErrorValue  e) {
00085   return error_code(e, Uart::errorCategory());
00086 }
00087 
00088 inline error_condition make_error_condition(Uart::ErrorValue  e) {
00089   return error_condition(e, Uart::errorCategory());
00090 }
00091 
00092 } // namespace MaximInterface
00093 
00094 #endif