Table of Contents
Advertisement
The available commands are described in detail in specific sections later in this document, and a
summary table of all the parameters is provided in Appendix A.
Following the <COMMAND_VERB> there are a number of optional arguments [arg 1]..[arg N] which
depend on the specific parameter. These are detailed in the command tables later in the document.
If the <COMMAND_VERB> is are GET_ command, the output of the operation is printed to the terminal
as in the example below:
vfctrl_usb GET_GPI
GET_GPI: 13
The number and type of arguments depend on the command and these are detailed in the command
tables. Arguments are integer numbers separated by a space. For setting some parameters that
require floating-point data, the numbers have to be first converted to a Q format and then transferred
as integers.
The specification of the Q format for representing floating-point numbers is given in Appendix H.
A secondary form of vfctrl is also available which provides information for developers
vfctrl [options]
Where [options] can be:
-h, --help
: List all command options
-d, --dump-params
: Print list of parameter values
-n, --no-check-version : Do not check version of firmware image
3.4. CONFIGURATION VIA CONTROL INTERFACE
The XVF3510 Voice Processor contains parameters which can be read and written by the host
processor at run time. For information writing parameters at boot time for initial configuration, please
see the section on the Data Partition later in this document.
The XVF3510 firmware is provided as two pre-compiled builds, -UA and -INT, which provide a
parameter control mechanism over USB endpoint 0 and I2C respectively.
Device functions have controllable parameters for the audio pipeline, GPIO, sample rate settings,
audio muxing, timing and general device setup and adjustment. Commands support either read using
the GET_ prefix or write using the SET_ prefix. Controllable parameters may either be readable and
writeable, read-only or write-only. Various data types are supported including signed/unsigned integer
of either 8b or 32b, fixed point signed/unsigned and floating-point.
For a comprehensive list of parameters, their data types and an understanding of their function within
the device please consult the User Guide section relevant to the function of interest, or Appendix A
which summarises all the commands. The control utility can also be used by supplying the -h
argument to the command line. This dumps a list of commands to the console along with a brief
description of the function of each command. The remainder of this section will cover the generic
operation of the control interface.
3.5. CONTROL OPERATION
The control interface works by sending a message from the host to the control process within the
XVF3510 device. The time required to execute commands can vary, but most will respond within 30ms.
Since the commands are fully acknowledged, by design, the control utility blocks until completion.
This interface is designed to allow real-time tuning and adjustment but may stall due to bus access or
data retrieval.
The control interface consists of two parts a host side application and the device application. These
are briefly summarised in the following sections.
XM-014232-PC
15
Advertisement
Table of Contents
