PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/Serial.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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