Maxim Integrated / MaximInterface

Device interface library for multiple platforms including Mbed.

Dependents:   DeepCover Embedded Security in IoT MaximInterface MAXREFDES155#

Maxim Interface is a library framework focused on providing flexible and expressive hardware interfaces. Both communication interfaces such as I2C and 1-Wire and device interfaces such as DS18B20 are supported. Modern C++ concepts are used extensively while keeping compatibility with C++98/C++03 and requiring no external dependencies. The embedded-friendly design does not depend on exceptions or RTTI.

The full version of the project is hosted on GitLab: https://gitlab.com/iabenz/MaximInterface

MaximInterfaceMbed/Uart.hpp@12:7eb41621ba22, 2020-05-29 (annotated)

Committer:
IanBenzMaxim
Date:
Fri May 29 16:19:22 2020 -0500
Revision:
12:7eb41621ba22
Parent:
8:5ea891c7d1a1 
Updated to version 2.2.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
IanBenzMaxim 7:9cd16581b578 1 /*******************************************************************************
IanBenzMaxim 8:5ea891c7d1a1 2 * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
IanBenzMaxim 7:9cd16581b578 3 *
IanBenzMaxim 7:9cd16581b578 4 * Permission is hereby granted, free of charge, to any person obtaining a
IanBenzMaxim 7:9cd16581b578 5 * copy of this software and associated documentation files (the "Software"),
IanBenzMaxim 7:9cd16581b578 6 * to deal in the Software without restriction, including without limitation
IanBenzMaxim 7:9cd16581b578 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
IanBenzMaxim 7:9cd16581b578 8 * and/or sell copies of the Software, and to permit persons to whom the
IanBenzMaxim 7:9cd16581b578 9 * Software is furnished to do so, subject to the following conditions:
IanBenzMaxim 7:9cd16581b578 10 *
IanBenzMaxim 7:9cd16581b578 11 * The above copyright notice and this permission notice shall be included
IanBenzMaxim 7:9cd16581b578 12 * in all copies or substantial portions of the Software.
IanBenzMaxim 7:9cd16581b578 13 *
IanBenzMaxim 7:9cd16581b578 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
IanBenzMaxim 7:9cd16581b578 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
IanBenzMaxim 7:9cd16581b578 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IanBenzMaxim 7:9cd16581b578 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
IanBenzMaxim 7:9cd16581b578 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
IanBenzMaxim 7:9cd16581b578 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
IanBenzMaxim 7:9cd16581b578 20 * OTHER DEALINGS IN THE SOFTWARE.
IanBenzMaxim 7:9cd16581b578 21 *
IanBenzMaxim 7:9cd16581b578 22 * Except as contained in this notice, the name of Maxim Integrated
IanBenzMaxim 7:9cd16581b578 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
IanBenzMaxim 7:9cd16581b578 24 * Products, Inc. Branding Policy.
IanBenzMaxim 7:9cd16581b578 25 *
IanBenzMaxim 7:9cd16581b578 26 * The mere transfer of this software does not imply any licenses
IanBenzMaxim 7:9cd16581b578 27 * of trade secrets, proprietary technology, copyrights, patents,
IanBenzMaxim 7:9cd16581b578 28 * trademarks, maskwork rights, or any other form of intellectual
IanBenzMaxim 7:9cd16581b578 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
IanBenzMaxim 7:9cd16581b578 30 * ownership rights.
IanBenzMaxim 7:9cd16581b578 31 *******************************************************************************/
IanBenzMaxim 7:9cd16581b578 32
IanBenzMaxim 8:5ea891c7d1a1 33 #ifndef MaximInterfaceMbed_Uart_hpp
IanBenzMaxim 8:5ea891c7d1a1 34 #define MaximInterfaceMbed_Uart_hpp
IanBenzMaxim 7:9cd16581b578 35
IanBenzMaxim 7:9cd16581b578 36 #include <MaximInterfaceCore/Uart.hpp>
IanBenzMaxim 7:9cd16581b578 37 #include <mbed-os/drivers/Serial.h>
IanBenzMaxim 7:9cd16581b578 38
IanBenzMaxim 7:9cd16581b578 39 namespace MaximInterfaceMbed {
IanBenzMaxim 7:9cd16581b578 40
IanBenzMaxim 7:9cd16581b578 41 /// Wrapper for mbed::Serial.
IanBenzMaxim 7:9cd16581b578 42 class Uart : public MaximInterfaceCore::Uart {
IanBenzMaxim 7:9cd16581b578 43 public:
IanBenzMaxim 7:9cd16581b578 44 enum ErrorValue {
IanBenzMaxim 7:9cd16581b578 45 HardwareError = 1 ///< Write operation aborted due to timeout.
IanBenzMaxim 7:9cd16581b578 46 };
IanBenzMaxim 7:9cd16581b578 47
IanBenzMaxim 7:9cd16581b578 48 explicit Uart(mbed::Serial & serial) : serial(&serial) {}
IanBenzMaxim 7:9cd16581b578 49
IanBenzMaxim 7:9cd16581b578 50 void setSerial(mbed::Serial & serial) { this->serial = &serial; }
IanBenzMaxim 7:9cd16581b578 51
IanBenzMaxim 8:5ea891c7d1a1 52 virtual MaximInterfaceCore::Result<void> setBaudRate(int_least32_t baudRate);
IanBenzMaxim 7:9cd16581b578 53
IanBenzMaxim 8:5ea891c7d1a1 54 virtual MaximInterfaceCore::Result<void> sendBreak();
IanBenzMaxim 7:9cd16581b578 55
IanBenzMaxim 8:5ea891c7d1a1 56 virtual MaximInterfaceCore::Result<void> clearReadBuffer();
IanBenzMaxim 7:9cd16581b578 57
IanBenzMaxim 8:5ea891c7d1a1 58 virtual MaximInterfaceCore::Result<void> writeByte(uint_least8_t data);
IanBenzMaxim 7:9cd16581b578 59
IanBenzMaxim 8:5ea891c7d1a1 60 virtual MaximInterfaceCore::Result<uint_least8_t> readByte();
IanBenzMaxim 7:9cd16581b578 61
IanBenzMaxim 7:9cd16581b578 62 static const MaximInterfaceCore::error_category & errorCategory();
IanBenzMaxim 7:9cd16581b578 63
IanBenzMaxim 7:9cd16581b578 64 private:
IanBenzMaxim 7:9cd16581b578 65 mbed::Serial * serial;
IanBenzMaxim 7:9cd16581b578 66 };
IanBenzMaxim 7:9cd16581b578 67
IanBenzMaxim 8:5ea891c7d1a1 68 } // namespace MaximInterfaceMbed
IanBenzMaxim 8:5ea891c7d1a1 69 namespace MaximInterfaceCore {
IanBenzMaxim 8:5ea891c7d1a1 70
IanBenzMaxim 8:5ea891c7d1a1 71 template <>
IanBenzMaxim 8:5ea891c7d1a1 72 struct is_error_code_enum<MaximInterfaceMbed::Uart::ErrorValue> : true_type {};
IanBenzMaxim 8:5ea891c7d1a1 73
IanBenzMaxim 8:5ea891c7d1a1 74 } // namespace MaximInterfaceCore
IanBenzMaxim 8:5ea891c7d1a1 75 namespace MaximInterfaceMbed {
IanBenzMaxim 8:5ea891c7d1a1 76
IanBenzMaxim 7:9cd16581b578 77 inline MaximInterfaceCore::error_code make_error_code(Uart::ErrorValue e) {
IanBenzMaxim 7:9cd16581b578 78 return MaximInterfaceCore::error_code(e, Uart::errorCategory());
IanBenzMaxim 7:9cd16581b578 79 }
IanBenzMaxim 7:9cd16581b578 80
IanBenzMaxim 7:9cd16581b578 81 } // namespace MaximInterfaceMbed
IanBenzMaxim 7:9cd16581b578 82
IanBenzMaxim 7:9cd16581b578 83 #endif