takashi kadono / Mbed OS Nucleo_446

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/drivers/SerialBase.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

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