mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/Serial.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

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