Aravind Vadali / mbed-src-AV

mbed.h library with any bug fixes AV finds.

Dependents:   micromouse4_encoder_testing PID_Test Lab1_Test WorkingPID ... more

api/RawSerial.h@0:ba7650f404af, 2015-11-02 (annotated)

Committer:
aravindsv
Date:
Mon Nov 02 02:26:59 2015 +0000
Revision:
0:ba7650f404af
Reduced HSE_STARTUP_TIMEOUT to 500 ms, fixed some compiler warnings

Who changed what in which revision?

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