Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/Serial.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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