Contiki-NG
uart0-arch.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018, Texas Instruments Incorporated - http://www.ti.com/
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 the copyright holder nor the names of its
14  * contributors may be used to endorse or promote products derived
15  * from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
20  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
21  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
28  * OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 /**
31  * \addtogroup cc13xx-cc26xx-cpu
32  * @{
33  *
34  * \defgroup cc13xx-cc26xx-uart UART for CC13xx/CC26xx.
35  *
36  * This particular driver utilizes the UART0 peripheral specifically.
37  *
38  * Driver for the CC13xx/CC26xx UART controller.
39  * @{
40  *
41  * \file
42  * Header file of UART driver for CC13xx/CC26xx.
43  * \author
44  * Edvard Pettersen <e.pettersen@ti.com>
45  */
46 #ifndef UART0_ARCH_H_
47 #define UART0_ARCH_H_
48 /*---------------------------------------------------------------------------*/
49 #include <stddef.h>
50 #include <stdint.h>
51 /*---------------------------------------------------------------------------*/
52 typedef int (*uart0_input_fxn_t)(unsigned char);
53 /*---------------------------------------------------------------------------*/
54 /**
55  * \brief Initializes the UART driver.
56  */
57 void uart0_init(void);
58 
59 /**
60  * \brief Writes data from a memory buffer to the UART interface.
61  * \param buf A pointer to the data buffer.
62  * \param buf_size Size of the data buffer.
63  * \return Number of bytes that has been written to the UART. If an
64  * error occurs, a negative value is returned.
65  */
66 int_fast32_t uart0_write(const void *buf, size_t buf_size);
67 
68 /**
69  * \brief Writes a single byte to the UART interface.
70  * \param byte Byte to write.
71  * \return Number of bytes that has been written to the UART. If an
72  * error occurs, a negative value is returned.
73  */
74 int_fast32_t uart0_write_byte(uint8_t byte);
75 
76 /**
77  * \brief Set the callback function for when bytes are received
78  * on UART0.
79  * \param input_cb Pointer to the callback function. A valid pointer
80  * subscribes for UART0 callbacks when bytes are received,
81  * while a NULL pointer unsubscribes.
82  * \return 0 for success, negative value for errors.
83  */
84 int_fast32_t uart0_set_callback(uart0_input_fxn_t input_cb);
85 /*---------------------------------------------------------------------------*/
86 #endif /* UART0_ARCH_H_ */
87 /**
88  * @}
89  * @}
90  */
int_fast32_t uart0_write_byte(uint8_t byte)
Writes a single byte to the UART interface.
Definition: uart0-arch.c:115
int_fast32_t uart0_set_callback(uart0_input_fxn_t input_cb)
Set the callback function for when bytes are received on UART0.
Definition: uart0-arch.c:124
void uart0_init(unsigned long ubr)
Initalize the RS232 port.
Definition: uart0.c:139
int_fast32_t uart0_write(const void *buf, size_t buf_size)
Writes data from a memory buffer to the UART interface.
Definition: uart0-arch.c:106