Aleksandrs Gumenuks / MaximInterface_Extended

Extended MaximInterface

Dependents:   mbed_DS28EC20_GPIO

Platforms/dotnet/Uart.hpp@0:f77ad7f72d04, 2017-11-06 (annotated)

Committer:
IanBenzMaxim
Date:
Mon Nov 06 14:39:18 2017 -0600
Revision:
0:f77ad7f72d04
Initial commit.

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 #pragma once
IanBenzMaxim 0:f77ad7f72d04 34
IanBenzMaxim 0:f77ad7f72d04 35 #include <memory>
IanBenzMaxim 0:f77ad7f72d04 36 #include <string>
IanBenzMaxim 0:f77ad7f72d04 37 #include <MaximInterface/Links/Uart.hpp>
IanBenzMaxim 0:f77ad7f72d04 38 #include <MaximInterface/Utilities/Export.h>
IanBenzMaxim 0:f77ad7f72d04 39 #include "MoveOnly.hpp"
IanBenzMaxim 0:f77ad7f72d04 40
IanBenzMaxim 0:f77ad7f72d04 41 namespace MaximInterface {
IanBenzMaxim 0:f77ad7f72d04 42 namespace dotnet {
IanBenzMaxim 0:f77ad7f72d04 43
IanBenzMaxim 0:f77ad7f72d04 44 /// UART interface using .NET type System::IO::Ports::SerialPort.
IanBenzMaxim 0:f77ad7f72d04 45 class Uart : public MaximInterface::Uart, private MoveOnly {
IanBenzMaxim 0:f77ad7f72d04 46 public:
IanBenzMaxim 0:f77ad7f72d04 47 enum ErrorValue {
IanBenzMaxim 0:f77ad7f72d04 48 NotConnectedError = 1,
IanBenzMaxim 0:f77ad7f72d04 49 ArgumentError,
IanBenzMaxim 0:f77ad7f72d04 50 InvalidOperationError,
IanBenzMaxim 0:f77ad7f72d04 51 IOError,
IanBenzMaxim 0:f77ad7f72d04 52 UnauthorizedAccessError
IanBenzMaxim 0:f77ad7f72d04 53 };
IanBenzMaxim 0:f77ad7f72d04 54
IanBenzMaxim 0:f77ad7f72d04 55 MaximInterface_EXPORT Uart();
IanBenzMaxim 0:f77ad7f72d04 56 MaximInterface_EXPORT ~Uart();
IanBenzMaxim 0:f77ad7f72d04 57
IanBenzMaxim 0:f77ad7f72d04 58 MaximInterface_EXPORT Uart(Uart &&) noexcept;
IanBenzMaxim 0:f77ad7f72d04 59 MaximInterface_EXPORT Uart & operator=(Uart &&) noexcept;
IanBenzMaxim 0:f77ad7f72d04 60
IanBenzMaxim 0:f77ad7f72d04 61 /// Connect a specified COM port.
IanBenzMaxim 0:f77ad7f72d04 62 MaximInterface_EXPORT error_code connect(const std::string & portName);
IanBenzMaxim 0:f77ad7f72d04 63
IanBenzMaxim 0:f77ad7f72d04 64 /// Disconnect from the current COM port.
IanBenzMaxim 0:f77ad7f72d04 65 MaximInterface_EXPORT void disconnect();
IanBenzMaxim 0:f77ad7f72d04 66
IanBenzMaxim 0:f77ad7f72d04 67 /// Check if currently connected to a COM port.
IanBenzMaxim 0:f77ad7f72d04 68 /// @returns True if connected.
IanBenzMaxim 0:f77ad7f72d04 69 MaximInterface_EXPORT bool connected() const;
IanBenzMaxim 0:f77ad7f72d04 70
IanBenzMaxim 0:f77ad7f72d04 71 /// Get the currently connected COM port name.
IanBenzMaxim 0:f77ad7f72d04 72 MaximInterface_EXPORT std::string portName() const;
IanBenzMaxim 0:f77ad7f72d04 73
IanBenzMaxim 0:f77ad7f72d04 74 MaximInterface_EXPORT virtual error_code setBaud(int_least32_t baud) override;
IanBenzMaxim 0:f77ad7f72d04 75 MaximInterface_EXPORT virtual error_code sendBreak() override;
IanBenzMaxim 0:f77ad7f72d04 76 MaximInterface_EXPORT virtual error_code clearReadBuffer() override;
IanBenzMaxim 0:f77ad7f72d04 77 MaximInterface_EXPORT virtual error_code
IanBenzMaxim 0:f77ad7f72d04 78 writeByte(uint_least8_t data) override;
IanBenzMaxim 0:f77ad7f72d04 79 MaximInterface_EXPORT virtual error_code
IanBenzMaxim 0:f77ad7f72d04 80 writeBlock(const uint_least8_t * data, size_t dataLen) override;
IanBenzMaxim 0:f77ad7f72d04 81 MaximInterface_EXPORT virtual error_code
IanBenzMaxim 0:f77ad7f72d04 82 readByte(uint_least8_t & data) override;
IanBenzMaxim 0:f77ad7f72d04 83 MaximInterface_EXPORT virtual error_code readBlock(uint_least8_t * data,
IanBenzMaxim 0:f77ad7f72d04 84 size_t dataLen) override;
IanBenzMaxim 0:f77ad7f72d04 85
IanBenzMaxim 0:f77ad7f72d04 86 MaximInterface_EXPORT static const error_category & errorCategory();
IanBenzMaxim 0:f77ad7f72d04 87
IanBenzMaxim 0:f77ad7f72d04 88 private:
IanBenzMaxim 0:f77ad7f72d04 89 struct Data;
IanBenzMaxim 0:f77ad7f72d04 90 std::unique_ptr<Data> data;
IanBenzMaxim 0:f77ad7f72d04 91 };
IanBenzMaxim 0:f77ad7f72d04 92
IanBenzMaxim 0:f77ad7f72d04 93 inline error_code make_error_code(Uart::ErrorValue e) {
IanBenzMaxim 0:f77ad7f72d04 94 return error_code(e, Uart::errorCategory());
IanBenzMaxim 0:f77ad7f72d04 95 }
IanBenzMaxim 0:f77ad7f72d04 96
IanBenzMaxim 0:f77ad7f72d04 97 } // namespace dotnet
IanBenzMaxim 0:f77ad7f72d04 98 } // namespace MaximInterface