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@145:64910690c574, 2017-06-21 (annotated)

Committer:
AnnaBridge
Date:
Wed Jun 21 17:31:38 2017 +0100
Revision:
145:64910690c574
Parent:
128:9bcdf88f62b0
Child:
146:22da6e220af6
Release 145 of the mbed library.

Who changed what in which revision?

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