jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

serial_api.h@54:71b101360fb9, 2013-01-08 (annotated)

Committer:
emilmont
Date:
Tue Jan 08 12:46:36 2013 +0000
Revision:
54:71b101360fb9
Parent:
45:3d775a932e1d
Child:
55:d722ed6a4237
Support "stream as file" use case

Unify binary libraries

Update copyright

Who changed what in which revision?

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