mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

drivers/Serial.h@181:57724642e740, 2018-02-16 (annotated)

Committer:
AnnaBridge
Date:
Fri Feb 16 16:09:33 2018 +0000
Revision:
181:57724642e740
Parent:
168:9672193075cf
Child:
187:0387e8f68319
mbed-dev library. Release version 159.

Who changed what in which revision?

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