diff --git a/_links/link.py b/_links/link.py index cd018f2d..439bfb62 100644 --- a/_links/link.py +++ b/_links/link.py @@ -50,7 +50,7 @@ 'nbconvert': 'https://nbconvert.readthedocs.io/en/latest/', # Linux tools - 'minicom': 'https://linux.die.net/man/1/minicom', + 'picocom': 'https://linux.die.net/man/8/picocom', 'screen': 'https://www.gnu.org/software/screen/manual/screen.html', 'wsl': 'https://learn.microsoft.com/en-us/windows/wsl/install', 'wsl_usb': 'https://learn.microsoft.com/en-us/windows/wsl/connect-usb', diff --git a/conf.py b/conf.py index 219f30e7..aba97f2e 100644 --- a/conf.py +++ b/conf.py @@ -113,7 +113,7 @@ .. |nbconvert| replace:: `nbconvert <{nbconvert}>`__ .. Linux Tools -.. |minicom| replace:: `Minicom <{minicom}>`__ +.. |picocom| replace:: `picocom <{picocom}>`__ .. |screen| replace:: `screen <{screen}>`__ .. |WSL| replace:: `Windows Subsystem for Linux <{wsl}>`__ .. |WSL-USB| replace:: `Connect USB devices <{wsl_usb}>`__ diff --git a/developerGuide/software/getting_started/console/console.rst b/developerGuide/software/getting_started/console/console.rst index 1d42b0da..0a2b2c2f 100644 --- a/developerGuide/software/getting_started/console/console.rst +++ b/developerGuide/software/getting_started/console/console.rst @@ -121,13 +121,13 @@ To adjust the connection settings for serial communication, right-click on the C .. figure:: img/Comm_port.png -Boot reference must be done through ``Minicom`` or a similar serial console application. +Boot reference must be done through ``picocom`` or a similar serial console application. | **Using Windows Subsystem for Linux (WSL)** -For Windows users, we recommend using WSL to access the serial console with ``minicom``. WSL provides a Linux environment on Windows and allows you +For Windows users, we recommend using WSL to access the serial console with ``picocom``. WSL provides a Linux environment on Windows and allows you to connect USB devices to Linux tools. If you haven't set up WSL yet, please follow our :ref:`WSL Setup Guide ` first. @@ -189,7 +189,7 @@ Linux and Mac There is broad support for USB-to-serial converters in the Linux kernel, so in most cases the converter will be detected soon after it is plugged in. -- |minicom|, |screen| or a similar program for setting up a remote serial console. +- |picocom|, |screen| or a similar program for setting up a remote serial console. | @@ -220,66 +220,97 @@ Check the driver output in the kernel log using ``dmesg``: The first Red Pitaya board connected to your PC will create a device named ``/dev/ttyUSB0``. If **N** USB or serial devices are connected, they will appear as ``/dev/ttyUSBn``, where **n** is **{0, 1, ..., N-1}**. To access these devices, programs should be run with ``sudo``. -Minicom or a similar serial console application must be used to view the boot reference log. +Picocom or a similar serial console application must be used to view the boot reference log. | -``minicom`` +``picocom`` ------------ -Minicom is a text-based modem control and terminal emulation program. It is commonly used for setting up a remote serial console. +Picocom is a minimal serial communication program. It is commonly used for accessing the serial consoles of embedded systems. - -To configure ``minicom`` use the ``-s`` option. +To connect to the Red Pitaya's serial console, type .. code-block:: shell-session - sudo minicom -s - - -A configuration menu will open. + sudo picocom -b 115200 /dev/ttyUSB0 -.. figure:: img/minicom_main_menu.png - :width: 400 +Picocom has many options for configuring the serial port. However, only the baud rate needs to be explicitly set (with options ``--baud`` or ``-b``), as all other options have sane defaults. -Go to ``Serial Port Setup``, press **Enter**, and set up the next options: +Unless invoked with the option ``--quiet`` (or ``-q``), picocom starts by printing a bunch of information, including the serial port settings, followed by the message “Terminal ready”: -* Serial Device: ``/dev/ttyUSB0`` (device index ``0`` or a higher number) -* Bps/Par/Bits: ``115200 8N1`` (baud rate, byte length, parity, and stop bits) -* Hardware/Software Flow Control: No (flow control should be disabled) - -.. figure:: img/minicom_settings.png - :width: 600 +.. code-block:: shell-session -``Minicom`` requires some special ``Control+A`` key sequences to operate. The most common commands you will need are: + $ sudo picocom -b 115200 /dev/ttyUSB0 + picocom v3.1 + + port is : /dev/ttyUSB0 + flowcontrol : none + baudrate is : 115200 + parity is : none + databits are : 8 + stopbits are : 1 + escape is : C-a + local echo is : no + noinit is : no + noreset is : no + hangup is : no + nolock is : no + send_cmd is : sz -vv + receive_cmd is : rz -vv -E + imap is : + omap is : + emap is : crcrlf,delbs, + logfile is : none + initstring : none + exit_after is : not set + exit is : no + + Type [C-a] [C-h] to see available commands + Terminal ready + +At this point, picocom has your terminal connected to the Red Pitaya's serial console. + +Picocom uses some special ``Control+A`` key sequences to operate. The most common commands you will need are: - - ``Control+A`` followed by ``X`` to exit Minicom - - ``Control+A`` followed by ``Z`` to open the help menu - -Please see the |minicom| manual for details. + - ``Control+A`` followed by ``Control-X`` to exit picocom + - ``Control+A`` followed by ``Control-H`` to display the list of available commands +Please see the |picocom| manual for details. -After you have configured the details, exit the settings. At this point Minicom should be connected to your Red Pitaya: - -.. figure:: img/minicom_connected.png - :width: 1000 If you are asked to log in into the Red Pitaya, please use the following credentials: - **User name:** ``root`` - **Password:** ``root`` -Leave the Minicom open and unplug Red Pitaya from power. After plugging it back in, you should see the boot sequence for Red Pitaya. +Leave picocom open and unplug Red Pitaya from power. After plugging it back in, you should see the boot sequence for Red Pitaya. At the begginning of the boot sequence, you can press any key to stop the autoboot process and enter the Zynq U-Boot shell. This is useful for debugging and changing the boot parameters. -.. figure:: img/minicom_zynq_boot.png - :width: 1000 - - - -If you are not able to see the boot sequence, please check the connection between the Red Pitaya and your PC, and the settings in Minicom. +.. code-block:: text + + U-Boot 2022.01 (Nov 27 2024 - 05:10:38 +0000), Build: jenkins-RED_PITAYA_UNIFY-Kernel-212 + + CPU: Zynq 7z010 + Silicon: v3.1 + DRAM: ECC disabled 512 MiB + Flash: 0 Bytes + NAND: 0 MiB + MMC: mmc@e0100000: 0 + Loading Environment from nowhere... OK + In: serial@e0000000 + Out: serial@e0000000 + Err: serial@e0000000 + Net: + ZYNQ GEM: e000b000, mdio bus e000b000, phyaddr 1, interface rgmii-id + eth0: ethernet@e000b000 + Hit any key to stop autoboot: 0 + Zynq> + Zynq> █ + +If you are not able to see the boot sequence, please check the connection between the Red Pitaya and your PC, and the settings in picocom. | @@ -289,17 +320,17 @@ If you are not able to see the boot sequence, please check the connection betwee GNU ``screen`` is, in general, a terminal multiplexer. It also supports connecting to a serial console and provides syntax to configure the serial connection's baud rate, byte length, parity, and flow control. -Compared to ``Minicom``, it provides better fonts and support for terminal window resizing. +Compared to ``picocom``, it provides better fonts and support for terminal window resizing. .. code-block:: shell-session $ sudo screen /dev/ttyUSB1 115200 cs8 -Similar to ``Minicom``, ``screen`` requires some special ``Control+A`` key sequences to operate. +Similar to ``picocom``, ``screen`` requires some special ``Control+A`` key sequences to operate. Please see the |screen| manual for details. -The configuration is the same as for ``Minicom``. Please refer to the previous section for details. +The configuration is the same as for ``picocom``. Please refer to the previous section for details. | diff --git a/developerGuide/software/getting_started/console/img/Minicom_connected.png b/developerGuide/software/getting_started/console/img/Minicom_connected.png deleted file mode 100644 index 0d90e1e6..00000000 Binary files a/developerGuide/software/getting_started/console/img/Minicom_connected.png and /dev/null differ diff --git a/developerGuide/software/getting_started/console/img/Minicom_zynq_boot.png b/developerGuide/software/getting_started/console/img/Minicom_zynq_boot.png deleted file mode 100644 index faff0d30..00000000 Binary files a/developerGuide/software/getting_started/console/img/Minicom_zynq_boot.png and /dev/null differ diff --git a/developerGuide/software/getting_started/console/img/minicom_main_menu.png b/developerGuide/software/getting_started/console/img/minicom_main_menu.png deleted file mode 100644 index 9c74515e..00000000 Binary files a/developerGuide/software/getting_started/console/img/minicom_main_menu.png and /dev/null differ diff --git a/developerGuide/software/getting_started/console/img/minicom_settings.png b/developerGuide/software/getting_started/console/img/minicom_settings.png deleted file mode 100644 index ed55b813..00000000 Binary files a/developerGuide/software/getting_started/console/img/minicom_settings.png and /dev/null differ diff --git a/developerGuide/software/getting_started/wsl_setup.rst b/developerGuide/software/getting_started/wsl_setup.rst index 64bd7476..531e889d 100644 --- a/developerGuide/software/getting_started/wsl_setup.rst +++ b/developerGuide/software/getting_started/wsl_setup.rst @@ -6,7 +6,7 @@ Windows Subsystem for Linux Setup The Windows Subsystem for Linux (WSL) provides a Linux environment directly on Windows, which is useful for Red Pitaya development tasks such as: -- Accessing the serial console with ``minicom`` +- Accessing the serial console with ``picocom`` - Building and compiling software - Running Linux-based development tools - Accessing USB devices (including the Red Pitaya SD card) @@ -76,7 +76,7 @@ In your WSL terminal, install the required Linux tools: .. code-block:: bash sudo apt update - sudo apt install linux-tools-generic hwdata minicom + sudo apt install linux-tools-generic hwdata picocom sudo update-alternatives --install /usr/local/bin/usbip usbip /usr/lib/linux-tools/*-generic/usbip 20 | diff --git a/quickStart/E3_board/emmc_flash.rst b/quickStart/E3_board/emmc_flash.rst index 40d39da5..bd8277f4 100644 --- a/quickStart/E3_board/emmc_flash.rst +++ b/quickStart/E3_board/emmc_flash.rst @@ -56,7 +56,7 @@ Before proceeding, ensure you have: * A Red Pitaya board with the QSPI eMMC module attached (see :ref:`QSPI eMMC board connection `). * A USB to serial console cable connected to the Red Pitaya **CON** port. -* A terminal program (e.g. PuTTY, minicom, or screen) configured for **115200 baud, 8N1**. +* A terminal program (e.g. PuTTY, picocom, or screen) configured for **115200 baud, 8N1**. * A PC running a disk image writing tool such as `balenaEtcher `_. * A USB cable to connect the Red Pitaya USB port to the PC (the eMMC will appear as a USB drive). * The watchdog disabled on the QSPI eMMC module (see :ref:`emmc_flash_watchdog_note` above).