Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/RawSerial.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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