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