Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
mbed/serial_api.h@0:dd0fea342ad2, 2015-03-08 (annotated)
- Committer:
 - gkroussos
 - Date:
 - Sun Mar 08 19:42:20 2015 +0000
 - Revision:
 - 0:dd0fea342ad2
 
BLE Temperature Service ; Mobile and Ubiquitous Computing Module; Birkbeck College
Who changed what in which revision?
| User | Revision | Line number | New contents of line | 
|---|---|---|---|
| gkroussos | 0:dd0fea342ad2 | 1 | /* mbed Microcontroller Library | 
| gkroussos | 0:dd0fea342ad2 | 2 | * Copyright (c) 2006-2013 ARM Limited | 
| gkroussos | 0:dd0fea342ad2 | 3 | * | 
| gkroussos | 0:dd0fea342ad2 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); | 
| gkroussos | 0:dd0fea342ad2 | 5 | * you may not use this file except in compliance with the License. | 
| gkroussos | 0:dd0fea342ad2 | 6 | * You may obtain a copy of the License at | 
| gkroussos | 0:dd0fea342ad2 | 7 | * | 
| gkroussos | 0:dd0fea342ad2 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 | 
| gkroussos | 0:dd0fea342ad2 | 9 | * | 
| gkroussos | 0:dd0fea342ad2 | 10 | * Unless required by applicable law or agreed to in writing, software | 
| gkroussos | 0:dd0fea342ad2 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, | 
| gkroussos | 0:dd0fea342ad2 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | 
| gkroussos | 0:dd0fea342ad2 | 13 | * See the License for the specific language governing permissions and | 
| gkroussos | 0:dd0fea342ad2 | 14 | * limitations under the License. | 
| gkroussos | 0:dd0fea342ad2 | 15 | */ | 
| gkroussos | 0:dd0fea342ad2 | 16 | #ifndef MBED_SERIAL_API_H | 
| gkroussos | 0:dd0fea342ad2 | 17 | #define MBED_SERIAL_API_H | 
| gkroussos | 0:dd0fea342ad2 | 18 | |
| gkroussos | 0:dd0fea342ad2 | 19 | #include "device.h" | 
| gkroussos | 0:dd0fea342ad2 | 20 | |
| gkroussos | 0:dd0fea342ad2 | 21 | #if DEVICE_SERIAL | 
| gkroussos | 0:dd0fea342ad2 | 22 | |
| gkroussos | 0:dd0fea342ad2 | 23 | #ifdef __cplusplus | 
| gkroussos | 0:dd0fea342ad2 | 24 | extern "C" { | 
| gkroussos | 0:dd0fea342ad2 | 25 | #endif | 
| gkroussos | 0:dd0fea342ad2 | 26 | |
| gkroussos | 0:dd0fea342ad2 | 27 | typedef enum { | 
| gkroussos | 0:dd0fea342ad2 | 28 | ParityNone = 0, | 
| gkroussos | 0:dd0fea342ad2 | 29 | ParityOdd = 1, | 
| gkroussos | 0:dd0fea342ad2 | 30 | ParityEven = 2, | 
| gkroussos | 0:dd0fea342ad2 | 31 | ParityForced1 = 3, | 
| gkroussos | 0:dd0fea342ad2 | 32 | ParityForced0 = 4 | 
| gkroussos | 0:dd0fea342ad2 | 33 | } SerialParity; | 
| gkroussos | 0:dd0fea342ad2 | 34 | |
| gkroussos | 0:dd0fea342ad2 | 35 | typedef enum { | 
| gkroussos | 0:dd0fea342ad2 | 36 | RxIrq, | 
| gkroussos | 0:dd0fea342ad2 | 37 | TxIrq | 
| gkroussos | 0:dd0fea342ad2 | 38 | } SerialIrq; | 
| gkroussos | 0:dd0fea342ad2 | 39 | |
| gkroussos | 0:dd0fea342ad2 | 40 | typedef enum { | 
| gkroussos | 0:dd0fea342ad2 | 41 | FlowControlNone, | 
| gkroussos | 0:dd0fea342ad2 | 42 | FlowControlRTS, | 
| gkroussos | 0:dd0fea342ad2 | 43 | FlowControlCTS, | 
| gkroussos | 0:dd0fea342ad2 | 44 | FlowControlRTSCTS | 
| gkroussos | 0:dd0fea342ad2 | 45 | } FlowControl; | 
| gkroussos | 0:dd0fea342ad2 | 46 | |
| gkroussos | 0:dd0fea342ad2 | 47 | typedef void (*uart_irq_handler)(uint32_t id, SerialIrq event); | 
| gkroussos | 0:dd0fea342ad2 | 48 | |
| gkroussos | 0:dd0fea342ad2 | 49 | typedef struct serial_s serial_t; | 
| gkroussos | 0:dd0fea342ad2 | 50 | |
| gkroussos | 0:dd0fea342ad2 | 51 | void serial_init (serial_t *obj, PinName tx, PinName rx); | 
| gkroussos | 0:dd0fea342ad2 | 52 | void serial_free (serial_t *obj); | 
| gkroussos | 0:dd0fea342ad2 | 53 | void serial_baud (serial_t *obj, int baudrate); | 
| gkroussos | 0:dd0fea342ad2 | 54 | void serial_format (serial_t *obj, int data_bits, SerialParity parity, int stop_bits); | 
| gkroussos | 0:dd0fea342ad2 | 55 | |
| gkroussos | 0:dd0fea342ad2 | 56 | void serial_irq_handler(serial_t *obj, uart_irq_handler handler, uint32_t id); | 
| gkroussos | 0:dd0fea342ad2 | 57 | void serial_irq_set (serial_t *obj, SerialIrq irq, uint32_t enable); | 
| gkroussos | 0:dd0fea342ad2 | 58 | |
| gkroussos | 0:dd0fea342ad2 | 59 | int serial_getc (serial_t *obj); | 
| gkroussos | 0:dd0fea342ad2 | 60 | void serial_putc (serial_t *obj, int c); | 
| gkroussos | 0:dd0fea342ad2 | 61 | int serial_readable (serial_t *obj); | 
| gkroussos | 0:dd0fea342ad2 | 62 | int serial_writable (serial_t *obj); | 
| gkroussos | 0:dd0fea342ad2 | 63 | void serial_clear (serial_t *obj); | 
| gkroussos | 0:dd0fea342ad2 | 64 | |
| gkroussos | 0:dd0fea342ad2 | 65 | void serial_break_set (serial_t *obj); | 
| gkroussos | 0:dd0fea342ad2 | 66 | void serial_break_clear(serial_t *obj); | 
| gkroussos | 0:dd0fea342ad2 | 67 | |
| gkroussos | 0:dd0fea342ad2 | 68 | void serial_pinout_tx(PinName tx); | 
| gkroussos | 0:dd0fea342ad2 | 69 | |
| gkroussos | 0:dd0fea342ad2 | 70 | void serial_set_flow_control(serial_t *obj, FlowControl type, PinName rxflow, PinName txflow); | 
| gkroussos | 0:dd0fea342ad2 | 71 | |
| gkroussos | 0:dd0fea342ad2 | 72 | #ifdef __cplusplus | 
| gkroussos | 0:dd0fea342ad2 | 73 | } | 
| gkroussos | 0:dd0fea342ad2 | 74 | #endif | 
| gkroussos | 0:dd0fea342ad2 | 75 | |
| gkroussos | 0:dd0fea342ad2 | 76 | #endif | 
| gkroussos | 0:dd0fea342ad2 | 77 | |
| gkroussos | 0:dd0fea342ad2 | 78 | #endif |