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.cpp@12:7eb41621ba22, 2020-05-29 (annotated)

Committer:
IanBenzMaxim
Date:
Fri May 29 16:19:22 2020 -0500
Revision:
12:7eb41621ba22
Parent:
11:3f3bf6bf5e6c 
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 7:9cd16581b578 33 #include <MaximInterfaceCore/Error.hpp>
IanBenzMaxim 7:9cd16581b578 34 #include <mbed-os/drivers/Timer.h>
IanBenzMaxim 7:9cd16581b578 35 #include "Uart.hpp"
IanBenzMaxim 7:9cd16581b578 36
IanBenzMaxim 7:9cd16581b578 37 namespace MaximInterfaceMbed {
IanBenzMaxim 7:9cd16581b578 38
IanBenzMaxim 7:9cd16581b578 39 using namespace MaximInterfaceCore;
IanBenzMaxim 7:9cd16581b578 40
IanBenzMaxim 7:9cd16581b578 41 static const int timeout_ms = 10000;
IanBenzMaxim 7:9cd16581b578 42
IanBenzMaxim 8:5ea891c7d1a1 43 Result<void> Uart::setBaudRate(int_least32_t baudRate) {
IanBenzMaxim 7:9cd16581b578 44 serial->baud(baudRate);
IanBenzMaxim 8:5ea891c7d1a1 45 return none;
IanBenzMaxim 7:9cd16581b578 46 }
IanBenzMaxim 7:9cd16581b578 47
IanBenzMaxim 8:5ea891c7d1a1 48 Result<void> Uart::sendBreak() {
IanBenzMaxim 7:9cd16581b578 49 serial->send_break();
IanBenzMaxim 8:5ea891c7d1a1 50 return none;
IanBenzMaxim 7:9cd16581b578 51 }
IanBenzMaxim 7:9cd16581b578 52
IanBenzMaxim 8:5ea891c7d1a1 53 Result<void> Uart::clearReadBuffer() {
IanBenzMaxim 7:9cd16581b578 54 while (serial->readable()) {
IanBenzMaxim 7:9cd16581b578 55 serial->getc();
IanBenzMaxim 7:9cd16581b578 56 }
IanBenzMaxim 8:5ea891c7d1a1 57 return none;
IanBenzMaxim 7:9cd16581b578 58 }
IanBenzMaxim 7:9cd16581b578 59
IanBenzMaxim 8:5ea891c7d1a1 60 Result<void> Uart::writeByte(uint_least8_t data) {
IanBenzMaxim 7:9cd16581b578 61 if (!serial->writeable()) {
IanBenzMaxim 7:9cd16581b578 62 mbed::Timer timer;
IanBenzMaxim 7:9cd16581b578 63 timer.start();
IanBenzMaxim 7:9cd16581b578 64 while (!serial->writeable()) {
IanBenzMaxim 7:9cd16581b578 65 if (timer.read_ms() >= timeout_ms) {
IanBenzMaxim 8:5ea891c7d1a1 66 return HardwareError;
IanBenzMaxim 7:9cd16581b578 67 }
IanBenzMaxim 7:9cd16581b578 68 }
IanBenzMaxim 7:9cd16581b578 69 }
IanBenzMaxim 7:9cd16581b578 70 serial->putc(data);
IanBenzMaxim 8:5ea891c7d1a1 71 return none;
IanBenzMaxim 7:9cd16581b578 72 }
IanBenzMaxim 7:9cd16581b578 73
IanBenzMaxim 8:5ea891c7d1a1 74 Result<uint_least8_t> Uart::readByte() {
IanBenzMaxim 7:9cd16581b578 75 if (!serial->readable()) {
IanBenzMaxim 7:9cd16581b578 76 mbed::Timer timer;
IanBenzMaxim 7:9cd16581b578 77 timer.start();
IanBenzMaxim 7:9cd16581b578 78 while (!serial->readable()) {
IanBenzMaxim 7:9cd16581b578 79 if (timer.read_ms() >= timeout_ms) {
IanBenzMaxim 8:5ea891c7d1a1 80 return TimeoutError;
IanBenzMaxim 7:9cd16581b578 81 }
IanBenzMaxim 7:9cd16581b578 82 }
IanBenzMaxim 7:9cd16581b578 83 }
IanBenzMaxim 8:5ea891c7d1a1 84 return serial->getc();
IanBenzMaxim 7:9cd16581b578 85 }
IanBenzMaxim 7:9cd16581b578 86
IanBenzMaxim 7:9cd16581b578 87 const error_category & Uart::errorCategory() {
IanBenzMaxim 7:9cd16581b578 88 static class : public error_category {
IanBenzMaxim 7:9cd16581b578 89 public:
IanBenzMaxim 11:3f3bf6bf5e6c 90 virtual const char * name() const { return "MaximInterfaceMbed.Uart"; }
IanBenzMaxim 7:9cd16581b578 91
IanBenzMaxim 7:9cd16581b578 92 virtual std::string message(int condition) const {
IanBenzMaxim 7:9cd16581b578 93 switch (condition) {
IanBenzMaxim 7:9cd16581b578 94 case HardwareError:
IanBenzMaxim 7:9cd16581b578 95 return "Hardware Error";
IanBenzMaxim 7:9cd16581b578 96 }
IanBenzMaxim 8:5ea891c7d1a1 97 return defaultErrorMessage(condition);
IanBenzMaxim 7:9cd16581b578 98 }
IanBenzMaxim 7:9cd16581b578 99 } instance;
IanBenzMaxim 7:9cd16581b578 100 return instance;
IanBenzMaxim 7:9cd16581b578 101 }
IanBenzMaxim 7:9cd16581b578 102
IanBenzMaxim 7:9cd16581b578 103 } // namespace MaximInterfaceMbed