Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/drivers/Serial.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ommpy 0:d383e2dee0f7 1 /* mbed Microcontroller Library
ommpy 0:d383e2dee0f7 2 * Copyright (c) 2006-2013 ARM Limited
ommpy 0:d383e2dee0f7 3 * SPDX-License-Identifier: Apache-2.0
ommpy 0:d383e2dee0f7 4 *
ommpy 0:d383e2dee0f7 5 * Licensed under the Apache License, Version 2.0 (the "License");
ommpy 0:d383e2dee0f7 6 * you may not use this file except in compliance with the License.
ommpy 0:d383e2dee0f7 7 * You may obtain a copy of the License at
ommpy 0:d383e2dee0f7 8 *
ommpy 0:d383e2dee0f7 9 * http://www.apache.org/licenses/LICENSE-2.0
ommpy 0:d383e2dee0f7 10 *
ommpy 0:d383e2dee0f7 11 * Unless required by applicable law or agreed to in writing, software
ommpy 0:d383e2dee0f7 12 * distributed under the License is distributed on an "AS IS" BASIS,
ommpy 0:d383e2dee0f7 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ommpy 0:d383e2dee0f7 14 * See the License for the specific language governing permissions and
ommpy 0:d383e2dee0f7 15 * limitations under the License.
ommpy 0:d383e2dee0f7 16 */
ommpy 0:d383e2dee0f7 17 #ifndef MBED_SERIAL_H
ommpy 0:d383e2dee0f7 18 #define MBED_SERIAL_H
ommpy 0:d383e2dee0f7 19
ommpy 0:d383e2dee0f7 20 #include "platform/platform.h"
ommpy 0:d383e2dee0f7 21
ommpy 0:d383e2dee0f7 22 #if DEVICE_SERIAL || defined(DOXYGEN_ONLY)
ommpy 0:d383e2dee0f7 23
ommpy 0:d383e2dee0f7 24 #include "platform/Stream.h"
ommpy 0:d383e2dee0f7 25 #include "SerialBase.h"
ommpy 0:d383e2dee0f7 26 #include "platform/PlatformMutex.h"
ommpy 0:d383e2dee0f7 27 #include "hal/serial_api.h"
ommpy 0:d383e2dee0f7 28 #include "platform/NonCopyable.h"
ommpy 0:d383e2dee0f7 29
ommpy 0:d383e2dee0f7 30 namespace mbed {
ommpy 0:d383e2dee0f7 31 /** \addtogroup drivers */
ommpy 0:d383e2dee0f7 32
ommpy 0:d383e2dee0f7 33 /** A serial port (UART) for communication with other serial devices
ommpy 0:d383e2dee0f7 34 *
ommpy 0:d383e2dee0f7 35 * Can be used for Full Duplex communication, or Simplex by specifying
ommpy 0:d383e2dee0f7 36 * one pin as NC (Not Connected)
ommpy 0:d383e2dee0f7 37 *
ommpy 0:d383e2dee0f7 38 * @note Synchronization level: Thread safe
ommpy 0:d383e2dee0f7 39 *
ommpy 0:d383e2dee0f7 40 * Example:
ommpy 0:d383e2dee0f7 41 * @code
ommpy 0:d383e2dee0f7 42 * // Print "Hello World" to the PC
ommpy 0:d383e2dee0f7 43 *
ommpy 0:d383e2dee0f7 44 * #include "mbed.h"
ommpy 0:d383e2dee0f7 45 *
ommpy 0:d383e2dee0f7 46 * Serial pc(USBTX, USBRX);
ommpy 0:d383e2dee0f7 47 *
ommpy 0:d383e2dee0f7 48 * int main() {
ommpy 0:d383e2dee0f7 49 * pc.printf("Hello World\n");
ommpy 0:d383e2dee0f7 50 * }
ommpy 0:d383e2dee0f7 51 * @endcode
ommpy 0:d383e2dee0f7 52 * @ingroup drivers
ommpy 0:d383e2dee0f7 53 */
ommpy 0:d383e2dee0f7 54 class Serial : public SerialBase, public Stream, private NonCopyable<Serial> {
ommpy 0:d383e2dee0f7 55
ommpy 0:d383e2dee0f7 56 public:
ommpy 0:d383e2dee0f7 57 #if DEVICE_SERIAL_ASYNCH
ommpy 0:d383e2dee0f7 58 using SerialBase::read;
ommpy 0:d383e2dee0f7 59 using SerialBase::write;
ommpy 0:d383e2dee0f7 60 #endif
ommpy 0:d383e2dee0f7 61
ommpy 0:d383e2dee0f7 62 /** Create a Serial port, connected to the specified transmit and receive pins
ommpy 0:d383e2dee0f7 63 *
ommpy 0:d383e2dee0f7 64 * @param tx Transmit pin
ommpy 0:d383e2dee0f7 65 * @param rx Receive pin
ommpy 0:d383e2dee0f7 66 * @param name The name of the stream associated with this serial port (optional)
ommpy 0:d383e2dee0f7 67 * @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE or 9600)
ommpy 0:d383e2dee0f7 68 *
ommpy 0:d383e2dee0f7 69 * @note
ommpy 0:d383e2dee0f7 70 * Either tx or rx may be specified as NC (Not Connected) if unused
ommpy 0:d383e2dee0f7 71 */
ommpy 0:d383e2dee0f7 72 Serial(PinName tx, PinName rx, const char *name = NULL, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
ommpy 0:d383e2dee0f7 73
ommpy 0:d383e2dee0f7 74
ommpy 0:d383e2dee0f7 75 /** Create a Serial port, connected to the specified transmit and receive pins, with the specified baud
ommpy 0:d383e2dee0f7 76 *
ommpy 0:d383e2dee0f7 77 * @param tx Transmit pin
ommpy 0:d383e2dee0f7 78 * @param rx Receive pin
ommpy 0:d383e2dee0f7 79 * @param baud The baud rate of the serial port
ommpy 0:d383e2dee0f7 80 *
ommpy 0:d383e2dee0f7 81 * @note
ommpy 0:d383e2dee0f7 82 * Either tx or rx may be specified as NC (Not Connected) if unused
ommpy 0:d383e2dee0f7 83 */
ommpy 0:d383e2dee0f7 84 Serial(PinName tx, PinName rx, int baud);
ommpy 0:d383e2dee0f7 85
ommpy 0:d383e2dee0f7 86 /* Stream gives us a FileHandle with non-functional poll()/readable()/writable. Pass through
ommpy 0:d383e2dee0f7 87 * the calls from the SerialBase instead for backwards compatibility. This problem is
ommpy 0:d383e2dee0f7 88 * part of why Stream and Serial should be deprecated.
ommpy 0:d383e2dee0f7 89 */
ommpy 0:d383e2dee0f7 90 bool readable()
ommpy 0:d383e2dee0f7 91 {
ommpy 0:d383e2dee0f7 92 return SerialBase::readable();
ommpy 0:d383e2dee0f7 93 }
ommpy 0:d383e2dee0f7 94 bool writable()
ommpy 0:d383e2dee0f7 95 {
ommpy 0:d383e2dee0f7 96 return SerialBase::writeable();
ommpy 0:d383e2dee0f7 97 }
ommpy 0:d383e2dee0f7 98 bool writeable()
ommpy 0:d383e2dee0f7 99 {
ommpy 0:d383e2dee0f7 100 return SerialBase::writeable();
ommpy 0:d383e2dee0f7 101 }
ommpy 0:d383e2dee0f7 102
ommpy 0:d383e2dee0f7 103 #if !(DOXYGEN_ONLY)
ommpy 0:d383e2dee0f7 104 protected:
ommpy 0:d383e2dee0f7 105 virtual int _getc();
ommpy 0:d383e2dee0f7 106 virtual int _putc(int c);
ommpy 0:d383e2dee0f7 107 virtual void lock();
ommpy 0:d383e2dee0f7 108 virtual void unlock();
ommpy 0:d383e2dee0f7 109
ommpy 0:d383e2dee0f7 110 PlatformMutex _mutex;
ommpy 0:d383e2dee0f7 111 #endif
ommpy 0:d383e2dee0f7 112 };
ommpy 0:d383e2dee0f7 113
ommpy 0:d383e2dee0f7 114 } // namespace mbed
ommpy 0:d383e2dee0f7 115
ommpy 0:d383e2dee0f7 116 #endif
ommpy 0:d383e2dee0f7 117
ommpy 0:d383e2dee0f7 118 #endif