init

Dependencies:   mbed

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:16:49 2018 -0700
Revision:
10:46a4cf51ee38
Parent:
9:d58e77ebd769
remove mbed-os

Who changed what in which revision?

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