Forum Discussion

Altera_Forum's avatar
Altera_Forum
Icon for Honored Contributor rankHonored Contributor
10 years ago

QSYS Comments?

Hello,

I am a beginner Quartus user, and I've been playing around with some example projects for the MAX 10 Deca Kit.

One thing about QSYS I've found so far, is that aside from the names, there is not much information about what seperate IP blocks in a QSYS project are Meant to do for the project (ie multiple PIO blocks, for example).

Is there a better way to document, or leave/find comments on the IP blocks so users can understand what the block is meant to do, project wise?

Thanks for any advice.

4 Replies

  • Altera_Forum's avatar
    Altera_Forum
    Icon for Honored Contributor rankHonored Contributor
    10 years ago

    AFAIK, there is no way to do it internally in Qsys - I wish there were! The easiest thing to do is probably just to write a separate text document describing what each block does.

  • Altera_Forum's avatar
    Altera_Forum
    Icon for Honored Contributor rankHonored Contributor
    10 years ago

    That is certainly a pity. Good documentation of large designs (especially example projects!) is super helpful when you are trying to understand the independent parts to make changes!

    Are there any other documentation tools in regards to Quartus? I've mostly just been learning the QSYS tool...

    Thanks for any advice,

    Neal
  • Altera_Forum's avatar
    Altera_Forum
    Icon for Honored Contributor rankHonored Contributor
    10 years ago

    Quartus is just a IDE that doesnt have any documentation tools. As most input for Quartus is HDL code, you can write comments in there as much as you like.