BA / SerialCom

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of OmniWheels by Gustav Atmel

mbed-os/drivers/SerialBase.cpp@1:9c5af431a1f1, 2018-05-01 (annotated)

Committer:
gustavatmel
Date:
Tue May 01 15:47:08 2018 +0000
Revision:
1:9c5af431a1f1
sdf

Who changed what in which revision?

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