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/Serial.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_SERIAL_H
aravindsv 0:ba7650f404af 17 #define MBED_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 "Stream.h"
aravindsv 0:ba7650f404af 24 #include "SerialBase.h"
aravindsv 0:ba7650f404af 25 #include "serial_api.h"
aravindsv 0:ba7650f404af 26
aravindsv 0:ba7650f404af 27 namespace mbed {
aravindsv 0:ba7650f404af 28
aravindsv 0:ba7650f404af 29 /** A serial port (UART) for communication with other serial devices
aravindsv 0:ba7650f404af 30 *
aravindsv 0:ba7650f404af 31 * Can be used for Full Duplex communication, or Simplex by specifying
aravindsv 0:ba7650f404af 32 * one pin as NC (Not Connected)
aravindsv 0:ba7650f404af 33 *
aravindsv 0:ba7650f404af 34 * Example:
aravindsv 0:ba7650f404af 35 * @code
aravindsv 0:ba7650f404af 36 * // Print "Hello World" to the PC
aravindsv 0:ba7650f404af 37 *
aravindsv 0:ba7650f404af 38 * #include "mbed.h"
aravindsv 0:ba7650f404af 39 *
aravindsv 0:ba7650f404af 40 * Serial pc(USBTX, USBRX);
aravindsv 0:ba7650f404af 41 *
aravindsv 0:ba7650f404af 42 * int main() {
aravindsv 0:ba7650f404af 43 * pc.printf("Hello World\n");
aravindsv 0:ba7650f404af 44 * }
aravindsv 0:ba7650f404af 45 * @endcode
aravindsv 0:ba7650f404af 46 */
aravindsv 0:ba7650f404af 47 class Serial : public SerialBase, public Stream {
aravindsv 0:ba7650f404af 48
aravindsv 0:ba7650f404af 49 public:
aravindsv 0:ba7650f404af 50 #if DEVICE_SERIAL_ASYNCH
aravindsv 0:ba7650f404af 51 using SerialBase::read;
aravindsv 0:ba7650f404af 52 using SerialBase::write;
aravindsv 0:ba7650f404af 53 #endif
aravindsv 0:ba7650f404af 54
aravindsv 0:ba7650f404af 55 /** Create a Serial port, connected to the specified transmit and receive pins
aravindsv 0:ba7650f404af 56 *
aravindsv 0:ba7650f404af 57 * @param tx Transmit pin
aravindsv 0:ba7650f404af 58 * @param rx Receive pin
aravindsv 0:ba7650f404af 59 *
aravindsv 0:ba7650f404af 60 * @note
aravindsv 0:ba7650f404af 61 * Either tx or rx may be specified as NC if unused
aravindsv 0:ba7650f404af 62 */
aravindsv 0:ba7650f404af 63 Serial(PinName tx, PinName rx, const char *name=NULL);
aravindsv 0:ba7650f404af 64
aravindsv 0:ba7650f404af 65 protected:
aravindsv 0:ba7650f404af 66 virtual int _getc();
aravindsv 0:ba7650f404af 67 virtual int _putc(int c);
aravindsv 0:ba7650f404af 68 };
aravindsv 0:ba7650f404af 69
aravindsv 0:ba7650f404af 70 } // namespace mbed
aravindsv 0:ba7650f404af 71
aravindsv 0:ba7650f404af 72 #endif
aravindsv 0:ba7650f404af 73
aravindsv 0:ba7650f404af 74 #endif