Versions Compared

Old Version 9

changes.mady.by.user navam

Saved on

compared with

New Version 10

changes.mady.by.user navam

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • dfx_cfg_init (const char *dfx_package_path, const char *devpath, u32 flags);

Code Block
/* Provide a generic interface to the user to specify the required parameters for PR programming.
 * The calling process must call this API before it performs -load/remove.
 *
 * char *dfx_package_path: The contents of the package folder should look something as below:
 *                                -package: //-package1 
 *                                                                |--> Bit_file
 *                                                                |--> DT_Overlayfile
 *
 *  char *devpath: Unused for now. The dev interface for now is always exposed at /dev/fpga0
 *
 * unsigned long flags: Flags to specify any special instructions for library to perform.
 *                      Unused for now.
 *
 * Return: returns unique package_Id or Error code on failure.
 */
 
 
Usage example:
#include "libdfx.h"
 
 package_id1, package_id2;
 
/* More code */
/* -store /Pre-fetch data */
package_id1 = dfx_cfg_init ("/path/package1/", "/dev/fpga0", flags);
 
/* More code */
 
/* -store /Pre-fetch data */
package_id2 = dfx_cfg_init ("/path/package2/", "/dev/fpga0", flags);
 
/* More code */


fpga-load

  • int dfx_cfg_load ( struct dfx_package_Id *package_Id)

Code Block
/* This API is Responsible for the following things.
 *      -->Load  into the PL
 *      -->Probe the Drivers which are relevant to the Bitstream as per DT overlay mentioned in dfx_package folder)
 *
 *  package_id: Unique package_id value which was returned by dfx_cfg_init.
 *
 * Return: returns zero on success or Error code on failure.
 */
 
 
Usage example:
#include "libfpga.h"
 
/* More code */
 
ret = dfx_cfg_load (package_id);
if (ret)
    return -1
 
/* More code */


Deferred-drivers-load

  • int dfx_cfg_drivers_load(struct dfx_package_Id *package_Id)

Code Block
/* This API is Responsible for the following things.
 *      -->Probe the Drivers which are relevant to the Bitstream as per
 *         DT overlay mentioned in dfx_package folder(With name: *_d.dtbo)
 *
 * package_id: Unique package_id value which was returned by dfx_cfg_init.
 *
 * Return: returns zero on success or Error code on failure.
 */
 
 
Usage example:
#include "libdfx.h"
 
/* More code */
 
ret = dfx_cfg_drivers_load(package_id);
if (ret)
        return -1
 
/* More code */

Remove

  • dfx_cfg_remove (package_Id)

Code Block
/* This API is Responsible for unloading the drivers corresponding to a package
 *    
 *  package_id: Unique package_id value which was returned by dfx_cfg_init.
 *
 * Return: returns zero on success or Error code on failure.
 */
 
 
Usage example:
#include "libdfx.h"
 
 
/* More code */
 
ret = dfx_cfg_remove (package_id);
 if (ret)
    return -1;
/* More code */



Destroy package

  • dfx_cfg_destroy (package_Id)

Code Block
/* This API frees the resources allocated during dfx_cfg_init.
 *    
 *  package_id: Unique package_id value which was returned by dfx_cfg_init.
 *
 * Return: returns zero on success.  On error, -1 is returned.
 */
 
 
Usage example:
#include "libdfx.h"
 
 
/* More code */
 
 ret = dfx_cfg_destroy (package_id); /* Returns zero on success.  On error, -1 is returned */
 if (ret)
    return -1
 
/* More code */
................

To Get PDI image Active UID info list

  • dfx_get_active_uid_list(int *buffer)

Code Block
/* This API populates buffer with {Node ID, Unique ID, Parent Unique ID, Function ID}
 * for each applicable NodeID in the system.
 *
 * buffer: User buffer address
 *
 * Return: Number of bytes read from the firmware in case of success.
 *         or Negative value on failure.
 *
 * Note: The user buffer size should be 768 bytes.
 *
 */

Usage example:
#include "libdfx.h"

/* More code */

 ret = dfx_get_active_uid_list(&buffer);
 if (ret < 0)
        return -1

/* More code */

To Get PDI Image Meta-header info

  • dfx_get_meta_header(char *binfile, int *buffer, int buf_size)

Code Block
/* This API populates buffer with meta-header info related to the user
 * provided binary file (BIN/PDI).
 *
 * binfile: PDI Image.
 * buffer: User buffer address
 * buf_size : User buffer size.
 *
 * Return: Number of bytes read from the firmware in case of success.
 *         or Negative value on failure.
 */

Usage example:
#include "libdfx.h"

/* More code */

  ret = dfx_get_meta_header("/media/binary.bin", &buffer, buf_size);
  if (ret < 0)
	return -1

/* More code */


Example Application flow

Code Block
#include "libfpga.h"
 
int main()
{
 package_id, ret;
 
 
    /* package initialization */
    package_id = dfx_cfg_init(pck1/, /dev/fpga0, 0);
     if (package_id < 0)
         return -1;
                
 
    /* Package load */
    ret = dfx_cfg_load(package_id);
    if (ret)
        return -1;
 
    /* Remove package */
    ret = dfx_cfg_remove(package_id);
    if (ret)
        return -1;
 
    /* Destroy package */
    ret = dfx_cfg_destroy(package_id);
 
    return ret;
 
}


Build procedure

Build procedure for  compiling library from source

...

Devicetree Overlay file contents example: For Only PDI/BIN/BIT configuration

Code Block
/dts-v1/;
/plugin/;
/ {
        fragment@0 {
                target = <&fpga>;
                overlay0: __overlay__ {
                        firmware-name = "partial_1.pdi";
                        partial-fpga-config;                       
                };
        };
};


PL drivers probing ( For Deferred Probe)

Code Block
/dts-v1/;
/plugin/;
/ {
        fragment@0 {
                target = <&amba>;
                __overlay__ {
                        axi_gpio_0: gpio@a0000000 {
                                #gpio-cells = <3>;
                                clock-names = "s_axi_aclk";
                                clocks = <&zynqmp_clk 71>;
                                compatible = "xlnx,axi-gpio-2.0", "xlnx,xps-gpio-1.00.a";
                                gpio-controller ;
                                reg = <0x0 0xa0000000 0x0 0x1000>;
                                xlnx,all-inputs = <0x0>;
                                xlnx,all-inputs-2 = <0x0>;
                                xlnx,all-outputs = <0x1>;
                                xlnx,all-outputs-2 = <0x0>;
                                xlnx,dout-default = <0x00000000>;
                                xlnx,dout-default-2 = <0x00000000>;
                                xlnx,gpio-width = <0x8>;
                                xlnx,gpio2-width = <0x20>;
                                xlnx,interrupt-present = <0x0>;
                                xlnx,is-dual = <0x0>;
                                xlnx,tri-default = <0xFFFFFFFF>;
                                xlnx,tri-default-2 = <0xFFFFFFFF>;
                        };
            };
};


Devicetree Overlay file contents example: For PDI configuration + PL drivers probing

Code Block
/dts-v1/;
/plugin/;
/ {
        fragment@0 {
                target = <&fpga>;
                overlay0: __overlay__ {
                        firmware-name = "partial_1.pdi";
                        partial-fpga-config;                       
                };
        fragment@1 {
                target = <&amba>;
                overlay1: __overlay__ {
                        axi_gpio_0: gpio@a0000000 {
                                #gpio-cells = <3>;
                                clock-names = "s_axi_aclk";
                                clocks = <&zynqmp_clk 71>;
                                compatible = "xlnx,axi-gpio-2.0", "xlnx,xps-gpio-1.00.a";
                                gpio-controller ;
                                reg = <0x0 0xa0000000 0x0 0x1000>;
                                xlnx,all-inputs = <0x0>;
                                xlnx,all-inputs-2 = <0x0>;
                                xlnx,all-outputs = <0x1>;
                                xlnx,all-outputs-2 = <0x0>;
                                xlnx,dout-default = <0x00000000>;
                                xlnx,dout-default-2 = <0x00000000>;
                                xlnx,gpio-width = <0x8>;
                                xlnx,gpio2-width = <0x20>;
                                xlnx,interrupt-present = <0x0>;
                                xlnx,is-dual = <0x0>;
                                xlnx,tri-default = <0xFFFFFFFF>;
                                xlnx,tri-default-2 = <0xFFFFFFFF>;
                        };
            };
};

Create Device Tree Overlay Blob (.dtbo) file from .dts file

...