doc/html/ref/fis-create-command.html

   1 <!-- Copyright (C) 2003 Red Hat, Inc.                                -->
   2 <!-- This material may be distributed only subject to the terms      -->
   3 <!-- and conditions set forth in the Open Publication License, v1.0  -->
   4 <!-- or later (the latest version is presently available at          -->
   5 <!-- http://www.opencontent.org/openpub/).                           -->
   6 <!-- Distribution of the work or derivative of the work in any       -->
   7 <!-- standard (paper) book form is prohibited unless prior           -->
   8 <!-- permission is obtained from the copyright holder.               -->
   9 <HTML
  10 ><HEAD
  11 ><TITLE
  12 >fis create</TITLE
  13 ><meta name="MSSmartTagsPreventParsing" content="TRUE">
  14 <META
  15 NAME="GENERATOR"
  16 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
  17 "><LINK
  18 REL="HOME"
  19 TITLE="eCos Reference Manual"
  20 HREF="ecos-ref.html"><LINK
  21 REL="UP"
  22 TITLE="Flash Image System (FIS)"
  23 HREF="flash-image-system.html"><LINK
  24 REL="PREVIOUS"
  25 TITLE="fis free"
  26 HREF="fis-free-command.html"><LINK
  27 REL="NEXT"
  28 TITLE="fis load"
  29 HREF="fis-load-command.html"></HEAD
  30 ><BODY
  31 CLASS="REFENTRY"
  32 BGCOLOR="#FFFFFF"
  33 TEXT="#000000"
  34 LINK="#0000FF"
  35 VLINK="#840084"
  36 ALINK="#0000FF"
  37 ><DIV
  38 CLASS="NAVHEADER"
  39 ><TABLE
  40 SUMMARY="Header navigation table"
  41 WIDTH="100%"
  42 BORDER="0"
  43 CELLPADDING="0"
  44 CELLSPACING="0"
  45 ><TR
  46 ><TH
  47 COLSPAN="3"
  48 ALIGN="center"
  49 >eCos Reference Manual</TH
  50 ></TR
  51 ><TR
  52 ><TD
  53 WIDTH="10%"
  54 ALIGN="left"
  55 VALIGN="bottom"
  56 ><A
  57 HREF="fis-free-command.html"
  58 ACCESSKEY="P"
  59 >Prev</A
  60 ></TD
  61 ><TD
  62 WIDTH="80%"
  63 ALIGN="center"
  64 VALIGN="bottom"
  65 ></TD
  66 ><TD
  67 WIDTH="10%"
  68 ALIGN="right"
  69 VALIGN="bottom"
  70 ><A
  71 HREF="fis-load-command.html"
  72 ACCESSKEY="N"
  73 >Next</A
  74 ></TD
  75 ></TR
  76 ></TABLE
  77 ><HR
  78 ALIGN="LEFT"
  79 WIDTH="100%"></DIV
  80 ><H1
  81 ><A
  82 NAME="FIS-CREATE-COMMAND">fis create</H1
  83 ><DIV
  84 CLASS="REFNAMEDIV"
  85 ><A
  86 NAME="AEN4008"
  87 ></A
  88 ><H2
  89 >Name</H2
  90 >fis create&nbsp;--&nbsp;Create flash image</DIV
  91 ><DIV
  92 CLASS="REFSYNOPSISDIV"
  93 ><A
  94 NAME="AEN4011"><H2
  95 >Synopsis</H2
  96 ><P
  97 ><B
  98 CLASS="COMMAND"
  99 >fis create</B
 100 >  {-b <TT
 101 CLASS="REPLACEABLE"
 102 ><I
 103 > data address</I
 104 ></TT
 105 >} {-l <TT
 106 CLASS="REPLACEABLE"
 107 ><I
 108 > length</I
 109 ></TT
 110 >} [-f <TT
 111 CLASS="REPLACEABLE"
 112 ><I
 113 > flash address</I
 114 ></TT
 115 >] [-e <TT
 116 CLASS="REPLACEABLE"
 117 ><I
 118 > entry</I
 119 ></TT
 120 >] [-r <TT
 121 CLASS="REPLACEABLE"
 122 ><I
 123 > relocation address</I
 124 ></TT
 125 >] [-s <TT
 126 CLASS="REPLACEABLE"
 127 ><I
 128 > data length</I
 129 ></TT
 130 >] [-n ] [<TT
 131 CLASS="REPLACEABLE"
 132 ><I
 133 >name</I
 134 ></TT
 135 >]</P
 136 ></DIV
 137 ><DIV
 138 CLASS="REFSECT1"
 139 ><A
 140 NAME="AEN4029"
 141 ></A
 142 ><H2
 143 >Arguments</H2
 144 ><DIV
 145 CLASS="INFORMALTABLE"
 146 ><A
 147 NAME="AEN4031"><P
 148 ></P
 149 ><TABLE
 150 BORDER="1"
 151 CLASS="CALSTABLE"
 152 ><THEAD
 153 ><TR
 154 ><TH
 155 WIDTH="25%"
 156 ALIGN="LEFT"
 157 VALIGN="TOP"
 158 >Name</TH
 159 ><TH
 160 WIDTH="25%"
 161 ALIGN="LEFT"
 162 VALIGN="TOP"
 163 >Type</TH
 164 ><TH
 165 WIDTH="25%"
 166 ALIGN="LEFT"
 167 VALIGN="TOP"
 168 >Description</TH
 169 ><TH
 170 WIDTH="25%"
 171 ALIGN="LEFT"
 172 VALIGN="TOP"
 173 >Default</TH
 174 ></TR
 175 ></THEAD
 176 ><TBODY
 177 ><TR
 178 ><TD
 179 WIDTH="25%"
 180 ALIGN="LEFT"
 181 VALIGN="TOP"
 182 >-b</TD
 183 ><TD
 184 WIDTH="25%"
 185 ALIGN="LEFT"
 186 VALIGN="TOP"
 187 >Number</TD
 188 ><TD
 189 WIDTH="25%"
 190 ALIGN="LEFT"
 191 VALIGN="TOP"
 192 >Address of data to be written to the flash.</TD
 193 ><TD
 194 WIDTH="25%"
 195 ALIGN="LEFT"
 196 VALIGN="TOP"
 197 >Address of last loaded file. If not set in a load
 198               operation, it must be specified.</TD
 199 ></TR
 200 ><TR
 201 ><TD
 202 WIDTH="25%"
 203 ALIGN="LEFT"
 204 VALIGN="TOP"
 205 >-l</TD
 206 ><TD
 207 WIDTH="25%"
 208 ALIGN="LEFT"
 209 VALIGN="TOP"
 210 >Number</TD
 211 ><TD
 212 WIDTH="25%"
 213 ALIGN="LEFT"
 214 VALIGN="TOP"
 215 >Length of flash area to occopy. If specified, and
 216               the named image already exists, the length must match
 217               the value in the FIS directory.</TD
 218 ><TD
 219 WIDTH="25%"
 220 ALIGN="LEFT"
 221 VALIGN="TOP"
 222 >Length of area reserved in FIS directory if the
 223               image already exists, or the length of the last loaded
 224               file. If neither are set, it must be specified.</TD
 225 ></TR
 226 ><TR
 227 ><TD
 228 WIDTH="25%"
 229 ALIGN="LEFT"
 230 VALIGN="TOP"
 231 >-f</TD
 232 ><TD
 233 WIDTH="25%"
 234 ALIGN="LEFT"
 235 VALIGN="TOP"
 236 >Number</TD
 237 ><TD
 238 WIDTH="25%"
 239 ALIGN="LEFT"
 240 VALIGN="TOP"
 241 >Address of flash area to occopy.</TD
 242 ><TD
 243 WIDTH="25%"
 244 ALIGN="LEFT"
 245 VALIGN="TOP"
 246 >The address of an area reserved in the FIS
 247               directory for extant images. Otherwise the first free block
 248               which is large enough will be used.</TD
 249 ></TR
 250 ><TR
 251 ><TD
 252 WIDTH="25%"
 253 ALIGN="LEFT"
 254 VALIGN="TOP"
 255 >-e</TD
 256 ><TD
 257 WIDTH="25%"
 258 ALIGN="LEFT"
 259 VALIGN="TOP"
 260 >Number</TD
 261 ><TD
 262 WIDTH="25%"
 263 ALIGN="LEFT"
 264 VALIGN="TOP"
 265 >Entry address for an executable image, used by
 266               the <B
 267 CLASS="COMMAND"
 268 >fis load</B
 269 > command.</TD
 270 ><TD
 271 WIDTH="25%"
 272 ALIGN="LEFT"
 273 VALIGN="TOP"
 274 >The entry address of last loaded file.</TD
 275 ></TR
 276 ><TR
 277 ><TD
 278 WIDTH="25%"
 279 ALIGN="LEFT"
 280 VALIGN="TOP"
 281 >-r</TD
 282 ><TD
 283 WIDTH="25%"
 284 ALIGN="LEFT"
 285 VALIGN="TOP"
 286 >Number</TD
 287 ><TD
 288 WIDTH="25%"
 289 ALIGN="LEFT"
 290 VALIGN="TOP"
 291 >Address where the image should be relocated to by
 292               the <B
 293 CLASS="COMMAND"
 294 >fis load</B
 295 > command. This is only
 296               relevant for images that will be loaded with the
 297               <B
 298 CLASS="COMMAND"
 299 >fis load</B
 300 > command.</TD
 301 ><TD
 302 WIDTH="25%"
 303 ALIGN="LEFT"
 304 VALIGN="TOP"
 305 >The load address of the last loaded file.</TD
 306 ></TR
 307 ><TR
 308 ><TD
 309 WIDTH="25%"
 310 ALIGN="LEFT"
 311 VALIGN="TOP"
 312 >-s</TD
 313 ><TD
 314 WIDTH="25%"
 315 ALIGN="LEFT"
 316 VALIGN="TOP"
 317 >Number</TD
 318 ><TD
 319 WIDTH="25%"
 320 ALIGN="LEFT"
 321 VALIGN="TOP"
 322 >Actual length of data written to image. This is
 323               used to control the range over which the checksum is
 324               made.</TD
 325 ><TD
 326 WIDTH="25%"
 327 ALIGN="LEFT"
 328 VALIGN="TOP"
 329 >It defaults to the length of the last loaded
 330               file.</TD
 331 ></TR
 332 ><TR
 333 ><TD
 334 WIDTH="25%"
 335 ALIGN="LEFT"
 336 VALIGN="TOP"
 337 >-n</TD
 338 ><TD
 339 WIDTH="25%"
 340 ALIGN="LEFT"
 341 VALIGN="TOP"
 342 >&nbsp;</TD
 343 ><TD
 344 WIDTH="25%"
 345 ALIGN="LEFT"
 346 VALIGN="TOP"
 347 >When set, no image data will be written to the
 348               flash. Only the FIS directory will be updated.</TD
 349 ><TD
 350 WIDTH="25%"
 351 ALIGN="LEFT"
 352 VALIGN="TOP"
 353 >&nbsp;</TD
 354 ></TR
 355 ><TR
 356 ><TD
 357 WIDTH="25%"
 358 ALIGN="LEFT"
 359 VALIGN="TOP"
 360 ><TT
 361 CLASS="REPLACEABLE"
 362 ><I
 363 >name</I
 364 ></TT
 365 ></TD
 366 ><TD
 367 WIDTH="25%"
 368 ALIGN="LEFT"
 369 VALIGN="TOP"
 370 >String</TD
 371 ><TD
 372 WIDTH="25%"
 373 ALIGN="LEFT"
 374 VALIGN="TOP"
 375 >Name of flash image.</TD
 376 ><TD
 377 WIDTH="25%"
 378 ALIGN="LEFT"
 379 VALIGN="TOP"
 380 >&nbsp;</TD
 381 ></TR
 382 ></TBODY
 383 ></TABLE
 384 ><P
 385 ></P
 386 ></DIV
 387 ></DIV
 388 ><DIV
 389 CLASS="REFSECT1"
 390 ><A
 391 NAME="AEN4088"
 392 ></A
 393 ><H2
 394 >Description</H2
 395 ><P
 396 >This command creates an image in the FIS directory. The data for the
 397 image must exist in RAM memory before the copy. Typically, you would use the
 398 RedBoot <B
 399 CLASS="COMMAND"
 400 >load</B
 401 > command to load file into
 402 RAM and then the <B
 403 CLASS="COMMAND"
 404 >fis create</B
 405 > command to write
 406 it to a flash image.</P
 407 ></DIV
 408 ><DIV
 409 CLASS="REFSECT1"
 410 ><A
 411 NAME="AEN4093"
 412 ></A
 413 ><H2
 414 >Examples</H2
 415 ><P
 416 >Trying to create an extant image, will require the action
 417       to be verified.
 418 <TABLE
 419 BORDER="5"
 420 BGCOLOR="#E0E0F0"
 421 WIDTH="70%"
 422 ><TR
 423 ><TD
 424 ><PRE
 425 CLASS="SCREEN"
 426 >RedBoot&#62; <TT
 427 CLASS="USERINPUT"
 428 ><B
 429 >fis create RedBoot -f 0xa0000000 -b 0x8c400000 -l 0x20000</B
 430 ></TT
 431 >
 432 An image named &#8216;RedBoot&#8217; exists - continue (y/n)? <TT
 433 CLASS="USERINPUT"
 434 ><B
 435 >n</B
 436 ></TT
 437 ></PRE
 438 ></TD
 439 ></TR
 440 ></TABLE
 441 ></P
 442 ><P
 443 >Create a new test image, let the command find a suitable place.
 444 <TABLE
 445 BORDER="5"
 446 BGCOLOR="#E0E0F0"
 447 WIDTH="70%"
 448 ><TR
 449 ><TD
 450 ><PRE
 451 CLASS="SCREEN"
 452 >RedBoot&#62; <TT
 453 CLASS="USERINPUT"
 454 ><B
 455 >fis create junk -b 0x8c400000 -l 0x20000</B
 456 ></TT
 457 >
 458 ... Erase from 0xa0040000-0xa0060000: .
 459 ... Program from 0x8c400000-0x8c420000 at 0xa0040000: .
 460 ... Erase from 0xa0fe0000-0xa1000000: .
 461 ... Program from 0x8c7d0000-0x8c7f0000 at 0xa0fe0000: .</PRE
 462 ></TD
 463 ></TR
 464 ></TABLE
 465 ></P
 466 ><P
 467 >Update the RedBoot[RAM] image.
 468 <TABLE
 469 BORDER="5"
 470 BGCOLOR="#E0E0F0"
 471 WIDTH="70%"
 472 ><TR
 473 ><TD
 474 ><PRE
 475 CLASS="SCREEN"
 476 >RedBoot&#62; <TT
 477 CLASS="USERINPUT"
 478 ><B
 479 >load redboot_RAM.img</B
 480 ></TT
 481 >
 482 Entry point: 0x060213c0, address range: 0x06020000-0x06036cc0
 483 RedBoot&#62; <TT
 484 CLASS="USERINPUT"
 485 ><B
 486 >fis create RedBoot[RAM]</B
 487 ></TT
 488 >
 489 No memory address set.
 490 An image named 'RedBoot[RAM]' exists - continue (y/n)? <TT
 491 CLASS="USERINPUT"
 492 ><B
 493 >y</B
 494 ></TT
 495 >
 496 * CAUTION * about to program 'RedBoot[RAM]'
 497             at 0x00020000..0x00036cbf from 0x06020000 - continue (y/n)? <TT
 498 CLASS="USERINPUT"
 499 ><B
 500 >y</B
 501 ></TT
 502 >
 503 ... Erase from 0x00020000-0x00040000: ..
 504 ... Program from 0x06020000-0x06036cc0 at 0x00020000: ..
 505 ... Erase from 0x00070000-0x00080000: .
 506 ... Program from 0x0606f000-0x0607f000 at 0x00070000: .</PRE
 507 ></TD
 508 ></TR
 509 ></TABLE
 510 ></P
 511 ></DIV
 512 ><DIV
 513 CLASS="NAVFOOTER"
 514 ><HR
 515 ALIGN="LEFT"
 516 WIDTH="100%"><TABLE
 517 SUMMARY="Footer navigation table"
 518 WIDTH="100%"
 519 BORDER="0"
 520 CELLPADDING="0"
 521 CELLSPACING="0"
 522 ><TR
 523 ><TD
 524 WIDTH="33%"
 525 ALIGN="left"
 526 VALIGN="top"
 527 ><A
 528 HREF="fis-free-command.html"
 529 ACCESSKEY="P"
 530 >Prev</A
 531 ></TD
 532 ><TD
 533 WIDTH="34%"
 534 ALIGN="center"
 535 VALIGN="top"
 536 ><A
 537 HREF="ecos-ref.html"
 538 ACCESSKEY="H"
 539 >Home</A
 540 ></TD
 541 ><TD
 542 WIDTH="33%"
 543 ALIGN="right"
 544 VALIGN="top"
 545 ><A
 546 HREF="fis-load-command.html"
 547 ACCESSKEY="N"
 548 >Next</A
 549 ></TD
 550 ></TR
 551 ><TR
 552 ><TD
 553 WIDTH="33%"
 554 ALIGN="left"
 555 VALIGN="top"
 556 >fis free</TD
 557 ><TD
 558 WIDTH="34%"
 559 ALIGN="center"
 560 VALIGN="top"
 561 ><A
 562 HREF="flash-image-system.html"
 563 ACCESSKEY="U"
 564 >Up</A
 565 ></TD
 566 ><TD
 567 WIDTH="33%"
 568 ALIGN="right"
 569 VALIGN="top"
 570 >fis load</TD
 571 ></TR
 572 ></TABLE
 573 ></DIV
 574 ></BODY
 575 ></HTML
 576 >