Skip to content

Commit 45d8c98

Browse files
committed
User manual 4g module content update
1 parent d5131d2 commit 45d8c98

File tree

1 file changed

+66
-3
lines changed
  • content/hardware/04.pro/carriers/portenta-mid-carrier/tutorials/user-manual

1 file changed

+66
-3
lines changed

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

Lines changed: 66 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2072,6 +2072,8 @@ The image below shows the anticipated configuration, featuring the Portenta X8 a
20722072

20732073
![Portenta Mid Carrier Mini PCIe & Portenta X8 Setup](assets/portentaMIDcarrier_x8_mpcie_set.png)
20742074

2075+
#### Overlay Configuration
2076+
20752077
Once the setup is ready, the following sequence of commands is used to set the overlays required for the Portenta X8 and the Portenta Mid Carrier:
20762078

20772079
```bash
@@ -2090,6 +2092,12 @@ fw_setenv carrier_name mid
20902092
fw_setenv overlays 'ov_som_lbee5kl1dx ov_som_x8h7 ov_carrier_breakout_usbfs ov_carrier_mid_pcie_mini'
20912093
```
20922094

2095+
For managing the Pro 4G Module (EG25 and EC200A-EU), you **only need the USB overlay**, and **mPCIe overlay is not necessary** for these USB modems. You can configure the necessary USB overlays using the following command:
2096+
2097+
```bash
2098+
fw_setenv overlays 'ov_som_lbee5kl1dx ov_som_x8h7 ov_carrier_breakout_usbfs'
2099+
```
2100+
20932101
Alternatively, it is possible to use the **tenta-config** process implemented in the [GIGA Display Connector's Linux Setup](#using-linux-1) section to apply the overlays to enable mini PCIe for the Portenta Mid Carrier with the Portenta X8.
20942102

20952103
***Please check out the guidelines in the [GIGA Display Connector's Linux Setup](#using-linux-1) section for detailed information on how the __tenta-config__ works if you have yet to become familiar with the usage.***
@@ -2124,6 +2132,8 @@ It will prompt a message showing a new set of overlays that will be applied once
21242132

21252133
Select **Ok** to confirm, and the device will be configured with the overlays for mini PCIe support.
21262134

2135+
#### Enabling the Module via GPIO
2136+
21272137
The module must be enabled, and this can be accomplished either by putting the GPIO 5 (iMX8 Pin 165) manually via the 3.3V line or by command as follows:
21282138

21292139
```bash
@@ -2138,6 +2148,8 @@ echo out > /sys/class/gpio/gpio165/direction
21382148
echo 1 > /sys/class/gpio/gpio165/value
21392149
```
21402150

2151+
#### Network Interface Management and Raw IP Mode
2152+
21412153
Afterward, the setup process involves bringing down the `wwan0` interface, setting it to raw IP mode, and then bringing it back up:
21422154

21432155
```bash
@@ -2152,21 +2164,72 @@ echo Y > /sys/class/net/wwan0/qmi/raw_ip
21522164
ip link set dev wwan0 up
21532165
```
21542166

2155-
The following steps include using `qmicli` commands to check the card status and start a network connection:
2167+
This step ensures the modem functions properly in QMI mode.
2168+
2169+
#### ModemManager and Power Management
2170+
2171+
The **ModemManager** service manages the power for the Pro 4G Module via a script. **Global (EG25)** and **EU (EC200A-EU)** modems are different and require different configurations:
2172+
2173+
- **Global EG25 Module**: This modem is supported directly by **NetworkManager**, which works alongside **ModemManager**.
2174+
- **EU EC200A-EU Module**: This modem is **not officially supported** by **ModemManager** and creates a USB `eth0` connection. This can be remapped into an `ec200aeu` network device using an `udev` rule.
2175+
2176+
The modem is powered down when **ModemManager** is stopped using
2177+
2178+
```bash
2179+
systemctl stop ModemManager
2180+
```
2181+
2182+
After stopping **ModemManager**, there will be a delay before the modem can be powered back on and detected by **mmcli**.
2183+
2184+
#### Modem Configuration
2185+
2186+
For the **Global EG25 Module**, you can configure the modem using **NetworkManager** with the following command:
2187+
2188+
```bash
2189+
nmcli c add type gsm ifname cdc-wdm0 con-name wwan0 apn hologram connection.autoconnect yes
2190+
```
2191+
2192+
For the **EU EC200A-EU Module**, **ModemManager** does not support it out of the box, so a patch is required for compatibility. You can then use the following command to connect:
2193+
2194+
```bash
2195+
mmcli -m 0 --simple-connect='apn=iot.1nce.net,ip-type=ipv4v6'
2196+
```
2197+
2198+
If the modem creates a USB `eth0` interface, remap it into an `ec200aeu` network device using an `udev` rule.
2199+
2200+
In a Docker environment, it may be beneficial to disable **ModemManager** and control the modem using **qmicli**. To avoid conflicts, disable **ModemManager** with the following command:
2201+
2202+
```bash
2203+
sudo systemctl stop ModemManager
2204+
```
2205+
2206+
Next, provide a Docker container with an **entrypoint.sh** script to manage the modem's power using **gpiod**:
2207+
2208+
```bash
2209+
gpiod set-value <gpio-pin> 1
2210+
```
2211+
2212+
```bash
2213+
sleep 10
2214+
```
2215+
2216+
Once the modem is powered on, use **qmicli** to configure and manage the modem. For instance, to check the modem status, use:
21562217

21572218
```bash
21582219
qmicli --device=/dev/cdc-wdm0 --device-open-proxy --uim-get-card-status
21592220
```
21602221

21612222
![Pro 4G Module - Card Status](assets/portentaMIDcarrier_mpcie_card_status.png)
21622223

2224+
To start a network connection, use:
2225+
21632226
```bash
21642227
qmicli --device=/dev/cdc-wdm0 --device-open-proxy --wds-start-network="ip-type=4,apn=iot.1nce.net" --client-no-release-cid
21652228
```
21662229

21672230
![Pro 4G Module - Network Initialization](assets/portentaMIDcarrier_mpcie_network_start.png)
21682231

2169-
After establishing the network connection, you can use `udhcpc` to manage dynamic IP configuration:
2232+
After establishing the network connection, manage the dynamic IP using:
21702233

21712234
```bash
21722235
udhcpc -q -f -n -i wwan0
@@ -2196,7 +2259,7 @@ docker run -it --mount type=bind,source="$(pwd)",target=/app python:3.8-slim-bus
21962259
/app/speedtest-cli
21972260
```
21982261

2199-
Once the speed test concludes, you can see similar behavior to the following image.
2262+
Once the speed test concludes, you can see similar behavior to the following image which shows the download and upload speeds
22002263

22012264
![Arduino Pro 4G Module - Speed Test](assets/portentaMIDcarrier_mpcie_4gmodem_result.png)
22022265

0 commit comments

Comments
 (0)