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

hal/serial_api.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
dkato 0:f782d9c66c49 2 /** \addtogroup hal */
dkato 0:f782d9c66c49 3 /** @{*/
dkato 0:f782d9c66c49 4 /* mbed Microcontroller Library
dkato 0:f782d9c66c49 5 * Copyright (c) 2006-2013 ARM Limited
dkato 0:f782d9c66c49 6 *
dkato 0:f782d9c66c49 7 * Licensed under the Apache License, Version 2.0 (the "License");
dkato 0:f782d9c66c49 8 * you may not use this file except in compliance with the License.
dkato 0:f782d9c66c49 9 * You may obtain a copy of the License at
dkato 0:f782d9c66c49 10 *
dkato 0:f782d9c66c49 11 * http://www.apache.org/licenses/LICENSE-2.0
dkato 0:f782d9c66c49 12 *
dkato 0:f782d9c66c49 13 * Unless required by applicable law or agreed to in writing, software
dkato 0:f782d9c66c49 14 * distributed under the License is distributed on an "AS IS" BASIS,
dkato 0:f782d9c66c49 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
dkato 0:f782d9c66c49 16 * See the License for the specific language governing permissions and
dkato 0:f782d9c66c49 17 * limitations under the License.
dkato 0:f782d9c66c49 18 */
dkato 0:f782d9c66c49 19 #ifndef MBED_SERIAL_API_H
dkato 0:f782d9c66c49 20 #define MBED_SERIAL_API_H
dkato 0:f782d9c66c49 21
dkato 0:f782d9c66c49 22 #include "device.h"
dkato 0:f782d9c66c49 23 #include "hal/buffer.h"
dkato 0:f782d9c66c49 24 #include "hal/dma_api.h"
dkato 0:f782d9c66c49 25
dkato 0:f782d9c66c49 26 #if DEVICE_SERIAL
dkato 0:f782d9c66c49 27
dkato 0:f782d9c66c49 28 #define SERIAL_EVENT_TX_SHIFT (2)
dkato 0:f782d9c66c49 29 #define SERIAL_EVENT_RX_SHIFT (8)
dkato 0:f782d9c66c49 30
dkato 0:f782d9c66c49 31 #define SERIAL_EVENT_TX_MASK (0x00FC)
dkato 0:f782d9c66c49 32 #define SERIAL_EVENT_RX_MASK (0x3F00)
dkato 0:f782d9c66c49 33
dkato 0:f782d9c66c49 34 #define SERIAL_EVENT_ERROR (1 << 1)
dkato 0:f782d9c66c49 35
dkato 0:f782d9c66c49 36 /**
dkato 0:f782d9c66c49 37 * @defgroup SerialTXEvents Serial TX Events Macros
dkato 0:f782d9c66c49 38 *
dkato 0:f782d9c66c49 39 * @{
dkato 0:f782d9c66c49 40 */
dkato 0:f782d9c66c49 41 #define SERIAL_EVENT_TX_COMPLETE (1 << (SERIAL_EVENT_TX_SHIFT + 0))
dkato 0:f782d9c66c49 42 #define SERIAL_EVENT_TX_ALL (SERIAL_EVENT_TX_COMPLETE)
dkato 0:f782d9c66c49 43 /**@}*/
dkato 0:f782d9c66c49 44
dkato 0:f782d9c66c49 45 /**
dkato 0:f782d9c66c49 46 * @defgroup SerialRXEvents Serial RX Events Macros
dkato 0:f782d9c66c49 47 *
dkato 0:f782d9c66c49 48 * @{
dkato 0:f782d9c66c49 49 */
dkato 0:f782d9c66c49 50 #define SERIAL_EVENT_RX_COMPLETE (1 << (SERIAL_EVENT_RX_SHIFT + 0))
dkato 0:f782d9c66c49 51 #define SERIAL_EVENT_RX_OVERRUN_ERROR (1 << (SERIAL_EVENT_RX_SHIFT + 1))
dkato 0:f782d9c66c49 52 #define SERIAL_EVENT_RX_FRAMING_ERROR (1 << (SERIAL_EVENT_RX_SHIFT + 2))
dkato 0:f782d9c66c49 53 #define SERIAL_EVENT_RX_PARITY_ERROR (1 << (SERIAL_EVENT_RX_SHIFT + 3))
dkato 0:f782d9c66c49 54 #define SERIAL_EVENT_RX_OVERFLOW (1 << (SERIAL_EVENT_RX_SHIFT + 4))
dkato 0:f782d9c66c49 55 #define SERIAL_EVENT_RX_CHARACTER_MATCH (1 << (SERIAL_EVENT_RX_SHIFT + 5))
dkato 0:f782d9c66c49 56 #define SERIAL_EVENT_RX_ALL (SERIAL_EVENT_RX_OVERFLOW | SERIAL_EVENT_RX_PARITY_ERROR | \
dkato 0:f782d9c66c49 57 SERIAL_EVENT_RX_FRAMING_ERROR | SERIAL_EVENT_RX_OVERRUN_ERROR | \
dkato 0:f782d9c66c49 58 SERIAL_EVENT_RX_COMPLETE | SERIAL_EVENT_RX_CHARACTER_MATCH)
dkato 0:f782d9c66c49 59 /**@}*/
dkato 0:f782d9c66c49 60
dkato 0:f782d9c66c49 61 #define SERIAL_RESERVED_CHAR_MATCH (255)
dkato 0:f782d9c66c49 62
dkato 0:f782d9c66c49 63 typedef enum {
dkato 0:f782d9c66c49 64 ParityNone = 0,
dkato 0:f782d9c66c49 65 ParityOdd = 1,
dkato 0:f782d9c66c49 66 ParityEven = 2,
dkato 0:f782d9c66c49 67 ParityForced1 = 3,
dkato 0:f782d9c66c49 68 ParityForced0 = 4
dkato 0:f782d9c66c49 69 } SerialParity;
dkato 0:f782d9c66c49 70
dkato 0:f782d9c66c49 71 typedef enum {
dkato 0:f782d9c66c49 72 RxIrq,
dkato 0:f782d9c66c49 73 TxIrq
dkato 0:f782d9c66c49 74 } SerialIrq;
dkato 0:f782d9c66c49 75
dkato 0:f782d9c66c49 76 typedef enum {
dkato 0:f782d9c66c49 77 FlowControlNone,
dkato 0:f782d9c66c49 78 FlowControlRTS,
dkato 0:f782d9c66c49 79 FlowControlCTS,
dkato 0:f782d9c66c49 80 FlowControlRTSCTS
dkato 0:f782d9c66c49 81 } FlowControl;
dkato 0:f782d9c66c49 82
dkato 0:f782d9c66c49 83 typedef void (*uart_irq_handler)(uint32_t id, SerialIrq event);
dkato 0:f782d9c66c49 84
dkato 0:f782d9c66c49 85 #if DEVICE_SERIAL_ASYNCH
dkato 0:f782d9c66c49 86 /** Asynch serial HAL structure
dkato 0:f782d9c66c49 87 */
dkato 0:f782d9c66c49 88 typedef struct {
dkato 0:f782d9c66c49 89 struct serial_s serial; /**< Target specific serial structure */
dkato 0:f782d9c66c49 90 struct buffer_s tx_buff; /**< TX buffer */
dkato 0:f782d9c66c49 91 struct buffer_s rx_buff; /**< RX buffer */
dkato 0:f782d9c66c49 92 uint8_t char_match; /**< Character to be matched */
dkato 0:f782d9c66c49 93 uint8_t char_found; /**< State of the matched character */
dkato 0:f782d9c66c49 94 } serial_t;
dkato 0:f782d9c66c49 95
dkato 0:f782d9c66c49 96 #else
dkato 0:f782d9c66c49 97 /** Non-asynch serial HAL structure
dkato 0:f782d9c66c49 98 */
dkato 0:f782d9c66c49 99 typedef struct serial_s serial_t;
dkato 0:f782d9c66c49 100
dkato 0:f782d9c66c49 101 #endif
dkato 0:f782d9c66c49 102
dkato 0:f782d9c66c49 103 #ifdef __cplusplus
dkato 0:f782d9c66c49 104 extern "C" {
dkato 0:f782d9c66c49 105 #endif
dkato 0:f782d9c66c49 106
dkato 0:f782d9c66c49 107 /**
dkato 0:f782d9c66c49 108 * \defgroup hal_GeneralSerial Serial Configuration Functions
dkato 0:f782d9c66c49 109 * @{
dkato 0:f782d9c66c49 110 */
dkato 0:f782d9c66c49 111
dkato 0:f782d9c66c49 112 /** Initialize the serial peripheral. It sets the default parameters for serial
dkato 0:f782d9c66c49 113 * peripheral, and configures its specifieds pins.
dkato 0:f782d9c66c49 114 *
dkato 0:f782d9c66c49 115 * @param obj The serial object
dkato 0:f782d9c66c49 116 * @param tx The TX pin name
dkato 0:f782d9c66c49 117 * @param rx The RX pin name
dkato 0:f782d9c66c49 118 */
dkato 0:f782d9c66c49 119 void serial_init(serial_t *obj, PinName tx, PinName rx);
dkato 0:f782d9c66c49 120
dkato 0:f782d9c66c49 121 /** Release the serial peripheral, not currently invoked. It requires further
dkato 0:f782d9c66c49 122 * resource management.
dkato 0:f782d9c66c49 123 *
dkato 0:f782d9c66c49 124 * @param obj The serial object
dkato 0:f782d9c66c49 125 */
dkato 0:f782d9c66c49 126 void serial_free(serial_t *obj);
dkato 0:f782d9c66c49 127
dkato 0:f782d9c66c49 128 /** Configure the baud rate
dkato 0:f782d9c66c49 129 *
dkato 0:f782d9c66c49 130 * @param obj The serial object
dkato 0:f782d9c66c49 131 * @param baudrate The baud rate to be configured
dkato 0:f782d9c66c49 132 */
dkato 0:f782d9c66c49 133 void serial_baud(serial_t *obj, int baudrate);
dkato 0:f782d9c66c49 134
dkato 0:f782d9c66c49 135 /** Configure the format. Set the number of bits, parity and the number of stop bits
dkato 0:f782d9c66c49 136 *
dkato 0:f782d9c66c49 137 * @param obj The serial object
dkato 0:f782d9c66c49 138 * @param data_bits The number of data bits
dkato 0:f782d9c66c49 139 * @param parity The parity
dkato 0:f782d9c66c49 140 * @param stop_bits The number of stop bits
dkato 0:f782d9c66c49 141 */
dkato 0:f782d9c66c49 142 void serial_format(serial_t *obj, int data_bits, SerialParity parity, int stop_bits);
dkato 0:f782d9c66c49 143
dkato 0:f782d9c66c49 144 /** The serial interrupt handler registration
dkato 0:f782d9c66c49 145 *
dkato 0:f782d9c66c49 146 * @param obj The serial object
dkato 0:f782d9c66c49 147 * @param handler The interrupt handler which will be invoked when the interrupt fires
dkato 0:f782d9c66c49 148 * @param id The SerialBase object
dkato 0:f782d9c66c49 149 */
dkato 0:f782d9c66c49 150 void serial_irq_handler(serial_t *obj, uart_irq_handler handler, uint32_t id);
dkato 0:f782d9c66c49 151
dkato 0:f782d9c66c49 152 /** Configure serial interrupt. This function is used for word-approach
dkato 0:f782d9c66c49 153 *
dkato 0:f782d9c66c49 154 * @param obj The serial object
dkato 0:f782d9c66c49 155 * @param irq The serial IRQ type (RX or TX)
dkato 0:f782d9c66c49 156 * @param enable Set to non-zero to enable events, or zero to disable them
dkato 0:f782d9c66c49 157 */
dkato 0:f782d9c66c49 158 void serial_irq_set(serial_t *obj, SerialIrq irq, uint32_t enable);
dkato 0:f782d9c66c49 159
dkato 0:f782d9c66c49 160 /** Get character. This is a blocking call, waiting for a character
dkato 0:f782d9c66c49 161 *
dkato 0:f782d9c66c49 162 * @param obj The serial object
dkato 0:f782d9c66c49 163 */
dkato 0:f782d9c66c49 164 int serial_getc(serial_t *obj);
dkato 0:f782d9c66c49 165
dkato 0:f782d9c66c49 166 /** Send a character. This is a blocking call, waiting for a peripheral to be available
dkato 0:f782d9c66c49 167 * for writing
dkato 0:f782d9c66c49 168 *
dkato 0:f782d9c66c49 169 * @param obj The serial object
dkato 0:f782d9c66c49 170 * @param c The character to be sent
dkato 0:f782d9c66c49 171 */
dkato 0:f782d9c66c49 172 void serial_putc(serial_t *obj, int c);
dkato 0:f782d9c66c49 173
dkato 0:f782d9c66c49 174 /** Check if the serial peripheral is readable
dkato 0:f782d9c66c49 175 *
dkato 0:f782d9c66c49 176 * @param obj The serial object
dkato 0:f782d9c66c49 177 * @return Non-zero value if a character can be read, 0 if nothing to read
dkato 0:f782d9c66c49 178 */
dkato 0:f782d9c66c49 179 int serial_readable(serial_t *obj);
dkato 0:f782d9c66c49 180
dkato 0:f782d9c66c49 181 /** Check if the serial peripheral is writable
dkato 0:f782d9c66c49 182 *
dkato 0:f782d9c66c49 183 * @param obj The serial object
dkato 0:f782d9c66c49 184 * @return Non-zero value if a character can be written, 0 otherwise.
dkato 0:f782d9c66c49 185 */
dkato 0:f782d9c66c49 186 int serial_writable(serial_t *obj);
dkato 0:f782d9c66c49 187
dkato 0:f782d9c66c49 188 /** Clear the serial peripheral
dkato 0:f782d9c66c49 189 *
dkato 0:f782d9c66c49 190 * @param obj The serial object
dkato 0:f782d9c66c49 191 */
dkato 0:f782d9c66c49 192 void serial_clear(serial_t *obj);
dkato 0:f782d9c66c49 193
dkato 0:f782d9c66c49 194 /** Set the break
dkato 0:f782d9c66c49 195 *
dkato 0:f782d9c66c49 196 * @param obj The serial object
dkato 0:f782d9c66c49 197 */
dkato 0:f782d9c66c49 198 void serial_break_set(serial_t *obj);
dkato 0:f782d9c66c49 199
dkato 0:f782d9c66c49 200 /** Clear the break
dkato 0:f782d9c66c49 201 *
dkato 0:f782d9c66c49 202 * @param obj The serial object
dkato 0:f782d9c66c49 203 */
dkato 0:f782d9c66c49 204 void serial_break_clear(serial_t *obj);
dkato 0:f782d9c66c49 205
dkato 0:f782d9c66c49 206 /** Configure the TX pin for UART function.
dkato 0:f782d9c66c49 207 *
dkato 0:f782d9c66c49 208 * @param tx The pin name used for TX
dkato 0:f782d9c66c49 209 */
dkato 0:f782d9c66c49 210 void serial_pinout_tx(PinName tx);
dkato 0:f782d9c66c49 211
dkato 0:f782d9c66c49 212 /** Configure the serial for the flow control. It sets flow control in the hardware
dkato 0:f782d9c66c49 213 * if a serial peripheral supports it, otherwise software emulation is used.
dkato 0:f782d9c66c49 214 *
dkato 0:f782d9c66c49 215 * @param obj The serial object
dkato 0:f782d9c66c49 216 * @param type The type of the flow control. Look at the available FlowControl types.
dkato 0:f782d9c66c49 217 * @param rxflow The TX pin name
dkato 0:f782d9c66c49 218 * @param txflow The RX pin name
dkato 0:f782d9c66c49 219 */
dkato 0:f782d9c66c49 220 void serial_set_flow_control(serial_t *obj, FlowControl type, PinName rxflow, PinName txflow);
dkato 0:f782d9c66c49 221
dkato 0:f782d9c66c49 222 #if DEVICE_SERIAL_ASYNCH
dkato 0:f782d9c66c49 223
dkato 0:f782d9c66c49 224 /**@}*/
dkato 0:f782d9c66c49 225
dkato 0:f782d9c66c49 226 /**
dkato 0:f782d9c66c49 227 * \defgroup hal_AsynchSerial Asynchronous Serial Hardware Abstraction Layer
dkato 0:f782d9c66c49 228 * @{
dkato 0:f782d9c66c49 229 */
dkato 0:f782d9c66c49 230
dkato 0:f782d9c66c49 231 /** Begin asynchronous TX transfer. The used buffer is specified in the serial object,
dkato 0:f782d9c66c49 232 * tx_buff
dkato 0:f782d9c66c49 233 *
dkato 0:f782d9c66c49 234 * @param obj The serial object
dkato 0:f782d9c66c49 235 * @param tx The transmit buffer
dkato 0:f782d9c66c49 236 * @param tx_length The number of bytes to transmit
dkato 0:f782d9c66c49 237 * @param tx_width Deprecated argument
dkato 0:f782d9c66c49 238 * @param handler The serial handler
dkato 0:f782d9c66c49 239 * @param event The logical OR of events to be registered
dkato 0:f782d9c66c49 240 * @param hint A suggestion for how to use DMA with this transfer
dkato 0:f782d9c66c49 241 * @return Returns number of data transfered, otherwise returns 0
dkato 0:f782d9c66c49 242 */
dkato 0:f782d9c66c49 243 int serial_tx_asynch(serial_t *obj, const void *tx, size_t tx_length, uint8_t tx_width, uint32_t handler, uint32_t event, DMAUsage hint);
dkato 0:f782d9c66c49 244
dkato 0:f782d9c66c49 245 /** Begin asynchronous RX transfer (enable interrupt for data collecting)
dkato 0:f782d9c66c49 246 * The used buffer is specified in the serial object - rx_buff
dkato 0:f782d9c66c49 247 *
dkato 0:f782d9c66c49 248 * @param obj The serial object
dkato 0:f782d9c66c49 249 * @param rx The receive buffer
dkato 0:f782d9c66c49 250 * @param rx_length The number of bytes to receive
dkato 0:f782d9c66c49 251 * @param rx_width Deprecated argument
dkato 0:f782d9c66c49 252 * @param handler The serial handler
dkato 0:f782d9c66c49 253 * @param event The logical OR of events to be registered
dkato 0:f782d9c66c49 254 * @param handler The serial handler
dkato 0:f782d9c66c49 255 * @param char_match A character in range 0-254 to be matched
dkato 0:f782d9c66c49 256 * @param hint A suggestion for how to use DMA with this transfer
dkato 0:f782d9c66c49 257 */
dkato 0:f782d9c66c49 258 void serial_rx_asynch(serial_t *obj, void *rx, size_t rx_length, uint8_t rx_width, uint32_t handler, uint32_t event, uint8_t char_match, DMAUsage hint);
dkato 0:f782d9c66c49 259
dkato 0:f782d9c66c49 260 /** Attempts to determine if the serial peripheral is already in use for TX
dkato 0:f782d9c66c49 261 *
dkato 0:f782d9c66c49 262 * @param obj The serial object
dkato 0:f782d9c66c49 263 * @return Non-zero if the RX transaction is ongoing, 0 otherwise
dkato 0:f782d9c66c49 264 */
dkato 0:f782d9c66c49 265 uint8_t serial_tx_active(serial_t *obj);
dkato 0:f782d9c66c49 266
dkato 0:f782d9c66c49 267 /** Attempts to determine if the serial peripheral is already in use for RX
dkato 0:f782d9c66c49 268 *
dkato 0:f782d9c66c49 269 * @param obj The serial object
dkato 0:f782d9c66c49 270 * @return Non-zero if the RX transaction is ongoing, 0 otherwise
dkato 0:f782d9c66c49 271 */
dkato 0:f782d9c66c49 272 uint8_t serial_rx_active(serial_t *obj);
dkato 0:f782d9c66c49 273
dkato 0:f782d9c66c49 274 /** The asynchronous TX and RX handler.
dkato 0:f782d9c66c49 275 *
dkato 0:f782d9c66c49 276 * @param obj The serial object
dkato 0:f782d9c66c49 277 * @return Returns event flags if an RX transfer termination condition was met; otherwise returns 0
dkato 0:f782d9c66c49 278 */
dkato 0:f782d9c66c49 279 int serial_irq_handler_asynch(serial_t *obj);
dkato 0:f782d9c66c49 280
dkato 0:f782d9c66c49 281 /** Abort the ongoing TX transaction. It disables the enabled interupt for TX and
dkato 0:f782d9c66c49 282 * flushes the TX hardware buffer if TX FIFO is used
dkato 0:f782d9c66c49 283 *
dkato 0:f782d9c66c49 284 * @param obj The serial object
dkato 0:f782d9c66c49 285 */
dkato 0:f782d9c66c49 286 void serial_tx_abort_asynch(serial_t *obj);
dkato 0:f782d9c66c49 287
dkato 0:f782d9c66c49 288 /** Abort the ongoing RX transaction. It disables the enabled interrupt for RX and
dkato 0:f782d9c66c49 289 * flushes the RX hardware buffer if RX FIFO is used
dkato 0:f782d9c66c49 290 *
dkato 0:f782d9c66c49 291 * @param obj The serial object
dkato 0:f782d9c66c49 292 */
dkato 0:f782d9c66c49 293 void serial_rx_abort_asynch(serial_t *obj);
dkato 0:f782d9c66c49 294
dkato 0:f782d9c66c49 295 /**@}*/
dkato 0:f782d9c66c49 296
dkato 0:f782d9c66c49 297 #endif
dkato 0:f782d9c66c49 298
dkato 0:f782d9c66c49 299 #ifdef __cplusplus
dkato 0:f782d9c66c49 300 }
dkato 0:f782d9c66c49 301 #endif
dkato 0:f782d9c66c49 302
dkato 0:f782d9c66c49 303 #endif
dkato 0:f782d9c66c49 304
dkato 0:f782d9c66c49 305 #endif
dkato 0:f782d9c66c49 306
dkato 0:f782d9c66c49 307 /** @}*/