Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

init

Dependencies:   mbed

mbed-os/drivers/RawSerial.h@10:46a4cf51ee38, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:16:49 2018 -0700
Revision:
10:46a4cf51ee38
Parent:
9:d58e77ebd769 
remove mbed-os

Who changed what in which revision?

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