Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

drivers/RawSerial.h@1:3deb71413561, 2017-07-20 (annotated)

Committer:
xuaner
Date:
Thu Jul 20 14:26:57 2017 +0000
Revision:
1:3deb71413561
Parent:
0:f269e3021894 
mbed_os

Who changed what in which revision?

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