fip: move headers shared between TF and fiptool to include/tools_share

Some header files need to be shared between TF and host programs.
For fiptool, two headers are copied to the tools/fiptool directory,
but it looks clumsy.

This commit introduces a new directory, include/tools_share, which
collects headers that should be shared between TF and host programs.

This will clarify the interface exposed to host tools.  We should
add new headers to this directory only when we really need to do so.

For clarification, I inserted a blank line between headers from the
include/ directory (#include <...>) and ones from a local directory
(#include "..." ).

Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>

.gitignore

@@ -19,10 +19,6 @@ tools/cert_create/src/**/*.o
 tools/cert_create/cert_create
 tools/cert_create/cert_create.exe
 
-# Ignore header files copied.
-tools/fiptool/firmware_image_package.h
-tools/fiptool/uuid.h
-
 # GNU GLOBAL files
 GPATH
 GRTAGS

Makefile

@@ -176,7 +176,8 @@ INCLUDES		+=	-Iinclude/bl1				\
 				-Iinclude/plat/common			\
 				-Iinclude/services			\
 				${PLAT_INCLUDES}			\
-				${SPD_INCLUDES}
+				${SPD_INCLUDES}				\
+				-Iinclude/tools_share
 
 
 ################################################################################

tools/fiptool/Makefile

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2014-2016, ARM Limited and Contributors. All rights reserved.
+# Copyright (c) 2014-2017, ARM Limited and Contributors. All rights reserved.
 #
 # SPDX-License-Identifier: BSD-3-Clause
 #
@@ -11,7 +11,6 @@ include ${MAKE_HELPERS_DIRECTORY}build_env.mk
 PROJECT := fiptool${BIN_EXT}
 OBJECTS := fiptool.o tbbr_config.o
 V := 0
-COPIED_H_FILES := uuid.h firmware_image_package.h
 
 override CPPFLAGS += -D_GNU_SOURCE -D_XOPEN_SOURCE=700
 CFLAGS := -Wall -Werror -pedantic -std=c99
@@ -28,8 +27,7 @@ else
   Q :=
 endif
 
-# Only include from local directory (see comment below).
-INCLUDE_PATHS := -I.
+INCLUDE_PATHS := -I. -I../../include/tools_share
 
 CC := gcc
 
@@ -48,24 +46,9 @@ fip_create: fip_create.sh
 	${Q}mkdir -p ../fip_create
 	${Q}install -m 755 fip_create.sh ../fip_create/fip_create
 
-%.o: %.c %.h ${COPIED_H_FILES} Makefile
+%.o: %.c %.h Makefile
 	@echo "  CC      $<"
 	${Q}${CC} -c ${CPPFLAGS} ${CFLAGS} ${INCLUDE_PATHS} $< -o $@
 
-#
-# Copy required library headers to a local directory so they can be included
-# by this project without adding the library directories to the system include
-# path. This avoids conflicts with definitions in the compiler standard
-# include path.
-#
-uuid.h : ../../include/lib/stdlib/sys/uuid.h
-	$(call SHELL_COPY,$<,$@)
-
-firmware_image_package.h : ../../include/common/firmware_image_package.h
-	$(call SHELL_COPY,$<,$@)
-
 clean:
 	$(call SHELL_DELETE_ALL, ${PROJECT} ${OBJECTS} fip_create)
-
-distclean: clean
-	$(call SHELL_DELETE_ALL, ${COPIED_H_FILES})

tools/fiptool/fiptool.c

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, ARM Limited and Contributors. All rights reserved.
+ * Copyright (c) 2016-2017, ARM Limited and Contributors. All rights reserved.
  *
  * SPDX-License-Identifier: BSD-3-Clause
  */
@@ -20,8 +20,9 @@
 
 #include <openssl/sha.h>
 
+#include <firmware_image_package.h>
+
 #include "fiptool.h"
-#include "firmware_image_package.h"
 #include "tbbr_config.h"
 
 #define OPT_TOC_ENTRY 0

tools/fiptool/fiptool.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, ARM Limited and Contributors. All rights reserved.
+ * Copyright (c) 2016-2017, ARM Limited and Contributors. All rights reserved.
  *
  * SPDX-License-Identifier: BSD-3-Clause
  */
@@ -10,8 +10,8 @@
 #include <stddef.h>
 #include <stdint.h>
 
-#include "firmware_image_package.h"
-#include "uuid.h"
+#include <firmware_image_package.h>
+#include <uuid.h>
 
 #define NELEM(x) (sizeof (x) / sizeof *(x))
 

tools/fiptool/tbbr_config.c

@@ -1,12 +1,13 @@
 /*
- * Copyright (c) 2016, ARM Limited and Contributors. All rights reserved.
+ * Copyright (c) 2016-2017, ARM Limited and Contributors. All rights reserved.
  *
  * SPDX-License-Identifier: BSD-3-Clause
  */
 
 #include <stddef.h>
 
-#include "firmware_image_package.h"
+#include <firmware_image_package.h>
+
 #include "tbbr_config.h"
 
 /* The images used depends on the platform. */

tools/fiptool/tbbr_config.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2016, ARM Limited and Contributors. All rights reserved.
+ * Copyright (c) 2016-2017, ARM Limited and Contributors. All rights reserved.
  *
  * SPDX-License-Identifier: BSD-3-Clause
  */
@@ -9,7 +9,7 @@
 
 #include <stdint.h>
 
-#include "uuid.h"
+#include <uuid.h>
 
 /* TODO: Update this number as required */
 #define TOC_HEADER_SERIAL_NUMBER 0x12345678