takashi kadono / Mbed OS Nucleo_446

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/drivers/Serial.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

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