Wiki

Below is the source of this page. To edit this source as well as other pages on the wiki, you must login.
====== SigmaStudio Network Utility for Linux ======

The SigmaStudio Network Utility for Linux is a tool for the Linux operating system, which allows SigmaStudio to connect to a audio CODEC/DSP via a TCP connection. This allows to use SigmaStudio for in-system testing or rapid prototyping.

===== Download the SigmaStudio Network Utility ======

The source code for the SigmaStudio Network Utility can be downloaded from the wiki.

{{:resources:tools-software:linux-software:sigma_tcp.tar.bz2|SigmaStudio Network Utility Download}}


  * [[https://github.com/analogdevicesinc/sigma-tcp | sigma-tcp]]
  * [[https://github.com/analogdevicesinc/sigma-tcp/tree/dev-extended-mode | sigma-tcp (with support for extended mode)]]




===== Build and install the SigmaStudio Network Utility ======

Download the SigmaStudio Network Utility and extract the tar archive. To build the tool run //make//.


<WRAP box bggreen><wrap info>This specifies any shell prompt running on the target</wrap>
<xterm>
> **wget http:%%//%%wiki.analog.com/_media/resources/tools-software/linux-software/sigma_tcp.tar.bz2**
> **tar -xjf sigma_tcp.tar.bz**
> **cd sigma_tcp**
> **make**
</xterm>
</WRAP>

==== Run ====

To run sigma_tcp on the target system just execute `sigma_tcp`. sigma_tcp supports different modes. The mode is selected by the first argument passed to the sigma_tcp executable. Each mode has a number of mode specific additional arguments. If no mode is specified sigma_tcp will use the debug mode by default.

Example:
<WRAP box bggreen><wrap info>This specifies any shell prompt running on the target</wrap>
<xterm>
> **sigmap_tcp debug**
Using debug backend
Waiting for connections...
IP addresses:
eth0: 192.168.0.123
</xterm></WRAP>

After sigma_tcp has been started it will print "Waiting for connections..." and the list of IP addresses it is listening on. You will need the IP address when opening up a connection from SigmaStudio. After a new connection has been established sigma_tcp will print "New connection from <ip>", where <ip> is the IP of the client system. When the client disconnects sigma_tcp will print "Connection closed.".

<WRAP round help>sigma_tcp only allows one client connection at a time. It is not possible to connect multiple SigmaStudio instances at the same time.</WRAP>

=== Debug mode ===

In debug mode all register writes go to an internal cache and all register reads will return the values from this cache. So no actual hardware access is done in this case. This mode is useful to test the basic functionality of sigma_tcp. In debug mode each read and each write performed by SigmaStudio will be logged on the console.


<WRAP box bggreen><wrap info>Example</wrap>
<xterm>
> **sigmap_tcp debug**
Using debug backend
Waiting for connections...
IP addresses:
eth0: 192.168.0.123
</xterm></WRAP>

=== Regmap mode ===

In regmap mode sigma_tcp expects the path to a regmap debugfs file, which will be used to read the registers. In this mode it is only possible to read the devices core registers. It is not possible to read any other registers or to write any registers.


<WRAP box bggreen><wrap info>Example</wrap>
<xterm>
> **sigma_tcp regmap /sys/kernel/debug/regmap/0-003b/registers**
Using regmap backend
Waiting for connections...
IP addresses:
eth0: 192.168.0.123
</xterm>
</WRAP>

Regmap mode required debugfs support to be built into the kernel.

In `make menuconfig`:
<code>
  Kernel hacking  --->
    ...
    [*] Debug Filesystem
    ...
</code>

In .config:
<code>
CONFIG_DEBUG_FS=y
</code>

=== I2C mode ===

The third mode is the "i2c" mode. In I2C mode sigma_tcp uses raw access to the I2C bus. In this mode it is possible to read and write all register and it is possible to download and configure a DSP firmware.

The I2C mode takes two parameters, the first parameter is the I2C adapter character device (e.g. "/dev/i2c-0"). The second parameter is the address of the I2C device (e.g. "0x3b").


<WRAP box bggreen><wrap info>This specifies any shell prompt running on the target</wrap><xterm>
> **sigma_tcp i2c /dev/i2c-0 0x3b**
Using i2c backend
Waiting for connections...
IP addresses:
eth0: 192.168.0.123
</xterm></WRAP>

<WRAP alert>
Writing core CODEC registers in this mode may confuse the Linux driver since its internal
and the external state do not necessarily match anymore.
</WRAP>

I2C mode requires support for the I2C device interface built into the kernel.

In `make menuconfig`:
<code>
  Device Drivers  --->
    -*- I2C support  --->
       ...
       <*>   I2C device interface
       ...
</code>

In .config:
<code>
CONFIG_I2C_CHARDEV=y
</code>
===== On the host system =====

Lunch SigmaStudio. Add the TCPIPADAU1761 and the ADAU176x modules to the "Hardware Configuration" window and connect both modules.

{{ :resources:tools-software:linux-software:sigmatcp_sigmastudio_1.png?direct&400 |}}

Now right click on the TCPIPADAU1761 module and select "Show TCPIP Settings" from the popup menu.

{{ :resources:tools-software:linux-software:sigmatcp_sigmastudio_2.png?direct&400 |}}

This brings up the configuration dialog. Enter the target IP address in the dialog and click "Open Connection".

{{ :resources:tools-software:linux-software:sigmatcp_sigmastudio_3.png?direct&400 |}}

You can now switch to the ADAU1761 configuration window and read and write (depending on the sigma_tcp mode) register settings from the device. If the sigma_tcp is running in I2C mode it is also possible to download a firmware by clicking the "Link Compile Download" button.

===== More information =====

  * [[resources/tools-software/sigmastudio|SigmaStudio]]

{{page>resources/tools-software/linux-drivers/need_help#need help&noheader&firstseconly&noeditbtn}}
Analog Devices Wiki

Page Tools
