mbed library sources for TON Board V1.2
Fork of mbed-dev by
drivers/Serial.h@168:1dc8c8bdd03d, 2017-06-29 (annotated)
- Committer:
- krebyy
- Date:
- Thu Jun 29 20:34:04 2017 +0000
- Revision:
- 168:1dc8c8bdd03d
- Parent:
- 167:e84263d55307
First commit - mbed for TON Board V1.2
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
<> | 149:156823d33999 | 1 | /* mbed Microcontroller Library |
<> | 149:156823d33999 | 2 | * Copyright (c) 2006-2013 ARM Limited |
<> | 149:156823d33999 | 3 | * |
<> | 149:156823d33999 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
<> | 149:156823d33999 | 5 | * you may not use this file except in compliance with the License. |
<> | 149:156823d33999 | 6 | * You may obtain a copy of the License at |
<> | 149:156823d33999 | 7 | * |
<> | 149:156823d33999 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
<> | 149:156823d33999 | 9 | * |
<> | 149:156823d33999 | 10 | * Unless required by applicable law or agreed to in writing, software |
<> | 149:156823d33999 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
<> | 149:156823d33999 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
<> | 149:156823d33999 | 13 | * See the License for the specific language governing permissions and |
<> | 149:156823d33999 | 14 | * limitations under the License. |
<> | 149:156823d33999 | 15 | */ |
<> | 149:156823d33999 | 16 | #ifndef MBED_SERIAL_H |
<> | 149:156823d33999 | 17 | #define MBED_SERIAL_H |
<> | 149:156823d33999 | 18 | |
<> | 149:156823d33999 | 19 | #include "platform/platform.h" |
<> | 149:156823d33999 | 20 | |
AnnaBridge | 167:e84263d55307 | 21 | #if defined (DEVICE_SERIAL) || defined(DOXYGEN_ONLY) |
<> | 149:156823d33999 | 22 | |
<> | 149:156823d33999 | 23 | #include "Stream.h" |
<> | 149:156823d33999 | 24 | #include "SerialBase.h" |
<> | 149:156823d33999 | 25 | #include "PlatformMutex.h" |
<> | 149:156823d33999 | 26 | #include "serial_api.h" |
<> | 149:156823d33999 | 27 | |
<> | 149:156823d33999 | 28 | namespace mbed { |
<> | 149:156823d33999 | 29 | /** \addtogroup drivers */ |
<> | 149:156823d33999 | 30 | |
<> | 149:156823d33999 | 31 | /** A serial port (UART) for communication with other serial devices |
<> | 149:156823d33999 | 32 | * |
<> | 149:156823d33999 | 33 | * Can be used for Full Duplex communication, or Simplex by specifying |
<> | 149:156823d33999 | 34 | * one pin as NC (Not Connected) |
<> | 149:156823d33999 | 35 | * |
AnnaBridge | 167:e84263d55307 | 36 | * @note Synchronization level: Thread safe |
<> | 149:156823d33999 | 37 | * |
<> | 149:156823d33999 | 38 | * Example: |
<> | 149:156823d33999 | 39 | * @code |
<> | 149:156823d33999 | 40 | * // Print "Hello World" to the PC |
<> | 149:156823d33999 | 41 | * |
<> | 149:156823d33999 | 42 | * #include "mbed.h" |
<> | 149:156823d33999 | 43 | * |
<> | 149:156823d33999 | 44 | * Serial pc(USBTX, USBRX); |
<> | 149:156823d33999 | 45 | * |
<> | 149:156823d33999 | 46 | * int main() { |
<> | 149:156823d33999 | 47 | * pc.printf("Hello World\n"); |
<> | 149:156823d33999 | 48 | * } |
<> | 149:156823d33999 | 49 | * @endcode |
AnnaBridge | 167:e84263d55307 | 50 | * @ingroup drivers |
<> | 149:156823d33999 | 51 | */ |
<> | 149:156823d33999 | 52 | class Serial : public SerialBase, public Stream { |
<> | 149:156823d33999 | 53 | |
<> | 149:156823d33999 | 54 | public: |
<> | 149:156823d33999 | 55 | #if DEVICE_SERIAL_ASYNCH |
<> | 149:156823d33999 | 56 | using SerialBase::read; |
<> | 149:156823d33999 | 57 | using SerialBase::write; |
<> | 149:156823d33999 | 58 | #endif |
<> | 149:156823d33999 | 59 | |
<> | 149:156823d33999 | 60 | /** Create a Serial port, connected to the specified transmit and receive pins |
<> | 149:156823d33999 | 61 | * |
<> | 149:156823d33999 | 62 | * @param tx Transmit pin |
<> | 149:156823d33999 | 63 | * @param rx Receive pin |
<> | 149:156823d33999 | 64 | * @param name The name of the stream associated with this serial port (optional) |
<> | 149:156823d33999 | 65 | * @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE) |
<> | 149:156823d33999 | 66 | * |
<> | 149:156823d33999 | 67 | * @note |
<> | 149:156823d33999 | 68 | * Either tx or rx may be specified as NC if unused |
<> | 149:156823d33999 | 69 | */ |
<> | 149:156823d33999 | 70 | Serial(PinName tx, PinName rx, const char *name=NULL, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE); |
<> | 149:156823d33999 | 71 | |
<> | 149:156823d33999 | 72 | |
<> | 149:156823d33999 | 73 | /** Create a Serial port, connected to the specified transmit and receive pins, with the specified baud |
<> | 149:156823d33999 | 74 | * |
<> | 149:156823d33999 | 75 | * @param tx Transmit pin |
<> | 149:156823d33999 | 76 | * @param rx Receive pin |
<> | 149:156823d33999 | 77 | * @param baud The baud rate of the serial port |
<> | 149:156823d33999 | 78 | * |
<> | 149:156823d33999 | 79 | * @note |
<> | 149:156823d33999 | 80 | * Either tx or rx may be specified as NC if unused |
<> | 149:156823d33999 | 81 | */ |
<> | 149:156823d33999 | 82 | Serial(PinName tx, PinName rx, int baud); |
<> | 149:156823d33999 | 83 | |
AnnaBridge | 167:e84263d55307 | 84 | /* Stream gives us a FileHandle with non-functional poll()/readable()/writable. Pass through |
AnnaBridge | 167:e84263d55307 | 85 | * the calls from the SerialBase instead for backwards compatibility. This problem is |
AnnaBridge | 167:e84263d55307 | 86 | * part of why Stream and Serial should be deprecated. |
AnnaBridge | 167:e84263d55307 | 87 | */ |
AnnaBridge | 167:e84263d55307 | 88 | bool readable() |
AnnaBridge | 167:e84263d55307 | 89 | { |
AnnaBridge | 167:e84263d55307 | 90 | return SerialBase::readable(); |
AnnaBridge | 167:e84263d55307 | 91 | } |
AnnaBridge | 167:e84263d55307 | 92 | bool writable() |
AnnaBridge | 167:e84263d55307 | 93 | { |
AnnaBridge | 167:e84263d55307 | 94 | return SerialBase::writeable(); |
AnnaBridge | 167:e84263d55307 | 95 | } |
AnnaBridge | 167:e84263d55307 | 96 | bool writeable() |
AnnaBridge | 167:e84263d55307 | 97 | { |
AnnaBridge | 167:e84263d55307 | 98 | return SerialBase::writeable(); |
AnnaBridge | 167:e84263d55307 | 99 | } |
AnnaBridge | 167:e84263d55307 | 100 | |
<> | 149:156823d33999 | 101 | protected: |
<> | 149:156823d33999 | 102 | virtual int _getc(); |
<> | 149:156823d33999 | 103 | virtual int _putc(int c); |
<> | 149:156823d33999 | 104 | virtual void lock(); |
<> | 149:156823d33999 | 105 | virtual void unlock(); |
<> | 149:156823d33999 | 106 | |
<> | 149:156823d33999 | 107 | PlatformMutex _mutex; |
<> | 149:156823d33999 | 108 | }; |
<> | 149:156823d33999 | 109 | |
<> | 149:156823d33999 | 110 | } // namespace mbed |
<> | 149:156823d33999 | 111 | |
<> | 149:156823d33999 | 112 | #endif |
<> | 149:156823d33999 | 113 | |
<> | 149:156823d33999 | 114 | #endif |