xref: /rk3399_ARM-atf/tools/fiptool/fiptool.h (revision 9f3ee61c904e4b6d2038086718c5ec4237d544a8)
1 /*
2  * Copyright (c) 2016, ARM Limited and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * Neither the name of ARM nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without specific
16  * prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef __FIPTOOL_H__
32 #define __FIPTOOL_H__
33 
34 #include <stddef.h>
35 #include <stdint.h>
36 
37 #include "uuid.h"
38 
39 #define NELEM(x) (sizeof (x) / sizeof *(x))
40 
41 /* TODO: Do not hardcode, use realloc() */
42 #define MAX_IMAGES 32
43 
44 enum {
45 	DO_PACK   = 1,
46 	DO_UNPACK = 2,
47 	DO_REMOVE = 3
48 };
49 
50 enum {
51 	LOG_DBG,
52 	LOG_WARN,
53 	LOG_ERR
54 };
55 
56 typedef struct image {
57 	uuid_t            uuid;
58 	size_t            size;
59 	void             *buffer;
60 } image_t;
61 
62 typedef struct cmd {
63 	char             *name;
64 	int             (*handler)(int, char **);
65 	void            (*usage)(void);
66 } cmd_t;
67 
68 #endif /* __FIPTOOL_H__ */
69