/** * 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.SendBytePacket

Interface: tos.lib.serial.SendBytePacket

interface SendBytePacket

This is an interface that a serial framing protocol provides and a serial dispatcher uses. The call sequence should be as follows: The dispatcher should call startSend, specifying the first byte to send. The framing protocol can then signal as many nextBytes as it wants/needs, to spool in the bytes. It continues to do so until it receives a sendComplete call, which will almost certainly happen within a nextByte signal (i.e., re-entrant to the framing protocol). This allows the framing protocol to buffer as many bytes as it needs to to meet timing requirements, jitter, etc.

Author:
Philip Levis
Ben Greenstein
Date:
August 7 2005

Commands
command error_t completeSend() The dispatcher must indicate when the end-of-packet has been reached and does so by calling completeSend.
command error_t startSend(uint8_t first_byte) The dispatcher may initiate a serial transmission by calling this function and passing the first byte to be transmitted.

Events
event uint8_t nextByte() Used by the framer to request the next byte to transmit.
event void sendCompleted(error_t error) The framer signals sendCompleted to indicate that it is done transmitting a packet on the dispatcher's behalf.

Commands - Details

completeSend

command error_t completeSend()

The dispatcher must indicate when the end-of-packet has been reached and does so by calling completeSend. The function may be called from within the implementation of a nextByte event.

Returns:
Returns an error_t code indicating whether the framer accepts this notification (SUCCESS) or not (FAIL).

startSend

command error_t startSend(uint8_t first_byte)

The dispatcher may initiate a serial transmission by calling this function and passing the first byte to be transmitted.

Parameters:
first_byte - The first byte to be transmitted.
Returns:
Returns an error_t code indicating either that the framer has the resources available to transmit the frame (SUCCESS) or not (EBUSY).

Events - Details

nextByte

event uint8_t nextByte()

Used by the framer to request the next byte to transmit. The framer may allocate a buffer to pre-spool some or all of a packet; or it may request and transmit a byte at a time. If there are no more bytes to send, the dispatcher must call completeSend before returning from this function.

Returns:
The dispatcher must return the next byte to transmit

sendCompleted

event void sendCompleted(error_t error)

The framer signals sendCompleted to indicate that it is done transmitting a packet on the dispatcher's behalf. A non-SUCCESS error_t code indicates that there was a problem in transmission.

Parameters:
error - The framer indicates whether it has successfully accepted the entirety of the packet from the dispatcher (SUCCESS) or not (FAIL).