2
\$\begingroup\$

How are the register detail figures made for documentation of things like Xilinx/Vivado IP or in documentation for memory-mapped peripherals in microcontrollers like the examples below?

Xilinx IP documentation

Xilinx IP example

ESP32 documentation

ESP32 example

I'm trying to write my own documentation for IP I made, but I'm finding it difficult to replicate something similar.

\$\endgroup\$
5
  • \$\begingroup\$ These can get complicated, so I won't give an answer, but I would use tikz in LaTex for this. \$\endgroup\$ Feb 7, 2023 at 19:14
  • \$\begingroup\$ You can do this in word if you wanted. \$\endgroup\$
    – Andy aka
    Feb 7, 2023 at 19:15
  • \$\begingroup\$ Shouldn't be hard to do using e.g. Inkscape or even Word. \$\endgroup\$
    – Renan
    Feb 7, 2023 at 19:16
  • 2
    \$\begingroup\$ Personally I hate maintaining register documentation by hand. Most register generation frameworks come with a documentation component, check out rggen or cheby. Wavedrom also has a register feature. \$\endgroup\$
    – mng
    Feb 7, 2023 at 21:32
  • \$\begingroup\$ Use any application you know to produce images, then include that image in your text. For example, I prefer UMLet for UML and general diagrams. \$\endgroup\$ Feb 8, 2023 at 9:01

1 Answer 1

0
\$\begingroup\$

Use any application you know to produce images, then include that image in your text.

You might also want to learn to use your text processing program. Many of them offer simple graphical objects. And all of the text processing programs are capable to insert images in your text.

\$\endgroup\$

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Not the answer you're looking for? Browse other questions tagged or ask your own question.