SDK Development / mbed-src

mbed SDK library sources

Fork of mbed-src by mbed official

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Last commit 20 Feb 2019 by mbed official

hal/serial_api.h@10:3bc89ef62ce7, 2013-06-14 (annotated)

Committer:
emilmont
Date:
Fri Jun 14 17:49:17 2013 +0100
Revision:
10:3bc89ef62ce7
Parent:
9:0ce32e54c9a7
Child:
13:0645d8841f51
Unify mbed library sources

Who changed what in which revision?

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