Skip to content

Commit 64966aa

Browse files
committed
mimxrt: Change network.LANmimxrt.rst to network.LAN.rst.
Editorial change: Move the MIMXRT specific sentence to the end of the section.
1 parent 88846d6 commit 64966aa

File tree

3 files changed

+15
-8
lines changed

3 files changed

+15
-8
lines changed

docs/library/network.LANmimxrt.rst renamed to docs/library/network.LAN.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
.. currentmodule:: network
2-
.. _mimxrt_network.LAN:
2+
.. _network.LAN:
33

4-
class LAN -- control Ethernet modules of the MIMXRT port
5-
========================================================
4+
class LAN -- control an Ethernet module
5+
=======================================
66

7-
This class allows you to control the Ethernet interface of the MIMXRT
8-
MCUs. The PHY hardware type is board-specific.
7+
This class allows you to control the Ethernet interface. The PHY hardware type is board-specific.
98

109
Example usage::
1110

@@ -29,7 +28,7 @@ Constructors
2928

3029
- *id* is the number of the Ethernet port, either 0 or 1.
3130
- *phy_type* is the name of the PHY driver. For most board the on-board PHY has to be used and
32-
is the default. Suitable values are PHY_KSZ8081, PHY_DP83825, PHY_DP83848, PHY_LAN8720, and PHY_RTL8211F.
31+
is the default. Suitable values are port specific.
3332
- *phy_addr* specifies the address of the PHY interface. As with *phy_type*, the hardwired value has
3433
to be used for most boards and that value is the default.
3534
- *phy_clock* specifies, whether the data clock is provided by the Ethernet controller or the PYH interface.
@@ -83,3 +82,11 @@ Methods
8382

8483
low_power=True | False Set or clear low power mode.
8584

85+
86+
Specific LAN class implementations
87+
----------------------------------
88+
89+
MIMXRT port:
90+
91+
Suitable values for the *phy_type* constructor argument are
92+
PHY_KSZ8081, PHY_DP83825, PHY_DP83848, PHY_LAN8720, and PHY_RTL8211F.

docs/library/network.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ provide a way to control networking interfaces of various kinds.
152152
network.WLANWiPy.rst
153153
network.CC3K.rst
154154
network.WIZNET5K.rst
155-
network.LANmimxrt.rst
155+
network.LAN.rst
156156

157157
Network functions
158158
=================

docs/mimxrt/quickref.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -890,7 +890,7 @@ However, you can attach external PHY interfaces. By default, the firmware for Se
890890
uses the driver for a LAN8720 PHY. The MIMXRT1170_EVK is equipped with two Ethernet ports.
891891
They are addressed as LAN(0) for the 100M port and LAN(1) for the 1G port.
892892

893-
For details of the network interface refer to the class :std:ref:`network.LAN <mimxrt_network.LAN>`.
893+
For details of the network interface refer to the class :std:ref:`network.LAN <network.LAN>`.
894894

895895
Transferring files
896896
------------------

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy