Contiki-NG
uart-driver.h
1 /*
2  * Copyright (c) 2015 NXP B.V.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of NXP B.V. nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY NXP B.V. AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL NXP B.V. OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * This file is part of the Contiki operating system.
30  *
31  * Author: Lee Mitchell
32  * Integrated into Contiki by Beshr Al Nahas
33  *
34  */
35 
36 #ifndef UARTDRIVER_H
37 #define UARTDRIVER_H
38 
39 #include <jendefs.h>
40 #include "contiki.h"
41 
42 #define UART_EXTRAS 1
43 
44 void uart_driver_init(uint8_t uart_dev, uint8_t br, uint8_t * txbuf_data, uint16_t txbuf_size, uint8_t * rxbuf_data, uint16_t rxbuf_size, int (*uart_input_function)(unsigned char c));
45 void uart_driver_write_buffered(uint8_t uart_dev, uint8_t ch);
46 void uart_driver_write_with_deadline(uint8_t uart_dev, uint8_t c);
47 uint8_t uart_driver_read(uint8_t uart_dev, uint8_t *data);
48 void uart_driver_write_direct(uint8_t uart_dev, uint8_t ch);
49 void uart_driver_set_input(uint8_t u8Uart, int (*uart_input_function)(unsigned char c));
50 
51 void uart_driver_rx_handler(uint8_t uart_dev);
52 void uart_driver_enable_interrupts(uint8_t uart_dev);
53 void uart_driver_disable_interrupts(uint8_t uart_dev);
54 int8_t uart_driver_interrupt_is_enabled(uint8_t uart_dev);
55 void uart_driver_store_interrupts(uint8_t uart_dev);
56 void uart_driver_restore_interrupts(uint8_t uart_dev);
57 
58 uint8_t uart_driver_tx_in_progress(uint8_t uart_dev);
59 
60 #ifdef UART_EXTRAS
61 void uart_driver_flush(uint8_t uart_dev, bool_t reset_tx, bool_t reset_rx);
62 #endif
63 
64 #endif /* UARTDRIVER_H */