Steven Wray / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/RawSerial.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:
<>
Date:
Fri Sep 02 15:07:44 2016 +0100
Revision:
144:ef7eb2e8f9f7
Parent:
0:9b334a45a8ff 
This updates the lib to the mbed lib v125

Who changed what in which revision?

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