Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Committer:
reARMnimator
Date:
Wed Apr 03 12:33:10 2019 +0000
Revision:
8:211d1b8f730c
Parent:
3:f818ea5172ed
Merge with version 1.7;

Who changed what in which revision?

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