Skip to content

Commit 367067b

Browse files
committed
west: update telink manifest and doc URLs for tl_ repo rename
Prepare for the GitHub repo renames tracked in UTCSH-526 (Rename-01, parent epic UTCSH-525): - zephyr -> tl_zephyr (self references in README / docs) - mcuboot -> tl_mcuboot - openthread -> tl_openthread - xz -> tl_xz openthread_telink_lib references now point to tl_openthread_libs, published first as a placeholder mirror; the original repository is renamed onto that name after ThreadGroup confirmation (UTCSH-533 / Rename-08). Historical release notes are left unchanged (GitHub 301 redirects cover them). Do not merge before the freeze window: CI cloning tl_* URLs fails until the renames are executed (UTCSH-527 / Rename-02, UTCSH-528 / Rename-03). Also sort the tl_ble_sdk west manifest entry and add its MAINTAINERS.yml entry; these pre-existing issues surface now that this branch touches west.yml and would otherwise fail the compliance check. Also documents the Telink specific modifications carried by the renamed fork repositories (tl_mcuboot, tl_openthread, tl_xz, tl_openthread_libs) in the SDK README. Signed-off-by: Damien Ji <yinghao.ji@telink-semi.com>
1 parent f47e596 commit 367067b

4 files changed

Lines changed: 66 additions & 9 deletions

File tree

MAINTAINERS.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5568,6 +5568,14 @@ West:
55685568
labels:
55695569
- "platform: Telink"
55705570

5571+
"West project: tl_ble_sdk":
5572+
status: maintained
5573+
maintainers:
5574+
- telink
5575+
files: []
5576+
labels:
5577+
- "platform: Telink"
5578+
55715579
Xtensa arch:
55725580
status: maintained
55735581
maintainers:

README.rst

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,55 @@ Getting Started
3636
Welcome to Zephyr! See the `Introduction to Zephyr`_ for a high-level overview,
3737
and the documentation's `Getting Started Guide`_ to start developing.
3838

39+
Telink Maintained Repositories
40+
******************************
41+
42+
Besides this repository, the SDK pulls in the following Telink maintained
43+
modules through its west manifests (``west.yml`` and
44+
``submanifests/telink.yaml``). They carry Telink specific modifications and
45+
optimizations on top of their upstream projects, or are Telink provided
46+
components, and are therefore published under the ``tl_`` naming convention:
47+
48+
.. list-table::
49+
:header-rows: 1
50+
51+
* - Repository
52+
- Upstream
53+
- Telink Modifications
54+
* - `tl_mcuboot`_
55+
- `MCUboot`_
56+
- Boot time optimizations: the primary slot image is validated only on the first boot (``BOOT_VALIDATE_SLOT0_ONCE``); on TL323X the application image hash is computed directly from flash storage (``CONFIG_BOOT_IMG_HASH_DIRECTLY_ON_STORAGE``) without a RAM copy.
57+
* - `tl_openthread`_
58+
- `OpenThread`_
59+
- Security fix for a MAC Key ID Mode 2 frame injection issue, and performance optimization placing the sleepy end device (SED) processing call tree (tasklets, timers, MAC frame handling, mesh forwarding) in the RAM code section (``OT_SED_RAM``) for faster execution on Telink SoCs.
60+
* - `tl_xz`_
61+
- `XZ Utils`_
62+
- Zephyr module integration for ``liblzma`` (a ``zephyr/`` CMake and Kconfig wrapper) with size optimization (``-Os``) enabled by default.
63+
* - `tl_openthread_libs`_
64+
- Telink owned
65+
- Prebuilt OpenThread FTD libraries for Telink SoCs, in extended and reduced feature set variants, linked as a Zephyr module when ``CONFIG_OPENTHREAD_TELINK_LIBRARY`` is selected.
66+
67+
The Telink HAL module `hal_telink`_ keeps the upstream Zephyr HAL naming
68+
convention (``hal_<vendor>``). Other Telink provided components, such as the
69+
BLE SDK (``tl_ble_sdk_zephyr``), ``tflite-micro-telink`` and the NFC driver
70+
``nfc_st25dv``, keep their component oriented names and are referenced
71+
unchanged; all remaining manifest projects are consumed as-is from their
72+
upstream repositories.
73+
74+
This repository and the modules listed above were previously published under
75+
their upstream-derived names (``zephyr``, ``mcuboot``, ``openthread``, ``xz``
76+
and ``openthread_telink_lib``) and have been renamed to carry the ``tl_``
77+
prefix, making the Telink maintained components of the SDK easy to identify.
78+
79+
.. _tl_mcuboot: https://github.com/telink-semi/tl_mcuboot
80+
.. _MCUboot: https://github.com/mcu-tools/mcuboot
81+
.. _tl_openthread: https://github.com/telink-semi/tl_openthread
82+
.. _OpenThread: https://github.com/openthread/openthread
83+
.. _tl_xz: https://github.com/telink-semi/tl_xz
84+
.. _XZ Utils: https://github.com/tukaani-project/xz
85+
.. _tl_openthread_libs: https://github.com/telink-semi/tl_openthread_libs
86+
.. _hal_telink: https://github.com/telink-semi/hal_telink
87+
3988
.. start_include_here
4089
4190
Community Support

submanifests/telink.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
manifest:
55
projects:
66
- name: lzma
7-
url: https://github.com/telink-semi/xz
7+
url: https://github.com/telink-semi/tl_xz
88
revision: 053c1629f452b43339e7cd5c66fc89a143f4827a
99
path: modules/lib/lzma
1010

1111
- name: openthread_telink_lib
12-
url: https://github.com/telink-semi/openthread_telink_lib
12+
url: https://github.com/telink-semi/tl_openthread_libs
1313
revision: tags/v4.1.1
1414
path: modules/lib/openthread_telink_lib
1515

west.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -251,12 +251,6 @@ manifest:
251251
path: modules/hal/telink
252252
groups:
253253
- hal
254-
- name: tl_ble_sdk
255-
url: https://github.com/telink-semi/tl_ble_sdk_zephyr.git
256-
revision: a52f693b5b09d534e3076d2a6c9f787f7335907f
257-
path: modules/hal/telink/hal_v2/tl_ble_sdk
258-
groups:
259-
- hal
260254
- name: hal_ti
261255
revision: 258652a3ac5d7df68ba8df20e4705c3bd98ede38
262256
path: modules/hal/ti
@@ -308,7 +302,7 @@ manifest:
308302
groups:
309303
- crypto
310304
- name: mcuboot
311-
url: https://github.com/telink-semi/mcuboot
305+
url: https://github.com/telink-semi/tl_mcuboot
312306
revision: ce0da85c39c749df49b0ec62b33d2ecdea24c927
313307
path: bootloader/mcuboot
314308
groups:
@@ -357,6 +351,12 @@ manifest:
357351
path: modules/crypto/tinycrypt
358352
groups:
359353
- crypto
354+
- name: tl_ble_sdk
355+
url: https://github.com/telink-semi/tl_ble_sdk_zephyr.git
356+
revision: a52f693b5b09d534e3076d2a6c9f787f7335907f
357+
path: modules/hal/telink/hal_v2/tl_ble_sdk
358+
groups:
359+
- hal
360360
- name: trusted-firmware-a
361361
revision: 713ffbf96c5bcbdeab757423f10f73eb304eff07
362362
path: modules/tee/tf-a/trusted-firmware-a

0 commit comments

Comments
 (0)