|
| 1 | +.. _tlst9518adk80d: |
| 2 | + |
| 3 | +Telink TLSR9518ADK80D |
| 4 | +##################### |
| 5 | + |
| 6 | +Overview |
| 7 | +******** |
| 8 | + |
| 9 | +The TLSR9518A Generic Starter Kit is a hardware platform which |
| 10 | +can be used to verify the `Telink TLSR9 series chipset`_ and develop applications |
| 11 | +for several 2.4 GHz air interface standards including Bluetooth 5.2 (Basic data |
| 12 | +rate, Enhanced data rate, LE, Indoor positioning and BLE Mesh), |
| 13 | +Zigbee 3.0, Homekit, 6LoWPAN, Thread and 2.4 Ghz proprietary. |
| 14 | + |
| 15 | +.. figure:: img/tlsr9518adk80d.jpg |
| 16 | + :width: 400px |
| 17 | + :align: center |
| 18 | + :alt: TLSR9518ADK80D |
| 19 | + |
| 20 | +More information about the board can be found at the `Telink B91 Generic Starter Kit Hardware Guide`_ website. |
| 21 | + |
| 22 | +Hardware |
| 23 | +******** |
| 24 | + |
| 25 | +The TLSR9518A SoC integrates a powerful 32-bit RISC-V MCU, DSP, AI Engine, 2.4 GHz ISM Radio, 256 |
| 26 | +KB SRAM (128 KB of Data Local Memory and 128 KB of Instruction Local Memory), external Flash memory, |
| 27 | +stereo audio codec, 14 bit AUX ADC, analog and digital Microphone input, PWM, flexible IO interfaces, |
| 28 | +and other peripheral blocks required for advanced IoT, hearable, and wearable devices. |
| 29 | + |
| 30 | +.. figure:: img/tlsr9518_block_diagram.jpg |
| 31 | + :width: 400px |
| 32 | + :align: center |
| 33 | + :alt: TLSR9518ADK80D_SOC |
| 34 | + |
| 35 | +The TLSR9518ADK80D default board configuration provides the following hardware components: |
| 36 | + |
| 37 | +- RF conducted antenna |
| 38 | +- 1 MB External Flash memory with reset button |
| 39 | +- Chip reset button |
| 40 | +- Mini USB interface |
| 41 | +- 4-wire JTAG |
| 42 | +- 4 LEDs, Key matrix up to 4 keys |
| 43 | +- 2 line-in function (Dual Analog microphone supported when switching jumper from microphone path) |
| 44 | +- Dual Digital microphone |
| 45 | +- Stereo line-out |
| 46 | + |
| 47 | +Supported Features |
| 48 | +================== |
| 49 | + |
| 50 | +The Zephyr TLSR9518ADK80D board configuration supports the following hardware features: |
| 51 | + |
| 52 | ++----------------+------------+------------------------------+ |
| 53 | +| Interface | Controller | Driver/Component | |
| 54 | ++================+============+==============================+ |
| 55 | +| PLIC | on-chip | interrupt_controller | |
| 56 | ++----------------+------------+------------------------------+ |
| 57 | +| RISC-V Machine | on-chip | timer | |
| 58 | +| Timer (32 KHz) | | | |
| 59 | ++----------------+------------+------------------------------+ |
| 60 | +| PINMUX | on-chip | pinmux | |
| 61 | ++----------------+------------+------------------------------+ |
| 62 | +| GPIO | on-chip | gpio | |
| 63 | ++----------------+------------+------------------------------+ |
| 64 | +| UART | on-chip | serial | |
| 65 | ++----------------+------------+------------------------------+ |
| 66 | + |
| 67 | +The following example projects are supported: |
| 68 | + |
| 69 | +- samples/hello_world |
| 70 | +- samples/synchronization |
| 71 | +- samples/philosophers |
| 72 | +- samples/basic/threads |
| 73 | +- samples/basic/blinky |
| 74 | +- samples/basic/button |
| 75 | +- samples/subsys/console/echo |
| 76 | +- samples/subsys/console/getchar |
| 77 | +- samples/subsys/console/getline |
| 78 | +- samples/subsys/shell/shell_module |
| 79 | +- samples/subsys/cpp/cpp_synchronization |
| 80 | + |
| 81 | +.. note:: |
| 82 | + To support "button" example project PC3-KEY3 (J20-19, J20-20) jumper needs to be removed and KEY3 (J20-19) should be connected to VDD3_DCDC (J51-13) externally. |
| 83 | + |
| 84 | + For the rest example projects use the default jumpers configuration. |
| 85 | + |
| 86 | +Other hardware features and example projects are not supported yet. |
| 87 | + |
| 88 | +Limitations |
| 89 | +----------- |
| 90 | + |
| 91 | +- Maximum 3 GPIO pins could be configured to generate interrupts simultaneously. All pins must be related to different ports and use different IRQ numbers. |
| 92 | +- DMA mode is not supported by Serial Port. |
| 93 | +- UART hardware flow control is not implemented. |
| 94 | + |
| 95 | +Default configuration and IOs |
| 96 | +============================= |
| 97 | + |
| 98 | +System Clock |
| 99 | +------------ |
| 100 | + |
| 101 | +The TLSR9518ADK80D board is configured to use the 24 MHz external crystal oscillator |
| 102 | +with the on-chip PLL/DIV generating the 48 MHz system clock. |
| 103 | +The following values also could be assigned to the system clock in the board DTS file |
| 104 | +(``boards/riscv/tlsr9518adk80d/tlsr9518adk80d.dts``): |
| 105 | + |
| 106 | +- 16000000 |
| 107 | +- 24000000 |
| 108 | +- 32000000 |
| 109 | +- 48000000 |
| 110 | +- 64000000 |
| 111 | +- 96000000 |
| 112 | + |
| 113 | +.. code-block:: |
| 114 | +
|
| 115 | + &cpu0 { |
| 116 | + clock-frequency = <48000000>; |
| 117 | + }; |
| 118 | +
|
| 119 | +PINs Configuration |
| 120 | +------------------ |
| 121 | + |
| 122 | +The TLSR9518A SoC has five GPIO controllers (PORT_A to PORT_E), but only two are |
| 123 | +currently enabled (PORT_B for LEDs control and PORT_C for buttons) in the board DTS file: |
| 124 | + |
| 125 | +- LED0 (blue): PB4, LED1 (green): PB5, LED2 (white): PB6, LED3 (red): PB7 |
| 126 | +- Key Matrix SW0: PC2_PC3, SW1: PC2_PC1, SW2: PC0_PC3, SW3: PC0_PC1 |
| 127 | + |
| 128 | +Peripheral's pins on the SoC are mapped to the following GPIO pins in the |
| 129 | +``boards/riscv/tlsr9518adk80d/tlsr9518adk80d.dts`` file: |
| 130 | + |
| 131 | +- UART0 RX: PB2, TX: PB3 |
| 132 | +- UART1 RX: PC6, TX: PC7 |
| 133 | + |
| 134 | +Serial Port |
| 135 | +----------- |
| 136 | + |
| 137 | +The TLSR9518A SoC has 2 UARTs. The Zephyr console output is assigned |
| 138 | +to UART0 in the ``boards/riscv/tlsr9518adk80d/tlsr9518adk80d_defconfig`` file. |
| 139 | +The default settings are 115200 8N1. |
| 140 | + |
| 141 | +Programming and debugging |
| 142 | +************************* |
| 143 | + |
| 144 | +Building |
| 145 | +======== |
| 146 | + |
| 147 | +You can build applications in the usual way. Here is an example for |
| 148 | +the "hello_world" application. |
| 149 | + |
| 150 | +.. code-block:: console |
| 151 | +
|
| 152 | + # From the root of the zephyr repository |
| 153 | + west build -b tlsr9518adk80d samples/hello_world |
| 154 | +
|
| 155 | +To use `Telink RISC-V Linux Toolchain`_, ``ZEPHYR_TOOLCHAIN_VARIANT`` and ``CROSS_COMPILE`` variables need to be set. |
| 156 | + |
| 157 | +.. code-block:: console |
| 158 | +
|
| 159 | + # Set Zephyr toolchain variant to cross-compile |
| 160 | + export ZEPHYR_TOOLCHAIN_VARIANT=cross-compile |
| 161 | + # Specify the Telink RISC-V Toolchain location |
| 162 | + export CROSS_COMPILE=~/toolchains/nds32le-elf-mculib-v5f/bin/riscv32-elf- |
| 163 | + # From the root of the zephyr repository |
| 164 | + west build -b tlsr9518adk80d samples/hello_world |
| 165 | +
|
| 166 | +`Telink RISC-V Linux Toolchain`_ is available on the `Burning and Debugging Tools for TLSR9 Series in Linux`_ page. |
| 167 | + |
| 168 | +Open a serial terminal with the following settings: |
| 169 | + |
| 170 | +- Speed: 115200 |
| 171 | +- Data: 8 bits |
| 172 | +- Parity: None |
| 173 | +- Stop bits: 1 |
| 174 | + |
| 175 | +Flash the board, reset and observe the following messages on the selected |
| 176 | +serial port: |
| 177 | + |
| 178 | +.. code-block:: console |
| 179 | +
|
| 180 | + *** Booting Zephyr OS version 2.5.0 *** |
| 181 | + Hello World! tlsr9518adk80d |
| 182 | +
|
| 183 | +
|
| 184 | +Flashing |
| 185 | +======== |
| 186 | + |
| 187 | +In order to flash the TLSR9518ADK80D board check the following resources: |
| 188 | + |
| 189 | +- `Burning and Debugging Tools for all Series`_ |
| 190 | +- `Burning and Debugging Tools for TLSR9 Series`_ |
| 191 | +- `Burning and Debugging Tools for TLSR9 Series in Linux`_ |
| 192 | + |
| 193 | +Debugging |
| 194 | +========= |
| 195 | + |
| 196 | +Supporting UART debug and OpenOCD+GDB. |
| 197 | + |
| 198 | +References |
| 199 | +********** |
| 200 | + |
| 201 | +.. target-notes:: |
| 202 | + |
| 203 | +.. _Telink TLSR9 series chipset: http://wiki.telink-semi.cn/wiki/chip-series/TLSR9-Series/ |
| 204 | +.. _Telink B91 Generic Starter Kit Hardware Guide: http://wiki.telink-semi.cn/wiki/Hardware/B91_Generic_Starter_Kit_Hardware_Guide/ |
| 205 | +.. _Telink RISC-V Linux Toolchain: http://wiki.telink-semi.cn/tools_and_sdk/Tools/IDE/telink_riscv_linux_toolchain.zip |
| 206 | +.. _Burning and Debugging Tools for all Series: http://wiki.telink-semi.cn/wiki/IDE-and-Tools/Burning-and-Debugging-Tools-for-all-Series/ |
| 207 | +.. _Burning and Debugging Tools for TLSR9 Series: http://wiki.telink-semi.cn/wiki/IDE-and-Tools/Burning-and-Debugging-Tools-for-TLSR9-Series/ |
| 208 | +.. _Burning and Debugging Tools for TLSR9 Series in Linux: http://wiki.telink-semi.cn/wiki/IDE-and-Tools/BDT_for_TLSR9_Series_in_Linux/ |
0 commit comments