hexagonrpcd.1: document the paths relative to the root directory

The files shouldn't be installed right in /usr/share/qcom except for
testing. Rather, they should be installed in some device-specific
directory to make packaging easier on some distros. Document the paths
relative to the root directory for served files.

README.md

@@ -125,19 +125,26 @@ Interfaces are initialized in the `start_reverse_tunnel` function, in hexagonrpc
 ## HexagonFS
 
 The reverse tunnel's `apps_std` interface serves files to the remote processor.
-These files are searched for in:
+These files are searched for in a directory tree, starting at the location
+defined by the `-R` option, or in `/usr/share/qcom` by default:
 
-    Physical file/dir			Android file/dir
-    /usr/share/qcom/acdb			/vendor/etc/acdbdata
-    /usr/share/qcom/dsp			/vendor/dsp
-    /usr/share/qcom/sensors/config		/vendor/etc/sensors/config
-    /usr/share/qcom/sensors/registry	/mnt/vendor/persist/sensors/registry/registry
-    /usr/share/qcom/sensors/sns_reg.conf	/vendor/etc/sensors/sns_reg_config
-    /usr/share/qcom/socinfo			/sys/devices/soc0
+    HexagonRPCD file/dir	Android file/dir
+    acdb			/vendor/etc/acdbdata
+    dsp			/vendor/dsp
+    sensors/config		/vendor/etc/sensors/config
+    sensors/registry	/mnt/vendor/persist/sensors/registry/registry
+    sensors/sns_reg.conf	/vendor/etc/sensors/sns_reg_config
+    socinfo			/sys/devices/soc0
 
 These files and directories should be populated with files from your device's
 Android firmware.
 
+If you can pass the `-R` option, the convention is to pass `-R
+/usr/share/qcom/SOC/VENDOR/DEVICE`, where SOC is the SoC name in lowercase,
+VENDOR is the capitalized name of the device vendor, and DEVICE is the device
+name (e.g. `-R /usr/share/qcom/sdm845/SHIFT/axolotl` or `-R
+/usr/share/qcom/sdm845/Thundercomm/db845c`).
+
 # Future plans
 
 Reverse tunnels are separated by the process that opens the file descriptor and

hexagonrpcd/hexagonrpcd.1

@@ -0,0 +1,64 @@
+'\" t
+.TH HEXAGONRPCD 1 "2024-09-28" "hexagonrpcd" "Server for FastRPC remote procedure calls from Qualcomm DSPs"
+.SH NAME
+hexagonrpcd - Server for FastRPC remote procedure calls from Qualcomm DSPs
+.SH SYNOPSIS
+\fBhexagonrpcd\fP [\fIoptions\&.\&.\&.\fP] -f \fIDEVICE
+.SH DESCRIPTION
+Server for FastRPC remote procedure calls from Qualcomm DSPs\&.
+.PP
+.SH OPTIONS
+.TP
+\fB\-d \fIDSP\fP
+DSP name (default: )
+.TP
+\fB\-f \fIDEVICE\fP
+FastRPC device node to attach to
+.TP
+\fB\-p \fIPROGRAM\fP
+Run client program with shared file descriptor
+.TP
+\fB\-R \fIDIR\fP
+Root directory of served files (default: /usr/share/qcom/)
+.TP
+\fB\-s\fP
+Attach to sensorspd
+.PP
+.SH NOTES
+
+Hexagonrpcd serves files to the remote processor via a reverse tunnel interface
+to the remote processor. These files are by default searched for in:
+
+These files are searched for in a directory tree, starting at the location
+defined by the -R option, or in /usr/share/qcom by default:
+
+.TS
+l l
+---
+l l. 
+HexagonRPCD file/dir    Android file/dir
+acdb                    /vendor/etc/acdbdata
+dsp                     /vendor/dsp
+sensors/config          /vendor/etc/sensors/config
+sensors/registry        /mnt/vendor/persist/sensors/registry/registry
+sensors/sns_reg.conf    /vendor/etc/sensors/sns_reg_config
+socinfo                 /sys/devices/soc0
+.TE
+
+These files and directories should be populated with files from your device's
+Android firmware.
+
+If you can pass the -R option, the convention is to pass -R
+/usr/share/qcom/SOC/VENDOR/DEVICE, where SOC is the SoC name in lowercase,
+VENDOR is the capitalized name of the device vendor, and DEVICE is the device
+name (e.g. -R /usr/share/qcom/sdm845/SHIFT/axolotl or -R
+/usr/share/qcom/sdm845/Thundercomm/db845c).
+
+.SH AUTHORS
+hexagonrpcd was written by The HexagonRPC Contributors <https://github.com/linux-msm/hexagonrpc>
+.SH COPYRIGHT
+Copyright (C) 2024 The HexagonRPC Contributors <https://github.com/linux-msm/hexagonrpc>
+Copyright (C) 2023 The Sensor Shell Contributors <https://github.com/linux-msm/hexagonrpc>
+.PP
+Released under GPL-3+ license\&.
+

hexagonrpcd/meson.build

@@ -17,3 +17,4 @@ executable('hexagonrpcd',
   link_with : libhexagonrpc,
   install_dir : get_option('bindir'),
 )
+install_man('hexagonrpcd.1')

libhexagonrpc/meson.build

@@ -5,6 +5,7 @@ libhexagonrpc = shared_library('hexagonrpc',
   'session.c',
   c_args : cflags,
   include_directories : include,
+  soversion : api_version,
   install : true
 )
 

meson.build

@@ -1,4 +1,7 @@
-project('fastrpc', 'c')
+project('fastrpc', 'c', version: '0.3.2')
+
+version_array = meson.project_version().split('.')
+api_version = version_array[0] + '.' + version_array[1]
 
 include = include_directories('include')
 client_target = get_option('libexecdir') / 'hexagonrpc'

meson.options

@@ -1,2 +1,2 @@
-option('hexagonrpcd_verbose', type : 'boolean', value : true,
+option('hexagonrpcd_verbose', type : 'boolean', value : false,
   description : 'Compile hexagonrpcd with extra logging for each remote method invocation')