michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/boards/arc/emsdp/doc/index.rst
Gerard Marull-Paretas e81e92dbb9 boards: convert images to JPEG and reduce image size 
The boards folder uses ~142.8 MB, being the largest in the repository.
This is due mostly to board images, which are in most cases not
optimized for web content. This patch tries to address this problem by
converting all pictures to JPEG (quality 75) and by adjusting its size
up to 750 px (the width of the documentation content). Images that
specified a fixed width in rst files are converted down to that value
instead.

With this patch, folder goes down to ~53.5 MB from 142.8 MB (-~63%).
Note that this patch introduces a new set of binary files to git
history, though (bad).

The process has been automated using this quickly crafted Python script:

```python
from pathlib import Path
import re
import subprocess

def process(doc, image, image_jpeg, size):
    subprocess.run(
        (
	     f"convert {image}"
	     "-background white -alpha remove -alpha off -quality 75"
	     f"-resize {size}\> {image_jpeg}"
	),
        shell=True,
        check=True,
        cwd=doc.parent,
    )
    if image != image_jpeg:
        (doc.parent / image).unlink()

for doc in Path(".").glob("boards/**/*.rst"):
    with open(doc) as f:
        content = ""
        image = None
        for line in f:
            m = re.match(r"^(\s*)\.\. (image|figure):: (.*)$", line)
            if m:
                if image:
                    process(doc, image, image_jpeg, size)

                image = Path(m.group(3))
                if image.suffix not in (".jpg", ".jpeg", ".png"):
                    content += line
                    image = None
                    continue

                image_jpeg = image.parent / (image.stem + ".jpg")
                size = 750
                content += (
                    f"{m.group(1)}.. {m.group(2)}:: {image_jpeg}\n"
                )
            elif image:
                m = re.match(r"\s*:height:\s*[0-9]+.*$", line)
                if m:
                    continue

                m = re.match(r"\s*:width:\s*([0-9]+).*$", line)
                if m:
                    size = min(int(m.group(1)), size)
                    continue

                content += line
                if line == "\n":
                    process(doc, image, image_jpeg, size)
                    image = None
            else:
                content += line

    with open(doc, "w") as f:
        f.write(content)
```

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-08-29 10:18:18 +02:00

209 lines
6.4 KiB
ReStructuredText
Raw Blame History

.. _emsdp:
DesignWare(R) ARC(R) EM Software Development Platform
#####################################################
Overview
********
The DesignWare® ARC® EM Software Development Platform (SDP) is a flexible platform
for rapid software development on ARC EM processor-based subsystems. It is intended
to accelerate software development and debug of ARC EM processors and subsystems for
a wide range of ultra-low power embedded applications such as IoT, sensor fusion,
and voice applications.
.. image:: emsdp.jpg
:align: center
:alt: DesignWare(R) ARC(R) EM Software Development Platform (synopsys.com)
For details about the board, see: `DesignWare ARC EM Software Development Platform
(EM SDP) <https://www.synopsys.com/dw/ipdir.php?ds=arc-em-software-development-platform>`__
Hardware
********
The EM Software Development Platform supports different core configurations, such as EM4,
EM5D, EM6, EM7D, EM9D, EM9D+ESP, EM11D, the default core configuration is EM11D. Use
:kconfig:option:`CONFIG_SOC_EMSDP_EM4`, :kconfig:option:`CONFIG_SOC_EMSDP_EM5D`,
:kconfig:option:`CONFIG_SOC_EMSDP_EM6`, :kconfig:option:`CONFIG_SOC_EMSDP_EM7D`,
:kconfig:option:`CONFIG_SOC_EMSDP_EM7D_ESP`, :kconfig:option:`CONFIG_SOC_EMSDP_EM9D` or
:kconfig:option:`CONFIG_SOC_EMSDP_EM11D` to select different core configuration.
The following table shows the hardware features supported for different core configuration:
+-----------+-----+-----+------+------+----------+------+-------+
| Features | EM4 | EM6 | EM5D | EM7D | EM7D_ESP | EM9D | EM11D |
+===========+=====+=====+======+======+==========+======+=======+
| Caches | N | Y | N | Y | Y | N | Y |
+-----------+-----+-----+------+------+----------+------+-------+
| DSP | N | N | Y | Y | Y | Y | Y |
+-----------+-----+-----+------+------+----------+------+-------+
| XY Memory | N | N | N | N | N | Y | Y |
+-----------+-----+-----+------+------+----------+------+-------+
| Secure | N | N | N | N | Y | N | N |
+-----------+-----+-----+------+------+----------+------+-------+
For hardware feature details, refer to : `ARC EM Software Development Platform
<https://embarc.org/embarc_osp/doc/build/html/board/emsdp.html>`__
Programming and Debugging
*************************
Required Hardware and Software
==============================
To use Zephyr RTOS applications on the EM Software Development Platform board,
a few additional pieces of hardware are required.
* A micro USB cable to connect the computer.
* A universal switching power adaptor (110-240V AC to 12 DC),
provided in the package, which used to power the board.
* :ref:`The Zephyr SDK <toolchain_zephyr_sdk>`
* Terminal emulator software for use with the USB-UART. Suggestion:
`Putty Website`_.
* (optional) A collection of Pmods, Arduino modules, or Mikro modules.
See `Digilent Pmod Modules`_ or develop your custom interfaces to attach
to the Pmod connector.
Set up the EM Software Development Platform
===========================================
To run Zephyr application on EM Software Development Platform, you need to
setup the board correctly.
* Connect the 12V DC power supply to your board.
* Connect the digilent usb cable from your host to the board.
Set up Zephyr Software
======================
Building Sample Applications
==============================
You can try many of the sample applications or tests, but let us discuss
the one called :ref:`hello_world`.
It is found in :zephyr_file:`samples/hello_world`.
Configuring
-----------
You may need to write a prj_arc.conf file if the sample doesn't have one.
Next, you can use the menuconfig rule to configure the target. By specifying
``emsdp`` as the board configuration, you can select the ARC EM Software
Development Platform board support for Zephyr.
.. zephyr-app-commands::
:board: emsdp
:zephyr-app: samples/hello_world
:goals: menuconfig
Building
--------
You can build an application in the usual way. Refer to
:ref:`build_an_application` for more details. Here is an example for
:ref:`hello_world`.
.. zephyr-app-commands::
:board: emsdp
:zephyr-app: samples/hello_world
:maybe-skip-config:
:goals: build
Connecting Serial Output
=========================
In the default configuration, Zephyr's EM Software Development Platform images
support serial output via the USB-UART on the board. To enable serial output:
* Open a serial port emulator (i.e. on Linux minicom, putty, screen, etc)
* Specify the tty driver name, for example, on Linux this may be
:file:`/dev/ttyUSB0`
* Set the communication settings to:
========= =====
Parameter Value
========= =====
Baud: 115200
Data: 8 bits
Parity: None
Stopbits: 1
========= =====
Debugging
==========
Using the latest version of Zephyr SDK(>=0.9), you can debug and flash IoT
Development Kit directly.
One option is to build and debug the application using the usual
Zephyr build system commands.
.. zephyr-app-commands::
:board: emsdp
:app: <my app>
:goals: debug
At this point you can do your normal debug session. Set breakpoints and then
'c' to continue into the program.
The other option is to launch a debug server, as follows.
.. zephyr-app-commands::
:board: emsdp
:app: <my app>
:goals: debugserver
Then connect to the debug server at the EM Software Development Platform from a
second console, from the build directory containing the output :file:`zephyr.elf`.
.. code-block:: console
$ cd <my app>
$ $ZEPHYR_SDK_INSTALL_DIR/sysroots/x86_64-pokysdk-linux/usr/bin/ \
arc-zephyr-elf/arc-zephyr-elf-gdb zephyr.elf
(gdb) target remote localhost:3333
(gdb) load
(gdb) b main
(gdb) c
Flashing
========
If you just want to download the application to the EM Software Development
Platform's CCM and run, you can do so in the usual way.
.. zephyr-app-commands::
:board: emsdp
:app: <my app>
:goals: flash
This command still uses openocd and gdb to load the application elf file to EM
Software Development Platform, but it will load the application and immediately run.
If power is removed, the application will be lost since it wasn't written to flash.
Most of the time you will not be flashing your program but will instead debug
it using openocd and gdb. The program can be download via the USB cable into
the code and data memories.
References
**********
.. target-notes::
.. _Digilent Pmod Modules:
http://store.digilentinc.com/pmod-modules
.. _Putty website:
http://www.putty.org
View git blame Copy permalink