Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/hal/serial_api.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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