FPGAwars / apio

:seedling: Open source ecosystem for open FPGA boards
https://github.com/FPGAwars/apio/wiki
GNU General Public License v2.0
794 stars 136 forks source link

Documentation incomplete for adding new boards #299

Closed mkvenkit closed 6 months ago

mkvenkit commented 2 years ago

The documentation for adding a new board to apio seems incomplete:

https://github.com/FPGAwars/apio/wiki/Adding-new-boards-to-apio

Please add some details.

Thanks!

cavearr commented 2 years ago

Hi @mkvenkit ! what type of programmer do you use? ftdi? jtag? Have you any documentation about your board?

mahesh-electronut commented 2 years ago

Hi @cavearr thanks for your response. The RP2040 on the board acts as a programmer. The board is not released yet, so I am still working on documentation and firmware. Here's a guide to getting started with board:

https://github.com/mkvenkit/humble_ice/blob/main/getting_started.md

This is the Python script used to upload the bitstream:

https://github.com/mkvenkit/humble_ice/blob/main/hiprog.py

cavearr commented 2 years ago

Thanks! mahesh, i think i could integrate without the needed to add to apio, because recently i integrate the badge for the mch2022 that uses the rp2040 as programmer like you. Give me some time to try and i'm telling you to check it.

One thing i need of you is the pcf file of your board.

mahesh-electronut commented 2 years ago

@cavearr the only constraints required are the clk signal and the LED. So a minimal PCF file is:

set_io clk 35
set_io LED 13

The rest can be set by the user as needed.

Or are you looking for a PCF file with all GPIOs populated?

cavearr commented 2 years ago

Hi Mahesh! in Icestudio is needed to assign the input and output pins for the board, in the near future the user could modify easily from the interface but for now, the board should do the initial preset to provide at Icestudio the information to configure inputs and outputs

If other pins in your board could be input/output, setup in this way in the pcf , but this, is needed.

De: "Mahesh Venkitachalam" @.> Para: "FPGAwars/apio" @.> CC: "Carlos" @.>, "Mention" @.> Enviados: Jueves, 22 de Septiembre 2022 8:21:23 Asunto: Re: [FPGAwars/apio] Documentation incomplete for adding new boards (Issue #299)

[ https://github.com/cavearr | @cavearr ] the only constraints required are the clk signal and the LED. So a minimal PCF file is: set_io clk 35 set_io LED 13

The rest can be set by the user as needed.

— Reply to this email directly, [ https://github.com/FPGAwars/apio/issues/299#issuecomment-1254579282 | view it on GitHub ] , or [ https://github.com/notifications/unsubscribe-auth/ABUVYIOBBXGYUPIMTDDFIDLV7P3GHANCNFSM6AAAAAAQSDLCLM | unsubscribe ] . You are receiving this because you were mentioned. Message ID: @.***>

mahesh-electronut commented 2 years ago

OK, I will work on this and get back to you. Thanks

Obijuan commented 6 months ago

The documentation on how to add boards to apio has been added. It is located here: https://github.com/FPGAwars/apio/wiki/Adding-new-boards-to-apio