View source for IOT-GATE-IMX8PV2: Debian Linux: iotg-config Configuration Tool

= Overview =
This article provides instructions for ''iotg-config'' configuration tool. It is a command-line interactive tool for managing IOT-GATE-IMX8PV2 peripherals and industrial I/O interfaces.<br>

= Running the Utility =
{{Note|IOT-GATE-IMX8PV2 configuration settings generated by ''iotg-config'' are stored in local configuration files and the [https://docs.u-boot.org/en/latest/usage/environment.html U-Boot environment]. A reboot is required for the changes to take effect.}}

Run the ''iotg-config'' utility with root privileges:
<pre>
compulab@iot-gate-imx8pv2:~$ sudo /opt/cl-iotg/shell/iotg-config
</pre>

= Navigation =
Use the '''Up''' and '''Down''' arrow keys to move through menu options, '''Enter''' to move in and '''Esc''' to move out.<br>
Use '''Space''' to select/deselect configuration option.<br>
Use '''Tab''' to jump between menu body and control buttons (e.g. '''Select''', '''Back''' etc.)<br>

= Main Menu =
Main menu provides access to main options:<br>
<pre>
┌───────────────────┤ IOT-GATE-IMX8PV2 Configuration Tool ├────────────────────┐
│                                                                              │
│           1 Industrial I/O Stack     Industrial I/O Stack options            │
│           2 Peripherals              Peripheral devices options              │
│           3 Save Changes and Exit    Apply changes and exit                  │
│           4 Discard Changes and Exit Exit discarding changes                 │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Ok>                         <Cancel>                    │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
</pre>

== Industrial I/O Stack Options ==
<pre>
┌───────────────────────┤ Industrial I/O Stack Options ├───────────────────────┐
│                                                                              │
│           I1 Show          Show Industrial I/O Stack Configuration           │
│           I2 Configure     Configure Industrial I/O Stack                    │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Select>                     <Back>                      │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
</pre>

=== Configure Industrial I/O Slots ===
<pre>
┌───────────────────────┤ Industrial I/O Slots Options ├───────────────────────┐
│                                                                              │
│       C1 Slot A         Configure Industrial I/O interface for slot A        │
│       C2 Slot B         Configure Industrial I/O interface for slot B        │
│       C3 Slot C         Configure Industrial I/O interface for slot C        │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Select>                     <Back>                      │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
</pre>

For industrial slots '''A''' and '''B''' it is possible to choose one of following configuration option:
* CAN - configure as CAN FD interface
* RS485 - configure as RS-485 interface (half-duplex)
* IDLE - disable all interfaces (default)
<pre>
┌──────────────────────────┤ Industrial I/O Slot A ├───────────────────────────┐
│                                                                              │
│  (*) CAN    CAN FD interface                                                 │
│  ( ) RS485  RS-485 interface (half-duplex)                                   │
│  ( ) IDLE   No interface is enabled                                          │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Ok>                         <Cancel>                    │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
</pre>

For industrial slot '''C''' the only configuration option is:
* DIO - configure Digital I/O interface 4x Digital Signals (inputs or outputs)
<pre>
┌──────────────────────────┤ Industrial I/O Slot C ├───────────────────────────┐
│                                                                              │
│  (*) DIO  4x Digital Signals (inputs or outputs)                             │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Ok>                         <Cancel>                    │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
</pre>

:* Each one of four Digital Signals 0 to 3 can be individually configured as either input or output
<pre>
┌────────────────────────┤ Digital I/O (DIO) Options ├─────────────────────────┐
│                                                                              │
│                  P0 D0          Configure Digital Signal 0                   │
│                  P1 D1          Configure Digital Signal 1                   │
│                  P2 D2          Configure Digital Signal 2                   │
│                  P3 D3          Configure Digital Signal 3                   │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Select>                     <Back>                      │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
</pre>

<pre>
┌─────────────────────────────┤ Digital Signal 2 ├─────────────────────────────┐
│                                                                              │
│  ( ) Input   Read-only access enabled                                        │
│  (*) Output  Write-only access enabled                                       │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Ok>                         <Cancel>                    │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
</pre>

User defined configuration can be shown in a [[#User_defined_configuration|corresponding menu]].

=== Show Industrial I/O Modules ===
<pre>
┌─────────────────┤ Show Industrial I/O Stack Configuration ├──────────────────┐
│                                                                              │
│      S1 Show User Configured          Show user defined configuration        │
│      S2 Show Current Configuration    Show currently run configuration       │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Select>                     <Back>                      │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
</pre>

==== User defined configuration ====
This option displays user defined configuration for industrial I/O slots<br>
<pre>
┌────────────┤ Industrial I/O Stack: user configuration ├────────────┐
│                                                                    │ 
│         Slot A:  [CAN] - CAN FD interface                          │ 
│                                                                    │ 
│                                                                    │ 
│         Slot B:  [RS485] - RS-485 interface (half-duplex)          │ 
│                                                                    │ 
│                                                                    │ 
│         Slot C:  [DIO] - 4x Digital Signals (inputs or outputs)    │ 
│                                                                    │ 
│                  IN OUT                                            │ 
│            D0    [*][ ]                                            │ 
│            D1    [ ][*]                                            │ 
│            D2    [ ][*]                                            │ 
│            D3    [*][ ]                                            │ 
│                                                                    │ 
│                                                                    │ 
│                               <Ok>                                 │ 
│                                                                    │ 
└────────────────────────────────────────────────────────────────────┘ 
</pre>

==== Running configuration ====
This option displays running configuration of the Industrial I/O Stack<br>
<pre>
┌──────────┤ Industrial I/O Stack: running configuration ├───────────┐
│                                                                    │ 
│         Slot A:  [IDLE] - No interface is enabled                  │ 
│                                                                    │ 
│                                                                    │ 
│         Slot B:  [IDLE] - No interface is enabled                  │ 
│                                                                    │ 
│                                                                    │ 
│         Slot C:  [DIO] - 4x Digital Signals (inputs or outputs)    │ 
│                                                                    │ 
│                  IN OUT                                            │ 
│            D0    [*][ ]                                            │ 
│            D1    [*][ ]                                            │ 
│            D2    [*][ ]                                            │ 
│            D3    [*][ ]                                            │ 
│                                                                    │ 
│                                                                    │ 
│                               <Ok>                                 │ 
│                                                                    │ 
└────────────────────────────────────────────────────────────────────┘ 
</pre>

== Peripherals Options ==
<pre>
┌───────────────────────────┤ Peripherals Options ├────────────────────────────┐
│                                                                              │
│               G1 Show          Show Peripherals Configuration                │
│               G2 Configure     Configure Peripherals                         │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Select>                     <Back>                      │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
</pre>


=== Configure Peripherals ===
<pre>
┌──────────────────────────┤ Configure Peripherals ├───────────────────────────┐
│                                                                              │
│             C1 PCIe       Configure PCI Express Devices                      │
│             C2 Wireless   Configure Alternative Wireless Devices             │
│             C3 Misc       Configure Miscellaneous Devices                    │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Select>                     <Back>                      │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
</pre>

==== Configure PCI Express Devices ====
For PCI Express Bus it is possible to choose one of following configuration option:
* WIFI - enable Intel WiFi 6 AX210 module (default)
* NVME - enable NVMe secondary storage device

<pre>
┌──────────────────────┤ Configure PCI Express Devices ├───────────────────────┐
│                                                                              │
│  ( ) WIFI  WiFi Interface (PCIe)                                             │
│  (*) NVME  NVME Storage / HAILO AI                                           │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Ok>                         <Cancel>                    │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
</pre>

==== Configure Alternative Wireless Devices ====
IOT-GATE-IOTG8PV2 features an optional WiFi/BT module interfaced via SDIO/UARD which can be enabled/disabled via this menu.
<pre>
┌──────────────────┤ Configure Alternative Wireless Devices ├──────────────────┐
│                                                                              │
│  [ ] WIFI-SDIO  Enable/Disable WiFi Interface (SDIO)                         │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Ok>                         <Cancel>                    │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
</pre>

==== Configure Misc Peripherals ====
IOT-GATE-IOTG8PV2 features [[IOT-GATE-IMX8PV2:_Debian_Linux:_How-To_Guide#CMD_button|CMD button]] which can be enabled/disabled via this menu.
<pre>
┌────────────────────────┤ Configure Misc Peripherals ├────────────────────────┐
│                                                                              │
│  [*] CMD  Enable/Disable CMD Button                                          │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Ok>                         <Cancel>                    │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
</pre>

=== Show Peripherals Configuration ===
<pre>
┌──────────────────────┤ Show Peripherals Configuration ├──────────────────────┐
│                                                                              │
│      P1 Show User Configured          Show user defined configuration        │
│      P2 Show Current Configuration    Show currently run configuration       │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                                                                              │
│                     <Select>                     <Back>                      │
│                                                                              │
└──────────────────────────────────────────────────────────────────────────────┘
</pre>

===== User defined configuration =====
<pre>
┌────────────────┤ Peripherals: user configuration ├─────────────────┐
│                                                                    │
│         PCI Express:                                               │
│           WiFi Interface (PCIe):    [OFF] - Disabled               │
│           NVME Storage / HAILO AI:  [ON] - Enabled                 │
│                                                                    │
│         Alternative Wireless Connectivity:                         │
│           WiFi Interface (SDIO):    [OFF] - Disabled               │
│                                                                    │
│         Miscellaneous:                                             │
│           CMD Button:               [ON] - Enabled                 │
│                                                                    │
│                                                                    │
│                                                                    │
│                                                                    │
│                                                                    │
│                                                                    │
│                               <Ok>                                 │
│                                                                    │
└────────────────────────────────────────────────────────────────────┘
</pre>

===== Running configuration =====
<pre>
┌───────────────┤ Peripherals: running configuration ├───────────────┐
│                                                                    │ 
│         PCI Express:                                               │ 
│           WiFi Interface (PCIe):    [ON] - Enabled                 │ 
│           NVME Storage / HAILO AI:  [OFF] - Disabled               │ 
│                                                                    │ 
│         Alternative Wireless Connectivity:                         │ 
│           WiFi Interface (SDIO):    [OFF] - Disabled               │ 
│                                                                    │ 
│         Miscellaneous:                                             │ 
│           CMD Button:               [OFF] - Disabled               │ 
│                                                                    │ 
│                                                                    │ 
│                                                                    │ 
│                                                                    │ 
│                                                                    │ 
│                                                                    │ 
│                               <Ok>                                 │ 
│                                                                    │ 
└────────────────────────────────────────────────────────────────────┘ 
</pre>

= Save Changes =
It's strongly recommended to [[#User_defined_configuration|review]] user defined configuration for Gateway Peripherals and Industrial I/O Stack before applying a new configuration.<br>
<pre>
┌──────────────────────────────────────────────────────────┐
│                                                          │ 
│ Would you like to apply changes and exit?                │ 
│                                                          │ 
│                                                          │ 
│                                                          │ 
│                                                          │ 
│                                                          │ 
│                                                          │ 
│                                                          │ 
│                                                          │ 
│                                                          │ 
│                                                          │ 
│               <Save & Exit>          <Back>              │ 
│                                                          │ 
└──────────────────────────────────────────────────────────┘ 
</pre>
Please note, all changes require a reboot to take effect.<br>
<pre>
┌────────────────────────────────────────────────────────────────────┐
│                                                                    │
│         NOTE: ANY CHANGES WILL TAKE EFFECT ONLY AFTER REBOOT.      │
│                                                                    │
│         Would you like to reboot now?                              │
│                                                                    │
│                                                                    │
│                  <Yes>                     <No>                    │
│                                                                    │
└────────────────────────────────────────────────────────────────────┘
</pre>

[[Category:Linux]]
[[Category:IOT-GATE-IMX8PV2]]