libpynq (release 5EWC0-2023 version 0.2.3 of 2023-10-06 18:15)
Loading...
Searching...
No Matches
Versioning library

Data Structures

struct  version_t
 

Functions

void print_version (void)
 
void check_version (void)
 

Variables

const version_t libpynq_version
 

Detailed Description

Typedef and functions to check the version and compatibility of the libpynq library and the FPGA bitstream.

Semantic versioning (https://semver.org) is used. Given a version number MAJOR.MINOR.PATCH, increment the:

When the libpynq library version and the FPGA bitstream version are not the same:

Function Documentation

◆ check_version()

void check_version ( void  )

Check the version of the hardware (bitstream) and the libpynq library. Called by e.g. the switchbox but can also be called in user code.

Warning
Fails with program exit when versions are incompatible.

Definition at line 68 of file version.c.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ print_version()

void print_version ( void  )

Print the version of the hardware (bitstream) and the libpynq library.

Prints INFO message when minor/patch versions are different.

Definition at line 44 of file version.c.

Here is the call graph for this function:
Here is the caller graph for this function:

Variable Documentation

◆ libpynq_version

const version_t libpynq_version
extern

Constant containing the version of this the libpynq library.

Definition at line 34 of file version.c.