RTC auf true
drivers/SerialBase.h@0:38ceb79fef03, 2018-11-28 (annotated)
- Committer:
- kevman
- Date:
- Wed Nov 28 15:10:15 2018 +0000
- Revision:
- 0:38ceb79fef03
RTC modified
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
kevman | 0:38ceb79fef03 | 1 | /* mbed Microcontroller Library |
kevman | 0:38ceb79fef03 | 2 | * Copyright (c) 2006-2013 ARM Limited |
kevman | 0:38ceb79fef03 | 3 | * |
kevman | 0:38ceb79fef03 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
kevman | 0:38ceb79fef03 | 5 | * you may not use this file except in compliance with the License. |
kevman | 0:38ceb79fef03 | 6 | * You may obtain a copy of the License at |
kevman | 0:38ceb79fef03 | 7 | * |
kevman | 0:38ceb79fef03 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
kevman | 0:38ceb79fef03 | 9 | * |
kevman | 0:38ceb79fef03 | 10 | * Unless required by applicable law or agreed to in writing, software |
kevman | 0:38ceb79fef03 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
kevman | 0:38ceb79fef03 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
kevman | 0:38ceb79fef03 | 13 | * See the License for the specific language governing permissions and |
kevman | 0:38ceb79fef03 | 14 | * limitations under the License. |
kevman | 0:38ceb79fef03 | 15 | */ |
kevman | 0:38ceb79fef03 | 16 | #ifndef MBED_SERIALBASE_H |
kevman | 0:38ceb79fef03 | 17 | #define MBED_SERIALBASE_H |
kevman | 0:38ceb79fef03 | 18 | |
kevman | 0:38ceb79fef03 | 19 | #include "platform/platform.h" |
kevman | 0:38ceb79fef03 | 20 | |
kevman | 0:38ceb79fef03 | 21 | #if defined (DEVICE_SERIAL) || defined(DOXYGEN_ONLY) |
kevman | 0:38ceb79fef03 | 22 | |
kevman | 0:38ceb79fef03 | 23 | #include "platform/Callback.h" |
kevman | 0:38ceb79fef03 | 24 | #include "hal/serial_api.h" |
kevman | 0:38ceb79fef03 | 25 | #include "platform/mbed_toolchain.h" |
kevman | 0:38ceb79fef03 | 26 | #include "platform/NonCopyable.h" |
kevman | 0:38ceb79fef03 | 27 | |
kevman | 0:38ceb79fef03 | 28 | #if DEVICE_SERIAL_ASYNCH |
kevman | 0:38ceb79fef03 | 29 | #include "platform/CThunk.h" |
kevman | 0:38ceb79fef03 | 30 | #include "hal/dma_api.h" |
kevman | 0:38ceb79fef03 | 31 | #endif |
kevman | 0:38ceb79fef03 | 32 | |
kevman | 0:38ceb79fef03 | 33 | namespace mbed { |
kevman | 0:38ceb79fef03 | 34 | /** \addtogroup drivers */ |
kevman | 0:38ceb79fef03 | 35 | |
kevman | 0:38ceb79fef03 | 36 | /** A base class for serial port implementations |
kevman | 0:38ceb79fef03 | 37 | * Can't be instantiated directly (use Serial or RawSerial) |
kevman | 0:38ceb79fef03 | 38 | * |
kevman | 0:38ceb79fef03 | 39 | * @note Synchronization level: Set by subclass |
kevman | 0:38ceb79fef03 | 40 | * @ingroup drivers |
kevman | 0:38ceb79fef03 | 41 | */ |
kevman | 0:38ceb79fef03 | 42 | class SerialBase : private NonCopyable<SerialBase> { |
kevman | 0:38ceb79fef03 | 43 | |
kevman | 0:38ceb79fef03 | 44 | public: |
kevman | 0:38ceb79fef03 | 45 | /** Set the baud rate of the serial port |
kevman | 0:38ceb79fef03 | 46 | * |
kevman | 0:38ceb79fef03 | 47 | * @param baudrate The baudrate of the serial port (default = 9600). |
kevman | 0:38ceb79fef03 | 48 | */ |
kevman | 0:38ceb79fef03 | 49 | void baud(int baudrate); |
kevman | 0:38ceb79fef03 | 50 | |
kevman | 0:38ceb79fef03 | 51 | enum Parity { |
kevman | 0:38ceb79fef03 | 52 | None = 0, |
kevman | 0:38ceb79fef03 | 53 | Odd, |
kevman | 0:38ceb79fef03 | 54 | Even, |
kevman | 0:38ceb79fef03 | 55 | Forced1, |
kevman | 0:38ceb79fef03 | 56 | Forced0 |
kevman | 0:38ceb79fef03 | 57 | }; |
kevman | 0:38ceb79fef03 | 58 | |
kevman | 0:38ceb79fef03 | 59 | enum IrqType { |
kevman | 0:38ceb79fef03 | 60 | RxIrq = 0, |
kevman | 0:38ceb79fef03 | 61 | TxIrq, |
kevman | 0:38ceb79fef03 | 62 | |
kevman | 0:38ceb79fef03 | 63 | IrqCnt |
kevman | 0:38ceb79fef03 | 64 | }; |
kevman | 0:38ceb79fef03 | 65 | |
kevman | 0:38ceb79fef03 | 66 | enum Flow { |
kevman | 0:38ceb79fef03 | 67 | Disabled = 0, |
kevman | 0:38ceb79fef03 | 68 | RTS, |
kevman | 0:38ceb79fef03 | 69 | CTS, |
kevman | 0:38ceb79fef03 | 70 | RTSCTS |
kevman | 0:38ceb79fef03 | 71 | }; |
kevman | 0:38ceb79fef03 | 72 | |
kevman | 0:38ceb79fef03 | 73 | /** Set the transmission format used by the serial port |
kevman | 0:38ceb79fef03 | 74 | * |
kevman | 0:38ceb79fef03 | 75 | * @param bits The number of bits in a word (5-8; default = 8) |
kevman | 0:38ceb79fef03 | 76 | * @param parity The parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None) |
kevman | 0:38ceb79fef03 | 77 | * @param stop_bits The number of stop bits (1 or 2; default = 1) |
kevman | 0:38ceb79fef03 | 78 | */ |
kevman | 0:38ceb79fef03 | 79 | void format(int bits = 8, Parity parity = SerialBase::None, int stop_bits = 1); |
kevman | 0:38ceb79fef03 | 80 | |
kevman | 0:38ceb79fef03 | 81 | /** Determine if there is a character available to read |
kevman | 0:38ceb79fef03 | 82 | * |
kevman | 0:38ceb79fef03 | 83 | * @returns |
kevman | 0:38ceb79fef03 | 84 | * 1 if there is a character available to read, |
kevman | 0:38ceb79fef03 | 85 | * 0 otherwise |
kevman | 0:38ceb79fef03 | 86 | */ |
kevman | 0:38ceb79fef03 | 87 | int readable(); |
kevman | 0:38ceb79fef03 | 88 | |
kevman | 0:38ceb79fef03 | 89 | /** Determine if there is space available to write a character |
kevman | 0:38ceb79fef03 | 90 | * |
kevman | 0:38ceb79fef03 | 91 | * @returns |
kevman | 0:38ceb79fef03 | 92 | * 1 if there is space to write a character, |
kevman | 0:38ceb79fef03 | 93 | * 0 otherwise |
kevman | 0:38ceb79fef03 | 94 | */ |
kevman | 0:38ceb79fef03 | 95 | int writeable(); |
kevman | 0:38ceb79fef03 | 96 | |
kevman | 0:38ceb79fef03 | 97 | /** Attach a function to call whenever a serial interrupt is generated |
kevman | 0:38ceb79fef03 | 98 | * |
kevman | 0:38ceb79fef03 | 99 | * @param func A pointer to a void function, or 0 to set as none |
kevman | 0:38ceb79fef03 | 100 | * @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty) |
kevman | 0:38ceb79fef03 | 101 | */ |
kevman | 0:38ceb79fef03 | 102 | void attach(Callback<void()> func, IrqType type = RxIrq); |
kevman | 0:38ceb79fef03 | 103 | |
kevman | 0:38ceb79fef03 | 104 | /** Attach a member function to call whenever a serial interrupt is generated |
kevman | 0:38ceb79fef03 | 105 | * |
kevman | 0:38ceb79fef03 | 106 | * @param obj pointer to the object to call the member function on |
kevman | 0:38ceb79fef03 | 107 | * @param method pointer to the member function to be called |
kevman | 0:38ceb79fef03 | 108 | * @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty) |
kevman | 0:38ceb79fef03 | 109 | * @deprecated |
kevman | 0:38ceb79fef03 | 110 | * The attach function does not support cv-qualifiers. Replaced by |
kevman | 0:38ceb79fef03 | 111 | * attach(callback(obj, method), type). |
kevman | 0:38ceb79fef03 | 112 | */ |
kevman | 0:38ceb79fef03 | 113 | template<typename T> |
kevman | 0:38ceb79fef03 | 114 | MBED_DEPRECATED_SINCE("mbed-os-5.1", |
kevman | 0:38ceb79fef03 | 115 | "The attach function does not support cv-qualifiers. Replaced by " |
kevman | 0:38ceb79fef03 | 116 | "attach(callback(obj, method), type).") |
kevman | 0:38ceb79fef03 | 117 | void attach(T *obj, void (T::*method)(), IrqType type = RxIrq) |
kevman | 0:38ceb79fef03 | 118 | { |
kevman | 0:38ceb79fef03 | 119 | attach(callback(obj, method), type); |
kevman | 0:38ceb79fef03 | 120 | } |
kevman | 0:38ceb79fef03 | 121 | |
kevman | 0:38ceb79fef03 | 122 | /** Attach a member function to call whenever a serial interrupt is generated |
kevman | 0:38ceb79fef03 | 123 | * |
kevman | 0:38ceb79fef03 | 124 | * @param obj pointer to the object to call the member function on |
kevman | 0:38ceb79fef03 | 125 | * @param method pointer to the member function to be called |
kevman | 0:38ceb79fef03 | 126 | * @param type Which serial interrupt to attach the member function to (Serial::RxIrq for receive, TxIrq for transmit buffer empty) |
kevman | 0:38ceb79fef03 | 127 | * @deprecated |
kevman | 0:38ceb79fef03 | 128 | * The attach function does not support cv-qualifiers. Replaced by |
kevman | 0:38ceb79fef03 | 129 | * attach(callback(obj, method), type). |
kevman | 0:38ceb79fef03 | 130 | */ |
kevman | 0:38ceb79fef03 | 131 | template<typename T> |
kevman | 0:38ceb79fef03 | 132 | MBED_DEPRECATED_SINCE("mbed-os-5.1", |
kevman | 0:38ceb79fef03 | 133 | "The attach function does not support cv-qualifiers. Replaced by " |
kevman | 0:38ceb79fef03 | 134 | "attach(callback(obj, method), type).") |
kevman | 0:38ceb79fef03 | 135 | void attach(T *obj, void (*method)(T *), IrqType type = RxIrq) |
kevman | 0:38ceb79fef03 | 136 | { |
kevman | 0:38ceb79fef03 | 137 | attach(callback(obj, method), type); |
kevman | 0:38ceb79fef03 | 138 | } |
kevman | 0:38ceb79fef03 | 139 | |
kevman | 0:38ceb79fef03 | 140 | /** Generate a break condition on the serial line |
kevman | 0:38ceb79fef03 | 141 | */ |
kevman | 0:38ceb79fef03 | 142 | void send_break(); |
kevman | 0:38ceb79fef03 | 143 | |
kevman | 0:38ceb79fef03 | 144 | protected: |
kevman | 0:38ceb79fef03 | 145 | |
kevman | 0:38ceb79fef03 | 146 | /** Acquire exclusive access to this serial port |
kevman | 0:38ceb79fef03 | 147 | */ |
kevman | 0:38ceb79fef03 | 148 | virtual void lock(void); |
kevman | 0:38ceb79fef03 | 149 | |
kevman | 0:38ceb79fef03 | 150 | /** Release exclusive access to this serial port |
kevman | 0:38ceb79fef03 | 151 | */ |
kevman | 0:38ceb79fef03 | 152 | virtual void unlock(void); |
kevman | 0:38ceb79fef03 | 153 | |
kevman | 0:38ceb79fef03 | 154 | public: |
kevman | 0:38ceb79fef03 | 155 | |
kevman | 0:38ceb79fef03 | 156 | #if DEVICE_SERIAL_FC |
kevman | 0:38ceb79fef03 | 157 | /** Set the flow control type on the serial port |
kevman | 0:38ceb79fef03 | 158 | * |
kevman | 0:38ceb79fef03 | 159 | * @param type the flow control type (Disabled, RTS, CTS, RTSCTS) |
kevman | 0:38ceb79fef03 | 160 | * @param flow1 the first flow control pin (RTS for RTS or RTSCTS, CTS for CTS) |
kevman | 0:38ceb79fef03 | 161 | * @param flow2 the second flow control pin (CTS for RTSCTS) |
kevman | 0:38ceb79fef03 | 162 | */ |
kevman | 0:38ceb79fef03 | 163 | void set_flow_control(Flow type, PinName flow1 = NC, PinName flow2 = NC); |
kevman | 0:38ceb79fef03 | 164 | #endif |
kevman | 0:38ceb79fef03 | 165 | |
kevman | 0:38ceb79fef03 | 166 | static void _irq_handler(uint32_t id, SerialIrq irq_type); |
kevman | 0:38ceb79fef03 | 167 | |
kevman | 0:38ceb79fef03 | 168 | #if DEVICE_SERIAL_ASYNCH |
kevman | 0:38ceb79fef03 | 169 | |
kevman | 0:38ceb79fef03 | 170 | /** Begin asynchronous write using 8bit buffer. The completion invokes registered TX event callback |
kevman | 0:38ceb79fef03 | 171 | * |
kevman | 0:38ceb79fef03 | 172 | * This function locks the deep sleep until any event has occurred |
kevman | 0:38ceb79fef03 | 173 | * |
kevman | 0:38ceb79fef03 | 174 | * @param buffer The buffer where received data will be stored |
kevman | 0:38ceb79fef03 | 175 | * @param length The buffer length in bytes |
kevman | 0:38ceb79fef03 | 176 | * @param callback The event callback function |
kevman | 0:38ceb79fef03 | 177 | * @param event The logical OR of TX events |
kevman | 0:38ceb79fef03 | 178 | */ |
kevman | 0:38ceb79fef03 | 179 | int write(const uint8_t *buffer, int length, const event_callback_t &callback, int event = SERIAL_EVENT_TX_COMPLETE); |
kevman | 0:38ceb79fef03 | 180 | |
kevman | 0:38ceb79fef03 | 181 | /** Begin asynchronous write using 16bit buffer. The completion invokes registered TX event callback |
kevman | 0:38ceb79fef03 | 182 | * |
kevman | 0:38ceb79fef03 | 183 | * This function locks the deep sleep until any event has occurred |
kevman | 0:38ceb79fef03 | 184 | * |
kevman | 0:38ceb79fef03 | 185 | * @param buffer The buffer where received data will be stored |
kevman | 0:38ceb79fef03 | 186 | * @param length The buffer length in bytes |
kevman | 0:38ceb79fef03 | 187 | * @param callback The event callback function |
kevman | 0:38ceb79fef03 | 188 | * @param event The logical OR of TX events |
kevman | 0:38ceb79fef03 | 189 | */ |
kevman | 0:38ceb79fef03 | 190 | int write(const uint16_t *buffer, int length, const event_callback_t &callback, int event = SERIAL_EVENT_TX_COMPLETE); |
kevman | 0:38ceb79fef03 | 191 | |
kevman | 0:38ceb79fef03 | 192 | /** Abort the on-going write transfer |
kevman | 0:38ceb79fef03 | 193 | */ |
kevman | 0:38ceb79fef03 | 194 | void abort_write(); |
kevman | 0:38ceb79fef03 | 195 | |
kevman | 0:38ceb79fef03 | 196 | /** Begin asynchronous reading using 8bit buffer. The completion invokes registered RX event callback. |
kevman | 0:38ceb79fef03 | 197 | * |
kevman | 0:38ceb79fef03 | 198 | * This function locks the deep sleep until any event has occurred |
kevman | 0:38ceb79fef03 | 199 | * |
kevman | 0:38ceb79fef03 | 200 | * @param buffer The buffer where received data will be stored |
kevman | 0:38ceb79fef03 | 201 | * @param length The buffer length in bytes |
kevman | 0:38ceb79fef03 | 202 | * @param callback The event callback function |
kevman | 0:38ceb79fef03 | 203 | * @param event The logical OR of RX events |
kevman | 0:38ceb79fef03 | 204 | * @param char_match The matching character |
kevman | 0:38ceb79fef03 | 205 | */ |
kevman | 0:38ceb79fef03 | 206 | 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); |
kevman | 0:38ceb79fef03 | 207 | |
kevman | 0:38ceb79fef03 | 208 | /** Begin asynchronous reading using 16bit buffer. The completion invokes registered RX event callback. |
kevman | 0:38ceb79fef03 | 209 | * |
kevman | 0:38ceb79fef03 | 210 | * This function locks the deep sleep until any event has occurred |
kevman | 0:38ceb79fef03 | 211 | * |
kevman | 0:38ceb79fef03 | 212 | * @param buffer The buffer where received data will be stored |
kevman | 0:38ceb79fef03 | 213 | * @param length The buffer length in bytes |
kevman | 0:38ceb79fef03 | 214 | * @param callback The event callback function |
kevman | 0:38ceb79fef03 | 215 | * @param event The logical OR of RX events |
kevman | 0:38ceb79fef03 | 216 | * @param char_match The matching character |
kevman | 0:38ceb79fef03 | 217 | */ |
kevman | 0:38ceb79fef03 | 218 | 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); |
kevman | 0:38ceb79fef03 | 219 | |
kevman | 0:38ceb79fef03 | 220 | /** Abort the on-going read transfer |
kevman | 0:38ceb79fef03 | 221 | */ |
kevman | 0:38ceb79fef03 | 222 | void abort_read(); |
kevman | 0:38ceb79fef03 | 223 | |
kevman | 0:38ceb79fef03 | 224 | /** Configure DMA usage suggestion for non-blocking TX transfers |
kevman | 0:38ceb79fef03 | 225 | * |
kevman | 0:38ceb79fef03 | 226 | * @param usage The usage DMA hint for peripheral |
kevman | 0:38ceb79fef03 | 227 | * @return Zero if the usage was set, -1 if a transaction is on-going |
kevman | 0:38ceb79fef03 | 228 | */ |
kevman | 0:38ceb79fef03 | 229 | int set_dma_usage_tx(DMAUsage usage); |
kevman | 0:38ceb79fef03 | 230 | |
kevman | 0:38ceb79fef03 | 231 | /** Configure DMA usage suggestion for non-blocking RX transfers |
kevman | 0:38ceb79fef03 | 232 | * |
kevman | 0:38ceb79fef03 | 233 | * @param usage The usage DMA hint for peripheral |
kevman | 0:38ceb79fef03 | 234 | * @return Zero if the usage was set, -1 if a transaction is on-going |
kevman | 0:38ceb79fef03 | 235 | */ |
kevman | 0:38ceb79fef03 | 236 | int set_dma_usage_rx(DMAUsage usage); |
kevman | 0:38ceb79fef03 | 237 | |
kevman | 0:38ceb79fef03 | 238 | protected: |
kevman | 0:38ceb79fef03 | 239 | void start_read(void *buffer, int buffer_size, char buffer_width, const event_callback_t &callback, int event, unsigned char char_match); |
kevman | 0:38ceb79fef03 | 240 | void start_write(const void *buffer, int buffer_size, char buffer_width, const event_callback_t &callback, int event); |
kevman | 0:38ceb79fef03 | 241 | void interrupt_handler_asynch(void); |
kevman | 0:38ceb79fef03 | 242 | #endif |
kevman | 0:38ceb79fef03 | 243 | |
kevman | 0:38ceb79fef03 | 244 | protected: |
kevman | 0:38ceb79fef03 | 245 | SerialBase(PinName tx, PinName rx, int baud); |
kevman | 0:38ceb79fef03 | 246 | virtual ~SerialBase(); |
kevman | 0:38ceb79fef03 | 247 | |
kevman | 0:38ceb79fef03 | 248 | int _base_getc(); |
kevman | 0:38ceb79fef03 | 249 | int _base_putc(int c); |
kevman | 0:38ceb79fef03 | 250 | |
kevman | 0:38ceb79fef03 | 251 | #if DEVICE_SERIAL_ASYNCH |
kevman | 0:38ceb79fef03 | 252 | CThunk<SerialBase> _thunk_irq; |
kevman | 0:38ceb79fef03 | 253 | DMAUsage _tx_usage; |
kevman | 0:38ceb79fef03 | 254 | DMAUsage _rx_usage; |
kevman | 0:38ceb79fef03 | 255 | event_callback_t _tx_callback; |
kevman | 0:38ceb79fef03 | 256 | event_callback_t _rx_callback; |
kevman | 0:38ceb79fef03 | 257 | #endif |
kevman | 0:38ceb79fef03 | 258 | |
kevman | 0:38ceb79fef03 | 259 | serial_t _serial; |
kevman | 0:38ceb79fef03 | 260 | Callback<void()> _irq[IrqCnt]; |
kevman | 0:38ceb79fef03 | 261 | int _baud; |
kevman | 0:38ceb79fef03 | 262 | |
kevman | 0:38ceb79fef03 | 263 | }; |
kevman | 0:38ceb79fef03 | 264 | |
kevman | 0:38ceb79fef03 | 265 | } // namespace mbed |
kevman | 0:38ceb79fef03 | 266 | |
kevman | 0:38ceb79fef03 | 267 | #endif |
kevman | 0:38ceb79fef03 | 268 | |
kevman | 0:38ceb79fef03 | 269 | #endif |