Knight KE / Mbed OS Game_Master

游戏王对战板，目前code还是空的

mbed-os/drivers/UARTSerial.h@0:9b3d4731edbb, 2018-06-21 (annotated)

Committer:
WFKnight
Date:
Thu Jun 21 13:51:43 2018 +0000
Revision:
0:9b3d4731edbb
UART, RTOS, LED

Who changed what in which revision?

UserRevisionLine numberNew contents of line
WFKnight 0:9b3d4731edbb 1 /* mbed Microcontroller Library
WFKnight 0:9b3d4731edbb 2 * Copyright (c) 2006-2017 ARM Limited
WFKnight 0:9b3d4731edbb 3 *
WFKnight 0:9b3d4731edbb 4 * Licensed under the Apache License, Version 2.0 (the "License");
WFKnight 0:9b3d4731edbb 5 * you may not use this file except in compliance with the License.
WFKnight 0:9b3d4731edbb 6 * You may obtain a copy of the License at
WFKnight 0:9b3d4731edbb 7 *
WFKnight 0:9b3d4731edbb 8 * http://www.apache.org/licenses/LICENSE-2.0
WFKnight 0:9b3d4731edbb 9 *
WFKnight 0:9b3d4731edbb 10 * Unless required by applicable law or agreed to in writing, software
WFKnight 0:9b3d4731edbb 11 * distributed under the License is distributed on an "AS IS" BASIS,
WFKnight 0:9b3d4731edbb 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
WFKnight 0:9b3d4731edbb 13 * See the License for the specific language governing permissions and
WFKnight 0:9b3d4731edbb 14 * limitations under the License.
WFKnight 0:9b3d4731edbb 15 */
WFKnight 0:9b3d4731edbb 16
WFKnight 0:9b3d4731edbb 17 #ifndef MBED_UARTSERIAL_H
WFKnight 0:9b3d4731edbb 18 #define MBED_UARTSERIAL_H
WFKnight 0:9b3d4731edbb 19
WFKnight 0:9b3d4731edbb 20 #include "platform/platform.h"
WFKnight 0:9b3d4731edbb 21
WFKnight 0:9b3d4731edbb 22 #if (DEVICE_SERIAL && DEVICE_INTERRUPTIN) || defined(DOXYGEN_ONLY)
WFKnight 0:9b3d4731edbb 23
WFKnight 0:9b3d4731edbb 24 #include "FileHandle.h"
WFKnight 0:9b3d4731edbb 25 #include "SerialBase.h"
WFKnight 0:9b3d4731edbb 26 #include "InterruptIn.h"
WFKnight 0:9b3d4731edbb 27 #include "PlatformMutex.h"
WFKnight 0:9b3d4731edbb 28 #include "serial_api.h"
WFKnight 0:9b3d4731edbb 29 #include "CircularBuffer.h"
WFKnight 0:9b3d4731edbb 30 #include "platform/NonCopyable.h"
WFKnight 0:9b3d4731edbb 31
WFKnight 0:9b3d4731edbb 32 #ifndef MBED_CONF_DRIVERS_UART_SERIAL_RXBUF_SIZE
WFKnight 0:9b3d4731edbb 33 #define MBED_CONF_DRIVERS_UART_SERIAL_RXBUF_SIZE 256
WFKnight 0:9b3d4731edbb 34 #endif
WFKnight 0:9b3d4731edbb 35
WFKnight 0:9b3d4731edbb 36 #ifndef MBED_CONF_DRIVERS_UART_SERIAL_TXBUF_SIZE
WFKnight 0:9b3d4731edbb 37 #define MBED_CONF_DRIVERS_UART_SERIAL_TXBUF_SIZE 256
WFKnight 0:9b3d4731edbb 38 #endif
WFKnight 0:9b3d4731edbb 39
WFKnight 0:9b3d4731edbb 40 namespace mbed {
WFKnight 0:9b3d4731edbb 41
WFKnight 0:9b3d4731edbb 42 /** \addtogroup drivers */
WFKnight 0:9b3d4731edbb 43
WFKnight 0:9b3d4731edbb 44 /** Class providing buffered UART communication functionality using separate circular buffer for send and receive channels
WFKnight 0:9b3d4731edbb 45 *
WFKnight 0:9b3d4731edbb 46 * @ingroup drivers
WFKnight 0:9b3d4731edbb 47 */
WFKnight 0:9b3d4731edbb 48
WFKnight 0:9b3d4731edbb 49 class UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UARTSerial> {
WFKnight 0:9b3d4731edbb 50
WFKnight 0:9b3d4731edbb 51 public:
WFKnight 0:9b3d4731edbb 52
WFKnight 0:9b3d4731edbb 53 /** Create a UARTSerial port, connected to the specified transmit and receive pins, with a particular baud rate.
WFKnight 0:9b3d4731edbb 54 * @param tx Transmit pin
WFKnight 0:9b3d4731edbb 55 * @param rx Receive pin
WFKnight 0:9b3d4731edbb 56 * @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE)
WFKnight 0:9b3d4731edbb 57 */
WFKnight 0:9b3d4731edbb 58 UARTSerial(PinName tx, PinName rx, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
WFKnight 0:9b3d4731edbb 59 virtual ~UARTSerial();
WFKnight 0:9b3d4731edbb 60
WFKnight 0:9b3d4731edbb 61 /** Equivalent to POSIX poll(). Derived from FileHandle.
WFKnight 0:9b3d4731edbb 62 * Provides a mechanism to multiplex input/output over a set of file handles.
WFKnight 0:9b3d4731edbb 63 */
WFKnight 0:9b3d4731edbb 64 virtual short poll(short events) const;
WFKnight 0:9b3d4731edbb 65
WFKnight 0:9b3d4731edbb 66 /* Resolve ambiguities versus our private SerialBase
WFKnight 0:9b3d4731edbb 67 * (for writable, spelling differs, but just in case)
WFKnight 0:9b3d4731edbb 68 */
WFKnight 0:9b3d4731edbb 69 using FileHandle::readable;
WFKnight 0:9b3d4731edbb 70 using FileHandle::writable;
WFKnight 0:9b3d4731edbb 71
WFKnight 0:9b3d4731edbb 72 /** Write the contents of a buffer to a file
WFKnight 0:9b3d4731edbb 73 *
WFKnight 0:9b3d4731edbb 74 * Follows POSIX semantics:
WFKnight 0:9b3d4731edbb 75 *
WFKnight 0:9b3d4731edbb 76 * * if blocking, block until all data is written
WFKnight 0:9b3d4731edbb 77 * * if no data can be written, and non-blocking set, return -EAGAIN
WFKnight 0:9b3d4731edbb 78 * * if some data can be written, and non-blocking set, write partial
WFKnight 0:9b3d4731edbb 79 *
WFKnight 0:9b3d4731edbb 80 * @param buffer The buffer to write from
WFKnight 0:9b3d4731edbb 81 * @param length The number of bytes to write
WFKnight 0:9b3d4731edbb 82 * @return The number of bytes written, negative error on failure
WFKnight 0:9b3d4731edbb 83 */
WFKnight 0:9b3d4731edbb 84 virtual ssize_t write(const void* buffer, size_t length);
WFKnight 0:9b3d4731edbb 85
WFKnight 0:9b3d4731edbb 86 /** Read the contents of a file into a buffer
WFKnight 0:9b3d4731edbb 87 *
WFKnight 0:9b3d4731edbb 88 * Follows POSIX semantics:
WFKnight 0:9b3d4731edbb 89 *
WFKnight 0:9b3d4731edbb 90 * * if no data is available, and non-blocking set return -EAGAIN
WFKnight 0:9b3d4731edbb 91 * * if no data is available, and blocking set, wait until data is available
WFKnight 0:9b3d4731edbb 92 * * If any data is available, call returns immediately
WFKnight 0:9b3d4731edbb 93 *
WFKnight 0:9b3d4731edbb 94 * @param buffer The buffer to read in to
WFKnight 0:9b3d4731edbb 95 * @param length The number of bytes to read
WFKnight 0:9b3d4731edbb 96 * @return The number of bytes read, 0 at end of file, negative error on failure
WFKnight 0:9b3d4731edbb 97 */
WFKnight 0:9b3d4731edbb 98 virtual ssize_t read(void* buffer, size_t length);
WFKnight 0:9b3d4731edbb 99
WFKnight 0:9b3d4731edbb 100 /** Close a file
WFKnight 0:9b3d4731edbb 101 *
WFKnight 0:9b3d4731edbb 102 * @return 0 on success, negative error code on failure
WFKnight 0:9b3d4731edbb 103 */
WFKnight 0:9b3d4731edbb 104 virtual int close();
WFKnight 0:9b3d4731edbb 105
WFKnight 0:9b3d4731edbb 106 /** Check if the file in an interactive terminal device
WFKnight 0:9b3d4731edbb 107 *
WFKnight 0:9b3d4731edbb 108 * @return True if the file is a terminal
WFKnight 0:9b3d4731edbb 109 * @return False if the file is not a terminal
WFKnight 0:9b3d4731edbb 110 * @return Negative error code on failure
WFKnight 0:9b3d4731edbb 111 */
WFKnight 0:9b3d4731edbb 112 virtual int isatty();
WFKnight 0:9b3d4731edbb 113
WFKnight 0:9b3d4731edbb 114 /** Move the file position to a given offset from from a given location
WFKnight 0:9b3d4731edbb 115 *
WFKnight 0:9b3d4731edbb 116 * Not valid for a device type FileHandle like UARTSerial.
WFKnight 0:9b3d4731edbb 117 * In case of UARTSerial, returns ESPIPE
WFKnight 0:9b3d4731edbb 118 *
WFKnight 0:9b3d4731edbb 119 * @param offset The offset from whence to move to
WFKnight 0:9b3d4731edbb 120 * @param whence The start of where to seek
WFKnight 0:9b3d4731edbb 121 * SEEK_SET to start from beginning of file,
WFKnight 0:9b3d4731edbb 122 * SEEK_CUR to start from current position in file,
WFKnight 0:9b3d4731edbb 123 * SEEK_END to start from end of file
WFKnight 0:9b3d4731edbb 124 * @return The new offset of the file, negative error code on failure
WFKnight 0:9b3d4731edbb 125 */
WFKnight 0:9b3d4731edbb 126 virtual off_t seek(off_t offset, int whence);
WFKnight 0:9b3d4731edbb 127
WFKnight 0:9b3d4731edbb 128 /** Flush any buffers associated with the file
WFKnight 0:9b3d4731edbb 129 *
WFKnight 0:9b3d4731edbb 130 * @return 0 on success, negative error code on failure
WFKnight 0:9b3d4731edbb 131 */
WFKnight 0:9b3d4731edbb 132 virtual int sync();
WFKnight 0:9b3d4731edbb 133
WFKnight 0:9b3d4731edbb 134 /** Set blocking or non-blocking mode
WFKnight 0:9b3d4731edbb 135 * The default is blocking.
WFKnight 0:9b3d4731edbb 136 *
WFKnight 0:9b3d4731edbb 137 * @param blocking true for blocking mode, false for non-blocking mode.
WFKnight 0:9b3d4731edbb 138 */
WFKnight 0:9b3d4731edbb 139 virtual int set_blocking(bool blocking)
WFKnight 0:9b3d4731edbb 140 {
WFKnight 0:9b3d4731edbb 141 _blocking = blocking;
WFKnight 0:9b3d4731edbb 142 return 0;
WFKnight 0:9b3d4731edbb 143 }
WFKnight 0:9b3d4731edbb 144
WFKnight 0:9b3d4731edbb 145 /** Check current blocking or non-blocking mode for file operations.
WFKnight 0:9b3d4731edbb 146 *
WFKnight 0:9b3d4731edbb 147 * @return true for blocking mode, false for non-blocking mode.
WFKnight 0:9b3d4731edbb 148 */
WFKnight 0:9b3d4731edbb 149 virtual bool is_blocking() const
WFKnight 0:9b3d4731edbb 150 {
WFKnight 0:9b3d4731edbb 151 return _blocking;
WFKnight 0:9b3d4731edbb 152 }
WFKnight 0:9b3d4731edbb 153
WFKnight 0:9b3d4731edbb 154 /** Register a callback on state change of the file.
WFKnight 0:9b3d4731edbb 155 *
WFKnight 0:9b3d4731edbb 156 * The specified callback will be called on state changes such as when
WFKnight 0:9b3d4731edbb 157 * the file can be written to or read from.
WFKnight 0:9b3d4731edbb 158 *
WFKnight 0:9b3d4731edbb 159 * The callback may be called in an interrupt context and should not
WFKnight 0:9b3d4731edbb 160 * perform expensive operations.
WFKnight 0:9b3d4731edbb 161 *
WFKnight 0:9b3d4731edbb 162 * Note! This is not intended as an attach-like asynchronous api, but rather
WFKnight 0:9b3d4731edbb 163 * as a building block for constructing such functionality.
WFKnight 0:9b3d4731edbb 164 *
WFKnight 0:9b3d4731edbb 165 * The exact timing of when the registered function
WFKnight 0:9b3d4731edbb 166 * is called is not guaranteed and susceptible to change. It should be used
WFKnight 0:9b3d4731edbb 167 * as a cue to make read/write/poll calls to find the current state.
WFKnight 0:9b3d4731edbb 168 *
WFKnight 0:9b3d4731edbb 169 * @param func Function to call on state change
WFKnight 0:9b3d4731edbb 170 */
WFKnight 0:9b3d4731edbb 171 virtual void sigio(Callback<void()> func);
WFKnight 0:9b3d4731edbb 172
WFKnight 0:9b3d4731edbb 173 /** Setup interrupt handler for DCD line
WFKnight 0:9b3d4731edbb 174 *
WFKnight 0:9b3d4731edbb 175 * If DCD line is connected, an IRQ handler will be setup.
WFKnight 0:9b3d4731edbb 176 * Does nothing if DCD is NC, i.e., not connected.
WFKnight 0:9b3d4731edbb 177 *
WFKnight 0:9b3d4731edbb 178 * @param dcd_pin Pin-name for DCD
WFKnight 0:9b3d4731edbb 179 * @param active_high a boolean set to true if DCD polarity is active low
WFKnight 0:9b3d4731edbb 180 */
WFKnight 0:9b3d4731edbb 181 void set_data_carrier_detect(PinName dcd_pin, bool active_high = false);
WFKnight 0:9b3d4731edbb 182
WFKnight 0:9b3d4731edbb 183 /** Set the baud rate
WFKnight 0:9b3d4731edbb 184 *
WFKnight 0:9b3d4731edbb 185 * @param baud The baud rate
WFKnight 0:9b3d4731edbb 186 */
WFKnight 0:9b3d4731edbb 187 void set_baud(int baud);
WFKnight 0:9b3d4731edbb 188
WFKnight 0:9b3d4731edbb 189 // Expose private SerialBase::Parity as UARTSerial::Parity
WFKnight 0:9b3d4731edbb 190 using SerialBase::Parity;
WFKnight 0:9b3d4731edbb 191 // In C++11, we wouldn't need to also have using directives for each value
WFKnight 0:9b3d4731edbb 192 using SerialBase::None;
WFKnight 0:9b3d4731edbb 193 using SerialBase::Odd;
WFKnight 0:9b3d4731edbb 194 using SerialBase::Even;
WFKnight 0:9b3d4731edbb 195 using SerialBase::Forced1;
WFKnight 0:9b3d4731edbb 196 using SerialBase::Forced0;
WFKnight 0:9b3d4731edbb 197
WFKnight 0:9b3d4731edbb 198 /** Set the transmission format used by the serial port
WFKnight 0:9b3d4731edbb 199 *
WFKnight 0:9b3d4731edbb 200 * @param bits The number of bits in a word (5-8; default = 8)
WFKnight 0:9b3d4731edbb 201 * @param parity The parity used (None, Odd, Even, Forced1, Forced0; default = None)
WFKnight 0:9b3d4731edbb 202 * @param stop_bits The number of stop bits (1 or 2; default = 1)
WFKnight 0:9b3d4731edbb 203 */
WFKnight 0:9b3d4731edbb 204 void set_format(int bits=8, Parity parity=UARTSerial::None, int stop_bits=1);
WFKnight 0:9b3d4731edbb 205
WFKnight 0:9b3d4731edbb 206 #if DEVICE_SERIAL_FC
WFKnight 0:9b3d4731edbb 207 // For now use the base enum - but in future we may have extra options
WFKnight 0:9b3d4731edbb 208 // such as XON/XOFF or manual GPIO RTSCTS.
WFKnight 0:9b3d4731edbb 209 using SerialBase::Flow;
WFKnight 0:9b3d4731edbb 210 // In C++11, we wouldn't need to also have using directives for each value
WFKnight 0:9b3d4731edbb 211 using SerialBase::Disabled;
WFKnight 0:9b3d4731edbb 212 using SerialBase::RTS;
WFKnight 0:9b3d4731edbb 213 using SerialBase::CTS;
WFKnight 0:9b3d4731edbb 214 using SerialBase::RTSCTS;
WFKnight 0:9b3d4731edbb 215
WFKnight 0:9b3d4731edbb 216 /** Set the flow control type on the serial port
WFKnight 0:9b3d4731edbb 217 *
WFKnight 0:9b3d4731edbb 218 * @param type the flow control type (Disabled, RTS, CTS, RTSCTS)
WFKnight 0:9b3d4731edbb 219 * @param flow1 the first flow control pin (RTS for RTS or RTSCTS, CTS for CTS)
WFKnight 0:9b3d4731edbb 220 * @param flow2 the second flow control pin (CTS for RTSCTS)
WFKnight 0:9b3d4731edbb 221 */
WFKnight 0:9b3d4731edbb 222 void set_flow_control(Flow type, PinName flow1=NC, PinName flow2=NC);
WFKnight 0:9b3d4731edbb 223 #endif
WFKnight 0:9b3d4731edbb 224
WFKnight 0:9b3d4731edbb 225 private:
WFKnight 0:9b3d4731edbb 226
WFKnight 0:9b3d4731edbb 227 void wait_ms(uint32_t millisec);
WFKnight 0:9b3d4731edbb 228
WFKnight 0:9b3d4731edbb 229 /** SerialBase lock override */
WFKnight 0:9b3d4731edbb 230 virtual void lock(void);
WFKnight 0:9b3d4731edbb 231
WFKnight 0:9b3d4731edbb 232 /** SerialBase unlock override */
WFKnight 0:9b3d4731edbb 233 virtual void unlock(void);
WFKnight 0:9b3d4731edbb 234
WFKnight 0:9b3d4731edbb 235 /** Acquire mutex */
WFKnight 0:9b3d4731edbb 236 virtual void api_lock(void);
WFKnight 0:9b3d4731edbb 237
WFKnight 0:9b3d4731edbb 238 /** Release mutex */
WFKnight 0:9b3d4731edbb 239 virtual void api_unlock(void);
WFKnight 0:9b3d4731edbb 240
WFKnight 0:9b3d4731edbb 241 /** Software serial buffers
WFKnight 0:9b3d4731edbb 242 * By default buffer size is 256 for TX and 256 for RX. Configurable through mbed_app.json
WFKnight 0:9b3d4731edbb 243 */
WFKnight 0:9b3d4731edbb 244 CircularBuffer<char, MBED_CONF_DRIVERS_UART_SERIAL_RXBUF_SIZE> _rxbuf;
WFKnight 0:9b3d4731edbb 245 CircularBuffer<char, MBED_CONF_DRIVERS_UART_SERIAL_TXBUF_SIZE> _txbuf;
WFKnight 0:9b3d4731edbb 246
WFKnight 0:9b3d4731edbb 247 PlatformMutex _mutex;
WFKnight 0:9b3d4731edbb 248
WFKnight 0:9b3d4731edbb 249 Callback<void()> _sigio_cb;
WFKnight 0:9b3d4731edbb 250
WFKnight 0:9b3d4731edbb 251 bool _blocking;
WFKnight 0:9b3d4731edbb 252 bool _tx_irq_enabled;
WFKnight 0:9b3d4731edbb 253 bool _rx_irq_enabled;
WFKnight 0:9b3d4731edbb 254 InterruptIn *_dcd_irq;
WFKnight 0:9b3d4731edbb 255
WFKnight 0:9b3d4731edbb 256 /** Device Hanged up
WFKnight 0:9b3d4731edbb 257 * Determines if the device hanged up on us.
WFKnight 0:9b3d4731edbb 258 *
WFKnight 0:9b3d4731edbb 259 * @return True, if hanged up
WFKnight 0:9b3d4731edbb 260 */
WFKnight 0:9b3d4731edbb 261 bool hup() const;
WFKnight 0:9b3d4731edbb 262
WFKnight 0:9b3d4731edbb 263 /** ISRs for serial
WFKnight 0:9b3d4731edbb 264 * Routines to handle interrupts on serial pins.
WFKnight 0:9b3d4731edbb 265 * Copies data into Circular Buffer.
WFKnight 0:9b3d4731edbb 266 * Reports the state change to File handle.
WFKnight 0:9b3d4731edbb 267 */
WFKnight 0:9b3d4731edbb 268 void tx_irq(void);
WFKnight 0:9b3d4731edbb 269 void rx_irq(void);
WFKnight 0:9b3d4731edbb 270
WFKnight 0:9b3d4731edbb 271 void wake(void);
WFKnight 0:9b3d4731edbb 272
WFKnight 0:9b3d4731edbb 273 void dcd_irq(void);
WFKnight 0:9b3d4731edbb 274
WFKnight 0:9b3d4731edbb 275 };
WFKnight 0:9b3d4731edbb 276 } //namespace mbed
WFKnight 0:9b3d4731edbb 277
WFKnight 0:9b3d4731edbb 278 #endif //(DEVICE_SERIAL && DEVICE_INTERRUPTIN) || defined(DOXYGEN_ONLY)
WFKnight 0:9b3d4731edbb 279 #endif //MBED_UARTSERIAL_H