PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/RawSerial.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_RAW_SERIAL_H
phungductung 0:e87aa4c49e95 17 #define MBED_RAW_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 "SerialBase.h"
phungductung 0:e87aa4c49e95 24 #include "serial_api.h"
phungductung 0:e87aa4c49e95 25
phungductung 0:e87aa4c49e95 26 namespace mbed {
phungductung 0:e87aa4c49e95 27
phungductung 0:e87aa4c49e95 28 /** A serial port (UART) for communication with other serial devices
phungductung 0:e87aa4c49e95 29 * This is a variation of the Serial class that doesn't use streams,
phungductung 0:e87aa4c49e95 30 * thus making it safe to use in interrupt handlers with the RTOS.
phungductung 0:e87aa4c49e95 31 *
phungductung 0:e87aa4c49e95 32 * Can be used for Full Duplex communication, or Simplex by specifying
phungductung 0:e87aa4c49e95 33 * one pin as NC (Not Connected)
phungductung 0:e87aa4c49e95 34 *
phungductung 0:e87aa4c49e95 35 * Example:
phungductung 0:e87aa4c49e95 36 * @code
phungductung 0:e87aa4c49e95 37 * // Send a char to the PC
phungductung 0:e87aa4c49e95 38 *
phungductung 0:e87aa4c49e95 39 * #include "mbed.h"
phungductung 0:e87aa4c49e95 40 *
phungductung 0:e87aa4c49e95 41 * RawSerial pc(USBTX, USBRX);
phungductung 0:e87aa4c49e95 42 *
phungductung 0:e87aa4c49e95 43 * int main() {
phungductung 0:e87aa4c49e95 44 * pc.putc('A');
phungductung 0:e87aa4c49e95 45 * }
phungductung 0:e87aa4c49e95 46 * @endcode
phungductung 0:e87aa4c49e95 47 */
phungductung 0:e87aa4c49e95 48 class RawSerial: public SerialBase {
phungductung 0:e87aa4c49e95 49
phungductung 0:e87aa4c49e95 50 public:
phungductung 0:e87aa4c49e95 51 /** Create a RawSerial port, connected to the specified transmit and receive pins
phungductung 0:e87aa4c49e95 52 *
phungductung 0:e87aa4c49e95 53 * @param tx Transmit pin
phungductung 0:e87aa4c49e95 54 * @param rx Receive pin
phungductung 0:e87aa4c49e95 55 *
phungductung 0:e87aa4c49e95 56 * @note
phungductung 0:e87aa4c49e95 57 * Either tx or rx may be specified as NC if unused
phungductung 0:e87aa4c49e95 58 */
phungductung 0:e87aa4c49e95 59 RawSerial(PinName tx, PinName rx);
phungductung 0:e87aa4c49e95 60
phungductung 0:e87aa4c49e95 61 /** Write a char to the serial port
phungductung 0:e87aa4c49e95 62 *
phungductung 0:e87aa4c49e95 63 * @param c The char to write
phungductung 0:e87aa4c49e95 64 *
phungductung 0:e87aa4c49e95 65 * @returns The written char or -1 if an error occured
phungductung 0:e87aa4c49e95 66 */
phungductung 0:e87aa4c49e95 67 int putc(int c);
phungductung 0:e87aa4c49e95 68
phungductung 0:e87aa4c49e95 69 /** Read a char from the serial port
phungductung 0:e87aa4c49e95 70 *
phungductung 0:e87aa4c49e95 71 * @returns The char read from the serial port
phungductung 0:e87aa4c49e95 72 */
phungductung 0:e87aa4c49e95 73 int getc();
phungductung 0:e87aa4c49e95 74
phungductung 0:e87aa4c49e95 75 /** Write a string to the serial port
phungductung 0:e87aa4c49e95 76 *
phungductung 0:e87aa4c49e95 77 * @param str The string to write
phungductung 0:e87aa4c49e95 78 *
phungductung 0:e87aa4c49e95 79 * @returns 0 if the write succeeds, EOF for error
phungductung 0:e87aa4c49e95 80 */
phungductung 0:e87aa4c49e95 81 int puts(const char *str);
phungductung 0:e87aa4c49e95 82
phungductung 0:e87aa4c49e95 83 int printf(const char *format, ...);
phungductung 0:e87aa4c49e95 84 };
phungductung 0:e87aa4c49e95 85
phungductung 0:e87aa4c49e95 86 } // namespace mbed
phungductung 0:e87aa4c49e95 87
phungductung 0:e87aa4c49e95 88 #endif
phungductung 0:e87aa4c49e95 89
phungductung 0:e87aa4c49e95 90 #endif