Contiki 3.x
usb-serial.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  * \file
34  * Header file for cc2531's UART-like I/O over USB
35  *
36  * With it in place, putchar can be redirected to the USB and USB
37  * incoming traffic can be handled as input
38  *
39  * \author
40  * George Oikonomou - <oikonomou@users.sourceforge.net>
41  */
42 #ifndef USB_SERIAL_H_
43 #define USB_SERIAL_H_
44 
45 #include "contiki.h"
46 
47 void usb_serial_init(void);
48 void usb_serial_writeb(uint8_t);
49 void usb_serial_set_input(int (* input)(unsigned char c));
50 
51 #if USB_SERIAL_CONF_BUFFERED
52 void usb_serial_flush(void);
53 #else
54 #define usb_serial_flush()
55 #endif
56 
57 #endif /* USB_SERIAL_H_ */
void usb_serial_set_input(int(*input)(unsigned char c))
Set an input hook for bytes received over USB.
Definition: usb-serial.c:295
void usb_serial_init()
Initialise the Serial-over-USB process.
Definition: usb-serial.c:301
#define usb_serial_flush()
Immediately transmit the content of Serial-over-USB TX buffers.
Definition: usb-serial.h:54
void usb_serial_writeb(uint8_t b)
Write a byte over USB.
Definition: usb-serial.c:250