mbed library sources
Fork of mbed-src by
capi/serial_api.h
- Committer:
- mbed_official
- Date:
- 2012-11-20
- Revision:
- 0:fd0d7bdfcdc2
- Child:
- 1:62685faffa05
File content as of revision 0:fd0d7bdfcdc2:
/* mbed Microcontroller Library * Copyright (c) 2006-2012 ARM Limited * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ #ifndef MBED_SERIAL_API_H #define MBED_SERIAL_API_H #include "device.h" #if DEVICE_SERIAL #ifdef __cplusplus extern "C" { #endif typedef enum { ParityNone = 0, ParityOdd = 1, ParityEven = 2, ParityForced1 = 3, ParityForced0 = 4 } SerialParity; typedef enum { TxIrq, RxIrq } SerialIrq; typedef void (*uart_irq_handler)(uint32_t id, SerialIrq event); typedef struct serial_s serial_t; void serial_init (serial_t *obj, PinName tx, PinName rx); void serial_free (serial_t *obj); void serial_baud (serial_t *obj, int baudrate); void serial_format (serial_t *obj, int data_bits, SerialParity parity, int stop_bits); void serial_irq_handler(serial_t *obj, uart_irq_handler handler, uint32_t id); void serial_irq_set (serial_t *obj, SerialIrq irq, uint32_t enable); int serial_getc (serial_t *obj); void serial_putc (serial_t *obj, int c); int serial_readable (serial_t *obj); int serial_writable (serial_t *obj); void serial_clear (serial_t *obj); void serial_pinout_tx(PinName tx); #ifdef __cplusplus } #endif #endif #endif