Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/SerialBase.cpp@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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