Contiki-NG
Loading...
Searching...
No Matches
uart-arch.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2022 Yago Fontoura do Rosario <yago.rosario@hotmail.com.br>
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/**
32 * \addtogroup gecko
33 * @{
34 *
35 * \addtogroup gecko-dev Device drivers
36 * @{
37 *
38 * \addtogroup gecko-uart UART driver
39 * @{
40 *
41 * \file
42 * UART header file for the gecko.
43 * \author
44 * Yago Fontoura do Rosario <yago.rosario@hotmail.com.br>
45 *
46 */
47/*---------------------------------------------------------------------------*/
48#ifndef UART_ARCH_H
49#define UART_ARCH_H
50/*---------------------------------------------------------------------------*/
51#include "contiki.h"
52/*---------------------------------------------------------------------------*/
53/**
54 * @brief Initializa the UART driver
55 *
56 */
57void uart_init(void);
58/*---------------------------------------------------------------------------*/
59/**
60 * @brief Writes to the UART driver
61 *
62 * @param s character array to be transferred
63 * @param len length of character array
64 *
65 * @pre @ref uart_init must have been called
66 */
67void uart_write(unsigned char *s, unsigned int len);
68/*---------------------------------------------------------------------------*/
69/**
70 * @brief Sets the input handler called in the event handler
71 *
72 * @param input character that has been read
73 */
74void uart_set_input(int (*input)(unsigned char c));
75/*---------------------------------------------------------------------------*/
76#endif /* UART_ARCH_H */
77/*---------------------------------------------------------------------------*/
78/**
79 * @}
80 * @}
81 * @}
82 */
uart_set_input
void uart_set_input(uint8_t uart, int(*input)(unsigned char c))
Assigns a callback to be called when the UART receives a byte.
Definition uart.c:334
uart_init
void uart_init(void)
Initializa the UART driver.
Definition uart-arch.c:87
uart_write
void uart_write(unsigned char *s, unsigned int len)
Writes to the UART driver.
Definition uart-arch.c:71