doc/html/ref/download-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 >load</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="Common Commands"
  23 HREF="common-commands.html"><LINK
  24 REL="PREVIOUS"
  25 TITLE="ip_address"
  26 HREF="ip-address-command.html"><LINK
  27 REL="NEXT"
  28 TITLE="mcmp"
  29 HREF="mcmp-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="ip-address-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="mcmp-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="DOWNLOAD-COMMAND">load</H1
  83 ><DIV
  84 CLASS="REFNAMEDIV"
  85 ><A
  86 NAME="AEN3433"
  87 ></A
  88 ><H2
  89 >Name</H2
  90 >load&nbsp;--&nbsp;Download programs or data to the RedBoot platform</DIV
  91 ><DIV
  92 CLASS="REFSYNOPSISDIV"
  93 ><A
  94 NAME="AEN3436"><H2
  95 >Synopsis</H2
  96 ><P
  97 ><B
  98 CLASS="COMMAND"
  99 >load</B
 100 >  [-v ] [-d ] [-r ] [-m
 101            [[xmodem | ymodem] | tftp | disk]
 102         ] [-h <TT
 103 CLASS="REPLACEABLE"
 104 ><I
 105 > server_IP_address</I
 106 ></TT
 107 >] [-b <TT
 108 CLASS="REPLACEABLE"
 109 ><I
 110 > location</I
 111 ></TT
 112 >] [-c <TT
 113 CLASS="REPLACEABLE"
 114 ><I
 115 > channel</I
 116 ></TT
 117 >] [<TT
 118 CLASS="REPLACEABLE"
 119 ><I
 120 >file_name</I
 121 ></TT
 122 >]</P
 123 ></DIV
 124 ><DIV
 125 CLASS="REFSECT1"
 126 ><A
 127 NAME="AEN3458"
 128 ></A
 129 ><H2
 130 >Arguments</H2
 131 ><DIV
 132 CLASS="INFORMALTABLE"
 133 ><A
 134 NAME="AEN3460"><P
 135 ></P
 136 ><TABLE
 137 BORDER="1"
 138 CLASS="CALSTABLE"
 139 ><THEAD
 140 ><TR
 141 ><TH
 142 WIDTH="25%"
 143 ALIGN="LEFT"
 144 VALIGN="TOP"
 145 >Name</TH
 146 ><TH
 147 WIDTH="25%"
 148 ALIGN="LEFT"
 149 VALIGN="TOP"
 150 >Type</TH
 151 ><TH
 152 WIDTH="25%"
 153 ALIGN="LEFT"
 154 VALIGN="TOP"
 155 >Description</TH
 156 ><TH
 157 WIDTH="25%"
 158 ALIGN="LEFT"
 159 VALIGN="TOP"
 160 >Default</TH
 161 ></TR
 162 ></THEAD
 163 ><TBODY
 164 ><TR
 165 ><TD
 166 WIDTH="25%"
 167 ALIGN="LEFT"
 168 VALIGN="TOP"
 169 >-v</TD
 170 ><TD
 171 WIDTH="25%"
 172 ALIGN="LEFT"
 173 VALIGN="TOP"
 174 >Boolean</TD
 175 ><TD
 176 WIDTH="25%"
 177 ALIGN="LEFT"
 178 VALIGN="TOP"
 179 >Display a small spinner (indicator)
 180 while the download is in  progress. This is just for feedback, especially
 181 during long loads. Note that the option has no effect when using a
 182 serial download method since it would interfere with the protocol.</TD
 183 ><TD
 184 WIDTH="25%"
 185 ALIGN="LEFT"
 186 VALIGN="TOP"
 187 ><SPAN
 188 CLASS="emphasis"
 189 ><I
 190 CLASS="EMPHASIS"
 191 >quiet</I
 192 ></SPAN
 193 ></TD
 194 ></TR
 195 ><TR
 196 ><TD
 197 WIDTH="25%"
 198 ALIGN="LEFT"
 199 VALIGN="TOP"
 200 >-d</TD
 201 ><TD
 202 WIDTH="25%"
 203 ALIGN="LEFT"
 204 VALIGN="TOP"
 205 >Boolean</TD
 206 ><TD
 207 WIDTH="25%"
 208 ALIGN="LEFT"
 209 VALIGN="TOP"
 210 >Decompress data stream (gzip data)</TD
 211 ><TD
 212 WIDTH="25%"
 213 ALIGN="LEFT"
 214 VALIGN="TOP"
 215 ><SPAN
 216 CLASS="emphasis"
 217 ><I
 218 CLASS="EMPHASIS"
 219 >non-compressed data</I
 220 ></SPAN
 221 ></TD
 222 ></TR
 223 ><TR
 224 ><TD
 225 WIDTH="25%"
 226 ALIGN="LEFT"
 227 VALIGN="TOP"
 228 >-r</TD
 229 ><TD
 230 WIDTH="25%"
 231 ALIGN="LEFT"
 232 VALIGN="TOP"
 233 >Boolean</TD
 234 ><TD
 235 WIDTH="25%"
 236 ALIGN="LEFT"
 237 VALIGN="TOP"
 238 >Raw (or binary) data</TD
 239 ><TD
 240 WIDTH="25%"
 241 ALIGN="LEFT"
 242 VALIGN="TOP"
 243 ><SPAN
 244 CLASS="emphasis"
 245 ><I
 246 CLASS="EMPHASIS"
 247 >formatted (S-records, ELF image, etc)</I
 248 ></SPAN
 249 ></TD
 250 ></TR
 251 ><TR
 252 ><TD
 253 WIDTH="25%"
 254 ALIGN="LEFT"
 255 VALIGN="TOP"
 256 >-m tftp</TD
 257 ><TD
 258 WIDTH="25%"
 259 ALIGN="LEFT"
 260 VALIGN="TOP"
 261 >&nbsp;</TD
 262 ><TD
 263 WIDTH="25%"
 264 ALIGN="LEFT"
 265 VALIGN="TOP"
 266 >Transfer data via the network using <SPAN
 267 CLASS="ACRONYM"
 268 >TFTP</SPAN
 269 > protocol.</TD
 270 ><TD
 271 WIDTH="25%"
 272 ALIGN="LEFT"
 273 VALIGN="TOP"
 274 ><SPAN
 275 CLASS="ACRONYM"
 276 >TFTP</SPAN
 277 ></TD
 278 ></TR
 279 ><TR
 280 ><TD
 281 WIDTH="25%"
 282 ALIGN="LEFT"
 283 VALIGN="TOP"
 284 >-m http</TD
 285 ><TD
 286 WIDTH="25%"
 287 ALIGN="LEFT"
 288 VALIGN="TOP"
 289 >&nbsp;</TD
 290 ><TD
 291 WIDTH="25%"
 292 ALIGN="LEFT"
 293 VALIGN="TOP"
 294 >Transfer data via the network using <SPAN
 295 CLASS="ACRONYM"
 296 >HTTP</SPAN
 297 > protocol.</TD
 298 ><TD
 299 WIDTH="25%"
 300 ALIGN="LEFT"
 301 VALIGN="TOP"
 302 ><SPAN
 303 CLASS="ACRONYM"
 304 >TFTP</SPAN
 305 ></TD
 306 ></TR
 307 ><TR
 308 ><TD
 309 WIDTH="25%"
 310 ALIGN="LEFT"
 311 VALIGN="TOP"
 312 >-m xmodem</TD
 313 ><TD
 314 WIDTH="25%"
 315 ALIGN="LEFT"
 316 VALIGN="TOP"
 317 >&nbsp;</TD
 318 ><TD
 319 WIDTH="25%"
 320 ALIGN="LEFT"
 321 VALIGN="TOP"
 322 >Transfer data using <SPAN
 323 CLASS="emphasis"
 324 ><I
 325 CLASS="EMPHASIS"
 326 >X-modem</I
 327 ></SPAN
 328 > protocol.</TD
 329 ><TD
 330 WIDTH="25%"
 331 ALIGN="LEFT"
 332 VALIGN="TOP"
 333 ><SPAN
 334 CLASS="ACRONYM"
 335 >TFTP</SPAN
 336 ></TD
 337 ></TR
 338 ><TR
 339 ><TD
 340 WIDTH="25%"
 341 ALIGN="LEFT"
 342 VALIGN="TOP"
 343 >-m ymodem</TD
 344 ><TD
 345 WIDTH="25%"
 346 ALIGN="LEFT"
 347 VALIGN="TOP"
 348 >&nbsp;</TD
 349 ><TD
 350 WIDTH="25%"
 351 ALIGN="LEFT"
 352 VALIGN="TOP"
 353 >Transfer data using <SPAN
 354 CLASS="emphasis"
 355 ><I
 356 CLASS="EMPHASIS"
 357 >Y-modem</I
 358 ></SPAN
 359 > protocol.</TD
 360 ><TD
 361 WIDTH="25%"
 362 ALIGN="LEFT"
 363 VALIGN="TOP"
 364 ><SPAN
 365 CLASS="ACRONYM"
 366 >TFTP</SPAN
 367 ></TD
 368 ></TR
 369 ><TR
 370 ><TD
 371 WIDTH="25%"
 372 ALIGN="LEFT"
 373 VALIGN="TOP"
 374 >-m disk</TD
 375 ><TD
 376 WIDTH="25%"
 377 ALIGN="LEFT"
 378 VALIGN="TOP"
 379 >&nbsp;</TD
 380 ><TD
 381 WIDTH="25%"
 382 ALIGN="LEFT"
 383 VALIGN="TOP"
 384 >Transfer data from a local disk.</TD
 385 ><TD
 386 WIDTH="25%"
 387 ALIGN="LEFT"
 388 VALIGN="TOP"
 389 ><SPAN
 390 CLASS="ACRONYM"
 391 >TFTP</SPAN
 392 ></TD
 393 ></TR
 394 ><TR
 395 ><TD
 396 WIDTH="25%"
 397 ALIGN="LEFT"
 398 VALIGN="TOP"
 399 >-h <TT
 400 CLASS="REPLACEABLE"
 401 ><I
 402 >server_IP_address</I
 403 ></TT
 404 ></TD
 405 ><TD
 406 WIDTH="25%"
 407 ALIGN="LEFT"
 408 VALIGN="TOP"
 409 >Numeric IP or DNS name</TD
 410 ><TD
 411 WIDTH="25%"
 412 ALIGN="LEFT"
 413 VALIGN="TOP"
 414 >The IP address of the <SPAN
 415 CLASS="ACRONYM"
 416 >TFTP</SPAN
 417 > or <SPAN
 418 CLASS="ACRONYM"
 419 >HTTP</SPAN
 420 > server.</TD
 421 ><TD
 422 WIDTH="25%"
 423 ALIGN="LEFT"
 424 VALIGN="TOP"
 425 >Value set by <B
 426 CLASS="COMMAND"
 427 >ip_address</B
 428 ></TD
 429 ></TR
 430 ><TR
 431 ><TD
 432 WIDTH="25%"
 433 ALIGN="LEFT"
 434 VALIGN="TOP"
 435 >-b <TT
 436 CLASS="REPLACEABLE"
 437 ><I
 438 >location</I
 439 ></TT
 440 ></TD
 441 ><TD
 442 WIDTH="25%"
 443 ALIGN="LEFT"
 444 VALIGN="TOP"
 445 >Number</TD
 446 ><TD
 447 WIDTH="25%"
 448 ALIGN="LEFT"
 449 VALIGN="TOP"
 450 >Address in memory to load the data.  Formatted data streams will have
 451 an implied load address which this option may override.</TD
 452 ><TD
 453 WIDTH="25%"
 454 ALIGN="LEFT"
 455 VALIGN="TOP"
 456 ><SPAN
 457 CLASS="emphasis"
 458 ><I
 459 CLASS="EMPHASIS"
 460 >Depends on data format</I
 461 ></SPAN
 462 ></TD
 463 ></TR
 464 ><TR
 465 ><TD
 466 WIDTH="25%"
 467 ALIGN="LEFT"
 468 VALIGN="TOP"
 469 >-c <TT
 470 CLASS="REPLACEABLE"
 471 ><I
 472 >channel</I
 473 ></TT
 474 ></TD
 475 ><TD
 476 WIDTH="25%"
 477 ALIGN="LEFT"
 478 VALIGN="TOP"
 479 >Number</TD
 480 ><TD
 481 WIDTH="25%"
 482 ALIGN="LEFT"
 483 VALIGN="TOP"
 484 >Specify which I/O channel to
 485 use for download.  This option is only supported when using either
 486 xmodem or ymodem protocol.</TD
 487 ><TD
 488 WIDTH="25%"
 489 ALIGN="LEFT"
 490 VALIGN="TOP"
 491 ><SPAN
 492 CLASS="emphasis"
 493 ><I
 494 CLASS="EMPHASIS"
 495 >Depends on data format</I
 496 ></SPAN
 497 ></TD
 498 ></TR
 499 ><TR
 500 ><TD
 501 WIDTH="25%"
 502 ALIGN="LEFT"
 503 VALIGN="TOP"
 504 ><TT
 505 CLASS="REPLACEABLE"
 506 ><I
 507 >file_name</I
 508 ></TT
 509 ></TD
 510 ><TD
 511 WIDTH="25%"
 512 ALIGN="LEFT"
 513 VALIGN="TOP"
 514 >String</TD
 515 ><TD
 516 WIDTH="25%"
 517 ALIGN="LEFT"
 518 VALIGN="TOP"
 519 >The name of the file on the <SPAN
 520 CLASS="ACRONYM"
 521 >TFTP</SPAN
 522 > or <SPAN
 523 CLASS="ACRONYM"
 524 >HTTP</SPAN
 525 >
 526 server or the local disk. Details of how this is specified for <SPAN
 527 CLASS="ACRONYM"
 528 >TFTP</SPAN
 529 > are
 530 host-specific. For local disk files, the name must be in <SPAN
 531 CLASS="emphasis"
 532 ><I
 533 CLASS="EMPHASIS"
 534 >disk</I
 535 ></SPAN
 536 >:
 537 <SPAN
 538 CLASS="emphasis"
 539 ><I
 540 CLASS="EMPHASIS"
 541 >filename</I
 542 ></SPAN
 543 > format. The disk portion must match one of the disk
 544 names listed by the <B
 545 CLASS="COMMAND"
 546 >disks</B
 547 > command.</TD
 548 ><TD
 549 WIDTH="25%"
 550 ALIGN="LEFT"
 551 VALIGN="TOP"
 552 ><SPAN
 553 CLASS="emphasis"
 554 ><I
 555 CLASS="EMPHASIS"
 556 >None</I
 557 ></SPAN
 558 ></TD
 559 ></TR
 560 ></TBODY
 561 ></TABLE
 562 ><P
 563 ></P
 564 ></DIV
 565 ></DIV
 566 ><DIV
 567 CLASS="REFSECT1"
 568 ><A
 569 NAME="AEN3561"
 570 ></A
 571 ><H2
 572 >Description</H2
 573 ><P
 574 >The <B
 575 CLASS="COMMAND"
 576 >load</B
 577 > command is used to download
 578 data into the target system. Data can be loaded via a network connection,
 579 using either the <SPAN
 580 CLASS="ACRONYM"
 581 >TFTP</SPAN
 582 > or <SPAN
 583 CLASS="ACRONYM"
 584 >HTTP</SPAN
 585 > protocols, or the console serial connection using the
 586 X/Y modem protocol. Files may also be loaded directly from local filesystems
 587 on disk. Files to be downloaded may either be executable images in
 588 ELF executable program format,
 589 Motorola S-record (SREC)
 590 format or raw data.
 591       </P
 592 ></DIV
 593 ><DIV
 594 CLASS="REFSECT1"
 595 ><A
 596 NAME="AEN3567"
 597 ></A
 598 ><H2
 599 >Examples</H2
 600 ><P
 601 >Download a Motorola S-record (or ELF) image, using <SPAN
 602 CLASS="ACRONYM"
 603 >TFTP</SPAN
 604 >, specifying the
 605 base memory address.
 606 <TABLE
 607 BORDER="5"
 608 BGCOLOR="#E0E0F0"
 609 WIDTH="70%"
 610 ><TR
 611 ><TD
 612 ><PRE
 613 CLASS="SCREEN"
 614 >RedBoot&#62; <TT
 615 CLASS="USERINPUT"
 616 ><B
 617 >load redboot.ROM -b 0x8c400000</B
 618 ></TT
 619 >
 620 Address offset = 0x0c400000
 621 Entry point: 0x80000000, address range: 0x80000000-0x8000fe80</PRE
 622 ></TD
 623 ></TR
 624 ></TABLE
 625 >
 626       </P
 627 ><P
 628 >Download a Motorola S-record (or ELF) image, using <SPAN
 629 CLASS="ACRONYM"
 630 >HTTP</SPAN
 631 >, specifying the
 632 host [server] address.
 633 <TABLE
 634 BORDER="5"
 635 BGCOLOR="#E0E0F0"
 636 WIDTH="70%"
 637 ><TR
 638 ><TD
 639 ><PRE
 640 CLASS="SCREEN"
 641 >RedBoot&#62; <TT
 642 CLASS="USERINPUT"
 643 ><B
 644 >load /redboot.ROM -m HTTP -h 192.168.1.104</B
 645 ></TT
 646 >
 647 Address offset = 0x0c400000
 648 Entry point: 0x80000000, address range: 0x80000000-0x8000fe80</PRE
 649 ></TD
 650 ></TR
 651 ></TABLE
 652 >
 653       </P
 654 ><P
 655 >Load an ELF file from /dev/hda1 which should be an EXT2 partition:
 656 <TABLE
 657 BORDER="5"
 658 BGCOLOR="#E0E0F0"
 659 WIDTH="70%"
 660 ><TR
 661 ><TD
 662 ><PRE
 663 CLASS="SCREEN"
 664 >RedBoot&#62; <TT
 665 CLASS="USERINPUT"
 666 ><B
 667 >load -mode disk hda1:hello.elf</B
 668 ></TT
 669 >
 670 Entry point: 0x00020000, address range: 0x00020000-0x0002fd70</PRE
 671 ></TD
 672 ></TR
 673 ></TABLE
 674 >
 675       </P
 676 ></DIV
 677 ><DIV
 678 CLASS="NAVFOOTER"
 679 ><HR
 680 ALIGN="LEFT"
 681 WIDTH="100%"><TABLE
 682 SUMMARY="Footer navigation table"
 683 WIDTH="100%"
 684 BORDER="0"
 685 CELLPADDING="0"
 686 CELLSPACING="0"
 687 ><TR
 688 ><TD
 689 WIDTH="33%"
 690 ALIGN="left"
 691 VALIGN="top"
 692 ><A
 693 HREF="ip-address-command.html"
 694 ACCESSKEY="P"
 695 >Prev</A
 696 ></TD
 697 ><TD
 698 WIDTH="34%"
 699 ALIGN="center"
 700 VALIGN="top"
 701 ><A
 702 HREF="ecos-ref.html"
 703 ACCESSKEY="H"
 704 >Home</A
 705 ></TD
 706 ><TD
 707 WIDTH="33%"
 708 ALIGN="right"
 709 VALIGN="top"
 710 ><A
 711 HREF="mcmp-command.html"
 712 ACCESSKEY="N"
 713 >Next</A
 714 ></TD
 715 ></TR
 716 ><TR
 717 ><TD
 718 WIDTH="33%"
 719 ALIGN="left"
 720 VALIGN="top"
 721 >ip_address</TD
 722 ><TD
 723 WIDTH="34%"
 724 ALIGN="center"
 725 VALIGN="top"
 726 ><A
 727 HREF="common-commands.html"
 728 ACCESSKEY="U"
 729 >Up</A
 730 ></TD
 731 ><TD
 732 WIDTH="33%"
 733 ALIGN="right"
 734 VALIGN="top"
 735 >mcmp</TD
 736 ></TR
 737 ></TABLE
 738 ></DIV
 739 ></BODY
 740 ></HTML
 741 >