Bar
SpaceWire UK
Specialist providers of VHDL Intellectual Property & Design Services
BarBarBarBar
Tutorial
Missing Image!
Part 21 - Add textural information inside the PL to provide project & build information (10 December 2021)

Introduction

This tutorial details the steps required to add a read-only register bank inside the PL that will contain product identification, version & timestamp information. The tutorial covers quite a range of activities and includes the use of numerous languages; C, HTML, Javascript, System Verilog, TCL & Verilog.

Aims

The aims of this tutorial are as follows :-
  1. Setup environment
  2. Change present working directory
  3. Launch Vivado & open project
  4. Create AXI4-Lite peripheral (HDL)
  5. Open block design
  6. Re-customize AXI GPIO
  7. Add peripheral to block design
  8. Edit address map
  9. Create, move & modify HDL wrapper
  10. Create build hook scripts
  11. Generate bitstream
  12. Export hardware platform
  13. Create peek string C application
  14. Update website to display ID strings
  15. Update Javascript to peek ID strings
  16. Rebuild PetaLinux to include updates
  17. Setup Zedboard hardware
  18. Deploy PetaLinux on Zedboard
  19. Check everything is working as expected
  20. Files for revision control

1. Setup environment

Setup Xilinx design environment for the 2021.2 toolset.
steve@Linux-Steve:/home/steve$ source xilinx.sh
Xilinx tools available tools at /opt/Xilinx :-
1) 2021.2 - Vivado - SDK - Vitis - PetaLinux
0) Exit
Please select tools required or exit : 1

Tools are as follows :-
vivado @ /opt/Xilinx/Vivado/2021.2/bin/vivado
vitis @ /opt/Xilinx/Vitis/2021.2/bin/vitis
petalinux-build @ /opt/Xilinx/PetaLinux/2021.2/tool/tools/common/petalinux/bin/petalinux-build

2. Change present working directory

Change the present working directory to be the project directory.
steve@Linux-Steve:/home/steve$ cd /home/steve/projects/leds_switches/fw

3. Launch Vivado & open project

Launch Vivado quietly from a Terminal.
steve@Linux-Steve:/home/steve/projects/leds_switches/fw$ vivado -nojournal -nolog -notrace project.xpr &

4. Create AXI4-Lite peripheral (HDL)

Add a new HDL source file to Vivado by right clicking on Design Sources within Sources and selecting Add Sources... from the context menu. Missing Image! In the Add Sources dialog select Add or create design sources and then click Next. Missing Image! In the Add Sources - Add or Create Design Sources dialog click on Create File. Missing Image! In the Create Source File dialog set File type to Verilog, File name to axi_identification and File location to /home/steve/projects/leds_switches/usr/hdl. Click OK to continue. Missing Image! In the Add Sources - Add or Create Design Sources dialog click Finish. Missing Image! In the Define Module dialog click OK to continue. Missing Image! Edit the newly added axi_identication by double clicking on it within Sources. Missing Image! Using the AXI4 peripheral generated in the previous tutorial as a starting point a new AXI4 peripheral can be created containing registers that hold textural information. No write access to the registers is required but the write logic is left in to make the AXI interface complete (most of it will be optimised away). Modify axi_identication.v and replace its stub code with something similar to the following.

axi_identification.v

  1. //
  2. // File .......... axi_identification.v
  3. // Author ........ Steve Haywood
  4. // Version ....... 1.0
  5. // Date .......... 5 December 2021
  6. // Standard ...... IEEE 1364-2001
  7. // Description ...
  8. //   AXI4-Lite controlled register bank written in basic Verilog. The register
  9. // bank contains the following fixed length identification and timestamp
  10. // strings.
  11. //
  12. // Product Description ........ 128 Characters - 32 Registers - 0x000 - 0x07F
  13. // Company ....................  64 Characters - 16 Registers - 0x080 - 0x0BF
  14. // Author .....................  64 Characters - 16 Registers - 0x0C0 - 0x0FF
  15. // Product Version ............  16 Characters -  4 Registers - 0x100 - 0x10F
  16. // Firmware Build Timestamp ...  32 Characters -  8 Registers - 0x110 - 0x12F
  17. // Unused ..................... 208 Characters - 52 Registers - 0x130 - 0x1FF
  18. //                              ---              ---            -------------
  19. //                              512              128          - 0x000 - 0x1FF
  20. //


  23. `timescale 1 ns / 1 ps


  26. module axi_identification #
  27. (
  28.   // Parameters (AXI4-Lite)
  29.   localparam c_addr_w           = 9,                       // P:Address Bus Width (bits)
  30.   localparam c_data_w           = 32,                      // P:Data Bus Width (bits)
  31.   // Parameters (ID Strings)
  32.   localparam c_id_description_w = 128,                     // P:Description Width (chars)
  33.   localparam c_id_company_w     = 64,                      // P:Company Width (chars)
  34.   localparam c_id_author_w      = 64,                      // P:Author Width (chars)
  35.   localparam c_id_version_w     = 16,                      // P:Version Width (chars)
  36.   localparam c_id_timestamp_w   = 32                       // P:Timestamp Width (chars)
  37. )
  38. (
  39.   // Clock & Reset
  40.   input  wire                             aclk,            // I:Clock
  41.   input  wire                             aresetn,         // I:Reset
  42.   // Identification Strings
  43.   input  wire [8*c_id_description_w-1 :0] id_description,  // I:Product Description
  44.   input  wire [8*c_id_company_w-1 : 0]    id_company,      // I:Company
  45.   input  wire [8*c_id_author_w-1 : 0]     id_author,       // I:Author
  46.   input  wire [8*c_id_version_w-1 : 0]    id_version,      // I:Product Version
  47.   input  wire [8*c_id_timestamp_w-1 : 0]  id_timestamp,    // I:Firmware Build Timestamp
  48.   // AXI4-Lite - Write Address Channel
  49.   input  wire [c_addr_w-1 : 0]            s_axi_awaddr,    // I:Write Address
  50.   input  wire [2 : 0]                     s_axi_awprot,    // I:Write Protection Type
  51.   input  wire                             s_axi_awvalid,   // I:Write Address Valid
  52.   output reg                              s_axi_awready,   // O:Write Address Ready
  53.   // AXI4-Lite - Write Data Channel
  54.   input  wire [c_data_w-1 : 0]            s_axi_wdata,     // I:Write Data
  55.   input  wire [(c_data_w/8)-1 : 0]        s_axi_wstrb,     // I:Write Strobes
  56.   input  wire                             s_axi_wvalid,    // I:Write Valid
  57.   output reg                              s_axi_wready,    // O:Write Ready
  58.   // AXI4-Lite - Write Response Channel
  59.   output reg  [1 : 0]                     s_axi_bresp,     // O:Write Response
  60.   output reg                              s_axi_bvalid,    // O:Write Response Valid
  61.   input  wire                             s_axi_bready,    // I:Write Response Ready
  62.   // AXI4-Lite - Read Address Channel
  63.   input  wire [c_addr_w-1 : 0]            s_axi_araddr,    // I:Read Address
  64.   input  wire [2 : 0]                     s_axi_arprot,    // I:Read Protection Type
  65.   input  wire                             s_axi_arvalid,   // I:Read Address Valid
  66.   output reg                              s_axi_arready,   // O:Read Address Ready
  67.   // AXI4-Lite - Read Data Channel
  68.   output reg  [c_data_w-1 : 0]            s_axi_rdata,     // O:Read Data
  69.   output reg  [1 : 0]                     s_axi_rresp,     // O:Read Response
  70.   output reg                              s_axi_rvalid,    // O:Read Valid
  71.   input  wire                             s_axi_rready     // I:Read Ready
  72. );


  75.   // Constants
  76.   localparam no_regs = 2**(c_addr_w - $clog2(c_data_w / 8));
  77.   localparam id_description_lo = 0;
  78.   localparam id_description_hi = id_description_lo + (c_id_description_w / 4) - 1;
  79.   localparam id_company_lo     = 1 + id_description_hi;
  80.   localparam id_company_hi     = id_company_lo + (c_id_company_w / 4) - 1;
  81.   localparam id_author_lo      = 1 + id_company_hi;
  82.   localparam id_author_hi      = id_author_lo + (c_id_author_w / 4) -1;
  83.   localparam id_version_lo     = 1 + id_author_hi;
  84.   localparam id_version_hi     = id_version_lo + (c_id_version_w / 4) - 1;
  85.   localparam id_timestamp_lo   = 1 + id_version_hi;
  86.   localparam id_timestamp_hi   = id_timestamp_lo + (c_id_timestamp_w / 4) - 1;


  89.   // Signals
  90.   reg aw_en;
  91.   reg [c_addr_w-$clog2(c_data_w / 8) - 1 : 0] axi_awaddr;
  92.   reg [c_addr_w-$clog2(c_data_w / 8) - 1 : 0] axi_araddr;
  93.   reg [c_data_w-1 : 0] registers_wr [no_regs - 1 : 0];
  94.   wire [c_data_w-1 : 0] registers_rd [no_regs - 1 : 0];


  97.   // Write Address Ready
  98.   always @(posedge aclk)
  99.     if (!aresetn) begin
  100.       s_axi_awready <= 1'b0;
  101.       aw_en <= 1'b1;
  102.     end else if (s_axi_awvalid && !s_axi_awready && s_axi_wvalid && aw_en) begin
  103.       s_axi_awready <= 1'b1;
  104.       aw_en <= 1'b0;
  105.     end else if (s_axi_bvalid && s_axi_bready) begin
  106.       s_axi_awready <= 1'b0;
  107.       aw_en <= 1'b1;
  108.     end else
  109.       s_axi_awready <= 1'b0;


  112.   // Write Address Latch
  113.   always @(posedge aclk)
  114.     if (!aresetn)
  115.       axi_awaddr <= {c_addr_w{1'b0}};
  116.     else if (s_axi_awvalid && !s_axi_awready && s_axi_wvalid && aw_en)
  117.       axi_awaddr <= s_axi_awaddr[c_addr_w - 1 : $clog2(c_data_w/8)];


  120.   // Write Data Ready
  121.   always @(posedge aclk)
  122.     if (!aresetn)
  123.       s_axi_wready <= 1'b0;
  124.     else if (s_axi_awvalid && s_axi_wvalid && !s_axi_wready && aw_en)
  125.       s_axi_wready <= 1'b1;
  126.     else
  127.       s_axi_wready <= 1'b0;


  130.   // Write Data
  131.   integer i;
  132.   always @(posedge aclk)
  133.     if (!aresetn)
  134.       for (i = 0; i <= no_regs - 1; i = i + 1)
  135.         registers_wr[i] <= {c_data_w{1'b0}};
  136.     else if (s_axi_awvalid && s_axi_awready && s_axi_wvalid && s_axi_wready)
  137.       for (i = 0; i <= c_data_w/8 - 1; i = i + 1)
  138.         if (s_axi_wstrb[i])
  139.           registers_wr[axi_awaddr][i*8 +: 8] <= s_axi_wdata[i*8 +: 8]; // Byte-Wise Write


  142.   // Write Response
  143.   always @(posedge aclk)
  144.     if (!aresetn) begin
  145.       s_axi_bvalid <= 1'b0;
  146.       s_axi_bresp  <= 2'b00;
  147.     end else if (s_axi_awvalid && s_axi_awready && s_axi_wvalid && s_axi_wready && !s_axi_bvalid) begin
  148.       s_axi_bvalid <= 1'b1;
  149.       s_axi_bresp  <= 2'b00;
  150.     end else if (s_axi_bvalid && s_axi_bready)
  151.       s_axi_bvalid <= 1'b0;


  154.   // Read Address Ready
  155.   always @(posedge aclk)
  156.     if (!aresetn)
  157.       s_axi_arready <= 1'b0;
  158.     else if (s_axi_arvalid && !s_axi_arready)
  159.       s_axi_arready <= 1'b1;
  160.     else
  161.       s_axi_arready <= 1'b0;


  164.   // Read Address Latch
  165.   always @(posedge aclk)
  166.     if (!aresetn)
  167.       axi_araddr  <= {c_addr_w{1'b0}};
  168.     else if (s_axi_arvalid && !s_axi_arready)
  169.       axi_araddr <= s_axi_araddr[c_addr_w - 1 : $clog2(c_data_w/8)];


  172.   // Read Response
  173.   always @(posedge aclk)
  174.     if (!aresetn) begin
  175.       s_axi_rvalid <= 1'b0;
  176.       s_axi_rresp  <= 2'b00;
  177.     end else if (s_axi_arvalid && s_axi_arready && !s_axi_rvalid) begin
  178.       s_axi_rvalid <= 1'b1;
  179.       s_axi_rresp  <= 2'b00;
  180.     end else if (s_axi_rvalid && s_axi_rready)
  181.       s_axi_rvalid <= 1'b0;


  184.   // Read Data
  185.   always @(posedge aclk)
  186.     if (!aresetn)
  187.       s_axi_rdata <= {c_data_w{1'b0}};
  188.     else if (s_axi_arvalid && s_axi_arready && !s_axi_rvalid)
  189.       s_axi_rdata <= registers_rd[axi_araddr];


  192.   // Read Register Constants
  193.   genvar j;
  194.   generate
  195.     for (j = 0; j <= no_regs - 1; j = j + 1) begin
  196.       if      (j <= id_description_hi) assign registers_rd[j] = id_description[32*(j-id_description_lo) +: 32];
  197.       else if (j <= id_company_hi    ) assign registers_rd[j] = id_company    [32*(j-id_company_lo    ) +: 32];
  198.       else if (j <= id_author_hi     ) assign registers_rd[j] = id_author     [32*(j-id_author_lo     ) +: 32];
  199.       else if (j <= id_version_hi    ) assign registers_rd[j] = id_version    [32*(j-id_version_lo    ) +: 32];
  200.       else if (j <= id_timestamp_hi  ) assign registers_rd[j] = id_timestamp  [32*(j-id_timestamp_lo  ) +: 32];
  201.       else                             assign registers_rd[j] = 32'h00000000;
  202.     end
  203.   endgenerate


  206. endmodule

5. Open block design

Open the existing block design by clicking on Open Block Design under IP INTEGRATOR. Get a better view of the Block Design by clicking on its Float Missing Image! icon. Missing Image!

6. Re-customize AXI GPIO

Double click on the AXI GPIO module to begin re-customization. Change the Default Output Value of GPIO to 0x00000082 so the updated PL design is easily identifiable from the previous one. Click OK to commit the changes. Missing Image!

7. Add peripheral to block design

Add the newly created peripheral to the Block Design by dragging it from Sources and dropping it in Diagram. Note the reason Verilog is being used for this and not System Verilog is because this operation is currently not supported for System Verilog. Missing Image! Connect the Register Bank to the rest of the system by clicking on Run Connection Automation.

In the Run Connection Automation dialog tick All Automation and click OK to proceed. Missing Image! Make the ID signals external to the Block Design by highlighting them and selecting Make External from the right mouse context menu. Note the reason signals are being used and not parameters is because passing parameters into a Block Design is currently not supported. Missing Image! Rename the external signals to remove the _0 from their names. Missing Image! Verify the block design is error free by clicking on the Validate Design Missing Image! icon. All being well the Validation successful dialog should now appear.

8. Edit address map

Check the address map assignment inside the Address Editor under the BLOCK DESIGN section. The axi_identification_0 module should have a Master Base Address of 0x43C1_0000 and a range of 64K. Change these to 0x4000_0000 and 4K respectively. The product identification will now reside at the very start of the PL address space. Missing Image! Save the Block Design.

9. Create, move & modify HDL wrapper

The HDL wrapper must now be hand edited so the ID information can be provided using parameters, this means the wrapper can no longer be managed automatically by Vivado.

Create an updated wrapper to include the new ID signals by right clicking on the system_i block design inside Sources and selecting Create HDL Wrapper... from the context menu.

In the Create HDL Wrapper dialog select Copy generated wrapper to allow user edits and then click OK. Missing Image! Copy the generated wrapper into the user area outside of Vivado and rename it such that it becomes a System Verilog source.
steve@Linux-Steve:/home/steve/projects/leds_switches/fw$ cp project.srcs/sources_1/imports/hdl/system_wrapper.v ../usr/hdl/system_wrapper.sv
Remove the generated wrapper from Vivado by right clicking on system_wrapper inside Sources and selecting Remove File from Project... from the context menu.

In the Remove Sources dialog select Also delete the project local file/directory from disk and then click OK to continue. Missing Image! Add system_wrapper.sv back into the project from its new location /home/steve/projects/leds_switches/usr/hdl.

Edit the wrapper file as follows:- The resulting source should look similar to the following...

system_wrapper.sv

  1. //
  2. // File .......... system_wrapper.sv
  3. // Author ........ Steve Haywood
  4. // Version ....... 1.0
  5. // Date .......... 6 December 2021
  6. // Standard ...... IEEE 1800-2017
  7. // Description ...
  8. //   Top level wrapper for the underlying block design.
  9. //


  12. timeunit      1ns;
  13. timeprecision 1ps;


  16. module system_wrapper #
  17. (
  18.   // Parameters
  19.   parameter string id_description = "",  // P:Firmware Description ... Max 128 Characters
  20.   parameter string id_company     = "",  // P:Company ................ Max  64 Characters
  21.   parameter string id_author      = "",  // P:Author ................. Max  64 Characters
  22.   parameter string id_version     = "",  // P:Version Number ......... Max  16 Characters
  23.   parameter string id_timestamp   = ""   // P:Build Timestamp ........ Max  32 Characters
  24. )
  25. (
  26.   // LEDs
  27.   output [ 7:0] leds_tri_o,         // O:LEDs
  28.   // Switches
  29.   input  [ 7:0] switches_tri_i,     // I:Switches
  30.   // System
  31.   inout  [14:0] DDR_addr,           // B:Address
  32.   inout  [ 2:0] DDR_ba,             // B:Bank Address
  33.   inout         DDR_cas_n,          // B:Column Address Select
  34.   inout         DDR_ck_n,           // B:Clock (Neg)
  35.   inout         DDR_ck_p,           // B:Clock (Pos)
  36.   inout         DDR_cke,            // B:Clock Enable
  37.   inout         DDR_cs_n,           // B:Chip Select
  38.   inout  [ 3:0] DDR_dm,             // B:Data Mask
  39.   inout  [31:0] DDR_dq,             // B:Data Input/Output
  40.   inout  [ 3:0] DDR_dqs_n,          // B:Data Strobe (Neg)
  41.   inout  [ 3:0] DDR_dqs_p,          // B:Data Strobe (Pos)
  42.   inout         DDR_odt,            // B:Output Dynamic Termination
  43.   inout         DDR_ras_n,          // B:Row Address Select
  44.   inout         DDR_reset_n,        // B:Reset
  45.   inout         DDR_we_n,           // B:Write Enable
  46.   inout         FIXED_IO_ddr_vrn,   // B:Termination Voltage
  47.   inout         FIXED_IO_ddr_vrp,   // B:Termination Voltage
  48.   inout  [53:0] FIXED_IO_mio,       // B:Peripheral Input/Output
  49.   inout         FIXED_IO_ps_clk,    // B:System Reference Clock
  50.   inout         FIXED_IO_ps_porb,   // B:Power On Reset
  51.   inout         FIXED_IO_ps_srstb   // B:External System Reset
  52. );


  55.   // Function to convert a string to a vector (max 128 characters)
  56.   function [1023:0] fmt(input string str);
  57.     int len;
  58.     bit [1023:0] tmp;
  59.     len = str.len();
  60.     for (int i=0; i<len; i++)
  61.       tmp[8*i +: 8] = str.getc(i);
  62.     fmt = tmp;
  63.   endfunction


  66.   // Top-Level Block Design
  67.   system system_i
  68.    (
  69.     // Identification Strings
  70.     .id_description    ( fmt(id_description) ),  // P:Firmware Description
  71.     .id_company        ( fmt(id_company)     ),  // P:Company
  72.     .id_author         ( fmt(id_author)      ),  // P:Author
  73.     .id_version        ( fmt(id_version)     ),  // P:Version Number
  74.     .id_timestamp      ( fmt(id_timestamp)   ),  // P:Build Timestamp
  75.     // LEDs
  76.     .leds_tri_o        ( leds_tri_o          ),  // O:LEDs
  77.     // Switches
  78.     .switches_tri_i    ( switches_tri_i      ),  // I:Switches
  79.     // System
  80.     .DDR_addr          ( DDR_addr            ),  // B:Address
  81.     .DDR_ba            ( DDR_ba              ),  // B:Bank Address
  82.     .DDR_cas_n         ( DDR_cas_n           ),  // B:Column Address Select
  83.     .DDR_ck_n          ( DDR_ck_n            ),  // B:Clock (Neg)
  84.     .DDR_ck_p          ( DDR_ck_p            ),  // B:Clock (Pos)
  85.     .DDR_cke           ( DDR_cke             ),  // B:Clock Enable
  86.     .DDR_cs_n          ( DDR_cs_n            ),  // B:Chip Select
  87.     .DDR_dm            ( DDR_dm              ),  // B:Data Mask
  88.     .DDR_dq            ( DDR_dq              ),  // B:Data Input/Output
  89.     .DDR_dqs_n         ( DDR_dqs_n           ),  // B:Data Strobe (Neg)
  90.     .DDR_dqs_p         ( DDR_dqs_p           ),  // B:Data Strobe (Pos)
  91.     .DDR_odt           ( DDR_odt             ),  // B:Output Dynamic Termination
  92.     .DDR_ras_n         ( DDR_ras_n           ),  // B:Row Address Select
  93.     .DDR_reset_n       ( DDR_reset_n         ),  // B:Reset
  94.     .DDR_we_n          ( DDR_we_n            ),  // B:Write Enable
  95.     .FIXED_IO_ddr_vrn  ( FIXED_IO_ddr_vrn    ),  // B:Termination Voltage
  96.     .FIXED_IO_ddr_vrp  ( FIXED_IO_ddr_vrp    ),  // B:Termination Voltage
  97.     .FIXED_IO_mio      ( FIXED_IO_mio        ),  // B:Peripheral Input/Output
  98.     .FIXED_IO_ps_clk   ( FIXED_IO_ps_clk     ),  // B:System Reference Clock
  99.     .FIXED_IO_ps_porb  ( FIXED_IO_ps_porb    ),  // B:Power On Reset
  100.     .FIXED_IO_ps_srstb ( FIXED_IO_ps_srstb   )   // B:External System Reset
  101.    );


  104. endmodule

10. Create build hook scripts

To pass textural information into the parameters of system_wrapper.sv a pre-synthesis TCL script can be used. Versioning and timestamping can also be achieved using this script. Care must be taken when a build fails and a bitstream isn't generated not to leave a version/revision missing from the build history. A post-bitstream TCL script can be used to assist with the missing version/revision problem. Note there are very many ways to achieve versioning with fallback, most of which are dependant on how revision control is used with the build process and committing of source & bitstream. The approach used here shall be a product identification file containing information pertinent to a successfully created bitstream. After a successful build the product identification file along with the new bitstream could be committed into revision control. If source is committed into revision control prior to a build being undertaken a tag from the commit could be included in the product identification file & bitstream to link the build back to the version of the source used to create it.

Create an initial product identification file and edit it to include the product information fields. Note the version will be incremented during the build process so this is set to 0.0 initially ready for it becoming 1.0. The timestamp will be overwritten so this can be set to anything.
steve@Linux-Steve:/home/steve/projects/leds_switches/fw$ subl project.txt

project.txt

  1. Zedboard LEDs & Switches Example Design
  2. SpaceWire UK
  3. Steve Haywood
  4. 0.0
  5. 00-Xxx-0000 - 00:00:00

Create pre-synthesis & post-bitstream TCL scripts and edit to include the required code.
steve@Linux-Steve:/home/steve/projects/leds_switches/fw$ subl {pre_synth.tcl,post_bit.tcl}

pre_synth.tcl

  1. #
  2. # File .......... pre_synth.tcl
  3. # Author ........ Steve Haywood
  4. # Version ....... 1.0
  5. # Date .......... 24 October 2021
  6. # Description ...
  7. #   Script to read product/project information from a text file, increase
  8. # the version/revision, get current timestamp and set the generics/parameters
  9. # on the top level module.
  10. #

  12. # Read Product/Project Information
  13. set id_file [open "../../project.txt" r]
  14. gets $id_file id_description
  15. gets $id_file id_company
  16. gets $id_file id_author
  17. gets $id_file id_version
  18. gets $id_file id_timestamp
  19. close $id_file

  21. # Increase Version
  22. set id_version [expr $id_version+1]

  24. # Increase Revision
  25. #set id_version [expr $id_version+0.1]

  27. # Get Timestamp
  28. set id_timestamp "[clock format [clock seconds] -format {%d-%b-%Y - %H:%M:%S}]"

  30. # Write New Product/Project Information
  31. set id_file [open "../../project_new.txt" w]
  32. puts $id_file $id_description
  33. puts $id_file $id_company
  34. puts $id_file $id_author
  35. puts $id_file $id_version
  36. puts $id_file $id_timestamp
  37. close $id_file

  39. # Replace space character with its octal code
  40. proc space_replace {str} {
  41.   return [string map {" " "\\040"} $str]
  42. }

  44. # Replace spaces in information strings
  45. set id_description [space_replace $id_description]
  46. set id_company     [space_replace $id_company]
  47. set id_author      [space_replace $id_author]
  48. set id_version     [space_replace $id_version]
  49. set id_timestamp   [space_replace $id_timestamp]

  51. # Set Generics/Parameters
  52. set_property generic " \
  53.   id_description=\"$id_description\" \
  54.   id_company=\"$id_company\" \
  55.   id_author=\"$id_author\" \
  56.   id_version=\"$id_version\" \
  57.   id_timestamp=\"$id_timestamp\" \
  58. " [current_fileset]

post_bit.tcl

  1. #
  2. # File .......... post_bit.tcl
  3. # Author ........ Steve Haywood
  4. # Version ....... 1.0
  5. # Date .......... 24 October 2021
  6. # Description ...
  7. #   Script to replace 'project.txt' (Information about last version of firmware)
  8. # with 'project_new.txt' (Information about new version of firmware). The file
  9. # replace only occurs if the bitstream was generated successfully.
  10. #


  13. file delete ../../project.txt
  14. file rename ../../project_new.txt ../../project.txt

Add the pre-synthesis & post-bitstream hooks into Vivado's build process by navigating Tools » Settings....

In the Settings dialog select Synthesis under Project Settings and click the ... button across from tcl.pre to select the pre-synthesis file. Missing Image! In the Select A Tcl Script dialog select New script and set this to /home/steve/projects/leds_switches/fw/pre_synth.tcl. Click OK to continue. Missing Image! In the Settings dialog select Bitstream under Project Settings and click the ... button across from tcl.post to select the post-bitstream file. Missing Image! In the Select A Tcl Script dialog select New script and set this to /home/steve/projects/leds_switches/fw/post_bit.tcl. Click OK to continue. Missing Image!

11. Generate bitstream

Generate the programmable logic bitstream by clicking on Generate Bitstream under the PROGRAM AND DEBUG heading inside the Flow Navigator section. Missing Image!

12. Export hardware platform

Export the hardware platform by selecting File » Export » Export Hardware... from the main menu. Include the bitstream in the exported hardware file and save as /home/steve/projects/leds_switches/fw/system_wrapper.xsa.

13. Create peek string C application

Using peek.c as a starting point create a new C application to perform the reading of a string from the PL address space.
steve@Linux-Steve:/home/steve/projects/leds_switches/fw$ cd ../../petalinux
steve@Linux-Steve:/home/steve/projects/petalinux$ subl project-spec/meta-user/recipes-apps/peekpokecgi/files/peekstring.c
Something similar to the following should do the trick.

peekstring.c

  1. //
  2. // File .......... peekstring.c
  3. // Author ........ Steve Haywood
  4. // Version ....... 1.0
  5. // Date .......... 29 October 2021
  6. // Description ...
  7. //   CGI type module to read a string from memory and return it.
  8. // Usage ...
  9. //   http://<web address>/cgi-bin/peekstring?base&size&offset&maxchars
  10. // base = Base address of memory region to be used
  11. // size = Size of memory region to be used
  12. // offset = Offset address of string within memory region
  13. // maxchars = Maximum length of return string
  14. //


  17. #include <stdio.h>
  18. #include <string.h>
  19. #include <stdlib.h>
  20. #include <fcntl.h>
  21. #include <sys/mman.h>
  22. #include <stdint.h>
  23. #include <unistd.h>


  26. int main()
  27. {
  28.   int fd;              // File descriptor for mapped memory
  29.   char *map;           // Pointer to mapped memory
  30.   uint32_t base;       // Start address of area to map
  31.   uint32_t size;       // Size of area to map
  32.   uint32_t addr;       // Address within area to access
  33.   uint32_t length;     // Maximum length of string to return
  34.   char *ptr;           // Pointer to character of string
  35.   char *querystring;   // Pointer to QUERY_STRING
  36.   char *rest;          // Pointer to next token within QUERY_STRING
  37.   char *token;         // Pointer to extracted token
  38.   char *endptr = NULL; // Pointer to end of string in str2int conversion
  39.   uint32_t count = 0;  // Number of character output from string

  41.   printf("Content-Type: text/plain;charset=us-ascii\n\n");

  43.   querystring = getenv("QUERY_STRING");
  44.   if (querystring)
  45.   {
  46.     rest = querystring;
  47.     token = strtok_r(rest, "&", &rest);
  48.     if (token != NULL) {
  49.       base = strtoul(token, &endptr, 0);
  50.       if (token != endptr) {
  51.         token = strtok_r(rest, "&", &rest);
  52.         if (token != NULL) {
  53.           size = strtoul(token, &endptr, 0);
  54.           if (token != endptr) {
  55.             token = strtok_r(rest, "&", &rest);
  56.             if (token != NULL) {
  57.               addr = strtoul(token, &endptr, 0);
  58.               if (token != endptr) {
  59.                 token = strtok_r(rest, "&", &rest);
  60.                 if (token != NULL) {
  61.                   length = strtoul(token, &endptr, 0);
  62.                   if (token != endptr) {
  63.                     fd = open( "/dev/mem", O_RDWR);
  64.                     if (fd > 0) {
  65.                       map = mmap(NULL, size, (PROT_READ | PROT_WRITE), MAP_SHARED, fd, base);
  66.                       if (map != MAP_FAILED) {
  67.                         ptr = (char *)(map + addr);
  68.                         while (*ptr != '\0' && count < length) {
  69.                           printf("%c", *ptr);
  70.                           ptr++;
  71.                           count++;
  72.                         }
  73.                         munmap(map, size);
  74.                       } else printf("Error: Memory to mmap");
  75.                       close(fd);
  76.                     } else printf("Error: Failed to open /dev/mem");
  77.                   } else printf("Error: Invalid string length");
  78.                 } else printf("Error: Missing string length");
  79.               } else printf("Error: Invalid string offset address");
  80.             } else printf("Error: Missing string offset address");
  81.           } else printf("Error: Invalid memory map size");
  82.         } else printf("Error: Missing memory map size");
  83.       } else printf("Error: Invalid memory map base address");
  84.     } else printf("Error: Missing memory map base address");
  85.   } else printf("Error: No QUERY_STRING");
  86. }

Modify the Makefile to include the peekstring application.
steve@Linux-Steve:/home/steve/projects/petalinux$ subl project-spec/meta-user/recipes-apps/peekpokecgi/files/Makefile

Makefile

  1. PEEK = peek
  2. POKE = poke
  3. PEEKSTRING = peekstring

  5. # Add any other object files to this list below
  6. PEEK_OBJS = peek.o
  7. POKE_OBJS = poke.o
  8. PEEKSTRING_OBJS = peekstring.o

  10. all: $(PEEK) $(POKE) $(PEEKSTRING)

  12. $(PEEKSTRING): $(PEEKSTRING_OBJS)
  13. $(CC) $(LDFLAGS) -o $@ $(PEEKSTRING_OBJS) $(LDLIBS)

  15. $(POKE): $(POKE_OBJS)
  16. $(CC) $(LDFLAGS) -o $@ $(POKE_OBJS) $(LDLIBS)

  18. $(PEEK): $(PEEK_OBJS)
  19. $(CC) $(LDFLAGS) -o $@ $(PEEK_OBJS) $(LDLIBS)

  21. clean:
  22. -rm -f $(PEEKSTRING) $(POKE) $(PEEK) *.elf *.gdb *.o

Modify the BitBake recipe to include the peekstring application.
steve@Linux-Steve:/home/steve/projects/petalinux$ subl project-spec/meta-user/recipes-apps/peekpokecgi/peekpokecgi.bb

peekpokecgi.bb

  1. #
  2. # This is the peekpokecgi aplication recipe
  3. #
  4. #

  6. SUMMARY = "peekpokecgi application"
  7. SECTION = "PETALINUX/apps"
  8. LICENSE = "MIT"
  9. LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302"
  10. SRC_URI = "file://peek.c \
  11.            file://poke.c \
  12.            file://peekstring.c \
  13.            file://Makefile \
  14.           "
  15. FILES_${PN} += "/srv/www/cgi-bin"
  16. S = "${WORKDIR}"
  17. CFLAGS_prepend = "-I ${S}/include"
  18. do_compile() {
  19.         oe_runmake
  20. }
  21. do_install() {
  22.         install -d ${D}/srv/www/cgi-bin
  23.         install -m 0755 ${S}/peek ${D}/srv/www/cgi-bin
  24.         install -m 0755 ${S}/poke ${D}/srv/www/cgi-bin
  25.         install -m 0755 ${S}/peekstring ${D}/srv/www/cgi-bin
  26. }


14. Update website to display ID strings

Edit the existing HTML to have a Product Identification section, this will include a table of information and an update button that calls a Javascript function to perform the webpage update. Lines 33-62 illustrate the potential code required.
steve@Linux-Steve:/home/steve/projects/petalinux$ subl project-spec/meta-user/recipes-apps/website/files/cgi-bin/index.cgi

index.cgi

  1. #!/bin/sh

  3. # Output Header
  4. printf "Content-type: text/html\n\n"

  6. # Get information
  7. sys_host=$(hostname)
  8. sys_time=$(date)
  9. sys_load=$(awk '{print $1}' /proc/loadavg)
  10. sys_up=$(awk '{print $1}' /proc/uptime)
  11. cpu_model=$(grep model /proc/cpuinfo | cut -d : -f2 | tail -1 | sed 's/\s//')
  12. cpu_cores=$(grep -c ^processor /proc/cpuinfo)
  13. mem_total=$(free -m | awk 'NR==2{print $2}')
  14. mem_used=$(free -m | awk 'NR==2{print $3}')
  15. mem_free=$(free -m | awk 'NR==2{print $4}')
  16. net_mac=$(cat /sys/class/net/eth0/address)
  17. net_ip_loc=$(ip a | grep inet | grep -vw lo | grep -v inet6 | cut -d \/ -f1 | sed 's/[^0-9\.]*//g')
  18. net_ip_ext=$(wget -q -O- http://ipecho.net/plain)

  20. # Output HTML
  21. cat <<EOF
  22. <!DOCTYPE html>
  23. <html lang="en">
  24. <head>
  25. <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  26. <link href="../styles.css" rel="stylesheet">
  27. <title>Zedboard Webserver</title>
  28. </head>
  29. <body onload="add_register()">

  31. <div class="section"><h2>Zedboard Webserver</h2></div>

  33. <div class="section">
  34. <table>
  35. <thead>
  36. <tr><th colspan="2">Firmware Product Information (Read from Firmware) <input type="submit" value="Read ID" id="read_ids" onclick="read_ids()"></th>
  37. </tr>
  38. </thead>
  39. <tbody>
  40. <tr>
  41. <td style="text-align:right">Description :</td>
  42. <td style="text-align:left" id="id_0">Unknown</td>
  43. </tr>
  44. <tr>
  45. <td style="text-align:right">Company :</td>
  46. <td style="text-align:left" id="id_1">Unknown</td>
  47. </tr>
  48. <tr>
  49. <td style="text-align:right">Author :</td>
  50. <td style="text-align:left" id="id_2">Unknown</td>
  51. </tr>
  52. <tr>
  53. <td style="text-align:right">Build Version :</td>
  54. <td style="text-align:left" id="id_3">Unknown</td>
  55. </tr>
  56. <tr>
  57. <td style="text-align:right">Build Timestamp :</td>
  58. <td style="text-align:left" id="id_4">Unknown</td>
  59. </tr>
  60. </tbody>
  61. </table>
  62. </div>

  64. <div class="section"><img src="../zedboard.png" alt="Missing Image!"></div>

  66. <div class="section">

  68. <table>
  69. <tr><th colspan="2">System</th></tr>
  70. <tr><td>Hostname</td>
  71. <td>${sys_host}</td>
  72. </tr><tr><td>Time</td><td>${sys_time}</td></tr>
  73. <tr><td>Uptime</td><td><span id="uptime_text">${sys_up}</span> seconds <button onclick="get_uptime()">Refresh</button> Auto :
  74. <select id="uptime" onchange="uptime();">
  75.   <option value="0">Off</option>
  76.   <option value="1">1s</option>
  77.   <option value="5">5s</option>
  78. </select>
  79. </td></tr>
  80. </table>

  82. <table>
  83. <tr><th colspan="2">CPU</th></tr>
  84. <tr><td>Model</td>
  85. <td>${cpu_model}</td></tr>
  86. <tr><td>Cores</td><td>${cpu_cores}</td></tr>
  87. <tr><td>Load</td><td>${sys_load}</td></tr>
  88. </table>

  90. <table>
  91. <tr><th colspan="2">Memory</th></tr>
  92. <tr><td>Total</td><td>${mem_total} Mb</td></tr>
  93. <tr><td>Used</td><td>${mem_used} Mb</td></tr>
  94. <tr><td>Free</td><td>${mem_free} Mb</td></tr>
  95. </table>

  97. <table>
  98. <tr><th colspan="2">Network</th></tr>
  99. <tr><td>MAC Address</td><td>${net_mac}</td></tr>
  100. <tr><td>Internal IP</td><td>${net_ip_loc}</td></tr>
  101. <tr><td>External IP</td><td>${net_ip_ext}</td></tr>
  102. </table>

  104. </div>

  106. <div class="section">
  107. <table id="registers">
  108. <tr>
  109. <th>Address</th>
  110. <th>Peek Value</th>
  111. <th>Peek</th>
  112. <th>Status</th>
  113. <th>Copy</th>
  114. <th>Poke Value</th>
  115. <th>Poke</th>
  116. <th>Status</th>
  117. <th>Description</th>
  118. </tr>
  119. </table>
  120. <br><br>
  121. <input title="Add new address at end of table" type="button" value="Add" onclick="add_register()">
  122. <input title="Remove last address from table" type="button" value="Remove" onclick="rem_register()">
  123. <input title="Peek all addresses in table" type="button" value="Peek All" onclick="peek_all()">
  124. <input title="Copy all table peek values into poke values" type="button" value="Copy All" onclick="copy_all()">
  125. <input title="Poke all addresses in table" type="button" value="Poke All" onclick="poke_all()">
  126. Peek Refresh :
  127. <select title="Set timer interval for automatic peek of table addresses" id="timer" onchange="timer()">
  128.   <option value="0">Off</option>
  129.   <option value="1">1s</option>
  130.   <option value="5">5s</option>
  131. </select>
  132. Number Format :
  133. <select title="Set number format for peek and poke values" id="format" onchange="format()">
  134.   <option value="0">Hexadecimal</option>
  135.   <option value="1">Unsigned</option>
  136. </select>
  137. Configuration :
  138. <button title="Create configuration file from table" onclick="create_config()">Create...</button> <a title="Right click and Save Link As... to locate and rename this file" download="config.txt" id="download" href="" style="display: none">config.txt</a>
  139. <input title="Read configuration file into table" type="file" id="load_config">
  140. </div>

  142. <div class="section">Designed by Steve Haywood @ 2021</div>

  144. <script src="../uptime.js"></script>

  146. </body>
  147. </html>
  148. EOF

15. Update Javascript to peek ID strings

Edit the existing Javascript to add the functions required to support reading strings from the PL address space and dynamically updating the the webpage accordingly. Lines 5-32 illustrate the potential code required.
steve@Linux-Steve:/home/steve/projects/petalinux$ subl project-spec/meta-user/recipes-apps/website/files/uptime.js

uptime.js

  1. // Requests
  2. var timer_uptime;
  3. var timer_peek_all;

  5. // Peek all strings
  6. function read_ids() {
  7.   read_id(0x000, 0);
  8.   read_id(0x080, 1);
  9.   read_id(0x0C0, 2);
  10.   read_id(0x100, 3);
  11.   read_id(0x110, 4);
  12. }

  14. // Peek string & display result
  15. function read_id(offset, reg) {
  16.   var url = "/cgi-bin/peekstring?0x40000000&4096&" + offset + "&128";
  17.   if (window.XMLHttpRequest) {
  18.     var ajaxReq = new XMLHttpRequest();
  19.     ajaxReq.onreadystatechange = function() {
  20.       if (ajaxReq.readyState == 4 && ajaxReq.status == 200) {
  21.         var respText = ajaxReq.responseText;
  22.         if (respText.substr(0,6) == "Error:") {
  23.           alert("Error!");
  24.         } else {
  25.           document.getElementById("id_" + reg).innerHTML = respText;
  26.         }
  27.       }
  28.     }
  29.     ajaxReq.open("POST", url, true);
  30.     ajaxReq.send(null);
  31.   }
  32. }

  34. // Get uptime
  35. function get_uptime(reg) {
  36.   var url = "cgi-bin/uptime.cgi";
  37.   if (window.XMLHttpRequest) {
  38.     var ajaxReq = new XMLHttpRequest();
  39.     ajaxReq.onreadystatechange = function() {
  40.       if (ajaxReq.readyState == 4 && ajaxReq.status == 200) {
  41.         var respText = ajaxReq.responseText;
  42.         txtObj = document.getElementById("uptime_text");
  43.         if (txtObj) {
  44.           txtObj.innerHTML = respText;
  45.         }
  46.       }
  47.     }
  48.     ajaxReq.open("POST", url, true);
  49.     ajaxReq.send(null);
  50.   }
  51. }

  53. // Update uptime timer
  54. function uptime() {
  55.   clearInterval(timer_uptime);
  56.   var uptime = document.getElementById("uptime");
  57.   var interval = uptime.value;
  58.   if (interval > 0) {
  59.     timer_uptime = setInterval("get_uptime()", 1000 * interval);
  60.   }
  61. }

  63. // Update peek_all timer
  64. function timer() {
  65.   clearInterval(timer_peek_all);
  66.   var timer = document.getElementById("timer");
  67.   interval = timer.value;
  68.   if (interval > 0) {
  69.     timer_peek_all = setInterval("peek_all()", 1000 * interval);
  70.   }
  71. }

  73. // Update number format
  74. function format() {
  75.   var table = document.getElementById("registers");
  76.   var rows = table.rows.length;
  77.   var peek;
  78.   var poke;
  79.   for (var index = 0; index < rows; index++) {
  80.     peek = document.getElementById("peek_" + index);
  81.     if (peek) {
  82.       peek.value = fmtUnsignedLong(parseInt(peek.value));
  83.     }
  84.     poke = document.getElementById("poke_" + index);
  85.     if (poke) {
  86.       poke.value = fmtUnsignedLong(parseInt(poke.value));
  87.     }
  88.   }
  89. }

  91. // Convert unsigned long to dec/hex string
  92. function fmtUnsignedLong(value) {
  93.   var format = document.getElementById("format");
  94.   var hexStr;
  95.   if (format.value == 0) {
  96.     hexStr = value.toString(16).toUpperCase();
  97.     hexStr = "0x" + "00000000".substr(0, 8 - hexStr.length) + hexStr;
  98.   } else {
  99.     hexStr = value.toString(10);
  100.   }
  101.   return hexStr;
  102. }

  104. // Copy peek to poke
  105. function copy(reg) {
  106.   var peek = document.getElementById("peek_" + reg);
  107.   if (peek) {
  108.     var poke = document.getElementById("poke_" + reg);
  109.     if (poke) {
  110.       poke.value = peek.value;
  111.     }
  112.   }
  113. }

  115. // Copy all peek to poke
  116. function copy_all() {
  117.   var table = document.getElementById("registers");
  118.   var rows = table.rows.length - 1;
  119.   for (var index = 0; index < rows; index++) {
  120.     copy(index);
  121.   }
  122. }

  124. // Peek all addresses
  125. function peek_all() {
  126.   var table = document.getElementById("registers");
  127.   var rows = table.rows.length - 1;
  128.   for (var index = 0; index < rows; index++) {
  129.     peek(index);
  130.   }
  131. }

  133. // Poke all addresses
  134. function poke_all() {
  135.   var table = document.getElementById("registers");
  136.   var rows = table.rows.length - 1;
  137.   for (var index = 0; index < rows; index++) {
  138.     poke(index);
  139.   }
  140. }

  142. // Add row to table
  143. function add_register(reg) {
  144.   var table = document.getElementById("registers");
  145.   var next = table.rows.length - 1;
  146.   var row = table.insertRow(-1);
  147.   var newcell;
  148.   var addr = 0x41200000;
  149.   if (next > 0) {
  150.     addr = parseInt(document.getElementById("addr_" + (next - 1)).value) + 4;
  151.   }
  152.   newcell = row.insertCell(0);
  153.   newcell.innerHTML = '<input type="text" id="addr_' + next + '" value="' + fmtUnsignedLong(addr) + '" size="10">';
  154.   newcell = row.insertCell(1);
  155.   newcell.innerHTML = '<input type="text" id="peek_' + next + '" value="0x00000000" size="10" readonly="readonly"></td>';
  156.   newcell = row.insertCell(2);
  157.   newcell.innerHTML = '<input type="submit" value="Peek" onclick="peek(' + next + ')">';
  158.   newcell = row.insertCell(3);
  159.   newcell.innerHTML = '<span id="speek_' + next + '">-</span>';
  160.   newcell = row.insertCell(4);
  161.   newcell.innerHTML = '<input type="submit" value=">>" onclick="copy(' + next + ')">';
  162.   newcell = row.insertCell(5);
  163.   newcell.innerHTML = '<input type="text" id="poke_' + next + '" value="0x00000000" size="10">';
  164.   newcell = row.insertCell(6);
  165.   newcell.innerHTML = '<input type="submit" value="Poke" onclick="poke(' + next + ')">';
  166.   newcell = row.insertCell(7);
  167.   newcell.innerHTML = '<span id="spoke_' + next + '">-</span>';
  168.   newcell = row.insertCell(8);
  169.   newcell.innerHTML = '<input type="text" id="name_' + next + '" value="Register @ ' + fmtUnsignedLong(addr) + '" size="40">';
  170. }

  172. // Remove all rows from table
  173. function remove_all() {
  174.   var table = document.getElementById("registers");
  175.   var rows = table.rows.length - 1;
  176.   for (var index = 0; index < rows; index++) {
  177.     table.deleteRow(-1);
  178.   }
  179. }

  181. // Remove row from table
  182. function rem_register(reg) {
  183.   var table = document.getElementById("registers");
  184.   if (table.rows.length > 1) {
  185.     table.deleteRow(-1);
  186.   }
  187. }

  189. // Poke address & display result
  190. function poke(reg) {
  191.   var url = "/cgi-bin/poke?" + document.getElementById("addr_" + reg).value + "&" + document.getElementById("poke_" + reg).value;
  192.   if (window.XMLHttpRequest) {
  193.     var ajaxReq = new XMLHttpRequest();
  194.     ajaxReq.onreadystatechange = function() {
  195.       if (ajaxReq.readyState == 4 && ajaxReq.status == 200) {
  196.         var respText = ajaxReq.responseText;
  197.         if (respText.substr(0,6) == "Error:") {
  198.           document.getElementById("spoke_" + reg).innerHTML = "Failed";
  199.         } else {
  200.           document.getElementById("spoke_" + reg).innerHTML = "Success";
  201.         }
  202.       }
  203.     }
  204.     ajaxReq.open("POST", url, true);
  205.     ajaxReq.send(null);
  206.   }
  207. }

  209. // Peek address & display result
  210. function peek(reg) {
  211.   var url = "/cgi-bin/peek?" + document.getElementById("addr_" + reg).value;
  212.   if (window.XMLHttpRequest) {
  213.     var ajaxReq = new XMLHttpRequest();
  214.     ajaxReq.onreadystatechange = function() {
  215.       if (ajaxReq.readyState == 4 && ajaxReq.status == 200) {
  216.         var respText = ajaxReq.responseText;
  217.         if (respText.substr(0,6) == "Error:") {
  218.           document.getElementById("speek_" + reg).innerHTML = "Failed";
  219.         } else {
  220.           document.getElementById("speek_" + reg).innerHTML = "Success";
  221.           document.getElementById("peek_" + reg).value = fmtUnsignedLong(parseInt(respText));
  222.         }
  223.       }
  224.     }
  225.     ajaxReq.open("POST", url, true);
  226.     ajaxReq.send(null);
  227.   }
  228. }

  230. // Note: browser file access is made difficult for security reasons - there maybe a better way of doing file read & write.

  232. var config_file = null;

  234. // Create virtual configuration file from address table for user to download
  235. function create_config() {
  236.   var text = "";
  237.   var table = document.getElementById("registers");
  238.   var rows = table.rows.length - 1;
  239.   for (var index = 0; index < rows; index++) {
  240.     var addr = document.getElementById("addr_" + index).value;
  241.     var poke = document.getElementById("poke_" + index).value;
  242.     var name = document.getElementById("name_" + index).value;
  243.     text += addr + "|" + poke + "|" + name + "\n";
  244.   }
  245.   const data = new Blob([text], {type: 'text/plain'});
  246.   if (config_file !== null) {
  247.     URL.revokeObjectURL(config_file);
  248.   }
  249.   config_file = URL.createObjectURL(data);
  250.   var link = document.getElementById('download');
  251.   link.href = config_file;
  252.   link.style.display = 'inline';
  253. }

  255. // Read configuration file and update address table
  256. function load_config(input) {
  257.   var file = input.target.files[0];
  258.   if (file) {
  259.     var reader = new FileReader();
  260.     reader.onload = function(input) {
  261.       var contents = input.target.result;
  262.       const lines = contents.split(/\r\n|\n/);
  263.       remove_all();
  264.       lines.forEach((line) => {
  265.         if (line.length > 0) {
  266.           var table = document.getElementById("registers");
  267.           var next = table.rows.length - 1;
  268.           add_register();
  269.           const values = line.split("|");
  270.           document.getElementById("addr_" + next).value = values[0];
  271.           document.getElementById("poke_" + next).value = values[1];
  272.           document.getElementById("name_" + next).value = values[2];
  273.         }
  274.       });
  275.     };
  276.     reader.readAsText(file);
  277.   }
  278. }

  280. document.getElementById('load_config').addEventListener('change', load_config, false);

16. Rebuild PetaLinux to include updates

Rebuild PetaLinux to include the updated FPGA bitstream, the updated peekpokecgi application & the updated website application.
steve@Linux-Steve:/home/steve/projects/petalinux$ petalinux-config --get-hw-description ../leds_switches/fw/system_wrapper.xsa
steve@Linux-Steve:/home/steve/projects/petalinux$ petalinux-build
steve@Linux-Steve:/home/steve/projects/petalinux$ petalinux-package --prebuilt --force

17. Setup Zedboard hardware

If not already, connect up the hardware as follows and power on the Zedboard :-
  1. Xubuntu PC USB ⇄ Zedboard USB JTAG/Debug
  2. Xubuntu PC USB ⇄ Zedboard USB UART
  3. Zedboard Ethernet ⇄ Router
  4. Xubuntu PC Ethenet ⇄ Router
  5. Router ⇄ Internet
Missing Image! Set the boot mode jumpers on the Zedboard for JTAG. Missing Image!

18. Deploy PetaLinux on Zedboard

Deploy the updated PetaLinux image via JTAG.
steve@Linux-Steve:/home/steve/projects/petalinux$ petalinux-boot --jtag --prebuilt 3

19. Check everything is working as expected

All being well the following sequence of events should be observed, pay particular attention to point 2.
  1. The blue done LED illuminates indicating the Programmable Logic (PL) has been programmed.
  2. LED 7 and 1 illuminate indicating the bitstream from the updated leds_switches project is in use.
  3. The software runs on the Processor System (PS).
  4. PetaLinux starts to boot.
  5. The led-runner application launches and executes the expanding & contracting LED illumination sequence.
  6. The PetaLinux login prompt appears in the terminal emulator.
Using a web browser access the Zedboard Webserver at 192.168.2.77 and click the Read ID button to read the Identification information from the PL address space. Use the Browse... button to select the previously saved configuration file (leds_switched.txt). Poke the Register @ 0x0, Poke the Register @ 0x8 and then Peek All the registers. All being well the webpage should look similar to the following... Missing Image!

20. Files for revision control

The following files/directories are the new ones to add to the repository.
Copyright © 2004-2021 SpaceWire UK. All rights reserved.