swisskyrepo
/
HardwareAllTheThings
mirror of https://github.com/swisskyrepo/HardwareAllTheThings.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'swisskyrepo:main' into ics

pull/17/head
Aagam Shah 2022-10-16 23:24:06 +05:30 committed by GitHub
parent e0c07b9f64 54b18bfe8c
commit 7ebfd11974
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 118 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

177
docs/debug-interfaces/uart.md
View File

@ -1,91 +1,154 @@
# UART # UART
## Table of contents
### Summary * [What is it ?](#what-is-it-)
* [Identifying UART ports](#identifying-uart-ports)
* What is it ? * [Using a multimeter](#using-a-multimeter)
* Identifying UART Ports * [Using a logic analyzer](#using-a-logic-analyzer)
* Connect to serial port * [Connect to serial port](#connect-to-serial-port)
* Detect baudrate * [WARNING](#warning)
* Interact with the /dev/ttyUSB0 * [Examples](#examples)
* UART over BLE * [Connection using a USB to TTL](#connection-using-a-usb-to-ttl)
* Examples * [Detect the baud rate](#detect-the-baud-rate)
* [Interact with UART](#interact-with-uart)
* [UART over BLE](#uart-over-ble)
* [Examples](#examples)
## What is it ? ## What is it ?
UART stands for Universal asynchronous receiver transmitter. Used for serial communications over a computer or peripheral device serial port. UART stands for Universal asynchronous receiver transmitter. Used for serial communications over a computer or peripheral device serial port.
UART peripherals are commonly integrated in many embedded devices. UART communication makes use of baud rate to maintain synchronism between two devices. The baud rate is the rate at which information is transferred in a communication channel. UART peripherals are commonly integrated in many embedded devices. UART communication makes use of baud rate to maintain synchronism between two devices. The baud rate is the rate at which information is transferred in a communication channel.
With access to the UART, a user can see bootloader and operating system logs. With access to the UART, a user can see bootloader and operating-system logs.
Generaly, the line is held high (at a logical 1 value) while UART is in idle state. Generally, the line is held high (at a logical 1 value) while UART is in idle state.
We call the most common configuration 8N1 : eight data bits, no parity, and 1 stop bit. We call the most common configuration **8N1**: eight data bits, no parity, and 1 stop bit.
## Identifying UART Ports ## Identifying UART ports
A UART pinout has **four** ports:
* **TX** (Transmit)
* **RX** (Receive)
* **VCC** (Voltage)
* **GNR** (Ground)
A UART pinout has four ports : ![](https://re-ws.pl/wp-content/uploads/2017/09/pinout.jpg)
- TX (Transmit)
- Rx (Receive)
- Vcc (Voltage)
- GNR (Ground)
To find UART multiple solution : To find UART multiple solution:
- Search on Internet * Search on Internet
- Labeled on PCB * Labeled on PCB
- Find candidates * Find candidates
- Use a multi-meter * Using a multimeter
- Follow PCB traces (almost always impossible) * Using a logic analyzer
* Follow PCB traces (almost always impossible)
Keep in mind that some devices emulate UART ports by programming the Generla-Purpose Input/Output (GPIO) pins if there isn't enough space on the board for dedicated hardware UART pins. Keep in mind that some devices **emulate** UART ports by programming the General-Purpose Input/Output (GPIO) pins if there isn't enough space on the board for dedicated hardware UART pins.
### Use a multimeter
### Using a multimeter
#### GNR pin #### GNR pin
First identify the GRN pin, by using the multimeter in continuity mode. First identify the GRN pin, by using the multimeter in continuity mode.
Place the black probe on any grounded metallic surface, be it a part of the tested PCB or not. Then place the red probe on each of the ports. When you hear a beeping sound, you found a GND pin. Place the black probe on any grounded metallic surface, be it a part of the tested PCB or not. Then place the red probe on each of the ports. When you hear a beeping sound, you found a GND pin.
#### VCC pin #### VCC pin
Turn the multimeter to the DC voltage mode in and set it up to 20V of voltage. Keep the black probe on a grounded surface. Place the red probe on a suspeted pin and turn on the device. Turn the multimeter to the DC voltage mode in and set it up to 20V of voltage. Keep the black probe on a grounded surface. Place the red probe on a suspected pin and turn on the device.
If the multimeter measures a constant voltage of either 3.3V or 5V, you've found the VCC pin. If the multimeter measures a constant voltage of either 3.3V or 5V, you've found the VCC pin.
#### Tx pin #### TX pin
Keep the multimeter mode at DC voltage of 20V or less, and leave the black probe in a grounded surface. Move the red probe to the suspected pin and power cycle the device. If the voltage fluctuates for a few seconds and then stabilizes at the Vcc value, you've most likely found the Tx pin. Keep the multimeter mode at DC voltage of 20V or less, and leave the black probe in a grounded surface. Move the red probe to the suspected pin and power cycle the device. If the voltage fluctuates for a few seconds and then stabilizes at the VCC value, you've most likely found the TX pin.
This behavior happens because, during bootup, the device sends serial data through that Tx pin for debugging purposes. Once it finishes booting, the UART line goes idle. This behavior happens because, during bootup, the device sends serial data through that TX pin for debugging purposes. Once it finishes booting, the UART line goes idle.
#### Rx pin #### Rx pin
If you've already identified the rest of the UART pins, the nearby fourth pin is most likely the Rx pin. If you've already identified the rest of the UART pins, the nearby fourth pin is most likely the RX pin.
Otherwise, you can identify it because it has the lowest voltage fluctuation and lowest overall value of all the UART pins. Otherwise, you can identify it because it has the lowest voltage fluctuation and lowest overall value of all the UART pins.
### Connect to serial port ### Using a logic analyzer
A logic analyzer is an electronic instrument that captures and displays multiple signals from a digital system or digital circuit.
Connect to UART using an USB to TTL, then find the `/dev/ttyUSB0` device in the `dmesg` command output. You need to create the `dialout` group for Debian or `uucp` for Manjaro : To find the UART pins we will connect the pins to a logic analyzer and look for data being transmitted.
* `sudo usermod -a -G dialout username` #### Hardware setup
* `sudo gpasswd -a username uucp` Make sure any system you're testing is **powered off** when you connect the logic analyzer's probes to it **to avoid short-circuiting**.
#### Detect baudrate * Connect the suspected TX pin to any channel of the logic analyzer.
* Connect one of your logic analyzer's GND pins to the PCB that you're testing GND pins so they **share a common ground**.
Standard baud rate are `110`, `300`, `600`, `1200`, `2400`, `4800`, `9600`, `14400`, `19200`, `38400`, `57600`, `115200`, `128000` and `256000`.\ #### Software setup
Auto-detect baud rate using the script : [devttys0/baudrate/baudrate.py](https://github.com/devttys0/baudrate/blob/master/baudrate.py) This setup is for **Saleae based logic analyzer**, if you use a different one referer to the constructor documentation.
#### Interact with the /dev/ttyUSB0 * Open the saleae software
* Create a new analyzer entry by pressing a plus (+) icon and select Async Serial (this is for UART).
* Select a serial channel (8 channels on Logic Analyser) and keep the default settings.
* Try with popular baud rates used in IoT devices (9600, 19200, 38400, 57600, 115200). Note that when you don't know the bit rate, you can select "**Use Autobaud**" and let the software work its magic.
* Save the configurations.
```powershell If you want to modify the speed and the duration:
cu -l /dev/ttyUSB0 -s 9600 * As a rule, you should sample digital signals **at least four times faster than their bandwidth**.
screen port_name 115200 * With serial communications, which are generally very slow, a **50 kS/s** sampling rate is more than enough, although sampling faster than this does no harm.
minicom -b 115200 -o -D Port_Name # to exit GNU screen, type Control-A k. * As for the duration, **20 seconds** is enough time for the device to power on and start transmitting data.
microcom -d -s 9600 -p /dev/ttyUSB0
microcom -d -s 19200 -p /dev/ttyUSB0 Now try with the popular baud rates with both the suspected pins and try to compare the results. If you find any readable text with one of the pins and the text makes some sense then that’s the TX pin.
![](https://miro.medium.com/max/640/1*_7i8gbB0Sw2I0QxCMQ6gRw.png)
![](https://miro.medium.com/max/640/1*1Ku2G160NBczbgM-USi8kQ.png)
## Connect to serial port
### WARNING
It's not a big deal if you confuse the UART RX and TX ports with each other, because you can easily swap the wires connecting to them without any consequences. But confusing the VCC with the GND and connecting wires to them incorrectly **might fry the circuit**.
### Examples
![](http://remotexy.com/img/help/help-esp8266-firmware-update-usbuart.png)
![](https://vanhunteradams.com/Protocols/UART/uart_hardware.png)
### Connection using a USB to TTL
Once the ports are connected, plug the adapter into your computer. You now need to find the **device file descriptor**. To do that enter the following command : `sudo dmesg`.
Typically, it will be assigned to `/dev/ttyUSB0` **if you don't have any other peripheral devices attached**.
Under Ubuntu or Debian, a non-root user cannot have access to serial ports such as ttyS0 or ttyUSB0 if he is not a member of the **dialout** group ! The equivalent group on Arch based distributions is **uucp**. In other words, you just have to add yourself to this group to have access.
Ubuntu or Debian: `sudo usermod -a -G dialout $USER`
Arch based: `sudo usermod -a -G uucp $USER`
### Detect the baud rate
#### Most common baud rate
The most common baud rates for UART are `9600`, `19200`, `38400`, `57600` and `115200`.
A table of other used but less common baud rates can be found here: [Here](https://lucidar.me/en/serialib/most-used-baud-rates-table/)
#### Autodetect the baud rate using a script
Link: [baudrate.py](https://github.com/devttys0/baudrate/blob/master/baudrate.py)
```bash
# Download the script
wget https://raw.githubusercontent.com/devttys0/baudrate/master/baudrate.py
# Install serial dependency
pip2.7 install serial
# Run the script on "/dev/ttyUSB0"
python2.7 baudrate.py -p /dev/ttyUSB0
``` ```
### Interact with UART
Different command line tools to interact with UART:
```powershell
cu -l /dev/ttyUSB0 -s 115200
microcom -d -s 115200 -p /dev/ttyUSB0
minicom -b 115200 -o -D /dev/ttyUSB0 # To exit GNU screen, type Control-A k
screen /dev/ttyUSB0 115200
```
Script to brute force a password protected UART:
```python ```python
import serial, time import serial, time
port = "/dev/ttyUSB0" port = "/dev/ttyUSB0"
baud = 9600 baud = 115200
s = serial.Serial(port) s = serial.Serial(port)
s.baudrate = baud s.baudrate = baud
@ -100,22 +163,18 @@ with open('/home/audit/Documents/IOT/passwords.lst', 'r') as f:
time.sleep(10) time.sleep(10)
``` ```
### UART over BLE ## UART over BLE
It’s an emulation of serial port over BLE. The UUID of the Nordic UART Service is `6E400001-B5A3-F393-E0A9-E50E24DCCA9E`. This service exposes two characteristics: one for transmitting and one for receiving. It’s an emulation of serial port over BLE. The UUID of the Nordic UART Service is `6E400001-B5A3-F393-E0A9-E50E24DCCA9E`. This service exposes two characteristics: one for transmitting and one for receiving.
* **RX Characteristic** (UUID: 6E400002-B5A3-F393-E0A9-E50E24DCCA9E) : The peer can send data to the device by writing to the RX Characteristic of the service. ATT Write Request or ATT Write Command can be used. The received data is sent on the UART interface. * **RX Characteristic (UUID: 6E400002-B5A3-F393-E0A9-E50E24DCCA9E)** :
* **TX Characteristic** (UUID: 6E400003-B5A3-F393-E0A9-E50E24DCCA9E) : If the peer has enabled notifications for the TX Characteristic, the application can send data to the peer as notifications. The application will transmit all data received over UART as notifications. * The peer can send data to the device by writing to the RX Characteristic of the service. ATT Write Request or ATT Write Command can be used. The received data is sent on the UART interface.
* **TX Characteristic (UUID: 6E400003-B5A3-F393-E0A9-E50E24DCCA9E)** :
* If the peer has enabled notifications for the TX Characteristic, the application can send data to the peer as notifications. The application will transmit all data received over UART as notifications.
### Examples
* [nRF UART 2.0 - Nordic Semiconductor ASA](https://play.google.com/store/apps/details?id=com.nordicsemi.nrfUARTv2) * [nRF UART 2.0 - Nordic Semiconductor ASA](https://play.google.com/store/apps/details?id=com.nordicsemi.nrfUARTv2)
* [UART/Serial Port Emulation over BLE](https://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.sdk5.v14.0.0%2Fble_sdk_app_nus_eval.html) * [UART/Serial Port Emulation over BLE](https://infocenter.nordicsemi.com/index.jsp?topic=%2Fcom.nordic.infocenter.sdk5.v14.0.0%2Fble_sdk_app_nus_eval.html)
* [UART Over Bluetooth Low Energy](https://thejeshgn.com/2016/10/01/uart-over-bluetooth-low-energy/) * [UART Over Bluetooth Low Energy](https://thejeshgn.com/2016/10/01/uart-over-bluetooth-low-energy/)
Example with Micro::bit :
* [https://makecode.microbit.org/v1/98535-28913-33692-07418](https://makecode.microbit.org/v1/98535-28913-33692-07418) * [https://makecode.microbit.org/v1/98535-28913-33692-07418](https://makecode.microbit.org/v1/98535-28913-33692-07418)
* [Using the micro:bit Bluetooth Low Energy UART (serial over Bluetooth)](https://support.microbit.org/support/solutions/articles/19000062330-using-the-micro-bit-bluetooth-low-energy-uart-serial-over-bluetooth-) * [Using the micro:bit Bluetooth Low Energy UART (serial over Bluetooth)](https://support.microbit.org/support/solutions/articles/19000062330-using-the-micro-bit-bluetooth-low-energy-uart-serial-over-bluetooth-)
### Examples
![](https://developer.android.com/things/images/raspberrypi-console.png)
![](http://remotexy.com/img/help/help-esp8266-firmware-update-usbuart.png)