ST STA309A User manual

June 2012 Doc ID 023225 Rev 1 1/64

UM1545

User manual

Using the Audio Processor Workbench (APWorkbench)

Introduction

The Audio Processor Workbench (APW) has been designed as a multi-device software

control panel supporting all the products in the Sound Terminal® family from

STMicroelectronics.

APW has been developed to fit the needs of both the beginner and the experienced user.

The tool is quite flexible and its configuration can be simple or more advanced in order to

access the multitude of features offered by the Sound Terminal® products.

Features of the APW include:

■I2C register control: direct R/W access to all I2C registers of the device.

■Equalizer editor: a powerful graphic tool to design filters (or a chain of them) and to

download their coefficients directly into the device. APW makes the use of any other

external tool unnecessary, thus simplifying device operation.

■Configuration presets: the capability of storing up to 8 device configurations that can be

loaded just by pushing a button. Thanks to this feature the configuration process becomes

a rare activity making device testing, measuring or listening faster than ever.

■Device common controls: embedded or external bridge power-up, device reset, power-up

and initialization.

■Device-specific controls: the ST Sound Terminal® product family includes many devices.

APW offers the control of all the various device-specific features (proprietary audio

effects, I/O configuration and routing and so on).

For the complete list of the supported devices please refer to Section 1.1: Supported

devices.

www.st.com

Contents UM1545

2/64 Doc ID 023225 Rev 1

Contents

1 Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.1 Supported devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.2 Supported interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.3 Customer requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

1.3.1 Installation notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

1.4 Quick start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

2 APW walkthrough . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

2.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

2.2 Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

2.3 Operations logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

2.4 Registers Bank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

2.5 Equalizer Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

2.6 Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

2.7 Command shell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

2.8 Importing a filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

2.9 Exporting filter coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

2.10 Miscellaneous controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

3 Device-specific controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

4 F.A.Q.s . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

4.1 Questions & procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

4.2 Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Appendix A Types of filters supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Appendix B Audio processor configuration file . . . . . . . . . . . . . . . . . . . . . . . . . 46

Appendix C Script file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Appendix D Filter import wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

UM1545 Contents

Doc ID 023225 Rev 1 3/64

Appendix E Exporting coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Appendix F Shortcuts quick reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Appendix G Software license agreement and disclaimer . . . . . . . . . . . . . . . . . . 60

5 Revision history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

List of figures UM1545

4/64 Doc ID 023225 Rev 1

List of figures

Figure 1. APW package folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Figure 2. Startup settings, device selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Figure 3. Startup settings, interface selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Figure 4. APW main dialog, device controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Figure 5. Status bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Figure 6. Tools menu, preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Figure 7. Preferences dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Figure 8. I2C failure pop-up message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Figure 9. I2C data and clock line when Delay = 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Figure 10. I2C data and clock line when Delay = 5000 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Figure 11. I2C data and clock line when Delay = 10,000 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Figure 12. Auto Apply option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Figure 13. Auto Retrieve option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Figure 14. Real-time logger window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Figure 15. Registers Bank tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Figure 16. Registers modified in the local bank . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Figure 17. Example of the behavior of the “Enable check vs defaults” option . . . . . . . . . . . . . . . . . . . 21

Figure 18. Register filter and register editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Figure 19. Local bank register values dumped in the log viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Figure 20. Equalizer Editor tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Figure 21. Equalizer Editor tab, the upper part (graphing and design tools) . . . . . . . . . . . . . . . . . . . . 24

Figure 22. Auto-scaler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Figure 23. Scaling coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Figure 24. Equalizer Editor tab (lower part concerning filter design customization) . . . . . . . . . . . . . . 26

Figure 25. Generic processing block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Figure 26. Equalizer Editor tab, miscellaneous options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Figure 27. Running a script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Figure 28. Events in logger upon completion of a script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Figure 29. Location of Command Shell button. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Figure 30. Drop-down menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Figure 31. Command Shell window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Figure 32. File menu, Filter import wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Figure 33. Filter import wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Figure 34. Filter analysis and scaling information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Figure 35. Filter import options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Figure 36. Exporting coefficients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Figure 37. C/C++ format (using Generate C code button) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Figure 38. C code generation wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Figure 39. Miscellaneous controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Figure 40. Peak filter (gain +10 dB, freq 1 kHz, Q 1.41) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Figure 41. Low-pass filter (gain 0 dB, freq 1 kHz, Q 0.71) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Figure 42. High-pass filter (gain 0 dB, freq 1 kHz, Q 0.71) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Figure 43. Low-shelf filter (gain -10 dB, freq 1 kHz, slope 1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Figure 44. High-shelf filter (gain -10 dB, freq 1 kHz, slope 1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Figure 45. Filter import wizard, all coefficients in range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Figure 46. Filter import wizard, adjustable attenuation (one coefficient out of range) . . . . . . . . . . . . . 53

Figure 47. Filter import wizard, gain not adjustable (one coefficient out of range). . . . . . . . . . . . . . . . 54

Figure 48. Filter import wizard, wrong processing frequency. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

UM1545 Getting started

Doc ID 023225 Rev 1 5/64

1 Getting started

1.1 Supported devices

The products actually supported by the APW, all belonging to the ST Sound Terminal®

family, include:

●STA308A

●STA309A

●STA321

●STA323W

●STA326

●STA333BW

●STA333W

●STA339BW

●STA339BWS

●STA350BW

●STA369BW

●STA369BWS

●STA381BW

●STA381BWS

●STA529

●STA559BW

●STA559BWS

Other customer-specific products are supported by the APW but require an activation code.

For further information please contact your local ST sales office.

1.2 Supported interface

The APW needs an interface to interact with the various devices it supports. At the present

time the supported interface is:

●APWLink™ interface (via FTDI© USB UART/FIFO I.C.), see AN4118, “APWLink™ USB

interface board for Sound Terminal® demonstration boards” for further information.

Getting started UM1545

6/64 Doc ID 023225 Rev 1

1.3 Customer requirements

Figure 1. APW package folder

In order to quickly get started very few requirements have to be met. The user will need the

following hardware:

●A supported interface (i.e. APWLink™). If this interface is not available, the tool will run

in SIMULATION mode only and no communication with either the target device or the

demonstration board will be possible.

●A demonstration board of one of the Sound Terminal® supported products.

The software requires:

●A complete APW package (a complete package consists of the files shown in Figure 1,

please note that the structure might change according to the list of supported devices).

●MS Windows operating system (from Windows XP to Windows 7), no other OS is

supported.

●The FTDI© driver (this driver is free and can be downloaded from

http://www.ftdichip.com/Drivers/D2XX.htm). This driver will only be required to

communicate with a target device or demonstration board through the APWLink™

UM1545 Getting started

Doc ID 023225 Rev 1 7/64

interface. APW will run in SIMULATION mode only when the FTDI driver is not installed

or the APWLink™ interface is not connected to the PC.

●Microsoft Visual C++ 2008 Feature Pack Redistributable package, if not already

available on the target PC. These libraries can be downloaded for free from the

Microsoft web site (see below Section 1.3.1: Installation notes).

1.3.1 Installation notes

●Microsoft Visual C++ 2008 Feature Pack Redistributable Package (x86)

To properly run APWorkbench on some machines the user may be required to install the

updated Microsoft VC++ 2008 Feature Pack redistributable libraries, available at no cost

from the Microsoft web page at:

http://www.microsoft.com/en-us/download/details.aspx?id=10015

●FTDIChip USB communication driver (APWLink™ interface)

Concerning USB communication (APWLink™ interface), proper OS drivers must be

installed, available for free from the FTDI website below. Note that different versions are

available depending on the installed OS, either x86 (32-bit) or x64 (64-bit). All Windows

versions, including Vista and Win 7 64-bit are supported.

http://www.ftdichip.com/Drivers/D2XX.htm

Getting started UM1545

8/64 Doc ID 023225 Rev 1

1.4 Quick start

Figure 2. Startup settings, device selection

To start the APW double click on the file APWorkbench.exe. Each time the APW is started,

the Startup settings dialog pops up. The upper part of this dialog allows the product

selection (Figure 2, highlighted in red). Use the drop-down menu to select between the

supported devices. Please note that for each device a brief product description will be

supplied in the frame underneath. For those products not provided with an embedded power

bridge, the Startup settings dialog offers the possibility of specifying the external bridge in

use. Selecting the correct power bridge allows the APW to automatically apply the settings

to get the best audio performances. For those devices embedding a power bridge, this

selection is not available. In the lower part of the Device selection frame the View

specifications button allows quickly displaying the device datasheet (if provided together

with the APW installation).

UM1545 Getting started

Doc ID 023225 Rev 1 9/64

Figure 3. Startup settings, interface selection

The lower part of the Startup settings dialog, instead, allows specifying the interface to be

used (Figure 3, highlighted in red). Please note that when selecting the AP Interface (use

this option for the LPT interface too) or the USB option, respectively the available parallel

ports or the available COM ports will be enumerated in the drop-down menu on the right.

Select the correct interface and communication port, then press OK. Among the physical

interfaces the Simulation option is also available. Use this option if you do not want to be

connected to an interface (APW evaluation and testing only).

Getting started UM1545

10/64 Doc ID 023225 Rev 1

Figure 4. APW main dialog, device controls

After pressing the OK button, the APW main dialog will be displayed, its presentation will

depend on the device selected and may vary from product to product. On the right side of

the APW main dialog, the Device controls frame (Figure 4, highlighted in red) is displayed.

Use the Device power up button to start the device (when the IC is powered, the green LED

will be switched on as well), then use the other controls (Reset, Initialize, …) as needed.

UM1545 Getting started

Doc ID 023225 Rev 1 11/64

Figure 5. Status bar

At the bottom of the APW window a status bar provides some additional information

regarding the last executed command concerning both the I2C registers and the coefficients,

the processing sampling frequency, the chosen interface (LPT, USB or SIM) and some of

the selected preferences (AA = Auto Apply, AR = Auto Retrieve, ACK = Warn for ACK

Failures).

Some of the APW features can be activated using easy shortcuts. The list is available in

Section Appendix F: Shortcuts quick reference.

APW walkthrough UM1545

12/64 Doc ID 023225 Rev 1

2 APW walkthrough

2.1 Introduction

This chapter will guide the user through many of the controls and features offered by the

APWorkbench. Before proceeding with the following paragraphs an important concept has

to be clarified. For each supported device, the APW has an internal registers bank and a

coefficients bank (which will be referred to from now on as local banks), that reproduce the

banks contained in the device (which will be referred to from now on as device banks). It is

up to the user to decide how to handle the local and the device banks by setting the Auto

Apply and the Auto Retrieve preferences. The consequences and the advantages of these

choices will be thoroughly explained in Section 2.2: Preferences. Please note that the

registers bank and the coefficients bank contain all the information needed to completely

describe the device setup. Nevertheless, the APW also uses a third structure called filter

bank. Starting from the filter’s coefficients, this bank stores the filter’s setup in terms of each

filter’s qualitative parameters (gain, cutoff frequency, filter type, etc…). From now on the

ensemble of the registers bank, coefficients bank and the derived filters bank will be

considered and referred to as the device configuration.

2.2 Preferences

The Preferences dialog allows customizing the behavior of the APW in order to fit the needs

of every user. Select the To o l s menu and left click on Preferences to show the dialog

(Figure 6).

The dialog should appear as shown in Figure 7. It can be divided into three main areas. The

left top side of the dialog groups all the controls concerning the tracing preferences

(highlighted in red).

Figure 6. Tools menu, preferences

UM1545 APW walkthrough

Doc ID 023225 Rev 1 13/64

Figure 7. Preferences dialog

Using these options the user can decide which kind of events will be logged:

●Coefficient reading

●Coefficient writing

●Register reading

●Register writing

●Miscellaneous operations on registers

●Register modifications

As a last tracing option the user can also choose to trace all the operations occurring

between the PC and the interface by selecting the Trace I/O Events flag. The log file can be

provided with an automatic line numbering feature that can be enabled, if needed, through

the Print Line Number in Log flag.

APW walkthrough UM1545

14/64 Doc ID 023225 Rev 1

On the right side of the dialog (highlighted in blue) some miscellaneous preferences

concerning the features of the APW are displayed. Hereafter a list of them by group and a

brief explanation (if needed):

●Coefficient Settings:

–Allow Editing Coefficients: this option enables the editing of the filter’s coefficients.

–Show Value in Hexadecimal: this option allows toggling between the hexadecimal

and the decimal notation when displaying the coefficient’s value. Please note that

in case of decimal notation, the values are displayed with ten numbers after the

comma. For this reason and for space constraints they might not be completely

displayed.

●Filter Editor Settings:

–Show Information in EQ Graphic: shows gain and frequency information when

moving with the pointer over the graphic.

●Miscellaneous:

–Load Preferences on Startup: the APW loads the preferences used the previous

time.

–Save Preferences on Exit: when quitting the APW, saves a copy of the current

preferences setup.

●Startup Operations: this option modifies how the APW interacts with the device at

startup. The APW can read the device configuration from the DUT (Device Under Test)

or set it from its local banks (in this latter case the device defaults will be applied). A No

Operation option is also available. If chosen, the APW will not perform any operation on

the DUT at startup. Please note that by choosing this latter option the device

configuration stored in the APW and the one stored in the device might not be the

same.

On the bottom left side of the dialog are grouped all the preferences concerning the register

I/O setup. Since these options will customize how the APW will behave when performing

any I2C operation, do not modify them unless strictly needed.

●

I2C Options

–Check for ACK Events: if selected, the APW will check for I2C operations

acknowledge, otherwise it will be ignored.

–Warn for ACK Failures: through this option the user can choose whether to be

informed in case of I2C failures or not. The check for ACK events option has to be

checked first. Please note that when this option is set, a pop-up message

(Figure 8) will warn the user at each I2C failure, offering the user the possibility of

aborting the operation, retrying it or ignoring any subsequent warning. If this last

option is chosen, the APW will automatically disable the warn for ACK Failures

option. To re-enable it, access the Preferences window as described above.

Figure 8. I2C failure pop-up message

UM1545 APW walkthrough

Doc ID 023225 Rev 1 15/64

–Delay (LPT Only): the I2C clock speed generated through the LPT interface is

strictly related to the performance of the PC the APW is running on and therefore it

cannot be predicted with accuracy. For this reason, from the release 0.910, the

Delay option has been added to make the I2C operation slower or faster according

to need. Its value is basically a counter that has to reach zero before toggling the

I2C clock line. The Delay range varies from 1 (which corresponds to the fastest

configuration possible) to 10000 (which corresponds to the slowest one). Since its

effect may vary from one machine to another, the following screenshots show

three sample cases for Delay = 1 (Figure 9), 5000 (Figure 10) and 10,000

(Figure 11).

Figure 9. I2C data and clock line when Delay = 1

Note: The clock period is 8.6 µs, hence Fmax is 116 kHz

Figure 10. I2C data and clock line when Delay = 5000

Note: The clock period is 113.8 µs, hence Fmax is 8.8 kHz

APW walkthrough UM1545

16/64 Doc ID 023225 Rev 1

Figure 11. I2C data and clock line when Delay = 10,000

Note: The clock period is 216 µs, hence Fmax is 4.6 kHz

–I2C clock (USB only): when using the APWLink interface the user can set the I2C

bus clock using this control. The supported frequencies are 50 kHz, 100 kHz,

200 kHz and 400 kHz.

●Register I/O settings:

–Auto Apply Registers Values: influences how the APW writes the I2C register and

the coefficient values. Figure 12 shows the two possible configurations. If Auto

Apply is set, the new register and coefficient values will be written in both the local

and the device banks (red arrow). On the other hand, when this option is not set,

the new information will be transmitted only to the local banks (blue arrow). In this

latter case the content of the local banks can be copied into the device banks all at

once using the Apply button in the upper right-hand corner of the APW window

(see Section 2.10: Miscellaneous controls). By default, this option is set to

guarantee the content alignment between the two banks.

Figure 12. Auto Apply option

A

uto A

pp

l

y

is ON

A

uto A

pp

l

y

is OFF

Local Banks

Device Banks

Registers

Coefficients

Write

Register/Coefficient

UM1545 APW walkthrough

Doc ID 023225 Rev 1 17/64

–Auto retrieve registers values: influences how the APW retrieves the I2C register

and the coefficient values.

Figure 13. Auto Retrieve option

Figure 13 shows the two possible configurations. When the Auto Retrieve is on (blue arrow),

the requested information is read from the device banks and then copied into the local

banks and displayed to the user. On the other hand, when the Auto Retrieve is off, the

requested information is read only from the Local Banks (red arrow). By default this option is

not set since the content of the local and the device banks are meant to be aligned. It is

suggested to keep this option disabled unless the Auto Apply option is also modified.

Use the Save Preferences button to save all the preferences set up.

Local Banks

A

uto Retrieve is OFF

A

uto Ret

r

ieve is ON

RegistersCoefficients

Device Banks

Read

Register / Coefficient

APW walkthrough UM1545

18/64 Doc ID 023225 Rev 1

2.3 Operations logging

Figure 14. Real-time logger window

The APW offers the possibility of logging many of the events generated through its controls.

These logs are automatically saved to a file named debug.log that can be found in the

APWorkbench/Log folder. Real-time logging is also possible. By clicking on the Logs Viewer

button (Figure 39) the logs viewer window will pop up and show different events in different

colors as they are generated (Figure 14). Right-clicking on the log window will allow the user

to copy, select, clear or save the log. Through the preferences customization, the user can

choose in detail which events to log (see Section 2.2: Preferences). Using the controls

placed on the top margin of the Logs Viewer window, the user can also choose between

(from the left to the right most control): keep on top the logger, to add a note in the logs or to

add an extra "#" break line. Please note that the operations regarding the I2C register are

logged both in hexadecimal and binary notation for easier interpretation.

UM1545 APW walkthrough

Doc ID 023225 Rev 1 19/64

2.4 Registers Bank

Figure 15. Registers Bank tab

The Registers Bank tab offers the user direct access to the device I2C registers (Figure 15).

The panel is mainly occupied by the list of the device registers. From the left column to the

rightmost one, the list offers the following information:

●Register description: the register extended name

●Address: the register address (in hexadecimal notation)

●Data: the actual value of the register (in hexadecimal notation)

●R/W: register access type (if read/write or read only). Read-only or reserved registers

are displayed in grey.

●Default (the register defaults are defined according to the device datasheet)

As additional information, the list of registers highlights in violet every register whose value

in the local bank is not aligned with the value stored in the device bank, thus allowing to

visualize all the modifications applied only the to local bank. Figure 16 shows an example of

this feature. A small reminder of the colors and their meanings is provided in the bottom

right corner of the panel.

APW walkthrough UM1545

20/64 Doc ID 023225 Rev 1

Figure 16. Registers modified in the local bank

The registers list highlights in violet those registers modified in the local bank with respect to

the device bank.

At the bottom of the tab four buttons (and a checkbox) implement the following functions:

●Read All: reads all the registers from the device bank (in this case the Auto Retrieve

option is bypassed).

●Write All: writes the content of the local registers bank (the values shown in the Data

column) into the device bank (in this case the Auto Apply option is bypassed).

●Verify All: compares the contents of the local banks with those of the device banks. If

any difference is detected, the register is displayed in violet.

●Load Defaults: loads the registers default settings in the APW local register bank. To

apply these default settings to the device bank, press Write All.

●Enable Check vs Defaults: enabling this option, the register values stored in the local

bank are compared with the default values. If any difference is detected, the registers

are displayed in red, otherwise they are displayed in green (Figure 17).

Page is loading ...

ST STA309A User manual

Other documents