mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

cmsis/BUILD/mbed/drivers/Serial.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

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