/** * 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.interfaces.UartStream

Interface: tos.interfaces.UartStream

interface UartStream

Author:
Jonathan Hui <jhui@archedrock.com>
Version:
$Revision: 1.5 $ $Date: 2008/06/04 03:00:35 $

Commands
command error_t disableReceiveInterrupt() Disable the receive byte interrupt.
command error_t enableReceiveInterrupt() Enable the receive byte interrupt.
command error_t receive(uint8_t *buf, uint16_t len) Begin reception of a UART stream.
command error_t send(uint8_t *buf, uint16_t len) Begin transmission of a UART stream.

Events
event void receivedByte(uint8_t byte) Signals the receipt of a byte.
event void receiveDone(uint8_t *buf, uint16_t len, error_t error) Signal completion of receiving a stream.
event void sendDone(uint8_t *buf, uint16_t len, error_t error) Signal completion of sending a stream.

Commands - Details

disableReceiveInterrupt

command error_t disableReceiveInterrupt()

Disable the receive byte interrupt.

Returns:
SUCCESS if interrupt was disabled, FAIL otherwise.

enableReceiveInterrupt

command error_t enableReceiveInterrupt()

Enable the receive byte interrupt. The receive event is signalled each time a byte is received.

Returns:
SUCCESS if interrupt was enabled, FAIL otherwise.

receive

command error_t receive(uint8_t *buf, uint16_t len)

Begin reception of a UART stream. If SUCCESS is returned, receiveDone will be signalled when reception is complete.

Parameters:
'uint8_t* COUNT(len) buf' Buffer for received bytes.
len - Number of bytes to receive.
Returns:
SUCCESS if request was accepted, FAIL otherwise.

send

command error_t send(uint8_t *buf, uint16_t len)

Begin transmission of a UART stream. If SUCCESS is returned, sendDone will be signalled when transmission is complete.

Parameters:
'uint8_t* COUNT(len) buf' Buffer for bytes to send.
len - Number of bytes to send.
Returns:
SUCCESS if request was accepted, FAIL otherwise.

Events - Details

receivedByte

event void receivedByte(uint8_t byte)

Signals the receipt of a byte.

Parameters:
byte - The byte received.

receiveDone

event void receiveDone(uint8_t *buf, uint16_t len, error_t error)

Signal completion of receiving a stream.

Parameters:
'uint8_t* COUNT(len) buf' Buffer for bytes received.
len - Number of bytes received.
error - SUCCESS if the reception was successful, FAIL otherwise.

sendDone

event void sendDone(uint8_t *buf, uint16_t len, error_t error)

Signal completion of sending a stream.

Parameters:
'uint8_t* COUNT(len) buf' Bytes sent.
len - Number of bytes sent.
error - SUCCESS if the transmission was successful, FAIL otherwise.