Lancaster University / mbed-dev-bin

Binary version of Lancaster University's mbed branch, soon to be merged. The source lives here:https://developer.mbed.org/teams/Lancaster-University/code/mbed-src/

Dependents:   microbit-dal microbit-ble-open microbit-dal-eddystone microbit-dal ... more

Fork of mbed-lite-test by Lancaster University

SerialBase.h@3:768173a57492, 2016-07-13 (annotated)

Committer:
jamesadevine
Date:
Wed Jul 13 15:12:06 2016 +0100
Revision:
3:768173a57492
Parent:
0:e1a608bb55e8 
further updates to mbed-dev-bin

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jamesadevine 0:e1a608bb55e8 1 /* mbed Microcontroller Library
jamesadevine 0:e1a608bb55e8 2 * Copyright (c) 2006-2013 ARM Limited
jamesadevine 0:e1a608bb55e8 3 *
jamesadevine 0:e1a608bb55e8 4 * Licensed under the Apache License, Version 2.0 (the "License");
jamesadevine 0:e1a608bb55e8 5 * you may not use this file except in compliance with the License.
jamesadevine 0:e1a608bb55e8 6 * You may obtain a copy of the License at
jamesadevine 0:e1a608bb55e8 7 *
jamesadevine 0:e1a608bb55e8 8 * http://www.apache.org/licenses/LICENSE-2.0
jamesadevine 0:e1a608bb55e8 9 *
jamesadevine 0:e1a608bb55e8 10 * Unless required by applicable law or agreed to in writing, software
jamesadevine 0:e1a608bb55e8 11 * distributed under the License is distributed on an "AS IS" BASIS,
jamesadevine 0:e1a608bb55e8 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
jamesadevine 0:e1a608bb55e8 13 * See the License for the specific language governing permissions and
jamesadevine 0:e1a608bb55e8 14 * limitations under the License.
jamesadevine 0:e1a608bb55e8 15 */
jamesadevine 0:e1a608bb55e8 16 #ifndef MBED_SERIALBASE_H
jamesadevine 0:e1a608bb55e8 17 #define MBED_SERIALBASE_H
jamesadevine 0:e1a608bb55e8 18
jamesadevine 0:e1a608bb55e8 19 #include "platform.h"
jamesadevine 0:e1a608bb55e8 20
jamesadevine 0:e1a608bb55e8 21 #if DEVICE_SERIAL
jamesadevine 0:e1a608bb55e8 22
jamesadevine 0:e1a608bb55e8 23 #include "Stream.h"
jamesadevine 0:e1a608bb55e8 24 #include "FunctionPointer.h"
jamesadevine 0:e1a608bb55e8 25 #include "serial_api.h"
jamesadevine 0:e1a608bb55e8 26
jamesadevine 0:e1a608bb55e8 27 #if DEVICE_SERIAL_ASYNCH
jamesadevine 0:e1a608bb55e8 28 #include "CThunk.h"
jamesadevine 0:e1a608bb55e8 29 #include "dma_api.h"
jamesadevine 0:e1a608bb55e8 30 #endif
jamesadevine 0:e1a608bb55e8 31
jamesadevine 0:e1a608bb55e8 32 namespace mbed {
jamesadevine 0:e1a608bb55e8 33
jamesadevine 0:e1a608bb55e8 34 /** A base class for serial port implementations
jamesadevine 0:e1a608bb55e8 35 * Can't be instantiated directly (use Serial or RawSerial)
jamesadevine 0:e1a608bb55e8 36 */
jamesadevine 0:e1a608bb55e8 37 class SerialBase {
jamesadevine 0:e1a608bb55e8 38
jamesadevine 0:e1a608bb55e8 39 public:
jamesadevine 0:e1a608bb55e8 40 /** Set the baud rate of the serial port
jamesadevine 0:e1a608bb55e8 41 *
jamesadevine 0:e1a608bb55e8 42 * @param baudrate The baudrate of the serial port (default = 9600).
jamesadevine 0:e1a608bb55e8 43 */
jamesadevine 0:e1a608bb55e8 44 void baud(int baudrate);
jamesadevine 0:e1a608bb55e8 45
jamesadevine 0:e1a608bb55e8 46 enum Parity {
jamesadevine 0:e1a608bb55e8 47 None = 0,
jamesadevine 0:e1a608bb55e8 48 Odd,
jamesadevine 0:e1a608bb55e8 49 Even,
jamesadevine 0:e1a608bb55e8 50 Forced1,
jamesadevine 0:e1a608bb55e8 51 Forced0
jamesadevine 0:e1a608bb55e8 52 };
jamesadevine 0:e1a608bb55e8 53
jamesadevine 0:e1a608bb55e8 54 enum IrqType {
jamesadevine 0:e1a608bb55e8 55 RxIrq = 0,
jamesadevine 0:e1a608bb55e8 56 TxIrq
jamesadevine 0:e1a608bb55e8 57 };
jamesadevine 0:e1a608bb55e8 58
jamesadevine 0:e1a608bb55e8 59 enum Flow {
jamesadevine 0:e1a608bb55e8 60 Disabled = 0,
jamesadevine 0:e1a608bb55e8 61 RTS,
jamesadevine 0:e1a608bb55e8 62 CTS,
jamesadevine 0:e1a608bb55e8 63 RTSCTS
jamesadevine 0:e1a608bb55e8 64 };
jamesadevine 0:e1a608bb55e8 65
jamesadevine 0:e1a608bb55e8 66 /** Set the transmission format used by the serial port
jamesadevine 0:e1a608bb55e8 67 *
jamesadevine 0:e1a608bb55e8 68 * @param bits The number of bits in a word (5-8; default = 8)
jamesadevine 0:e1a608bb55e8 69 * @param parity The parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None)
jamesadevine 0:e1a608bb55e8 70 * @param stop The number of stop bits (1 or 2; default = 1)
jamesadevine 0:e1a608bb55e8 71 */
jamesadevine 0:e1a608bb55e8 72 void format(int bits=8, Parity parity=SerialBase::None, int stop_bits=1);
jamesadevine 0:e1a608bb55e8 73
jamesadevine 0:e1a608bb55e8 74 /** Determine if there is a character available to read
jamesadevine 0:e1a608bb55e8 75 *
jamesadevine 0:e1a608bb55e8 76 * @returns
jamesadevine 0:e1a608bb55e8 77 * 1 if there is a character available to read,
jamesadevine 0:e1a608bb55e8 78 * 0 otherwise
jamesadevine 0:e1a608bb55e8 79 */
jamesadevine 0:e1a608bb55e8 80 int readable();
jamesadevine 0:e1a608bb55e8 81
jamesadevine 0:e1a608bb55e8 82 /** Determine if there is space available to write a character
jamesadevine 0:e1a608bb55e8 83 *
jamesadevine 0:e1a608bb55e8 84 * @returns
jamesadevine 0:e1a608bb55e8 85 * 1 if there is space to write a character,
jamesadevine 0:e1a608bb55e8 86 * 0 otherwise
jamesadevine 0:e1a608bb55e8 87 */
jamesadevine 0:e1a608bb55e8 88 int writeable();
jamesadevine 0:e1a608bb55e8 89
jamesadevine 0:e1a608bb55e8 90 /** Attach a function to call whenever a serial interrupt is generated
jamesadevine 0:e1a608bb55e8 91 *
jamesadevine 0:e1a608bb55e8 92 * @param fptr A pointer to a void function, or 0 to set as none
jamesadevine 0:e1a608bb55e8 93 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
jamesadevine 0:e1a608bb55e8 94 */
jamesadevine 0:e1a608bb55e8 95 void attach(void (*fptr)(void), IrqType type=RxIrq);
jamesadevine 0:e1a608bb55e8 96
jamesadevine 0:e1a608bb55e8 97 /** Attach a member function to call whenever a serial interrupt is generated
jamesadevine 0:e1a608bb55e8 98 *
jamesadevine 0:e1a608bb55e8 99 * @param tptr pointer to the object to call the member function on
jamesadevine 0:e1a608bb55e8 100 * @param mptr pointer to the member function to be called
jamesadevine 0:e1a608bb55e8 101 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
jamesadevine 0:e1a608bb55e8 102 */
jamesadevine 0:e1a608bb55e8 103 template<typename T>
jamesadevine 0:e1a608bb55e8 104 void attach(T* tptr, void (T::*mptr)(void), IrqType type=RxIrq) {
jamesadevine 0:e1a608bb55e8 105 if((mptr != NULL) && (tptr != NULL)) {
jamesadevine 0:e1a608bb55e8 106 _irq[type].attach(tptr, mptr);
jamesadevine 0:e1a608bb55e8 107 serial_irq_set(&_serial, (SerialIrq)type, 1);
jamesadevine 0:e1a608bb55e8 108 } else {
jamesadevine 0:e1a608bb55e8 109 serial_irq_set(&_serial, (SerialIrq)type, 0);
jamesadevine 0:e1a608bb55e8 110 }
jamesadevine 0:e1a608bb55e8 111 }
jamesadevine 0:e1a608bb55e8 112
jamesadevine 0:e1a608bb55e8 113 /** Generate a break condition on the serial line
jamesadevine 0:e1a608bb55e8 114 */
jamesadevine 0:e1a608bb55e8 115 void send_break();
jamesadevine 0:e1a608bb55e8 116
jamesadevine 0:e1a608bb55e8 117 #if DEVICE_SERIAL_FC
jamesadevine 0:e1a608bb55e8 118 /** Set the flow control type on the serial port
jamesadevine 0:e1a608bb55e8 119 *
jamesadevine 0:e1a608bb55e8 120 * @param type the flow control type (Disabled, RTS, CTS, RTSCTS)
jamesadevine 0:e1a608bb55e8 121 * @param flow1 the first flow control pin (RTS for RTS or RTSCTS, CTS for CTS)
jamesadevine 0:e1a608bb55e8 122 * @param flow2 the second flow control pin (CTS for RTSCTS)
jamesadevine 0:e1a608bb55e8 123 */
jamesadevine 0:e1a608bb55e8 124 void set_flow_control(Flow type, PinName flow1=NC, PinName flow2=NC);
jamesadevine 0:e1a608bb55e8 125 #endif
jamesadevine 0:e1a608bb55e8 126
jamesadevine 0:e1a608bb55e8 127 static void _irq_handler(uint32_t id, SerialIrq irq_type);
jamesadevine 0:e1a608bb55e8 128
jamesadevine 0:e1a608bb55e8 129 #if DEVICE_SERIAL_ASYNCH
jamesadevine 0:e1a608bb55e8 130
jamesadevine 0:e1a608bb55e8 131 /** Begin asynchronous write using 8bit buffer. The completition invokes registered TX event callback
jamesadevine 0:e1a608bb55e8 132 *
jamesadevine 0:e1a608bb55e8 133 * @param buffer The buffer where received data will be stored
jamesadevine 0:e1a608bb55e8 134 * @param length The buffer length in bytes
jamesadevine 0:e1a608bb55e8 135 * @param callback The event callback function
jamesadevine 0:e1a608bb55e8 136 * @param event The logical OR of TX events
jamesadevine 0:e1a608bb55e8 137 */
jamesadevine 0:e1a608bb55e8 138 int write(const uint8_t *buffer, int length, const event_callback_t& callback, int event = SERIAL_EVENT_TX_COMPLETE);
jamesadevine 0:e1a608bb55e8 139
jamesadevine 0:e1a608bb55e8 140 /** Begin asynchronous write using 16bit buffer. The completition invokes registered TX event callback
jamesadevine 0:e1a608bb55e8 141 *
jamesadevine 0:e1a608bb55e8 142 * @param buffer The buffer where received data will be stored
jamesadevine 0:e1a608bb55e8 143 * @param length The buffer length in bytes
jamesadevine 0:e1a608bb55e8 144 * @param callback The event callback function
jamesadevine 0:e1a608bb55e8 145 * @param event The logical OR of TX events
jamesadevine 0:e1a608bb55e8 146 */
jamesadevine 0:e1a608bb55e8 147 int write(const uint16_t *buffer, int length, const event_callback_t& callback, int event = SERIAL_EVENT_TX_COMPLETE);
jamesadevine 0:e1a608bb55e8 148
jamesadevine 0:e1a608bb55e8 149 /** Abort the on-going write transfer
jamesadevine 0:e1a608bb55e8 150 */
jamesadevine 0:e1a608bb55e8 151 void abort_write();
jamesadevine 0:e1a608bb55e8 152
jamesadevine 0:e1a608bb55e8 153 /** Begin asynchronous reading using 8bit buffer. The completition invokes registred RX event callback.
jamesadevine 0:e1a608bb55e8 154 *
jamesadevine 0:e1a608bb55e8 155 * @param buffer The buffer where received data will be stored
jamesadevine 0:e1a608bb55e8 156 * @param length The buffer length in bytes
jamesadevine 0:e1a608bb55e8 157 * @param callback The event callback function
jamesadevine 0:e1a608bb55e8 158 * @param event The logical OR of RX events
jamesadevine 0:e1a608bb55e8 159 * @param char_match The matching character
jamesadevine 0:e1a608bb55e8 160 */
jamesadevine 0:e1a608bb55e8 161 int read(uint8_t *buffer, int length, const event_callback_t& callback, int event = SERIAL_EVENT_RX_COMPLETE, unsigned char char_match = SERIAL_RESERVED_CHAR_MATCH);
jamesadevine 0:e1a608bb55e8 162
jamesadevine 0:e1a608bb55e8 163 /** Begin asynchronous reading using 16bit buffer. The completition invokes registred RX event callback.
jamesadevine 0:e1a608bb55e8 164 *
jamesadevine 0:e1a608bb55e8 165 * @param buffer The buffer where received data will be stored
jamesadevine 0:e1a608bb55e8 166 * @param length The buffer length in bytes
jamesadevine 0:e1a608bb55e8 167 * @param callback The event callback function
jamesadevine 0:e1a608bb55e8 168 * @param event The logical OR of RX events
jamesadevine 0:e1a608bb55e8 169 * @param char_match The matching character
jamesadevine 0:e1a608bb55e8 170 */
jamesadevine 0:e1a608bb55e8 171 int read(uint16_t *buffer, int length, const event_callback_t& callback, int event = SERIAL_EVENT_RX_COMPLETE, unsigned char char_match = SERIAL_RESERVED_CHAR_MATCH);
jamesadevine 0:e1a608bb55e8 172
jamesadevine 0:e1a608bb55e8 173 /** Abort the on-going read transfer
jamesadevine 0:e1a608bb55e8 174 */
jamesadevine 0:e1a608bb55e8 175 void abort_read();
jamesadevine 0:e1a608bb55e8 176
jamesadevine 0:e1a608bb55e8 177 /** Configure DMA usage suggestion for non-blocking TX transfers
jamesadevine 0:e1a608bb55e8 178 *
jamesadevine 0:e1a608bb55e8 179 * @param usage The usage DMA hint for peripheral
jamesadevine 0:e1a608bb55e8 180 * @return Zero if the usage was set, -1 if a transaction is on-going
jamesadevine 0:e1a608bb55e8 181 */
jamesadevine 0:e1a608bb55e8 182 int set_dma_usage_tx(DMAUsage usage);
jamesadevine 0:e1a608bb55e8 183
jamesadevine 0:e1a608bb55e8 184 /** Configure DMA usage suggestion for non-blocking RX transfers
jamesadevine 0:e1a608bb55e8 185 *
jamesadevine 0:e1a608bb55e8 186 * @param usage The usage DMA hint for peripheral
jamesadevine 0:e1a608bb55e8 187 * @return Zero if the usage was set, -1 if a transaction is on-going
jamesadevine 0:e1a608bb55e8 188 */
jamesadevine 0:e1a608bb55e8 189 int set_dma_usage_rx(DMAUsage usage);
jamesadevine 0:e1a608bb55e8 190
jamesadevine 0:e1a608bb55e8 191 protected:
jamesadevine 0:e1a608bb55e8 192 void start_read(void *buffer, int buffer_size, char buffer_width, const event_callback_t& callback, int event, unsigned char char_match);
jamesadevine 0:e1a608bb55e8 193 void start_write(const void *buffer, int buffer_size, char buffer_width, const event_callback_t& callback, int event);
jamesadevine 0:e1a608bb55e8 194 void interrupt_handler_asynch(void);
jamesadevine 0:e1a608bb55e8 195 #endif
jamesadevine 0:e1a608bb55e8 196
jamesadevine 0:e1a608bb55e8 197 protected:
jamesadevine 0:e1a608bb55e8 198 SerialBase(PinName tx, PinName rx);
jamesadevine 0:e1a608bb55e8 199 virtual ~SerialBase() {
jamesadevine 0:e1a608bb55e8 200 }
jamesadevine 0:e1a608bb55e8 201
jamesadevine 0:e1a608bb55e8 202 int _base_getc();
jamesadevine 0:e1a608bb55e8 203 int _base_putc(int c);
jamesadevine 0:e1a608bb55e8 204
jamesadevine 0:e1a608bb55e8 205 #if DEVICE_SERIAL_ASYNCH
jamesadevine 0:e1a608bb55e8 206 CThunk<SerialBase> _thunk_irq;
jamesadevine 0:e1a608bb55e8 207 event_callback_t _tx_callback;
jamesadevine 0:e1a608bb55e8 208 event_callback_t _rx_callback;
jamesadevine 0:e1a608bb55e8 209 DMAUsage _tx_usage;
jamesadevine 0:e1a608bb55e8 210 DMAUsage _rx_usage;
jamesadevine 0:e1a608bb55e8 211 #endif
jamesadevine 0:e1a608bb55e8 212
jamesadevine 0:e1a608bb55e8 213 serial_t _serial;
jamesadevine 0:e1a608bb55e8 214 FunctionPointer _irq[2];
jamesadevine 0:e1a608bb55e8 215 int _baud;
jamesadevine 0:e1a608bb55e8 216
jamesadevine 0:e1a608bb55e8 217 };
jamesadevine 0:e1a608bb55e8 218
jamesadevine 0:e1a608bb55e8 219 } // namespace mbed
jamesadevine 0:e1a608bb55e8 220
jamesadevine 0:e1a608bb55e8 221 #endif
jamesadevine 0:e1a608bb55e8 222
jamesadevine 0:e1a608bb55e8 223 #endif