Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/RawSerial.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ommpy 0:d383e2dee0f7 1 /* mbed Microcontroller Library
ommpy 0:d383e2dee0f7 2 * Copyright (c) 2006-2013 ARM Limited
ommpy 0:d383e2dee0f7 3 *
ommpy 0:d383e2dee0f7 4 * Licensed under the Apache License, Version 2.0 (the "License");
ommpy 0:d383e2dee0f7 5 * you may not use this file except in compliance with the License.
ommpy 0:d383e2dee0f7 6 * You may obtain a copy of the License at
ommpy 0:d383e2dee0f7 7 *
ommpy 0:d383e2dee0f7 8 * http://www.apache.org/licenses/LICENSE-2.0
ommpy 0:d383e2dee0f7 9 *
ommpy 0:d383e2dee0f7 10 * Unless required by applicable law or agreed to in writing, software
ommpy 0:d383e2dee0f7 11 * distributed under the License is distributed on an "AS IS" BASIS,
ommpy 0:d383e2dee0f7 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ommpy 0:d383e2dee0f7 13 * See the License for the specific language governing permissions and
ommpy 0:d383e2dee0f7 14 * limitations under the License.
ommpy 0:d383e2dee0f7 15 */
ommpy 0:d383e2dee0f7 16 #ifndef MBED_RAW_SERIAL_H
ommpy 0:d383e2dee0f7 17 #define MBED_RAW_SERIAL_H
ommpy 0:d383e2dee0f7 18
ommpy 0:d383e2dee0f7 19 #include "platform.h"
ommpy 0:d383e2dee0f7 20
ommpy 0:d383e2dee0f7 21 #if DEVICE_SERIAL
ommpy 0:d383e2dee0f7 22
ommpy 0:d383e2dee0f7 23 #include "SerialBase.h"
ommpy 0:d383e2dee0f7 24 #include "serial_api.h"
ommpy 0:d383e2dee0f7 25
ommpy 0:d383e2dee0f7 26 namespace mbed {
ommpy 0:d383e2dee0f7 27
ommpy 0:d383e2dee0f7 28 /** A serial port (UART) for communication with other serial devices
ommpy 0:d383e2dee0f7 29 * This is a variation of the Serial class that doesn't use streams,
ommpy 0:d383e2dee0f7 30 * thus making it safe to use in interrupt handlers with the RTOS.
ommpy 0:d383e2dee0f7 31 *
ommpy 0:d383e2dee0f7 32 * Can be used for Full Duplex communication, or Simplex by specifying
ommpy 0:d383e2dee0f7 33 * one pin as NC (Not Connected)
ommpy 0:d383e2dee0f7 34 *
ommpy 0:d383e2dee0f7 35 * Example:
ommpy 0:d383e2dee0f7 36 * @code
ommpy 0:d383e2dee0f7 37 * // Send a char to the PC
ommpy 0:d383e2dee0f7 38 *
ommpy 0:d383e2dee0f7 39 * #include "mbed.h"
ommpy 0:d383e2dee0f7 40 *
ommpy 0:d383e2dee0f7 41 * RawSerial pc(USBTX, USBRX);
ommpy 0:d383e2dee0f7 42 *
ommpy 0:d383e2dee0f7 43 * int main() {
ommpy 0:d383e2dee0f7 44 * pc.putc('A');
ommpy 0:d383e2dee0f7 45 * }
ommpy 0:d383e2dee0f7 46 * @endcode
ommpy 0:d383e2dee0f7 47 */
ommpy 0:d383e2dee0f7 48 class RawSerial: public SerialBase {
ommpy 0:d383e2dee0f7 49
ommpy 0:d383e2dee0f7 50 public:
ommpy 0:d383e2dee0f7 51 /** Create a RawSerial port, connected to the specified transmit and receive pins
ommpy 0:d383e2dee0f7 52 *
ommpy 0:d383e2dee0f7 53 * @param tx Transmit pin
ommpy 0:d383e2dee0f7 54 * @param rx Receive pin
ommpy 0:d383e2dee0f7 55 *
ommpy 0:d383e2dee0f7 56 * @note
ommpy 0:d383e2dee0f7 57 * Either tx or rx may be specified as NC if unused
ommpy 0:d383e2dee0f7 58 */
ommpy 0:d383e2dee0f7 59 RawSerial(PinName tx, PinName rx);
ommpy 0:d383e2dee0f7 60
ommpy 0:d383e2dee0f7 61 /** Write a char to the serial port
ommpy 0:d383e2dee0f7 62 *
ommpy 0:d383e2dee0f7 63 * @param c The char to write
ommpy 0:d383e2dee0f7 64 *
ommpy 0:d383e2dee0f7 65 * @returns The written char or -1 if an error occured
ommpy 0:d383e2dee0f7 66 */
ommpy 0:d383e2dee0f7 67 int putc(int c);
ommpy 0:d383e2dee0f7 68
ommpy 0:d383e2dee0f7 69 /** Read a char from the serial port
ommpy 0:d383e2dee0f7 70 *
ommpy 0:d383e2dee0f7 71 * @returns The char read from the serial port
ommpy 0:d383e2dee0f7 72 */
ommpy 0:d383e2dee0f7 73 int getc();
ommpy 0:d383e2dee0f7 74
ommpy 0:d383e2dee0f7 75 /** Write a string to the serial port
ommpy 0:d383e2dee0f7 76 *
ommpy 0:d383e2dee0f7 77 * @param str The string to write
ommpy 0:d383e2dee0f7 78 *
ommpy 0:d383e2dee0f7 79 * @returns 0 if the write succeeds, EOF for error
ommpy 0:d383e2dee0f7 80 */
ommpy 0:d383e2dee0f7 81 int puts(const char *str);
ommpy 0:d383e2dee0f7 82
ommpy 0:d383e2dee0f7 83 int printf(const char *format, ...);
ommpy 0:d383e2dee0f7 84 };
ommpy 0:d383e2dee0f7 85
ommpy 0:d383e2dee0f7 86 } // namespace mbed
ommpy 0:d383e2dee0f7 87
ommpy 0:d383e2dee0f7 88 #endif
ommpy 0:d383e2dee0f7 89
ommpy 0:d383e2dee0f7 90 #endif