Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

drivers/SerialBase.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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