TUKS MCU Introductory course / TUKS-COURSE-TIMER

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.

mbed-dev/drivers/SerialBase.cpp@1:d0dfbce63a89, 2017-02-24 (annotated)

Committer:
elmot
Date:
Fri Feb 24 21:13:56 2017 +0000
Revision:
1:d0dfbce63a89
Ready-to-copy

Who changed what in which revision?

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