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@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Parent:
156:ff21514d8981
Child:
170:e95d10626187
Release 155 of the mbed library.

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