ctsrts-sensor.h

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: ctsrts-sensor.h,v 1.2 2010/01/14 17:39:35 nifi Exp $
00032  */
00033 
00034 /**
00035  * RTS/CTS (Request to Send/Clear to Send) are the signals used for hardware
00036  * flow control. By setting the RTS line to "ON" the host tells the connected
00037  * device that it is ready to receive data. Hardware flow control is not
00038  * implemented yet. This implementation is just so some application can use
00039  * the pins, it would also be possible for rs232.c to use it for hardware
00040  * handshake but that is not implemented yet.
00041  */
00042 #ifndef __CTSRTS_SENSOR_H__
00043 #define __CTSRTS_SENSOR_H__
00044 
00045 #include "lib/sensors.h"
00046 
00047 extern const struct sensors_sensor ctsrts_sensor;
00048 
00049 #define CTSRTS_SENSOR "CTSRTS"
00050 
00051 /**
00052  * Indicate to host/client we are NOT ready to receive data. Sets the RTS pin
00053  * to low.
00054  */
00055 void ctsrts_rts_clear(void);
00056 
00057 /**
00058  * Request host/client to send data. Sets the RTS pin to high.
00059  */
00060 void ctsrts_rts_set(void);
00061 
00062 #endif /* __CTSRTS_SENSOR_H__ */

Generated on Mon Apr 11 14:23:43 2011 for Contiki 2.5 by  doxygen 1.6.1