mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

drivers/Serial.h@134:ad3be0349dc5, 2017-01-16 (annotated)

Committer:
<>
Date:
Mon Jan 16 12:05:23 2017 +0000
Revision:
134:ad3be0349dc5
Parent:
128:9bcdf88f62b0
Child:
145:64910690c574
Release 134 of the mbed library



Ports for Upcoming Targets





Fixes and Changes



3488: Dev stm i2c v2 unitary functions https://github.com/ARMmbed/mbed-os/pull/3488

3492: Fix #3463 CAN read() return value https://github.com/ARMmbed/mbed-os/pull/3492

3503: [LPC15xx] Ensure that PWM=1 is resolved correctly https://github.com/ARMmbed/mbed-os/pull/3503

3504: [LPC15xx] CAN implementation improvements https://github.com/ARMmbed/mbed-os/pull/3504

3539: NUCLEO_F412ZG - Add support of TRNG peripheral https://github.com/ARMmbed/mbed-os/pull/3539

3540: STM: SPI: Initialize Rx in spi_master_write https://github.com/ARMmbed/mbed-os/pull/3540

3438: K64F: Add support for SERIAL ASYNCH API https://github.com/ARMmbed/mbed-os/pull/3438

3519: MCUXpresso: Fix ENET driver to enable interrupts after interrupt handler is set https://github.com/ARMmbed/mbed-os/pull/3519

3544: STM32L4 deepsleep improvement https://github.com/ARMmbed/mbed-os/pull/3544

3546: NUCLEO-F412ZG - Add CAN peripheral https://github.com/ARMmbed/mbed-os/pull/3546

3551: Fix I2C driver for RZ/A1H https://github.com/ARMmbed/mbed-os/pull/3551

3558: K64F UART Asynch API: Fix synchronization issue https://github.com/ARMmbed/mbed-os/pull/3558

3563: LPC4088 - Fix vector checksum https://github.com/ARMmbed/mbed-os/pull/3563

3567: Dev stm32 F0 v1.7.0 https://github.com/ARMmbed/mbed-os/pull/3567

3577: Fixes linking errors when building with debug profile https://github.com/ARMmbed/mbed-os/pull/3577

Who changed what in which revision?

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