Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Diff: mbed/drivers/Serial.h
- Revision:
- 12:406f75196a12
- Parent:
- 11:32eeb052cda5
- Child:
- 13:0c732e06d675
diff -r 32eeb052cda5 -r 406f75196a12 mbed/drivers/Serial.h
--- a/mbed/drivers/Serial.h Wed Aug 26 14:26:27 2020 +0530
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,118 +0,0 @@
-/* mbed Microcontroller Library
- * Copyright (c) 2006-2013 ARM Limited
- * SPDX-License-Identifier: Apache-2.0
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-#ifndef MBED_SERIAL_H
-#define MBED_SERIAL_H
-
-#include "platform/platform.h"
-
-#if DEVICE_SERIAL || defined(DOXYGEN_ONLY)
-
-#include "platform/Stream.h"
-#include "SerialBase.h"
-#include "platform/PlatformMutex.h"
-#include "hal/serial_api.h"
-#include "platform/NonCopyable.h"
-
-namespace mbed {
-/** \addtogroup drivers */
-
-/** A serial port (UART) for communication with other serial devices
- *
- * Can be used for Full Duplex communication, or Simplex by specifying
- * one pin as NC (Not Connected)
- *
- * @note Synchronization level: Thread safe
- *
- * Example:
- * @code
- * // Print "Hello World" to the PC
- *
- * #include "mbed.h"
- *
- * Serial pc(USBTX, USBRX);
- *
- * int main() {
- * pc.printf("Hello World\n");
- * }
- * @endcode
- * @ingroup drivers
- */
-class Serial : public SerialBase, public Stream, private NonCopyable<Serial> {
-
-public:
-#if DEVICE_SERIAL_ASYNCH
- using SerialBase::read;
- using SerialBase::write;
-#endif
-
- /** Create a Serial port, connected to the specified transmit and receive pins
- *
- * @param tx Transmit pin
- * @param rx Receive pin
- * @param name The name of the stream associated with this serial port (optional)
- * @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE or 9600)
- *
- * @note
- * Either tx or rx may be specified as NC (Not Connected) if unused
- */
- Serial(PinName tx, PinName rx, const char *name = NULL, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
-
-
- /** Create a Serial port, connected to the specified transmit and receive pins, with the specified baud
- *
- * @param tx Transmit pin
- * @param rx Receive pin
- * @param baud The baud rate of the serial port
- *
- * @note
- * Either tx or rx may be specified as NC (Not Connected) if unused
- */
- Serial(PinName tx, PinName rx, int baud);
-
- /* Stream gives us a FileHandle with non-functional poll()/readable()/writable. Pass through
- * the calls from the SerialBase instead for backwards compatibility. This problem is
- * part of why Stream and Serial should be deprecated.
- */
- bool readable()
- {
- return SerialBase::readable();
- }
- bool writable()
- {
- return SerialBase::writeable();
- }
- bool writeable()
- {
- return SerialBase::writeable();
- }
-
-#if !(DOXYGEN_ONLY)
-protected:
- virtual int _getc();
- virtual int _putc(int c);
- virtual void lock();
- virtual void unlock();
-
- PlatformMutex _mutex;
-#endif
-};
-
-} // namespace mbed
-
-#endif
-
-#endif