1/* 2 * Copyright (C) 2006,2007 Gabor Juhos 3 * 4 * This program is free software; you can redistribute it and/or modify it 5 * under the terms of the GNU General Public License as published by the 6 * Free Software Foundation; either version 2 of the License, or (at your 7 * option) any later version. 8 * 9 */ 10 11#ifndef _MYLOADER_H_ 12#define _MYLOADER_H_ 13 14/* 15 * Firmware file format: 16 * 17 * <header> 18 * [<block descriptor 0>] 19 * ... 20 * [<block descriptor n>] 21 * <null block descriptor> 22 * [<block data 0>] 23 * ... 24 * [<block data n>] 25 * 26 * 27 */ 28 29/* Myloader specific magic numbers */ 30#define MYLO_MAGIC_FIRMWARE 0x4C594D00 31#define MYLO_MAGIC_20021103 0x20021103 32#define MYLO_MAGIC_20021107 0x20021107 33 34#define MYLO_MAGIC_SYS_PARAMS MYLO_MAGIC_20021107 35#define MYLO_MAGIC_PARTITIONS MYLO_MAGIC_20021103 36#define MYLO_MAGIC_BOARD_PARAMS MYLO_MAGIC_20021103 37 38/* 39 * Addresses of the data structures provided by MyLoader 40 */ 41#define MYLO_MIPS_SYS_PARAMS 0x80000800 /* System Parameters */ 42#define MYLO_MIPS_BOARD_PARAMS 0x80000A00 /* Board Parameters */ 43#define MYLO_MIPS_PARTITIONS 0x80000C00 /* Partition Table */ 44#define MYLO_MIPS_BOOT_PARAMS 0x80000E00 /* Boot Parameters */ 45 46/* Vendor ID's (seems to be same as the PCI vendor ID's) */ 47#define VENID_COMPEX 0x11F6 48 49/* Devices based on the ADM5120 */ 50#define DEVID_COMPEX_NP27G 0x0078 51#define DEVID_COMPEX_NP28G 0x044C 52#define DEVID_COMPEX_NP28GHS 0x044E 53#define DEVID_COMPEX_WP54Gv1C 0x0514 54#define DEVID_COMPEX_WP54G 0x0515 55#define DEVID_COMPEX_WP54AG 0x0546 56#define DEVID_COMPEX_WPP54AG 0x0550 57#define DEVID_COMPEX_WPP54G 0x0555 58 59/* Devices based on the IXP422 */ 60#define DEVID_COMPEX_WP18 0x047E 61#define DEVID_COMPEX_NP18A 0x0489 62 63/* Other devices */ 64#define DEVID_COMPEX_NP26G8M 0x03E8 65#define DEVID_COMPEX_NP26G16M 0x03E9 66 67struct mylo_fw_header { 68 uint32_t magic; /* must be MYLO_MAGIC_FIRMWARE */ 69 uint32_t crc; /* CRC of the whole firmware */ 70 uint32_t res0; /* unknown/unused */ 71 uint32_t res1; /* unknown/unused */ 72 uint16_t vid; /* vendor ID */ 73 uint16_t did; /* device ID */ 74 uint16_t svid; /* sub vendor ID */ 75 uint16_t sdid; /* sub device ID */ 76 uint32_t rev; /* device revision */ 77 uint32_t fwhi; /* FIXME: firmware version high? */ 78 uint32_t fwlo; /* FIXME: firmware version low? */ 79 uint32_t flags; /* firmware flags */ 80}; 81 82#define FW_FLAG_BOARD_PARAMS_WP 0x01 /* board parameters are write protected */ 83#define FW_FLAG_BOOT_SECTOR_WE 0x02 /* enable of write boot sectors (below 64K) */ 84 85struct mylo_fw_blockdesc { 86 uint32_t type; /* block type */ 87 uint32_t addr; /* relative address to flash start */ 88 uint32_t dlen; /* size of block data in bytes */ 89 uint32_t blen; /* total size of block in bytes */ 90}; 91 92#define FW_DESC_TYPE_UNUSED 0 93#define FW_DESC_TYPE_USED 1 94 95struct mylo_partition { 96 uint16_t flags; /* partition flags */ 97 uint16_t type; /* type of the partition */ 98 uint32_t addr; /* relative address of the partition from the 99 flash start */ 100 uint32_t size; /* size of the partition in bytes */ 101 uint32_t param; /* if this is the active partition, the 102 MyLoader load code to this address */ 103}; 104 105#define PARTITION_FLAG_ACTIVE 0x8000 /* this is the active partition, 106 * MyLoader loads firmware from here */ 107#define PARTITION_FLAG_ISRAM 0x2000 /* FIXME: this is a RAM partition? */ 108#define PARTIIION_FLAG_RAMLOAD 0x1000 /* FIXME: load this partition into the RAM? */ 109#define PARTITION_FLAG_PRELOAD 0x0800 /* the partition data preloaded to RAM 110 * before decompression */ 111#define PARTITION_FLAG_HAVEHDR 0x0002 /* the partition data have a header */ 112 113#define PARTITION_TYPE_FREE 0 114#define PARTITION_TYPE_USED 1 115 116#define MYLO_MAX_PARTITIONS 8 /* maximum number of partitions in the 117 partition table */ 118 119struct mylo_partition_table { 120 uint32_t magic; /* must be MYLO_MAGIC_PARTITIONS */ 121 uint32_t res0; /* unknown/unused */ 122 uint32_t res1; /* unknown/unused */ 123 uint32_t res2; /* unknown/unused */ 124 struct mylo_partition partitions[MYLO_MAX_PARTITIONS]; 125}; 126 127struct mylo_partition_header { 128 uint32_t len; /* length of the partition data */ 129 uint32_t crc; /* CRC value of the partition data */ 130}; 131 132struct mylo_system_params { 133 uint32_t magic; /* must be MYLO_MAGIC_SYS_PARAMS */ 134 uint32_t res0; 135 uint32_t res1; 136 uint32_t mylo_ver; 137 uint16_t vid; /* Vendor ID */ 138 uint16_t did; /* Device ID */ 139 uint16_t svid; /* Sub Vendor ID */ 140 uint16_t sdid; /* Sub Device ID */ 141 uint32_t rev; /* device revision */ 142 uint32_t fwhi; 143 uint32_t fwlo; 144 uint32_t tftp_addr; 145 uint32_t prog_start; 146 uint32_t flash_size; /* Size of boot FLASH in bytes */ 147 uint32_t dram_size; /* Size of onboard RAM in bytes */ 148}; 149 150 151struct mylo_eth_addr { 152 uint8_t mac[6]; 153 uint8_t csum[2]; 154}; 155 156#define MYLO_ETHADDR_COUNT 8 /* maximum number of ethernet address 157 in the board parameters */ 158 159struct mylo_board_params { 160 uint32_t magic; /* must be MYLO_MAGIC_BOARD_PARAMS */ 161 uint32_t res0; 162 uint32_t res1; 163 uint32_t res2; 164 struct mylo_eth_addr addr[MYLO_ETHADDR_COUNT]; 165}; 166 167#endif /* _MYLOADER_H_*/ 168