[Tinyos-2-commits] CVS: tinyos-2.x/tos/interfaces Mount.nc, 1.1.2.3, 1.1.2.4 BlockRead.nc, 1.1.2.9, 1.1.2.10 ConfigStorage.nc, 1.1.2.1, 1.1.2.2 LogRead.nc, 1.1.2.3, 1.1.2.4

Tue May 30 14:35:16 PDT 2006

Update of /cvsroot/tinyos/tinyos-2.x/tos/interfaces
In directory sc8-pr-cvs10.sourceforge.net:/tmp/cvs-serv21125

Modified Files:
      Tag: tinyos-2_0_devel-BRANCH
	BlockRead.nc ConfigStorage.nc LogRead.nc 
Added Files:
      Tag: tinyos-2_0_devel-BRANCH
	Mount.nc 
Log Message:
some interface cleanup

Index: BlockRead.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/Attic/BlockRead.nc,v
retrieving revision 1.1.2.9
retrieving revision 1.1.2.10
diff -C2 -d -r1.1.2.9 -r1.1.2.10
*** BlockRead.nc	16 Feb 2006 22:21:32 -0000	1.1.2.9
--- BlockRead.nc	30 May 2006 21:35:14 -0000	1.1.2.10
***************
*** 106,110 ****

    /**
!    * Report volume size in bytes.
     * @return Volume size.
     */
--- 106,111 ----

    /**
!    * Report the usable volume size in bytes (this may be different than
!    * the actual volume size because of metadata overheads).
     * @return Volume size.
     */

Index: ConfigStorage.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/Attic/ConfigStorage.nc,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -C2 -d -r1.1.2.1 -r1.1.2.2
*** ConfigStorage.nc	25 May 2006 18:38:58 -0000	1.1.2.1
--- ConfigStorage.nc	30 May 2006 21:35:14 -0000	1.1.2.2
***************
*** 58,62 ****
     * @param buf buffer to place read data.
     * @param len number of bytes to read.
!    * @return SUCCESS if the request was accepted, FAIL otherwise.
     */
    command error_t read(storage_addr_t addr, void* buf, storage_len_t len);
--- 58,66 ----
     * @param buf buffer to place read data.
     * @param len number of bytes to read.
!    * @return 
!    *   <li>SUCCESS if the request was accepted, 
!    *   <li>EINVAL if the parameters are invalid
!    *   <li>EOFF if the volume has not been mounted
!    *   <li>EBUSY if a request is already being processed.
     */
    command error_t read(storage_addr_t addr, void* buf, storage_len_t len);
***************
*** 68,72 ****
     * @param buf buffer where read data was placed.
     * @param len number of bytes read.
!    * @param error notification of how the operation went.
     */
    event void readDone(storage_addr_t addr, void* buf, storage_len_t len, 
--- 72,77 ----
     * @param buf buffer where read data was placed.
     * @param len number of bytes read.
!    * @param error SUCCESS if the operation was successful, FAIL if
!    *   it failed
     */
    event void readDone(storage_addr_t addr, void* buf, storage_len_t len, 
***************
*** 81,85 ****
     * @param buf buffer to write data from.
     * @param len number of bytes to write.
!    * @return SUCCESS if the request was accepted, FAIL otherwise.
     */
    command error_t write(storage_addr_t addr, void* buf, storage_len_t len);
--- 86,94 ----
     * @param buf buffer to write data from.
     * @param len number of bytes to write.
!    * @return 
!    *   <li>SUCCESS if the request was accepted, 
!    *   <li>EINVAL if the parameters are invalid
!    *   <li>EOFF if the volume has not been mounted
!    *   <li>EBUSY if a request is already being processed.
     */
    command error_t write(storage_addr_t addr, void* buf, storage_len_t len);
***************
*** 93,97 ****
     * @param buf buffer that written data was read from.
     * @param len number of bytes written.
!    * @param error notification of how the operation went.
     */
    event void writeDone(storage_addr_t addr, void* buf, storage_len_t len, 
--- 102,107 ----
     * @param buf buffer that written data was read from.
     * @param len number of bytes written.
!    * @param error SUCCESS if the operation was successful, FAIL if
!    *   it failed
     */
    event void writeDone(storage_addr_t addr, void* buf, storage_len_t len, 
***************
*** 104,108 ****
     * event will signal completion of the operation.
     *
!    * @return SUCCESS if the request was accepted, FAIL otherwise.
     */
    command error_t commit();
--- 114,121 ----
     * event will signal completion of the operation.
     *
!    * @return 
!    *   <li>SUCCESS if the request was accepted, 
!    *   <li>EBUSY if a request is already being processed.
!    *   <li>EOFF if the volume has not been mounted
     */
    command error_t commit();
***************
*** 112,117 ****
     * flushed to non-volatile storage after this event.
     *
!    * @param error notification of how the operation went.
     */
    event void commitDone(error_t error);
  }
--- 125,141 ----
     * flushed to non-volatile storage after this event.
     *
!    * @param error SUCCESS if the operation was successful, FAIL if
!    *   it failed
     */
    event void commitDone(error_t error);
+ 
+   /**
+    * Report the usable volume size in bytes (this may be significantly
+    * different from the actual volume size, e.g., it's approximately
+    * half the volume size on the AT45DB implementation).
+    *
+    * @return Volume size. The result is undefined if the volume hasn't
+    *    been mounted.
+    */
+   command storage_len_t getSize();
  }

Index: LogRead.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/Attic/LogRead.nc,v
retrieving revision 1.1.2.3
retrieving revision 1.1.2.4
diff -C2 -d -r1.1.2.3 -r1.1.2.4
*** LogRead.nc	23 May 2006 21:57:48 -0000	1.1.2.3
--- LogRead.nc	30 May 2006 21:35:14 -0000	1.1.2.4
***************
*** 52,58 ****

    /**
!    * Initiate a read operation from the current position  within a given log volume. 
!    * On SUCCESS, the <code>readDone</code> event will signal completion of the
!    * operation.
     * 
     * @param buf buffer to place read data.
--- 52,58 ----

    /**
!    * Initiate a read operation from the current position within a given log
!    * volume. On SUCCESS, the <code>readDone</code> event will signal
!    * completion of the operation.
     * 
     * @param buf buffer to place read data.
***************
*** 73,79 ****
    event void readDone(void* buf, storage_len_t len, error_t error);

!   command uint32_t currentOffset();

!   command error_t seek(uint32_t offset);
    event void seekDone(error_t error);

--- 73,106 ----
    event void readDone(void* buf, storage_len_t len, error_t error);

!   /**
!    * Return a "cookie" representing the current read offset within the
!    * log. This cookie can be used in a subsequent seek operation to
!    * return to the same place in the log (if it hasn't been overwritten)
!    * @return Cookie representing current offset. 
!    *   <code>SEEK_BEGINNING</code> will be returned if:
!    *   <li> a write in a circular log overwrote the previous read position
!    *   <li> seek was passed a cookie representing a position before the
!    *        current beginning of a circular log
!    */
!   command storage_cookie_t currentOffset();

!   /**
!    * Set the read position in the log, using a cookie returned by the
!    * <code>currentOffset</code> commands of <code>LogRead</code> or
!    * <code>LogWrite</code>, or the special value <code>SEEK_BEGINNING</code>.
!    *
!    * If the specified position has been overwritten, the read position
!    * will be set to the beginning of the log.
!    */
!   command error_t seek(storage_cookie_t offset);
! 
!   /**
!    * Report success of seek operation. If <code>SUCCESS</code> is returned,
!    * the read position has been changed as requested. Otherwise, the read
!    * position is unchanged.
!    *
!    * @param error SUCCESS if the seek was succesful, EINVAL if the cookie
!    *   was invalid and FAIL for other errors.
!    */
    event void seekDone(error_t error);

***************
*** 85,88 ****
     * @return Volume size.
     */
!   //command storage_len_t getSize();
  }
--- 112,115 ----
     * @return Volume size.
     */
!   command storage_len_t getSize();
  }