Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

Serial.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mturner5 0:b7116bd48af6 1 /* mbed Microcontroller Library
mturner5 0:b7116bd48af6 2 * Copyright (c) 2006-2013 ARM Limited
mturner5 0:b7116bd48af6 3 *
mturner5 0:b7116bd48af6 4 * Licensed under the Apache License, Version 2.0 (the "License");
mturner5 0:b7116bd48af6 5 * you may not use this file except in compliance with the License.
mturner5 0:b7116bd48af6 6 * You may obtain a copy of the License at
mturner5 0:b7116bd48af6 7 *
mturner5 0:b7116bd48af6 8 * http://www.apache.org/licenses/LICENSE-2.0
mturner5 0:b7116bd48af6 9 *
mturner5 0:b7116bd48af6 10 * Unless required by applicable law or agreed to in writing, software
mturner5 0:b7116bd48af6 11 * distributed under the License is distributed on an "AS IS" BASIS,
mturner5 0:b7116bd48af6 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mturner5 0:b7116bd48af6 13 * See the License for the specific language governing permissions and
mturner5 0:b7116bd48af6 14 * limitations under the License.
mturner5 0:b7116bd48af6 15 */
mturner5 0:b7116bd48af6 16 #ifndef MBED_SERIAL_H
mturner5 0:b7116bd48af6 17 #define MBED_SERIAL_H
mturner5 0:b7116bd48af6 18
mturner5 0:b7116bd48af6 19 #include "platform.h"
mturner5 0:b7116bd48af6 20
mturner5 0:b7116bd48af6 21 #if DEVICE_SERIAL
mturner5 0:b7116bd48af6 22
mturner5 0:b7116bd48af6 23 #include "Stream.h"
mturner5 0:b7116bd48af6 24 #include "SerialBase.h"
mturner5 0:b7116bd48af6 25 #include "PlatformMutex.h"
mturner5 0:b7116bd48af6 26 #include "serial_api.h"
mturner5 0:b7116bd48af6 27
mturner5 0:b7116bd48af6 28 namespace mbed {
mturner5 0:b7116bd48af6 29
mturner5 0:b7116bd48af6 30 /** A serial port (UART) for communication with other serial devices
mturner5 0:b7116bd48af6 31 *
mturner5 0:b7116bd48af6 32 * Can be used for Full Duplex communication, or Simplex by specifying
mturner5 0:b7116bd48af6 33 * one pin as NC (Not Connected)
mturner5 0:b7116bd48af6 34 *
mturner5 0:b7116bd48af6 35 * @Note Synchronization level: Thread safe
mturner5 0:b7116bd48af6 36 *
mturner5 0:b7116bd48af6 37 * Example:
mturner5 0:b7116bd48af6 38 * @code
mturner5 0:b7116bd48af6 39 * // Print "Hello World" to the PC
mturner5 0:b7116bd48af6 40 *
mturner5 0:b7116bd48af6 41 * #include "mbed.h"
mturner5 0:b7116bd48af6 42 *
mturner5 0:b7116bd48af6 43 * Serial pc(USBTX, USBRX);
mturner5 0:b7116bd48af6 44 *
mturner5 0:b7116bd48af6 45 * int main() {
mturner5 0:b7116bd48af6 46 * pc.printf("Hello World\n");
mturner5 0:b7116bd48af6 47 * }
mturner5 0:b7116bd48af6 48 * @endcode
mturner5 0:b7116bd48af6 49 */
mturner5 0:b7116bd48af6 50 class Serial : public SerialBase, public Stream {
mturner5 0:b7116bd48af6 51
mturner5 0:b7116bd48af6 52 public:
mturner5 0:b7116bd48af6 53 #if DEVICE_SERIAL_ASYNCH
mturner5 0:b7116bd48af6 54 using SerialBase::read;
mturner5 0:b7116bd48af6 55 using SerialBase::write;
mturner5 0:b7116bd48af6 56 #endif
mturner5 0:b7116bd48af6 57
mturner5 0:b7116bd48af6 58 /** Create a Serial port, connected to the specified transmit and receive pins
mturner5 0:b7116bd48af6 59 *
mturner5 0:b7116bd48af6 60 * @param tx Transmit pin
mturner5 0:b7116bd48af6 61 * @param rx Receive pin
mturner5 0:b7116bd48af6 62 *
mturner5 0:b7116bd48af6 63 * @note
mturner5 0:b7116bd48af6 64 * Either tx or rx may be specified as NC if unused
mturner5 0:b7116bd48af6 65 */
mturner5 0:b7116bd48af6 66 Serial(PinName tx, PinName rx, const char *name=NULL);
mturner5 0:b7116bd48af6 67
mturner5 0:b7116bd48af6 68 protected:
mturner5 0:b7116bd48af6 69 virtual int _getc();
mturner5 0:b7116bd48af6 70 virtual int _putc(int c);
mturner5 0:b7116bd48af6 71 virtual void lock();
mturner5 0:b7116bd48af6 72 virtual void unlock();
mturner5 0:b7116bd48af6 73
mturner5 0:b7116bd48af6 74 PlatformMutex _mutex;
mturner5 0:b7116bd48af6 75 };
mturner5 0:b7116bd48af6 76
mturner5 0:b7116bd48af6 77 } // namespace mbed
mturner5 0:b7116bd48af6 78
mturner5 0:b7116bd48af6 79 #endif
mturner5 0:b7116bd48af6 80
mturner5 0:b7116bd48af6 81 #endif