diff --git a/docs/source/user_guide/project_commands/cmd_upload.rst b/docs/source/user_guide/project_commands/cmd_upload.rst deleted file mode 100644 index 210ee528..00000000 --- a/docs/source/user_guide/project_commands/cmd_upload.rst +++ /dev/null @@ -1,104 +0,0 @@ -.. _cmd_upload: - -apio upload -=========== - -.. contents:: - -Usage ------ - -.. code:: - - apio upload [OPTIONS] - -Description ------------ - -Upload the bitstream to the FPGA. It builds the project if required. - -It also performs an automatic discovery and validation of the FTDI chip depending on the selected board. - -Required packages: ``scons``, ``system``, ``icestorm``. - -.. note:: - - FTDI driver configuration must be done before upload. More information in :ref:`cmd_drivers`. - -Options -------- - -.. program:: apio upload - -.. option:: - -b, --board - -Select a specific board. - -.. option:: - --serial-port - -Select a specific serial port. You can check the available serial devices with the command ``apio system --lsserial``. - -.. option:: - --ftdi-id - -Select a specific FTDI index. You can check the available FTDI indexes with the command ``apio system --lsftdi``. -This numerical index is provided by **libftdi1**, that is different from *libftdi0*. - -.. option:: - -s, --sram - -Perform SRAM programming. Only available for `iceprog` compatible boards. - -.. option:: - -p, --project-dir - -Set the target directory for the project. - -.. option:: - -v, --verbose - -Show the entire output of the command. - -.. option:: - --verbose-yosys - -Show the yosys output of the command. - -.. option:: - --verbose-arachne - -Show the arachne output of the command. - -.. note:: - - All available boards, FPGAs, sizes, types and packs are showed in :ref:`cmd_boards` - -Examples --------- - -1. Upload the *leds example* - -.. code:: - - $ apio upload - [] Processing icezum - --------------------------------------------------------------------------------------------- - [...] - iceprog -d i:0x0403:0x6010:0 hardware.bin - init.. - cdone: high - reset.. - cdone: low - flash ID: 0x20 0xBA 0x16 0x10 0x00 0x00 0x23 0x51 0x85 0x32 0x13 0x00 0x54 0x00 0x29 0x10 0x06 0x15 0x51 0x62 - file size: 32220 - erase 64kB sector at 0x000000.. - programming.. - reading.. - VERIFY OK - cdone: high - Bye. - ================================== [SUCCESS] Took 1.96 seconds ============================== - -.. Executing: scons -Q upload fpga_type=hx fpga_pack=tq144 fpga_size=1k device=0 -f /path/to/SConstruct