Marek Trojan / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/Serial.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:
<>
Date:
Fri Sep 02 15:07:44 2016 +0100
Revision:
144:ef7eb2e8f9f7
Parent:
0:9b334a45a8ff 
This updates the lib to the mbed lib v125

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 144:ef7eb2e8f9f7 1 /* mbed Microcontroller Library
<> 144:ef7eb2e8f9f7 2 * Copyright (c) 2006-2013 ARM Limited
<> 144:ef7eb2e8f9f7 3 *
<> 144:ef7eb2e8f9f7 4 * Licensed under the Apache License, Version 2.0 (the "License");
<> 144:ef7eb2e8f9f7 5 * you may not use this file except in compliance with the License.
<> 144:ef7eb2e8f9f7 6 * You may obtain a copy of the License at
<> 144:ef7eb2e8f9f7 7 *
<> 144:ef7eb2e8f9f7 8 * http://www.apache.org/licenses/LICENSE-2.0
<> 144:ef7eb2e8f9f7 9 *
<> 144:ef7eb2e8f9f7 10 * Unless required by applicable law or agreed to in writing, software
<> 144:ef7eb2e8f9f7 11 * distributed under the License is distributed on an "AS IS" BASIS,
<> 144:ef7eb2e8f9f7 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 144:ef7eb2e8f9f7 13 * See the License for the specific language governing permissions and
<> 144:ef7eb2e8f9f7 14 * limitations under the License.
<> 144:ef7eb2e8f9f7 15 */
<> 144:ef7eb2e8f9f7 16 #ifndef MBED_SERIAL_H
<> 144:ef7eb2e8f9f7 17 #define MBED_SERIAL_H
<> 144:ef7eb2e8f9f7 18
<> 144:ef7eb2e8f9f7 19 #include "platform.h"
<> 144:ef7eb2e8f9f7 20
<> 144:ef7eb2e8f9f7 21 #if DEVICE_SERIAL
<> 144:ef7eb2e8f9f7 22
<> 144:ef7eb2e8f9f7 23 #include "Stream.h"
<> 144:ef7eb2e8f9f7 24 #include "SerialBase.h"
<> 144:ef7eb2e8f9f7 25 #include "PlatformMutex.h"
<> 144:ef7eb2e8f9f7 26 #include "serial_api.h"
<> 144:ef7eb2e8f9f7 27
<> 144:ef7eb2e8f9f7 28 namespace mbed {
<> 144:ef7eb2e8f9f7 29
<> 144:ef7eb2e8f9f7 30 /** A serial port (UART) for communication with other serial devices
<> 144:ef7eb2e8f9f7 31 *
<> 144:ef7eb2e8f9f7 32 * Can be used for Full Duplex communication, or Simplex by specifying
<> 144:ef7eb2e8f9f7 33 * one pin as NC (Not Connected)
<> 144:ef7eb2e8f9f7 34 *
<> 144:ef7eb2e8f9f7 35 * @Note Synchronization level: Thread safe
<> 144:ef7eb2e8f9f7 36 *
<> 144:ef7eb2e8f9f7 37 * Example:
<> 144:ef7eb2e8f9f7 38 * @code
<> 144:ef7eb2e8f9f7 39 * // Print "Hello World" to the PC
<> 144:ef7eb2e8f9f7 40 *
<> 144:ef7eb2e8f9f7 41 * #include "mbed.h"
<> 144:ef7eb2e8f9f7 42 *
<> 144:ef7eb2e8f9f7 43 * Serial pc(USBTX, USBRX);
<> 144:ef7eb2e8f9f7 44 *
<> 144:ef7eb2e8f9f7 45 * int main() {
<> 144:ef7eb2e8f9f7 46 * pc.printf("Hello World\n");
<> 144:ef7eb2e8f9f7 47 * }
<> 144:ef7eb2e8f9f7 48 * @endcode
<> 144:ef7eb2e8f9f7 49 */
<> 144:ef7eb2e8f9f7 50 class Serial : public SerialBase, public Stream {
<> 144:ef7eb2e8f9f7 51
<> 144:ef7eb2e8f9f7 52 public:
<> 144:ef7eb2e8f9f7 53 #if DEVICE_SERIAL_ASYNCH
<> 144:ef7eb2e8f9f7 54 using SerialBase::read;
<> 144:ef7eb2e8f9f7 55 using SerialBase::write;
<> 144:ef7eb2e8f9f7 56 #endif
<> 144:ef7eb2e8f9f7 57
<> 144:ef7eb2e8f9f7 58 /** Create a Serial port, connected to the specified transmit and receive pins
<> 144:ef7eb2e8f9f7 59 *
<> 144:ef7eb2e8f9f7 60 * @param tx Transmit pin
<> 144:ef7eb2e8f9f7 61 * @param rx Receive pin
<> 144:ef7eb2e8f9f7 62 *
<> 144:ef7eb2e8f9f7 63 * @note
<> 144:ef7eb2e8f9f7 64 * Either tx or rx may be specified as NC if unused
<> 144:ef7eb2e8f9f7 65 */
<> 144:ef7eb2e8f9f7 66 Serial(PinName tx, PinName rx, const char *name=NULL);
<> 144:ef7eb2e8f9f7 67
<> 144:ef7eb2e8f9f7 68 protected:
<> 144:ef7eb2e8f9f7 69 virtual int _getc();
<> 144:ef7eb2e8f9f7 70 virtual int _putc(int c);
<> 144:ef7eb2e8f9f7 71 virtual void lock();
<> 144:ef7eb2e8f9f7 72 virtual void unlock();
<> 144:ef7eb2e8f9f7 73
<> 144:ef7eb2e8f9f7 74 PlatformMutex _mutex;
<> 144:ef7eb2e8f9f7 75 };
<> 144:ef7eb2e8f9f7 76
<> 144:ef7eb2e8f9f7 77 } // namespace mbed
<> 144:ef7eb2e8f9f7 78
<> 144:ef7eb2e8f9f7 79 #endif
<> 144:ef7eb2e8f9f7 80
<> 144:ef7eb2e8f9f7 81 #endif