Merge TinyOS 2.1.1 into master.

[tinyos-2.x.git] / tos / chips / ds2401 / HplDs2401.nc

diff --git a/tos/chips/ds2401/HplDs2401.nc b/tos/chips/ds2401/HplDs2401.nc
new file mode 100644 (file)
index 0000000..ba45390
--- /dev/null
+++ b/tos/chips/ds2401/HplDs2401.nc
@@ -0,0 +1,38 @@
+// $Id$
+/*
+ * Copyright (c) 2007, Vanderbilt University
+ * All rights reserved.
+ *
+ * Permission to use, copy, modify, and distribute this software and its
+ * documentation for any purpose, without fee, and without written agreement is
+ * hereby granted, provided that the above copyright notice, the following
+ * two paragraphs and the author appear in all copies of this software.
+ *
+ * IN NO EVENT SHALL THE VANDERBILT UNIVERSITY BE LIABLE TO ANY PARTY FOR
+ * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
+ * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE VANDERBILT
+ * UNIVERSITY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * THE VANDERBILT UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
+ * ON AN "AS IS" BASIS, AND THE VANDERBILT UNIVERSITY HAS NO OBLIGATION TO
+ * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+ *
+ * Author: Janos Sallai
+ */
+
+#include "Ds2401.h"
+
+/**
+ * Interface to read the 64-bit hardware ID from the DS2401 chip.
+ */
+interface HplDs2401 {
+
+/**
+ * Read the 64-bit hardware ID (family id, serial, crc) from the DS2401 chip.
+ * @param rom Pointer to a ds2401_serial_t struct, defined in ds2401.h.
+ * @returns SUCCESS on success, an error code otherwise.
+ */
+  async command error_t read(ds2401_serial_t* rom);
+}