Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

serial_api.h@9:663789d7729f, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 09:41:56 2013 +0000
Revision:
9:663789d7729f
Parent:
8:c14af7958ef5 
Update mbed-KL25Z to latest build

Who changed what in which revision?

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