Skip to content

Commit d7d9e62

Browse files
committed
Documentation content update post-review
1 parent 767a60c commit d7d9e62

File tree

2 files changed

+32
-5
lines changed
  • content/hardware/04.pro/carriers
    • portenta-max-carrier/tutorials/mpcie-4g-modem
    • portenta-mid-carrier/tutorials/user-manual

2 files changed

+32
-5
lines changed

content/hardware/04.pro/carriers/portenta-max-carrier/tutorials/mpcie-4g-modem/content.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -334,6 +334,12 @@ nmcli c add type gsm ifname cdc-wdm0 con-name wwan0 apn hologram connection.auto
334334

335335
If your SIM card requires a PIN, update the command as follows:
336336

337+
```bash
338+
nmcli c add type gsm ifname cdc-wdm0 con-name wwan0 apn <APN> gsm.pin <PIN>
339+
```
340+
341+
For instance, if you are using Vodafone in Italy, you can replace the `<APN>` field with `mobile.vodafone.it` and include the PIN number as well:
342+
337343
```bash
338344
nmcli c add type gsm ifname cdc-wdm0 con-name wwan0 apn mobile.vodafone.it gsm.pin <PIN>
339345
```
@@ -444,6 +450,12 @@ Ensure that the Docker container has access to the GPIO device files by passing
444450
docker run --device /dev/gpiochip5 <docker-image>
445451
```
446452

453+
The `<docker-image>` field is the name of the Docker image you want to run with access to the GPIO device files. For example, if your Docker image is called `my_modem_image`, the command would look like this:
454+
455+
```bash
456+
docker run --device /dev/gpiochip5 my_modem_image
457+
```
458+
447459
Inside the container, an **entrypoint.sh** script can control the modem's power via GPIO, with the 3.3V Buck Converter line connected to the **PCIE Enable (GPIO5)** pin. The following command can be added to the script:
448460

449461
```bash
@@ -488,7 +500,6 @@ After the speed test, you might observe results similar to the following image.
488500

489501
***The download and upload speed may vary depending on the region.***
490502

491-
492503
For a more streamlined approach, you can use the following single-line command:
493504

494505
```bash
@@ -497,6 +508,12 @@ nmcli c add type gsm ifname cdc-wdm0 con-name wwan0 apn hologram connection.auto
497508

498509
If your SIM card requires a PIN, adjust the command as follows:
499510

511+
```bash
512+
nmcli c add type gsm ifname cdc-wdm0 con-name wwan0 apn <APN> gsm.pin <PIN>
513+
```
514+
515+
For instance, if you are using Vodafone in Italy, you can replace the `<APN>` field with `mobile.vodafone.it` and include the PIN number as well:
516+
500517
```bash
501518
nmcli c add type gsm ifname cdc-wdm0 con-name wwan0 apn mobile.vodafone.it gsm.pin <PIN>
502519
```

content/hardware/04.pro/carriers/portenta-mid-carrier/tutorials/user-manual/content.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2189,9 +2189,7 @@ systemctl stop ModemManager
21892189

21902190
After stopping **ModemManager**, there will be a delay before the modem can be powered back on and detected by **mmcli**. The delay is around **20 seconds** for appropriate initialization.
21912191

2192-
Make sure the mini PCIe power configuration is configured as described in the [Mini PCIe Power Breakout Header](#mini-pcie-power-breakout-header-j9) section. The Portenta X8 requires the **PCIE Enable (GPIO5)** pin to be connected to a **VCC (3V3)** pin.
2193-
2194-
Modems may get stuck on certain occasions, so it is recommended that power be managed through software to allow modem rebooting when necessary.
2192+
***Make sure the mini PCIe power configuration is configured as described in the [Mini PCIe Power Breakout Header](#mini-pcie-power-breakout-header-j9) section. The Portenta X8 requires the __PCIE Enable (GPIO5)__ pin to be connected to a __VCC (3V3)__ pin. Modems may get stuck on certain occasions, so it is recommended that power be managed through software to allow modem rebooting when necessary.***
21952193

21962194
#### Modem Configuration
21972195

@@ -2265,6 +2263,12 @@ Ensure that the Docker container has access to the GPIO device files by passing
22652263
docker run --device /dev/gpiochip5 <docker-image>
22662264
```
22672265

2266+
The `<docker-image>` field is the name of the Docker image you want to run with access to the GPIO device files. For example, if your Docker image is called `my_modem_image`, the command would look like this:
2267+
2268+
```bash
2269+
docker run --device /dev/gpiochip5 my_modem_image
2270+
```
2271+
22682272
Inside the container, an **entrypoint.sh** script can control the modem's power via GPIO, with the 3.3V Buck Converter line connected to the **PCIE Enable (GPIO5)** pin. The following command can be added to the script:
22692273

22702274
```bash
@@ -2345,6 +2349,12 @@ nmcli c add type gsm ifname cdc-wdm0 con-name wwan0 apn hologram connection.auto
23452349

23462350
In case the SIM card requires a PIN number, the format is modified slightly as follows:
23472351

2352+
```bash
2353+
nmcli c add type gsm ifname cdc-wdm0 con-name wwan0 apn <APN> gsm.pin <PIN>
2354+
```
2355+
2356+
For instance, if you are using Vodafone in Italy, you can replace the `<APN>` field with `mobile.vodafone.it` and include the PIN number as well:
2357+
23482358
```bash
23492359
nmcli c add type gsm ifname cdc-wdm0 con-name wwan0 apn mobile.vodafone.it gsm.pin <PIN>
23502360
```
@@ -2573,7 +2583,7 @@ sudo qmicli -d /dev/cdc-wdm0 --dms-get-manufacturer
25732583

25742584
Power management for the **EC200A-EU module** may require manual intervention, particularly if **ModemManager** is disabled or when using Docker. Make sure the mini PCIe power configuration is configured as described in the [Mini PCIe Power Breakout Header](#mini-pcie-power-breakout-header-j9) section. The Portenta X8 requires the **PCIE Enable (GPIO5)** pin to be connected to a **VCC (3V3)** pin. This is a required power setup for proper system operation.
25752585

2576-
Additionally, sometimes the modem may become unresponsive, so it is recommended that you have a software based power control, which allows you to reboot the modem when necessary.
2586+
***Sometimes the modem may become unresponsive, so it is recommended that you have a software based power control, which allows you to reboot the modem when necessary.***
25772587

25782588
You can create a custom script using the `gpiod` library to manage modem power via software. Ensure that the jumper connection mentioned previously is in place for this to work. The script can be used to power the modem and provide the required delay for proper initialization. A typical example is as follows:
25792589

0 commit comments

Comments
 (0)