Main Content

downloadImage

Download SD card image or bitstream file

collapse all in page

Add-On Required: This feature requires the SoC Blockset Support Package for AMD FPGA and SoC Devices add-on.

Syntax

downloadImage(devAD936x,'BoardName',devAD936xDeviceName)
downloadImage(devFMCOMMS5,'BoardName',devFMCOMMS5DeviceName)
downloadImage(devAD936x,'BoardName',devAD936xDeviceName,'IPAddress',IPAddress)
downloadImage(devAD936x,'BoardName',devAD936xDeviceName,'IPAddress',IPAddress,Name,Value)
downloadImage(devFMCOMMS5,'BoardName',devFMCOMMS5DeviceName,'IPAddress',IPAddress)
downloadImage(devFMCOMMS5,'BoardName',devFMCOMMS5DeviceName,'IPAddress',IPAddress,Name,Value)
downloadImage(___,'SDCardLocation',SDCardLocation)
downloadImage(___,'SDCardImage',SDCardImage)
downloadImage(___,'SDCardImage',SDCardImage,'SDCardLocation',SDCardLocation)
downloadImage(___,'FPGAImage',FPGAImage)

Description

downloadImage(devAD936x,'BoardName',devAD936xDeviceName) downloads the default SD card image onto the SD card inserted into the reader of the radio hardware associated with the radio object devAD936x. Specify the name of the radio hardware by devAD936xDeviceName. The board restarts with the new image.

example

downloadImage(devFMCOMMS5,'BoardName',devFMCOMMS5DeviceName) downloads the default SD card image onto the SD card inserted into the reader of the radio hardware associated with the radio object devFMCOMMS5. Specify the name of the radio hardware by devFMCOMMS5DeviceName. The board restarts with the new image.

downloadImage(devAD936x,'BoardName',devAD936xDeviceName,'IPAddress',IPAddress) updates the default SD card image with the specified IP address and downloads the image onto the SD card inserted into the reader of the radio hardware. The board restarts with the new image. The function also updates the IPAddress property of the devAD936x radio object accordingly.

downloadImage(devAD936x,'BoardName',devAD936xDeviceName,'IPAddress',IPAddress,Name,Value) uses additional options specified by one or more name-value pair arguments. Use these options to change the netmask and gateway of the updated IP address in the downloaded SD card image. The board restarts with the new image. The function also updates the IPAddress property of the devAD936x radio object accordingly.

downloadImage(devFMCOMMS5,'BoardName',devFMCOMMS5DeviceName,'IPAddress',IPAddress) updates the default SD card image with the specified IP address and downloads the image onto the SD card inserted into the reader of the radio hardware. The board restarts with the new image. The function also updates the IPAddress property of the devFMCOMMS5 radio object accordingly.

downloadImage(devFMCOMMS5,'BoardName',devFMCOMMS5DeviceName,'IPAddress',IPAddress,Name,Value) uses additional options specified by one or more name-value pair arguments. Use these options to change the netmask and gateway of the updated IP address in the downloaded SD card image. The board restarts with the new image. The function also updates the IPAddress property of the devFMCOMMS5 radio object accordingly.

downloadImage(___,'SDCardLocation',SDCardLocation) downloads the SD card image onto the SD card inserted into the SD card reader on the host computer specified by SDCardLocation. Use this name-value pair in addition to the input arguments in any of the previous syntax descriptions. After the image is downloaded, insert the SD card into the reader of the specified radio hardware and restart the board.

example

downloadImage(___,'SDCardImage',SDCardImage) downloads a custom SD card image onto the SD card inserted into the reader of the radio hardware. Use this name-value pair in addition to the input arguments in any of the first two syntax descriptions. The board restarts with the new image.

downloadImage(___,'SDCardImage',SDCardImage,'SDCardLocation',SDCardLocation) downloads a custom SD card image onto the SD card inserted into the specified SD card reader of the host computer. After the image is downloaded, insert the SD card into the reader of the specified radio hardware and restart the board. Use these name-value pairs in addition to the input arguments in any of the first two syntax descriptions.

downloadImage(___,'FPGAImage',FPGAImage) downloads the bitstream specified by FPGAImage onto the SD card inserted into the reader of the specified radio hardware. Use this name-value pair in addition to the input arguments in any of the first two syntax descriptions. The board restarts with the new image and the bitstream is downloaded to the radio hardware.

Note

To download the SD card image onto the SD card inserted into the reader of the radio hardware, an Ethernet connection must be present between the host and the radio hardware.

Examples

collapse all

This example uses:

Open Live Script

Connect the radio hardware to the host over an Ethernet cable and insert an SD card into the card reader on the radio hardware. Make sure your radio hardware is configured for host-radio communication by following the steps in Set Up Xilinx Devices.

Create a radio object for your radio hardware. For example: 

dev = sdrdev('AD936x')
dev = 
  SDRDevAD936x with properties:

     IPAddress: '192.168.3.2'
    DeviceName: 'AD936x'

Download the default SD card image onto the SD card by using the object and the device name.

downloadImage(dev,'BoardName','ADI RF SOM')
## Loading SD card image.
## Rebooting board.
## Reboot complete.

This example uses:

Open Live Script

Insert an SD card into the SD card reader on the host computer.

Create a radio object for your radio hardware.

dev = sdrdev('AD936x')
dev = 
  SDRDevAD936x with properties:

     IPAddress: '192.168.3.2'
    DeviceName: 'AD936x'

Download the default SD card image onto the SD card by using the object, the device name, and by specifying the drive name of the SD card reader.

downloadImage(dev,'BoardName','ADI RF SOM','SDCardLocation','G:')
## Copying to SD card.

Input Arguments

collapse all

Interface to AD936x-based Zynq radio hardware, specified as a comm.SDRDevAD936x radio object. To create this object, use the sdrdev function.

Name of AD936x-based Zynq radio hardware, specified as a character vector. Valid character vectors include:

  • 'ADI RF SOM'

  • 'ZC706 and FMCOMMS2/3/4'

  • 'ZedBoard and FMCOMMS2/3/4'

  • 'ZCU102 and FMCOMMS2/3/4'

Interface to FMCOMMS5 Zynq radio hardware, specified as a comm.SDRDevFMCOMMS5 radio object. To create this object, use the sdrdev function.

Name of FMCOMMS5 Zynq radio hardware, specified as 'ZC706 and FMCOMMS5'.

IP address of the radio hardware, specified as a dotted-quad character vector.

Drive name of the SD card reader on the host, specified as a character vector.

Example: 'SDCardLocation','Z:'

Folder location of a custom SD card image, specified as a character vector. To generate a custom SD card image, see FPGA Targeting Workflow.

Example: 'SDCardImage','C:\mywork\hdl_prj\sdr_prj\sdcard_image'

Bitstream file specified as 'Default' or a character vector containing the extension .bit. When you specify 'Default', the default bitstream is downloaded onto the SD card. Otherwise, you can download a custom bitstream. To generate custom bitstreams, see Step 7. Generate FPGA Bitstream and Program Zynq Hardware of the hardware-software co-design workflow.

Example: 'FPGAImage','C:\mywork\hdl_bitstreams\system_wrapper.bit'

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: 'Netmask','/23','Gateway','192.168.2.1' specifies the netmask and gateway for the network interface.

Netmask for network interface, specified as the comma-separated pair consisting of 'Netmask' and a character vector using the CIDR format.

Example: 'Netmask','/23'

Gateway for network interface, specified as the comma-separated pair consisting of 'Gateway' and a dotted-quad character vector.

Example: 'Gateway','192.168.2.1'

Version History

Introduced in R2014b

See Also

Objects

Functions

Topics