Skip to content

Commit 5539e0e

Browse files
author
Amanda Butler
authored
Edit addition to fastmodels.md
Edit file to point example links to rendered examples and edit text.
1 parent a041986 commit 5539e0e

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

docs/tools/fastmodels/fastmodels.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,19 @@ FVP_MPS2_Cortex-M7 | FVP_MPS2_M7
2525
Fast Models can run most of the Mbed OS examples.
2626

2727
Examples you can successfully run include:
28-
* [`mbed-os-example-blinky`](https://github.com/ARMmbed/mbed-os-example-blinky)
29-
* [`mbed-os-example-tls`](https://github.com/ARMmbed/mbed-os-example-tls)
30-
* [`mbed-os-example-devicekey`](https://github.com/ARMmbed/mbed-os-example-devicekey)
31-
* [`mbed-os-example-nvstore`](https://github.com/ARMmbed/mbed-os-example-nvstore)
32-
* [`mbed-os-example-thread-statistics`](https://github.com/ARMmbed/mbed-os-example-thread-statistics)
33-
* [`mbed-os-example-sys-info`](https://github.com/ARMmbed/mbed-os-example-sys-info)
34-
* [`mbed-os-example-cpu-usage`](https://github.com/ARMmbed/mbed-os-example-cpu-usage)
35-
* [`mbed-os-example-cpu-stats`](https://github.com/ARMmbed/mbed-os-example-cpu-stats)
36-
* [`mbed-os-example-error-handling`](https://github.com/ARMmbed/mbed-os-example-error-handling)
37-
* [`mbed-os-example-filesystem`](https://github.com/ARMmbed/mbed-os-example-filesystem)
38-
* [`mbed-os-example-blockdevice`](https://github.com/ARMmbed/mbed-os-example-blockdevice)
39-
* [`mbed-os-example-sockets`](https://github.com/ARMmbed/mbed-os-example-sockets)
28+
29+
- [`mbed-os-example-blinky`](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-blinky/).
30+
- [`mbed-os-example-tls`](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-tls-benchmark/).
31+
- [`mbed-os-example-devicekey`](https://os-doc-builder.test.mbed.com/docs/development/apis/devicekey.html#devicekey-example).
32+
- [`mbed-os-example-nvstore`](https://os-doc-builder.test.mbed.com/docs/development/apis/nvstore.html#nvstore-example).
33+
- [`mbed-os-example-thread-statistics`](https://os-doc-builder.test.mbed.com/docs/development/apis/mbed-statistics.html#thread-statistics-example).
34+
- [`mbed-os-example-sys-info`](https://os-doc-builder.test.mbed.com/docs/development/apis/mbed-statistics.html#system-information-example).
35+
- [`mbed-os-example-cpu-usage`](https://os-doc-builder.test.mbed.com/docs/development/apis/mbed-statistics.html#cpu-usage-example).
36+
- [`mbed-os-example-cpu-stats`](https://os-doc-builder.test.mbed.com/docs/development/apis/mbed-statistics.html#cpu-statistics-example).
37+
- [`mbed-os-example-error-handling`](https://os-doc-builder.test.mbed.com/docs/development/apis/error-handling.html#error-handling-example).
38+
- [`mbed-os-example-filesystem`](https://os-doc-builder.test.mbed.com/docs/development/apis/filesystem.html#file-system-example).
39+
- [`mbed-os-example-blockdevice`](https://os-doc-builder.test.mbed.com/docs/development/apis/blockdevice.html#blockdevice-example).
40+
- [`mbed-os-example-sockets`](https://os-doc-builder.test.mbed.com/docs/development/apis/socket.html#socket-example).
4041

4142
The following examples use `mbed-os-example-blinky`.
4243

@@ -69,30 +70,31 @@ $ FVP_MPS2_Cortex-M3 -a BUILD/FVP_MPS2_M3/GCC_ARM/mbed-os-example-blinky.elf
6970

7071
The FVPs start running, and the LEDs on the FVP blink, like:
7172

72-
<span class="images">![](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/fastmodel_cm3.png)
73+
<span class="images">![](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/fastmodel_cm3.png)<span>A screen shot of FVPs running</span></span>
7374

74-
<span>a screen-shot for FVPs running</span></span>
75+
<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 reference guide](https://developer.arm.com/docs/100966/latest).</span>
7576

76-
<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 Reference Guide](https://developer.arm.com/docs/100966/latest).</span>
77+
#### Run Mbed OS sockets examples with Fast Models ethernet
7778

78-
#### Run Mbed OS sockets examples with Fast Models Ethernet
79+
Fast Models ethernet is a special component not enabled by default.
7980

80-
Fast Models ethernet is a specical compoment which not been enabled by default. Two special options are required when using the ethernet compoment or any networking functions.
81+
<span class="notes">**Note:** The current version of Fast Model ethernet implementations requires Fast Models 11.3 or later or DS-5 5.29.0 or later. Also, the simulated IP routing only works on TCP and IP protocols, but neither the ICMP nor the IGMP protocol. This means ping does not work. For more details about how the Fast Models ethernet MAC works, please reference the [Fast Models reference manual](https://developer.arm.com/products/system-design/fast-models/docs/100964/latest/introduction/network-set-up/user-mode-networking).</span>
8182

82-
<span class="notes">**Note:** Current version of Fast Model ethernet implementations requires Fast Models 11.3 or later or DS-5 5.29.0 or later. Also the simulated IP routing only works on TCP/IP protocol, but neither ICMP nor IGMP protocol. which means ping would not work. For more details about how the Fast Models ethernet MAC working, please reference the [Fast Models Reference Manual](https://developer.arm.com/products/system-design/fast-models/docs/100964/latest/introduction/network-set-up/user-mode-networking).</span>
83+
Here, the `mbed-os-example-sockets` example demonstrates ethernet function. You can build the example as usual:
8384

84-
Here, `mbed-os-example-sockets` example is used to demonstrated ethernet function. The example can be build as usual:
8585
```
8686
$ mbed import mbed-os-example-sockets
8787
$ cd mbed-os-example-sockets
8888
$ mbed compile -t GCC_ARM -m FVP_MPS2_M3
8989
```
90-
While launching the mbed OS socket example with Fast Models Ethernet function, arguments `-C fvp_mps2.smsc_91c111.enabled=1` and `-C fvp_mps2.hostbridge.userNetworking=1` need to be passed in the command line:
90+
91+
While launching the Mbed OS socket example with the Fast Models Ethernet function, you need to pass the arguments `-C fvp_mps2.smsc_91c111.enabled=1` and `-C fvp_mps2.hostbridge.userNetworking=1` in the command-line:
92+
9193
```
9294
$ FVP_MPS2_Cortex-M3 -C fvp_mps2.smsc_91c111.enabled=1 -C fvp_mps2.hostbridge.userNetworking=1 -a BUILD/FVP_MPS2_M3/GCC_ARM/mbed-os-example-sockets.elf
9395
```
9496

95-
The FVPs start running, and the console output like::
97+
The FVPs start running, and the console output looks like:
9698

9799
```
98100
Mbed OS Socket example
@@ -107,7 +109,6 @@ External IP address: 217.140.106.54
107109
Done
108110
```
109111

110-
111112
### Notes
112113

113114
1. Timing accuracy of Fast Models can't be guaranteed.

0 commit comments

Comments
 (0)