test test test

Dependencies:   mbed

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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