Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

hal/api/Serial.h@0:6c56fb4bc5f0, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:27:58 2016 +0000
Revision:
0:6c56fb4bc5f0
Moving to library for sharing updates

Who changed what in which revision?

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