Jonathan Piat / mbed-src

mbed library sources

Fork of mbed-src by mbed official

capi/serial_api.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
1:62685faffa05
mbed sources

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 0:fd0d7bdfcdc2 1 /* mbed Microcontroller Library
mbed_official 0:fd0d7bdfcdc2 2 * Copyright (c) 2006-2012 ARM Limited
mbed_official 0:fd0d7bdfcdc2 3 *
mbed_official 0:fd0d7bdfcdc2 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
mbed_official 0:fd0d7bdfcdc2 5 * of this software and associated documentation files (the "Software"), to deal
mbed_official 0:fd0d7bdfcdc2 6 * in the Software without restriction, including without limitation the rights
mbed_official 0:fd0d7bdfcdc2 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
mbed_official 0:fd0d7bdfcdc2 8 * copies of the Software, and to permit persons to whom the Software is
mbed_official 0:fd0d7bdfcdc2 9 * furnished to do so, subject to the following conditions:
mbed_official 0:fd0d7bdfcdc2 10 *
mbed_official 0:fd0d7bdfcdc2 11 * The above copyright notice and this permission notice shall be included in
mbed_official 0:fd0d7bdfcdc2 12 * all copies or substantial portions of the Software.
mbed_official 0:fd0d7bdfcdc2 13 *
mbed_official 0:fd0d7bdfcdc2 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
mbed_official 0:fd0d7bdfcdc2 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
mbed_official 0:fd0d7bdfcdc2 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
mbed_official 0:fd0d7bdfcdc2 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
mbed_official 0:fd0d7bdfcdc2 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:fd0d7bdfcdc2 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
mbed_official 0:fd0d7bdfcdc2 20 * SOFTWARE.
mbed_official 0:fd0d7bdfcdc2 21 */
mbed_official 0:fd0d7bdfcdc2 22 #ifndef MBED_SERIAL_API_H
mbed_official 0:fd0d7bdfcdc2 23 #define MBED_SERIAL_API_H
mbed_official 0:fd0d7bdfcdc2 24
mbed_official 0:fd0d7bdfcdc2 25 #include "device.h"
mbed_official 0:fd0d7bdfcdc2 26
mbed_official 0:fd0d7bdfcdc2 27 #if DEVICE_SERIAL
mbed_official 0:fd0d7bdfcdc2 28
mbed_official 0:fd0d7bdfcdc2 29 #ifdef __cplusplus
mbed_official 0:fd0d7bdfcdc2 30 extern "C" {
mbed_official 0:fd0d7bdfcdc2 31 #endif
mbed_official 0:fd0d7bdfcdc2 32
mbed_official 0:fd0d7bdfcdc2 33 typedef enum {
mbed_official 0:fd0d7bdfcdc2 34 ParityNone = 0,
mbed_official 0:fd0d7bdfcdc2 35 ParityOdd = 1,
mbed_official 0:fd0d7bdfcdc2 36 ParityEven = 2,
mbed_official 0:fd0d7bdfcdc2 37 ParityForced1 = 3,
mbed_official 0:fd0d7bdfcdc2 38 ParityForced0 = 4
mbed_official 0:fd0d7bdfcdc2 39 } SerialParity;
mbed_official 0:fd0d7bdfcdc2 40
mbed_official 0:fd0d7bdfcdc2 41 typedef enum {
mbed_official 0:fd0d7bdfcdc2 42 TxIrq,
mbed_official 0:fd0d7bdfcdc2 43 RxIrq
mbed_official 0:fd0d7bdfcdc2 44 } SerialIrq;
mbed_official 0:fd0d7bdfcdc2 45
mbed_official 0:fd0d7bdfcdc2 46 typedef void (*uart_irq_handler)(uint32_t id, SerialIrq event);
mbed_official 0:fd0d7bdfcdc2 47
mbed_official 0:fd0d7bdfcdc2 48 typedef struct serial_s serial_t;
mbed_official 0:fd0d7bdfcdc2 49
mbed_official 0:fd0d7bdfcdc2 50 void serial_init (serial_t *obj, PinName tx, PinName rx);
mbed_official 0:fd0d7bdfcdc2 51 void serial_free (serial_t *obj);
mbed_official 0:fd0d7bdfcdc2 52 void serial_baud (serial_t *obj, int baudrate);
mbed_official 0:fd0d7bdfcdc2 53 void serial_format (serial_t *obj, int data_bits, SerialParity parity, int stop_bits);
mbed_official 0:fd0d7bdfcdc2 54
mbed_official 0:fd0d7bdfcdc2 55 void serial_irq_handler(serial_t *obj, uart_irq_handler handler, uint32_t id);
mbed_official 0:fd0d7bdfcdc2 56 void serial_irq_set (serial_t *obj, SerialIrq irq, uint32_t enable);
mbed_official 0:fd0d7bdfcdc2 57
mbed_official 0:fd0d7bdfcdc2 58 int serial_getc (serial_t *obj);
mbed_official 0:fd0d7bdfcdc2 59 void serial_putc (serial_t *obj, int c);
mbed_official 0:fd0d7bdfcdc2 60 int serial_readable (serial_t *obj);
mbed_official 0:fd0d7bdfcdc2 61 int serial_writable (serial_t *obj);
mbed_official 0:fd0d7bdfcdc2 62 void serial_clear (serial_t *obj);
mbed_official 0:fd0d7bdfcdc2 63
mbed_official 0:fd0d7bdfcdc2 64 void serial_pinout_tx(PinName tx);
mbed_official 0:fd0d7bdfcdc2 65
mbed_official 0:fd0d7bdfcdc2 66 #ifdef __cplusplus
mbed_official 0:fd0d7bdfcdc2 67 }
mbed_official 0:fd0d7bdfcdc2 68 #endif
mbed_official 0:fd0d7bdfcdc2 69
mbed_official 0:fd0d7bdfcdc2 70 #endif
mbed_official 0:fd0d7bdfcdc2 71
mbed_official 0:fd0d7bdfcdc2 72 #endif