Skip to content

Commit 3185ae1

Browse files
adabreutiandy31415
andauthored
[TI] Update Example Applications and TI Documentation (#34060)
* Update TI Applications with correct OTA startup handling * Update Linker command files and NV regions * Add test event trigger delegate * Fix pairing failure in TI applications * Update TI Matter documentation * Update Openthread OT-TI commit * Apply restyled updates * Update Image spelling * Apply restyled * Update workflow to perform recursive clone * Update nvocmp.c to fix formatting issue --------- Co-authored-by: Andrei Litvin <andy314@gmail.com>
1 parent 176896a commit 3185ae1

File tree

75 files changed

+6466
-339
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+6466
-339
lines changed

.github/workflows/examples-cc13xx_26xx.yaml

+11-7
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,19 @@ name: Build example - TI CC13XX_26XX
1717
on:
1818
push:
1919
branches-ignore:
20-
- 'dependabot/**'
20+
- "dependabot/**"
2121
pull_request:
2222
merge_group:
2323

2424
concurrency:
25-
group: ${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name == 'pull_request' && github.event.number) || (github.event_name == 'workflow_dispatch' && github.run_number) || github.sha }}
25+
group:
26+
${{ github.ref }}-${{ github.workflow }}-${{ (github.event_name ==
27+
'pull_request' && github.event.number) || (github.event_name ==
28+
'workflow_dispatch' && github.run_number) || github.sha }}
2629
cancel-in-progress: true
2730
env:
2831
CHIP_NO_LOG_TIMESTAMPS: true
29-
32+
3033
jobs:
3134
cc13xx_26xx:
3235
name: cc13xx_26xx
@@ -47,13 +50,14 @@ jobs:
4750
- name: Checkout submodules & Bootstrap
4851
uses: ./.github/actions/checkout-submodules-and-bootstrap
4952
with:
50-
platform: cc13xx_26xx
53+
platform: cc13xx_26xx
54+
extra-submodule-parameters: " --recursive"
5155
- name: Set up environment for size reports
5256
uses: ./.github/actions/setup-size-reports
5357
if: ${{ !env.ACT }}
5458
with:
55-
gh-context: ${{ toJson(github) }}
56-
59+
gh-context: ${{ toJson(github) }}
60+
5761
- name: Build examples
5862
run: |
5963
scripts/run_in_build_env.sh "\
@@ -103,4 +107,4 @@ jobs:
103107
uses: ./.github/actions/upload-size-reports
104108
if: ${{ !env.ACT }}
105109
with:
106-
platform-name: cc13x4_26x4
110+
platform-name: cc13x4_26x4

docs/guides/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
- [Silicon Labs - Software Update](./silabs_efr32_software_update.md)
2525
- [Silicon Labs - CLI Guide](./silabs_cli_guide.md)
2626
- [STMicroelectronics (STM32)](./stm32_getting_started_guide.md)
27-
- [TI - Platform Overview](./ti/ti_platform_overview.md)
27+
- [TI - Platform Overview](./ti/ti_matter_overview.md)
2828
- [Open IoT SDK - Platform Overview](./openiotsdk_platform_overview.md)
2929
- [Open IoT SDK - Examples](./openiotsdk_examples.md)
3030
- [Open IoT SDK - Unit Tests](./openiotsdk_unit_tests.md)

docs/guides/darwin.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ Example:
267267
- [Silicon Labs](./silabs_getting_started.md)
268268
- [Simulated Linux](./simulated_device_linux.md)
269269
- [Telink](/examples/lighting-app/telink/README.md)
270-
- [TI Platform](./ti/ti_platform_overview.md)
270+
- [TI Platform](./ti/ti_matter_overview.md)
271271
- [TI All Clusters](/examples/all-clusters-app/cc13x4_26x4/README.md)
272272
- [Tizen](/examples/lighting-app/tizen/README.md)
273273

101 KB
Loading

docs/guides/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ and features.
1111
*
1212
esp32/README
1313
nxp/README
14-
ti/ti_platform_overview
14+
ti/ti_matter_overview
1515
```
1616

1717
## Build Guides
@@ -40,7 +40,7 @@ ti/ti_platform_overview
4040
- [Silicon Labs - Getting Started](./silabs_getting_started.md)
4141
- [Silicon Labs - Software Update](./silabs_efr32_software_update.md)
4242
- [Silicon Labs - CLI Guide](./silabs_cli_guide.md)
43-
- [TI - Platform Overview](./ti/ti_platform_overview.md)
43+
- [TI - Platform Overview](./ti/ti_matter_overview.md)
4444

4545
## Tool Guides
4646

docs/guides/ti/matter_cc2674_migration.md docs/guides/ti/matter-migration-guide/matter_cc2674_migration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ The GPIO pin values for SPI will need to be adjusted based on your design.
5050
4. Select _Board_ as _None_ and _Device_ as _`CC2674P10RGZ`_, Unselect
5151
_`Lock PinMux`_, and click _Confirm_.
5252
5. To fix errors, make the following module changes:
53-
- _RF Design_ and _RF Stacks -> BLE -> Radio_: click on _accepting the
54-
current value_, which should be _`LP_CC2674P10_RGZ`_ in the drop down menu
55-
for _Based On RF Design_
53+
- _RF Design_ and _RF Stacks -> Bluetooth LE -> Radio_: click on _accepting
54+
the current value_, which should be _`LP_CC2674P10_RGZ`_ in the drop down
55+
menu for _Based On RF Design_
5656
- _TI DEVICES -> Device Configuration_: Clear
5757
_`XOSC Cap Array Modification`_
5858
- _TI DRIVERS -> RF_: Set _Global Event Mask_ as _None_ and _No. of Antenna
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Get started with SysConfig
2+
3+
System Configuration Tool (SysConfig) is a graphical interface for configuring
4+
your project. Configuration files, C source files and header files are generated
5+
based on the parameters configured in the SysConfig dashboard.
6+
7+
SysConfig should be used as a standalone tool for script-based builds (such as
8+
for Matter).
9+
10+
The document will help for getting started in tailoring the `syscfg` file to
11+
your application needs.
12+
13+
## Using Stand-alone SysConfig
14+
15+
You can find the standalone SysConfig tool on the
16+
[SysConfig Standalone Installer Download Page](https://www.ti.com/tool/SYSCONFIG).
17+
18+
The location of the Matter `syscfg` file is located here:
19+
`/examples/<name>/cc13x4_26x4/chip.syscfg` For example, on the github web:
20+
`https://github.com/project-chip/connectedhomeip/blob/master/examples/lock-app/cc13x4_26x4/chip.syscfg`
21+
The local file in your cloned repository should be used.
22+
23+
This file is used by Matter build scripts, when it invokes SysConfig CLI. In
24+
order to edit the file for your custom application configurations, you'll need
25+
to open the file with the SysConfig GUI. Before doing so, you should add the
26+
following line above the `/* Modules */` comment:
27+
28+
```
29+
// @cliArgs --product <path to SDK>/.metadata/product.json --board /ti/boards/LP_EM_CC1354P10_6 --rtos freertos
30+
```
31+
32+
As an example, after adding the necessary `<path to SDK>`, it would look like:
33+
34+
```
35+
// @cliArgs --product /home/Documents/repos/connectedhomeip/third_party/ti_simplelink_sdk/repo_cc13xx_cc26xx/.metadata/product.json --board /ti/boards/LP_EM_CC1354P10_6 --rtos freertos
36+
```
37+
38+
If the file is not found, then you may need to first initialize the submodules:
39+
40+
```
41+
git submodule update --init
42+
```
43+
44+
Now you can open the file in SysConfig GUI. Once you are done, remove the
45+
`@cliArgs` line then save the file. Now the Matter build scripts will use the
46+
updated `.syscfg` file.
47+
48+
## Viewing SysConfig Output
49+
50+
To preview the code to be generated reference the `Generated Files` image, the
51+
button at the top of the `Configuration` pane you will find a list of Generated
52+
Files. After selecting a file you will be able, in real-time, to identify how
53+
the changes in the GUI affect the generated files. This will help you review the
54+
relationship between the GUI and the code.
55+
56+
<div style="text-align: center;">
57+
<img src="images/generated_files_ble.png" alt="Generated Files" width=30%>
58+
<div class="caption">Generated Files</div>
59+
</div>
60+
61+
Whenever you re-build the project, SysConfig will re-generate the files. Because
62+
of this, any changes made directly in the generated files will be overwritten.
Loading
Loading
Loading
Loading
Loading
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Configure The Board Files with SysConfig
2+
3+
The board view shows you what pins are available on your board, and what
4+
peripherals are assigned to what pins. Hover over each pin for more information.
5+
6+
<div style="text-align: center;">
7+
<img src="./images/board_view.png" width=20%>
8+
</div>
9+
10+
Enabled and configured peripherals are displayed with green symbols. To add a
11+
new peripheral, press the plus sign next to the peripheral type. The \"Show
12+
generated files\" tab lets you see the files generated based on SysConfig.
13+
Generated files are dynamically updated every time you make a change in
14+
SysConfig. When you build your project, the generated files are exported into
15+
the output folder of your project.
16+
17+
<div style="text-align: center;">
18+
<img src="images/show_generated_files_tab.png">
19+
</div>
20+
21+
## Reserve Peripherals
22+
23+
Certain use cases may require preventing SysConfig from generating the
24+
configuration of specific peripherals.
25+
26+
Examples of use cases requiring to reserve peripherals are:
27+
28+
- dynamic re-configuration of a peripheral
29+
- leveraging the Sensor Controller (on devices enabling it)
30+
- already handling certain peripherals configuration
31+
- with hardware constraints preventing to use certain peripherals (typically
32+
`GPIOs`)
33+
- peripherals reserved for future use
34+
35+
Below are the steps required to utilize the Reserve Peripherals feature.
36+
37+
1. Open the `.syscfg` file using the SysConfig GUI
38+
39+
2. Open the panel \"Reserve Peripherals\"
40+
41+
<div style="text-align: center;">
42+
<img src="images/reserve-peripheral-panel.png" width=30%>
43+
</div>
44+
45+
3. Reserve the resources
46+
47+
Reserve a peripheral using SysConfig. This image shows how to reserve `DIO`
48+
15
49+
50+
<div style="text-align: center;">
51+
<img src="images/reserve-gpio.png" width=30%>
52+
</div>
53+
54+
SysConfig ensures no resource conflict occurs. In case no solution can be found,
55+
an error is raised.
56+
57+
## Hardware View
58+
59+
The Hardware view may be used to add software modules for supporting hardware
60+
resources on EVMs or LaunchPads. The same capability could be done in the
61+
Software view by adding a Hardware. However the Hardware view provides a
62+
hardware-first perspective to show which software could be used with hardware
63+
resources.
64+
65+
Sysconfig Hardware View:
66+
67+
<div style="text-align: center;">
68+
<img src="images/hardware_view.png" width=30%>
69+
</div>

docs/guides/ti/enabling_icd_on_ti_devices.md docs/guides/ti/matter-users-guide/enabling_icd_on_ti_devices.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Configuring Intermittently Connected Devices on TI CC13x4 Platforms
1+
# Configuring Intermittently Connected Devices on TI SimpleLink CC13x4_CC26x4 Platforms
22

33
## Overview
44

55
Intermittently Connected Devices are devices in a network that do not always
66
need to be active. Matter has defined a cluster that helps capture this
77
behavior; this configuration is ideal for devices that need to operate with low
88
power consumption or do not have a need to always be on the network. Matter
9-
examples on the TI CC13x4 platform can be configured to act as ICDs.
9+
examples on the TI CC13x4_CC26x4 platform can be configured to act as ICDs.
1010

1111
## Platform Code Changes
1212

docs/guides/ti/ti_factory_data_user_guide.md docs/guides/ti/matter-users-guide/ti_factory_data_user_guide.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ programming infrastructure for their Matter devices.
1616
TI Matter examples allow the use of factory data in the following two ways:
1717

1818
- **Example Out of Box Factory Data** : Use TI example DAC values to get
19-
started. This is intended to be used when just starting with Matter or
20-
during development until customer or product specific data is not required.
19+
started. This is intended to be used during development.
2120
- **Custom factory data** : Allows users to configure custom factory data via
2221
a JSON file. The custom values are then processed by a script provided by TI
2322
and merged with the Matter application to create a binary that can be
@@ -50,9 +49,9 @@ Each element is described in more detail below:
5049

5150
## How to use
5251

53-
Out of box factory data location is configured to be on second last page of
54-
flash. For CC13x4, the starting address is `0xFE800`. This can be configured in
55-
the linker file.
52+
Out of box factory data location is configured to be on second to last page of
53+
flash. For CC13x4_CC26x4, the starting address is `0xFE800`. This can be
54+
configured in the linker file.
5655

5756
To configure:
5857

@@ -94,7 +93,7 @@ FLASH_FACTORY_DATA (R) : ORIGIN = 0x000fe800, LENGTH = 0x00000900
9493

9594
3. In the example's args.gni file, set 'custom_factory_data' to true
9695

97-
It is recommended to keep 2 dedicated pages for CC13x4 for factory data.
96+
It is recommended to keep 2 dedicated pages for CC13x4_CC26x4 for factory data.
9897

9998
### Formatting certs and keys for JSON file
10099

0 commit comments

Comments
 (0)