Skip to contentSkip to conversation

mips: start.S: Add Octeon boot header compatibility

PATCH New Stefan Roese 2 participants 11 messages Oct 28, 2020 – Nov 30, 2020 MIPS

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/5 mips: start.S: Add Octeon boot header compatibility

Octeon has a specific boot header, when booted via SPI NOR, NAND or MMC. Here the only 2 instructions are allowed in the first few bytes of the image. And these instructions need to be one branch and a nop. This patch adds the necessary nop after the nop, to that the common MIPS image is compatible with this Octeon header.

The tool to patch the Octeon boot header into the image will be send in a follow-up patch.

Cc Aaron Williams <[email protected]>
Cc Chandrakala Chavva <[email protected]>
Cc Daniel Schwierzeck <[email protected]>

---
v2:
- Enhance comment
- Fix delay slot indentation

 arch/mips/cpu/start.S | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)
arch/mips/cpu/start.S +8 -2
index d0c412236d..335aafa6a8 100644
@@ -74,9 +74,14 @@
 	.endm
 
 ENTRY(_start)
-	/* U-Boot entry point */
+	/*
+	 * U-Boot entry point.
+	 * Do not add instructions to the branch delay slot! Some SoC's
+	 * like Octeon might patch the final U-Boot binary at this location
+	 * with additional boot headers.
+	 */
 	b	reset
-	 mtc0	zero, CP0_COUNT	# clear cp0 count for most accurate boot timing
+	 nop
 
 #if defined(CONFIG_MIPS_INSERT_BOOT_CONFIG)
 	/*
@@ -123,6 +128,7 @@ ENTRY(_start)
 #endif
 
 reset:
+	mtc0	zero, CP0_COUNT	# clear cp0 count for most accurate boot timing
 #if __mips_isa_rev >= 6
 	mfc0	t0, CP0_CONFIG, 5
 	and	t0, t0, MIPS_CONF5_VP
Signature · 1 line
2.29.1
#1 lore raw

PATCH v2 1/5 mips: start.S: Add Octeon boot header compatibility

Hi Daniel,

Quoted 9 lines · Stefan Roese

Octeon has a specific boot header, when booted via SPI NOR, NAND or MMC. Here the only 2 instructions are allowed in the first few bytes of the image. And these instructions need to be one branch and a nop. This patch adds the necessary nop after the nop, to that the common MIPS image is compatible with this Octeon header.

The tool to patch the Octeon boot header into the image will be send in a follow-up patch.

Quoted 8 lines
Cc Aaron Williams <[email protected]>
Cc Chandrakala Chavva <[email protected]>
Cc Daniel Schwierzeck <[email protected]>

---
v2:
- Enhance comment
- Fix delay slot indentation

Do you have any comments on this patchset? What is your plan with it? Could you integrate it in the upcoming release? It includes some fixes, which would be really helpful in the release and does not touch platforms other than Octeon (other than this small patch here).

Thanks,
Stefan

Quoted 26 lines
  arch/mips/cpu/start.S | 10 ++++++++--
  1 file changed, 8 insertions(+), 2 deletions(-)
arch/mips/cpu/start.S +7 -2
index d0c412236d..335aafa6a8 100644
@@ -74,9 +74,14 @@
  	.endm
 
  ENTRY(_start)
-	/* U-Boot entry point */
+	/*
+	 * U-Boot entry point.
+	 * Do not add instructions to the branch delay slot! Some SoC's
+	 * like Octeon might patch the final U-Boot binary at this location
+	 * with additional boot headers.
+	 */
  	b	reset
-	 mtc0	zero, CP0_COUNT	# clear cp0 count for most accurate boot timing
+	 nop
 
  #if defined(CONFIG_MIPS_INSERT_BOOT_CONFIG)
  	/*

arch/mips/cpu/start.S ENTRY(_start) · line 134

Quoted 7 lines
arch/mips/cpu/start.S +1 -0
@@ -123,6 +128,7 @@ ENTRY(_start)
  #endif
 
  reset:
+	mtc0	zero, CP0_COUNT	# clear cp0 count for most accurate boot timing
  #if __mips_isa_rev >= 6
  	mfc0	t0, CP0_CONFIG, 5
  	and	t0, t0, MIPS_CONF5_VP

Viele Gr??e,
Stefan

Signature · 3 lines
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-51 Fax: (+49)-8142-66989-80 Email: sr at denx.de
#2 lore raw

PATCH v2 2/5 mips: octeon: Fix Octeon DDR driver to use the correct struct

In reply to Stefan Roese

Don't use "platdata_auto_alloc_size" but "priv_auto_alloc_size" instead to auto allocate the private data struct, which is referenced via dev_get_priv() in this driver. This fixes an ugly bug detected while trying to boot via SPI NOR.

Cc Aaron Williams <[email protected]>
Cc Chandrakala Chavva <[email protected]>
Cc Daniel Schwierzeck <[email protected]>

---
v2:
- No change

 drivers/ram/octeon/octeon_ddr.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/ram/octeon/octeon_ddr.c +1 -1
index 757436b9d3..aaff9c3687 100644
@@ -2724,5 +2724,5 @@ U_BOOT_DRIVER(octeon_ddr) = {
 	.of_match = octeon_ids,
 	.ops = &octeon_ops,
 	.probe = octeon_ddr_probe,
-	.platdata_auto_alloc_size = sizeof(struct ddr_priv),
+	.priv_auto_alloc_size = sizeof(struct ddr_priv),
 };
Signature · 1 line
2.29.1
#3 lore raw

PATCH v2 3/5 mips: octeon: Report full DDR size in dram_init() to gd->ram_size

In reply to Stefan Roese

With this patch, gd->ram_size now holds to full RAM size detected by the DDR init code. It introduces the get_effective_memsize() function to report the maximum usable RAM size in U-Boot to the system instead.

Cc Aaron Williams <[email protected]>
Cc Chandrakala Chavva <[email protected]>
Cc Daniel Schwierzeck <[email protected]>

---
v2:
- No change

 arch/mips/mach-octeon/dram.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
arch/mips/mach-octeon/dram.c +6 -1
index 6dc08e19da..4679260f17 100644
@@ -33,7 +33,7 @@ int dram_init(void)
 			return ret;
 		}
 
-		gd->ram_size = min_t(size_t, ram.size, UBOOT_RAM_SIZE_MAX);
+		gd->ram_size = ram.size;
 		debug("SDRAM base=%lx, size=%lx\n",
 		      (unsigned long)ram.base, (unsigned long)ram.size);
 	} else {
@@ -72,6 +72,11 @@ void board_add_ram_info(int use_default)
 	}
 }
 
+phys_size_t get_effective_memsize(void)
+{
+	return UBOOT_RAM_SIZE_MAX;
+}
+
 ulong board_get_usable_ram_top(ulong total_size)
 {
 	if (IS_ENABLED(CONFIG_RAM_OCTEON)) {
Signature · 1 line
2.29.1
#4 lore raw

PATCH v2 3/5 mips: octeon: Report full DDR size in dram_init() to gd->ram_size

Am Mittwoch, den 28.10.2020, 15:10 +0100 schrieb Stefan Roese:

Quoted 8 lines

With this patch, gd->ram_size now holds to full RAM size detected by the DDR init code. It introduces the get_effective_memsize() function to report the maximum usable RAM size in U-Boot to the system instead.

Cc Aaron Williams <[email protected]>
Cc Chandrakala Chavva <[email protected]>
Cc Daniel Schwierzeck <[email protected]>
Quoted 8 lines

---
v2:
- No change

 arch/mips/mach-octeon/dram.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)
Signature · 1 line
- Daniel
#5 lore raw

PATCH v2 4/5 mips: octeon: bootoctlinux: Use gd->ram_size instead of ram_get_info()

In reply to Stefan Roese

Using ram_get_info() is complicated and does not work after relocation. Now that gd->ram_size holds the full RAM size, let's use it instead and remove the ram_get_size logic completely.

Cc Aaron Williams <[email protected]>
Cc Chandrakala Chavva <[email protected]>
Cc Daniel Schwierzeck <[email protected]>

---
v2:
- No change

 arch/mips/mach-octeon/bootoctlinux.c | 21 +++------------------
 1 file changed, 3 insertions(+), 18 deletions(-)
arch/mips/mach-octeon/bootoctlinux.c +3 -18
index 75d7e83bd7..26136902f3 100644
@@ -9,7 +9,6 @@
 #include <dm.h>
 #include <elf.h>
 #include <env.h>
-#include <ram.h>
 
 #include <asm/io.h>
 #include <linux/compat.h>
@@ -370,8 +369,6 @@ int do_bootoctlinux(struct cmd_tbl *cmdtp, int flag, int argc,
 	struct cvmx_coremask avail_coremask;
 	int first_core;
 	int core;
-	struct ram_info ram;
-	struct udevice *dev;
 	const u64 *nmi_code;
 	int num_dwords;
 	u8 node_mask = 0x01;
@@ -470,19 +467,6 @@ int do_bootoctlinux(struct cmd_tbl *cmdtp, int flag, int argc,
 	 */
 	cvmx_coremask_or(&coremask_to_run, &coremask_to_run, &core_mask);
 
-	/* Get RAM size */
-	ret = uclass_get_device(UCLASS_RAM, 0, &dev);
-	if (ret) {
-		debug("DRAM init failed: %d\n", ret);
-		return ret;
-	}
-
-	ret = ram_get_info(dev, &ram);
-	if (ret) {
-		debug("Cannot get DRAM size: %d\n", ret);
-		return ret;
-	}
-
 	/*
 	 * Load kernel ELF image, or try binary if ELF is not detected.
 	 * This way the much smaller vmlinux.bin can also be started but
@@ -498,7 +482,7 @@ int do_bootoctlinux(struct cmd_tbl *cmdtp, int flag, int argc,
 
 	/* Init bootmem list for Linux kernel booting */
 	if (!cvmx_bootmem_phy_mem_list_init(
-		    ram.size, OCTEON_RESERVED_LOW_MEM_SIZE,
+		    gd->ram_size, OCTEON_RESERVED_LOW_MEM_SIZE,
 		    (void *)CKSEG0ADDR(BOOTLOADER_BOOTMEM_DESC_SPACE))) {
 		printf("FATAL: Error initializing free memory list\n");
 		return 0;
@@ -517,7 +501,8 @@ int do_bootoctlinux(struct cmd_tbl *cmdtp, int flag, int argc,
 		if (core == first_core)
 			cvmx_bootinfo_array[core].flags |= BOOT_FLAG_INIT_CORE;
 
-		cvmx_bootinfo_array[core].dram_size = ram.size / (1024 * 1024);
+		cvmx_bootinfo_array[core].dram_size = gd->ram_size /
+			(1024 * 1024);
 
 		cvmx_bootinfo_array[core].dclock_hz = gd->mem_clk * 1000000;
 		cvmx_bootinfo_array[core].eclock_hz = gd->cpu_clk;
Signature · 1 line
2.29.1
#6 lore raw

PATCH v2 4/5 mips: octeon: bootoctlinux: Use gd->ram_size instead of ram_get_info()

Am Mittwoch, den 28.10.2020, 15:10 +0100 schrieb Stefan Roese:

Quoted 8 lines

Using ram_get_info() is complicated and does not work after relocation. Now that gd->ram_size holds the full RAM size, let's use it instead and remove the ram_get_size logic completely.

Cc Aaron Williams <[email protected]>
Cc Chandrakala Chavva <[email protected]>
Cc Daniel Schwierzeck <[email protected]>
Quoted 8 lines

---
v2:
- No change

 arch/mips/mach-octeon/bootoctlinux.c | 21 +++------------------
 1 file changed, 3 insertions(+), 18 deletions(-)
Signature · 1 line
- Daniel
#7 lore raw

PATCH v2 5/5 mips: octeon: tools: Add update_octeon_header tool

In reply to Stefan Roese

Add a tool to update or insert an Octeon specific header into the U-Boot image. This is needed e.g. for booting via SPI NOR, eMMC and NAND.

While working on this, move enum cvmx_board_types_enum and cvmx_board_type_to_string() to cvmx-bootloader.h and remove the unreferenced (unsupported) board definition.

Cc Aaron Williams <[email protected]>
Cc Chandrakala Chavva <[email protected]>
Cc Daniel Schwierzeck <[email protected]>

---
v2:
- No change
- Azure build success here:
https://dev.azure.com/sr0718/u-boot/_build/results?buildId=59&view=results

 .../mach-octeon/include/mach/cvmx-bootinfo.h  | 222 ---------
 .../include/mach/cvmx-bootloader.h            | 172 +++++++
 tools/Makefile                                |   3 +
 tools/update_octeon_header.c                  | 450 ++++++++++++++++++
 4 files changed, 625 insertions(+), 222 deletions(-)
 create mode 100644 arch/mips/mach-octeon/include/mach/cvmx-bootloader.h
 create mode 100644 tools/update_octeon_header.c
arch/mips/mach-octeon/include/mach/cvmx-bootinfo.h +0 -222
index 337987178f..97438ff787 100644
@@ -125,226 +125,4 @@ struct cvmx_bootinfo {
 
 #endif /*   (CVMX_BOOTINFO_MAJ_VER == 1) */
 
-/* Type defines for board and chip types */
-enum cvmx_board_types_enum {
-	CVMX_BOARD_TYPE_NULL = 0,
-	CVMX_BOARD_TYPE_SIM = 1,
-	CVMX_BOARD_TYPE_EBT3000 = 2,
-	CVMX_BOARD_TYPE_KODAMA = 3,
-	CVMX_BOARD_TYPE_NIAGARA = 4,
-	CVMX_BOARD_TYPE_NAC38 = 5,	/* formerly NAO38 */
-	CVMX_BOARD_TYPE_THUNDER = 6,
-	CVMX_BOARD_TYPE_TRANTOR = 7,
-	CVMX_BOARD_TYPE_EBH3000 = 8,
-	CVMX_BOARD_TYPE_EBH3100 = 9,
-	CVMX_BOARD_TYPE_HIKARI = 10,
-	CVMX_BOARD_TYPE_CN3010_EVB_HS5 = 11,
-	CVMX_BOARD_TYPE_CN3005_EVB_HS5 = 12,
-	CVMX_BOARD_TYPE_KBP = 13,
-	/* Deprecated, CVMX_BOARD_TYPE_CN3010_EVB_HS5 supports the CN3020 */
-	CVMX_BOARD_TYPE_CN3020_EVB_HS5 = 14,
-	CVMX_BOARD_TYPE_EBT5800 = 15,
-	CVMX_BOARD_TYPE_NICPRO2 = 16,
-	CVMX_BOARD_TYPE_EBH5600 = 17,
-	CVMX_BOARD_TYPE_EBH5601 = 18,
-	CVMX_BOARD_TYPE_EBH5200 = 19,
-	CVMX_BOARD_TYPE_BBGW_REF = 20,
-	CVMX_BOARD_TYPE_NIC_XLE_4G = 21,
-	CVMX_BOARD_TYPE_EBT5600 = 22,
-	CVMX_BOARD_TYPE_EBH5201 = 23,
-	CVMX_BOARD_TYPE_EBT5200 = 24,
-	CVMX_BOARD_TYPE_CB5600	= 25,
-	CVMX_BOARD_TYPE_CB5601	= 26,
-	CVMX_BOARD_TYPE_CB5200	= 27,
-	/* Special 'generic' board type, supports many boards */
-	CVMX_BOARD_TYPE_GENERIC = 28,
-	CVMX_BOARD_TYPE_EBH5610 = 29,
-	CVMX_BOARD_TYPE_LANAI2_A = 30,
-	CVMX_BOARD_TYPE_LANAI2_U = 31,
-	CVMX_BOARD_TYPE_EBB5600 = 32,
-	CVMX_BOARD_TYPE_EBB6300 = 33,
-	CVMX_BOARD_TYPE_NIC_XLE_10G = 34,
-	CVMX_BOARD_TYPE_LANAI2_G = 35,
-	CVMX_BOARD_TYPE_EBT5810 = 36,
-	CVMX_BOARD_TYPE_NIC10E = 37,
-	CVMX_BOARD_TYPE_EP6300C = 38,
-	CVMX_BOARD_TYPE_EBB6800 = 39,
-	CVMX_BOARD_TYPE_NIC4E = 40,
-	CVMX_BOARD_TYPE_NIC2E = 41,
-	CVMX_BOARD_TYPE_EBB6600 = 42,
-	CVMX_BOARD_TYPE_REDWING = 43,
-	CVMX_BOARD_TYPE_NIC68_4 = 44,
-	CVMX_BOARD_TYPE_NIC10E_66 = 45,
-	CVMX_BOARD_TYPE_MAX,
-
-	/*
-	 * The range from CVMX_BOARD_TYPE_MAX to
-	 * CVMX_BOARD_TYPE_CUST_DEFINED_MIN is reserved for future
-	 * SDK use.
-	 */
-
-	/*
-	 * Set aside a range for customer boards.  These numbers are managed
-	 * by Cavium.
-	 */
-	CVMX_BOARD_TYPE_CUST_DEFINED_MIN = 10000,
-	CVMX_BOARD_TYPE_CUST_WSX16 = 10001,
-	CVMX_BOARD_TYPE_CUST_NS0216 = 10002,
-	CVMX_BOARD_TYPE_CUST_NB5 = 10003,
-	CVMX_BOARD_TYPE_CUST_WMR500 = 10004,
-	CVMX_BOARD_TYPE_CUST_ITB101 = 10005,
-	CVMX_BOARD_TYPE_CUST_NTE102 = 10006,
-	CVMX_BOARD_TYPE_CUST_AGS103 = 10007,
-	CVMX_BOARD_TYPE_CUST_GST104 = 10008,
-	CVMX_BOARD_TYPE_CUST_GCT105 = 10009,
-	CVMX_BOARD_TYPE_CUST_AGS106 = 10010,
-	CVMX_BOARD_TYPE_CUST_SGM107 = 10011,
-	CVMX_BOARD_TYPE_CUST_GCT108 = 10012,
-	CVMX_BOARD_TYPE_CUST_AGS109 = 10013,
-	CVMX_BOARD_TYPE_CUST_GCT110 = 10014,
-	CVMX_BOARD_TYPE_CUST_L2_AIR_SENDER = 10015,
-	CVMX_BOARD_TYPE_CUST_L2_AIR_RECEIVER = 10016,
-	CVMX_BOARD_TYPE_CUST_L2_ACCTON2_TX = 10017,
-	CVMX_BOARD_TYPE_CUST_L2_ACCTON2_RX = 10018,
-	CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_TX = 10019,
-	CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_RX = 10020,
-	CVMX_BOARD_TYPE_CUST_L2_ZINWELL = 10021,
-	CVMX_BOARD_TYPE_CUST_DEFINED_MAX = 20000,
-
-	/*
-	 * Set aside a range for customer private use.	The SDK won't
-	 * use any numbers in this range.
-	 */
-	CVMX_BOARD_TYPE_CUST_PRIVATE_MIN = 20001,
-	CVMX_BOARD_TYPE_UBNT_E100 = 20002,
-	CVMX_BOARD_TYPE_CUST_DSR1000N = 20006,
-	CVMX_BOARD_TYPE_KONTRON_S1901 = 21901,
-	CVMX_BOARD_TYPE_CUST_PRIVATE_MAX = 30000,
-
-	/* The remaining range is reserved for future use. */
-};
-
-enum cvmx_chip_types_enum {
-	CVMX_CHIP_TYPE_NULL = 0,
-	CVMX_CHIP_SIM_TYPE_DEPRECATED = 1,
-	CVMX_CHIP_TYPE_OCTEON_SAMPLE = 2,
-	CVMX_CHIP_TYPE_MAX,
-};
-
-/*
- * Compatibility alias for NAC38 name change, planned to be removed
- * from SDK 1.7
- */
-#define CVMX_BOARD_TYPE_NAO38	CVMX_BOARD_TYPE_NAC38
-
-/* Functions to return string based on type */
-#define ENUM_BRD_TYPE_CASE(x)						\
-	case x:								\
-		return(#x + 16)		/* Skip CVMX_BOARD_TYPE_ */
-
-static inline const char *cvmx_board_type_to_string(enum
-						    cvmx_board_types_enum type)
-{
-	switch (type) {
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NULL);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_SIM);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT3000);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_KODAMA);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIAGARA);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NAC38);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_THUNDER);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_TRANTOR);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH3000);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH3100);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_HIKARI);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3010_EVB_HS5);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3005_EVB_HS5);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_KBP);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CN3020_EVB_HS5);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5800);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NICPRO2);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5600);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5601);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5200);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_BBGW_REF);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC_XLE_4G);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5600);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5201);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5200);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5600);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5601);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CB5200);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_GENERIC);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBH5610);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_A);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_U);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB5600);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB6300);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC_XLE_10G);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_LANAI2_G);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBT5810);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC10E);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EP6300C);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB6800);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC4E);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC2E);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_EBB6600);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_REDWING);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC68_4);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_NIC10E_66);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_MAX);
-
-		/* Customer boards listed here */
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_DEFINED_MIN);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_WSX16);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NS0216);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NB5);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_WMR500);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_ITB101);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_NTE102);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS103);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GST104);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT105);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS106);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_SGM107);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT108);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_AGS109);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_GCT110);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_AIR_SENDER);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_AIR_RECEIVER);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ACCTON2_TX);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ACCTON2_RX);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_TX);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_WSTRNSNIC_RX);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_L2_ZINWELL);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_DEFINED_MAX);
-
-		/* Customer private range */
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_PRIVATE_MIN);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_UBNT_E100);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_DSR1000N);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_KONTRON_S1901);
-		ENUM_BRD_TYPE_CASE(CVMX_BOARD_TYPE_CUST_PRIVATE_MAX);
-	}
-
-	return NULL;
-}
-
-#define ENUM_CHIP_TYPE_CASE(x)						\
-	case x:								\
-		return(#x + 15)		/* Skip CVMX_CHIP_TYPE */
-
-static inline const char *cvmx_chip_type_to_string(enum
-						   cvmx_chip_types_enum type)
-{
-	switch (type) {
-		ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_NULL);
-		ENUM_CHIP_TYPE_CASE(CVMX_CHIP_SIM_TYPE_DEPRECATED);
-		ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_OCTEON_SAMPLE);
-		ENUM_CHIP_TYPE_CASE(CVMX_CHIP_TYPE_MAX);
-	}
-
-	return "Unsupported Chip";
-}
-
 #endif /* __CVMX_BOOTINFO_H__ */
arch/mips/mach-octeon/include/mach/cvmx-bootloader.h new file +172 -0

172 lines not on this page · raw message

tools/Makefile +3 -0
index 51123fd929..253a6b9706 100644
@@ -206,6 +206,9 @@ hostprogs-y += proftool
 hostprogs-$(CONFIG_STATIC_RELA) += relocate-rela
 hostprogs-$(CONFIG_RISCV) += prelink-riscv
 
+hostprogs-$(CONFIG_ARCH_OCTEON) += update_octeon_header
+update_octeon_header-objs := update_octeon_header.o lib/crc32.o
+
 hostprogs-y += fdtgrep
 fdtgrep-objs += $(LIBFDT_OBJS) common/fdt_region.o fdtgrep.o
 
tools/update_octeon_header.c new file +450 -0

450 lines not on this page · raw message

Signature · 1 line
2.29.1
#8 lore raw

PATCH v2 5/5 mips: octeon: tools: Add update_octeon_header tool

Am Mittwoch, den 28.10.2020, 15:10 +0100 schrieb Stefan Roese:

Quoted 25 lines

Add a tool to update or insert an Octeon specific header into the U-Boot image. This is needed e.g. for booting via SPI NOR, eMMC and NAND.

While working on this, move enum cvmx_board_types_enum and cvmx_board_type_to_string() to cvmx-bootloader.h and remove the unreferenced (unsupported) board definition.

Cc Aaron Williams <[email protected]>
Cc Chandrakala Chavva <[email protected]>
Cc Daniel Schwierzeck <[email protected]>

---
v2:
- No change
- Azure build success here:
https://dev.azure.com/sr0718/u-boot/_build/results?buildId=59&view=results

 .../mach-octeon/include/mach/cvmx-bootinfo.h  | 222 ---------
 .../include/mach/cvmx-bootloader.h            | 172 +++++++
 tools/Makefile                                |   3 +
 tools/update_octeon_header.c                  | 450 ++++++++++++++++++
 4 files changed, 625 insertions(+), 222 deletions(-)
 create mode 100644 arch/mips/mach-octeon/include/mach/cvmx-bootloader.h
 create mode 100644 tools/update_octeon_header.c

...

tools/Makefile hostprogs-y += proftool · line 210

Quoted 10 lines
tools/Makefile +2 -0
index 51123fd929..253a6b9706 100644
@@ -206,6 +206,9 @@ hostprogs-y += proftool
 hostprogs-$(CONFIG_STATIC_RELA) += relocate-rela
 hostprogs-$(CONFIG_RISCV) += prelink-riscv
 
+hostprogs-$(CONFIG_ARCH_OCTEON) += update_octeon_header
+update_octeon_header-objs := update_octeon_header.o lib/crc32.o

entry in tools/.gitignore is missing

Quoted 24 lines
tools/Makefile +1 -0
+
 hostprogs-y += fdtgrep
 fdtgrep-objs += $(LIBFDT_OBJS) common/fdt_region.o fdtgrep.o
 
tools/update_octeon_header.c new file +14 -0
new file mode 100644
index 0000000000..964036216d
@@ -0,0 +1,450 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Copyright (C) 2020 Marvell International Ltd.
+ */
+
+#include <stdio.h>
+#include <stdint.h>
+#include <stddef.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <unistd.h>
+#include <stdlib.h>
+#include <string.h>

tools/update_octeon_header.c line 24

Quoted 10 lines
tools/update_octeon_header.c new file +10 -0
+#include <getopt.h>
+#include <arpa/inet.h>
+
+#include <u-boot/crc.h>
+
+#include "mkimage.h"
+
+#include "../arch/mips/mach-octeon/include/mach/cvmx-bootloader.h"
+
+void usage(void);

this needs some code cleanup:
- drop the forward declarations and reorder the functions when necessary
- make all functions static
- drop dead code
- drop debug() macros convert the useful ones to printf
- maybe use fprintf(STDERR, ...) for error messages

there are also some bugs:
- tool crashes with segfault when called without arguments
- tool crashes when called with a long option but no value
- the bugs above will also be detected by clang-tidy, suggestions for fixing below

tools/update_octeon_header.c line 32

Quoted 8 lines
tools/update_octeon_header.c new file +8 -0
+
+/*
+ * Do some funky stuff here to get a compile time error if the size of the
+ * bootloader_header structure has changed.
+ */
+#define compile_time_assert(cond, msg) char msg[(cond) ? 1 : -1]
+compile_time_assert(sizeof(struct bootloader_header) == 192,
+		    bootloader_header_size_changed);

there is BUILD_BUG_ON_MSG() in linux/build_bug.h
or compiletime_assert() in linux/compiler.h

Quoted 111 lines
tools/update_octeon_header.c new file +111 -0
+
+#define BUF_SIZE	(16 * 1024)
+#define NAME_LEN	100
+
+#ifndef WOFFSETOF
+/* word offset */
+#define WOFFSETOF(type, elem)	(offsetof(type, elem) / 4)
+#endif
+
+#define cvmx_cpu_to_be64(x)	(x)
+
+static int stage2_flag;
+static int stage_1_5_flag;
+static int stage_1_flag;
+
+int lookup_board_type(char *board_name)
+{
+	int i;
+	int board_type = 0;
+	char *substr = NULL;
+
+	/* Detect stage 2 bootloader boards */
+	if (strcasestr(board_name, "_stage2")) {
+		debug("Stage 2 bootloader detected from substring %s in name %s\n",
+		      "_stage2", board_name);
+		stage2_flag = 1;
+	} else {
+		debug("Stage 2 bootloader NOT detected from name \"%s\"\n",
+		      board_name);
+	}
+
+	if (strcasestr(board_name, "_stage1")) {
+		debug("Stage 1 bootloader detected from substring %s in name %s\n",
+		      "_stage1", board_name);
+		stage_1_flag = 1;
+	}
+
+	/* Generic is a special case since there are numerous sub-types */
+	if (!strncasecmp("generic", board_name, strlen("generic")))
+		return CVMX_BOARD_TYPE_GENERIC;
+
+	/*
+	 * If we're an eMMC stage 2 bootloader, cut off the _emmc_stage2
+	 * part of the name.
+	 */
+	substr = strcasestr(board_name, "_emmc_stage2");
+	if (substr && (substr[strlen("_emmc_stage2")] == '\0')) {
+		/*return CVMX_BOARD_TYPE_GENERIC;*/
+
+		printf("  Converting board name %s to ", board_name);
+		*substr = '\0';
+		printf("%s\n", board_name);
+	}
+
+	/*
+	 * If we're a NAND stage 2 bootloader, cut off the _nand_stage2
+	 * part of the name.
+	 */
+	substr = strcasestr(board_name, "_nand_stage2");
+	if (substr && (substr[strlen("_nand_stage2")] == '\0')) {
+		/*return CVMX_BOARD_TYPE_GENERIC;*/
+
+		printf("  Converting board name %s to ", board_name);
+		*substr = '\0';
+		printf("%s\n", board_name);
+	}
+
+	/*
+	 * If we're a SPI stage 2 bootloader, cut off the _spi_stage2
+	 * part of the name.
+	 */
+	substr = strcasestr(board_name, "_spi_stage2");
+	if (substr && (substr[strlen("_spi_stage2")] == '\0')) {
+		printf("  Converting board name %s to ", board_name);
+		*substr = '\0';
+		printf("%s\n", board_name);
+	}
+
+	for (i = CVMX_BOARD_TYPE_NULL; i < CVMX_BOARD_TYPE_MAX; i++)
+		if (!strcasecmp(cvmx_board_type_to_string(i), board_name))
+			board_type = i;
+
+	for (i = CVMX_BOARD_TYPE_CUST_DEFINED_MIN;
+	     i < CVMX_BOARD_TYPE_CUST_DEFINED_MAX; i++)
+		if (!strncasecmp(cvmx_board_type_to_string(i), board_name,
+				 strlen(cvmx_board_type_to_string(i))))
+			board_type = i;
+
+	for (i = CVMX_BOARD_TYPE_CUST_PRIVATE_MIN;
+	     i < CVMX_BOARD_TYPE_CUST_PRIVATE_MAX; i++)
+		if (!strncasecmp(cvmx_board_type_to_string(i), board_name,
+				 strlen(cvmx_board_type_to_string(i))))
+			board_type = i;
+
+	return board_type;
+}
+
+/* Getoptions variables must be global */
+static int failsafe_flag;
+static int pciboot_flag;
+static int env_flag;
+
+int main(int argc, char *argv[])
+{
+	int fd;
+	uint8_t buf[BUF_SIZE];
+	uint32_t data_crc = 0;
+	int len;
+	int data_len = 0;
+	struct bootloader_header header;
+	char filename[NAME_LEN];

tools/update_octeon_header.c line 153

Quoted 10 lines
tools/update_octeon_header.c new file +10 -0
+	int i;
+	int option_index = 0;	/* getopt_long stores the option index here. */
+	char board_name[NAME_LEN] = { 0 };
+	char tmp_board_name[NAME_LEN] = { 0 };
+	int c;
+	int board_type = 0;
+	unsigned long long address = 0;
+	ssize_t ret;
+	const char *type_str = NULL;
+	int hdr_size = sizeof(struct bootloader_header);

the tool has two positional arguments, so you should bail out early. This will also fix the segfault

        if (argc < 3) {
		usage();
		return -1;
	}
Quoted 13 lines
tools/update_octeon_header.c new file +13 -0
+
+	debug("header size is: %d bytes\n", hdr_size);
+
+	/* Parse command line options using getopt_long */
+	while (1) {
+		static struct option long_options[] = {
+			/* These options set a flag. */
+			{"failsafe", no_argument, &failsafe_flag, 1},
+			{"pciboot", no_argument, &pciboot_flag, 1},
+			{"nandstage2", no_argument, &stage2_flag, 1},
+			{"spistage2", no_argument, &stage2_flag, 1},
+			{"norstage2", no_argument, &stage2_flag, 1},
+			{"stage2", no_argument, &stage2_flag, 1},

tools/update_octeon_header.c line 176

Quoted 10 lines
tools/update_octeon_header.c new file +10 -0
+			{"stage1.5", no_argument, &stage_1_5_flag, 1},
+			{"stage1", no_argument, &stage_1_flag, 1},
+			{"environment", no_argument, &env_flag, 1},
+			/* These options don't set a flag.
+			 * We distinguish them by their indices.
+			 */
+			{"board", required_argument, 0, 0},
+			{"text_base", required_argument, 0, 0},
+			{0, 0, 0, 0}
+		};

this should be moved out of main() and marked as static const

tools/update_octeon_header.c line 178

Quoted 2 lines
tools/update_octeon_header.c new file +2 -0
+
+		c = getopt_long(argc, (char *const *)argv, "h",

cast is not needed

Quoted 6 lines
tools/update_octeon_header.c new file +6 -0
+				long_options, &option_index);
+
+		/* Detect the end of the options. */
+		if (c == -1)
+			break;
+

tools/update_octeon_header.c line 194

Quoted 10 lines
tools/update_octeon_header.c new file +10 -0
+		switch (c) {
+			/* All long options handled in case 0 */
+		case 0:
+			/* If this option set a flag, do nothing else now. */
+			if (long_options[option_index].flag != 0)
+				break;
+			debug("option(l) %s", long_options[option_index].name);
+			if (optarg)
+				debug(" with arg %s", optarg);
+			debug("\n");

should be

                        if (!optarg) {
				usage();
				return -1;
			}
			debug(" with arg %s\n", optarg);

the code below depends on optarg and passing a long option without value is an error and should be notified to the user

Quoted 170 lines
tools/update_octeon_header.c new file +170 -0
+
+			if (!strcmp(long_options[option_index].name, "board")) {
+				if (strlen(optarg) >= NAME_LEN) {
+					printf("strncpy() issue detected!");
+					exit(-1);
+				}
+				strncpy(board_name, optarg, NAME_LEN);
+
+				debug("Using user supplied board name: %s\n",
+				      board_name);
+			} else if (!strcmp(long_options[option_index].name,
+					   "text_base")) {
+				address = strtoull(optarg, NULL, 0);
+				debug("Address of image is: 0x%llx\n",
+				      (unsigned long long)address);
+				if (!(address & 0xFFFFFFFFULL << 32)) {
+					if (address & 1 << 31) {
+						address |= 0xFFFFFFFFULL << 32;
+						debug("Converting address to 64 bit compatibility space: 0x%llx\n",
+						      address);
+					}
+				}
+			}
+			break;
+
+		case 'h':
+		case '?':
+			/* getopt_long already printed an error message. */
+			usage();
+			return -1;
+
+		default:
+			abort();
+		}
+	}
+
+	if (optind < argc) {
+		/*
+		 * We only support one argument - an optional bootloader
+		 * file name
+		 */
+		if (argc - optind > 2) {
+			debug("non-option ARGV-elements: ");
+			while (optind < argc)
+				debug("%s ", argv[optind++]);
+			debug("\n");
+			usage();
+			return -1;
+		}
+	}
+
+	if (strlen(argv[optind]) >= NAME_LEN) {
+		printf("strncpy() issue detected!");
+		exit(-1);
+	}
+	strncpy(filename, argv[optind], NAME_LEN);
+
+	if (board_name[0] == '\0') {
+		if (strlen(argv[optind + 1]) >= NAME_LEN) {
+			printf("strncpy() issue detected!");
+			exit(-1);
+		}
+		strncpy(board_name, argv[optind + 1], NAME_LEN);
+	}
+
+	if (strlen(board_name) >= NAME_LEN) {
+		printf("strncpy() issue detected!");
+		exit(-1);
+	}
+	strncpy(tmp_board_name, board_name, NAME_LEN);
+
+	fd = open(filename, O_RDWR);
+	if (fd < 0) {
+		printf("Unable to open file: %s\n", filename);
+		exit(-1);
+	}
+
+	if (failsafe_flag)
+		debug("Setting failsafe flag\n");
+
+	if (strlen(board_name)) {
+		int offset = 0;
+
+		debug("Supplied board name of: %s\n", board_name);
+
+		if (strstr(board_name, "failsafe")) {
+			failsafe_flag = 1;
+			debug("Setting failsafe flag based on board name\n");
+		}
+		/* Skip leading octeon_ if present. */
+		if (!strncmp(board_name, "octeon_", 7))
+			offset = 7;
+
+		/*
+		 * Check to see if 'failsafe' is in the name.  If so, set the
+		 * failsafe flag.  Also, ignore extra trailing characters on
+		 * passed parameter when comparing against board names.
+		 * We actually use the configuration name from u-boot, so it
+		 * may have some other variant names.  Variants other than
+		 * failsafe _must_ be passed to this program explicitly
+		 */
+
+		board_type = lookup_board_type(board_name + offset);
+		if (!board_type) {
+			/* Retry with 'cust_' prefix to catch boards that are
+			 * in the customer section (such as nb5)
+			 */
+			sprintf(tmp_board_name, "cust_%s", board_name + offset);
+			board_type = lookup_board_type(tmp_board_name);
+		}
+
+		/* reset to original value */
+		strncpy(tmp_board_name, board_name, NAME_LEN);
+		if (!board_type) {
+			/*
+			 * Retry with 'cust_private_' prefix to catch boards
+			 * that are in the customer private section
+			 */
+			sprintf(tmp_board_name, "cust_private_%s",
+				board_name + offset);
+			board_type = lookup_board_type(tmp_board_name);
+		}
+
+		if (!board_type) {
+			printf("ERROR: unable to determine board type\n");
+			exit(-1);
+		}
+		debug("Board type is: %d: %s\n", board_type,
+		      cvmx_board_type_to_string(board_type));
+	} else {
+		printf("Board name must be specified!\n");
+		exit(-1);
+	}
+
+	/*
+	 * Check to see if there is either an existing header, or that there
+	 * are zero valued bytes where we want to put the header
+	 */
+	len = read(fd, buf, BUF_SIZE);
+	if (len > 0) {
+		/*
+		 * Copy the header, as the first word (jump instruction, needs
+		 * to remain the same.
+		 */
+		memcpy(&header, buf, hdr_size);
+		/*
+		 * Check to see if we have zero bytes (excluding first 4, which
+		 * are the jump instruction)
+		 */
+		for (i = 1; i < hdr_size / 4; i++) {
+			if (((uint32_t *)buf)[i]) {
+				printf("ERROR: non-zero word found %x in location %d required for header, aborting\n",
+				       ((uint32_t *)buf)[i], i);
+				exit(-1);
+			}
+		}
+		debug("Zero bytes found in header location, adding header.\n");
+
+	} else {
+		printf("Unable to read from file %s\n", filename);
+		exit(-1);
+	}
+
+	/* Read data bytes and generate CRC */
+	lseek(fd, hdr_size, SEEK_SET);
+
+	while ((len = read(fd, buf, BUF_SIZE)) > 0) {
+		data_crc = crc32(data_crc, buf, len);
+		data_len += len;
+	}

tools/update_octeon_header.c line 374

Quoted 10 lines
tools/update_octeon_header.c new file +10 -0
+	printf("CRC of data: 0x%x, length: %d\n", data_crc, data_len);
+
+	/* Now create the new header */
+	header.magic = htonl(BOOTLOADER_HEADER_MAGIC);
+	header.maj_rev = htons(BOOTLOADER_HEADER_CURRENT_MAJOR_REV);
+	header.min_rev = htons(BOOTLOADER_HEADER_CURRENT_MINOR_REV);
+	header.dlen = htonl(data_len);
+	header.dcrc = htonl(data_crc);
+	header.board_type = htons(board_type);
+	header.address = cvmx_cpu_to_be64(address);

cvmx_cpu_to_be64() is a no-op, is this intentional? If yes, this macro can be removed. Otherwise you can use cpu_to_be64(). All cpu_to_be*() functions are automatically available in tools/ directory.

Signature · 1 line
- Daniel
#9 lore raw

PATCH v2 5/5 mips: octeon: tools: Add update_octeon_header tool

Hi Daniel,

Quoted 84 lines · Daniel Schwierzeck

Am Mittwoch, den 28.10.2020, 15:10 +0100 schrieb Stefan Roese:

Quoted 25 lines

Add a tool to update or insert an Octeon specific header into the U-Boot image. This is needed e.g. for booting via SPI NOR, eMMC and NAND.

While working on this, move enum cvmx_board_types_enum and cvmx_board_type_to_string() to cvmx-bootloader.h and remove the unreferenced (unsupported) board definition.

Cc Aaron Williams <[email protected]>
Cc Chandrakala Chavva <[email protected]>
Cc Daniel Schwierzeck <[email protected]>

---
v2:
- No change
- Azure build success here:

   https://dev.azure.com/sr0718/u-boot/_build/results?buildId=59&view=results
  .../mach-octeon/include/mach/cvmx-bootinfo.h  | 222 ---------
  .../include/mach/cvmx-bootloader.h            | 172 +++++++
  tools/Makefile                                |   3 +
  tools/update_octeon_header.c                  | 450 ++++++++++++++++++
  4 files changed, 625 insertions(+), 222 deletions(-)

create mode 100644 arch/mips/mach-octeon/include/mach/cvmx-bootloader.h create mode 100644 tools/update_octeon_header.c

...

tools/Makefile hostprogs-y += proftool · line 210

Quoted 10 lines
tools/Makefile +2 -0
index 51123fd929..253a6b9706 100644
@@ -206,6 +206,9 @@ hostprogs-y += proftool
  hostprogs-$(CONFIG_STATIC_RELA) += relocate-rela
  hostprogs-$(CONFIG_RISCV) += prelink-riscv
 
+hostprogs-$(CONFIG_ARCH_OCTEON) += update_octeon_header
+update_octeon_header-objs := update_octeon_header.o lib/crc32.o

entry in tools/.gitignore is missing

Quoted 24 lines
tools/Makefile +1 -0
+
  hostprogs-y += fdtgrep
  fdtgrep-objs += $(LIBFDT_OBJS) common/fdt_region.o fdtgrep.o
 
tools/update_octeon_header.c new file +14 -0
new file mode 100644
index 0000000000..964036216d
@@ -0,0 +1,450 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Copyright (C) 2020 Marvell International Ltd.
+ */
+
+#include <stdio.h>
+#include <stdint.h>
+#include <stddef.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+#include <unistd.h>
+#include <stdlib.h>
+#include <string.h>

tools/update_octeon_header.c line 24

Quoted 10 lines
tools/update_octeon_header.c new file +10 -0
+#include <getopt.h>
+#include <arpa/inet.h>
+
+#include <u-boot/crc.h>
+
+#include "mkimage.h"
+
+#include "../arch/mips/mach-octeon/include/mach/cvmx-bootloader.h"
+
+void usage(void);

this needs some code cleanup:
- drop the forward declarations and reorder the functions when necessary
- make all functions static
- drop dead code
- drop debug() macros convert the useful ones to printf
- maybe use fprintf(STDERR, ...) for error messages

Quoted 5 lines

there are also some bugs:
- tool crashes with segfault when called without arguments
- tool crashes when called with a long option but no value
- the bugs above will also be detected by clang-tidy, suggestions for fixing below

Many thanks for the extensive code review. I'll try to address all comments shortly.

Thanks,
Stefan

Quoted 377 lines

tools/update_octeon_header.c line 32

Quoted 8 lines
tools/update_octeon_header.c new file +8 -0
+
+/*
+ * Do some funky stuff here to get a compile time error if the size of the
+ * bootloader_header structure has changed.
+ */
+#define compile_time_assert(cond, msg) char msg[(cond) ? 1 : -1]
+compile_time_assert(sizeof(struct bootloader_header) == 192,
+		    bootloader_header_size_changed);

there is BUILD_BUG_ON_MSG() in linux/build_bug.h
or compiletime_assert() in linux/compiler.h

Quoted 111 lines
tools/update_octeon_header.c new file +111 -0
+
+#define BUF_SIZE	(16 * 1024)
+#define NAME_LEN	100
+
+#ifndef WOFFSETOF
+/* word offset */
+#define WOFFSETOF(type, elem)	(offsetof(type, elem) / 4)
+#endif
+
+#define cvmx_cpu_to_be64(x)	(x)
+
+static int stage2_flag;
+static int stage_1_5_flag;
+static int stage_1_flag;
+
+int lookup_board_type(char *board_name)
+{
+	int i;
+	int board_type = 0;
+	char *substr = NULL;
+
+	/* Detect stage 2 bootloader boards */
+	if (strcasestr(board_name, "_stage2")) {
+		debug("Stage 2 bootloader detected from substring %s in name %s\n",
+		      "_stage2", board_name);
+		stage2_flag = 1;
+	} else {
+		debug("Stage 2 bootloader NOT detected from name \"%s\"\n",
+		      board_name);
+	}
+
+	if (strcasestr(board_name, "_stage1")) {
+		debug("Stage 1 bootloader detected from substring %s in name %s\n",
+		      "_stage1", board_name);
+		stage_1_flag = 1;
+	}
+
+	/* Generic is a special case since there are numerous sub-types */
+	if (!strncasecmp("generic", board_name, strlen("generic")))
+		return CVMX_BOARD_TYPE_GENERIC;
+
+	/*
+	 * If we're an eMMC stage 2 bootloader, cut off the _emmc_stage2
+	 * part of the name.
+	 */
+	substr = strcasestr(board_name, "_emmc_stage2");
+	if (substr && (substr[strlen("_emmc_stage2")] == '\0')) {
+		/*return CVMX_BOARD_TYPE_GENERIC;*/
+
+		printf("  Converting board name %s to ", board_name);
+		*substr = '\0';
+		printf("%s\n", board_name);
+	}
+
+	/*
+	 * If we're a NAND stage 2 bootloader, cut off the _nand_stage2
+	 * part of the name.
+	 */
+	substr = strcasestr(board_name, "_nand_stage2");
+	if (substr && (substr[strlen("_nand_stage2")] == '\0')) {
+		/*return CVMX_BOARD_TYPE_GENERIC;*/
+
+		printf("  Converting board name %s to ", board_name);
+		*substr = '\0';
+		printf("%s\n", board_name);
+	}
+
+	/*
+	 * If we're a SPI stage 2 bootloader, cut off the _spi_stage2
+	 * part of the name.
+	 */
+	substr = strcasestr(board_name, "_spi_stage2");
+	if (substr && (substr[strlen("_spi_stage2")] == '\0')) {
+		printf("  Converting board name %s to ", board_name);
+		*substr = '\0';
+		printf("%s\n", board_name);
+	}
+
+	for (i = CVMX_BOARD_TYPE_NULL; i < CVMX_BOARD_TYPE_MAX; i++)
+		if (!strcasecmp(cvmx_board_type_to_string(i), board_name))
+			board_type = i;
+
+	for (i = CVMX_BOARD_TYPE_CUST_DEFINED_MIN;
+	     i < CVMX_BOARD_TYPE_CUST_DEFINED_MAX; i++)
+		if (!strncasecmp(cvmx_board_type_to_string(i), board_name,
+				 strlen(cvmx_board_type_to_string(i))))
+			board_type = i;
+
+	for (i = CVMX_BOARD_TYPE_CUST_PRIVATE_MIN;
+	     i < CVMX_BOARD_TYPE_CUST_PRIVATE_MAX; i++)
+		if (!strncasecmp(cvmx_board_type_to_string(i), board_name,
+				 strlen(cvmx_board_type_to_string(i))))
+			board_type = i;
+
+	return board_type;
+}
+
+/* Getoptions variables must be global */
+static int failsafe_flag;
+static int pciboot_flag;
+static int env_flag;
+
+int main(int argc, char *argv[])
+{
+	int fd;
+	uint8_t buf[BUF_SIZE];
+	uint32_t data_crc = 0;
+	int len;
+	int data_len = 0;
+	struct bootloader_header header;
+	char filename[NAME_LEN];

tools/update_octeon_header.c line 153

Quoted 10 lines
tools/update_octeon_header.c new file +10 -0
+	int i;
+	int option_index = 0;	/* getopt_long stores the option index here. */
+	char board_name[NAME_LEN] = { 0 };
+	char tmp_board_name[NAME_LEN] = { 0 };
+	int c;
+	int board_type = 0;
+	unsigned long long address = 0;
+	ssize_t ret;
+	const char *type_str = NULL;
+	int hdr_size = sizeof(struct bootloader_header);

the tool has two positional arguments, so you should bail out early. This will also fix the segfault

         if (argc < 3) {
		usage();
		return -1;
	}
Quoted 13 lines
tools/update_octeon_header.c new file +13 -0
+
+	debug("header size is: %d bytes\n", hdr_size);
+
+	/* Parse command line options using getopt_long */
+	while (1) {
+		static struct option long_options[] = {
+			/* These options set a flag. */
+			{"failsafe", no_argument, &failsafe_flag, 1},
+			{"pciboot", no_argument, &pciboot_flag, 1},
+			{"nandstage2", no_argument, &stage2_flag, 1},
+			{"spistage2", no_argument, &stage2_flag, 1},
+			{"norstage2", no_argument, &stage2_flag, 1},
+			{"stage2", no_argument, &stage2_flag, 1},

tools/update_octeon_header.c line 176

Quoted 10 lines
tools/update_octeon_header.c new file +10 -0
+			{"stage1.5", no_argument, &stage_1_5_flag, 1},
+			{"stage1", no_argument, &stage_1_flag, 1},
+			{"environment", no_argument, &env_flag, 1},
+			/* These options don't set a flag.
+			 * We distinguish them by their indices.
+			 */
+			{"board", required_argument, 0, 0},
+			{"text_base", required_argument, 0, 0},
+			{0, 0, 0, 0}
+		};

this should be moved out of main() and marked as static const

tools/update_octeon_header.c line 178

Quoted 2 lines
tools/update_octeon_header.c new file +2 -0
+
+		c = getopt_long(argc, (char *const *)argv, "h",

cast is not needed

Quoted 6 lines
tools/update_octeon_header.c new file +6 -0
+				long_options, &option_index);
+
+		/* Detect the end of the options. */
+		if (c == -1)
+			break;
+

tools/update_octeon_header.c line 194

Quoted 10 lines
tools/update_octeon_header.c new file +10 -0
+		switch (c) {
+			/* All long options handled in case 0 */
+		case 0:
+			/* If this option set a flag, do nothing else now. */
+			if (long_options[option_index].flag != 0)
+				break;
+			debug("option(l) %s", long_options[option_index].name);
+			if (optarg)
+				debug(" with arg %s", optarg);
+			debug("\n");

should be

                         if (!optarg) {
				usage();
				return -1;
			}
			debug(" with arg %s\n", optarg);

the code below depends on optarg and passing a long option without value is an error and should be notified to the user

Quoted 176 lines
tools/update_octeon_header.c new file +176 -0
+
+			if (!strcmp(long_options[option_index].name, "board")) {
+				if (strlen(optarg) >= NAME_LEN) {
+					printf("strncpy() issue detected!");
+					exit(-1);
+				}
+				strncpy(board_name, optarg, NAME_LEN);
+
+				debug("Using user supplied board name: %s\n",
+				      board_name);
+			} else if (!strcmp(long_options[option_index].name,
+					   "text_base")) {
+				address = strtoull(optarg, NULL, 0);
+				debug("Address of image is: 0x%llx\n",
+				      (unsigned long long)address);
+				if (!(address & 0xFFFFFFFFULL << 32)) {
+					if (address & 1 << 31) {
+						address |= 0xFFFFFFFFULL << 32;
+						debug("Converting address to 64 bit compatibility space: 0x%llx\n",
+						      address);
+					}
+				}
+			}
+			break;
+
+		case 'h':
+		case '?':
+			/* getopt_long already printed an error message. */
+			usage();
+			return -1;
+
+		default:
+			abort();
+		}
+	}
+
+	if (optind < argc) {
+		/*
+		 * We only support one argument - an optional bootloader
+		 * file name
+		 */
+		if (argc - optind > 2) {
+			debug("non-option ARGV-elements: ");
+			while (optind < argc)
+				debug("%s ", argv[optind++]);
+			debug("\n");
+			usage();
+			return -1;
+		}
+	}
+
+	if (strlen(argv[optind]) >= NAME_LEN) {
+		printf("strncpy() issue detected!");
+		exit(-1);
+	}
+	strncpy(filename, argv[optind], NAME_LEN);
+
+	if (board_name[0] == '\0') {
+		if (strlen(argv[optind + 1]) >= NAME_LEN) {
+			printf("strncpy() issue detected!");
+			exit(-1);
+		}
+		strncpy(board_name, argv[optind + 1], NAME_LEN);
+	}
+
+	if (strlen(board_name) >= NAME_LEN) {
+		printf("strncpy() issue detected!");
+		exit(-1);
+	}
+	strncpy(tmp_board_name, board_name, NAME_LEN);
+
+	fd = open(filename, O_RDWR);
+	if (fd < 0) {
+		printf("Unable to open file: %s\n", filename);
+		exit(-1);
+	}
+
+	if (failsafe_flag)
+		debug("Setting failsafe flag\n");
+
+	if (strlen(board_name)) {
+		int offset = 0;
+
+		debug("Supplied board name of: %s\n", board_name);
+
+		if (strstr(board_name, "failsafe")) {
+			failsafe_flag = 1;
+			debug("Setting failsafe flag based on board name\n");
+		}
+		/* Skip leading octeon_ if present. */
+		if (!strncmp(board_name, "octeon_", 7))
+			offset = 7;
+
+		/*
+		 * Check to see if 'failsafe' is in the name.  If so, set the
+		 * failsafe flag.  Also, ignore extra trailing characters on
+		 * passed parameter when comparing against board names.
+		 * We actually use the configuration name from u-boot, so it
+		 * may have some other variant names.  Variants other than
+		 * failsafe _must_ be passed to this program explicitly
+		 */
+
+		board_type = lookup_board_type(board_name + offset);
+		if (!board_type) {
+			/* Retry with 'cust_' prefix to catch boards that are
+			 * in the customer section (such as nb5)
+			 */
+			sprintf(tmp_board_name, "cust_%s", board_name + offset);
+			board_type = lookup_board_type(tmp_board_name);
+		}
+
+		/* reset to original value */
+		strncpy(tmp_board_name, board_name, NAME_LEN);
+		if (!board_type) {
+			/*
+			 * Retry with 'cust_private_' prefix to catch boards
+			 * that are in the customer private section
+			 */
+			sprintf(tmp_board_name, "cust_private_%s",
+				board_name + offset);
+			board_type = lookup_board_type(tmp_board_name);
+		}
+
+		if (!board_type) {
+			printf("ERROR: unable to determine board type\n");
+			exit(-1);
+		}
+		debug("Board type is: %d: %s\n", board_type,
+		      cvmx_board_type_to_string(board_type));
+	} else {
+		printf("Board name must be specified!\n");
+		exit(-1);
+	}
+
+	/*
+	 * Check to see if there is either an existing header, or that there
+	 * are zero valued bytes where we want to put the header
+	 */
+	len = read(fd, buf, BUF_SIZE);
+	if (len > 0) {
+		/*
+		 * Copy the header, as the first word (jump instruction, needs
+		 * to remain the same.
+		 */
+		memcpy(&header, buf, hdr_size);
+		/*
+		 * Check to see if we have zero bytes (excluding first 4, which
+		 * are the jump instruction)
+		 */
+		for (i = 1; i < hdr_size / 4; i++) {
+			if (((uint32_t *)buf)[i]) {
+				printf("ERROR: non-zero word found %x in location %d required for header, aborting\n",
+				       ((uint32_t *)buf)[i], i);
+				exit(-1);
+			}
+		}
+		debug("Zero bytes found in header location, adding header.\n");
+
+	} else {
+		printf("Unable to read from file %s\n", filename);
+		exit(-1);
+	}
+
+	/* Read data bytes and generate CRC */
+	lseek(fd, hdr_size, SEEK_SET);
+
+	while ((len = read(fd, buf, BUF_SIZE)) > 0) {
+		data_crc = crc32(data_crc, buf, len);
+		data_len += len;
+	}
+	printf("CRC of data: 0x%x, length: %d\n", data_crc, data_len);
+
+	/* Now create the new header */
+	header.magic = htonl(BOOTLOADER_HEADER_MAGIC);
+	header.maj_rev = htons(BOOTLOADER_HEADER_CURRENT_MAJOR_REV);
+	header.min_rev = htons(BOOTLOADER_HEADER_CURRENT_MINOR_REV);
Quoted 10 lines

tools/update_octeon_header.c line 374

Quoted 4 lines
tools/update_octeon_header.c new file +4 -0
+	header.dlen = htonl(data_len);
+	header.dcrc = htonl(data_crc);
+	header.board_type = htons(board_type);
+	header.address = cvmx_cpu_to_be64(address);

cvmx_cpu_to_be64() is a no-op, is this intentional? If yes, this macro can be removed. Otherwise you can use cpu_to_be64(). All cpu_to_be*() functions are automatically available in tools/ directory.

Viele Gr??e,
Stefan

Signature · 3 lines
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-51 Fax: (+49)-8142-66989-80 Email: sr at denx.de
#10 lore raw

PATCH v2 1/5 mips: start.S: Add Octeon boot header compatibility

In reply to Stefan Roese

Am Mittwoch, den 28.10.2020, 15:09 +0100 schrieb Stefan Roese:

Quoted 13 lines

Octeon has a specific boot header, when booted via SPI NOR, NAND or MMC. Here the only 2 instructions are allowed in the first few bytes of the image. And these instructions need to be one branch and a nop. This patch adds the necessary nop after the nop, to that the common MIPS image is compatible with this Octeon header.

The tool to patch the Octeon boot header into the image will be send in a follow-up patch.

Cc Aaron Williams <[email protected]>
Cc Chandrakala Chavva <[email protected]>
Cc Daniel Schwierzeck <[email protected]>
Quoted 9 lines

---
v2:
- Enhance comment
- Fix delay slot indentation

 arch/mips/cpu/start.S | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)
Signature · 1 line
- Daniel