3 //==========================================================================
7 // RedBoot - FLASH image directory layout
9 //==========================================================================
10 //####ECOSGPLCOPYRIGHTBEGIN####
11 // -------------------------------------------
12 // This file is part of eCos, the Embedded Configurable Operating System.
13 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
15 // eCos is free software; you can redistribute it and/or modify it under
16 // the terms of the GNU General Public License as published by the Free
17 // Software Foundation; either version 2 or (at your option) any later version.
19 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
20 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
24 // You should have received a copy of the GNU General Public License along
25 // with eCos; if not, write to the Free Software Foundation, Inc.,
26 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
28 // As a special exception, if other files instantiate templates or use macros
29 // or inline functions from this file, or you compile this file and link it
30 // with other works to produce a work based on this file, this file does not
31 // by itself cause the resulting work to be covered by the GNU General Public
32 // License. However the source code for this file must still be made available
33 // in accordance with section (3) of the GNU General Public License.
35 // This exception does not invalidate any other reasons why a work based on
36 // this file might be covered by the GNU General Public License.
38 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
39 // at http://sources.redhat.com/ecos/ecos-license/
40 // -------------------------------------------
41 //####ECOSGPLCOPYRIGHTEND####
42 //==========================================================================
43 //#####DESCRIPTIONBEGIN####
46 // Contributors: gthomas, tkoeller
51 // This code is part of RedBoot (tm).
53 //####DESCRIPTIONEND####
55 //==========================================================================
57 #include <pkgconf/redboot.h>
58 #ifdef CYGOPT_REDBOOT_FIS
59 #include <cyg/infra/cyg_type.h>
61 //the version can be tested via the VV calls to check for compatibility
62 #define CYG_REDBOOT_FIS_VERSION (1)
64 // the following defines will be used if RedBoot is configured
65 // with support for redundant FIS tables, which enable failsafe updating
66 #ifdef CYGOPT_REDBOOT_REDUNDANT_FIS
68 #define CYG_REDBOOT_RFIS_VALID_MAGIC_LENGTH 10
69 #define CYG_REDBOOT_RFIS_VALID_MAGIC ".FisValid" // exactly 10 bytes
71 #define CYG_REDBOOT_RFIS_VALID (0xa5) // this FIS table is valid, the only "good" value
72 #define CYG_REDBOOT_RFIS_IN_PROGRESS (0xfd) // this FIS table is being modified
73 #define CYG_REDBOOT_RFIS_EMPTY (0xff) // this FIS table is empty
77 char magic_name[CYG_REDBOOT_RFIS_VALID_MAGIC_LENGTH];
78 unsigned char valid_flag[2]; // one of the flags defined above
79 unsigned long version_count; // with each successfull update the version count will increase by 1
82 #endif // CYGOPT_REDBOOT_REDUNDANT_FIS
84 #define FIS_IMAGE_DESC_SIZE_UNPADDED \
85 (16 + 4 * sizeof(unsigned long) + 3 * sizeof(CYG_ADDRESS))
87 struct fis_image_desc {
90 unsigned char name[16]; // Null terminated name
91 #ifdef CYGOPT_REDBOOT_REDUNDANT_FIS
92 struct fis_valid_info valid_info;
95 CYG_ADDRESS flash_base; // Address within FLASH of image
96 CYG_ADDRESS mem_base; // Address in memory where it executes
97 unsigned long size; // Length of image
98 CYG_ADDRESS entry_point; // Execution entry point
99 unsigned long data_length; // Length of actual data
100 unsigned char _pad[CYGNUM_REDBOOT_FIS_DIRECTORY_ENTRY_SIZE-FIS_IMAGE_DESC_SIZE_UNPADDED];
101 unsigned long desc_cksum; // Checksum over image descriptor
102 unsigned long file_cksum; // Checksum over image data
105 struct fis_image_desc *fis_lookup(char *name, int *num);
107 #endif // CYGOPT_REDBOOT_FIS