song zhao / smartball_project_test_board

to cai

Dependencies:   BLE_API nRF51822

Fork of BLE_NODE_TEST by Yihui Xiong

mbed-src/hal/serial_api.h@9:05f0b5a3a70a, 2014-10-29 (annotated)

Committer:
yihui
Date:
Wed Oct 29 06:23:47 2014 +0000
Revision:
9:05f0b5a3a70a
initial

Who changed what in which revision?

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