BUG: Drivers not working in Vitis 2024.2

[obruendl]

I added a driver and pass a GUI parameter to xparameters.h. I get the following error when generating the Vitis BSP:

incrementer_g.c:23:1: error: unknown type name 'incrementer_Config'

I have attached the IP including the packaging script and the corresponding HW export.

bd_wrapper_solution.zip

ip_solution.zip

I might just do something wrong. Please let me know if this is the case.

[obruendl]

I also noticed the entries in the xparameters.h are missing.

[patrick-studer]

@obruendl

Thanks for using the XTOOLS IP-Packager 👍🏻

incrementer_g.c:23:1: error: unknown type name 'incrementer_Config'

I could reproduce the problem with Vitis Classic 2024.1 (2024.2 is not yet installed).

The problem comes from the auto-generated "Driver Config-File" => incrementer_g.c, which is created when the Platform is compiled. This files expects an type-definition of the incrementer_Config struct inside incrementer.h.

I did not notice, that Xilinx does not auto-create the type definition and I will see if it is possible (or add a feature to code it automatically).

Since the Driver Config-File is only a extra-feature (to be as close as possible to Xilinx IP Cores), I can safely remove it until I found a fix. I pushed a fix to https://github.com/patrick-studer/xtools/tree/8-drivers-not-working-in-vitis-20242 (only commenting out the file creation in the driver TCL snippet).

Could you please test this state if it resolves your Platform compiler problem?

I also noticed the entries in the xparameters.h are missing.

After removing the Driver Config-File generation, the platform project is compiling successfully in Vitis Classic 2024.1.

If you are still missing the entries to the xparameters.h file, it must be related to Vitis Classic 2024.2! Please let me know if so, then I will install the 2024.2 version and try to find out why...

[patrick-studer]

@obruendl

Could you verify the patch? The "Driver Config File" (_g.c) is now disabled, what leaves the freedom to the user to implement it is his own code if required.

But the topic about missing xparameters.h entries and failing compilation should be resolved now, is it?

[obruendl]

@patrick-studer

Yes, I can now fix it in the header file myself. However, it is a bit awkward that I have to define a strucct in my manually written file that must comply with code that later in the tool-flow is generated automatically.

Is this documented anywhere in xtools and is there a sample provided?

For anyone not very deeply into the AMD tools, I think documentation and a sample driver (one that can be used as starting point to be edited) would be good. The driver here seems empty.

[patrick-studer]

@obruendl
With the change provided here the _g.c file is not created.

In this case your IP Driver should compile successfully without the need of defining extra structs in the header file...
And everything should be fine in xparameters.h...

Did you test the patch - can I merge it?