Ermanno Brusadin / mbed

mbed library sources

Dependents:   FRDM-KL46Z_LCD_Test FRDM-KL46Z_LCD_Test FRDM-KL46Z_Plantilla FRDM-KL46Z_Plantilla ... more

hal/serial_api.h@0:6bc4ac881c8e, 2016-07-28 (annotated)

Committer:
ebrus
Date:
Thu Jul 28 15:56:34 2016 +0000
Revision:
0:6bc4ac881c8e
1;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ebrus 0:6bc4ac881c8e 1 /* mbed Microcontroller Library
ebrus 0:6bc4ac881c8e 2 * Copyright (c) 2006-2013 ARM Limited
ebrus 0:6bc4ac881c8e 3 *
ebrus 0:6bc4ac881c8e 4 * Licensed under the Apache License, Version 2.0 (the "License");
ebrus 0:6bc4ac881c8e 5 * you may not use this file except in compliance with the License.
ebrus 0:6bc4ac881c8e 6 * You may obtain a copy of the License at
ebrus 0:6bc4ac881c8e 7 *
ebrus 0:6bc4ac881c8e 8 * http://www.apache.org/licenses/LICENSE-2.0
ebrus 0:6bc4ac881c8e 9 *
ebrus 0:6bc4ac881c8e 10 * Unless required by applicable law or agreed to in writing, software
ebrus 0:6bc4ac881c8e 11 * distributed under the License is distributed on an "AS IS" BASIS,
ebrus 0:6bc4ac881c8e 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ebrus 0:6bc4ac881c8e 13 * See the License for the specific language governing permissions and
ebrus 0:6bc4ac881c8e 14 * limitations under the License.
ebrus 0:6bc4ac881c8e 15 */
ebrus 0:6bc4ac881c8e 16 #ifndef MBED_SERIAL_API_H
ebrus 0:6bc4ac881c8e 17 #define MBED_SERIAL_API_H
ebrus 0:6bc4ac881c8e 18
ebrus 0:6bc4ac881c8e 19 #include "device.h"
ebrus 0:6bc4ac881c8e 20
ebrus 0:6bc4ac881c8e 21 #if DEVICE_SERIAL
ebrus 0:6bc4ac881c8e 22
ebrus 0:6bc4ac881c8e 23 #ifdef __cplusplus
ebrus 0:6bc4ac881c8e 24 extern "C" {
ebrus 0:6bc4ac881c8e 25 #endif
ebrus 0:6bc4ac881c8e 26
ebrus 0:6bc4ac881c8e 27 typedef enum {
ebrus 0:6bc4ac881c8e 28 ParityNone = 0,
ebrus 0:6bc4ac881c8e 29 ParityOdd = 1,
ebrus 0:6bc4ac881c8e 30 ParityEven = 2,
ebrus 0:6bc4ac881c8e 31 ParityForced1 = 3,
ebrus 0:6bc4ac881c8e 32 ParityForced0 = 4
ebrus 0:6bc4ac881c8e 33 } SerialParity;
ebrus 0:6bc4ac881c8e 34
ebrus 0:6bc4ac881c8e 35 typedef enum {
ebrus 0:6bc4ac881c8e 36 RxIrq,
ebrus 0:6bc4ac881c8e 37 TxIrq
ebrus 0:6bc4ac881c8e 38 } SerialIrq;
ebrus 0:6bc4ac881c8e 39
ebrus 0:6bc4ac881c8e 40 typedef enum {
ebrus 0:6bc4ac881c8e 41 FlowControlNone,
ebrus 0:6bc4ac881c8e 42 FlowControlRTS,
ebrus 0:6bc4ac881c8e 43 FlowControlCTS,
ebrus 0:6bc4ac881c8e 44 FlowControlRTSCTS
ebrus 0:6bc4ac881c8e 45 } FlowControl;
ebrus 0:6bc4ac881c8e 46
ebrus 0:6bc4ac881c8e 47 typedef void (*uart_irq_handler)(uint32_t id, SerialIrq event);
ebrus 0:6bc4ac881c8e 48
ebrus 0:6bc4ac881c8e 49 typedef struct serial_s serial_t;
ebrus 0:6bc4ac881c8e 50
ebrus 0:6bc4ac881c8e 51 void serial_init (serial_t *obj, PinName tx, PinName rx);
ebrus 0:6bc4ac881c8e 52 void serial_free (serial_t *obj);
ebrus 0:6bc4ac881c8e 53 void serial_baud (serial_t *obj, int baudrate);
ebrus 0:6bc4ac881c8e 54 void serial_format (serial_t *obj, int data_bits, SerialParity parity, int stop_bits);
ebrus 0:6bc4ac881c8e 55
ebrus 0:6bc4ac881c8e 56 void serial_irq_handler(serial_t *obj, uart_irq_handler handler, uint32_t id);
ebrus 0:6bc4ac881c8e 57 void serial_irq_set (serial_t *obj, SerialIrq irq, uint32_t enable);
ebrus 0:6bc4ac881c8e 58
ebrus 0:6bc4ac881c8e 59 int serial_getc (serial_t *obj);
ebrus 0:6bc4ac881c8e 60 void serial_putc (serial_t *obj, int c);
ebrus 0:6bc4ac881c8e 61 int serial_readable (serial_t *obj);
ebrus 0:6bc4ac881c8e 62 int serial_writable (serial_t *obj);
ebrus 0:6bc4ac881c8e 63 void serial_clear (serial_t *obj);
ebrus 0:6bc4ac881c8e 64
ebrus 0:6bc4ac881c8e 65 void serial_break_set (serial_t *obj);
ebrus 0:6bc4ac881c8e 66 void serial_break_clear(serial_t *obj);
ebrus 0:6bc4ac881c8e 67
ebrus 0:6bc4ac881c8e 68 void serial_pinout_tx(PinName tx);
ebrus 0:6bc4ac881c8e 69
ebrus 0:6bc4ac881c8e 70 void serial_set_flow_control(serial_t *obj, FlowControl type, PinName rxflow, PinName txflow);
ebrus 0:6bc4ac881c8e 71
ebrus 0:6bc4ac881c8e 72 #ifdef __cplusplus
ebrus 0:6bc4ac881c8e 73 }
ebrus 0:6bc4ac881c8e 74 #endif
ebrus 0:6bc4ac881c8e 75
ebrus 0:6bc4ac881c8e 76 #endif
ebrus 0:6bc4ac881c8e 77
ebrus 0:6bc4ac881c8e 78 #endif