Contiki-NG
serial-line.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2005, Swedish Institute of Computer Science
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 Institute nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * This file is part of the Contiki operating system.
30  *
31  */
32 /**
33  * \file
34  * Generic serial I/O process header filer
35  * \author
36  * Adam Dunkels
37  *
38  */
39 #ifndef SERIAL_LINE_H_
40 #define SERIAL_LINE_H_
41 
42 #include "contiki.h"
43 
44 /**
45  * Event posted when a line of input has been received.
46  *
47  * This event is posted when an entire line of input has been received
48  * from the serial port. A data pointer to the incoming line of input
49  * is sent together with the event.
50  */
51 extern process_event_t serial_line_event_message;
52 
53 /**
54  * Get one byte of input from the serial driver.
55  *
56  * This function is to be called from the actual RS232 driver to get
57  * one byte of serial data input.
58  *
59  * For systems using low-power CPU modes, the return value of the
60  * function can be used to determine if the CPU should be woken up or
61  * not. If the function returns non-zero, the CPU should be powered
62  * up. If the function returns zero, the CPU can continue to be
63  * powered down.
64  *
65  * \param c The data that is received.
66  *
67  * \return Non-zero if the CPU should be powered up, zero otherwise.
68  */
69 
70 int serial_line_input_byte(unsigned char c);
71 
72 void serial_line_init(void);
73 
74 PROCESS_NAME(serial_line_process);
75 
76 #endif /* SERIAL_LINE_H_ */
int serial_line_input_byte(unsigned char c)
Get one byte of input from the serial driver.
Definition: serial-line.c:65
#define PROCESS_NAME(name)
Declare the name of a process.
Definition: process.h:286
process_event_t serial_line_event_message
Event posted when a line of input has been received.
Definition: serial-line.c:61