Contiki 3.x
io-arch.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012, George Oikonomou (oikonomou@users.sourceforge.net)
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  * This file is part of the Contiki operating system.
31  */
32 
33 /**
34  * \file
35  * Platform-specific header file which switches between UART and USB
36  * input/output, depending on whether we are building for the
37  * cc2531 USB dongle or the SmartRF
38  *
39  * These configuration directives are hardware-specific and you
40  * normally won't have to modify anything in this file.
41  *
42  * \author
43  * George Oikonomou - <oikonomou@users.sourceforge.net>
44  */
45 
46 #ifndef IO_ARCH_H_
47 #define IO_ARCH_H_
48 
49 #include "contiki.h"
50 /*---------------------------------------------------------------------------*/
51 #if MODELS_CONF_CC2531_USB_STICK
52 #include "dev/usb-serial.h"
53 #define IO_ARCH_PREFIX usb_serial
54 
55 /*
56  * When using the cc2531 USB stick, we have the option to enable buffering
57  * for USB-serial output. In this case, the driver will implicitly flush the
58  * output when the TX buffer is full or when it encounters SLIP_END or '\n'.
59  * We can trigger an explicit flush by calling io_arch_flush(). Naturally, this
60  * does not make sense when our output uses the UART nor when buffering is
61  * disabled, in which cases the calls are simply pre-processed to nothingness
62  */
63 #define io_arch_flush() usb_serial_flush()
64 #else
65 #include "dev/uart0.h"
66 #define IO_ARCH_PREFIX uart0
67 #define io_arch_flush()
68 #endif
69 /*---------------------------------------------------------------------------*/
70 /* Expands to uart0_init(), usb_serial_init() */
71 #define io_arch_init() io_arch_init_x(IO_ARCH_PREFIX)
72 #define io_arch_writeb(b) io_arch_writeb_x(IO_ARCH_PREFIX, b)
73 #define io_arch_set_input(f) io_arch_set_input_x(IO_ARCH_PREFIX, f)
74 /*---------------------------------------------------------------------------*/
75 /* Second round of macro substitutions. You can stop reading here */
76 #define io_arch_init_x(prefix) io_arch_init_x_x(prefix)
77 #define io_arch_writeb_x(prefix, b) io_arch_writeb_x_x(prefix, b)
78 #define io_arch_set_input_x(prefix, f) io_arch_set_input_x_x(prefix, f)
79 /*---------------------------------------------------------------------------*/
80 #define io_arch_init_x_x(prefix) prefix##_init()
81 #define io_arch_writeb_x_x(prefix, b) prefix##_writeb(b)
82 #define io_arch_set_input_x_x(prefix, f) prefix##_set_input(f)
83 
84 #endif /* IO_ARCH_H_ */
Header file for cc2531&#39;s UART-like I/O over USB