Mercurial > flash_v2

annotate packages/redboot/current/include/sib.h @ 1775:79275fdb4f20

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* src/legacy_dev.c (legacy_flash_program): Added missing definition of block_size. * legacy_api.c: Added missing wrappers for flash_lock and flash_unlock
author asl
date Fri, 02 Feb 2007 20:06:03 +0000
parents d2c90368aeef
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
195
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
1 #ifndef _SIB_H_
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
2 #define _SIB_H_
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
3 //==========================================================================
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
4 //
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
5 // sib.h
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
6 //
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
7 // RedBoot - structure of ARM flash file format
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
8 //
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
9 //==========================================================================
208
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
10 //####ECOSGPLCOPYRIGHTBEGIN####
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
11 // -------------------------------------------
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
12 // This file is part of eCos, the Embedded Configurable Operating System.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
13 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Red Hat, Inc.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
14 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
15 // eCos is free software; you can redistribute it and/or modify it under
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
16 // the terms of the GNU General Public License as published by the Free
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
17 // Software Foundation; either version 2 or (at your option) any later version.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
18 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
19 // eCos is distributed in the hope that it will be useful, but WITHOUT ANY
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
20 // WARRANTY; without even the implied warranty of MERCHANTABILITY or
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
21 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
22 // for more details.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
23 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
24 // You should have received a copy of the GNU General Public License along
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
25 // with eCos; if not, write to the Free Software Foundation, Inc.,
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
26 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
27 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
28 // As a special exception, if other files instantiate templates or use macros
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
29 // or inline functions from this file, or you compile this file and link it
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
30 // with other works to produce a work based on this file, this file does not
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
31 // by itself cause the resulting work to be covered by the GNU General Public
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
32 // License. However the source code for this file must still be made available
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
33 // in accordance with section (3) of the GNU General Public License.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
34 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
35 // This exception does not invalidate any other reasons why a work based on
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
36 // this file might be covered by the GNU General Public License.
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
37 //
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
38 // Alternative licenses for eCos may be arranged by contacting Red Hat, Inc.
210
d2c90368aeef Merge from eCos master repository on 2002-05-23-21:39:14-BST
jlarmour
parents: 208
diff changeset
39 // at http://sources.redhat.com/ecos/ecos-license/
208
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
40 // -------------------------------------------
e0c0827131d1 Merge from eCos master repository on 2002-05-20-20:11:54-BST
jlarmour
parents: 195
diff changeset
41 //####ECOSGPLCOPYRIGHTEND####
195
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
42 //==========================================================================
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
43 //#####DESCRIPTIONBEGIN####
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
44 //
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
45 // Author(s): Philippe Robin
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
46 // Contributors: Philippe Robin, jskov
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
47 // Date: 2001-10-31
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
48 // Purpose:
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
49 // Description:
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
50 //
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
51 // This code is part of RedBoot (tm).
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
52 //
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
53 //####DESCRIPTIONEND####
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
54 //
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
55 //==========================================================================
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
56
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
57 #include <cyg/hal/hal_io.h>
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
58
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
59 /* type information :-
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
60 * 0xffff ffff - deleted (usual flash erased value)
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
61 * 0x0000 xxxx - Reserved for ARM usage:
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
62 * Bit 0 - ARM Executable Image
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
63 * Bit 1 - System Information Block
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
64 * Bit 2 - File System Block
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
65 * 0xyyyy 0000 - Available for customers (y != 0)
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
66 */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
67 #define TYPE_DELETED 0xFFFFFFFF
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
68 #define TYPE_ARM_MASK 0x0000FFFF
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
69 #define TYPE_CUSTOM_MASK 0xFFFF0000
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
70 #define TYPE_ARM_EXEC 0x00000001
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
71 #define TYPE_ARM_SIB 0x00000002
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
72 #define TYPE_ARM_SYSBLOCK 0x00000004
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
73
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
74 /* This is the type we use for RedBoot blocks */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
75 #define TYPE_REDHAT_REDBOOT 0x52420000
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
76
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
77 /* The ARM monitor may be using a different memory mapping than RedBoot */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
78 #ifndef _ADDR_REDBOOT_TO_ARM
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
79 # define _ADDR_REDBOOT_TO_ARM(x)
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
80 #endif
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
81
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
82 /* Filetypes */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
83
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
84 #define UNKNOWN_FILE 0x00000000
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
85 #define MOT_S_RECORD 0x00000001
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
86 #define INTEL_HEX 0x00000002
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
87 #define ELF 0x00000004
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
88 #define DWARF 0x00000008
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
89 #define ARM_AOF 0x00000010
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
90 #define ARM_AIF 0x00000020
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
91 #define PLAIN_BINARY 0x00000040
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
92 #define ARM_AIF_BIN 0x00000080
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
93 #define MCS_TYPE 0x00000100
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
94
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
95 #define CONVERT_TYPE (MOT_S_RECORD | INTEL_HEX | MCS_TYPE | ELF)
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
96
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
97 #define SIB_OWNER_STRING_SIZE 32
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
98 #define MAX_SIB_SIZE 512
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
99 #define MAX_SIB_INDEX 64
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
100
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
101 #define SIB_HEADER_SIGNATURE 0xA00FFF9F /* This is an invalid instruction - MULGE pc,pc,pc */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
102 #define FLASH_FOOTER_SIGNATURE 0xA0FFFF9F /* This is an invalid instruction - SMULALGES pc,pc,pc */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
103
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
104
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
105 typedef struct SIBType {
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
106 cyg_uint32 signature;
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
107 cyg_uint32 size;
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
108 char owner[SIB_OWNER_STRING_SIZE];
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
109 cyg_uint32 index;
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
110 cyg_uint32 revision;
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
111 cyg_uint32 checksum;
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
112 } tSIB;
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
113
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
114 typedef struct SIBInfoType {
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
115 cyg_uint32 SIB_number; /* Unique number of SIB Block */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
116 cyg_uint32 SIB_Extension; /* Base of SIB Flash Block */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
117 char Label[16]; /* String space for ownership string */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
118 cyg_uint32 checksum; /* SIB Image checksum */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
119 } tSIBInfo;
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
120
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
121 typedef struct FooterType {
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
122 void *infoBase; /* Address of first word of ImageFooter */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
123 char *blockBase; /* Start of area reserved by this footer */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
124 cyg_uint32 signature; /* 'Magic' number proves it's a footer */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
125 cyg_uint32 type; /* Area type: ARM Image, SIB, customer */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
126 cyg_uint32 checksum; /* Just this structure */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
127 } tFooter ;
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
128
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
129 typedef struct ImageInfoType {
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
130 cyg_uint32 bootFlags; /* Boot flags, compression etc. */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
131 cyg_uint32 imageNumber; /* Unique number, selects for boot etc. */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
132 char *loadAddress; /* Address program should be loaded to */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
133 cyg_uint32 length; /* Actual size of image */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
134 char *address; /* Image is executed from here */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
135 char name[16]; /* Null terminated */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
136 char *headerBase; /* Flash Address of any stripped header */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
137 cyg_uint32 header_length; /* Length of header in memory */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
138 cyg_uint32 headerType; /* AIF, RLF, s-record etc. */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
139 cyg_uint32 checksum; /* Image checksum (inc. this struct) */
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
140 } tImageInfo;
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
141
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
142
67850532eebb Merge from eCos master repository on 2001-11-02-06:43:03-GMT
jlarmour
parents:
diff changeset
143 #endif // _SIB_H_