ON Semiconductor / mbed-os

5.2.1 - Updated I2C files

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

drivers/Serial.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

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