Skip to content

Update Ethernet porting guide. #528

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 25, 2018
Merged

Update Ethernet porting guide. #528

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
081c596
Update Ethernet porting guide.
May 25, 2018
25af8d6
Delete sentence in ethernet.md
May 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/reference/contributing/connectivity/ethernet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<span class="images">![](https://s3-us-west-2.amazonaws.com/mbed-os-docs-images/emac.png)<span>Emac API</span></span>

This document describes how to port and test an Ethernet MAC (EMAC) driver to Mbed OS. This code is currently on a feature branch.
This document describes how to port and test an Ethernet MAC (EMAC) driver to Mbed OS.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


The scope of this document is limited to Ethernet (IEEE 802.3) or Ethernet-like devices, such as Wi-Fi (IEEE 802.11), where the device presents a MAC interface to send and receive frames, and one of the onboard network stacks that runs on Mbed OS on the host processor uses this.

Expand Down Expand Up @@ -144,7 +144,7 @@ For general Greentea information, please see the [Greentea](/docs/development/to

EMAC tests are in the Mbed OS tree under the `TESTS/network/emac` directory.

Greentea socket tests are in the Mbed OS tree under the `TESTS/netsocket` directory.
Greentea socket tests are in the Mbed OS tree under the `TESTS/network/emac` directory. It contains [README.md](https://github.com/ARMmbed/mbed-os/blob/master/TESTS/network/emac/README.md) to guide setting up the test environment and running test cases.
Copy link
Contributor

@AnotherButler AnotherButler May 25, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We prefer not to link to GitHub. Let's keep this line the way it was.


The driver should also be exercised with real-world examples, such as the [Arm Mbed Client example](https://os.mbed.com/teams/mbed-os-examples/code/mbed-os-example-client/).

Expand Down