marcus chiou / mbed-src

mbed library sources

Fork of mbed-src by mbed official

capi/serial_api.h@2:143cac498751, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 11:44:18 2013 +0000
Revision:
2:143cac498751
Parent:
1:62685faffa05 
Update mbed sources to Rev 59

Who changed what in which revision?

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