Mateusz Kowalik / Application

USB Serial application

Fork of USBSerial_HelloWorld by Samuel Mokrani

mbed-dev/drivers/RawSerial.h@10:41552d038a69, 2017-01-10 (annotated)

Committer:
Zaitsev
Date:
Tue Jan 10 20:42:26 2017 +0000
Revision:
10:41552d038a69
USB Serial bi-directional bridge

Who changed what in which revision?

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