Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

drivers/Serial.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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