Contiki 2.5
loader-arch.h
1 /*
2  * Copyright (c) 2005, Swedish Institute of Computer Science
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the Institute nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * This file is part of the Contiki operating system.
30  *
31  * @(#)$Id: loader-arch.h,v 1.1 2006/06/21 13:39:11 nifi Exp $
32  */
33 #ifndef __LOADER_ARCH_H__
34 #define __LOADER_ARCH_H__
35 
36 /**
37  * Load a program from EEPROM.
38  *
39  * This function loads a program from EEPROM into the flash ROM (code) and RAM (data).
40  *
41  * \param code The address of the first byte of code in the EEPROM.
42  *
43  * \param codelen The length of the code.
44  *
45  * \param data The address of the first byte of data in the EEPROM.
46  *
47  * \param datalen The length of the data.
48  *
49  */
50 void loader_arch_load(unsigned short startaddr);
51 
52 /**
53  * Unload a program.
54  *
55  * This function should not be called directly, but accessed through
56  * the macro LOADER_UNLOAD(). The function unloads a program from both
57  * RAM and ROM.
58  *
59  * \param codeaddr A pointer to the first byte of program code.
60  *
61  * \param dataaddr A pointer to the first byte of program data.
62  */
63 void loader_arch_free(void *codeaddr, void *dataaddr);
64 
65 extern void *loader_arch_codeaddr, *loader_arch_dataaddr;
66 
67 #ifndef LOADER_UNLOAD
68 #define LOADER_UNLOAD() loader_arch_free(&loader_arch_codeaddr, &loader_arch_dataaddr)
69 #endif
70 
71 #define LOADER_ARCH_MAGIC 0x373a
72 #define LOADER_ARCH_VERSION 0x0001
73 
74 #endif /* __LOADER_ARCH_H__ */