mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

drivers/SerialBase.cpp@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
187:0387e8f68319 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 149:156823d33999 1 /* mbed Microcontroller Library
<> 149:156823d33999 2 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 189:f392fc9709a3 3 * SPDX-License-Identifier: Apache-2.0
<> 149:156823d33999 4 *
<> 149:156823d33999 5 * Licensed under the Apache License, Version 2.0 (the "License");
<> 149:156823d33999 6 * you may not use this file except in compliance with the License.
<> 149:156823d33999 7 * You may obtain a copy of the License at
<> 149:156823d33999 8 *
<> 149:156823d33999 9 * http://www.apache.org/licenses/LICENSE-2.0
<> 149:156823d33999 10 *
<> 149:156823d33999 11 * Unless required by applicable law or agreed to in writing, software
<> 149:156823d33999 12 * distributed under the License is distributed on an "AS IS" BASIS,
<> 149:156823d33999 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 149:156823d33999 14 * See the License for the specific language governing permissions and
<> 149:156823d33999 15 * limitations under the License.
<> 149:156823d33999 16 */
<> 149:156823d33999 17 #include "drivers/SerialBase.h"
<> 160:d5399cc887bb 18 #include "platform/mbed_wait_api.h"
<> 160:d5399cc887bb 19 #include "platform/mbed_critical.h"
AnnaBridge 184:08ed48f1de7f 20 #include "platform/mbed_power_mgmt.h"
<> 149:156823d33999 21
<> 149:156823d33999 22 #if DEVICE_SERIAL
<> 149:156823d33999 23
<> 149:156823d33999 24 namespace mbed {
<> 149:156823d33999 25
<> 149:156823d33999 26 SerialBase::SerialBase(PinName tx, PinName rx, int baud) :
<> 149:156823d33999 27 #if DEVICE_SERIAL_ASYNCH
AnnaBridge 187:0387e8f68319 28 _thunk_irq(this), _tx_usage(DMA_USAGE_NEVER),
AnnaBridge 187:0387e8f68319 29 _rx_usage(DMA_USAGE_NEVER), _tx_callback(NULL),
AnnaBridge 187:0387e8f68319 30 _rx_callback(NULL),
<> 149:156823d33999 31 #endif
AnnaBridge 187:0387e8f68319 32 _serial(), _baud(baud)
AnnaBridge 187:0387e8f68319 33 {
<> 149:156823d33999 34 // No lock needed in the constructor
<> 149:156823d33999 35
<> 149:156823d33999 36 for (size_t i = 0; i < sizeof _irq / sizeof _irq[0]; i++) {
AnnaBridge 174:b96e65c34a4d 37 _irq[i] = NULL;
<> 149:156823d33999 38 }
<> 149:156823d33999 39
<> 149:156823d33999 40 serial_init(&_serial, tx, rx);
<> 149:156823d33999 41 serial_baud(&_serial, _baud);
<> 149:156823d33999 42 serial_irq_handler(&_serial, SerialBase::_irq_handler, (uint32_t)this);
<> 149:156823d33999 43 }
<> 149:156823d33999 44
AnnaBridge 187:0387e8f68319 45 void SerialBase::baud(int baudrate)
AnnaBridge 187:0387e8f68319 46 {
<> 149:156823d33999 47 lock();
<> 149:156823d33999 48 serial_baud(&_serial, baudrate);
<> 149:156823d33999 49 _baud = baudrate;
<> 149:156823d33999 50 unlock();
<> 149:156823d33999 51 }
<> 149:156823d33999 52
AnnaBridge 187:0387e8f68319 53 void SerialBase::format(int bits, Parity parity, int stop_bits)
AnnaBridge 187:0387e8f68319 54 {
<> 149:156823d33999 55 lock();
<> 149:156823d33999 56 serial_format(&_serial, bits, (SerialParity)parity, stop_bits);
<> 149:156823d33999 57 unlock();
<> 149:156823d33999 58 }
<> 149:156823d33999 59
AnnaBridge 187:0387e8f68319 60 int SerialBase::readable()
AnnaBridge 187:0387e8f68319 61 {
<> 149:156823d33999 62 lock();
<> 149:156823d33999 63 int ret = serial_readable(&_serial);
<> 149:156823d33999 64 unlock();
<> 149:156823d33999 65 return ret;
<> 149:156823d33999 66 }
<> 149:156823d33999 67
<> 149:156823d33999 68
AnnaBridge 187:0387e8f68319 69 int SerialBase::writeable()
AnnaBridge 187:0387e8f68319 70 {
<> 149:156823d33999 71 lock();
<> 149:156823d33999 72 int ret = serial_writable(&_serial);
<> 149:156823d33999 73 unlock();
<> 149:156823d33999 74 return ret;
<> 149:156823d33999 75 }
<> 149:156823d33999 76
AnnaBridge 187:0387e8f68319 77 void SerialBase::attach(Callback<void()> func, IrqType type)
AnnaBridge 187:0387e8f68319 78 {
<> 149:156823d33999 79 lock();
<> 149:156823d33999 80 // Disable interrupts when attaching interrupt handler
<> 149:156823d33999 81 core_util_critical_section_enter();
<> 149:156823d33999 82 if (func) {
AnnaBridge 174:b96e65c34a4d 83 // lock deep sleep only the first time
AnnaBridge 174:b96e65c34a4d 84 if (!_irq[type]) {
AnnaBridge 174:b96e65c34a4d 85 sleep_manager_lock_deep_sleep();
AnnaBridge 187:0387e8f68319 86 }
<> 160:d5399cc887bb 87 _irq[type] = func;
<> 149:156823d33999 88 serial_irq_set(&_serial, (SerialIrq)type, 1);
<> 149:156823d33999 89 } else {
AnnaBridge 174:b96e65c34a4d 90 // unlock deep sleep only the first time
AnnaBridge 174:b96e65c34a4d 91 if (_irq[type]) {
AnnaBridge 174:b96e65c34a4d 92 sleep_manager_unlock_deep_sleep();
AnnaBridge 187:0387e8f68319 93 }
AnnaBridge 174:b96e65c34a4d 94 _irq[type] = NULL;
<> 149:156823d33999 95 serial_irq_set(&_serial, (SerialIrq)type, 0);
<> 149:156823d33999 96 }
<> 149:156823d33999 97 core_util_critical_section_exit();
<> 149:156823d33999 98 unlock();
<> 149:156823d33999 99 }
<> 149:156823d33999 100
AnnaBridge 187:0387e8f68319 101 void SerialBase::_irq_handler(uint32_t id, SerialIrq irq_type)
AnnaBridge 187:0387e8f68319 102 {
AnnaBridge 187:0387e8f68319 103 SerialBase *handler = (SerialBase *)id;
AnnaBridge 174:b96e65c34a4d 104 if (handler->_irq[irq_type]) {
AnnaBridge 174:b96e65c34a4d 105 handler->_irq[irq_type]();
AnnaBridge 174:b96e65c34a4d 106 }
<> 149:156823d33999 107 }
<> 149:156823d33999 108
AnnaBridge 187:0387e8f68319 109 int SerialBase::_base_getc()
AnnaBridge 187:0387e8f68319 110 {
<> 149:156823d33999 111 // Mutex is already held
<> 149:156823d33999 112 return serial_getc(&_serial);
<> 149:156823d33999 113 }
<> 149:156823d33999 114
AnnaBridge 187:0387e8f68319 115 int SerialBase::_base_putc(int c)
AnnaBridge 187:0387e8f68319 116 {
<> 149:156823d33999 117 // Mutex is already held
<> 149:156823d33999 118 serial_putc(&_serial, c);
<> 149:156823d33999 119 return c;
<> 149:156823d33999 120 }
<> 149:156823d33999 121
AnnaBridge 189:f392fc9709a3 122 void SerialBase::set_break()
AnnaBridge 189:f392fc9709a3 123 {
AnnaBridge 189:f392fc9709a3 124 lock();
AnnaBridge 189:f392fc9709a3 125 serial_break_set(&_serial);
AnnaBridge 189:f392fc9709a3 126 unlock();
AnnaBridge 189:f392fc9709a3 127 }
AnnaBridge 189:f392fc9709a3 128
AnnaBridge 189:f392fc9709a3 129 void SerialBase::clear_break()
AnnaBridge 189:f392fc9709a3 130 {
AnnaBridge 189:f392fc9709a3 131 lock();
AnnaBridge 189:f392fc9709a3 132 serial_break_clear(&_serial);
AnnaBridge 189:f392fc9709a3 133 unlock();
AnnaBridge 189:f392fc9709a3 134 }
AnnaBridge 189:f392fc9709a3 135
AnnaBridge 187:0387e8f68319 136 void SerialBase::send_break()
AnnaBridge 187:0387e8f68319 137 {
<> 149:156823d33999 138 lock();
AnnaBridge 187:0387e8f68319 139 // Wait for 1.5 frames before clearing the break condition
AnnaBridge 187:0387e8f68319 140 // This will have different effects on our platforms, but should
AnnaBridge 187:0387e8f68319 141 // ensure that we keep the break active for at least one frame.
AnnaBridge 187:0387e8f68319 142 // We consider a full frame (1 start bit + 8 data bits bits +
AnnaBridge 187:0387e8f68319 143 // 1 parity bit + 2 stop bits = 12 bits) for computation.
AnnaBridge 187:0387e8f68319 144 // One bit time (in us) = 1000000/_baud
AnnaBridge 187:0387e8f68319 145 // Twelve bits: 12000000/baud delay
AnnaBridge 187:0387e8f68319 146 // 1.5 frames: 18000000/baud delay
AnnaBridge 187:0387e8f68319 147 serial_break_set(&_serial);
AnnaBridge 187:0387e8f68319 148 wait_us(18000000 / _baud);
AnnaBridge 187:0387e8f68319 149 serial_break_clear(&_serial);
AnnaBridge 187:0387e8f68319 150 unlock();
<> 149:156823d33999 151 }
<> 149:156823d33999 152
AnnaBridge 187:0387e8f68319 153 void SerialBase::lock()
AnnaBridge 187:0387e8f68319 154 {
<> 149:156823d33999 155 // Stub
<> 149:156823d33999 156 }
<> 149:156823d33999 157
AnnaBridge 187:0387e8f68319 158 void SerialBase:: unlock()
AnnaBridge 187:0387e8f68319 159 {
<> 149:156823d33999 160 // Stub
<> 149:156823d33999 161 }
<> 149:156823d33999 162
AnnaBridge 175:af195413fb11 163 SerialBase::~SerialBase()
AnnaBridge 175:af195413fb11 164 {
AnnaBridge 175:af195413fb11 165 // No lock needed in destructor
AnnaBridge 175:af195413fb11 166
AnnaBridge 175:af195413fb11 167 // Detaching interrupts releases the sleep lock if it was locked
AnnaBridge 175:af195413fb11 168 for (int irq = 0; irq < IrqCnt; irq++) {
AnnaBridge 175:af195413fb11 169 attach(NULL, (IrqType)irq);
AnnaBridge 175:af195413fb11 170 }
AnnaBridge 175:af195413fb11 171 }
AnnaBridge 175:af195413fb11 172
<> 149:156823d33999 173 #if DEVICE_SERIAL_FC
AnnaBridge 187:0387e8f68319 174 void SerialBase::set_flow_control(Flow type, PinName flow1, PinName flow2)
AnnaBridge 187:0387e8f68319 175 {
<> 149:156823d33999 176 lock();
<> 149:156823d33999 177 FlowControl flow_type = (FlowControl)type;
AnnaBridge 187:0387e8f68319 178 switch (type) {
<> 149:156823d33999 179 case RTS:
<> 149:156823d33999 180 serial_set_flow_control(&_serial, flow_type, flow1, NC);
<> 149:156823d33999 181 break;
<> 149:156823d33999 182
<> 149:156823d33999 183 case CTS:
<> 149:156823d33999 184 serial_set_flow_control(&_serial, flow_type, NC, flow1);
<> 149:156823d33999 185 break;
<> 149:156823d33999 186
<> 149:156823d33999 187 case RTSCTS:
<> 149:156823d33999 188 case Disabled:
<> 149:156823d33999 189 serial_set_flow_control(&_serial, flow_type, flow1, flow2);
<> 149:156823d33999 190 break;
<> 149:156823d33999 191
<> 149:156823d33999 192 default:
<> 149:156823d33999 193 break;
<> 149:156823d33999 194 }
<> 149:156823d33999 195 unlock();
<> 149:156823d33999 196 }
<> 149:156823d33999 197 #endif
<> 149:156823d33999 198
<> 149:156823d33999 199 #if DEVICE_SERIAL_ASYNCH
<> 149:156823d33999 200
AnnaBridge 187:0387e8f68319 201 int SerialBase::write(const uint8_t *buffer, int length, const event_callback_t &callback, int event)
<> 149:156823d33999 202 {
<> 149:156823d33999 203 if (serial_tx_active(&_serial)) {
<> 149:156823d33999 204 return -1; // transaction ongoing
<> 149:156823d33999 205 }
<> 149:156823d33999 206 start_write((void *)buffer, length, 8, callback, event);
<> 149:156823d33999 207 return 0;
<> 149:156823d33999 208 }
<> 149:156823d33999 209
AnnaBridge 187:0387e8f68319 210 int SerialBase::write(const uint16_t *buffer, int length, const event_callback_t &callback, int event)
<> 149:156823d33999 211 {
<> 149:156823d33999 212 if (serial_tx_active(&_serial)) {
<> 149:156823d33999 213 return -1; // transaction ongoing
<> 149:156823d33999 214 }
<> 149:156823d33999 215 start_write((void *)buffer, length, 16, callback, event);
<> 149:156823d33999 216 return 0;
<> 149:156823d33999 217 }
<> 149:156823d33999 218
AnnaBridge 187:0387e8f68319 219 void SerialBase::start_write(const void *buffer, int buffer_size, char buffer_width, const event_callback_t &callback, int event)
<> 149:156823d33999 220 {
<> 149:156823d33999 221 _tx_callback = callback;
<> 149:156823d33999 222
<> 149:156823d33999 223 _thunk_irq.callback(&SerialBase::interrupt_handler_asynch);
AnnaBridge 174:b96e65c34a4d 224 sleep_manager_lock_deep_sleep();
<> 149:156823d33999 225 serial_tx_asynch(&_serial, buffer, buffer_size, buffer_width, _thunk_irq.entry(), event, _tx_usage);
<> 149:156823d33999 226 }
<> 149:156823d33999 227
<> 149:156823d33999 228 void SerialBase::abort_write(void)
<> 149:156823d33999 229 {
AnnaBridge 174:b96e65c34a4d 230 // rx might still be active
AnnaBridge 174:b96e65c34a4d 231 if (_rx_callback) {
AnnaBridge 174:b96e65c34a4d 232 sleep_manager_unlock_deep_sleep();
AnnaBridge 174:b96e65c34a4d 233 }
AnnaBridge 174:b96e65c34a4d 234 _tx_callback = NULL;
<> 149:156823d33999 235 serial_tx_abort_asynch(&_serial);
<> 149:156823d33999 236 }
<> 149:156823d33999 237
<> 149:156823d33999 238 void SerialBase::abort_read(void)
<> 149:156823d33999 239 {
AnnaBridge 174:b96e65c34a4d 240 // tx might still be active
AnnaBridge 174:b96e65c34a4d 241 if (_tx_callback) {
AnnaBridge 174:b96e65c34a4d 242 sleep_manager_unlock_deep_sleep();
AnnaBridge 174:b96e65c34a4d 243 }
AnnaBridge 174:b96e65c34a4d 244 _rx_callback = NULL;
<> 149:156823d33999 245 serial_rx_abort_asynch(&_serial);
<> 149:156823d33999 246 }
<> 149:156823d33999 247
<> 149:156823d33999 248 int SerialBase::set_dma_usage_tx(DMAUsage usage)
<> 149:156823d33999 249 {
<> 149:156823d33999 250 if (serial_tx_active(&_serial)) {
<> 149:156823d33999 251 return -1;
<> 149:156823d33999 252 }
<> 149:156823d33999 253 _tx_usage = usage;
<> 149:156823d33999 254 return 0;
<> 149:156823d33999 255 }
<> 149:156823d33999 256
<> 149:156823d33999 257 int SerialBase::set_dma_usage_rx(DMAUsage usage)
<> 149:156823d33999 258 {
<> 149:156823d33999 259 if (serial_tx_active(&_serial)) {
<> 149:156823d33999 260 return -1;
<> 149:156823d33999 261 }
<> 149:156823d33999 262 _rx_usage = usage;
<> 149:156823d33999 263 return 0;
<> 149:156823d33999 264 }
<> 149:156823d33999 265
AnnaBridge 187:0387e8f68319 266 int SerialBase::read(uint8_t *buffer, int length, const event_callback_t &callback, int event, unsigned char char_match)
<> 149:156823d33999 267 {
<> 149:156823d33999 268 if (serial_rx_active(&_serial)) {
<> 149:156823d33999 269 return -1; // transaction ongoing
<> 149:156823d33999 270 }
AnnaBridge 187:0387e8f68319 271 start_read((void *)buffer, length, 8, callback, event, char_match);
<> 149:156823d33999 272 return 0;
<> 149:156823d33999 273 }
<> 149:156823d33999 274
<> 149:156823d33999 275
AnnaBridge 187:0387e8f68319 276 int SerialBase::read(uint16_t *buffer, int length, const event_callback_t &callback, int event, unsigned char char_match)
<> 149:156823d33999 277 {
<> 149:156823d33999 278 if (serial_rx_active(&_serial)) {
<> 149:156823d33999 279 return -1; // transaction ongoing
<> 149:156823d33999 280 }
AnnaBridge 187:0387e8f68319 281 start_read((void *)buffer, length, 16, callback, event, char_match);
<> 149:156823d33999 282 return 0;
<> 149:156823d33999 283 }
<> 149:156823d33999 284
<> 149:156823d33999 285
AnnaBridge 187:0387e8f68319 286 void SerialBase::start_read(void *buffer, int buffer_size, char buffer_width, const event_callback_t &callback, int event, unsigned char char_match)
<> 149:156823d33999 287 {
<> 149:156823d33999 288 _rx_callback = callback;
<> 149:156823d33999 289 _thunk_irq.callback(&SerialBase::interrupt_handler_asynch);
AnnaBridge 174:b96e65c34a4d 290 sleep_manager_lock_deep_sleep();
<> 149:156823d33999 291 serial_rx_asynch(&_serial, buffer, buffer_size, buffer_width, _thunk_irq.entry(), event, char_match, _rx_usage);
<> 149:156823d33999 292 }
<> 149:156823d33999 293
<> 149:156823d33999 294 void SerialBase::interrupt_handler_asynch(void)
<> 149:156823d33999 295 {
<> 149:156823d33999 296 int event = serial_irq_handler_asynch(&_serial);
<> 149:156823d33999 297 int rx_event = event & SERIAL_EVENT_RX_MASK;
AnnaBridge 174:b96e65c34a4d 298 bool unlock_deepsleep = false;
AnnaBridge 174:b96e65c34a4d 299
<> 149:156823d33999 300 if (_rx_callback && rx_event) {
AnnaBridge 174:b96e65c34a4d 301 unlock_deepsleep = true;
<> 149:156823d33999 302 _rx_callback.call(rx_event);
<> 149:156823d33999 303 }
<> 149:156823d33999 304
<> 149:156823d33999 305 int tx_event = event & SERIAL_EVENT_TX_MASK;
<> 149:156823d33999 306 if (_tx_callback && tx_event) {
AnnaBridge 174:b96e65c34a4d 307 unlock_deepsleep = true;
<> 149:156823d33999 308 _tx_callback.call(tx_event);
<> 149:156823d33999 309 }
AnnaBridge 174:b96e65c34a4d 310 // unlock if tx or rx events are generated
AnnaBridge 174:b96e65c34a4d 311 if (unlock_deepsleep) {
AnnaBridge 174:b96e65c34a4d 312 sleep_manager_unlock_deep_sleep();
AnnaBridge 174:b96e65c34a4d 313 }
<> 149:156823d33999 314 }
<> 149:156823d33999 315
<> 149:156823d33999 316 #endif
<> 149:156823d33999 317
<> 149:156823d33999 318 } // namespace mbed
<> 149:156823d33999 319
<> 149:156823d33999 320 #endif