/** * This file is part of license combination gpl version 3 license and eCos. * The corresponding license terms are below. * * gpl version 3 Licence: * * The file were developed during the student thesis "Datensammlung in Wireless * Sensor Networks fuer Autonomic Home NetworkingÒ of Thomas Kothmayr and is * included in the dissertation "Secure Data Transmission in Wireless * Sensor Networks" by Corinna Schmitt during employment at the Technische * UniversitŠt MŸnchen, Department Computer Science, Chair Network * Architectures and Services (Germany). * Copyright (C) 2013 * Authors: Thomas Kothmayr and Corinna Schmitt (schmitt[at]net.in.tum.de) * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, version 3 of the License * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * * * eCos Licence: (http://ecos.sourceware.org) * * This file is part of eCos, the Embedded Configurable Operating System. * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, * 2007, 2008, 2009 Free Software Foundation, Inc. * * eCos is free software; you can redistribute it and/or modify it under * the terms of the GNU General Public License as published by the Free * Software Foundation; either version 3 any later version. * * eCos is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for * more details. * * You should have received a copy of the GNU General Public License along * with eCos; if not, write to the Free Software Foundation, Inc., 51 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * As a special exception, if other files instantiate templates or use * macros or inline functions from this file, or you compile this file and * link it with other works to produce a work based on this file, this file * does not by itself cause the resulting work to be covered by the GNU * General Public License. However the source code for this file must still * be made available in accordance with section (3) of the GNU General * Public License v2. * * This exception does not invalidate any other reasons why a work based on * this file might be covered by the GNU General Public License. * */ Interface: tos.lib.serial.SerialFrameComm

Interface: tos.lib.serial.SerialFrameComm

interface SerialFrameComm

This interface sits between a serial byte encoding component and a framing/packetizing component. It is to be used with framing protocols that place delimiters between frames. This interface separates the tasks of interpreting and coding delimiters and escape bytes from the rest of the wire protocol.

Author:
Philip Levis
Ben Greenstein
Date:
August 7 2005

Commands
command error_t putData(uint8_t data) Used by the upper layer to request that a byte of data be sent over serial.
command error_t putDelimiter() Used by the upper layer to request that an interframe delimiter be sent.
command void resetReceive() Requests that any underlying state associated with receive-side frame or escaping be reset.
command void resetSend() Requests that any underlying state associated with send-side frame delimiting or escaping be reset.

Events
event void dataReceived(uint8_t data) Signals the upper layer that a byte of data has been received from the serial connection.
event void delimiterReceived() Signals the upper layer that an inter-frame delimiter has been received from the serial connection.
event void putDone() Split-phase event to signal when the lower layer has finished writing the last request (either putDelimiter or putData) to serial.

Commands - Details

putData

command error_t putData(uint8_t data)

Used by the upper layer to request that a byte of data be sent over serial.

Parameters:
data - The byte to be sent
Returns:
Returns an error_t code that indicates if the lower layer has accepted the byte for sending (SUCCESS) or not (FAIL).

putDelimiter

command error_t putDelimiter()

Used by the upper layer to request that an interframe delimiter be sent. The lower layer is responsible for the determining the actual byte(s) that must be sent to delimit the frame.

Returns:
Returns a error_t code that indicates if the lower layer was able to put an interframe delimiter to serial (SUCCESS) or not (FAIL).

resetReceive

command void resetReceive()

Requests that any underlying state associated with receive-side frame or escaping be reset. Used to initialize the lower layer's receive path and/or cancel a frame mid-reception when sync is lost.

resetSend

command void resetSend()

Requests that any underlying state associated with send-side frame delimiting or escaping be reset. Used to initialize the lower layer's send path and/or cancel a frame mid-transmission.

Events - Details

dataReceived

event void dataReceived(uint8_t data)

Signals the upper layer that a byte of data has been received from the serial connection. It passes this byte as a function parameter.

Parameters:
data - The byte of data that has been received from the serial connection

delimiterReceived

event void delimiterReceived()

Signals the upper layer that an inter-frame delimiter has been received from the serial connection.

putDone

event void putDone()

Split-phase event to signal when the lower layer has finished writing the last request (either putDelimiter or putData) to serial.