Vladimir Vana / mbed

pro vyuku PSS v Jecne

SerialBase.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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