Skip to content
Snippets Groups Projects
image-fit.c 39.1 KiB
Newer Older
  • Learn to ignore specific revisions
  • 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467
    		}
    	}
    	return 1;
    }
    
    /**
     * fit_image_check_os - check whether image node is of a given os type
     * @fit: pointer to the FIT format image header
     * @noffset: component image node offset
     * @os: requested image os
     *
     * fit_image_check_os() reads image os property and compares its numeric
     * id with the requested os. Comparison result is returned to the caller.
     *
     * returns:
     *     1 if image is of given os type
     *     0 otherwise (or on error)
     */
    int fit_image_check_os(const void *fit, int noffset, uint8_t os)
    {
    	uint8_t image_os;
    
    	if (fit_image_get_os(fit, noffset, &image_os))
    		return 0;
    	return (os == image_os);
    }
    
    /**
     * fit_image_check_arch - check whether image node is of a given arch
     * @fit: pointer to the FIT format image header
     * @noffset: component image node offset
     * @arch: requested imagearch
     *
     * fit_image_check_arch() reads image arch property and compares its numeric
     * id with the requested arch. Comparison result is returned to the caller.
     *
     * returns:
     *     1 if image is of given arch
     *     0 otherwise (or on error)
     */
    int fit_image_check_arch(const void *fit, int noffset, uint8_t arch)
    {
    	uint8_t image_arch;
    
    	if (fit_image_get_arch(fit, noffset, &image_arch))
    		return 0;
    	return (arch == image_arch);
    }
    
    /**
     * fit_image_check_type - check whether image node is of a given type
     * @fit: pointer to the FIT format image header
     * @noffset: component image node offset
     * @type: requested image type
     *
     * fit_image_check_type() reads image type property and compares its numeric
     * id with the requested type. Comparison result is returned to the caller.
     *
     * returns:
     *     1 if image is of given type
     *     0 otherwise (or on error)
     */
    int fit_image_check_type(const void *fit, int noffset, uint8_t type)
    {
    	uint8_t image_type;
    
    	if (fit_image_get_type(fit, noffset, &image_type))
    		return 0;
    	return (type == image_type);
    }
    
    /**
     * fit_image_check_comp - check whether image node uses given compression
     * @fit: pointer to the FIT format image header
     * @noffset: component image node offset
     * @comp: requested image compression type
     *
     * fit_image_check_comp() reads image compression property and compares its
     * numeric id with the requested compression type. Comparison result is
     * returned to the caller.
     *
     * returns:
     *     1 if image uses requested compression
     *     0 otherwise (or on error)
     */
    int fit_image_check_comp(const void *fit, int noffset, uint8_t comp)
    {
    	uint8_t image_comp;
    
    	if (fit_image_get_comp(fit, noffset, &image_comp))
    		return 0;
    	return (comp == image_comp);
    }
    
    /**
     * fit_check_format - sanity check FIT image format
     * @fit: pointer to the FIT format image header
     *
     * fit_check_format() runs a basic sanity FIT image verification.
     * Routine checks for mandatory properties, nodes, etc.
     *
     * returns:
     *     1, on success
     *     0, on failure
     */
    int fit_check_format(const void *fit)
    {
    	/* mandatory / node 'description' property */
    	if (fdt_getprop(fit, 0, FIT_DESC_PROP, NULL) == NULL) {
    		debug("Wrong FIT format: no description\n");
    		return 0;
    	}
    
    	if (IMAGE_ENABLE_TIMESTAMP) {
    		/* mandatory / node 'timestamp' property */
    		if (fdt_getprop(fit, 0, FIT_TIMESTAMP_PROP, NULL) == NULL) {
    			debug("Wrong FIT format: no timestamp\n");
    			return 0;
    		}
    	}
    
    	/* mandatory subimages parent '/images' node */
    	if (fdt_path_offset(fit, FIT_IMAGES_PATH) < 0) {
    		debug("Wrong FIT format: no images parent node\n");
    		return 0;
    	}
    
    	return 1;
    }
    
    
    /**
     * fit_conf_find_compat
     * @fit: pointer to the FIT format image header
     * @fdt: pointer to the device tree to compare against
     *
     * fit_conf_find_compat() attempts to find the configuration whose fdt is the
     * most compatible with the passed in device tree.
     *
     * Example:
     *
     * / o image-tree
     *   |-o images
     *   | |-o fdt@1
     *   | |-o fdt@2
     *   |
     *   |-o configurations
     *     |-o config@1
     *     | |-fdt = fdt@1
     *     |
     *     |-o config@2
     *       |-fdt = fdt@2
     *
     * / o U-Boot fdt
     *   |-compatible = "foo,bar", "bim,bam"
     *
     * / o kernel fdt1
     *   |-compatible = "foo,bar",
     *
     * / o kernel fdt2
     *   |-compatible = "bim,bam", "baz,biz"
     *
     * Configuration 1 would be picked because the first string in U-Boot's
     * compatible list, "foo,bar", matches a compatible string in the root of fdt1.
     * "bim,bam" in fdt2 matches the second string which isn't as good as fdt1.
     *
     * returns:
     *     offset to the configuration to use if one was found
     *     -1 otherwise
     */
    int fit_conf_find_compat(const void *fit, const void *fdt)
    {
    	int ndepth = 0;
    	int noffset, confs_noffset, images_noffset;
    	const void *fdt_compat;
    	int fdt_compat_len;
    	int best_match_offset = 0;
    	int best_match_pos = 0;
    
    	confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
    	images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
    	if (confs_noffset < 0 || images_noffset < 0) {
    		debug("Can't find configurations or images nodes.\n");
    		return -1;
    	}
    
    	fdt_compat = fdt_getprop(fdt, 0, "compatible", &fdt_compat_len);
    	if (!fdt_compat) {
    		debug("Fdt for comparison has no \"compatible\" property.\n");
    		return -1;
    	}
    
    	/*
    	 * Loop over the configurations in the FIT image.
    	 */
    	for (noffset = fdt_next_node(fit, confs_noffset, &ndepth);
    			(noffset >= 0) && (ndepth > 0);
    			noffset = fdt_next_node(fit, noffset, &ndepth)) {
    		const void *kfdt;
    		const char *kfdt_name;
    		int kfdt_noffset;
    		const char *cur_fdt_compat;
    		int len;
    		size_t size;
    		int i;
    
    		if (ndepth > 1)
    			continue;
    
    		kfdt_name = fdt_getprop(fit, noffset, "fdt", &len);
    		if (!kfdt_name) {
    			debug("No fdt property found.\n");
    			continue;
    		}
    		kfdt_noffset = fdt_subnode_offset(fit, images_noffset,
    						  kfdt_name);
    		if (kfdt_noffset < 0) {
    			debug("No image node named \"%s\" found.\n",
    			      kfdt_name);
    			continue;
    		}
    		/*
    		 * Get a pointer to this configuration's fdt.
    		 */
    		if (fit_image_get_data(fit, kfdt_noffset, &kfdt, &size)) {
    			debug("Failed to get fdt \"%s\".\n", kfdt_name);
    			continue;
    		}
    
    		len = fdt_compat_len;
    		cur_fdt_compat = fdt_compat;
    		/*
    		 * Look for a match for each U-Boot compatibility string in
    		 * turn in this configuration's fdt.
    		 */
    		for (i = 0; len > 0 &&
    		     (!best_match_offset || best_match_pos > i); i++) {
    			int cur_len = strlen(cur_fdt_compat) + 1;
    
    			if (!fdt_node_check_compatible(kfdt, 0,
    						       cur_fdt_compat)) {
    				best_match_offset = noffset;
    				best_match_pos = i;
    				break;
    			}
    			len -= cur_len;
    			cur_fdt_compat += cur_len;
    		}
    	}
    	if (!best_match_offset) {
    		debug("No match found.\n");
    		return -1;
    	}
    
    	return best_match_offset;
    }
    
    /**
     * fit_conf_get_node - get node offset for configuration of a given unit name
     * @fit: pointer to the FIT format image header
     * @conf_uname: configuration node unit name
     *
     * fit_conf_get_node() finds a configuration (withing the '/configurations'
     * parant node) of a provided unit name. If configuration is found its node
     * offset is returned to the caller.
     *
     * When NULL is provided in second argument fit_conf_get_node() will search
     * for a default configuration node instead. Default configuration node unit
     * name is retrived from FIT_DEFAULT_PROP property of the '/configurations'
     * node.
     *
     * returns:
     *     configuration node offset when found (>=0)
     *     negative number on failure (FDT_ERR_* code)
     */
    int fit_conf_get_node(const void *fit, const char *conf_uname)
    {
    	int noffset, confs_noffset;
    	int len;
    
    	confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
    	if (confs_noffset < 0) {
    		debug("Can't find configurations parent node '%s' (%s)\n",
    		      FIT_CONFS_PATH, fdt_strerror(confs_noffset));
    		return confs_noffset;
    	}
    
    	if (conf_uname == NULL) {
    		/* get configuration unit name from the default property */
    		debug("No configuration specified, trying default...\n");
    		conf_uname = (char *)fdt_getprop(fit, confs_noffset,
    						 FIT_DEFAULT_PROP, &len);
    		if (conf_uname == NULL) {
    			fit_get_debug(fit, confs_noffset, FIT_DEFAULT_PROP,
    				      len);
    			return len;
    		}
    		debug("Found default configuration: '%s'\n", conf_uname);
    	}
    
    	noffset = fdt_subnode_offset(fit, confs_noffset, conf_uname);
    	if (noffset < 0) {
    		debug("Can't get node offset for configuration unit name: '%s' (%s)\n",
    		      conf_uname, fdt_strerror(noffset));
    	}
    
    	return noffset;
    }
    
    static int __fit_conf_get_prop_node(const void *fit, int noffset,
    		const char *prop_name)
    {
    	char *uname;
    	int len;
    
    	/* get kernel image unit name from configuration kernel property */
    	uname = (char *)fdt_getprop(fit, noffset, prop_name, &len);
    	if (uname == NULL)
    		return len;
    
    	return fit_image_get_node(fit, uname);
    }
    
    /**
     * fit_conf_get_kernel_node - get kernel image node offset that corresponds to
     * a given configuration
     * @fit: pointer to the FIT format image header
     * @noffset: configuration node offset
     *
     * fit_conf_get_kernel_node() retrives kernel image node unit name from
     * configuration FIT_KERNEL_PROP property and translates it to the node
     * offset.
     *
     * returns:
     *     image node offset when found (>=0)
     *     negative number on failure (FDT_ERR_* code)
     */
    int fit_conf_get_kernel_node(const void *fit, int noffset)
    {
    	return __fit_conf_get_prop_node(fit, noffset, FIT_KERNEL_PROP);
    }
    
    /**
     * fit_conf_get_ramdisk_node - get ramdisk image node offset that corresponds to
     * a given configuration
     * @fit: pointer to the FIT format image header
     * @noffset: configuration node offset
     *
     * fit_conf_get_ramdisk_node() retrives ramdisk image node unit name from
     * configuration FIT_KERNEL_PROP property and translates it to the node
     * offset.
     *
     * returns:
     *     image node offset when found (>=0)
     *     negative number on failure (FDT_ERR_* code)
     */
    int fit_conf_get_ramdisk_node(const void *fit, int noffset)
    {
    	return __fit_conf_get_prop_node(fit, noffset, FIT_RAMDISK_PROP);
    }
    
    /**
     * fit_conf_get_fdt_node - get fdt image node offset that corresponds to
     * a given configuration
     * @fit: pointer to the FIT format image header
     * @noffset: configuration node offset
     *
     * fit_conf_get_fdt_node() retrives fdt image node unit name from
     * configuration FIT_KERNEL_PROP property and translates it to the node
     * offset.
     *
     * returns:
     *     image node offset when found (>=0)
     *     negative number on failure (FDT_ERR_* code)
     */
    int fit_conf_get_fdt_node(const void *fit, int noffset)
    {
    	return __fit_conf_get_prop_node(fit, noffset, FIT_FDT_PROP);
    }
    
    /**
     * fit_conf_print - prints out the FIT configuration details
     * @fit: pointer to the FIT format image header
     * @noffset: offset of the configuration node
     * @p: pointer to prefix string
     *
     * fit_conf_print() lists all mandatory properies for the processed
     * configuration node.
     *
     * returns:
     *     no returned results
     */
    void fit_conf_print(const void *fit, int noffset, const char *p)
    {
    	char *desc;
    	char *uname;
    	int ret;
    
    	/* Mandatory properties */
    	ret = fit_get_desc(fit, noffset, &desc);
    	printf("%s  Description:  ", p);
    	if (ret)
    		printf("unavailable\n");
    	else
    		printf("%s\n", desc);
    
    	uname = (char *)fdt_getprop(fit, noffset, FIT_KERNEL_PROP, NULL);
    	printf("%s  Kernel:       ", p);
    	if (uname == NULL)
    		printf("unavailable\n");
    	else
    		printf("%s\n", uname);
    
    	/* Optional properties */
    	uname = (char *)fdt_getprop(fit, noffset, FIT_RAMDISK_PROP, NULL);
    	if (uname)
    		printf("%s  Init Ramdisk: %s\n", p, uname);
    
    	uname = (char *)fdt_getprop(fit, noffset, FIT_FDT_PROP, NULL);
    	if (uname)
    		printf("%s  FDT:          %s\n", p, uname);
    }
    
    /**
     * fit_check_ramdisk - verify FIT format ramdisk subimage
     * @fit_hdr: pointer to the FIT ramdisk header
     * @rd_noffset: ramdisk subimage node offset within FIT image
     * @arch: requested ramdisk image architecture type
     * @verify: data CRC verification flag
     *
     * fit_check_ramdisk() verifies integrity of the ramdisk subimage and from
     * specified FIT image.
     *
     * returns:
     *     1, on success
     *     0, on failure
     */
    #ifndef USE_HOSTCC
    int fit_check_ramdisk(const void *fit, int rd_noffset, uint8_t arch,
    			int verify)
    {
    	fit_image_print(fit, rd_noffset, "   ");
    
    	if (verify) {
    		puts("   Verifying Hash Integrity ... ");
    		if (!fit_image_check_hashes(fit, rd_noffset)) {
    			puts("Bad Data Hash\n");
    			bootstage_error(BOOTSTAGE_ID_FIT_RD_HASH);
    			return 0;
    		}
    		puts("OK\n");
    	}
    
    	bootstage_mark(BOOTSTAGE_ID_FIT_RD_CHECK_ALL);
    	if (!fit_image_check_os(fit, rd_noffset, IH_OS_LINUX) ||
    	    !fit_image_check_arch(fit, rd_noffset, arch) ||
    	    !fit_image_check_type(fit, rd_noffset, IH_TYPE_RAMDISK)) {
    		printf("No Linux %s Ramdisk Image\n",
    		       genimg_get_arch_name(arch));
    		bootstage_error(BOOTSTAGE_ID_FIT_RD_CHECK_ALL);
    		return 0;
    	}
    
    	bootstage_mark(BOOTSTAGE_ID_FIT_RD_CHECK_ALL_OK);
    	return 1;
    }
    #endif /* USE_HOSTCC */