Kev Mann / mbed-dev-OS5_10_4

RTC auf true

drivers/RawSerial.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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