IDS - SRS - Version 1.1
IDS - SRS - Version 1.1
IDS - SRS - Version 1.1
Submitted to
Ikanos, India
By
ITrust Technologies, Bangalore, India.
Table of Contents:
2
IDS Software SRS
3
IDS Software SRS
2.0 Introduction
2.1 Purpose of Document
The purpose of this document is to provide a description of the
software requirement specification (SRS) of the IDS software. This
document is intended for I-Trust Technologies, Bangalore, India and
Ikanos, Bangalore, India.
4
IDS Software SRS
5
IDS Software SRS
2.5 References.
6
IDS Software SRS
7
IDS Software SRS
SDRAM
Serial Chip
Port
Ethernet
Ports Flash SDRAM
IDS GUI PC chip Chip
CO Reference Board
8
IDS Software SRS
HOST
IDS MFC PROCESSOR
ANALYSIS
MODULES APPLICATION APPLICATION
RUNNING ON
VxWORKS
MICROSOFT
WINDOWS OS BME
FIRMWARE
9
IDS Software SRS
10
IDS Software SRS
11
IDS Software SRS
5.1.2.1 System Provision: - The following screen shot shows the System
Provision screen:-
System Provision is configuring BMEs. The parameters set for a BME applies
to all ports on the BME. This comprises of xx parameters that can be set. The
GUI provides option to set port parameters and send the same to the port.
5.1.2.2 Port Provision: - The following figure show the Port Provision screen
which will be enabled only after system provision is completed:-
13
IDS Software SRS
Port Provision is configuring parameters which can be different for each port .
This comprises of xx parameters that can be set. Port provision screen displays
the BMEs and all the Ports and profiles.
5.1.2.2.1 Provisioning port: This refers to setting system parameters for the
ports. Following are salient features.
a. There are standard sets of configuration options which are
stored in files. User can choose from this option and
configure a port.
b. User can choose one or many or all Ports using the drop
down list provided. The number of ports shown will depend
upon the type of modem supported. The Profile Name
column displays the entire available standard and user
defined profiles in a combo box. First time a reference board
is being used, standard profile names are shown against each
port. Subsequent usages profiles previously set by the user is
14
IDS Software SRS
c. Edit profile: For each port the user can choose from existing
profiles and if desired change some parameters there by
creating a new profile. All the parameters and the values of
the chosen profile will be displayed. The user can change
any of the values click “Ok”, which will prompt the user to
enter a new name for the profile. This is to ensure that the
standard profiles are not modified. If he chooses “cancel”
button, no new profile is saved. Once a new profile is
created, it will be shown in the profile name of the chosen
port. The new profile will be stored in a separate file.
d. Save profile: The profiles chosen for ports can be saved
using save profile option. The profile names shown against
each port will be saved. This profile will be used for port
provision while sending the command.
e. Delete Profile: - This is used for cleaning up of the unwanted
user defined profiles. Delete will prompt if the user has
selected the standard profile. Again Ok and Cancel buttons
will be provided. The user will have the option of quitting if
he doesn’t want to delete. If in case he chooses Ok, the user
defined profile will be deleted from the drop down list of the
Profile Names and in case any of the port is associated to
this deleted profile, it will get mapped to the first profile of
the drop down list.
5.1.2.2.2 Send: This option is used to send command to the Host Processor
based on the command choices. The user can choose Port provision, Port start,
Port Stop and Clear port commands and click on “send”. The command will be
sent to the target board The status of this command will be displayed.
a. Port provision: This is used to send the configuration to the
target.
b. Port start: This is to send command to the target board to
start the selected port.
c. Port stop: This is to “stop” a configured port.
D. clear counter: This is to send a command to clear the counter
associated with the port.
5.1.2.3 Port Status: - This page allows user to display the status and
performance of ports. The same is used to change the status of the port.
following figure shows the Port Status screen:-
15
IDS Software SRS
16
IDS Software SRS
3. Refresh rate: this will set refresh rate for the port.
4. Port start: This will start the selected port.
5. Port stop: this will stop the selected port.
5.1.2.4 Debug:- This option helps in analyzing the various parameters like
EventLog, AFEREG, CMD3x1, SNRE1, SNRE2, SNRE3, SNRE4, TRNSNR,
SHOWSNR etc. The data for analysis can be on-line or off-line (stored in a
file). The data is plotted as graph which will help analyst to debug the data.
17
IDS Software SRS
4.. SHOWSNR.
The SNR will be plotted and displayed.
b. AFEREG – This will fetch values of
Registers and plot it.
c. CMD3x1
The following screen shot shows how Offline plotting can be implemented:-
The Offline debug data file can be chosen from the above screen.
19
IDS Software SRS
Once the offline plotting is over, the above screen allows the user to select a
different data file from the list of history files.
1. QLN:
2. Echo measurement:
5.1.2.6 SELT: - Presently, the SELT program is running separately from the
IDS application. The design takes care to make provision for integrating SELT
program with IDS.
20
IDS Software SRS
21
IDS Software SRS
22
IDS Software SRS
Annexure-1
1. IDS: This tool was developed by customer engineering (Apps) group. The tool runs on PC & connects
via sockets to the PowerPC host board through the PowerPC’s management Ethernet port (10 Mbps).
The host then performs one or more required IPOS API calls to BME and sends back the information
to the GUI application on the PC. This has a basic GUI with some buttons for provisioning, port
start/stop, and display of line statistics with automatic update of some of the statistics. The first version
was released for internal use on July 14th.
2. Kterm: This tool was developed by Kedar (core technology software group). This tool runs on PC and
connects through the serial port. This provides a basic GUI, and in addition to supports a console
interface. The features such as provisioning is not provided and is expected to be done through the
console interface itself. It has good capability to draw plots using gnuplot for various per tone
information, such as bit-loading, SNR etc.
The proposal is to create a new version including the capabilities of both IDS and Kterm, and to enhance the
underlying GUI framework, so that it is scalable and easy to add new features in the future.
BME, and wait for all the commands from the first GUI click to be finished, before sending the commands
for the second GUI click.
Similarly, the commands typed on the console will cause a IPOS command to BME. The GUI framework
should avoid conflict and wait for any unfinished commands from an earlier GUI button click to be
finished before acting on a command from the console.
- Should provide a mechanism for other applications to link to this through DLL. It is expected that the data
collected will be analysed in many different ways depending on what is being analyzed. It is not scalable to
have to compile the required analysis function into this each time. Instead, an analysis engine can be built
as a DLL to link to this and get the desired data and then do the required analysis on that data.
Initial Screen:
Should open up with a screen, and prompt to connect to the board with a dialog box to type in IP address of
board, with the default value being the most recently used board’s IP address. This dialog box should also have
a pull down button, which when clicked, will show the list containing the previously used IP addresses. After
the address is typed in, or selected from the previously used address list, user should hit ‘Enter’ key, and then it
should establish connection to the board.
Once board connection is done, the board should be queried to get the number of ports on that board display
should update with number of ports available on the board, and board type (100/100, VLR etc). This board
information can be added to be kept by the host code and returned upon query by the GUI.
The figure 1 below shows a proposed screen shot. The first line shows the board type and IP address, followed
by the set of tabs Provision, Stats, Network, TC, PMD, TimeDom, Analog, CollectData etc. In the figure below
the Provisioning tab is shown as being open.
24
IDS Software SRS
Provisioning Tab:
The first few lines in this tab have boxes, which allow the user to type the name of system and port profile and
the port numbers to be provisioned. The profile name can be a filename on the PC hard disk, or $Flash0 or
$Flash1 where Flash0 and Flash1 are the profiles already in the flash. The most recently used profile name
should be the default value, and the dialog box should have a pull down button, which when clicked should
show the list of previously used profile names as history (similar to web addresses in explorer’s address line).
The port numbers can be a single number or a range of ports – the above figure shows 1-4 to indicate ports
1,2,3,4 should have these profiles..
The next line has a pull down which allows the user to choose the actions to be performed – the above figure
shows the pull down being used to select “System & Port Provision, Start Port” as the sequence of actions to be
done. When this is selected, the IPOS commands are sent for System provision, followed by port provision
command for the ports 1,2,3,4, and then port start command for the ports 1,2,3,4.
The bottom part of the window has a ‘action display’ window showing the sequence of actions being
performed. This will provide feedback to the user as to what command is being executed. When a port start
command is being executed, the sequence of states can be shown with the last state shown being the current
state:
Port Start on port 1: g.hs, channel_discovery,
25
IDS Software SRS
Once one or more ports are up, we can use the other tabs to check information related to the ports which are
running. User can also return back to this tab at any time to stop a port which is running or to start a port which
is not running etc.
Statistics Tab:
This tab is “port statistics overview” tab and shows the most common statistics about the ports. Other tabs can
be used to dive into detail statistics based on the modem layer which is being analyzed or debugged. This
statistics overview tab can be as below:
The data for counters can be updated every ‘x’ seconds, and the SNR margin can be updated every ‘y’ minutes.
To be Decided: is it useful to have such a overview tab ? anything else to be put there ?
TC layer tab:
This is for more detailed checking and should have a box at the top to enter the port number. Then show for that
port information such as the one below. This tab may have to be disabled for external users ?
FEC: corr: ____ uncorr: ____ FEC: corr: ____ uncorr: ____
CRC: __5__ _1.5e-7_ CRC: __5__ _1.5e-7_
Tx SuperFrameCount: ____ RxSuperFrameCount: _____
26
IDS Software SRS
Tabs for Repeated Data Collection to capture how some statistic varies with time:
Every n symbols/millisecs/secs/mins , Collect crc, clk err, snr margin etc
& plot vs time
27
IDS Software SRS
28
IDS Software SRS
Keyboard
commands
Critical Critical keyboard
commands commands to be
done through
GUI. GUI should
keep the same
command with
simple text
definition. Should
be able to go to
help on this
command by
pushing help
button. GUI Need to relook
Interface to type GUI should
provide an
interface for user
to type GUI
supported and
other commands GUI Need to relook
Screen echo GUI should
provide a display
screen where the
data retrieved
from device is
echoed in normal
mode GUI Need to relook
Data capture to GUI should
file provide user the
option to save
retrieved data into
a file for offline
analysis GUI Done
29
IDS Software SRS
displayed on
screen and/or
saved to file
SATN(per band) Per band
information to be
displayed on
screen and/or
saved to file GUI Need to schedule
SNRM (per band) Per band
information to be
displayed on
screen and/or
saved to file GUI Need to schedule
30
IDS Software SRS
in DELT as well if
appropriate.
Information can
be updated with
reasonable
update frequency
(say 30 seconds)
if user requests
SNR Training is done.
Per tone SNR to Showtime SNR to
be displayed GUI be scheduled
SNRM Per tone SNR
margin to be
displayed GUI
FEQ coefficient FEQ coefficients
(per toned) values
in polar format as
well as magnitude
and phase GUI Need to schedule
BiGi table GUI Need to schedule
31
IDS Software SRS
SELT GUI
32