Add documents for Fast Model #690
Conversation
AnotherButler
requested review from
MarceloSalazar,
ashok-rao and
AnotherButler
|
@jamesbeyond Whom should I tag for engineering review? |
|
hi @AnotherButler , I think @bulislaw would be suitable, but currently, he is no holiday. |
|
@ARMmbed/mbed-os-hal Please review |
docs/tools/fastmodels/fastmodels.md
Outdated
|
|
||
|
|
||
| ## Mbed OS examples on Fast Models | ||
| Currently Fast Models able run most of the Mbed OS examples which do not require networking or external peripherals[^1] . |
There was a problem hiding this comment.
This reference is not rendering properly.
There was a problem hiding this comment.
seems GitHub markdown does not support footnote. so changed to HTML tags
docs/tools/fastmodels/fastmodels.md
Outdated
| ``` | ||
| You should be able to see FVPs starts running, and serial output through telnet/xterm, or LEDs on the FVP is blinking, like: | ||
|
|
||
| <span class="images"><span>a screen-shot for FVPs running</span></span> |
There was a problem hiding this comment.
The screenshot is not rendering properly.
There was a problem hiding this comment.
the image links will not be alive until doxygen pulls the changes. @AnotherButler could you verify the link afterward
docs/tools/fastmodels/fastmodels.md
Outdated
| ## Known issues | ||
| 1 Timing accuracy of Fast Model FVPs can't be guaranteed | ||
| 2 No support for external peripherals. e.g. esp8266, Expansion boards | ||
| 3 Ethernet support for Fast Model FVPs is in working progress. |
There was a problem hiding this comment.
The list is not rendering properly.
There was a problem hiding this comment.
This is fixed now
|
Hi @ithinuel @fkjagodzinski, |
Copy edit file for branding, formatting and grammar.
|
|
||
| For more details on Fast Models and FVPs, please reference further documentation about [Arm Fast Models](https://developer.arm.com/products/system-design/fast-models) or [FVPs](https://developer.arm.com/products/system-design/fixed-virtual-platforms). | ||
|
|
||
| ### Supported Fast Models FVPs |
There was a problem hiding this comment.
This looks like a list we'll have to keep updating every time we add support for a platform. If so, this page could easily get out of date. Can we delete this section and link somewhere, instead?
There was a problem hiding this comment.
This list is not going to to be updated frequently. It will get update some point next year, based on the plan. Then it will stay like that for a very long time.
But I am open to any suggestions. Where do you think is the best place to present such information? By saying "link to somewhere", do you mean a new page in the docs?
If we decided to keep it here, I will keep this list updated.
docs/tools/fastmodels/fastmodels.md
Outdated
|
|
||
| <span class="notes">**Note:** FVP's `-a` option only takes .elf format images. To use the `--data` option with binary format images, please reference the [FVP Users' Guide](http://arminfo.emea.arm.com/help/index.jsp?topic=/com.arm.doc.100966_1103_00_en/index.html).</span> | ||
|
|
||
| ### Known issues |
There was a problem hiding this comment.
The only known issues lists we typically publish are in the release notes. Has someone from Product approved this?
There was a problem hiding this comment.
em.. that's a good point. But I am not sure about the answers.
Maybe the words "known issues" not quite precise for these 3 things.
Point 1 and 2 are more of the unique properties or limitations of the software models compare to the real hardware targets that mbed OS supporting. What user would expect these would working on a HW, but these will not never working on software models. These are not defect nether, and they will never get fixed.
I don't think Point 1 and 2 need to be on the release notes.
Point 3, is something we are still in working progresss, not finished yet.
Not sure if we need to put this in to release notes.
I guess we'd need some one from the product to decide.
|
Hi @AnotherButler , thanks for the revising. Overall it looks very good. things remain accurate, much appreciated! But, I saw you removed one of the paragraphs about that users need to set up the fast model following other documents on their own. Just want to confirm these are not removed by accident. |
Update phrasing for precise language.
Document for how to build running mbed-os examples.
Along with a screenshot.