Andrew SaLoutos / mbed-dev-STM-lean

From Ben Katz mbed-dev library. Removed unnecessary target files to reduce the overall size by a factor of 10 to make it easier to import into the online IDE.

Dependents:   motor_driver motor_driver_screaming_fix

drivers/UARTSerial.h@0:083111ae2a11, 2020-11-26 (annotated)

Committer:
saloutos
Date:
Thu Nov 26 04:08:56 2020 +0000
Revision:
0:083111ae2a11
first commit of leaned mbed dev lib

Who changed what in which revision?

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