Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

drivers/SerialBase.cpp@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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