Contiki-NG
Loading...
Searching...
No Matches
uarte-arch.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2020 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 nrf
33 * @{
34 *
35 * \addtogroup nrf-dev Device drivers
36 * @{
37 *
38 * \addtogroup nrf-uarte UARTE driver
39 * @{
40 *
41 * \file
42 * UARTE header file for the nRF.
43 * \author
44 * Yago Fontoura do Rosario <yago.rosario@hotmail.com.br>
45 *
46 */
47/*---------------------------------------------------------------------------*/
48#ifndef UARTE_ARCH_H
49#define UARTE_ARCH_H
50/*---------------------------------------------------------------------------*/
51#include "contiki.h"
52/*---------------------------------------------------------------------------*/
53/**
54 * @brief Initializa the UARTE driver
55 *
56 */
57void uarte_init(void);
58/*---------------------------------------------------------------------------*/
59/**
60 * @brief Tear down the UARTE driver, releasing the peripheral.
61 *
62 * Used during TrustZone handoff so the secure world can release
63 * UART ownership before the SPU re-targets the peripheral to the
64 * normal world.
65 */
66void uarte_uninit(void);
67/*---------------------------------------------------------------------------*/
68/**
69 * @brief Writes to the UARTE driver
70 *
71 * @param data character to be transfered
72 *
73 * @pre @ref uarte_init must have been called
74 */
75void uarte_write(unsigned char data);
76/*---------------------------------------------------------------------------*/
77/**
78 * @brief Sets the input handler called in the event handler
79 *
80 * @param input character that has been read
81 */
82void uarte_set_input(int (*input)(unsigned char c));
83/*---------------------------------------------------------------------------*/
84#endif /* UARTE_ARCH_H */
85/*---------------------------------------------------------------------------*/
86/**
87 * @}
88 * @}
89 * @}
90 */
void uarte_write(unsigned char data)
Writes to the UARTE driver.
void uarte_uninit(void)
Tear down the UARTE driver, releasing the peripheral.
void uarte_init(void)
Initializa the UARTE driver.
void uarte_set_input(int(*input)(unsigned char c))
Sets the input handler called in the event handler.
static void input(void)
Process a received 6lowpan packet.