1 // SPDX-License-Identifier: GPL-2.0-only
4 * Copyright (C) 2007 OpenWrt.org
5 * Copyright (C) 2007 Gabor Juhos <juhosg at openwrt.org>
12 #include <unistd.h> /* for unlink() */
14 #include <getopt.h> /* for getopt() */
18 #include <endian.h> /* for __BYTE_ORDER */
19 #if defined(__CYGWIN__)
20 # include <byteswap.h>
23 #if (__BYTE_ORDER == __LITTLE_ENDIAN)
24 # define HOST_TO_LE16(x) (x)
25 # define HOST_TO_LE32(x) (x)
26 # define LE16_TO_HOST(x) (x)
27 # define LE32_TO_HOST(x) (x)
29 # define HOST_TO_LE16(x) bswap_16(x)
30 # define HOST_TO_LE32(x) bswap_32(x)
31 # define LE16_TO_HOST(x) bswap_16(x)
32 # define LE32_TO_HOST(x) bswap_32(x)
35 #define MAX_NUM_BLOCKS 2
36 #define MAX_ARG_COUNT 32
37 #define MAX_ARG_LEN 1024
38 #define FILE_BUF_LEN (16*1024)
39 #define DEFAULT_PADC 0xFF
41 #define DEFAULT_BLOCK_ALIGN 0x10000U
43 #define CSUM_TYPE_NONE 0
45 #define CSUM_TYPE_16 2
46 #define CSUM_TYPE_32 3
57 char *file_name
; /* name of the file */
58 uint32_t file_size
; /* length of the file */
74 } __attribute__ ((packed
));
85 } __attribute__ ((packed
));
97 uint32_t max_kernel_size
;
101 #define HEADER_TYPE_NFS 0
102 #define HEADER_TYPE_CAS 1
104 #define KERNEL_SIZE_CAS (61*64*1024)
105 #define KERNEL_SIZE_NFS (52*64*1024)
106 #define FS_SIZE_NFS (9*64*1024)
108 #define CAS_MAGIC1 0x5241AA55
109 #define CAS_MAGIC2 0x524F4741
110 #define CAS_MAGIC3 0xD3F22D4E
112 /* Cellvision/SparkLAN products */
113 #define MODEL_CAS_630 0x01000000
114 #define MODEL_CAS_630W 0x01000000
115 #define MODEL_CAS_670 0x01000000
116 #define MODEL_CAS_670W 0x01000000
117 #define MODEL_NFS_101U 0x01000000
118 #define MODEL_NFS_101WU 0x01000003
119 #define MODEL_NFS_202U 0x01000001
120 #define MODEL_NFS_202WU 0x01000002
122 /* Corega products */
123 #define MODEL_CG_NSADP 0x01000020 /* NFS-101U */
124 #define MODEL_CG_NSADPCR 0x01000021 /* NFS-202U */
126 /* D-Link products */
127 #define MODEL_DCS_950 0x01010102 /* CAS-630 */
128 #define MODEL_DCS_950G 0x01020102 /* CAS-630W */
129 #define MODEL_DNS_120 0x01000030 /* NFS-101U */
130 #define MODEL_DNS_G120 0x01000032 /* NFS-101WU */
132 /* Digitus products */
133 #define MODEL_DN_16021 MODEL_CAS_630
134 #define MODEL_DN_16022 MODEL_CAS_630W
135 #define MODEL_DN_16030 MODEL_CAS_670
136 #define MODEL_DN_16031 MODEL_CAS_670W
137 #define MODEL_DN_7013 MODEL_NFS_101U
140 #define MODEL_LB_SS01TXU 0x00000000
142 /* Neu-Fusion products */
144 /* Ovislink products */
145 #define MODEL_MU_5000FS 0x01000040 /* NFS-101U */
146 #define MODEL_WL_5420CAM 0x020B0101 /* CAS-630W? */
147 #define MODEL_WL_5460CAM 0x020B0001 /* CAS-670W */
149 /* Repotec products */
151 /* Sitecom products */
152 #define MODEL_LN_350 /* unknown */
153 #define MODEL_LN_403 0x01020402
154 #define MODEL_WL_401 0x01010402
156 /* Surecom products */
157 #define MODEL_EP_4001_MM 0x01030A02 /* CAS-630 */
158 #define MODEL_EP_4002_MM 0x01020A02 /* CAS-630W */
159 #define MODEL_EP_4011_MM 0x01010A02 /* CAS-670 */
160 #define MODEL_EP_4012_MM 0x01000A02 /* CAS-670W */
161 #define MODEL_EP_9812_U /* unknown */
163 /* Trendnet products */
164 #define MODEL_TN_U100 0x01000081 /* NFS-101U */
165 #define MODEL_TN_U200 0x01000082 /* NFS-202U */
173 int keep_invalid_images
;
174 int invalid_causes_error
= 1;
175 union file_hdr header
;
177 struct image_desc kernel_image
;
178 struct image_desc fs_image
;
180 struct board_info
*board
= NULL
;
182 #define BOARD(m, n, i, ks, fs, h) { \
186 .max_kernel_size = (ks), \
187 .max_fs_size = (fs), \
191 #define BOARD_CAS(m,n,i) \
192 BOARD(m, n, i, KERNEL_SIZE_CAS, 0, HEADER_TYPE_CAS)
193 #define BOARD_NFS(m,n,i) \
194 BOARD(m, n, i, KERNEL_SIZE_NFS, FS_SIZE_NFS, HEADER_TYPE_NFS)
196 static struct board_info boards
[] = {
197 /* Cellvision/Sparklan products */
198 BOARD_CAS("CAS-630", "Cellvision CAS-630", MODEL_CAS_630
),
199 BOARD_CAS("CAS-630W", "Cellvision CAS-630W", MODEL_CAS_630W
),
200 BOARD_CAS("CAS-670", "Cellvision CAS-670", MODEL_CAS_670
),
201 BOARD_CAS("CAS-670W", "Cellvision CAS-670W", MODEL_CAS_670W
),
202 BOARD_NFS("NFS-101U", "Cellvision NFS-101U", MODEL_NFS_101U
),
203 BOARD_NFS("NFS-101WU", "Cellvision NFS-101WU", MODEL_NFS_101WU
),
204 BOARD_NFS("NFS-202U", "Cellvision NFS-202U", MODEL_NFS_202U
),
205 BOARD_NFS("NFS-202WU", "Cellvision NFS-202WU", MODEL_NFS_202WU
),
207 /* Corega products */
208 BOARD_NFS("CG-NSADP", "Corega CG-NSADP", MODEL_CG_NSADP
),
209 BOARD_NFS("CG-NSADPCR", "Corega CG-NSADPCR", MODEL_CG_NSADPCR
),
211 /* D-Link products */
212 BOARD_CAS("DCS-950", "D-Link DCS-950", MODEL_DCS_950
),
213 BOARD_CAS("DCS-950G", "D-Link DCS-950G", MODEL_DCS_950G
),
214 BOARD_NFS("DNS-120", "D-Link DNS-120", MODEL_DNS_120
),
215 BOARD_NFS("DNS-G120", "D-Link DNS-G120", MODEL_DNS_G120
),
217 /* Digitus products */
218 BOARD_NFS("DN-7013", "Digitus DN-7013", MODEL_DN_7013
),
221 BOARD_NFS("LB-SS01TXU", "Lobos LB-SS01TXU", MODEL_LB_SS01TXU
),
223 /* Ovislink products */
224 BOARD_NFS("MU-5000FS", "Ovislink MU-5000FS", MODEL_MU_5000FS
),
225 BOARD_CAS("WL-5420CAM", "Ovislink WL-5420 CAM", MODEL_WL_5420CAM
),
226 BOARD_CAS("WL-5460CAM", "Ovislink WL-5460 CAM", MODEL_WL_5460CAM
),
228 /* Sitecom products */
229 BOARD_CAS("LN-403", "Sitecom LN-403", MODEL_LN_403
),
230 BOARD_CAS("WL-401", "Sitecom WL-401", MODEL_WL_401
),
232 /* Surecom products */
233 BOARD_CAS("EP-4001-MM", "Surecom EP-4001-MM", MODEL_EP_4001_MM
),
234 BOARD_CAS("EP-4002-MM", "Surecom EP-4002-MM", MODEL_EP_4002_MM
),
235 BOARD_CAS("EP-4011-MM", "Surecom EP-4011-MM", MODEL_EP_4011_MM
),
236 BOARD_CAS("EP-4012-MM", "Surecom EP-4012-MM", MODEL_EP_4012_MM
),
238 /* TrendNET products */
239 BOARD_NFS("TN-U100", "TrendNET TN-U100", MODEL_TN_U100
),
240 BOARD_NFS("TN-U200", "TrendNET TN-U200", MODEL_TN_U200
),
248 #define ERR(fmt, ...) do { \
250 fprintf(stderr, "[%s] *** error: " fmt "\n", \
251 progname, ## __VA_ARGS__ ); \
254 #define ERRS(fmt, ...) do { \
257 fprintf(stderr, "[%s] *** error: " fmt ": %s\n", \
258 progname, ## __VA_ARGS__, strerror(save)); \
261 #define WARN(fmt, ...) do { \
262 fprintf(stderr, "[%s] *** warning: " fmt "\n", \
263 progname, ## __VA_ARGS__ ); \
266 #define DBG(lev, fmt, ...) do { \
267 if (verblevel < lev) \
269 fprintf(stderr, "[%s] " fmt "\n", progname, ## __VA_ARGS__ ); \
273 #define ERR_INVALID_IMAGE -2
278 FILE *stream
= (status
!= EXIT_SUCCESS
) ? stderr
: stdout
;
279 struct board_info
*board
;
281 fprintf(stream
, "Usage: %s [OPTIONS...] <file>\n", progname
);
285 " -B <board> create image for the board specified with <board>.\n"
286 " valid <board> values:\n"
288 for (board
= boards
; board
->model
!= NULL
; board
++){
291 board
->model
, board
->name
);
294 " -d don't throw error on invalid images\n"
295 " -k keep invalid images\n"
296 " -K <file> add kernel to the image\n"
297 " -C <file> add custom filesystem to the image\n"
298 " -h show this screen\n"
300 " <file> write output to the file <file>\n"
306 static inline uint32_t align(uint32_t base
, uint32_t alignment
)
311 ret
= (base
+ alignment
- 1);
312 ret
&= ~(alignment
-1);
324 str2u32(char *arg
, uint32_t *val
)
330 t
= strtoul(arg
, &err
, 0);
331 if (errno
|| (err
==arg
) || ((err
!= NULL
) && *err
)) {
341 str2u16(char *arg
, uint16_t *val
)
347 t
= strtoul(arg
, &err
, 0);
348 if (errno
|| (err
==arg
) || ((err
!= NULL
) && *err
) || (t
>= 0x10000)) {
357 str2u8(char *arg
, uint8_t *val
)
363 t
= strtoul(arg
, &err
, 0);
364 if (errno
|| (err
==arg
) || ((err
!= NULL
) && *err
) || (t
>= 0x100)) {
373 parse_arg(char *arg
, char *buf
, char *argv
[])
381 memset(argv
, 0, MAX_ARG_COUNT
* sizeof(void *));
394 if (argl
>= MAX_ARG_LEN
) {
395 /* argument is too long */
396 argl
= MAX_ARG_LEN
-1;
399 memcpy(buf
, arg
, argl
);
402 for (i
= 0; i
< MAX_ARG_COUNT
; i
++) {
403 tok
= strsep(ap
, ":");
408 else if (tok
[0] == '\0') {
421 required_arg(char c
, char *arg
)
423 if (arg
== NULL
|| *arg
!= '-')
426 ERR("option -%c requires an argument\n", c
);
432 is_empty_arg(char *arg
)
443 csum8_update(uint8_t *p
, uint32_t len
, struct csum_state
*css
)
445 for ( ; len
> 0; len
--) {
452 csum8_get(struct csum_state
*css
)
462 csum16_update(void *data
, uint32_t len
, struct csum_state
*css
)
468 t
= css
->tmp
+ (p
[0]<<8);
469 css
->val
+= LE16_TO_HOST(t
);
475 for ( ; len
> 1; len
-= 2, p
+=2 ) {
476 t
= p
[0] + (p
[1] << 8);
477 css
->val
+= LE16_TO_HOST(t
);
488 csum16_get(struct csum_state
*css
)
492 csum16_update(&pad
, 1, css
);
493 return ~css
->val
+ 1;
497 csum32_update(uint8_t *p
, uint32_t len
, struct csum_state
*css
)
501 for ( ; len
> 3; len
-= 4, p
+= 4 ) {
502 t
= p
[0] + (p
[1] << 8) + (p
[2] << 16) + (p
[3] << 24);
508 csum32_get(struct csum_state
*css
)
515 csum_init(struct csum_state
*css
, int size
)
524 csum_update(void *data
, uint32_t len
, struct csum_state
*css
)
530 csum8_update(p
,len
,css
);
533 csum16_update(p
,len
,css
);
536 csum32_update(p
,len
,css
);
543 csum_get(struct csum_state
*css
)
549 ret
= csum8_get(css
);
552 ret
= csum16_get(css
);
555 ret
= csum32_get(css
);
558 ERR("invalid checksum size\n");
567 * routines to write data to the output file
570 write_out_data(FILE *outfile
, void *data
, size_t len
,
571 struct csum_state
*css
)
577 fwrite(ptr
, len
, 1, outfile
);
579 ERRS("unable to write output file");
584 csum_update(ptr
, len
, css
);
592 write_out_padding(FILE *outfile
, size_t len
, uint8_t padc
,
593 struct csum_state
*css
)
596 size_t buflen
= sizeof(buf
);
599 memset(buf
, padc
, buflen
);
604 err
= write_out_data(outfile
, buf
, buflen
, css
);
616 image_stat_file(struct image_desc
*desc
)
621 if (desc
->file_name
== NULL
)
624 err
= stat(desc
->file_name
, &st
);
626 ERRS("stat failed on %s", desc
->file_name
);
630 if (st
.st_size
> desc
->out_size
) {
631 WARN("file %s is too big, will be truncated to %d bytes\n",
632 desc
->file_name
, desc
->out_size
);
633 desc
->file_size
= desc
->out_size
;
634 return ERR_INVALID_IMAGE
;
638 desc
->file_size
= st
.st_size
;
639 desc
->out_size
= align(desc
->file_size
,1);
645 image_writeout_file(FILE *outfile
, struct image_desc
*desc
,
646 struct csum_state
*css
)
648 char buf
[FILE_BUF_LEN
];
649 size_t buflen
= sizeof(buf
);
654 if (desc
->file_name
== NULL
)
657 if (desc
->file_size
== 0)
661 f
= fopen(desc
->file_name
,"r");
663 ERRS("unable to open file: %s", desc
->file_name
);
667 len
= desc
->file_size
;
672 /* read data from source file */
674 fread(buf
, buflen
, 1, f
);
676 ERRS("unable to read from file: %s", desc
->file_name
);
681 res
= write_out_data(outfile
, buf
, buflen
, css
);
694 image_writeout(FILE *outfile
, struct image_desc
*desc
)
697 struct csum_state css
;
702 if (!desc
->file_size
)
705 DBG(2, "writing image, file=%s, file_size=%d\n",
706 desc
->file_name
, desc
->file_size
);
708 csum_init(&css
, CSUM_TYPE_32
);
710 res
= image_writeout_file(outfile
, desc
, &css
);
714 /* write padding data if neccesary */
715 padlen
= desc
->out_size
- desc
->file_size
;
716 DBG(1,"padding desc, length=%zu", padlen
);
717 res
= write_out_padding(outfile
, padlen
, desc
->padc
, &css
);
719 desc
->csum
= csum_get(&css
);
726 write_out_header(FILE *outfile
)
732 if (fseek(outfile
, 0, SEEK_SET
) != 0) {
733 ERRS("fseek failed on output file");
737 switch (board
->header_type
) {
738 case HEADER_TYPE_CAS
:
739 tmp
.cas
.type
= HOST_TO_LE32(header
.cas
.type
);
740 tmp
.cas
.id
= HOST_TO_LE32(header
.cas
.id
);
741 tmp
.cas
.kernel_offs
= HOST_TO_LE32(sizeof(tmp
.cas
));
742 tmp
.cas
.kernel_size
= HOST_TO_LE32(kernel_image
.out_size
);
743 tmp
.cas
.kernel_csum
= HOST_TO_LE32(kernel_image
.csum
);
744 tmp
.cas
.magic1
= HOST_TO_LE32(CAS_MAGIC1
);
745 tmp
.cas
.magic2
= HOST_TO_LE32(CAS_MAGIC2
);
746 tmp
.cas
.magic3
= HOST_TO_LE32(CAS_MAGIC3
);
747 res
= write_out_data(outfile
, (uint8_t *)&tmp
.cas
,
748 sizeof(tmp
.cas
), NULL
);
750 case HEADER_TYPE_NFS
:
751 tmp
.nfs
.type
= HOST_TO_LE32(header
.nfs
.type
);
752 tmp
.nfs
.id
= HOST_TO_LE32(header
.nfs
.id
);
753 tmp
.nfs
.kernel_offs
= HOST_TO_LE32(sizeof(tmp
.nfs
));
754 tmp
.nfs
.kernel_size
= HOST_TO_LE32(kernel_image
.out_size
);
755 tmp
.nfs
.kernel_csum
= HOST_TO_LE32(kernel_image
.csum
);
756 tmp
.nfs
.fs_offs
= HOST_TO_LE32(sizeof(tmp
.nfs
)
757 + kernel_image
.out_size
);
758 tmp
.nfs
.fs_size
= HOST_TO_LE32(fs_image
.out_size
);
759 tmp
.nfs
.fs_csum
= HOST_TO_LE32(fs_image
.csum
);
760 res
= write_out_data(outfile
, (uint8_t *)&tmp
.nfs
,
761 sizeof(tmp
.nfs
), NULL
);
764 ERR("invalid header type\n");
772 write_out_images(FILE *outfile
)
776 res
= image_writeout(outfile
, &kernel_image
);
780 res
= image_writeout(outfile
, &fs_image
);
789 find_board(char *model
)
791 struct board_info
*ret
;
792 struct board_info
*board
;
795 for (board
= boards
; board
->model
!= NULL
; board
++){
796 if (strcasecmp(model
, board
->model
) == 0) {
807 parse_opt_board(char ch
, char *arg
)
810 DBG(1,"parsing board option: -%c %s", ch
, arg
);
813 ERR("only one board option allowed");
817 if (required_arg(ch
, arg
))
820 board
= find_board(arg
);
822 ERR("invalid/unknown board specified: %s", arg
);
826 switch (board
->header_type
) {
827 case HEADER_TYPE_CAS
:
828 header
.cas
.type
= HEADER_TYPE_CAS
;
829 header
.cas
.id
= board
->id
;
831 case HEADER_TYPE_NFS
:
832 header
.nfs
.type
= HEADER_TYPE_NFS
;
833 header
.nfs
.id
= board
->id
;
836 ERR("internal error, unknown header type\n");
845 parse_opt_image(char ch
, char *arg
)
847 char buf
[MAX_ARG_LEN
];
848 char *argv
[MAX_ARG_COUNT
];
850 struct image_desc
*desc
= NULL
;
855 if (kernel_image
.file_name
) {
856 WARN("only one kernel option allowed");
859 desc
= &kernel_image
;
862 if (fs_image
.file_name
) {
863 WARN("only one fs option allowed");
873 parse_arg(arg
, buf
, argv
);
877 if (!is_empty_arg(p
)) {
878 desc
->file_name
= strdup(p
);
879 if (desc
->file_name
== NULL
) {
880 ERR("not enough memory");
884 ERR("no file specified for option %c", ch
);
897 kernel_image
.out_size
= board
->max_kernel_size
;
898 kernel_image
.padc
= DEFAULT_PADC
;
899 res
= image_stat_file(&kernel_image
);
903 if (!fs_image
.file_name
)
906 fs_image
.out_size
= board
->max_fs_size
;
907 fs_image
.padc
= DEFAULT_PADC
;
908 res
= image_stat_file(&fs_image
);
917 main(int argc
, char *argv
[])
919 int optinvalid
= 0; /* flag for invalid option */
925 progname
=basename(argv
[0]);
927 opterr
= 0; /* could not print standard getopt error messages */
931 c
= getopt(argc
, argv
, "B:C:dhK:r:vw:x:");
937 optinvalid
= parse_opt_board(c
,optarg
);
940 invalid_causes_error
= 0;
944 optinvalid
= parse_opt_image(c
,optarg
);
947 keep_invalid_images
= 1;
959 if (optinvalid
!= 0 ){
960 ERR("invalid option: -%c", optopt
);
966 ERR("no board specified");
970 if (optind
== argc
) {
971 ERR("no output file specified");
975 ofname
= argv
[optind
++];
978 ERR("invalid option: %s", argv
[optind
]);
982 res
= process_images();
983 if (res
== ERR_FATAL
)
986 if (res
== ERR_INVALID_IMAGE
) {
987 if (invalid_causes_error
)
990 if (keep_invalid_images
== 0) {
991 WARN("generation of invalid images \"%s\" disabled", ofname
);
995 WARN("generating invalid image: \"%s\"", ofname
);
998 outfile
= fopen(ofname
, "w");
999 if (outfile
== NULL
) {
1000 ERRS("could not open \"%s\" for writing", ofname
);
1005 if (write_out_header(outfile
) != 0) {
1010 if (write_out_images(outfile
) != 0) {
1015 if (write_out_header(outfile
) != 0) {
1020 DBG(1,"Image file %s completed.", ofname
);
1025 if (res
== ERR_FATAL
) {
1029 if (res
== ERR_FATAL
)
1030 return EXIT_FAILURE
;
1032 return EXIT_SUCCESS
;