test / mbed-src

mbed library sources

Dependents:   bare

Fork of mbed-src by mbed official

hal/serial_api.h@134:06c344ebdfe8, 2014-03-27 (annotated)

Committer:
koiamk
Date:
Thu Mar 27 22:43:30 2014 +0000
Revision:
134:06c344ebdfe8
Parent:
64:7b352733b00a 
oo

Who changed what in which revision?

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