xref: /rk3399_ARM-atf/tools/fiptool/fiptool.h (revision 51faada71a219a8b94cd8d8e423f0f22e9da4d8f)
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 "firmware_image_package.h"
38 #include "uuid.h"
39 
40 #define NELEM(x) (sizeof (x) / sizeof *(x))
41 
42 enum {
43 	DO_UNSPEC = 0,
44 	DO_PACK   = 1,
45 	DO_UNPACK = 2,
46 	DO_REMOVE = 3
47 };
48 
49 enum {
50 	LOG_DBG,
51 	LOG_WARN,
52 	LOG_ERR
53 };
54 
55 typedef struct image_desc {
56 	uuid_t             uuid;
57 	char              *name;
58 	char              *cmdline_name;
59 	int                action;
60 	char              *action_arg;
61 	struct image      *image;
62 	struct image_desc *next;
63 } image_desc_t;
64 
65 typedef struct image {
66 	struct fip_toc_entry toc_e;
67 	void                *buffer;
68 } image_t;
69 
70 typedef struct cmd {
71 	char              *name;
72 	int              (*handler)(int, char **);
73 	void             (*usage)(void);
74 } cmd_t;
75 
76 #endif /* __FIPTOOL_H__ */
77