netprog.nc

来自「tinyos最新版」· NC 代码 · 共 80 行

// $Id: NetProg.nc,v 1.9 2004/08/01 06:13:23 jwhui Exp $

/*									tab:4
 *
 *
 * "Copyright (c) 2000-2004 The Regents of the University  of California.  
 * 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 UNIVERSITY OF CALIFORNIA 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 UNIVERSITY OF
 * CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * THE UNIVERSITY OF CALIFORNIA 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 UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
 *
 */

/**
 * Top level interface for network programming integration with
 * applications.
 *
 * @author Jonathan Hui <[e-mail]>
 */

interface NetProg {

  /**
   * Reboot the node.
   *
   * @return  Does not return.
   */
  command result_t reboot();

  /**
   * Reboot into the image specified by <code>imgNum</code>. This
   * assumes that an image has been downloaded into slot <code>imgNum</code>
   * using Deluge.
   *
   * @param imgNum  Number of image to boot in to.
   * @return        <code>FAIL</code> if the reboot command fails to 
   *                complete due to an invalid imgNum or incomplete 
   *                image, 
   *                does not return, otherwise.
   */
  command result_t programImgAndReboot(uint8_t imgNum);

  /**
   * Write a buffer to internal program flash. This allows for
   * programming in place by applications. Due to the page-sized erase
   * granularity, all data contained in the same flash page being
   * written to will be destroyed.
   *
   * @param buf     Buffer to write to internal program flash.
   * @param addr    Byte address location to write to.
   * @param length  Length of write.
   * @return        <code>FAIL</code> if a write to bootloader section
   *                is attempted,
   *                <code>SUCCESS</code> otherwise.
   */
  command result_t programBuf(void* buf, uint32_t addr, uint32_t length);

  /**
   * Get the image number currently executing.
   *
   * @return        The image number of the executing image,
   *                <code>DELUGE_INVALID_IMGNUM</code> otherwise.
   */
  command uint8_t  getExecutingImgNum();

}