Skip to content

Commit f33f11a

Browse files
committed
Cleaning up duplications
1 parent 49601bc commit f33f11a

File tree

2 files changed

+20
-23
lines changed

2 files changed

+20
-23
lines changed

docs/porting/porting_full_process/porting_reqs.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,16 @@
44

55
Porting Mbed OS requires the following hardware:
66

7-
- An evaluation board with the targeted MCU.
7+
- A development PC. You can port targets, connectivity and storage on Windows, macOS or Linux. However, due to limitations in some development tools that Mbed OS uses, you need a Windows PC for DAPLink/FlashAlgo development.
8+
9+
- An evaluation board with a target MCU, debug probe or an integrated interface chip. The hardware [is reviewed in greater details later in this document]().
810

911
The new target needs a unique board ID. [Contact Arm]() to get one.
1012

11-
- A micro USB cables. One Micro USB cable connects the evaluation board to your development PC.
13+
- A storage device (SD or external flash).
14+
- A micro SD card for the CI test shield.<!--are these the same thing?-->
15+
16+
- A micro USB cable to connect the evaluation board to your development PC.
1217

1318
You may also need:
1419

@@ -19,7 +24,6 @@ You may also need:
1924
The following items might help you test SPI, I2C and Pins:
2025

2126
- A CI test shield v2.0.0. For details, refer to [https://github.com/ARMmbed/ci-test-shield](https://github.com/ARMmbed/ci-test-shield).
22-
- A micro SD card for the CI test shield.
2327

2428
<span class="tips">Check the user guide of the evaluation board to see if anything needs to be done prior to using a debug probe and running Mbed OS programs.</span>
2529

@@ -30,10 +34,13 @@ Please install the following:
3034
- [Python 2.7](https://www.python.org/downloads/release/python-2715/).
3135
- [Git](https://git-scm.com/downloads).
3236
- [Mbed CLI](../tools/installation-and-setup.html).
37+
- Choose an IDE and debugger. The three commonly used IDEs are [Eclipse](https://www.eclipse.org/ide/), [IAR Embedded Workbench](https://www.iar.com/iar-embedded-workbench/) and [Keil MDK](http://www.keil.com/).
38+
39+
Limitations:
40+
41+
- Eclipse is license free, whereas both IAR and Keil IDE require licenses.
42+
- Currently, DAPLink development works only Keil MDK. You will have to use Keil for pyOCD and DAPLink development.
43+
3344
- (Optional) [FTDI serial driver](http://www.ftdichip.com/Drivers/VCP.htm).
34-
- Toolchains:
35-
- [GNU Arm Embedded Toolchain (GCC)](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads).
36-
- [IAR](https://www.iar.com/iar-embedded-workbench/).
37-
- [Arm Compiler 5 or 6](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler/downloads/version-5).
3845

3946
<span class="notes">The [tools documentation](../tools/index.html) contains the exact third party tool versions supported in a specific Mbed OS release.</span>
Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,26 @@
11
## Porting guide
22

3-
This document provides guidelines for adding a new MCU target to Mbed OS and Pelion.
3+
This document provides guidelines for adding a new MCU target to Mbed OS and the Pelion IoT Platform.
44

55
### Scope and milestones
6-
<!--I'm not sure I see how these milestones follow what's below, at least in numbering-->
7-
The following milestones usually need to happen to port Mbed OS to a board or target:
86

9-
1. Set up a development environment. Please choose:
10-
- Your primary development PC (Windows, Mac OS or Linux).
7+
You will usually need to go through all of these steps to port Mbed OS:
118

12-
You can port targets, connectivity and storage on Windows, macOS or Linux. Due to limitations in some development tools that Mbed OS uses, you need a Windows PC for DAPLink/FlashAlgo development.
13-
14-
- An evaluation board with a target MCU, debug probe or an integrated interface chip.<!--I'm guessing the "or" is only for the last two things - debug probe or interface chip. In which case, this sentence requires rewriting.--> The hardware [is reviewed in greater details later in this document]().
15-
- A storage device (SD or external flash).
9+
1. Set up a development environment (including IDE and debugger) and your target.
1610

1711
1. Locate reusable code to port to Mbed OS.
1812
<!--Are the reusable code and SDK related? Are they the same thing?-->
1913
If there is an SDK available to speed up the porting process, we recommend reusing it (assuming copyright of the existing code is preserved).
2014

21-
1. Choose an IDE and debugger. The three commonly used IDEs are [Eclipse](https://www.eclipse.org/ide/), [IAR Embedded Workbench](https://www.iar.com/iar-embedded-workbench/) and [Keil MDK](http://www.keil.com/).
22-
23-
Limitations:
15+
<!--I actually don't quite understand this. Is it mandatory to find reusable code (which is implied in the first line), or is it "if you have it, use it"?-->
2416

25-
- Eclipse is license free, whereas both IAR and Keil IDE require licenses.
26-
- Currently, DAPLink development works only Keil MDK. You will have to use Keil for pyOCD and DAPLink development.
2717

2818
1. The [Mbed Enabled](https://www.mbed.com/en/about-mbed/mbed-enabled/introduction/) program requires pyOCD, so ultimately pyOCD needs to support the new target. To allow parallel development in porting targets, connectivity and storage while pyOCD is still under development, you can use other IDEs supported on the evaluation board in the beginning phase.
2919

3020
1. Implement and test CMSIS pack, bootstrap, linker script and startup code.
3121

3222
A basic framework is ready after this step. You can do the rest of the porting work in parallel:
3323

34-
1. Implement and test porting APIs. This includes all components described in the rest of this porting guide.
24+
1. Implement and test porting APIs<!--we call the modules everywhere else-->. This porting guide provides the recommended porting order and links to full porting information about each module.
3525

36-
1. Test Mbed OS and Pelion example applications (as listed [in the final steps in this porting guide]()). This steps verifies that your new port is fully functional.
26+
1. Test Mbed OS and Pelion example applications. This steps verifies that your new port is fully functional.

0 commit comments

Comments
 (0)