Skip to content

Commit

Permalink
* Add FAQ doc, and modify slogic doc
Browse files Browse the repository at this point in the history
  • Loading branch information
lxowalle committed Sep 12, 2023
1 parent 4bccaaf commit b4a33a7
Show file tree
Hide file tree
Showing 17 changed files with 262 additions and 71 deletions.
74 changes: 74 additions & 0 deletions docs/hardware/en/logic_analyzer/combo8/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
title: FAQ
keywords: LogicAnalyzer, debugger, link, RISCV, tool
update:
- date: 2023-09-12
version: v0.1
author: lxo
content:
- Release docs
---

The following lists some common problems according to the form of Q&A, please try to find a solution in the following if you find any problem when using it, if the above record doesn't solve your problem, you can try to ask the question in [Community](https://maixhub.com/discussion), reasonable questions will be answered by the technical staff for you.

## General Question

**Q:**There are some functional defects when using the logic analyzer/DAPLink/JLink/serial port module.

**A:**Please try to find and resolve your issue first in the Q&A section. If the problem persists, click [here](./update_firmware.md) to update the firmware and try again.


**Q:**The LED doesn't change after pressing the button?

**A:**Check that the interval between key presses is not less than 100ms, otherwise it may cause the module to enter boot mode and you will see that LED no longer change. If this occurs, re-power up the module to restore it

## Logic Analyzer

**Q:** After clicking "run", the prompt "device closed but should be open."

![image-20230816113213933](./../../../zh/logic_analyzer/combo8/assets/use_logic_function/tips_capture_failed.png)

**A:**This may be the result of unstable contact that causes the device to disconnect, try to re-plug the device and then reconnect it to solve the problem.

**Q:**When using 8-channel sampling, it was found that waveforms also appeared when the D7 channel was not connected.

**A:**This is a problem to be solved, but this problem will not affect the sampled waveforms, and the waveform can still be acquired normally after connecting an external signal to the D7 channel.

**Q:**When sampling waveforms, the waveforms in the display window do not match the actual waveforms.

**A:**Make sure that you connect the GND wire of the logic analyser to the GND of the target device, and make sure that the GND wire is as close as possible to the location of the point to be measured. Be aware that even at a distance of 1cm, there may be many components in between that can interfere with the signal, so even 1cm closer is likely to give better signal quality.

**Q:**Logic analyser can't sample for long periods of time

**A:**There are multiple situations:

**Situation 1:** Sampling time is very small due to incorrect setting of sampling points and sampling rate, sampling time (unit:s) = sampling points/sampling rate, please make sure that the sampling points and sampling rate are set correctly.

**Situation 2:** Effect from PC performance. As PulseView needs to use a lot of USB bandwidth, but if the PC performance is poor at this time, it will also result in shorter sampling times.

**Situation 3:** If everything is fine, check if the number of sampling points is set too large, resulting in a memory overflow that prevents sampling



## DAPLink

**Q:**MDK can't find DAPLink device

**A:**It is possible that the MDK version is too low, and a low version of MDK may not be able to recognise DAPLink (the MDK version used for testing in this article is V5.38). If the MDK version is too low to recognise DAPLink, if you don't want to upgrade the version, you can refer to the method [here](https://developer.arm.com/documentation/ka003663/latest/) to update the debug driver of CMSIS-DAP.

**Q:**The serial port function in DAPLink mode does not work properly and messages are echoed back

**A:**Please refer [here](./update_firmware.md) to update the firmware to the latest version before trying again


## CKLink

None


## Serial Module

**Q:**The serial terminal cannot open the serial port.

**A:**Try using a different serial terminal. For Windows, you can try using XCOM, and for Linux, you can try using Minicom.

9 changes: 8 additions & 1 deletion docs/hardware/en/logic_analyzer/combo8/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ In Windows environment, the SLogic Combo 8 has maximum transmission bandwidth of
| Maximum Baud Rate | 2x20Mbps+2x1Mbps |
| Total Bandwidth | 42Mbps |

## Get started now
## Get Started Now

Click the link below to enter the corresponding chapter:
[Basic Operation](./basic_operation.md)
Expand All @@ -62,3 +62,10 @@ Click the link below to enter the corresponding chapter:
[Using as DAPLink](./use_daplink_function.md)
[Using as Serial Module](./use_fouruart_function.md)
[Update firmware](./update_firmware.md)

## Others Links

[Sipeed Download station](https://dl.sipeed.com/shareURL/SLogic/SLogic_combo_8/4_application/Firmware)
[Forum](maixhub.com/discussion)

Support Email:[email protected]
2 changes: 2 additions & 0 deletions docs/hardware/en/logic_analyzer/combo8/update_firmware.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Firmware: [Click to download](https://dl.sipeed.com/shareURL/SLogic/SLogic_combo

Just select the latest version of the burning tool and firmware, and unzip it after downloading.

> Note:When the firmware is named `slogic_combo8_pack_202308171404.bin`, the date is 17/08/2023. The date naming rules are similar for other firmware.
## Configure Tool

1. Start the tool
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,5 @@ The pins on the right side of the diagram (TCK, TDI, TDO, TMS) are used for DAPL

![start_debugger_in_mdk](./../../../zh/logic_analyzer/combo8/assets/use_daplink_function/start_debugger_in_mdk.png)

## Issues

1. Can't find DAPLink device

- Check if the MDK version is too low, as older versions of MDK may not recognize DAPLink. The MDK version used in this document for testing is V5.38.
- If the low MDK version is causing DAPLink recognition issues and you prefer not to upgrade, you can refer to the methods provided [here](https://developer.arm.com/documentation/ka003663/latest/) to update the debug driver for CMSIS-DAP.

Thank you for the document contribution from 'dragonforward'.

65 changes: 44 additions & 21 deletions docs/hardware/en/logic_analyzer/combo8/use_logic_function.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,16 @@ Press the button to switch the indicator light to blue. As shown below:

The above diagram shows the pinout for the 8 channels of SLogic. Connect the target device's test signal points to any available CH port on SLogic, and ensure that the ground of the target device is connected to the ground of SLogic.

> Note: The GND line of the SLogic needs to be as close as possible to the location of the point to be measured, even 1cm closer may increase the quality of the sample.
#### Downloading and Running the Host Computer

[Download PulseView](https://dl.sipeed.com/shareURL/SLogic/SLogic_combo_8/4_application/PulseView)

PulseView is used for observing digital signals and decoding. Windows users should download files with the .exe extension, while Linux users should download files with the .AppImage extension. It is recommended to download the latest version with the most recent date.

> Note:When the software is named `PulseView-xxxx-230811-xxx.AppImage`, the date is 11/08/2023. The date naming rules are similar for other software.
Linux Environment:

1. After downloading, navigate to the directory where the software is located. Open the terminal using the shortcut CTRL+ALT+T. Then, use the following command to give the software execution permissions and run it with administrator privileges:
Expand All @@ -55,23 +59,54 @@ Windows Environment:

> Note: In the Linux environment, the maximum supported sampling rate is 80M for 4 channels and 40M for 8 channels. Due to limitations in USB transmission stability on Windows, the maximum supported sampling rate is 80M for 2 channels and 20M for 8 channels.
### Starting Sampling

1. Configure the channel count, sample count, and sampling rate in PulseView.
#### Scan SLogic and Connect

The connection will be made automatically on first startup, or you can choose to connect SLogic manually.

**Steps for manual connection**

1. Click on "Scan for devices xxx" to scan for devices.

2. 选择"SIPEED USB TO LA xxx" and click OK to connect the device.

![image-20230912140845449](./../../../zh/logic_analyzer/combo8/assets/use_logic_function/set_connect_cfg_of_pulseview.png)

#### Ready to Sample

1. Set the sampling parameters

The following figure sets the number of channels to **8**, the number of samples to **1M samples**, and the sampling rate to **10Mhz**. At this time the **sampling time** is 1M / 10Mhz = 0.1s

_In the following example, the channel count is set to **8**, the sample count is **1M samples**, and the sampling rate is **10MHz**._
![equ_selec_complete_of_pulseview](./../../../zh/logic_analyzer/combo8/assets/use_logic_function/equ_selec_complete_of_pulseview.png)

2. Set the trigger type for channel D0 to **Rising/Falling Edge Trigger**.
#### Start Sampling

1. Click on the "run" button to start sampling.

![waveform_fast_of_pulseview](./../../../zh/logic_analyzer/combo8/assets/use_logic_function/waveform_fast_of_pulseview.png)

_Click on the label icon of channel D0 to set the trigger type._
![set_channel_of_pulseview](./../../../zh/logic_analyzer/combo8/assets/use_logic_function/set_channel_of_pulseview.png)
> Note:If the D7 channel is not used during the sampling process, a level inversion of the channel may be observed, but this is normal and does not affect normal use.
3. Start the capture to obtain the sampling result.
#### Analyze the Sampling Result

![waveform_fast_of_pulseview](./../../../zh/logic_analyzer/combo8/assets/use_logic_function/waveform_fast_of_pulseview.png)
1. Open the protocol analysis function

> If you're not using channel D7 during the sampling process, you might observe a level inversion phenomenon on that channel. This phenomenon is normal and does not affect regular usage.
![image-20230912150905946](./../../../zh/logic_analyzer/combo8/assets/use_logic_function/open_ptl_field.png)

2. Select the target protocol

![image-20230912153947189](./../../../zh/logic_analyzer/combo8/assets/use_logic_function/select_the_target_protocol.png)

3. Configure the protocol parameters

![image-20230912152007703](./../../../zh/logic_analyzer/combo8/assets/use_logic_function/config_param_of_protocol.png)

4. Observe the analysis results

![image-20230912152105530](./../../../zh/logic_analyzer/combo8/assets/use_logic_function/observe_the_analysis_res.png)

Based on the results of the analysis, let's start debugging.

### Detailed Configuration

Expand Down Expand Up @@ -179,18 +214,6 @@ After capturing the required data, protocol decoding can be used to analyze the

![spi_26mhz](./../../../zh/logic_analyzer/combo8/assets/use_logic_function/logic_spi_26mhz.jpg)


### Issues
1. Q:After clicking "Run," a popup window shows the message "device closed but should be open."

![image-20230816113213933](./assets/tips_capture_failed.png)

A:This could be due to an unstable connection leading to the device being disconnected. Try unplugging and re-plugging the device, and then reconnecting to resolve the issue.

2. Q:When using 8-channel acquisition, it is found that the D7 channel will also have a waveform when it is suspended

A:We are very sorry that this problem has caused trouble to you. This is a problem that needs to be solved, but it will not affect waveform collection. After connecting an external signal to the D7 channel, you can collect waveforms normally. If you don't want to observe this phenomenon, you can also hide this channel.

### Precautions

When connecting the logic analyzer to the system under test, please note the following precautions:
Expand Down
4 changes: 3 additions & 1 deletion docs/hardware/en/sidebar.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -253,8 +253,10 @@ items:
file: logic_analyzer/combo8/use_daplink_function.md
- label: Using as Serial Module
file: logic_analyzer/combo8/use_fouruart_function.md
- label: Update firmware
- label: Update Firmware
file: logic_analyzer/combo8/update_firmware.md
- label: FAQ
file: logic_analyzer/combo8/faq.md
# - label: Maix Audio
# items:
# - label: MA USB 16
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
76 changes: 76 additions & 0 deletions docs/hardware/zh/logic_analyzer/combo8/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
title: 常见问题(FAQ)
keywords: LogicAnalyzer, debugger, link, RISCV, tool
update:
- date: 2023-09-12
version: v0.1
author: lxo
content:
- Release docs
---

以下按照Q&A的形式列举了一些常见的问题,使用过程遇到任何问题时请在下文中尝试寻找解决方法,如果上述记录并没有解决你的问题,可以尝试在[社区](https://maixhub.com/discussion)中反馈该问题,合理的问题会有技术人员或其他开发者为您解答。

## 综合问题

**Q:**使用逻辑分析仪/DAPLink/CKLink/串口模块时有部分功能异常

**A:**请优先在Q&A中尝试找到并解决你的问题,如果仍有问题,则点击[这里](./update_firmware.md)更新固件后再尝试



**Q:**按下按键后,指示灯没有变化?

**A:**检查是否按下的频率太快,按下按键的间隔不要小于100ms,否则可能导致模块进入boot模式,现象会看到灯不再变化。如果遇到了该情况,尝试重新上电即可恢复

## 逻辑分析仪

**Q:**点击run后弹窗提示"device closed but should be open"

![image-20230816113213933](./assets/use_logic_function/tips_capture_failed.png)

**A:**这可能是接触不稳定导致设备断连了,尝试重新插拔设备后再重新连接即可

**Q:**使用8通道采集时发现D7通道在悬空时也会出现波形

**A:**这是一个待解决的问题,但这个问题不会影响采集波形,给D7通道接入外部信号后仍然可以正常采集波形。如果不需要这个通道时也可以隐藏这个通道,很抱歉给您带来了困扰。

**Q:**波形采集时,波形显示窗口中的波形和实际的波形不一致

**A:**请确保将逻辑分析仪的GND线连接到了目标设备的GND,并且确保GND线离待测点的位置越近越好。要知道即使是1cm的距离,中间也可能有很多元器件会干扰信号,所以哪怕是更近1cm也有可能让信号质量更好。

**Q:**逻辑分析仪无法长时间采样

**A:**有多种情况影响无法长时间采样:

**情况1:**采样点数和采样率设置不正确导致采样时间很小,采样时间(单位:s)=采样点数/采样率,请确保采样点数和采样率设置正确。
**情况2:**PC性能的影响。由于PulseView需要使用大量的USB带宽,但是如果此时PC本身性能不足,也会导致采样时间变短。
**情况3:**PC内存的影响。如果一切都正常,那么检查一下是否是采样点数设置太大,导致内存不足以保存采样数据



## DAPLink

**Q:**MDK找不到DAPLink设备

**A:**有可能是MDK版本过低的原因,低版本的MDK可能无法识别DAPLink(本文测试使用的MDK版本是V5.38)。如果MDK版本低导致无法识别DAPLink,但是不想升级版本,可以参考[这里](https://developer.arm.com/documentation/ka003663/latest/)的方法来更新CMSIS-DAP的调试驱动

**Q:**DAPLink模式的串口功能无法正常使用,出现回显的情况

**A:**请在更新固件章节中将固件更新到最新版本后再尝试



## CKLink

None




## 串口模块

**Q:**串口终端无法打开串口

**A:**尝试一下其他的串口助手,Windows上可以尝试使用XCOM,Linux上可以尝试使用Minicom

8 changes: 8 additions & 0 deletions docs/hardware/zh/logic_analyzer/combo8/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,11 @@ SLogic Combo 8是一款兼有逻辑分析仪、CKLink Debugger、DAP-Link Debugg
[作为DAPLink使用](./use_daplink_function.md)
[作为串口模块使用](./use_fouruart_function.md)
[更新固件](./update_firmware.md)

## 其他链接

[淘宝](https://item.taobao.com/item.htm?spm=a21n57.1.0.0.14dd523cuZ61oI&id=737788586308&ns=1&abbucket=5#detail)
[Sipeed 下载站](https://dl.sipeed.com/shareURL/SLogic/SLogic_combo_8/4_application/Firmware)
[交流论坛](maixhub.com/discussion)

联系邮箱:[email protected]
2 changes: 2 additions & 0 deletions docs/hardware/zh/logic_analyzer/combo8/update_firmware.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ update:

烧录工具和固件选择最新版本即可,下载完成后自行解压

> 注:当固件名为`slogic_combo8_pack_202308171404.bin`时,日期为2023年08月17日。其他固件的日期命名规则类似。
## 配置烧录工具

1. 启动烧录工具
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,4 @@ DAPLink模式下可以同时支持一路DAPLink和一路UART

![start_debugger_in_mdk](./assets/use_daplink_function/start_debugger_in_mdk.png)

## 问题

1. MDK找不到DAPLink设备
- 检查MDK版本是否过低,低版本的MDK可能无法识别DAPLink。本文测试使用的MDK版本是V5.38
- 如果MDK版本低导致无法识别DAPLink,但是不想升级版本,可以参考[这里](https://developer.arm.com/documentation/ka003663/latest/)的方法来更新CMSIS-DAP的调试驱动

感谢群友`dragonforward`的文档贡献
Loading

0 comments on commit b4a33a7

Please sign in to comment.