BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/drivers/UARTSerial.cpp@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
borlanic 0:02dd72d1d465 1 /* mbed Microcontroller Library
borlanic 0:02dd72d1d465 2 * Copyright (c) 2006-2017 ARM Limited
borlanic 0:02dd72d1d465 3 *
borlanic 0:02dd72d1d465 4 * Licensed under the Apache License, Version 2.0 (the "License");
borlanic 0:02dd72d1d465 5 * you may not use this file except in compliance with the License.
borlanic 0:02dd72d1d465 6 * You may obtain a copy of the License at
borlanic 0:02dd72d1d465 7 *
borlanic 0:02dd72d1d465 8 * http://www.apache.org/licenses/LICENSE-2.0
borlanic 0:02dd72d1d465 9 *
borlanic 0:02dd72d1d465 10 * Unless required by applicable law or agreed to in writing, software
borlanic 0:02dd72d1d465 11 * distributed under the License is distributed on an "AS IS" BASIS,
borlanic 0:02dd72d1d465 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
borlanic 0:02dd72d1d465 13 * See the License for the specific language governing permissions and
borlanic 0:02dd72d1d465 14 * limitations under the License.
borlanic 0:02dd72d1d465 15 */
borlanic 0:02dd72d1d465 16
borlanic 0:02dd72d1d465 17 #if (DEVICE_SERIAL && DEVICE_INTERRUPTIN)
borlanic 0:02dd72d1d465 18
borlanic 0:02dd72d1d465 19 #include <errno.h>
borlanic 0:02dd72d1d465 20 #include "UARTSerial.h"
borlanic 0:02dd72d1d465 21 #include "platform/mbed_poll.h"
borlanic 0:02dd72d1d465 22
borlanic 0:02dd72d1d465 23 #if MBED_CONF_RTOS_PRESENT
borlanic 0:02dd72d1d465 24 #include "rtos/Thread.h"
borlanic 0:02dd72d1d465 25 #else
borlanic 0:02dd72d1d465 26 #include "platform/mbed_wait_api.h"
borlanic 0:02dd72d1d465 27 #endif
borlanic 0:02dd72d1d465 28
borlanic 0:02dd72d1d465 29 namespace mbed {
borlanic 0:02dd72d1d465 30
borlanic 0:02dd72d1d465 31 UARTSerial::UARTSerial(PinName tx, PinName rx, int baud) :
borlanic 0:02dd72d1d465 32 SerialBase(tx, rx, baud),
borlanic 0:02dd72d1d465 33 _blocking(true),
borlanic 0:02dd72d1d465 34 _tx_irq_enabled(false),
borlanic 0:02dd72d1d465 35 _rx_irq_enabled(true),
borlanic 0:02dd72d1d465 36 _dcd_irq(NULL)
borlanic 0:02dd72d1d465 37 {
borlanic 0:02dd72d1d465 38 /* Attatch IRQ routines to the serial device. */
borlanic 0:02dd72d1d465 39 SerialBase::attach(callback(this, &UARTSerial::rx_irq), RxIrq);
borlanic 0:02dd72d1d465 40 }
borlanic 0:02dd72d1d465 41
borlanic 0:02dd72d1d465 42 UARTSerial::~UARTSerial()
borlanic 0:02dd72d1d465 43 {
borlanic 0:02dd72d1d465 44 delete _dcd_irq;
borlanic 0:02dd72d1d465 45 }
borlanic 0:02dd72d1d465 46
borlanic 0:02dd72d1d465 47 void UARTSerial::dcd_irq()
borlanic 0:02dd72d1d465 48 {
borlanic 0:02dd72d1d465 49 wake();
borlanic 0:02dd72d1d465 50 }
borlanic 0:02dd72d1d465 51
borlanic 0:02dd72d1d465 52 void UARTSerial::set_baud(int baud)
borlanic 0:02dd72d1d465 53 {
borlanic 0:02dd72d1d465 54 SerialBase::baud(baud);
borlanic 0:02dd72d1d465 55 }
borlanic 0:02dd72d1d465 56
borlanic 0:02dd72d1d465 57 void UARTSerial::set_data_carrier_detect(PinName dcd_pin, bool active_high)
borlanic 0:02dd72d1d465 58 {
borlanic 0:02dd72d1d465 59 delete _dcd_irq;
borlanic 0:02dd72d1d465 60 _dcd_irq = NULL;
borlanic 0:02dd72d1d465 61
borlanic 0:02dd72d1d465 62 if (dcd_pin != NC) {
borlanic 0:02dd72d1d465 63 _dcd_irq = new InterruptIn(dcd_pin);
borlanic 0:02dd72d1d465 64 if (active_high) {
borlanic 0:02dd72d1d465 65 _dcd_irq->fall(callback(this, &UARTSerial::dcd_irq));
borlanic 0:02dd72d1d465 66 } else {
borlanic 0:02dd72d1d465 67 _dcd_irq->rise(callback(this, &UARTSerial::dcd_irq));
borlanic 0:02dd72d1d465 68 }
borlanic 0:02dd72d1d465 69 }
borlanic 0:02dd72d1d465 70 }
borlanic 0:02dd72d1d465 71
borlanic 0:02dd72d1d465 72 void UARTSerial::set_format(int bits, Parity parity, int stop_bits)
borlanic 0:02dd72d1d465 73 {
borlanic 0:02dd72d1d465 74 api_lock();
borlanic 0:02dd72d1d465 75 SerialBase::format(bits, parity, stop_bits);
borlanic 0:02dd72d1d465 76 api_unlock();
borlanic 0:02dd72d1d465 77 }
borlanic 0:02dd72d1d465 78
borlanic 0:02dd72d1d465 79 #if DEVICE_SERIAL_FC
borlanic 0:02dd72d1d465 80 void UARTSerial::set_flow_control(Flow type, PinName flow1, PinName flow2)
borlanic 0:02dd72d1d465 81 {
borlanic 0:02dd72d1d465 82 api_lock();
borlanic 0:02dd72d1d465 83 SerialBase::set_flow_control(type, flow1, flow2);
borlanic 0:02dd72d1d465 84 api_unlock();
borlanic 0:02dd72d1d465 85 }
borlanic 0:02dd72d1d465 86 #endif
borlanic 0:02dd72d1d465 87
borlanic 0:02dd72d1d465 88 int UARTSerial::close()
borlanic 0:02dd72d1d465 89 {
borlanic 0:02dd72d1d465 90 /* Does not let us pass a file descriptor. So how to close ?
borlanic 0:02dd72d1d465 91 * Also, does it make sense to close a device type file descriptor*/
borlanic 0:02dd72d1d465 92 return 0;
borlanic 0:02dd72d1d465 93 }
borlanic 0:02dd72d1d465 94
borlanic 0:02dd72d1d465 95 int UARTSerial::isatty()
borlanic 0:02dd72d1d465 96 {
borlanic 0:02dd72d1d465 97 return 1;
borlanic 0:02dd72d1d465 98
borlanic 0:02dd72d1d465 99 }
borlanic 0:02dd72d1d465 100
borlanic 0:02dd72d1d465 101 off_t UARTSerial::seek(off_t offset, int whence)
borlanic 0:02dd72d1d465 102 {
borlanic 0:02dd72d1d465 103 /*XXX lseek can be done theoratically, but is it sane to mark positions on a dynamically growing/shrinking
borlanic 0:02dd72d1d465 104 * buffer system (from an interrupt context) */
borlanic 0:02dd72d1d465 105 return -ESPIPE;
borlanic 0:02dd72d1d465 106 }
borlanic 0:02dd72d1d465 107
borlanic 0:02dd72d1d465 108 int UARTSerial::sync()
borlanic 0:02dd72d1d465 109 {
borlanic 0:02dd72d1d465 110 api_lock();
borlanic 0:02dd72d1d465 111
borlanic 0:02dd72d1d465 112 while (!_txbuf.empty()) {
borlanic 0:02dd72d1d465 113 api_unlock();
borlanic 0:02dd72d1d465 114 // Doing better than wait would require TxIRQ to also do wake() when becoming empty. Worth it?
borlanic 0:02dd72d1d465 115 wait_ms(1);
borlanic 0:02dd72d1d465 116 api_lock();
borlanic 0:02dd72d1d465 117 }
borlanic 0:02dd72d1d465 118
borlanic 0:02dd72d1d465 119 api_unlock();
borlanic 0:02dd72d1d465 120
borlanic 0:02dd72d1d465 121 return 0;
borlanic 0:02dd72d1d465 122 }
borlanic 0:02dd72d1d465 123
borlanic 0:02dd72d1d465 124 void UARTSerial::sigio(Callback<void()> func) {
borlanic 0:02dd72d1d465 125 core_util_critical_section_enter();
borlanic 0:02dd72d1d465 126 _sigio_cb = func;
borlanic 0:02dd72d1d465 127 if (_sigio_cb) {
borlanic 0:02dd72d1d465 128 short current_events = poll(0x7FFF);
borlanic 0:02dd72d1d465 129 if (current_events) {
borlanic 0:02dd72d1d465 130 _sigio_cb();
borlanic 0:02dd72d1d465 131 }
borlanic 0:02dd72d1d465 132 }
borlanic 0:02dd72d1d465 133 core_util_critical_section_exit();
borlanic 0:02dd72d1d465 134 }
borlanic 0:02dd72d1d465 135
borlanic 0:02dd72d1d465 136 ssize_t UARTSerial::write(const void* buffer, size_t length)
borlanic 0:02dd72d1d465 137 {
borlanic 0:02dd72d1d465 138 size_t data_written = 0;
borlanic 0:02dd72d1d465 139 const char *buf_ptr = static_cast<const char *>(buffer);
borlanic 0:02dd72d1d465 140
borlanic 0:02dd72d1d465 141 if (length == 0) {
borlanic 0:02dd72d1d465 142 return 0;
borlanic 0:02dd72d1d465 143 }
borlanic 0:02dd72d1d465 144
borlanic 0:02dd72d1d465 145 api_lock();
borlanic 0:02dd72d1d465 146
borlanic 0:02dd72d1d465 147 // Unlike read, we should write the whole thing if blocking. POSIX only
borlanic 0:02dd72d1d465 148 // allows partial as a side-effect of signal handling; it normally tries to
borlanic 0:02dd72d1d465 149 // write everything if blocking. Without signals we can always write all.
borlanic 0:02dd72d1d465 150 while (data_written < length) {
borlanic 0:02dd72d1d465 151
borlanic 0:02dd72d1d465 152 if (_txbuf.full()) {
borlanic 0:02dd72d1d465 153 if (!_blocking) {
borlanic 0:02dd72d1d465 154 break;
borlanic 0:02dd72d1d465 155 }
borlanic 0:02dd72d1d465 156 do {
borlanic 0:02dd72d1d465 157 api_unlock();
borlanic 0:02dd72d1d465 158 wait_ms(1); // XXX todo - proper wait, WFE for non-rtos ?
borlanic 0:02dd72d1d465 159 api_lock();
borlanic 0:02dd72d1d465 160 } while (_txbuf.full());
borlanic 0:02dd72d1d465 161 }
borlanic 0:02dd72d1d465 162
borlanic 0:02dd72d1d465 163 while (data_written < length && !_txbuf.full()) {
borlanic 0:02dd72d1d465 164 _txbuf.push(*buf_ptr++);
borlanic 0:02dd72d1d465 165 data_written++;
borlanic 0:02dd72d1d465 166 }
borlanic 0:02dd72d1d465 167
borlanic 0:02dd72d1d465 168 core_util_critical_section_enter();
borlanic 0:02dd72d1d465 169 if (!_tx_irq_enabled) {
borlanic 0:02dd72d1d465 170 UARTSerial::tx_irq(); // only write to hardware in one place
borlanic 0:02dd72d1d465 171 if (!_txbuf.empty()) {
borlanic 0:02dd72d1d465 172 SerialBase::attach(callback(this, &UARTSerial::tx_irq), TxIrq);
borlanic 0:02dd72d1d465 173 _tx_irq_enabled = true;
borlanic 0:02dd72d1d465 174 }
borlanic 0:02dd72d1d465 175 }
borlanic 0:02dd72d1d465 176 core_util_critical_section_exit();
borlanic 0:02dd72d1d465 177 }
borlanic 0:02dd72d1d465 178
borlanic 0:02dd72d1d465 179 api_unlock();
borlanic 0:02dd72d1d465 180
borlanic 0:02dd72d1d465 181 return data_written != 0 ? (ssize_t) data_written : (ssize_t) -EAGAIN;
borlanic 0:02dd72d1d465 182 }
borlanic 0:02dd72d1d465 183
borlanic 0:02dd72d1d465 184 ssize_t UARTSerial::read(void* buffer, size_t length)
borlanic 0:02dd72d1d465 185 {
borlanic 0:02dd72d1d465 186 size_t data_read = 0;
borlanic 0:02dd72d1d465 187
borlanic 0:02dd72d1d465 188 char *ptr = static_cast<char *>(buffer);
borlanic 0:02dd72d1d465 189
borlanic 0:02dd72d1d465 190 if (length == 0) {
borlanic 0:02dd72d1d465 191 return 0;
borlanic 0:02dd72d1d465 192 }
borlanic 0:02dd72d1d465 193
borlanic 0:02dd72d1d465 194 api_lock();
borlanic 0:02dd72d1d465 195
borlanic 0:02dd72d1d465 196 while (_rxbuf.empty()) {
borlanic 0:02dd72d1d465 197 if (!_blocking) {
borlanic 0:02dd72d1d465 198 api_unlock();
borlanic 0:02dd72d1d465 199 return -EAGAIN;
borlanic 0:02dd72d1d465 200 }
borlanic 0:02dd72d1d465 201 api_unlock();
borlanic 0:02dd72d1d465 202 wait_ms(1); // XXX todo - proper wait, WFE for non-rtos ?
borlanic 0:02dd72d1d465 203 api_lock();
borlanic 0:02dd72d1d465 204 }
borlanic 0:02dd72d1d465 205
borlanic 0:02dd72d1d465 206 while (data_read < length && !_rxbuf.empty()) {
borlanic 0:02dd72d1d465 207 _rxbuf.pop(*ptr++);
borlanic 0:02dd72d1d465 208 data_read++;
borlanic 0:02dd72d1d465 209 }
borlanic 0:02dd72d1d465 210
borlanic 0:02dd72d1d465 211 core_util_critical_section_enter();
borlanic 0:02dd72d1d465 212 if (!_rx_irq_enabled) {
borlanic 0:02dd72d1d465 213 UARTSerial::rx_irq(); // only read from hardware in one place
borlanic 0:02dd72d1d465 214 if (!_rxbuf.full()) {
borlanic 0:02dd72d1d465 215 SerialBase::attach(callback(this, &UARTSerial::rx_irq), RxIrq);
borlanic 0:02dd72d1d465 216 _rx_irq_enabled = true;
borlanic 0:02dd72d1d465 217 }
borlanic 0:02dd72d1d465 218 }
borlanic 0:02dd72d1d465 219 core_util_critical_section_exit();
borlanic 0:02dd72d1d465 220
borlanic 0:02dd72d1d465 221 api_unlock();
borlanic 0:02dd72d1d465 222
borlanic 0:02dd72d1d465 223 return data_read;
borlanic 0:02dd72d1d465 224 }
borlanic 0:02dd72d1d465 225
borlanic 0:02dd72d1d465 226 bool UARTSerial::hup() const
borlanic 0:02dd72d1d465 227 {
borlanic 0:02dd72d1d465 228 return _dcd_irq && _dcd_irq->read() != 0;
borlanic 0:02dd72d1d465 229 }
borlanic 0:02dd72d1d465 230
borlanic 0:02dd72d1d465 231 void UARTSerial::wake()
borlanic 0:02dd72d1d465 232 {
borlanic 0:02dd72d1d465 233 if (_sigio_cb) {
borlanic 0:02dd72d1d465 234 _sigio_cb();
borlanic 0:02dd72d1d465 235 }
borlanic 0:02dd72d1d465 236 }
borlanic 0:02dd72d1d465 237
borlanic 0:02dd72d1d465 238 short UARTSerial::poll(short events) const {
borlanic 0:02dd72d1d465 239
borlanic 0:02dd72d1d465 240 short revents = 0;
borlanic 0:02dd72d1d465 241 /* Check the Circular Buffer if space available for writing out */
borlanic 0:02dd72d1d465 242
borlanic 0:02dd72d1d465 243
borlanic 0:02dd72d1d465 244 if (!_rxbuf.empty()) {
borlanic 0:02dd72d1d465 245 revents |= POLLIN;
borlanic 0:02dd72d1d465 246 }
borlanic 0:02dd72d1d465 247
borlanic 0:02dd72d1d465 248 /* POLLHUP and POLLOUT are mutually exclusive */
borlanic 0:02dd72d1d465 249 if (hup()) {
borlanic 0:02dd72d1d465 250 revents |= POLLHUP;
borlanic 0:02dd72d1d465 251 } else if (!_txbuf.full()) {
borlanic 0:02dd72d1d465 252 revents |= POLLOUT;
borlanic 0:02dd72d1d465 253 }
borlanic 0:02dd72d1d465 254
borlanic 0:02dd72d1d465 255 /*TODO Handle other event types */
borlanic 0:02dd72d1d465 256
borlanic 0:02dd72d1d465 257 return revents;
borlanic 0:02dd72d1d465 258 }
borlanic 0:02dd72d1d465 259
borlanic 0:02dd72d1d465 260 void UARTSerial::lock()
borlanic 0:02dd72d1d465 261 {
borlanic 0:02dd72d1d465 262 // This is the override for SerialBase.
borlanic 0:02dd72d1d465 263 // No lock required as we only use SerialBase from interrupt or from
borlanic 0:02dd72d1d465 264 // inside our own critical section.
borlanic 0:02dd72d1d465 265 }
borlanic 0:02dd72d1d465 266
borlanic 0:02dd72d1d465 267 void UARTSerial::unlock()
borlanic 0:02dd72d1d465 268 {
borlanic 0:02dd72d1d465 269 // This is the override for SerialBase.
borlanic 0:02dd72d1d465 270 }
borlanic 0:02dd72d1d465 271
borlanic 0:02dd72d1d465 272 void UARTSerial::api_lock(void)
borlanic 0:02dd72d1d465 273 {
borlanic 0:02dd72d1d465 274 _mutex.lock();
borlanic 0:02dd72d1d465 275 }
borlanic 0:02dd72d1d465 276
borlanic 0:02dd72d1d465 277 void UARTSerial::api_unlock(void)
borlanic 0:02dd72d1d465 278 {
borlanic 0:02dd72d1d465 279 _mutex.unlock();
borlanic 0:02dd72d1d465 280 }
borlanic 0:02dd72d1d465 281
borlanic 0:02dd72d1d465 282 void UARTSerial::rx_irq(void)
borlanic 0:02dd72d1d465 283 {
borlanic 0:02dd72d1d465 284 bool was_empty = _rxbuf.empty();
borlanic 0:02dd72d1d465 285
borlanic 0:02dd72d1d465 286 /* Fill in the receive buffer if the peripheral is readable
borlanic 0:02dd72d1d465 287 * and receive buffer is not full. */
borlanic 0:02dd72d1d465 288 while (!_rxbuf.full() && SerialBase::readable()) {
borlanic 0:02dd72d1d465 289 char data = SerialBase::_base_getc();
borlanic 0:02dd72d1d465 290 _rxbuf.push(data);
borlanic 0:02dd72d1d465 291 }
borlanic 0:02dd72d1d465 292
borlanic 0:02dd72d1d465 293 if (_rx_irq_enabled && _rxbuf.full()) {
borlanic 0:02dd72d1d465 294 SerialBase::attach(NULL, RxIrq);
borlanic 0:02dd72d1d465 295 _rx_irq_enabled = false;
borlanic 0:02dd72d1d465 296 }
borlanic 0:02dd72d1d465 297
borlanic 0:02dd72d1d465 298 /* Report the File handler that data is ready to be read from the buffer. */
borlanic 0:02dd72d1d465 299 if (was_empty && !_rxbuf.empty()) {
borlanic 0:02dd72d1d465 300 wake();
borlanic 0:02dd72d1d465 301 }
borlanic 0:02dd72d1d465 302 }
borlanic 0:02dd72d1d465 303
borlanic 0:02dd72d1d465 304 // Also called from write to start transfer
borlanic 0:02dd72d1d465 305 void UARTSerial::tx_irq(void)
borlanic 0:02dd72d1d465 306 {
borlanic 0:02dd72d1d465 307 bool was_full = _txbuf.full();
borlanic 0:02dd72d1d465 308
borlanic 0:02dd72d1d465 309 /* Write to the peripheral if there is something to write
borlanic 0:02dd72d1d465 310 * and if the peripheral is available to write. */
borlanic 0:02dd72d1d465 311 while (!_txbuf.empty() && SerialBase::writeable()) {
borlanic 0:02dd72d1d465 312 char data;
borlanic 0:02dd72d1d465 313 _txbuf.pop(data);
borlanic 0:02dd72d1d465 314 SerialBase::_base_putc(data);
borlanic 0:02dd72d1d465 315 }
borlanic 0:02dd72d1d465 316
borlanic 0:02dd72d1d465 317 if (_tx_irq_enabled && _txbuf.empty()) {
borlanic 0:02dd72d1d465 318 SerialBase::attach(NULL, TxIrq);
borlanic 0:02dd72d1d465 319 _tx_irq_enabled = false;
borlanic 0:02dd72d1d465 320 }
borlanic 0:02dd72d1d465 321
borlanic 0:02dd72d1d465 322 /* Report the File handler that data can be written to peripheral. */
borlanic 0:02dd72d1d465 323 if (was_full && !_txbuf.full() && !hup()) {
borlanic 0:02dd72d1d465 324 wake();
borlanic 0:02dd72d1d465 325 }
borlanic 0:02dd72d1d465 326 }
borlanic 0:02dd72d1d465 327
borlanic 0:02dd72d1d465 328 void UARTSerial::wait_ms(uint32_t millisec)
borlanic 0:02dd72d1d465 329 {
borlanic 0:02dd72d1d465 330 /* wait_ms implementation for RTOS spins until exact microseconds - we
borlanic 0:02dd72d1d465 331 * want to just sleep until next tick.
borlanic 0:02dd72d1d465 332 */
borlanic 0:02dd72d1d465 333 #if MBED_CONF_RTOS_PRESENT
borlanic 0:02dd72d1d465 334 rtos::Thread::wait(millisec);
borlanic 0:02dd72d1d465 335 #else
borlanic 0:02dd72d1d465 336 ::wait_ms(millisec);
borlanic 0:02dd72d1d465 337 #endif
borlanic 0:02dd72d1d465 338 }
borlanic 0:02dd72d1d465 339 } //namespace mbed
borlanic 0:02dd72d1d465 340
borlanic 0:02dd72d1d465 341 #endif //(DEVICE_SERIAL && DEVICE_INTERRUPTIN)