Contiki-NG
usb-serial.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012, 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 cc2538-usb
32  * @{
33  *
34  * \file
35  * Header file for cc2538's UART-like I/O over USB
36  */
37 #ifndef USB_SERIAL_H_
38 #define USB_SERIAL_H_
39 
40 #include "contiki.h"
41 
42 /**
43  * \brief Initialise the Serial-over-USB process
44  */
45 void usb_serial_init(void);
46 
47 /**
48  * \brief Write a byte over USB
49  * \param b The byte
50  * \sa usb_serial_flush()
51  *
52  * USB-Serial output is buffered. The buffer is actually submitted to the USB
53  * controller for transmission when:
54  * - It is full or
55  * - The code explicitly calls usb_serial_flush()
56  */
57 void usb_serial_writeb(uint8_t b);
58 
59 /**
60  * \brief Set an input hook for bytes received over USB
61  * \param input A pointer to a function to be called when a byte is received
62  */
63 void usb_serial_set_input(int (* input)(unsigned char c));
64 
65 /**
66  * \brief Immediately transmit the content of Serial-over-USB TX buffers
67  * \sa usb_serial_writeb()
68  */
69 void usb_serial_flush(void);
70 
71 #endif /* USB_SERIAL_H_ */
72 
73 /** @} */
void usb_serial_init()
Initialise the Serial-over-USB process.
Definition: usb-serial.c:301
void usb_serial_writeb(uint8_t b)
Write a byte over USB.
Definition: usb-serial.c:250
void usb_serial_flush()
Immediately transmit the content of Serial-over-USB TX buffers.
Definition: usb-serial.c:234
static void input(void)
Process a received 6lowpan packet.
Definition: sicslowpan.c:1802
void usb_serial_set_input(int(*input)(unsigned char c))
Set an input hook for bytes received over USB.
Definition: usb-serial.c:295