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