Kev Mann / mbed-dev-OS5_10_4

RTC auf true

drivers/Serial.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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