Contiki 2.6
|
00001 /* 00002 * Copyright (c) 2005, Swedish Institute of Computer Science 00003 * All rights reserved. 00004 * 00005 * Redistribution and use in source and binary forms, with or without 00006 * modification, are permitted provided that the following conditions 00007 * are met: 00008 * 1. Redistributions of source code must retain the above copyright 00009 * notice, this list of conditions and the following disclaimer. 00010 * 2. Redistributions in binary form must reproduce the above copyright 00011 * notice, this list of conditions and the following disclaimer in the 00012 * documentation and/or other materials provided with the distribution. 00013 * 3. Neither the name of the Institute nor the names of its contributors 00014 * may be used to endorse or promote products derived from this software 00015 * without specific prior written permission. 00016 * 00017 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND 00018 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 00019 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 00020 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE 00021 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 00022 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 00023 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 00024 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 00025 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 00026 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 00027 * SUCH DAMAGE. 00028 * 00029 * This file is part of the Contiki operating system. 00030 * 00031 * @(#)$Id: serial-line.h,v 1.1 2009/03/17 15:56:33 adamdunkels Exp $ 00032 */ 00033 /** 00034 * \file 00035 * Generic serial I/O process header filer 00036 * \author 00037 * Adam Dunkels 00038 * 00039 */ 00040 #ifndef __SERIAL_LINE_H__ 00041 #define __SERIAL_LINE_H__ 00042 00043 #include "contiki.h" 00044 00045 /** 00046 * Event posted when a line of input has been received. 00047 * 00048 * This event is posted when an entire line of input has been received 00049 * from the serial port. A data pointer to the incoming line of input 00050 * is sent together with the event. 00051 */ 00052 extern process_event_t serial_line_event_message; 00053 00054 /** 00055 * Get one byte of input from the serial driver. 00056 * 00057 * This function is to be called from the actual RS232 driver to get 00058 * one byte of serial data input. 00059 * 00060 * For systems using low-power CPU modes, the return value of the 00061 * function can be used to determine if the CPU should be woken up or 00062 * not. If the function returns non-zero, the CPU should be powered 00063 * up. If the function returns zero, the CPU can continue to be 00064 * powered down. 00065 * 00066 * \param c The data that is received. 00067 * 00068 * \return Non-zero if the CPU should be powered up, zero otherwise. 00069 */ 00070 00071 int serial_line_input_byte(unsigned char c); 00072 00073 void serial_line_init(void); 00074 00075 PROCESS_NAME(serial_line_process); 00076 00077 #endif /* __SERIAL_LINE_H__ */