Knight KE / Mbed OS Game_Master

游戏王对战板，目前code还是空的

mbed-os/hal/serial_api.h@0:9b3d4731edbb, 2018-06-21 (annotated)

Committer:
WFKnight
Date:
Thu Jun 21 13:51:43 2018 +0000
Revision:
0:9b3d4731edbb
UART, RTOS, LED

Who changed what in which revision?

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