Contiki 2.6

loader-arch.h

00001 /*
00002  * Copyright (c) 2005, Swedish Institute of Computer Science
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions
00007  * are met:
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. Neither the name of the Institute nor the names of its contributors
00014  *    may be used to endorse or promote products derived from this software
00015  *    without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
00018  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
00021  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00022  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00023  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00024  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00025  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00026  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00027  * SUCH DAMAGE.
00028  *
00029  * This file is part of the Contiki operating system.
00030  *
00031  * @(#)$Id: loader-arch.h,v 1.1 2006/06/21 13:39:11 nifi Exp $
00032  */
00033 #ifndef __LOADER_ARCH_H__
00034 #define __LOADER_ARCH_H__
00035 
00036 /**
00037  * Load a program from EEPROM.
00038  *
00039  * This function loads a program from EEPROM into the flash ROM (code) and RAM (data).
00040  *
00041  * \param code The address of the first byte of code in the EEPROM.
00042  *
00043  * \param codelen The length of the code.
00044  *
00045  * \param data The address of the first byte of data in the EEPROM.
00046  *
00047  * \param datalen The length of the data.
00048  *
00049  */
00050 void loader_arch_load(unsigned short startaddr);
00051 
00052 /**
00053  * Unload a program.
00054  *
00055  * This function should not be called directly, but accessed through
00056  * the macro LOADER_UNLOAD(). The function unloads a program from both
00057  * RAM and ROM.
00058  *
00059  * \param codeaddr A pointer to the first byte of program code.
00060  *
00061  * \param dataaddr A pointer to the first byte of program data.
00062  */
00063 void loader_arch_free(void *codeaddr, void *dataaddr);
00064 
00065 extern void *loader_arch_codeaddr, *loader_arch_dataaddr;
00066 
00067 #ifndef LOADER_UNLOAD
00068 #define LOADER_UNLOAD() loader_arch_free(&loader_arch_codeaddr, &loader_arch_dataaddr)
00069 #endif
00070 
00071 #define LOADER_ARCH_MAGIC 0x373a
00072 #define LOADER_ARCH_VERSION 0x0001
00073 
00074 #endif /* __LOADER_ARCH_H__ */