mirror of
https://github.com/espressif/openthread.git
synced 2026-06-05 21:14:49 +00:00
[git] reflect branch rename from 'master' to 'main' (#6249)
This commit is contained in:
Jonathan Hui
@@ -23,5 +23,5 @@ At a minimum, the README should include:
|
||||
- Versions of libraries and toolchains used for validation of the port
|
||||
|
||||
See the
|
||||
[EFR32MG12 README](https://github.com/openthread/openthread/blob/master/examples/platforms/efr32/efr32mg12/README.md)
|
||||
[EFR32MG12 README](https://github.com/openthread/openthread/blob/main/examples/platforms/efr32/efr32mg12/README.md)
|
||||
for an example.
|
||||
|
||||
@@ -26,7 +26,7 @@ device, which acknowledges receipt of the data.
|
||||
|
||||
If the radio supports dynamically setting the Frame Pending bit in outgoing
|
||||
acknowledgments to SEDs, the drivers must implement the
|
||||
[source address match](https://github.com/openthread/openthread/blob/master/include/openthread/platform/radio.h#L288)
|
||||
[source address match](https://github.com/openthread/openthread/blob/main/include/openthread/platform/radio.h#L288)
|
||||
API to enable this capability. OpenThread uses this API to tell the radio which
|
||||
SEDs to set the Frame Pending bit for.
|
||||
|
||||
@@ -55,7 +55,7 @@ energy scanning logic by setting the macro
|
||||
> Note: This feature is optional.
|
||||
|
||||
mbedTLS defines several macros in the main configuration header file,
|
||||
[`mbedtls-config.h`](https://github.com/openthread/openthread/blob/master/third_party/mbedtls/mbedtls-config.h),
|
||||
[`mbedtls-config.h`](https://github.com/openthread/openthread/blob/main/third_party/mbedtls/mbedtls-config.h),
|
||||
to allow users to enable alternative implementations of AES, SHA1, SHA2, and
|
||||
other modules, as well as individual functions for the Elliptic curve
|
||||
cryptography (ECC) over GF(p) module. See
|
||||
@@ -89,7 +89,7 @@ Commented macros in `mbedtls-config.h` are not mandatory, and can be enabled in
|
||||
the user-specific configuration header file for hardware acceleration.
|
||||
|
||||
For a complete example user-specific configuration, see the
|
||||
[`mbedtls_config_autogen.h`](https://github.com/openthread/openthread/blob/master/examples/platforms/efr32/efr32mg12/crypto/mbedtls_config_autogen.h)
|
||||
[`mbedtls_config_autogen.h`](https://github.com/openthread/openthread/blob/main/examples/platforms/efr32/efr32mg12/crypto/mbedtls_config_autogen.h)
|
||||
file.
|
||||
|
||||
### AES module
|
||||
|
||||
@@ -36,14 +36,14 @@ HAL BSP | `/openthread/third_party/{platform-name}`
|
||||
|
||||
API declaration:
|
||||
|
||||
[`/openthread/include/openthread/platform/alarm-milli.h`](https://github.com/openthread/openthread/blob/master/include/openthread/platform/alarm-milli.h)
|
||||
[`/openthread/include/openthread/platform/alarm-milli.h`](https://github.com/openthread/openthread/blob/main/include/openthread/platform/alarm-milli.h)
|
||||
|
||||
The Alarm API provides fundamental timing and alarm services for the upper layer
|
||||
timer implementation.
|
||||
|
||||
There are two alarm service types,
|
||||
[millisecond](https://github.com/openthread/openthread/blob/master/include/openthread/platform/alarm-milli.h)
|
||||
and [microsecond](https://github.com/openthread/openthread/blob/master/include/openthread/platform/alarm-micro.h).
|
||||
[millisecond](https://github.com/openthread/openthread/blob/main/include/openthread/platform/alarm-milli.h)
|
||||
and [microsecond](https://github.com/openthread/openthread/blob/main/include/openthread/platform/alarm-micro.h).
|
||||
Millisecond is required for a new hardware platform. Microsecond is optional.
|
||||
|
||||
## Step 2: UART
|
||||
@@ -52,14 +52,14 @@ Millisecond is required for a new hardware platform. Microsecond is optional.
|
||||
|
||||
API declaration:
|
||||
|
||||
[`/openthread/include/openthread/platform/uart.h`](https://github.com/openthread/openthread/blob/master/include/openthread/platform/uart.h)
|
||||
[`/openthread/include/openthread/platform/uart.h`](https://github.com/openthread/openthread/blob/main/include/openthread/platform/uart.h)
|
||||
|
||||
The UART API implements fundamental serial port communication via the UART
|
||||
interface.
|
||||
|
||||
While the OpenThread
|
||||
[CLI](https://github.com/openthread/openthread/tree/master/examples/apps/cli)
|
||||
and [NCP](https://github.com/openthread/openthread/tree/master/examples/apps/ncp)
|
||||
[CLI](https://github.com/openthread/openthread/tree/main/examples/apps/cli)
|
||||
and [NCP](https://github.com/openthread/openthread/tree/main/examples/apps/ncp)
|
||||
add-ons depend on the UART interface to interact with the host side, UART API
|
||||
support is optional. However, even if you do not plan to use these add-ons on
|
||||
your new hardware platform example, we highly recommend you add support for a
|
||||
@@ -79,7 +79,7 @@ sure to:
|
||||
|
||||
API declaration:
|
||||
|
||||
[`/openthread/include/openthread/platform/radio.h`](https://github.com/openthread/openthread/blob/master/include/openthread/platform/radio.h)
|
||||
[`/openthread/include/openthread/platform/radio.h`](https://github.com/openthread/openthread/blob/main/include/openthread/platform/radio.h)
|
||||
|
||||
The Radio API defines all necessary functions called by the upper IEEE 802.15.4
|
||||
MAC layer. The Radio chip must be fully compliant with the 2.4GHz IEEE
|
||||
@@ -101,7 +101,7 @@ The EUI-64 is used to match to steering data during the Joiner Discovery phase.
|
||||
|
||||
API declaration:
|
||||
|
||||
[`/openthread/include/openthread/platform/misc.h`](https://github.com/openthread/openthread/blob/master/include/openthread/platform/misc.h)
|
||||
[`/openthread/include/openthread/platform/misc.h`](https://github.com/openthread/openthread/blob/main/include/openthread/platform/misc.h)
|
||||
|
||||
The Misc/Reset API provides a method to reset the software on the chip, and
|
||||
query the reason for last reset.
|
||||
@@ -112,7 +112,7 @@ query the reason for last reset.
|
||||
|
||||
API declaration:
|
||||
|
||||
[`/openthread/include/openthread/platform/entropy.h`](https://github.com/openthread/openthread/blob/master/include/openthread/platform/entropy.h)
|
||||
[`/openthread/include/openthread/platform/entropy.h`](https://github.com/openthread/openthread/blob/main/include/openthread/platform/entropy.h)
|
||||
|
||||
The Entropy API provides a true random number generator (TRNG) for the upper
|
||||
layer, which is used to maintain security assets for the entire OpenThread
|
||||
@@ -142,11 +142,11 @@ of OpenThread.**
|
||||
|
||||
API declarations:
|
||||
|
||||
[`/openthread/include/openthread/platform/flash.h`](https://github.com/openthread/openthread/blob/master/include/openthread/platform/flash.h)
|
||||
[`/openthread/include/openthread/platform/flash.h`](https://github.com/openthread/openthread/blob/main/include/openthread/platform/flash.h)
|
||||
|
||||
**or**
|
||||
|
||||
[`/openthread/include/openthread/platform/settings.h`](https://github.com/openthread/openthread/blob/master/include/openthread/platform/settings.h)
|
||||
[`/openthread/include/openthread/platform/settings.h`](https://github.com/openthread/openthread/blob/main/include/openthread/platform/settings.h)
|
||||
|
||||
The Non-volatile storage requirement can be satisfied by implementing one of the
|
||||
two APIs listed above. The Flash API implements a flash storage driver, while
|
||||
@@ -175,7 +175,7 @@ file.
|
||||
|
||||
API declaration:
|
||||
|
||||
[`/openthread/include/openthread/platform/logging.h`](https://github.com/openthread/openthread/blob/master/include/openthread/platform/logging.h)
|
||||
[`/openthread/include/openthread/platform/logging.h`](https://github.com/openthread/openthread/blob/main/include/openthread/platform/logging.h)
|
||||
|
||||
The Logging API implements OpenThread's logging and debug functionality, with
|
||||
multiple levels of debug output available. This API is optional if you do not
|
||||
@@ -189,7 +189,7 @@ the terminal. Choose a debug level that best meets your needs.
|
||||
|
||||
API declaration:
|
||||
|
||||
[`/openthread/examples/platforms/openthread-system.h`](https://github.com/openthread/openthread/blob/master/examples/platforms/openthread-system.h)
|
||||
[`/openthread/examples/platforms/openthread-system.h`](https://github.com/openthread/openthread/blob/main/examples/platforms/openthread-system.h)
|
||||
|
||||
The System-specific API primarily provides initialization and deinitialization
|
||||
operations for the selected hardware platform. This API is not called by the
|
||||
@@ -199,6 +199,6 @@ Misc/Reset) in this source file.
|
||||
|
||||
Implementation of this API depends on your use case. If you wish to use the
|
||||
generated [CLI and NCP applications](https://openthread.io/guides/build#binaries) for an [example
|
||||
platform](https://github.com/openthread/openthread/tree/master/examples/platforms),
|
||||
platform](https://github.com/openthread/openthread/tree/main/examples/platforms),
|
||||
you must implement this API. Otherwise, any API can be implemented to integrate
|
||||
the example platform drivers into your system/RTOS.
|
||||
|
||||
@@ -2,11 +2,11 @@
|
||||
|
||||
Porting the OpenThread stack to a new hardware platform consists of five steps:
|
||||
|
||||
1. [Set up the build environment](https://github.com/openthread/openthread/blob/master/doc/site/en/guides/porting/set-up-the-build-environment.md)
|
||||
1. [Implement Platform Abstraction Layer APIs](https://github.com/openthread/openthread/blob/master/doc/site/en/guides/porting/implement-platform-abstraction-layer-apis.md)
|
||||
1. [Implement advanced features (Hardware Abstraction Layer)](https://github.com/openthread/openthread/blob/master/doc/site/en/guides/porting/implement-advanced-features.md)
|
||||
1. [Validate the port](https://github.com/openthread/openthread/blob/master/doc/site/en/guides/porting/validate-the-port.md)
|
||||
1. [Certification and README](https://github.com/openthread/openthread/blob/master/doc/site/en/guides/porting/certification-and-readme.md)
|
||||
1. [Set up the build environment](https://github.com/openthread/openthread/blob/main/doc/site/en/guides/porting/set-up-the-build-environment.md)
|
||||
1. [Implement Platform Abstraction Layer APIs](https://github.com/openthread/openthread/blob/main/doc/site/en/guides/porting/implement-platform-abstraction-layer-apis.md)
|
||||
1. [Implement advanced features (Hardware Abstraction Layer)](https://github.com/openthread/openthread/blob/main/doc/site/en/guides/porting/implement-advanced-features.md)
|
||||
1. [Validate the port](https://github.com/openthread/openthread/blob/main/doc/site/en/guides/porting/validate-the-port.md)
|
||||
1. [Certification and README](https://github.com/openthread/openthread/blob/main/doc/site/en/guides/porting/certification-and-readme.md)
|
||||
|
||||
## Hardware platform requirements
|
||||
|
||||
|
||||
@@ -20,7 +20,7 @@ platform-relative macro definitions. These macros can be exposed for
|
||||
conditional compilation in other Makefiles during the pre-compiling phase.
|
||||
|
||||
The OpenThread Autoconf script is located at:
|
||||
[`/openthread/configure.ac`](https://github.com/openthread/openthread/blob/master/configure.ac)
|
||||
[`/openthread/configure.ac`](https://github.com/openthread/openthread/blob/main/configure.ac)
|
||||
|
||||
### Platform example name
|
||||
|
||||
@@ -106,14 +106,14 @@ The following platform-specific Automake files need to be created:
|
||||
- `/openthread/examples/platforms/{platform-name}/Makefile.am`
|
||||
- `/openthread/examples/platforms/{platform-name}/Makefile.platform.am`
|
||||
|
||||
See [`/examples`](https://github.com/openthread/openthread/tree/master/examples/) for sample implementations of
|
||||
See [`/examples`](https://github.com/openthread/openthread/tree/main/examples/) for sample implementations of
|
||||
these files.
|
||||
|
||||
The following Automake files also need to be updated with your platform
|
||||
information:
|
||||
|
||||
- [`/openthread/examples/platforms/Makefile.am`](https://github.com/openthread/openthread/blob/master/examples/platforms/Makefile.am)
|
||||
- [`/openthread/examples/platforms/Makefile.platform.am`](https://github.com/openthread/openthread/blob/master/examples/platforms/Makefile.platform.am)
|
||||
- [`/openthread/examples/platforms/Makefile.am`](https://github.com/openthread/openthread/blob/main/examples/platforms/Makefile.am)
|
||||
- [`/openthread/examples/platforms/Makefile.platform.am`](https://github.com/openthread/openthread/blob/main/examples/platforms/Makefile.platform.am)
|
||||
|
||||
### Linker script configuration
|
||||
|
||||
@@ -145,7 +145,7 @@ endif # OPENTHREAD_EXAMPLES_EFR32
|
||||
```
|
||||
|
||||
Add the platform's linker script configuration to the
|
||||
[`/openthread/examples/platforms/Makefile.platform.am`](https://github.com/openthread/openthread/blob/master/examples/platforms/Makefile.platform.am)
|
||||
[`/openthread/examples/platforms/Makefile.platform.am`](https://github.com/openthread/openthread/blob/main/examples/platforms/Makefile.platform.am)
|
||||
utility Makefile:
|
||||
|
||||
```
|
||||
@@ -156,7 +156,7 @@ endif
|
||||
|
||||
### Subdirectory configuration
|
||||
|
||||
Modify [`/openthread/examples/platforms/Makefile.am`](https://github.com/openthread/openthread/blob/master/examples/platforms/Makefile.platform.am)
|
||||
Modify [`/openthread/examples/platforms/Makefile.am`](https://github.com/openthread/openthread/blob/main/examples/platforms/Makefile.platform.am)
|
||||
to configure the package subdirectories for the new platform example.
|
||||
|
||||
Add the platform subdirectory name in the list for `make dist`, in alphabetical
|
||||
@@ -214,4 +214,4 @@ libopenthread_efr32_a_SOURCES = \
|
||||
|
||||
> Note: Any non-original derivative code (for example, linker script or
|
||||
toolchain startup code) must be contained in
|
||||
[`/openthread/third_party`](https://github.com/openthread/openthread/tree/master/third_party).
|
||||
[`/openthread/third_party`](https://github.com/openthread/openthread/tree/main/third_party).
|
||||
|
||||
Reference in New Issue
Block a user