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_mbed_Uart
00034 #define MaximInterface_mbed_Uart
00035 
00036 #include <Serial.h>
00037 #include <MaximInterface/Links/Uart.hpp>
00038 
00039 namespace MaximInterface {
00040 namespace mbed {
00041 
00042 /// Wrapper for mbed::Serial.
00043 class Uart : public MaximInterface::Uart {
00044 public:
00045   enum ErrorValue  {
00046     HardwareError = 1 ///< Write operation aborted due to timeout.
00047   };
00048 
00049   explicit Uart(::mbed::Serial & serial) : serial(&serial) {}
00050 
00051   void setSerial(::mbed::Serial & serial) { this->serial = &serial; }
00052 
00053   virtual error_code setBaudRate(int_least32_t baudRate);
00054   virtual error_code sendBreak();
00055   virtual error_code clearReadBuffer();
00056   virtual error_code writeByte(uint_least8_t data);
00057   virtual error_code readByte(uint_least8_t & data);
00058 
00059   static const error_category & errorCategory();
00060 
00061 private:
00062   ::mbed::Serial * serial;
00063 };
00064 
00065 inline error_code make_error_code(Uart::ErrorValue  e) {
00066   return error_code(e, Uart::errorCategory());
00067 }
00068 
00069 } // namespace mbed
00070 } // namespace MaximInterface
00071 
00072 #endif