-/* $Id$ */\r
-/*\r
- * Copyright (c) 2005 Arch Rock Corporation \r
- * All rights reserved. \r
- * Redistribution and use in source and binary forms, with or without\r
- * modification, are permitted provided that the following conditions are\r
- * met:\r
- * Redistributions of source code must retain the above copyright\r
- * notice, this list of conditions and the following disclaimer.\r
- * Redistributions in binary form must reproduce the above copyright\r
- * notice, this list of conditions and the following disclaimer in the\r
- * documentation and/or other materials provided with the distribution.\r
- * \r
- * Neither the name of the Arch Rock Corporation nor the names of its\r
- * contributors may be used to endorse or promote products derived from\r
- * this software without specific prior written permission.\r
- *\r
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\r
- * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\r
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\r
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ARCHED\r
- * ROCK OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,\r
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,\r
- * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS\r
- * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND\r
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR\r
- * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE\r
- * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH\r
- * DAMAGE.\r
- */\r
-\r
-/**\r
- * @author Phil Buonadonna\r
- */\r
-\r
-#include "pxa27x_serial.h"\r
-\r
-interface HalPXA27xSerialPacket\r
-{\r
- /**\r
- * Begin transmission of a UART stream. If SUCCESS is returned,\r
- * <code>sendDone</code> will be signalled when transmission is\r
- * complete.\r
- *\r
- * @param buf Buffer for bytes to send.\r
- * @param len Number of bytes to send.\r
- * @return SUCCESS if request was accepted, FAIL otherwise.\r
- */\r
- async command error_t send(uint8_t *buf, uint16_t len);\r
- \r
- /**\r
- * Signal completion of sending a stream.\r
- *\r
- * @param buf Bytes sent.\r
- * @param len Number of bytes sent.\r
- * @param status UART error status.\r
- *\r
- * @return buf A pointer to a new buffer of equal length\r
- * as in the original <code>send</code> call that is to be transmitted (chained\r
- * send). Set to NULL to end further transmissions.\r
- */\r
- async event uint8_t *sendDone(uint8_t *buf, uint16_t len, uart_status_t status);\r
-\r
- /**\r
- * Begin reception of a UART stream. If SUCCESS is returned,\r
- * <code>receiveDone</code> will be signalled when reception is\r
- * complete.\r
- *\r
- * @param buf Buffer for received bytes.\r
- * @param len Number of bytes to receive.\r
- * @param timeout Timeout, in milliseconds, for receive operation\r
- *\r
- * @return SUCCESS if request was accepted, FAIL otherwise.\r
- */\r
- async command error_t receive(uint8_t *buf, uint16_t len, uint16_t timeout);\r
-\r
- /**\r
- * Signal completion of receiving a stream.\r
- *\r
- * @param buf Buffer for bytes received.\r
- * @param len Number of bytes received.\r
- * @param status UART error status\r
- *\r
- * @return buf A pointer to a new buffer of equal or greater length \r
- * as in the original <code>receive</code> call in which it intiate a\r
- * new packet reception (chained receive). Set to NULL to terminate further\r
- * reception. \r
- */\r
- async event uint8_t *receiveDone(uint8_t *buf, uint16_t len, uart_status_t status);\r
- \r
-}\r
-\r
+/* $Id$ */
+/*
+ * Copyright (c) 2005 Arch Rock Corporation
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * Neither the name of the Arch Rock Corporation nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ARCHED
+ * ROCK OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+ * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+ * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+ * DAMAGE.
+ */
+
+/**
+ * @author Phil Buonadonna
+ */
+
+#include "pxa27x_serial.h"
+
+interface HalPXA27xSerialPacket
+{
+ /**
+ * Begin transmission of a UART stream. If SUCCESS is returned,
+ * <code>sendDone</code> will be signalled when transmission is
+ * complete.
+ *
+ * @param buf Buffer for bytes to send.
+ * @param len Number of bytes to send.
+ * @return SUCCESS if request was accepted, FAIL otherwise.
+ */
+ async command error_t send(uint8_t *buf, uint16_t len);
+
+ /**
+ * Signal completion of sending a stream.
+ *
+ * @param buf Bytes sent.
+ * @param len Number of bytes sent.
+ * @param status UART error status.
+ *
+ * @return buf A pointer to a new buffer of equal length
+ * as in the original <code>send</code> call that is to be transmitted (chained
+ * send). Set to NULL to end further transmissions.
+ */
+ async event uint8_t *sendDone(uint8_t *buf, uint16_t len, uart_status_t status);
+
+ /**
+ * Begin reception of a UART stream. If SUCCESS is returned,
+ * <code>receiveDone</code> will be signalled when reception is
+ * complete.
+ *
+ * @param buf Buffer for received bytes.
+ * @param len Number of bytes to receive.
+ * @param timeout Timeout, in milliseconds, for receive operation
+ *
+ * @return SUCCESS if request was accepted, FAIL otherwise.
+ */
+ async command error_t receive(uint8_t *buf, uint16_t len, uint16_t timeout);
+
+ /**
+ * Signal completion of receiving a stream.
+ *
+ * @param buf Buffer for bytes received.
+ * @param len Number of bytes received.
+ * @param status UART error status
+ *
+ * @return buf A pointer to a new buffer of equal or greater length
+ * as in the original <code>receive</code> call in which it intiate a
+ * new packet reception (chained receive). Set to NULL to terminate further
+ * reception.
+ */
+ async event uint8_t *receiveDone(uint8_t *buf, uint16_t len, uart_status_t status);
+
+}
+
projects / tinyos-2.x.git / blobdiff