Device interface library for multiple platforms including Mbed.
Dependents: DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#
Uart.hpp
00001 /******************************************************************************* 00002 * Copyright (C) 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 MaximInterfaceMbed_Uart_hpp 00034 #define MaximInterfaceMbed_Uart_hpp 00035 00036 #include <MaximInterfaceCore/Uart.hpp> 00037 #include <mbed-os/drivers/Serial.h> 00038 00039 namespace MaximInterfaceMbed { 00040 00041 /// Wrapper for mbed::Serial. 00042 class Uart : public MaximInterfaceCore::Uart { 00043 public: 00044 enum ErrorValue { 00045 HardwareError = 1 ///< Write operation aborted due to timeout. 00046 }; 00047 00048 explicit Uart(mbed::Serial & serial) : serial(&serial) {} 00049 00050 void setSerial(mbed::Serial & serial) { this->serial = &serial; } 00051 00052 virtual MaximInterfaceCore::Result<void> setBaudRate(int_least32_t baudRate); 00053 00054 virtual MaximInterfaceCore::Result<void> sendBreak(); 00055 00056 virtual MaximInterfaceCore::Result<void> clearReadBuffer(); 00057 00058 virtual MaximInterfaceCore::Result<void> writeByte(uint_least8_t data); 00059 00060 virtual MaximInterfaceCore::Result<uint_least8_t> readByte(); 00061 00062 static const MaximInterfaceCore::error_category & errorCategory(); 00063 00064 private: 00065 mbed::Serial * serial; 00066 }; 00067 00068 } // namespace MaximInterfaceMbed 00069 namespace MaximInterfaceCore { 00070 00071 template <> 00072 struct is_error_code_enum<MaximInterfaceMbed::Uart::ErrorValue> : true_type {}; 00073 00074 } // namespace MaximInterfaceCore 00075 namespace MaximInterfaceMbed { 00076 00077 inline MaximInterfaceCore::error_code make_error_code(Uart::ErrorValue e) { 00078 return MaximInterfaceCore::error_code(e, Uart::errorCategory()); 00079 } 00080 00081 } // namespace MaximInterfaceMbed 00082 00083 #endif
Generated on Tue Jul 12 2022 11:13:18 by 1.7.2