random-mirrors/easytarget-MQ-Pro-IO
1
0
Fork 0
mirror of https://github.com/easytarget/MQ-Pro-IO.git synced 2026-01-30 14:53:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc work

Browse Source
This commit is contained in:
Owen
2024-08-30 15:25:40 +02:00
parent fe4de5e43d
commit 53f4de3e3e
5 changed files with 106 additions and 192 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
alt-trees/README.md
View File

@@ -1,6 +1,14 @@
# Precompiled device trees:
Each folder contains a `.dtb` file, which is the compiled device tree itself, plus a `.dts` with the original source and a `.gpio` file showing the GPIO pin mappings.
# Alternate pre-populated device trees:
Each folder contains a `.dts` file and a README showing the GPIO pin mappings.
Copy the desired '.dts' file to the [build-trees](../build-trees) folder and follow the readme there to build the device-tree binaries.
There are instructions at the end of that document on how you can use a custom 'dtb' and make it permanent across reboots and kernel upgrades.
The issue with using these trees is that **if** the upstream device tree or includes is modified you need to manually rebuild these trees, and any changes to the upstream <FIX THIS: WHICH IS THE SOURCE??> file need to be detected and applied too.
- Fortunately this should not be an issue in practice; the kernel *should* remain very stable going forward. Ubuntu 24.04.1 is a LTS release..
The authors personal advice is to use this only if needed; or as a learning excercise.
## Common
[The common (generic) device tree I will use in my project, suitable for many occasions](./common)
@@ -17,77 +25,3 @@ Each folder contains a `.dtb` file, which is the compiled device tree itself, pl
[SPI plus Serial interfaces](./spi)
* Has 3x UART (plus the console uart), 3x I2C. 1xSPI
* 8 unassigned GPIO pins
## SunXI
[Vanilla, unpopulated, upstream](./sunxi)
* Has the console uart, nothing more
*26 unassigned GPIO pins!*
## AllWinner Nezha
[DO NOT USE](./allwinner-nezha)
* Included for completeness, this is the default device tree you get with the Ubuntu image.
* Has the console uart, 1x I2C. 1xSPI
* 15 unassigned GPIO pins, 3 pre-assigned to pinctl
# Getting the DTB files
Clone this repo:
```console
$ git clone https://github.com/easytarget/MQ-Pro-IO.git
$ cd MQ-Pro-IO
```
# Install the Device Tree
Installing is, in principle, simple.
* Clone this repo on to the MQ pro and, as root, copy the desired `.dtb` file to the `/boot/dbts` folder.
* Then make a soft link in the root of the /boot folder named `dtb-mqpro` that points to the file you just copied.
```console
$ sudo cp precompiled-trees/generic/6.8.0-31-generic.dtb /boot/dtbs/
$ cd /boot
$ sudo ln -s dtbs/6.8.0-31-generic.dtb dtb-mqpro
```
Finally, edit the `/boot/grub/grub.cfg` file to use the new DTB for the default 'Ubuntu' target:
* `sudo vi /boot/grub/grub.cfg`
* Look for the first block that begins with: `menuentry 'Ubuntu'`
* Comment out the existing entry and add a new one:
```console
# devicetree /boot/dtb-6.8.0-31-generic
devicetree /boot/dtb-mqpro
```
Reboot!
After rebooting you can run **list-pins.py** (see below) to verify the new mappings.
If you have errors rebooting (maybe a corrupt file if you rebuilt it etc..) you need to either boot using a USB serial adapter on the console pins and select the recovery image, or, in grub, edit the command and revert to the generic `/boot/dtb`.
As a last resort you may have to remove the SD card, mount the `/boot` partition and edit `grub/grub.cfg` there.
* !! The 'default' dtb supplied by ubuntu should always be softlinked as `/boot/dtb`, so putting `devicetree /boot/dtb` in grub in place of the custom `.dtb` should work and is predictable (no version numbers etc).
## Examining the DTB pin mappings:
In the [tools](../tools) folder there is a python script called `list-pins.py`.
To run it you need to be in that directory, then run:
`python3 list-pins.py MangoPi-MQ-Pro`
* This produces the same map I use in the documentation and `.gpio` files in the folders above.
* The data used to assemble the `.gpio` map files identifies which interface a pin is attached to, but not it's specific function for the interface.
* eg it can say 'pinX and pinY are mapped to UART2', but cannot identify which pin is the TX and which is the RX; a limitation of the data, my apologies..
* You therefore need to reference the [D1 pin mapping table](../reference/d1-pins.pdf) to get the exact functions for pins when running this for yourself.
* The `.gpio` files uploaded here *have* been manually edited to note full pin function for convenience.
# Making Permanent:
(As Root) Edit: `/etc/grub.d/10_linux` line 458 to say:
```
for i in "dtb-mqpro" "dtb-${version}" "dtb-${alt_version}" "dtb"; do
```
Note that we are adding `dtb-mqpro` to the start of this list, this is the 'search list' for the DTB files, the full section reads:
```bash
dtb=
for i in "dtb-mqpro" "dtb-${version}" "dtb-${alt_version}" "dtb"; do
if test -e "${dirname}/${i}" ; then
dtb="$i"
break
fi
done
```
When Grub next rebuilds it *should* make the new DTB the default for all entries now. (this is untested, as of this writing there have not been any kernel upgrades to test them on)

33
alt-trees/sun20i-d1-mangopi-mq-pro/README.md
View File

@@ -1,33 +0,0 @@
```
MangoPI MQ Pro GPIO header (dtb name: MangoPi MQ Pro)
Gpio Header:
func des pin pin des func
3v3 1 --o o-- 2 5v
free (205) PG13 3 --o o-- 4 5v
free (204) PG12 5 --o o-- 6 gnd
free (39) PB7 7 --o o-- 8 PB8 uart0.tx (2500000.serial:40)
gnd 9 --o o-- 10 PB9 uart0.rx (2500000.serial:41)
free (117) PD21 11 --o o-- 12 PB5 free (37)
free (118) PD22 13 --o o-- 14 gnd
free (32) PB0 15 --o o-- 16 PB1 free (33)
3v3 17 --o o-- 18 PD14 free (110)
free (108) PD12 19 --o o-- 20 gnd
free (109) PD13 21 --o o-- 22 PC1 free (65)
free (107) PD11 23 --o o-- 24 PD10 free (106)
gnd 25 --o o-- 26 PD15 free (111)
free (145) PE17 27 --o o-- 28 PE16 free (144)
free (42) PB10 29 --o o-- 30 gnd
free (43) PB11 31 --o o-- 32 PC0 free (64)
free (44) PB12 33 --o o-- 34 gnd
free (38) PB6 35 --o o-- 36 PB2 free (34)
free (113) PD17 37 --o o-- 38 PB3 free (35)
gnd 39 --o o-- 40 PB4 free (36)
Other gpio outputs of interest:
-- PD18: Blue Status Led - free (114)
Notes:
- I2C pins 3,5,27 and 28 (PG13, PG12, PE17 and PE16) have 10K pullup resistors to 3v3
- The Status LED (PD18) is common with the LED_PWM pin on the DSI/LVDS output
```

33
alt-trees/sun20i-d1-nezha/README.md
View File

@@ -1,33 +0,0 @@
```
MangoPI MQ Pro GPIO header (dtb name: Allwinner D1 Nezha)
Gpio Header:
func des pin pin des func
3v3 1 --o o-- 2 5v
free (205) PG13 3 --o o-- 4 5v
gpio (2000000.pinctrl:204) PG12 5 --o o-- 6 gnd
free (39) PB7 7 --o o-- 8 PB8 uart0.tx (2500000.serial:40)
gnd 9 --o o-- 10 PB9 uart0.rx (2500000.serial:41)
gpio (2000000.pinctrl:117) PD21 11 --o o-- 12 PB5 free (37)
free (118) PD22 13 --o o-- 14 gnd
i2c2.sck (2502800.i2c:32) PB0 15 --o o-- 16 PB1 i2c2.sda (2502800.i2c:33)
3v3 17 --o o-- 18 PD14 spi1.hold (4026000.spi:110)
spi1.mosi (4026000.spi:108) PD12 19 --o o-- 20 gnd
spi1.miso (4026000.spi:109) PD13 21 --o o-- 22 PC1 free (65)
spi1.clk (4026000.spi:107) PD11 23 --o o-- 24 PD10 spi1.cs (4026000.spi:106)
gnd 25 --o o-- 26 PD15 spi1.wp (4026000.spi:111)
free (145) PE17 27 --o o-- 28 PE16 free (144)
free (42) PB10 29 --o o-- 30 gnd
free (43) PB11 31 --o o-- 32 PC0 ledc (2008000.led-controller:64)
free (44) PB12 33 --o o-- 34 gnd
free (38) PB6 35 --o o-- 36 PB2 free (34)
free (113) PD17 37 --o o-- 38 PB3 free (35)
gnd 39 --o o-- 40 PB4 free (36)
Other gpio outputs of interest:
-- PD18: Blue Status Led - free (114)
Notes:
- I2C pins 3,5,27 and 28 (PG13, PG12, PE17 and PE16) have 10K pullup resistors to 3v3
- The Status LED (PD18) is common with the LED_PWM pin on the DSI/LVDS output
```