Promote to 1.0.6

.gitignore

@@ -24,17 +24,22 @@ libtool
 stamp-h1
 
 .deps/
+.dirstamp
 .libs/
 
 # Compiled objects
 *.o
 *.lo
 *.la
 
+# Generated service units
+files/*.service
+
 # Compiled programs
 src/adsprpcd
 src/cdsprpcd
 src/sdsprpcd
+src/gdsprpcd
 test/fastrpc_test
 
 # make dist tarballs

Makefile.am

@@ -1,3 +1,3 @@
-SUBDIRS = inc src test
+SUBDIRS = inc src test files
 
 ACLOCAL_AMFLAGS = -I m4

README.md

@@ -12,19 +12,108 @@ FastRPC interfaces are defined in an IDL file, and they are compiled using the Q
 
 The following diagram depicts the major FastRPC software components on the CPU and DSP.
 
-![FastRPC Architecture](Docs/images/FastRPC_architecture.png)
+```mermaid
+flowchart TB
+subgraph SMD["FastRPC Architecture"]
+direction TB
+
+subgraph TOP[" "]
+direction LR
+
+subgraph CPU["CPU"]
+direction TB
+subgraph Application["Application"]
+direction TB
+Stub["Stub"]
+FRPC_UD["FastRPC<br/>user<br/>driver"]
+end
+FRPC_KD["FastRPC Kernel<br/>driver"]
+end
+
+subgraph DSP["DSP"]
+direction TB
+subgraph User_PD["User PD"]
+direction TB
+Skel["Skel"]
+FRPC_DD["FastRPC<br/>DSP user<br/>driver"]
+end
+FRPC_DSP_KD["FastRPC DSP<br/>driver"]
+end
+
+end
+end
+
+classDef generated fill:#E6E6FA,stroke:#9370DB,color:#000
+classDef fastrpc fill:#4169E1,stroke:#000,color:#000
+classDef shared fill:#FAFAFA,stroke:#666,color:#000
+classDef userpdbox fill:#ABDBE3,stroke:#666,color:#000
+classDef mainbox fill:#7FB3CD,stroke:#666,color:#000
+classDef topbox fill:none,stroke:none,color:none
+
+class Stub,Skel generated
+class FRPC_UD,FRPC_KD,FRPC_DD,FRPC_DSP_KD fastrpc
+class SMD shared
+class Application,User_PD userpdbox
+class CPU,DSP mainbox
+class TOP topbox
+
+Stub <--> FRPC_UD
+FRPC_UD <--> FRPC_KD
+FRPC_KD <--> |rpmsg| FRPC_DSP_KD
+FRPC_DSP_KD <--> FRPC_DD
+FRPC_DD <--> Skel
+
+linkStyle default stroke:#000
+```
 
-**Stub and skel** are generated by the IDL compiler. Other modules are part of the software stack on the device.
+**Stub** and **Skel** are generated by the IDL compiler. The modules shown in blue blocks in the diagram are part of the FastRPC software stack on the device.
 
 **Definition of the terms in the diagram:**
 
-![Term Definitions](Docs/images/Term_definitions.png)
-
+| Term                         | Description                                                                                                                               |
+|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
+| Application                  | User mode process that initiates the remote invocation                                                                                    |
+| Stub                         | Auto-generated code that takes care of marshaling parameters and runs on the CPU                                                          |
+| FastRPC user driver on CPU   | User mode library that is used by the stub code to do remote invocations                                                                  |
+| FastRPC Kernel Driver        | Receives the remote invocations from the client, queues them up for transport to the DSP side over rpmsg, and then waits for the response after signaling the remote side |
+| rpmsg                        | Remote Processor Messaging is the transport mechanism used between the CPU-side FastRPC kernel driver and the DSP-side FastRPC driver to exchange FastRPC requests and responses |
+| FastRPC DSP Driver           | Dequeues the messages received over rpmsg from the FastRPC kernel driver and dispatches them for processing                               |
+| FastRPC user driver on DSP   | User mode code that includes a shell executable to run in the user protection domain (PD) on the DSP and complete the remote invocations to the skel library |
+| Skel                         | Auto-generated code that un-marshals parameters and invokes the user-defined implementation of the function that runs on the DSP         |
+| User PD                      | User protection domain on the DSP that provides the environment to run the user code                                                      |
+
 ### FastRPC Workflow
 
 The FastRPC framework consists of the following components.
 
-![FastRPC Workflow](Docs/images/FastRPC_workflow.png)
+```mermaid
+flowchart LR
+subgraph CPU
+UC[User Code]
+Stub[Stub]
+FF[FastRPC Framework]
+end
+subgraph DSP
+FD[FastRPC DSP Framework]
+Skel[Skel]
+MI[Method Implementation]
+end
+UC --> |"  1  "| Stub
+Stub --> |"  10  "| UC
+Stub --> |"  2  "| FF
+FF --> |"  9  "| Stub
+FF --> |"  3  "| FD
+FD --> |"  8  "| FF
+FD --> |"  4  "| Skel
+Skel --> |"  7  "| FD
+Skel --> |"  5  "| MI
+MI --> |"  6  "| Skel
+classDef generated fill:#E6E6FA,stroke:#9370DB,color:#2A0066
+classDef fastrpc fill:#4169E1,stroke:#000,color:#FFFFFF
+classDef shared fill:#F5F5F5,stroke:#666
+class UC,Stub,Skel,MI generated
+class FF,FD fastrpc
+```
 
 **Workflow:**
 
@@ -46,23 +135,86 @@ Hexagon SDK documentation covers all the required details about FastRPC. Please
 
 ## Build & Installation
 
+### Setting up the fastrpc group
+
+The udev rules set `/dev/fastrpc-*dsp` device nodes to `root:fastrpc` with `0640` permissions and
+grant the `fastrpc` group read/write access to `/dev/dma_heap/system` (required for memory allocation).
+Applications that use `libfastrpc` must therefore belong to the `fastrpc` group.
+
+The build system installs a `sysusers.d` configuration file that automatically creates the `fastrpc` group when `systemd-sysusers` runs (typically at boot or via package manager triggers).
+
+To manually create the group:
+
+```bash
+groupadd --system fastrpc
+```
+
+Or trigger systemd-sysusers:
+
+```bash
+sudo systemd-sysusers
+```
+
+To grant an application user access to FastRPC devices:
+
+```bash
+usermod -aG fastrpc <username>
+```
+
+The services are automatically started by udev when FastRPC devices are detected.
+No manual `systemctl enable` is required.
+
 ### Steps to Generate Native Binaries on Device
 
 ```bash
 git clone https://github.com/quic/fastrpc
 cd fastrpc
 ./gitcompile
 sudo make install
+sudo ldconfig              # Update dynamic linker cache
+sudo systemd-sysusers      # Create fastrpc group
 ```
 
-### Steps to Generate ARM Binaries Using Linaro Toolchain on Ubuntu Build Machine
+### Steps to cross-compile the project on Ubuntu
+
+1. **Install the cross compiler and required dependencies:**
+
+    Install cross-compilation toolchain:
+    ```bash
+    sudo apt install g++-aarch64-linux-gnu binutils-aarch64-linux-gnu
+    ```
 
-1. **Install Linaro tools and add the tools bin location to the path:**
+    Install and build libyaml:
+    ```bash
+    git clone https://github.com/yaml/libyaml.git
+    cd libyaml
+    ./bootstrap
+    ./configure --host=aarch64-linux-gnu
+    make
+    sudo make install
+    cd ..
+    ```
+
+    Install and build libmd:
+    ```bash
+    git clone https://git.hadrons.org/git/libmd.git
+    cd libmd
+    ./autogen
+    ./configure --host=aarch64-linux-gnu
+    make
+    sudo make install
+    cd ..
+    ```
 
+    Install and build libbsd:
     ```bash
-    wget -c https://releases.linaro.org/components/toolchain/binaries/latest-7/aarch64-linux-gnu/gcc-linaro-7.5.0-2019.12-i686_aarch64-linux-gnu.tar.xz
-    tar xf gcc-linaro-7.5.0-2019.12-i686_aarch64-linux-gnu.tar.xz
-    export PATH="$PATH:<linaro tools path>/toolchain/bin"
+    git clone https://gitlab.freedesktop.org/libbsd/libbsd.git
+    cd libbsd
+    ./autogen
+    ./configure --host=aarch64-linux-gnu
+    make
+    sudo make install
+    cd ..
     ```
 
 2. **Create softlink files for the compiler, linker, and other tools. Create environment variables as below for the auto tools:**
@@ -196,4 +348,4 @@ Thanks for your interest in contributing to FastRPC! Please read our [Contributi
 
 ## License
 
-FastRPC is licensed under the BSD 3-clause "New" or "Revised" License. Check out the [LICENSE](LICENSE.txt) for more details.
+FastRPC is licensed under the BSD 3-clause "New" or "Revised" License. Check out the [LICENSE](LICENSE.txt) for more details.

ci/MACHINES.json

@@ -16,5 +16,11 @@
     "linuxFirmware": "qcs8300",
     "lavaDeviceName": "qcs8300-ride",
     "hexDSPBinary": "qcs8300"
+  },
+  "qcs615-ride": {
+  "deviceTree": "qcs615-ride",
+  "linuxFirmware": "qcs615",
+  "lavaDeviceName": "qcs615-ride",
+  "hexDSPBinary": "qcs615"
   }
 }

ci/build.sh

@@ -0,0 +1,66 @@
+#!/usr/bin/bash
+# Copyright (c) Qualcomm Technologies, Inc.
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+
+set -euo pipefail
+
+echo "Configuring APT for amd64 + arm64 (ports)..."
+# Detect Ubuntu codename
+CODENAME="$(. /etc/os-release; echo "${VERSION_CODENAME}")"
+: "${CODENAME:?Failed to read VERSION_CODENAME from /etc/os-release}"
+echo "Detected Ubuntu codename: ${CODENAME}"
+
+# 1) Enable ARM64 multiarch
+sudo dpkg --add-architecture arm64
+
+# 2) Overwrite main sources to be amd64-only (archive + security)
+sudo tee /etc/apt/sources.list > /dev/null <<EOF
+deb [arch=amd64] http://archive.ubuntu.com/ubuntu ${CODENAME} main restricted universe multiverse
+deb [arch=amd64] http://archive.ubuntu.com/ubuntu ${CODENAME}-updates main restricted universe multiverse
+deb [arch=amd64] http://archive.ubuntu.com/ubuntu ${CODENAME}-backports main restricted universe multiverse
+deb [arch=amd64] http://security.ubuntu.com/ubuntu ${CODENAME}-security main restricted universe multiverse
+EOF
+
+# 3) Add Ubuntu Ports for arm64 only
+sudo tee /etc/apt/sources.list.d/arm64-ports.list > /dev/null <<EOF
+deb [arch=arm64] http://ports.ubuntu.com/ubuntu-ports ${CODENAME} main restricted universe multiverse
+deb [arch=arm64] http://ports.ubuntu.com/ubuntu-ports ${CODENAME}-updates main restricted universe multiverse
+deb [arch=arm64] http://ports.ubuntu.com/ubuntu-ports ${CODENAME}-backports main restricted universe multiverse
+deb [arch=arm64] http://ports.ubuntu.com/ubuntu-ports ${CODENAME}-security main restricted universe multiverse
+EOF
+
+# 4) Remove deb822 sources that may still request arm64 from security.ubuntu.com
+sudo rm -f /etc/apt/sources.list.d/ubuntu.sources || true
+
+# 5) Clean and update indices (amd64 from archive/security; arm64 from ports)
+sudo apt-get clean
+echo "Updating apt indices..."
+sudo apt-get update -y
+
+echo "Installing dependencies..."
+sudo apt-get install -y --no-install-recommends \
+  abi-compliance-checker abi-dumper elfutils \
+  automake autoconf libtool pkg-config \
+  gcc-aarch64-linux-gnu g++-aarch64-linux-gnu binutils-aarch64-linux-gnu \
+  libyaml-dev \
+  libyaml-0-2:arm64 libyaml-dev:arm64 \
+  libbsd-dev:arm64
+
+echo "Sanity checks for ARM64 yaml pkg-config..."
+ls -l /usr/include/yaml.h
+ls -l /usr/lib/aarch64-linux-gnu/pkgconfig/yaml-0.1.pc
+
+echo "Compiling for ARM64..."
+export CC=aarch64-linux-gnu-gcc
+export CXX=aarch64-linux-gnu-g++
+export AS=aarch64-linux-gnu-as
+export LD=aarch64-linux-gnu-ld
+export RANLIB=aarch64-linux-gnu-ranlib
+export STRIP=aarch64-linux-gnu-strip
+export PKG_CONFIG_PATH=/usr/lib/aarch64-linux-gnu/pkgconfig
+
+# These flags ensure complete debug info (useful for ABI analysis as in ref_build.sh)
+export CFLAGS="-g -Og -fno-eliminate-unused-debug-types"
+export CXXFLAGS="-g -Og -fno-eliminate-unused-debug-types"
+
+./gitcompile --host=aarch64-linux-gnu