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

Interface: tos.lib.serial.SerialPacketInfo

interface SerialPacketInfo

Accessor methods used by a serial dispatcher to communicate with various message_t link formats over a serial port.

Author:
Philip Levis
Ben Greenstein
Date:
August 7 2005

Commands
command uint8_t dataLinkLength(message_t *msg, uint8_t upperLen) Get the size of the datalink packet embedded in the message_t, in bytes.
command uint8_t offset() Get the offset into a message_t where the header information begins.
command uint8_t upperLength(message_t *msg, uint8_t dataLinkLen) Get the size of the payload (in bytes) given the size of the datalink packet (dataLinkLen) embedded in the message_t.

Commands - Details

dataLinkLength

command uint8_t dataLinkLength(message_t *msg, uint8_t upperLen)

Get the size of the datalink packet embedded in the message_t, in bytes. This is the sum of the payload (upperLen) and the size of the link header.

Parameters:
msg - A pointer to the message_t to interrogate. (unused)
upperLen - The size of the payload.
Returns:
Returns the size of the datalink packet.

offset

command uint8_t offset()

Get the offset into a message_t where the header information begins.

Returns:
Returns the offset.

upperLength

command uint8_t upperLength(message_t *msg, uint8_t dataLinkLen)

Get the size of the payload (in bytes) given the size of the datalink packet (dataLinkLen) embedded in the message_t.

Parameters:
msg - A pointer to the message_t to interrogate. (unused)
dataLinkLength - The size of the datalink packet.
Returns:
Returns the size of the payload.