Magnificent7 / Hackathon

Includes library modifications to allow access to AIN_4 (AIN_0 / 5)

mbd_os/hal/api/Serial.h@0:eafc3fd41f75, 2016-09-20 (annotated)

Committer:
bryantaylor
Date:
Tue Sep 20 21:26:12 2016 +0000
Revision:
0:eafc3fd41f75
hackathon

Who changed what in which revision?

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