Network Products Division (NPD) System Engineering Network Development
|
|
|
Top Searches for this datasheet
ETHERNET MONITOR (EMON) USER MANUAL
Network Products Division (NPD) System Engineering Network Development (SEND) Gene Gonzales
Date November 1992 July 1993 February 1994 February 1994 July 1995 February 1998 September 1998 February 1999
Revision History Version
File Name EMONUM.DOC EMONUM.DOC EMONUM.DOC EMONUM.DOC EMONUM.DOC EMONUM.DOC EMONUM.DOC
1991-1999 Advanced Micro Devices, Inc.
Ethernet registered trademark Xerox Corporation. PC/AT registered trademark International Business Machines Corporation. LANCE trademark Advanced Micro Devices. Incorporated. ILACC trademark Advanced Micro Devices, Incorporated. MACE trademark Advanced Micro Devices, Incorporated. PCnet trademark Advanced Micro Devices, Incorporated. C-LANCE trademark Advanced Micro Devices. Incorporated.
CONTENTS CHAPTER GENERAL INFORMATION CHAPTER BATCH FILES CHAPTER IDENTIFIER DATA TYPES CHAPTER EXPRESSIONS CHAPTER BUFFER MANAGEMENT CHAPTER COMMAND DESCRIPTION APPENDIX REFERENCES
CHAPTER GENERAL INFORMATION
WHAT'S INTRODUCTION CONFIGURATION FILE (EOI.CFG) AUTOMATIC STARTUP FILE (STARTUP.EMN) GETTING STARTED COMMAND LINE PROMPT ON-LINE HELP ERROR MESSAGES MULTIPLE CARD CONTROL
EMON User Manual
Revision
WHAT'S
Check README. there last-minute updates changes EMON, them ASCII text file. your file contains one, suggest review this using your word processor command: TYPE filename.
EMON been enhanced support three members PCnet family Ethernet controllers: PCnet-FAST (Am97C973 Am79C975), PCnet-Home (Am79C978).
Most example EMON batch files remain unchanged compatible with this release EMON executable. existing batch files that have created expected 100% compatible with this release. usual, example batch files available separate distribution package. batch files provided with EMON were actually used supplement factory testing each controller became available. known working batch files serve "starting point" your controller adapter card test suite. There four batch files which needed support PCnet-Home controller: STARTUP1.EMN, EV_HRON.EMN, EV_SFON.EMN, EV_EXON.EMN. addition, there's command line STARTUP.EMN that used call STARTUP1.EMN file PCnet-Home controller. Normally, line call STARTUP1.EMN commented sure uncomment this call, removing semicolon column one, you're using PCnet-Home controller. other three batch files used from EMON command line EMON batch files when need switch from interface another PHY. Batch files EV_HRON.EMN, EV_SFON.EMN, EV_EXON.EMN select internal HomePNA PHY, internal 10BASE-T PHY, external 10/100 PHY, respectively.
EMON User Manual been revised.
EMON executable, User Manual, example batch files available Corporate Site (www.amd.com). We've selected generic names ZIPd files they easy locate easy replace when newer versions available. EMON.ZIP EMONM.PDF EMONBTCH.ZIP EMON executable MS-DOS machines. EMON User Manual Adobe Acrobat format. EMON batch files your personal use.
Revision
EMON User Manual
INTRODUCTION
EMON name AMD's universal Ethernet MONitor. debug monitor designed allow testing various Ethernet controllers. EMON supports command driven user interface provides with modes specifying commands. With interactive mode, EMON displays simple prompt screen waits type command followed Enter key. specified command executed then cycle repeated. With batch file mode, enter command directing EMON existing batch file. EMON opens specified ASCII file, which expected contain EMON command lines, loads contents batch file into system memory, then executes each command line from memory. EMON written ANSI compiled with Version Borland compiler. Note, this User Manual assumes that already familiar with technical details network controller network interface card which this version EMON configured. Appendix provides with references other applicable documents.
CONFIGURATION FILE (EOI.CFG)
required provide simple ASCII configuration file describing configuration target adapter card(s) intend control with EMON. configuration file must named EOI.CFG must located same directory where invoke EMON directory that included your system PATH specification. Using special EMON configuration keywords, must supply configuration parameters each card intend access. HELP keyword used alone summary EOI.CFG file requirements. following configuration file keywords supported: CARD Adapter card identifier through CTLR Controller type (PCnet-ISA PCnet-PCI PCnet-FAST III, etc.). IOBASE Base address space specified card. channel used specified card. Interrupt channel used specified card. HELP Used itself display summary EOI.CFG requirements. Configuration parameters four cards specified card-by-card basis comprising five lines information. Information each card must grouped together consecutive lines must begin with keyword that specifies card number. Within each card group, detail lines specified order, include: type controller, base address, channel used, Interrupt Request line required. Configuration parameters expected format: keyword configuration_parameter. Example EOI.CFG file with full specifications cards: card ctlr pcnet-isa iobase 0x320 card ctlr pcnet-pci iobase 0xff80
EMON User Manual
Revision
equal sign omitted, spaces tabs ignored, EMON insensitive case characters. Configuration parameter values expected specified ASCII strings, positive integer values, hexadecimal values with prefix.
EMON provides support following controller types. Configuration Parameter LANCE CLANCE PCnet-ISA PCnet-ISA+ PCnet-ISA-II PCnet-32 PCnet-PCI PCnet-PCI PCnet-PCI PCnet-PCI PCnet-PCI PCnet-PCI PCnet-PCI
Controller Type
Am7990 LANCE Local Area Network Controller Ethernet Am79C90 C-LANCE CMOS Local Area Network Controller Ethernet Am79C960 PCnet-ISA Single-Chip Ethernet Controller 79C961 PCnet-ISA+ Jumperless Single-Chip Ethernet Controller 79C961A PCnet-ISA Jumperless Full Duplex Single-Chip Ethernet Controller 79C965 PCnet-32 Single-Chip Ethernet Controller VL-Bus Local Am79C970 PCnet-PCI Single-Chip Ethernet Controller Local Am79C970A PCnet-PCI Single-Chip Full Duplex Ethernet Controller Local Am79C971 PCnet-FAST Single-Chip Full Duplex Ethernet Controller Local Am79C972 PCnet-FAST+ Single-Chip Full Duplex Ethernet Controller Local Am79C973 PCnet-FAST Single-Chip 10/100 Mbps Ethernet Controller with Integrated Am79C975 PCnet-FAST Single-Chip 10/100 Mbps Ethernet Controller with AlertIT Technology Am79C978 PCnet-Home Single-Chip 1/10 Mbps Home Networking Controller
Table Supported Controller Types
Suitable (legal) values base address, channel, Interrupt Request Line parameters dictated design target adapter card. need evaluate capabilities target card your target computer system determine which values used without conflicting with existing cards. shown following table card configuration parameters, EMON maintains default values CTLR, IOBASE, DMA, configuration parameters. CARD CTLR PCnet-ISA PCnet-ISA PCnet-ISA PCnet-PCI IOBASE 0x300 0x320 0x340 0xFF80
Table Default Card Configuration Parameters
default parameter sets, avoid creating detail lines each parameter, specifying only card parameter. example, know that default values card correct your installation, could create minimal EOI.CFG file which contains only keyword card identifier card Example EOI.CFG file when default configuration parameters: card
Please note that PCnet-ISA controllers, choose specify more CTLR, IOBASE, DMA, parameters, must specify them. PCnet-PCI controllers, specification omitted because channel parameter used with PCnet-32 PCnet-PCI controllers.
EMON initialization procedure, using information provided EOI.CFG configuration file, determines total number configuration network interface cards allocated system. allocated cards available, lowest numbered card automatically selected receive commands EMON. must CARD command direct commands another card. Revision EMON User Manual
AUTOMATIC STARTUP FILE (STARTUP.EMN)
EMON will automatically search for, load, execute commands from OPTIONAL special file named STARTUP.EMN. This file contain startup batch code that might want startup EMON. STARTUP.EMN file present, EMON will inform with message then continue normal operation.
GETTING STARTED
execute EMON from command line typing program name followed pressing Enter key. emon
Once EMON loaded started, sign-on message displayed then EMON automatically processes EOI.CFG STARTUP.EMN files. current version program displayed your reference, then information message, showing allocated cards, displayed. Assuming system contains PCnet-FAST controller EOI.CFG configuration file with following: card ctlr pcnet-pci iobase 0xff80 then EMON will react with following sign-on information. Ethernet MONitor (EMON) Version B20.0 Copyright 1991,1992,1993 Advanced Micro Devices, Inc. FYI: Stop controller before CHIP scanning! FYI: EEPROM used BCR/CSR register content. show_cards: Info Total cards allocated: CARD: IOBASE: xFF80 DMA: used. IRQ: CTLR: PCnet-FAST (AM79C973) config mechanism: MODE: BUS_MASTER MEMORY STRUCTURE: bits STRUCTURE: bits Card (PCnet-PCI) selected. startup.emn
options echo, ECHO file index OUTPUT SCREEN EMON Version B20.0. Will delay msec before start HLAN controller from EMON prompt shows identifier currently selected network interface card. CARD command, with parameter identifying specific card (e.g., CARD select card receive subsequent commands. Also, CARD command without card identifier (e.g., CARD) find many network interface cards currently allocated system. EMON User Manual Revision
COMMAND LINE PROMPT
last output displayed after startup will EMON prompt. When this prompt display, EMON interactive mode waiting type command.
ON-LINE HELP
EMON provides on-line help that show complete list available commands show individual help each command. Just type HELP display list available EMON commands. Typing HELP followed specific command name, many cases, simply command name without arguments, will show command syntax summary command's operation. Example help BEEP CFGWR ECHOS FUNCTION INITRD MODE POKE TRAFFIC Example help card
BUFCMP CLEAR ECHOTIME GENCRC INITWR PRINT
BUFRD DATE FCLOSE GLOBAL INPUT MONITOR QUIT SETUP
BUFWR DESCRD FELON GOTO IORD OPTIONS REGRD STAT WAIT
CARD DESCWR FOPEN HELP IOWR PAUSE REGWR STATC
CFGRD ECHOM FPRINT KBHIT PEEK RETURN STOPB
CARD <index> Select network interface card following operations.
ERROR MESSAGES
command execution aborted reason, EMON will display error message that includes information nature error.
MULTIPLE CARD CONTROL
EMON capable supporting multiple network interface cards, although EMON only operate card time. identifier target card must specified (changed) before operation directed different card. descriptor architecture allows list receive transmit descriptors network controller than controller resources while EMON operates with different controller. This used, example, setup echo test between network interface cards, which plugged into same system. Revision EMON User Manual
CHAPTER BATCH FILES
VALUE BATCH FILES MAKING BATCH FILES BATCH FILE COMMENT LINES CALLABLE BATCH FILE FUNCTIONS LABELS TRANSFER CONTROL STARTING BATCH FILES ERRORS NESTING BATCH FILES
EMON User Manual
Revision
VALUE BATCH FILES
EMON batch file contains sequence EMON command lines that loaded executed built-in batch file interpreter. Batch files provide with mechanism execute long complex EMON command sequences without having type commands each time want sequence. Another look batch files that they allow quickly write program test operation device card utilize network interface card simple Ethernet station. EMON delivered with approximately working batch files. have included batch files with .EMN .LIB file name extensions. .LIB files, which analogous high level language time library, contain reusable global variables functions. .EMN files, which analogous high level language source code, contain actual functional tests that make global variables. make changes feel necessary these files basis your custom suite tests.
MAKING BATCH FILES
Batch files simple ASCII files that composed with ASCII editor. Since batch files physically exist local file system, filenames must conform with standard file naming conventions. example, case (IBM machine, file name eight characters optional extension three characters.
BATCH FILE COMMENT LINES
Comment lines added batch file provide some built-in documentation. comment line must contain semicolon column one. Characters following semicolon through end-of-line character will ignored EMON batch file processor.
CALLABLE BATCH FILE FUNCTIONS
batch file, which effect could become actual program, will have main module optionally followed subordinate callable functions similar program. scope main module begins with first line batch file ends first function definition end-of-file (whichever comes first). Each function independent module that begins with FUNCTION command line ends RETURN command line, next function definition, end-of-file (whichever comes first). Function definitions appear order, single batch file several batch files. Note that functions begin batch file another batch file. function called from command line (after batch file been RUN) from another batch file, since calling scope function global. Nested function calls permitted long sufficient stack heap space exist. currently don't know what limits are.
Revision
EMON User Manual
function definition form: function function_name statement_1 statement_2 statement_3
statement_n return
Functions passed arguments (integer string variables) capable returning integer arguments. limited using reserved global variables named ARG1 through ARG32 ERROR when returning arguments from function. calling function evaluate these global variables needed. When EMON finishes executing function, always displays RETURN, even when there RETURN command batch file.
LABELS TRANSFER CONTROL
Labels used GOTO commands unidirectional transfer program control within function within main module. Labels defined within module visible only that module, whether it's main module function. Thus, GOTO line inside another function allowed. Labels must begin column characters length, must with colon (:). Labels must stand alone given batch file line.
STARTING BATCH FILES
Batch file execution begun when EMON recognizes command. could type command prompt input could embed command batch file could combine both methods. Remember include full path name batch file located another sub-directory.
ERRORS
EMON will stop batch file execution when detects error. EMON will display error message then switch back into interactive mode.
EMON User Manual
Revision
NESTING BATCH FILES
Batch files executed from within other batch files including command line containing command followed batch file name. function statement_1 statement_2 statement_3
stuff.tst
statement_n return
Revision
EMON User Manual
CHAPTER IDENTIFIER DATA TYPES
IDENTIFIER DEFINITION INTEGER CONSTANT STRING CONSTANT INTEGER STRING VARIABLE ADDRESSES
EMON User Manual
Revision
IDENTIFIER DEFINITION
Identifiers used reference items such data objects, batch file entities such functions. example, integer string variables, callable functions batch files, given names that have meaning context batch file program. identifier EMON sequence letters digits, where first character must letter. underscore counted letter. There distinction between upper lower case letters. There limit number characters that used identifier name. restriction would come from total number characters that input command line (i.e., characters). EMON commands, which identified Command Description chapter, reserved words, well global variables ARG1 through ARG32 ERROR.
INTEGER CONSTANT
integer constants 32-bit signed values. EMON uses same convention different notations programming language. number without prefix, default, treated decimal number. prefix specifies hexadecimal number, prefix binary number. leading specifies octal integer. Example: DECIMAL BINARY, HEXADECIMAL, OCTAL DECIMAL BINARY 0b1101 HEXADECIMAL 0x1234 OCTAL 0123
STRING CONSTANT
string constant number characters enclosed double quotes ("). backslash character special meaning. following table shows backslash character interpreted. \ddd newline (left margin next line) horizontal backspace carriage return (left margin) form feed backslash character single quote character double quote character control character (specified octal) (\007 outputs control character BEL)
Revision
EMON User Manual
INTEGER STRING VARIABLE
Integer string variables basic data objects manipulated EMON EMON batch files. Both types variables must declared before they referenced. EMON provides commands declare variables. These commands assign different scope variable. Integer string variables declared with command main module batch file visible only main module. local variables declared beginning callable function, scope object function which declared. Integer string variables declared with GLOBAL command visible batch files, functions, remain existence long EMON running. Global variables declared EMON command line from keyboard then accessed within batch file, vice versa. 32-bit integer variables initialized declaration (zero) string variables initialized null string. Integer variables always 32-bit values. When EMON requires passes back smaller integer (i.e., four bits) means high order bits will ignored case return value, will zero. Valid assignments integer variables integer constants, other pre-declared integer variables, expressions both. Example: TEST1, TEST2 GLOBAL TEST3 TEST1 TEST2 TEST1 TEST3 TEST1 TEST2
String variables identified dollar sign last character their name. Valid assignments string variables only string constants another string variable. Example: TEST1$ GLOBAL TEST2$ TEST1$ "This test" TEST2$ TEST1$
ADDRESSES
parameters EMON commands that specify address integer values. EMON built-in routines convert address from "controller format" system format. This allows porting batch file code host systems with 80x86 type segment:offset address format well those using linear address format.
EMON User Manual
Revision
CHAPTER EXPRESSIONS
DEFINITION EXPRESSIONS TABLE LEGAL OPERATORS EXPRESSIONS WITH VARIABLES
EMON User Manual
Revision
DEFINITION EXPRESSIONS
expression formed with combination operators operands. Operators specify type action conversion that performed more operands. EMON provides basic operators addition, subtraction, multiplication, division. Other specialized operators, such double equal signs (==) equality check, available extend your capabilities. Within scope EMON, operands limited integer variables constants.
TABLE LEGAL OPERATORS
following legal operators, shown order decreasing precedence, allowed expression. Parenthesis logical one's complement two's complement multiply divide modulus subtract shift right shift left less than less than equal greater than greater than equal equality inequality bitwise bitwise exclusive bitwise inclusive logical logical
EXPRESSIONS WITH VARIABLES
When forming expression that contains variables, multiple operators operands allowed same command line. most obvious forms expression assignment statement. Examples valid assignments: 0x42 (b/c) (d*e)
Another frequent expression command. !error, goto label1 status 0x8000, goto label1 status 0x8000 !error, goto label1 Revision EMON User Manual
CHAPTER COMMAND DESCRIPTION
DESCRIPTOR RING ACCESS MECHANISM RECEIVE DESCRIPTOR ENTRIES TRANSMIT DESCRIPTOR ENTRIES
EMON User Manual
Revision
DESCRIPTOR RING ACCESS MECHANISM
intent this section explain descriptor ring access mechanism, documented various PCnet Family Data Sheets, relates EMON commands terminology. assumed that have already read data sheet applicable controller need know EMON access controller. basic organization buffer management circular queue tasks memory called descriptor ring. Transmit receive operations described separate descriptor rings. EMON uses buffer management based descriptors that very similar descriptor architecture Am7990 LANCE. Each descriptor ring must allocated contiguous area memory typically consists from quad-word entries called descriptors. Given this organization, from tasks queued descriptor ring awaiting execution Ethernet controller.
ONES BUFF UFLO
ADD_FCS
MORE LADR BCNT LCOL LCAR RTRY HADR TMD0 TMD1 TMD2 TMD3
ONES ZEROS FRAM OFLO LADR BUFF BCNT MCNT HADR
RMD0 RMD1 RMD2 RMD3
Figure 16-bit Transmit Receive Descriptors
Transmit descriptors four words length contain buffer address pointer, status, number bytes transmit from corresponding buffer. Receive descriptors four words length contain buffer address pointer, status, receive buffer size bytes, size received message, bytes. Each descriptor ring located quad-word address boundary system memory must allocated block contiguous 16-bit words. only limitations descriptor ring address that address must address fields (RDRA TDRA) Initialization Block address bits must zero order meet alignment requirement. BCNT fields transmit receive descriptors 12-bit negative numbers representing twos complement buffer size bytes. MCNT field receive descriptor 12-bit positive number representing length received message bytes.
Revision
EMON User Manual
either transmit receive operations, multiple data buffers chained together accommodate packet that longer than current buffer size. transmit, when know packet occupies more than buffer, Start Packet Packet bits (TMD1: STP[9] ENP[8]) inform controller situation. receive, when controller fills first buffer uses additional buffers, informs situation using Start Packet Packet bits (RMD1: STP[9] ENP[8]). ensure proper queuing de-queuing message buffers, each buffer descriptor owned entity time: either Ethernet controller host device driver. each descriptor (TMD1[15] RMD1[15]) indicates whether descriptor entry owned host (OWN controller (OWN transmit, this after filling data buffer controller clears this after transmitting contents buffer. receive, controller clears this after filling buffer this after emptying buffer.
Caution: Once relinquish ownership descriptor must make further changes field corresponding descriptor.
location descriptor rings, their lengths, presented controller Initialization Block that accessed during initialization procedure performed PCnet device.
TBADR ADD_FCS MORE BUFF UFLO EXDEF LCOL LCAR RTRY ONES BCNT
TMD0 TMD1 TMD2 TMD3
FRAM OFLO RBADR BUFF ONES BCNT ZEROS MCNT
RMD0 RMD1 RMD2 RMD3
Figure 32-bit Transmit Receive Descriptors
When initializing controller with Initialization Block, descriptor ring size fields (RLEN TLEN) used specify number descriptors ring. sizes encoding characteristics these fields limit descriptors ring 16-bit mode (512 descriptors ring 32-bit mode) with number descriptors limited power two.
EMON User Manual
Revision
However, able manually specify descriptor ring with 65535 entries directly writing receive transmit ring length registers (CSR76, CSR78 respectively). addition being able specify larger number descriptors, specify number descriptors, just those which power two. choose this method initialization, remember first configure your Initialization Block invoke controller initialization sequence, then perform direct register accesses override values read from Initialization Block.
Caution: choose override RLEN TLEN initialization values writing directly CSR76 CSR78, must write your descriptor ring entry counts 16-bit negative numbers representing twos complement ring size.
Transmit receive buffers located address system memory, required allocated contiguous buffers, have alignment requirements. only limitation buffer address that address must address fields (LADR HADR) provided descriptor. Buffers dynamically allocated randomly throughout system memory. Since specify starting address each individual buffer, required allocate buffers contiguous blocks. Buffers allocated boundary system memory. Since controller able access buffer data byte boundary, required ensure buffer alignment.
RECEIVE DESCRIPTOR ENTRIES
EMON's transmit receive descriptors directly into 32-bit descriptors used PCnet family buffer management hardware.
LADR/HADR RBADR <field> argument: this field receive descriptor specify address receive buffer associated with this descriptor. Buffer addresses either 24-bit 32-bit linear addresses. PCnet family controllers EMON commands always linear addresses even host system uses different format such segment:offset. LADR/HADR LADR 16-bit field that concatenated with 8-bit HADR field form 24-bit linear buffer address used PCnet-ISA, PCnet-ISA+, PCnet-ISA controllers. RBADR 32-bit linear buffer address used PCnet-32 PCnet-PCI controllers. EMON commands that require specify buffer address, such DESCRD DESCWR, shown EMON User Manual with references command line argument named ADR. generic name specifies descriptor address field regardless controller type.
BCNT
<field> argument: bcnt 12-bit Buffer Byte Count field length buffer pointed this descriptor, expressed two's complement length buffer. BCNT size receive buffer, size captured data. When specifying bcnt field with EMON command, specify 16-bit positive integer EMON automatically converts your number correct size format required controller (i.e., automatically converted two's complement 12-bit value). ONES These four bits must written ONEs.
Revision
EMON User Manual
Receive Status <field> argument: Status information indicating condition receive descriptor associated receive buffer. This status information presented forms. PCnet-ISA, PCnet-ISA+, PCnet-ISA controllers, Receive Status always presented bits 15-8 RMD1. PCnet-32 PCnet-PCI controllers, where RMD1 either 16-bits 32-bits wide, Receive Status then either bits 15-8 bits 31-16.
FRAM
OFLO
BUFF
16-bit RMD1
FRAM
OFLO
BUFF
23-16
32-bit RMD1
Figure Receive Status
This indicates that descriptor entry owned host (OWN controller (OWN controller clears after filling buffer pointed descriptor entry. host sets after emptying buffer. Neither host controller alter descriptor entry after relinquishing ownership. This error summary bitwise FRAM, OFLO, BUFF status bits. controller cleared host. FRAM FRAMING ERROR indicates that incoming packet contained non-integer multiple eight bits there error. there error incoming frame, then FRAM will even there non-integer multiple eight bits frame. FRAM valid internal loopback mode. FRAM valid only when OFLO set. FRAM controller cleared host. OFLO OVERFLOW ERROR indicates that receiver lost part incoming frame inability store frame memory buffer before internal FIFO overflowed. OFLO valid only when set. OFLO controller cleared host. ERROR indicates that receiver detected (FCS) error incoming frame. valid only when OFLO set. controller cleared host. BUFF BUFFER ERROR time controller does next buffer while data chaining received frame. This occur either ways: next buffer zero. FIFO overflow occurred before controller received STATUS byte next descriptor. Buffer Error occurs, Overflow Error also occur internally FIFO, will reported descriptor status entry unless both BUFF OFLO errors occur same time. BUFF controller cleared host. START PACKET indicates that this first buffer used controller this frame. used data chaining buffers. Clear information, data sheet specific controller you're using.
EMON User Manual
Revision
PACKET indicates that this last buffer used controller this frame. used data chaining buffers. both set, frame fits into buffer there data chaining. controller cleared host. PCnet-32 PCnet-PCI controllers, these bits reserved must written read ZEROs.
Message Byte Count <field> argument: mcnt MCNT 12-bit message byte count length bytes received message, expressed unsigned binary integer. MCNT valid only when clear set. MCNT written controller cleared host. ZEROS These four bits must written ZEROs host.
Receive Collision Count (PCnet-32, PCnet-PCI only) <field> argument: This 8-bit field indicates accumulated number collisions network since last packet received, excluding collisions that occurred during transmissions from this node.
Runt Packet Count (PCnet-32, PCnet-PCI only) <field> argument: This 8-bit field indicates accumulated number runts that were addressed this node since last time that receive packet successfully received corresponding RMD2 ring entry written controller.
Revision
EMON User Manual
TRANSMIT DESCRIPTOR ENTRIES
LADR/HADR TBADR <field> argument: this field transmit descriptor specify address transmit buffer associated with this descriptor. Buffer addresses either 24-bit 32-bit linear addresses. PCnet family controllers EMON commands always linear addresses even host system uses different format such segment:offset. LADR/HADR LADR 16-bit field that concatenated with 8-bit HADR field form 24-bit linear buffer address used PCnet-ISA, PCnet-ISA+, PCnet-ISA controllers. TBADR 32-bit linear buffer address used PCnet-32 PCnet-PCI controllers. EMON commands that require specify buffer address, such DESCRD DESCWR, shown EMON User Manual with references command line argument named ADR. generic name specifies descriptor address field regardless controller type.
BCNT
<field> argument: bcnt 12-bit Buffer Byte Count field usable length buffer pointed this descriptor, expressed two's complement length buffer. This number bytes that will transmitted controller from this buffer. When specifying bcnt field with EMON command, specify 16-bit positive integer EMON automatically converts your number correct size format required controller (i.e., automatically converted two's complement 12-bit value). ONES These four bits must written ONEs.
Transmit Status <field> argument: Status information indicating condition transmit descriptor associated transmit buffer. This status information presented forms. PCnet-ISA, PCnet-ISA+, PCnet-ISA controllers, Transmit Status always presented bits 15-8 TMD1. PCnet-32 PCnet-PCI controllers, where TMD1 either 16-bits 32-bits wide, Transmit Status then either bits 15-8 bits 31-16.
ADD_FCS MORE
16-bit TMD1
ADD_FCS MORE
23-16
32-bit TMD1
Figure Transmit Status
This indicates that descriptor entry owned host (OWN controller (OWN host sets after filling buffer pointed this descriptor. controller clears after transmitting contents buffer. Neither host controller alter descriptor entry after relinquishing ownership. This error summary bitwise UFLO, LCOL, LCAR RTRY status bits. controller cleared host.
EMON User Manual
Revision
ADD_FCS NO_FCS This dynamically controls generation frame frame basis. valid only set. When ADD_FCS set, state DXMTFCS CSR15 ignored, four bytes appended packet. When ADD_FCS cleared, generation controlled DXMTFCS: DXMTFCS set, appended packet. ADD_FCS host unchanged controller. PCnet-32 PCnet-PCI controllers, this reflect alternative function name NO_FCS. Software Style control bits (SWSTYLE) CSR58 control meaning this it's corresponding operation. MORE MORE indicates that more than retry needed transmit frame. MORE valid only set. MORE controller cleared host. Note that MORE, ONE, RTRY status bits mutually exclusive. indicates that exactly retry needed transmit frame. valid when LCOL set. MORE valid only set. controller cleared host. Note that MORE, ONE, RTRY status bits mutually exclusive. DEFERRED indicates that controller defer while trying transmit frame. This condition occurs channel busy when controller ready transmit. controller cleared host. START PACKET indicates that this first buffer used controller this frame. used data chaining buffers. must first buffer frame, controller will skip over this descriptor poll next descriptor(s) until finds descriptor with bits set. host changed controller. PACKET indicates that this last buffer used controller this frame. used data chaining buffers. both set, frame fits into buffer there data chaining. host changed controller. PCnet-32 PCnet-PCI controllers, these eight bits reserved must written read ZEROs.
Transmit Error Status <field> argument: BUFF BUFFER ERROR controller during transmission when controller does find flag current buffer does next buffer. This occur either ways: next buffer zero. FIFO underflow occurred before controller obtained STATUS byte next descriptor. Buffer Error occurs, Underflow Error will also occur. BUFF valid when LCOL RTRY error during transmit data chaining. BUFF controller cleared host. BUFF error will turn transmitter (CSR0, TXON cleared). UFLO UNDERFLOW ERROR indicates that transmitter truncated message because data from memory arrived late. UFLO indicates that FIFO emptied before frame reached. Upon UFLO error, transmitter turned (CSR0, TXON cleared). UFLO controller cleared host. RES/EXDEF PCnet-ISA, PCnet-ISA+, PCnet-ISA controllers, this reserved must written read ZERO. PCnet-32 PCnet-PCI controllers, this EXDEF. EXCESSIVE DEFERRAL indicates that transmitter experienced Excessive Deferral this transmit frame. Excessive Deferral defined 8803-3 (IEEE/ANSI 802.3).
Revision
EMON User Manual
LCOL LATE COLLISION indicates that collision occurred after slot time channel elapsed. controller does retry late collisions. LCOL controller cleared host. LCAR LOSS CARRIER when carrier lost during controller-initiated transmission. loss detected internally controller's integral being used, deassertion line general purpose serial interface utilized. controller does retry upon loss carrier. will continue transmit whole packet until done. PCnet family, when device 10BASE-T mode LCAR when internal TMAU link fail state. LCAR valid Internal Loopback Mode. LCAR controller cleared host. RTRY RETRY ERROR indicates that transmitter failed after sixteen attempts successfully transmit message repeated collisions medium. DRTY MODE register, RTRY will after failed transmission attempt. RTRY controller cleared host. Note that MORE, ONE, RTRY status bits mutually exclusive.
TIME DOMAIN REFLECTOMETRY <field> argument: This 10-bit field reflects state internal counter that counts 10MHz rate. counts from start packet transmission occurrence collision loss carrier. This value useful determining approximate distance cable fault. value written controller valid only RTRY set. PCnet-32 PCnet-PCI controllers, these twelve bits reserved must written read ZEROs.
TRANSMIT RETRY COUNT (PCnet-32, PCnet-PCI only) <field> argument: This 4-bit field indicates number transmit retries associated packet. maximum count fifteen. However, Retry Error occurs, count will roll over zero. this case only, Transmit Retry Count value zero should interpreted meaning sixteen. written controller into last transmit descriptor frame, when error terminates frame. valid only when cleared.
EMON User Manual
Revision
CHAPTER COMMAND DESCRIPTION
COMMAND SYNTAX COMMAND LINE ARGUMENTS ARGUMENT TYPES COMMAND REFERENCE
EMON User Manual
Revision
COMMAND SYNTAX
Command names entered either upper lower case must complete words; abbreviations accepted. most cases, command name followed more arguments. first argument must separated from command name least space. Additional arguments separated commas. Extra spaces inserted improve readability. When typing commands from keyboard, command executed when "Enter" pressed. Commands batch files executed when batch file processor detects command line, (either presence newline semicolon). maximum length command line cannot exceed characters.
COMMAND LINE ARGUMENTS
Some commands require more arguments while other commands require arguments. Some commands will require argument accept only argument. Other commands will require least argument, also allow list arguments. There also commands that default values arguments arguments specified. Command Reference section uses following syntax describe nature arguments. Required arguments enclosed angle brackets, Optional arguments, enclosed square brackets, Argument lists enclosed curly braces, indicate that additional arguments specified desired.
Example: bufrd <type>, <index> [offset], [count]} This example shows command that requires least arguments, type index. other arguments, offset count, optional have default values they specified.
descwr <type>, <index>, <field>, <val> [field, val],., [field, val]} DESCWR command requires least four arguments. allows more than descriptor field changed with command specifying list additional arguments. Some additional arguments must specified pairs (i.e., field must specified together).
ARGUMENT TYPES
Command arguments several different types. most common character constant, integer values, string values file names. character constant consists more letters. delimiter must used. Integer values immediate 32-bit values (integer constant), global local integer variables, expressions three. Note that variables must declared before being referenced.
Revision
EMON User Manual
following example using descwr command, assume first third arguments this command required specified character constants second fourth arguments integer constants. Example: rlen rlen descwr 0x10, bcnt, rlen first argument shown being specified with letter while third argument shown being specified with group letters bcnt. second argument shown integer hexadecimal value fourth argument shown being specified with expression. this case, expression consists variable integer constant rlen
specification argument string value slightly different from character constants integers. case string constants, you're required pair double quotation marks delimiters enclose string. With string variables, define variable with name ending with dollar sign limited assigning values that string constants. Example: test$ test$ "this test." print "Attention: %s", test$ this example, PRINT command string arguments. first argument string constant, delimited with double quotation marks, second argument string variable, which identified ending dollar sign. string variable, test$, correctly defined assigned string constant before being referenced print command.
File name arguments must specified with complete path name target file local subdirectory. example: \emon\batch\test.emn example given shows specify file names when running PC/AT compatible using MSDOS. This command tells EMON (load execute) contents batch file test.emn that resides subdirectory \emon\batch.
EMON User Manual
Revision
COMMAND REFERENCE
EMON commands fall into various categories. following list gives EMON command categories command under each category.
Controller Memory Interface descrd descwr initrd initwr
Controller Register Interface regrd regwr clear reset cfgrd cfgwr mode
Buffer Management bufcmp bufrd bufwr
Memory Management peek poke
File Management fopen fclose fprint
Variables global
Batch File function goto input kbhit options pause print return stopb wait flush
Packet Management echom echos echotime monitor stat statc traffic
Network Card Management card iord iowr
Misc. date gencrc help setup quit beep
Revision
EMON User Manual
BEEP
NAME
BEEP system speaker generate sound.
SYNOPSIS
BEEP <frequency>, <number>
DESCRIPTION
This command lets generate audible tone your systems speaker. specify frequency tone number times tone repeated. This command uses standard hardware found PC-AT compatible systems sound card necessary. <frequency> integer designating frequency tone. range numbers allowed specify from through 65535. However, generally speaking, human hearing limited frequencies range approximately 20,000Hz. default frequency generated 300Hz. <number> integer value indicating number times tone generated. default number times tone generated once.
RETURN
Does affect global variable.
EXAMPLE
beep this example, 300Hz tone generated time.
EXAMPLE
beep 1000, this example, 1000Hz tone generated time.
EMON User Manual
Revision
BUFCMP
NAME
BUFCMP Compare contents transmit receive buffer.
SYNOPSIS
Compare contents buffers. BUFCMP <type>, <index>, <offset>, <count>, <type1>, <index1>, <offset1> Compare contents buffer with fixed byte pattern. BUFCMP <type>, <index>, <offset>, <count>, <val> Compare contents buffer with incremental byte pattern. BUFCMP <type>, <index>, <offset>, <count>, <val>, <val1> Compare contents buffer with random byte pattern. BUFCMP <type>, <index>, <offset>, <count>, <seed> Compare contents buffer with integer data from command line. BUFCMP <type>, <index>, <offset>, <count>, <int> [int], [int],., [int]} Compare contents buffer with integers from command line. BUFCMP <type>, <index>, <offset>, <count>, <hex> [hex], [hex],., [hex]} Compare contents buffer with character string from command line. BUFCMP <type>, <index>, <offset>, <count>, <"string">
DESCRIPTION
BUFCMP <type>, <index>, <offset>, <count>, <type1>, <index1>, <offset1> This variant command performs byte-by-byte comparison contents transmit receive buffers, beginning specified offset from beginning buffer, specified number bytes. <type>, <type1> character constants designating type buffer: receive buffer, transmit buffer. <index>, <index1> integer values indicating descriptor ring with which buffer associated. first descriptor each ring referenced with index <offset> integer value indicating byte offset, from beginning buffer, where comparison begins. first byte each buffer referenced with offset <count> integer value indicating number bytes compare.
Revision
EMON User Manual
BUFCMP <type>, <index>, <offset>, <count>, <val> Compare contents transmit receive buffer with fixed byte pattern. <type> character constant designating type buffer: receive buffer, transmit buffer. <index> integer value indicating descriptor ring with which buffer associated. first descriptor each ring referenced with index <offset> integer value indicating byte offset, from beginning buffer, where comparison begins. first byte each buffer referenced with offset <count> integer value indicating number bytes compare. <val> fixed 8-bit integer value that used value compare with bytes specified buffer.
BUFCMP <type>, <index>, <offset>, <count>, <val>, <val1> Compare contents transmit receive buffer with incremental byte pattern. <type> character constant designating type buffer: receive buffer, transmit buffer. <index> integer value indicating descriptor ring with which buffer associated. first descriptor each ring referenced with index <offset> integer value indicating byte offset, from beginning buffer, where comparison begins. first byte each buffer referenced with offset <count> integer value indicating number bytes compare. <val> 8-bit integer indicating first value incrementing pattern. <val1> 8-bit integer indicating last value incrementing pattern. When number bytes compare, specified <count>, greater than range target values, specified <val1> <val>, pattern automatically wraps around continues with <val>.
BUFCMP <type>, <index>, <offset>, <count>, <seed> Compare contents transmit receive buffer with pseudo random byte pattern. <type> character constant designating type buffer: receive buffer, transmit buffer. <index> integer value indicating descriptor ring with which buffer associated. first descriptor each ring referenced with index <offset> integer value indicating byte offset, from beginning buffer, where comparison begins. first byte each buffer referenced with offset <count> integer value indicating number bytes compare. <seed> 16-bit integer used seed value pseudo random number generator.
EMON User Manual
Revision
BUFCMP <type>, <index>, <offset>, <count>, <int> [int], [int],., [int]} Compare contents transmit receive buffer with specified integer data pattern. <type> character constant designating type buffer: receive buffer, transmit buffer. <index> integer value indicating descriptor ring with which buffer associated. first descriptor each ring referenced with index <offset> integer value indicating byte offset, from beginning buffer, where comparison begins. first byte each buffer referenced with offset <count> number bytes compare. <count> number bytes compare determined number bytes specified <int> field. When <count> greater than number bytes specified <int> field, specified data pattern used repeatedly until <count> bytes have been compared. <int> more integer expressions, separated commas, compared with data from buffer. Each expression represents single byte. integer value greater than 255, that value replaced value modulo 256. Data extend over more than line.
BUFCMP <type>, <index>, <offset>, <count>, <hex> [hex], [hex],., [hex]} Similar option above, except that data pattern specified more hexadecimal numbers separated commas. prefix needed, fact, must used.
BUFCMP <type>, <index>, <offset>, <count>, <"string"> Similar option above, except that data pattern specified string variable ASCII character string enclosed double quotation marks (e.g., "this string compare").
Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR comparison matches, non-zero otherwise. ARG1 offset mismatch value (from start buffer) ERROR set. ARG2 mismatch value ERROR set. ARG3 expected value ERROR set.
EXAMPLE
bufcmp 100, print "%d\n", error this example, first bytes first Receive buffer compared first bytes first Transmit buffer. result comparison checked printing contents global variable ERROR, which this case indicating that comparison matched.
Revision
EMON User Manual
EXAMPLE
bufcmp 100, 100, 0xFF Mismatch buffer location 0x123: 0x00 0xFF This example illustrates what happens when buffer mismatch detected. This example checks bytes through second receive buffer 0xFF. bufcmp function reports mismatch byte 0x123, value 0x00 0xFF.
EXAMPLE
bufcmp 127, 100, this example, first bytes 128th transmit buffer compared incremental pattern ranging from 255.
EXAMPLE
bufcmp 100, 0x1234 this example, first bytes first receive buffer compared sequence pseudo random data generated from seed 0x1234.
EXAMPLE
bufcmp This example compares bytes offset through third transmit buffer with repeating pattern Since value <count> field greater than number data bytes command line, expected data repeated.
EXAMPLE
bufcmp This example compares first three bytes transmit buffer with hexadecimal pattern 0xF1, 0xE2, 0xD3. Since number bytes included comparison string greater than value <count> field, last bytes command line ignored.
EXAMPLE
err_msg$ err_msg$ "This obnoxious error message." bufcmp err_msg$ This example compares specified string ("This obnoxious error message.") with data located transmit buffer starting offset
EMON User Manual
Revision
BUFRD
NAME
BUFRD Display contents transmit receive buffer.
SYNOPSIS
BUFRD <type>, <index> [offset], [count]}
DESCRIPTION
This command let's display contents transmit receive buffers. specified buffer displayed traditional hexadecimal dump format with characters appropriate ASCII translation. display includes byte offsets left margin which indicate relative offset with respect beginning buffer. <type> character constant designating type buffer: receive buffer, transmit buffer. <index> integer value indicating descriptor ring with which buffer associated. first descriptor each ring referenced with index [offset] optional integer value indicating byte offset, from beginning buffer, where display begins. When offset specified, buffer display begins with first byte buffer. This also results default count value [count] optional integer value indicating number bytes display. specify count value other than default value offset parameter must also specified. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise. ARG1 ARGn first bytes read less, <count> less than
Revision
EMON User Manual
EXAMPLE
bufrd 0000: 0010: 0020: 0030: ABCDEFGHIJKLMNOP QRSTUVWXYZ[\]^_` abcdefghijklmnop qrstuvwxyz{|}~.
this example, first bytes first receive buffer displayed.
bufrd 0050: 0060: 0070: 0080:
0x50
this example, bytes first transmit buffer starting byte 0x50 displayed. None hexadecimal characters translate ASCII printing characters.
bufrd 0x50, 0x10 0050: this example, bytes first transmit buffer starting byte 0x50 displayed.
EMON User Manual
Revision
BUFWR
NAME
BUFWR Write data transmit receive buffer.
SYNOPSIS
BUFWR <type>, <index>, <offset>, <count>, <type1>, <index1>, <offset1> BUFWR <type>, <index>, <offset>, <count>, <val> BUFWR <type>, <index>, <offset>, <count>, <val>, <val1> BUFWR <type>, <index>, <offset>, <count>, <seed> BUFWR <type>, <index>, <offset>, <count>, <int> [int], [int],., [int]} BUFWR <type>, <index>, <offset>, <count>, <hex> [hex], [hex],., [hex]} BUFWR <type>, <index>, <offset>, <count>, <"string">
DESCRIPTION
BUFWR <type>, <index>, <offset>, <count>, <type1>, <index1>, <offset1> first parameters specify destination buffer second parameters specify source buffer. This command copies contents source buffer destination buffer. <type>, <type1> character constants designating type buffer: receive buffer, transmit buffer. <index>, <index1> integer values indicating descriptors ring with which buffers associated. first descriptor ring index <offset>, <offset1> integer values indicating byte offset from beginning buffer which copying should start. <count> integer value indicating number bytes copy.
BUFWR <type>, <index>, <offset>, <count>, <val> Write fixed byte pattern specified transmit receive buffer. <type> character constant designating type buffer: receive buffer, transmit buffer. <index> integer value indicating descriptor ring with which buffer associated. first descriptor ring index <offset> integer value indicating byte offset from beginning buffer which writing should start. <count> integer value indicating number bytes write. <val> 8-bit integer value used fill pattern.
Revision
EMON User Manual
BUFWR <type>, <index>, <offset>, <count>, <val>, <val1> Write incrementing byte pattern specified transmit receive buffer. <type> character constant designating type buffer: receive buffer, transmit buffer. <index> integer value indicating descriptor ring with which buffer associated. first descriptor ring index <offset> integer value indicating byte offset from beginning buffer which writing should start. <count> integer value indicating number bytes write. <val> 8-bit integer indicating first value incrementing fill pattern. <val1> 8-bit integer indicating last value incrementing fill pattern. When number bytes write, specified <count>, greater than range target values, specified <val1> <val>, pattern automatically wraps around continues with <val>.
BUFWR <type>, <index>, <offset>, <count>, <seed> Write pseudo random byte pattern specified transmit receive buffer. <type> character constant designating type buffer: receive buffer, transmit buffer. <index> integer value indicating descriptor ring with which buffer associated. first descriptor ring index <offset> integer value indicating byte offset from beginning buffer which writing should start. <count> integer value indicating number bytes write. <seed> 16-bit integer used seed value pseudo random number generator.
BUFWR <type>, <index>, <offset>, <count>, <int> [int], [int],., [int]} Write more integer byte values specified transmit receive buffer. <type> character constant designating type buffer: receive buffer, transmit buffer. <index> integer value indicating descriptor ring with which buffer associated. first descriptor ring index <offset> integer value indicating byte offset from beginning buffer which writing should start.
EMON User Manual
Revision
<count> number bytes load into buffer when single <int> parameter specified. <count> number bytes write determined number bytes specified <int> field. <count> greater than number bytes specified <int> field, data pattern used repeatedly until <count> bytes have been loaded into buffer. BCNT field associated descriptor changed agree with <count>. This lets change small portion large buffer without changing BCNT. data will written past buffer regardless values <count> <offset>. <offset> <count> greater than size buffer, data will truncated buffer. <int> more integer expressions, separated commas, loaded into specified buffer. Each expression represents single byte. integer value greater than 255, that value replaced value modulo 256. Data extend over more than line.
BUFWR <type>, <index>, <offset>, <count>, <hex> [hex] [hex],., [hex]} Similar option above, except that data pattern specified more hexadecimal numbers separated commas. prefix needed, fact, must used.
BUFWR <type>, <index>, <offset>, <count>, <"string"> Similar option above, except that data pattern specified string variable ASCII character string enclosed double quotation marks (").
Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
setup 8,200,8,200 bufwr 100, this example, first bytes first transmit buffer copied into first receive buffer starting byte offset
EXAMPLE
setup 8,200,8,200 bufwr 100, 100, 0xFF this example, second bytes second receive buffer filled with value 0xFF.
Revision
EMON User Manual
EXAMPLE
setup 8,200,8,200 bufwr 100, this example, first bytes transmit buffer written with incrementing pattern range (0x00) (0xFF).
EXAMPLE
setup 8,200,8,200 bufwr 100, 0x1234 this example, first bytes first receive buffer written with pseudo random data generated from seed 0x1234.
EXAMPLE
setup 8,200,8,200 bufwr This command writes byte sequence, into third transmit buffer starting byte number Since value specified <count> field greater than number data bytes specified, fill pattern repeated until <count> bytes.
EXAMPLE
setup 8,200,8,200 bufwr This command writes 0xF1, 0xE2, 0xD3 into first bytes third transmit buffer. Since number bytes entered greater than value specified <count> field, last bytes from command line ignored.
EXAMPLE
setup 8,200,8,200 err_msg$ err_msg$ "This obnoxious error message." bufwr err_msg$
This command writes character string, "This obnoxious error message.", into third transmit buffer starting byte number
EMON User Manual
Revision
CARD
NAME
CARD Select network interface card following operations.
SYNOPSIS
CARD <index>
DESCRIPTION
This command will activate network interface card with index (card number) specified. subsequent commands will directed specified card. Note that prompt will change, reflects index currently selected card. <index> integer range through Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
card show_cards: Info Total cards allocated: CARD: IOBASE: x0300 DMA: IRQ: CTLR: PCnet-ISA MODE: BUS_MASTER CARD: IOBASE: x0300 DMA: IRQ: CTLR: PCnet-ISA MODE: BUS_MASTER card Selected network interface card this example, configuration information pair installed cards displayed then command focus switched from card card
Revision
EMON User Manual
CFGRD
NAME
CFGRD Display more configuration register.
SYNOPSIS
CFGRD <reg offset> [reg offset],., [reg offset]}
DESCRIPTION
This command lets display more configuration registers. Multiple registers displayed with single command. <reg> character constant which indicates name register. Register Description PCnet-PCI Configuration Registers Vendor Register Device Register Command Register stat Status Register Revision Register Programming Interface Register sclass Class Register bclass Base Class Register Latency Timer Register head Header Type Register iobase Base Address Register Interrupt Line Register irqpin Interrupt Register mingnt Minimum Grant Register maxlt Maximum Latency Register eraddr Expansion Base Address Register mmaddr Memory Mapped Base Address Register Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
<offset> integer value which indicates double word offset register. Since these registers accessed double word boundaries, offset value must multiple four.
RETURN
ARG1 ARGn contain values register read order specified. <reg> ARG1 ARG2 ARG3 ARG4 stat ARG5 ARG6 ARG7 sclass ARG8 bclass ARG9 ARG10 head ARG11 iobase ARG12= ARG13= irqpin EMON User Manual Revision
ARG14= mingnt ARG15= maxlt ARG16= eraddr ARG17= mmaddr <reg> iobase ARG1 iobase<31-0> ERROR command successful, non-zero otherwise.
EXAMPLE
cfgrd iobase IOBASE 0xE800 this example, base address displayed.
EXAMPLE
cfgrd STAT SCLASS BCLASS HEAD IOBASE IRQPIN MINGNT MAXLT ERADDR MMADDR 0x1022 0x2000 0x01c5 0x0200 0x00 0x00 0x00 0x02 0x00 0x00 0xe801 0x0a 0x02 0x00 0x00 0xfbfef000
config space mapping port 0x80004800 (mechanism this example, configuration registers displayed.
Revision
EMON User Manual
CFGWR
NAME
CFGWR Write more configuration register.
SYNOPSIS
CFGWR <reg offset>, <val> [reg offset, val],., [reg offset, val]}
DESCRIPTION
This command lets write more configuration registers. Multiple registers modified with single command, long register name corresponding parameter values kept together command line.
<reg> character constant which indicates name register. Register stat iobase eraddr mmaddr Description Command Registers Status Register Latency Timer Register Base Address Register Interrupt Line Register Expansion Base Address Register Memory Mapped Base Address Register
<offset> integer value which indicates double word offset register. Since registers accessed double word boundaries, offset value must multiple four must provide 32-bit data value such 0x12345678.
<val> integer value. size value enter must correspond size configuration register being written. stat, then specify 16-bit value range 0x0000 through 0xFFFF. iobase, eraddr, mmaddr, specify 32-bit value range 0x00000000 through 0xFFFFFFFF. then specify 8-bit value range 0x00 through 0xFF. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
EMON User Manual
Revision
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
cfgwr cfgwr cfgwr cfgwr iobase,0xE800 cmd,0x0001 stat,0x8000 irq,0x05
this example, base address 0x0300 then Command Register IOEN indicate valid base address. Next, reset Parity Error Status Register. Last, change Interrupt Line Register indicate that this device requesting IRQ5.
Revision
EMON User Manual
CLEAR
NAME
CLEAR Deactivate status condition reported Control Status Register PCnet controller.
SYNOPSIS
CLEAR <bit>
DESCRIPTION
CLEAR command gives quick mnemonic method deactivate commonly used status bits Control Status Register PCnet family controller. This command automatically determines number polarity you, then performs register write operation. CLEAR will either appropriate reset appropriate required deactivate status. accomplish same action using REGWR command then you'd have know position polarity bit. related EMON command, SET, complement CLEAR command allows activate control function with simple command. <bit> character constant identifying control function deactivated. Valid names supported status bits CSR0 register are: idon Initialization Done indicates that initialization sequence completed. tint Transmit Interrupt after transmission frame toggling last buffer Transmit Descriptor Ring. Receive Interrupt after reception receive frame toggling last buffer Receive Descriptor Ring. Memory Error when master controller received DACK assertion after 50us after assertion. Missed Frame when controller lost incoming receive frame because receive descriptor available. Collision Error indicates that collision inputs port failed activate within network times after chip terminated transmission. Babble transmitter time-out error indicating transmitter been channel longer than time required send maximum length frame.
rint
merr
miss
cerr
babl
Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
clear idon this example, initialization done status (CSR0: deactivated.
EMON User Manual
Revision
DATE
NAME
DATE Display date time.
SYNOPSIS
DATE
DESCRIPTION
current system date time written current output.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
date 11:59:32 1999
Revision
EMON User Manual
DESCRD
NAME
DESCRD Display contents descriptor ring entry.
SYNOPSIS
DESCRD <type>, <index>, <field> [field],., [field]}
DESCRIPTION
Read display values specified fields descriptor ring entry. names active flags within field displayed, too. <type> character constant designating type descriptor ring: receive ring, transmit ring. <index> integer value indicating which descriptor ring accessed. first descriptor ring index <field> character constant designating field descriptor entry. receive descriptor valid values this constant are: fields descriptor Buffer Address bcnt Buffer Byte Count Status mcnt Message Count Runt Packet Count Receive Collision Count transmit descriptor valid values this constant are: fields descriptor Buffer Address bcnt Buffer Byte Count Status Error Status Time Domain Reflectometry Transmit Retry Count rcc, rpc, fields used only with PCnet-32 PCnet-PCI controllers. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
EMON User Manual
Revision
RETURN
ERROR command successful, non-zero otherwise. ARG1 ARGn contain values descriptor fields read order specified. <type> <field> ARG1 adr, ARG2 bcnt, ARG3 sts, ARG4 mcnt, ARG5 rpc, ARG6 rcc. <type> <field> ARG1 adr, ARG2 bcnt, ARG3 sts, ARG4 err, ARG5 tdr, ARG6 trc.
EXAMPLE
descrd Receive Buffer Address 0x00025404 Receive Buffer Byte Count Receive Status 0x8000 Receive Message Count Receive Descriptor Address 0x00042b88 this example, contents first receive descriptor displayed.
EXAMPLE
descrd Transmit Buffer Address 0x00043034 Transmit Buffer Byte Count Transmit Status 0x4300 Transmit Error Starus 0x0400 RTRY Time Domain Reflectometry Transmit Descriptor Address 0x00042b88 this example, contents first transmit descriptor displayed.
Revision
EMON User Manual
DESCWR
NAME
DESCWR Write value descriptor ring entry.
SYNOPSIS
DESCWR <type>, <index>, <field>, <val> [field, val],., [field, val]}
DESCRIPTION
Write value more fields descriptor ring entry. Multiple fields modified with command, long they specified pairs, field, val. <type> character constant designating type descriptor ring: receive buffer, transmit buffer. <index> integer value indicating which descriptor ring accessed. first descriptor ring index <field> character constant designating field descriptor. receive descriptor valid values this constant fields descriptor Buffer Address bcnt Buffer Byte Count (16-bit positive integer) Status mcnt Message Count Runt Packet Count* Receive Collision Count* transmit descriptor valid values this constant fields descriptor Buffer Address bcnt Buffer Byte Count (16-bit positive integer) Status Error Status Time Domain Reflectometry Transmit Retry Count* <val> specifies integer value corresponding length parameter which value being written. <type> <field> all, then <val> adr, bcnt, sts, mcnt, rpc, rcc. <type> <field> all, then <val> adr, bcnt, sts, err, tdr, trc. *The rpc, rcc, fields present PCnet-ISA controllers. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
EMON User Manual
Revision
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
descwr all, 0x1000, 500, 0x8300, this example, second transmit descriptor entry changed that buffer address will 0x1000, buffer byte count will status will 0x8300, which means that OWN, will set. transmit error status, time domain reflectometer transmit retry count field will
Revision
EMON User Manual
ECHOM
NAME
ECHOM Generates stream packets checks packet echo destination node.
SYNOPSIS
ECHOM [[N, number] number]], number], "filename"],
DESCRIPTION
ECHO Master command designed used with ECHO Slave (ECHOS) command which parallel under EMON another node network. ECHO Master sends burst serialized packets then allows some time packets received echoed destination node. ECHO Master keeps track transmitted received (echoed) packets that errors reported. ECHOM waits packet specified period time before timing out, logging error, continuing with next packet. time period with ECHOTIME command. Before invoking ECHOM ECHOS commands, responsible setting descriptor rings, data buffers, initializing controller with descriptor information. number receive descriptors less than number transmit descriptors, error message displayed, command executed. Also, receive buffers must least four bytes larger than transmit buffers there space bytes. Otherwise, error message displayed. option specified command line, ECHOM runs continuously until pressed. When ECHOM terminates, number packets sent, number packets received, number errors detected displayed. addition, STAT command used display this status information time. counters cleared with STATC command. Each iteration consists following steps: Sequence numbers written into first byte data field every transmit buffer that currently allocated. contents transmit buffers transmitted burst. transmit descriptors checked transmit errors. receive buffers checked verify that packets have been echoed back. EMON checks sequence number each received packet. expected packet missing after time limit (which specify), error message displayed.
number] Optional number iterations. This option option mutually exclusive. number] Optional number packets transmit. This option option mutually exclusive. number] Optional number lost packets allow before aborting command. Lost packets packets echoed back from Echo Slave node. "filename"] Optional name ASCII text file with data transmitted. file name must enclosed double quotes remember include full path file current directory. Optional mode verify data echoed back packets when option specified. option selected, then echoed back packets will written file named TMPFILE EMON displays result comparing files.
EMON User Manual
Revision
Performance Hint: After transmitting burst packets, ECHOM checks that packets have been received, performs some housekeeping restart process, then restarts process. This sequence causes period inactivity network while housekeeping takes place. period inactivity between bursts packets significantly reduced message output disabled with OPTIONS command. After ECHOM this mode, status information displayed first turning output back then using STAT command view accumulated totals.
RETURN
Does affect global variable.
EXAMPLE
init strt setup 4,104,4,100 bufwr t,0,0,0,h, bufwr t,1,0,0,h, bufwr t,2,0,0,h, bufwr t,3,0,0,h, bufwr t,0,14, bufwr t,1,14, bufwr t,2,14, 0xA5 bufwr t,3,14, 3,2,1 echotime 1000 ECHO timeout 0.99 seconds echom
clock ticks)
This example command sequence allocates four receive four transmit buffers, loads destination address, source address, length, data fields transmit buffers, sets time-out delay second, sends three bursts four packets each.
EXAMPLE
echom "test.txt", Assuming setup similar Example this example command sequence transmits text file "test.txt" five times verifies echoed back data (i.e., compares files).
Revision
EMON User Manual
ECHOS
NAME
ECHOS Received packets transmitted back originating node.
SYNOPSIS
ECHOS [[N, number] number]]
DESCRIPTION
ECHO Master command designed used with ECHO Slave (ECHOS) command which resides another node network. ECHOM sends series packets checks that each packet echoed ECHOS running receiving node. ECHOS exchanges contents destination address source address fields receive buffer, makes next available transmit descriptor point current receive buffer, transmits packet, releases receive buffer. make room bytes, receive buffers must least four bytes larger than longest message expected. option specified command line, ECHOS runs continuously until pressed. When ECHOS terminates, number packets sent, number packets received, number errors detected displayed. addition, STAT command used display this status information time. counters cleared with STATC command.
number] Optional number iterations echoed back. This option option mutually exclusive. number] Optional number packets echoed back. This option option mutually exclusive.
Performance Hint: between bursts packets reduced significantly printing disabled OPTIONS OUTPUT, command. After ECHOS this mode, status information displayed first turning output back then using STAT command.
RETURN
Does affect global variable.
EMON User Manual
Revision
EXAMPLE
setup 4,104,4,100 Initialization Block Address 0x4eeb4 Base Address Descriptor Ring 0x4eee8 Number Descriptors Base Address Descriptor Ring 0x4ef78 Number Descriptors echos 1200 pkts sent. bytes sent with CRC. bytes CRC) pkts rcvd. bytes rcvd with CRC. bytes CRC) Transmit errors Receive errors Echo errors BUFF FRAM Lost/corrupt packet UFLO OFLO LCOL Echo timeout RTRY BUFF LCAR Transmit collision statistics: MORE Receive collisions: Missed packets:
MISC errors BABL CERR MISS MERR
This example allocates four receive four transmit buffers echoes back next 1200 packets received.
Revision
EMON User Manual
ECHOTIME
NAME
ECHOTIME Set/Display time-out period used ECHOM ECHOS commands.
SYNOPSIS
ECHOTIME [delay]
DESCRIPTION
Sets displays length time (time-out period) that EMON will wait response from another node while ECHOM command executing. [delay] Length time milliseconds that ECHOM ECHOS command will wait echo before displays error message. delay time-out disabled. Entering command itself, with arguments, will invoke message displaying current time-out period.
RETURN
Does affect global variable.
EXAMPLE
echotime above command sets time-out delay ECHOM ECHOS command second.
EMON User Manual
Revision
FCLOSE
NAME
FCLOSE Close previously opened file.
SYNOPSIS
FCLOSE <index>
DESCRIPTION
FCLOSE closes file identified <index>. <index> integer value indicating file which should closed. index must value returned from FOPEN command. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
fclose File with index closed. this example, file with index closed.
Revision
EMON User Manual
FOPEN
NAME
FOPEN Open file writing.
SYNOPSIS
FOPEN <"filename">
DESCRIPTION
Open file writing only. file already exists, contents will destroyed before writing performed. file does exist file will created. maximum number files that simultaneously open depends host system. typically around <"filename"> name file. Remember include full path necessary. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise. ARG1 file index file which opened. operations file this index used.
EXAMPLE
fopen "error.log" file index fprint 3,"Test failed." this example, file ERROR.LOG opened writing. file index returned file opened correctly.
EMON User Manual
Revision
FPRINT
NAME
FPRINT Write file.
SYNOPSIS
FPRINT <index>, <format$> [arg],., [arg]}
DESCRIPTION
FPRINT used write argument list open file specified with file index. <index> file index which returned when file opened with FOPEN command. File index reserved stdout. <format$> string that controls output format arguments. format string contains types characters: plain text conversion characters. Plain text simply copied output stream. backslash character used display special characters. following table shows backslash character interpreted: newline (left margin next line) horizontal backspace carriage return (left margin) form feed backslash character single quote character double quote character \ddd control character (specified octal) Conversion characters used apply specific format argument. There must exactly conversion character each argument following list. conversion characters start with percent character (%). This list valid options conversion character: ASCII string integer decimal notation integer hexadecimal notation percent character [arg] either integer string constant variable. Multiple arguments specified with single PRINT statement. Entering FPRINT command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
global test, test$ test 0x1234 test$ "test" fprint "this decimal notation: %d\n", test$, test this test decimal notation: 4660 fprint "this notation: 0x%x\n", test$, test this test notation: 0x1234 Revision EMON User Manual
FUNCTION
NAME
FUNCTION Declare callable function.
SYNOPSIS
FUNCTION FUNCTION <name> [arg],., [arg]}
DESCRIPTION
FUNCTION Entering command itself, with arguments, will display list functions declared.
FUNCTION <name> [arg],., [arg]} Declares callable function batch file declares list arguments which passed function. command lines between function declaration next function declaration, end-of-file, part that function. Input variables, specified function declaration line, must exactly match arguments being passed when function called. function called from command line (after batch file been RUN) another batch file, since calling scope function global. <name> character constant indicating name function. [arg] list arguments, passed called function, which type integer string.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
function f_error, errstrng$, errid print %d\n", errstrng$, errid function test, testid testid return print "%d\n", testid This example shows listing small batch file with declaration functions. first function, called f_error, arguments. argument errstrng$ type 'string', whereas errid integer argument. Function f_error contains only command line, which print statement. body this function automatically delimited declaration next function, called test. function test itself delimited end-of-file, second command line, print statement, last line batch file.
EMON User Manual
Revision
GENCRC
NAME
GENCRC Generate 802.3 controller accessible memory area.
SYNOPSIS
GENCRC <addr>, <count>
DESCRIPTION
Calculate specified 802.3 standard controller accessible memory area. <addr> integer value indicating start address memory area calculation. <count> integer value indicating total number bytes calculated Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise. ARG1 CRC(31-24). ARG2 CRC(23-16). ARG3 CRC(15-8). ARG4 CRC(7-0).
EXAMPLE
descrd adr, mcnt gencrc arg1, arg2 this example, received frame calculated. frame stored buffer receive descriptor pointing calculated complete length received frame excluding last bytes, these byte transmitter generated CRC.
Revision
EMON User Manual
GLOBAL
NAME
GLOBAL Display global variables declare more global variables.
SYNOPSIS
GLOBAL GLOBAL [arg] [arg],., [arg]}
DESCRIPTION
GLOBAL Entering GLOBAL with command line arguments causes internal global table displayed. contents global variables, including default ARG1 through ARG32 ERROR, shown. global variable table displayed variable line. Therefore, when output directed screen, some information going scroll screen. method deal with this condition create batch file that redirects EMON output file, runs GLOBAL command, then redirects output back screen. then view print information captured file.
GLOBAL <arg> [arg],., [arg]} GLOBAL, with list arguments, declares variables which accessible EMON commands. Global variables read written with commands from keyboard, with commands from batch file, commands multiple batch files. Since global variables visible across multiple batch files, this allows batch file increment error counter which displayed different batch file, then written file with another batch file. When your batch files finished running, could display global variables from keyboard using first form command. global variable exists name again declared, global variable table full, warning message will appear most recently declared variable will ignored. <arg> integer string variable name, list integer string variable names. names must different from EMON reserved word name used batch files functions declared those batch files.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
global zz$, top, count "Hello World" count 1234
this example, string variable (zz$) integer variables (top count) declared global then some interesting values.
EMON User Manual
Revision
EXAMPLE
global ARG1 ARG10 ARG11
ARG7 ARG8 ARG9 COUNT ERROR OUT_DEV
1234 "Hello World"
this example, contents global table displayed. Note that global variables, including defaults ARG1 through ARG32 ERROR displayed along with global variables have declared.
Revision
EMON User Manual
GOTO
NAME
GOTO Transfer batch file processing different section same function.
SYNOPSIS
GOTO <label>
DESCRIPTION
GOTO with label causes batch file processor transfer control from section batch file another section. destination determined specified label. GOTO only reference labels that exist same function. This rule applies main module batch file well. Hence, scope GOTO internal function This will allow identical labels same batch file, long they different functions. <label> identifier which used batch file processor continue executing commands. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
ERROR GOTO ABORT
ABORT: ERRCOUNT ERRCOUNT STOPB this example, code segment where variable (ERROR) examined TRUE, program control transferred code segment beginning with label ABORT.
EMON User Manual
Revision
HELP
NAME
HELP Display on-line help information.
SYNOPSIS
HELP HELP [command]
DESCRIPTION
HELP HELP entered itself with argument command line displays summary EMON commands organized alphabetically.
HELP [command] HELP entered with specific command name causes EMON display syntax simple explanation specified command. [command] legal EMON commands. first type HELP itself list legal commands then enter help command specific command.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
HELP STOPB STOPB Stop EMON batch file processing enter interactive mode. this example, help command will display syntax explanation STOPB command.
Revision
EMON User Manual
NAME
Conditional statement.
SYNOPSIS
<expression>, <statement>
DESCRIPTION
conditional statement begins with keyword followed control expression statement. control expression evaluates non-zero value, then <statement> executed. control expression evaluates zero value, then execution continues with statement immediately following conditional statement. <expression> control expression which integer string variable. expression include multiple operands operators. control expression evaluates taken false; evaluates non-zero, taken true. <statement> either EMON command, such GOTO ABORT, could variable assignment such ERRCOUNT ERRCOUNT+1. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
ERROR ERROR ERROR, ERRCOUNT ERRCOUNT+1 ERROR, TEST2 ERROR, GOTO ABORT these three examples, test variable ERROR followed three conditional statements. Since ERROR evaluates true each case, conditional statements executed. first case, simple variable assignment takes place. second case, batch file TEST2 executed. last case, program control transferred code located label ABORT.
EMON User Manual
Revision
INITRD
NAME
INITRD Display contents initialization block.
SYNOPSIS
INITRD <field> [field],., [field]}
DESCRIPTION
Read display values specified fields initialization block. names active flags within field displayed, too. <field> character constant designating field initialization block. valid values this are: seven fields initialization block: mode, ladrf, padr, tdra, tlen, rdra, rlen. mode 16-bit mode register ladrf 64-bit logical address filter padr 48-bit physical address register displayed hexadecimal bytes tdra 32-bit transmit descriptor ring address tlen bits representing number transmit descriptors rdra 32-bit receive descriptor ring address rlen four bits representing number receive descriptors. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise. ARG1 ARGn contain values field read order specified. <field> ARG1 mode, ARG2 ladrf<31-0>, ARG3 ladrf<63-32>, ARG4 padr<7-0>, ARG5 padr<15-8>, ARG6 padr<23-16>, ARG7 padr<31-24>, ARG8 padr<39-32>, ARG9 padr<47-40>, ARG10 tdra, ARG11 tlen, ARG12 rdra, ARG13 rlen. <field> ladrf ARG1 ladrf<31-0>, ARG2 ladrf<63-32>. <field> padr ARG1 padr<7-0>, ARG2 padr<15-8>, ARG3 padr<23-16>, ARG4 padr<31-24>, ARG5 padr<39-32>, ARG6 padr<47-40>. Revision EMON User Manual
EXAMPLE
initrd tdra Base Address Descriptor Ring 0x0000ff54
this example, bits transmit descriptor ring address read displayed.
EXAMPLE
initrd Mode: 0x162 INTL DRTY GPSI Logical Address Filter: 0x007006f4 0ac102cf Physical Address: Base Address Descriptor Ring 0x007006f4 Number Descriptors(2**rlen): Base Address Descriptor Ring 0x0000ff54 Number Descriptors(2**tlen):
EMON User Manual
Revision
INITWR
NAME
INITWR Write controller initialization block.
SYNOPSIS
INITWR <field>, <val> [field, val],., [field, val]}
DESCRIPTION
INITWR <field>, <val> [field, val],., [field, val]} This command lets write more fields controller initialization block. Multiple fields modified with single command, long field name it's corresponding parameter values kept together command line. <field> name, list names, specific initialization block fields. mode 16-bit mode register. padr 48-bit physical address. ladrf 64-bit logical address filter. rdra 24-bit receive descriptor ring address. rlen 3-bit receive descriptor ring length. tdra 24-bit transmit descriptor ring address. tlen 3-bit transmit descriptor ring length. <val> specifies more integer values corresponding length initialization block field which value being written. Values must separated commas, field requires more than one. field mode, then specify 16-bit value. Values range 0x0000 through 0xFFFF legal. field padr, then specify 48-bit physical address expressed bytes. first byte value interpreted bits 7-0, second byte value interpreted bits 15-8, remaining four bytes. addition basic 46-bit physical address, remember that there additional bits which control address type designation (individual group (logical)) distinguish between locally globally administered addresses. field ladrf, then specify 64-bit logical address filter 32-bit values. first 32-bit value interpreted bits 63-32, second 32-bit value interpreted bits 31-0. Values range 0x00000000,0x00000000 through 0xFFFFFFFF,0xFFFFFFFF legal. field rdra tdra, then specify 24-bit descriptor ring address expressed 24-bit value. Note that controller requires quadword aligned address which means that bits address must zeros. field rlen tlen, then specify 3-bit descriptor ring length value. Values range through legal. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise.
Revision
EMON User Manual
EXAMPLE
initwr mode,0xDEADBEEF initwr ladrf,0x01234567,0x89ABCDEF initwr initwr rdra,0x123456 initwr rlen,0x7 initwr tdra,0x789ABC initwr tlen,0x4
this example, each field requires slightly different parameter format. initialization block produced this example sequence would appear follows. Higher Addresses: TLEN-TDR(23-16) TDRA(15-0) RLEN-RDRA(23-16) RDRA(15-0) LADRF(63-48) LADRF(47-32) LADRF(31-16) LADRF(15-0) PADR(47-32) PADR(31-16) PADR(15-0) Lower Addresses: MODE(15-0) IADR+22 IADR+20 IADR+18 IADR+16 IADR+14 IADR+12 IADR+10 IADR+08 IADR+06 IADR+04 IADR+02 IADR+00 0xxxxx 0xxxxx 0xxxxx 0xxxxx 0xxxxx 0xxxxx 0xxxxx 0xxxxx 0xxxxx 0xxxxx 0xxxxx 0xxxxx
EMON User Manual
Revision
INPUT
NAME
INPUT input from terminal.
SYNOPSIS
INPUT <format$>, <var> [var],., [var]}
DESCRIPTION
This command used input from keyboard during batch file execution. Data entered response INPUT command assigned corresponding variable. number data items supplied must same number variables list. type each data items must agree with type specified variable name. Strings that entered satisfy INPUT statement must surrounded double quotation marks cannot include blanks. <format$> string that controls input format arguments. format string contains types characters: plain text conversion characters. Plain text ignored. Normally, plain text should only consist blanks readability format string. Conversion characters used apply specific format argument. There must exactly conversion character each argument following list. conversion characters start with percent character (%). This list valid options conversion character: string integer decimal notation integer hexadecimal notation <var> integer string variable name. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
global test1, test2, test$ label1: print "Enter string, integer decimal integer" input test$, test1, test2 !error, goto label print "Not enough arguments" goto label1: label2: print %d\n", test$, test1, test2 This example shows short section batch file code. global variable error used check correct number arguments required INPUT command.
Revision
EMON User Manual
IORD
NAME
IORD Display card configuration register information data from resource (port).
SYNOPSIS
IORD <rscr> [rscr],., [rscr]} IORD d]<port>
DESCRIPTION
With this command display contents network interface card configuration register data from resource, also know port. <rscr> character constant which indicates name configuration register. Valid values PCnet family cards are: gadr Global address network interface card. iobase Base address network interface card. Number interrupt channel used network interface card. character constant which indicates byte, word, double-word access. default read performed word access. <port> hexadecimal value indicating address resource (port) read. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise. ARG1 ARGn contain values resources read order specified.
EXAMPLE
iord gadr, iobase, Global Address Network Interface Card Base Address 0xe800 Network Interface Card Interrupt Channel this example, configuration card displayed. Notice that three resource specifiers have been included single command line. Note that ARG1 gadr<7-0>, ARG2 gadr<15-8>, ARGx+2 gadr<23-16>, ARGx+3 gadr<31-24>, ARGx+4 gadr<39-32>, ARGx+5 gadr<47-40>.
EMON User Manual
Revision
EXAMPLE
iord b,0xe800 Byte read from port (0xe800) iord w,0xe800 Word read from port (0xe800) 0x0000 iord d,0xe800 Double word read from port (0xe800) 0x00000000 this example, that I've asked information captured using byte access, word access, then double-word access.
EXAMPLE
iord 0xe800 Word read from port (0xe800) 0x0000 this example, I've asked read port 0xE800 have allowed EMON default word access capture information.
Revision
EMON User Manual
IOWR
NAME
IOWR Write value card configuration register resource (port).
SYNOPSIS
IOWR <rscr>, <val> rscr, val],., [rscr, val]} IOWR d]<port>, <val>
DESCRIPTION
This command allows write values network interface card configuration register resource, also known port. <rscr> character constant which indicates name configuration register. Valid values PCnet family cards are: iobase Base address network interface card. reset Global reset network interface card. character constant which indicates byte, word, double-word access. default write performed word access. <port> hexadecimal value indicating address resource (port) written. <val> hexadecimal value that will written. Note, that activate global reset network interface card, <val> value. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
iowr reset, this example, global reset network interface card activated.
EXAMPLE
iowr 0x320, 0x12 Byte (0x12) write port (0x320) iowr 0x320, 0x1234 Word (0x1234) write port (0x320) iowr 0x320, 0x12345678 Double word (0x12345678) write port (0x320) this example, I've asked information written using byte access, word access, then double-word access.
EMON User Manual
Revision
KBHIT
NAME
KBHIT Check currently available keystroke.
SYNOPSIS
KBHIT
DESCRIPTION
Check currently available keystroke. This command requires parameters.
RETURN
ERROR command successful, non-zero otherwise. ARG1 there keystroke available, otherwise ASCII code pressed key.
EXAMPLE
print "Press continue" loop: kbhit arg1 goto loop this example, batch file will stay loop, until pressed.
Revision
EMON User Manual
MODE
NAME
MODE software structure size slave access modes PCnet-32/PCnet-PCI.
SYNOPSIS
MODE <mode>, {<mode>}
DESCRIPTION
With this command, software structure size either 16-bit 32-bit structures, controller 32-bit accesses. desired, combine these actions command line. Software structure size specified with constants ssize16, ssize32, ssize32-3. When 16-bit software structures selected controller uses PCnet-ISA style structures. When 32-bit software structures selected controller uses Am79C900 ILACC style software structures. particular, Initialization Block Transmit Receive descriptor maps affected. should refer CSR58 (BCR20) descriptions PCnet-32, PCnet-PCI, PCnet-PCI data sheets complete details. Double Word (DWIO) accesses specified with constant io32. Note, that change from 16-bit accesses 32-bit accesses cannot change other direction. Once Double Word mode selected, only H_RESET S_RESET reset controller Word mode. <mode> character constant designating mode operation that controller should assume. ssize16 When selected, this mode indicates that PCnet-32 PCnet-PCI controller utilizes Am79C900 (ILACC) 16-bit software structures. BCR20, (SSIZE32) cleared zero. When selected, this mode indicates that PCnet-32 PCnet-PCI controller utilizes 32-bit software structures. BCR20, bits 0x02. This software style When selected, this mode indicates that PCnet-PCI controller utilizes 32-bit software structure. BCR20, bits 0x03. This software style Sets DWIO mode where PCnet-32 PCnet-PCI resources treated four-byte entities spaced four-byte address intervals. BCR18, (DWIO) one. Toggles special mode EMON operation that allows access non-standard registers. When MODE debug "on", specify register number even though normally range. Specifying MODE debug again toggles setting this special capability. only determine current debug setting off) actually specify command observe message displayed.
ssize32
ssize32-3
io32
debug
RETURN
ERROR command successful, non-zero otherwise.
EMON User Manual
Revision
EXAMPLE
mode Card MEM_SIZE: BUS_WIDTH: (WIO)
this example following power-on, current modes displayed.
EXAMPLE
mode Card MEM_SIZE: BUS_WIDTH: (WIO) mode ssize16 software structure size bits. mode Card MEM_SIZE: BUS_WIDTH: (WIO) this example following power-on, current modes displayed. Then software structure 16-bit memory structures, current mode displayed.
EXAMPLE
mode Card MEM_SIZE: BUS_WIDTH: (WIO) mode ssize32 software (memory) structure size 32-bit mode software style mode Card MEM_SIZE: BUS_WIDTH: (WIO) this example following power-on, current modes displayed. Then software structure 32-bit memory structures, current mode displayed.
Revision
EMON User Manual
EXAMPLE
mode Card MEM_SIZE: BUS_WIDTH: (WIO) mode ssize32-3 software (memory) structure size 32-bit mode software style mode Card MEM_SIZE: BUS_WIDTH: (WIO) this example following power-on, current modes displayed. Then software structure 32-bit memory structures, current mode displayed.
EXAMPLE
mode Card MEM_SIZE: BUS_WIDTH: (WIO) mode io32 width STRUCTURE) bits. mode Card MEM_SIZE: BUS_WIDTH: 32(DWIO) this example following power-on, current modes displayed. Then resource size changed 32-bits.
EXAMPLE
mode Card MEM_SIZE: BUS_WIDTH: (WIO) regrd bcr42 ERROR 512: Register number range. mode debug Debug mode Debug: BCNT P1/P2/PCnet-32 (off=0, on=others) regrd bcr42 ==(DEBUG)==> read_BCR(42) data(0x0) BCR42 0x0000 mode debug Debug mode off. this example following power-on, current modes displayed. Then, when attempt read unsupported fails, enable debug mode which allows read operation take place. When finished accessing unsupported BCR, toggle debug mode back "off" setting.
EMON User Manual
Revision
MONITOR
NAME
MONITOR Monitor network traffic accumulate statistics.
SYNOPSIS
MONITOR {[D, delay], number], [PA], [PH]}
DESCRIPTION
MONITOR command designed used with TRAFFIC command which parallel another node. MONITOR watches network traffic records received packets until press terminate command. delay] When this option included command line, MONITOR keeps track elapsed time between received packets. When elapsed time between packets reaches delay seconds, MONITOR displays error message terminates. number] When this option included command line, MONITOR keeps track number received packets. When number packets received reaches number packets, MONITOR terminates. [PA] invokes ASCII mode, which contents received packets displayed ASCII. [PH] invokes hexadecimal mode, which first bytes received packets displayed hexadecimal. MONITOR maintains counters number packets received each type receive error that hardware detect. When packet received, appropriate counters updated receive buffer released. MONITOR uses receive buffers that have previously allocated. MONITOR terminates when number packets have been received, receiver time-out occurs, pressed. When terminates, displays contents statistical counters.
RETURN
Does affect global variables.
EXAMPLE
setup 1518, 1514 init strt monitor
This command records statistics packets received until pressed seconds elapses between packets. collected statistics displayed upon command termination.
EXAMPLE
setup 1518, 1514 init strt monitor
This command performs hexadecimal dump first bytes packets receives. When pressed, collected statistics displayed command terminates.
Revision
EMON User Manual
OPTIONS
NAME
OPTIONS Enable, disable redirect command output messages.
SYNOPSIS
OPTIONS OPTIONS ECHO ,<mode> OPTIONS OUTPUT ,<mode> [index]}
DESCRIPTION
OPTIONS OPTIONS entered itself with arguments command line displays current mode settings ECHO OUTPUT.
OPTIONS ECHO, <mode> <mode> either OFF. ECHO (the default setting), enables EMON echo each command line display during batch file execution. ECHO suppresses command line display.
OPTIONS OUTPUT, <mode> [index]} <mode> either SCREEN, FILE. SCREEN (the default setting), causes EMON messages which produced response commands such REGRD displayed screen. With OUTPUT OFF, messages displayed. With OUTPUT FILE, index form command, where index obtained with FOPEN command, messages produced executing EMON commands redirected specified file. When running batch file, EMON messages which identify syntax errors within batch file cannot suppressed displayed console.
RETURN
EXAMPLE
options ECHO OUTPUT SCREEN options echo,off options output, file,3 OUTPUT FILE these examples, OPTIONS used determine current settings, then used disable ECHO function, finally, redirect output file with file index
EMON User Manual
Revision
PAUSE
NAME
PAUSE Suspend batch file processing.
SYNOPSIS
PAUSE
DESCRIPTION
PAUSE used batch file cause execution batch file suspended. Batch file processing resumed pressing ENTER key.
RETURN
EXAMPLE
Batch file: verify stopb function verify print "Verify status before continuing.\n" pause return Screen: Verify status before continuing. Batch file paused.Hit return continue this example, batch file code section which performs function call user verify status. callable function uses PAUSE command suspend batch execution. Notice EMON lets know PAUSE effect, then waits command execute ENTER continue.
Revision
EMON User Manual
PEEK
NAME
PEEK Display contents controller accessible system memory.
SYNOPSIS
PEEK <addr> [count]}
DESCRIPTION
PEEK gives ability display contents controller accessible system memory. Data displayed both hexadecimal ASCII format. <addr> integer value indicating starting address memory block displayed. [count] optional integer value indicating number bytes display. default, PEEK displays bytes. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise. ARG1 through ARG32 first bytes PEEKed.
EXAMPLE
peek 0x10 00000010: 00000020: 00000030: 00000040: ABCDEFGHIJKLMNOP QRSTUVWXYZ[\]^_` abcdefghijklmnop qrstuvwxyz{|}~.
this example, default minimum bytes controller memory displayed starting address 0x10.
EMON User Manual
Revision
POKE
NAME
POKE Write controller accessible system memory.
SYNOPSIS
POKE <addr>, <val> [val],., [val]}
DESCRIPTION
POKE gives ability write more bytes into consecutive memory locations starting specified address. <addr> integer value indicating starting address system memory where specified data written. <val> 8-bit integer value which written system memory. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
poke 0x10, 0xFF this example, data address 0x10 will changed decimal value data address 0x11 will changed value 0xFF.
Revision
EMON User Manual
NAME
PRINT Display contents variables messages.
SYNOPSIS
PRINT <format$> [arg],., [arg]}
DESCRIPTION
PRINT displays specified argument, list arguments system console. Integers displayed decimal hexadecimal notation. <format$> string that controls output format arguments. format string contains types characters: plain text conversion characters. Plain text simply copied output stream. backslash character used display special characters. following table shows backslash character interpreted: newline (left margin next line) horizontal backspace carriage return (left margin) form feed backslash character single quote character double quote character \ddd control character (specified octal) Conversion characters used apply specific format argument. There must exactly conversion character each argument following list. conversion characters start with percent character (%). This list valid options conversion character: string integer decimal notation integer hexadecimal notation percent character [arg] either integer string constant variable. Multiple arguments specified with single PRINT statement. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
global test, test$ test 0x1234 test$ "test" print "this decimal notation: %d\n", test$, test this test decimal notation: 4660 print "this notation: 0x%x\n", test$, test this test notation: 0x1234
EMON User Manual
Revision
QUIT
NAME
QUIT Terminate EMON return DOS.
SYNOPSIS
QUIT
DESCRIPTION
Typing QUIT normal method terminate EMON orderly manner. following steps performed EMON. screen cleared. open files closed. EMON execution terminated user given back original system prompt.
Revision
EMON User Manual
REGRD
NAME
REGRD Display more PCnet controller register.
SYNOPSIS
REGRD <reg> [reg],., [reg]}
DESCRIPTION
This command lets read more PCnet family controller register. When specifying multiple registers, must separate each register identifier with comma. some more frequently accessed registers, active bits identified with mnemonic. default, EMON limits register numbers legal values based exact controller you're currently using. It's possible force EMON read reserved registers first specifying MODE command with debug command line argument: MODE debug When you're finished accessing non-standard registers, should turn this special access mode specifying MODE command with debug command line argument: MODE debug
<reg> character constant which identifies register wish read. Frequently used registers PCnet family devices are: Mnemonic csr0 csr1 csr2 csr3 csr4 ladrf padr mode iadr crbadr ctbadr nrtbadr rdra nrdra crdra tdra ntdra ctdra 8,9,10,11 12,13,14 16,17 18,19 20,21 22,23 24,25 26,27 28,29 30,31 32,33 34,35 Description Controller Status Register IADR[15:0] IADR[23:16] Interrupt Masks Deferral Control Test Features Control Logical Address Filter Physical Address Mode Initialization Block Address Current Receive Buffer Address Current Transmit Buffer Address Next Receive Buffer Address Base Address Receive Descriptor Ring Next Receive Descriptor Address Current Receive Descriptor Address Base Address Transmit Descriptor Ring Next Transmit Descriptor Address Current Transmit Descriptor Address Size
EMON User Manual
Revision
addition above registers with predefined mnemonic, read PCnet control status register specifying command regrd csrxx, where register number. This access method also works with configuration registers which accessed regrd bcrxx. When accessing configuration registers, there different legal ranges depending specific controller: Controller PCnet-ISA PCnet-ISA+ PCnet-ISA PCnet-32 PCnet-PCI PCnet-PCI PCnet-FAST PCnet-FAST+ PCnet-FAST PCnet-Home 0-21 0-21 0-22 0-35 0-47 0-47 0-49
(aka. ISACSR) (aka. ISACSR) (aka. ISACSR) 8-15 RESERVED) (0-1, 8-17, RESERVED) (0-1, 10-17, RESERVED) (0-1, 10-17, RESERVED) (0-1, 10-17, RESERVED) (0-1, 10-17, RESERVED) (0-1, 10-17, RESERVED)
NOTE: PCnet family controller must stopped read register except csr0, csr3, csr4, csr88, csr89, csr112, csr114.
Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise. Global variables ARG1 ARGn contain values registers read order specified. <reg> ladrf ARG1 ladrf<31-0> ARG2 ladrf<63-32> <reg> padr ARG1 padr<7-0> ARG2 padr<15-8> ARG3 padr<23-16> ARG4 padr<31-24> ARG5 padr<39-32> ARG6 padr<47-40>
Revision
EMON User Manual
EXAMPLE
regrd csr0 CSR0 0x0004 STOP regrd csr1 CSR1 0xffff regrd csr2 CSR2 0xffff regrd csr3 CSR3 0x0000 regrd csr4 CSR4 0x0115 MPCOM RCVCCOM
TXSTR
JABM
this example, contents Control Status Registers through displayed. mnemonics active bits displayed.
EXAMPLE
regrd ladrf Logical Address Filter 0xffffffffffffffff regrd padr Physical Address: regrd mode MODE 0x0000 PORTSEL regrd iadr Initialization Block Address 0xffffffff regrd crbadr Current Receive Buffer Address 0xffffffff regrd ctbadr Current Transmit Buffer Address 0xffffffff regrd nrtbadr Next Rx/Tx Buffer Address 0xffffffff regrd rdra Base Address Descriptor Ring 0xffffffff regrd nrdra Next Address Descriptor Ring 0xffffffff regrd crdra Current Address Descriptor Ring 0xffffffff regrd tdra Base Address Descriptor Ring 0xffffffff regrd ntdra Next Address Descriptor Ring 0xffffffff regrd ctdra Current Address Descriptor Ring 0xffffffff this example, contents other Control Status Registers with mnemonics displayed.
EMON User Manual
Revision
REGWR
NAME
REGWR Write more PCnet controller register.
SYNOPSIS
REGWR <reg>, <val> [reg, val],., [reg, val]}
DESCRIPTION
This command lets write more PCnet family controller register. When specifying multiple registers, must separate each register identifier with comma. <reg> character constant which identifies register wish write. Frequently used registers PCnet family devices are: Mnemonic csrxx bcrxx bcrxx bcrxx bcrxx bcrxx bcrxx bcrxx bcrxx bcrxx padr 0-126 0-21 0-21 0-22 0-35 0-47 0-49 12,13,14 Description Controller Status Register Control Register (PCnet-ISA) Control Register (PCnet-ISA+) Control Register (PCnet-ISA Control Register (PCnet-32) Control Register (PCnet-PCI) Control Register (PCnet-PCI Control Register (PCnet-FAST) Control Register (PCnet-FAST+, PCnet-FAST III) Control Register (PCnet-Home) Physical Address Size
<val> specifies more integer 16-bit hexadecimal values. When register requires more than value, such Physical Address register (PADR), each value must separated comma. NOTE: PCnet family controller must stopped write register except csr0, csr3, csr4, csr88, csr89, csr112, csr114. Entering command itself, with arguments, will invoke on-line help message showing syntax command summary operation.
RETURN
ERROR command successful, non-zero otherwise.
Revision
EMON User Manual
EXAMPLE
regwr csr0, regwr padr, 0x11, 0x22, 0x33,0x44, 0x55, 0x66 regrd csr0 CSR0 0x0004 STOP regrd padr Physical Address: this example, Control Status Register then byte physical address written Physical Address registers. When display CSR0, PADR registers, that active correct address present. Note, that there special EMON command (SET STOP) execute this several other often used control functions.
EMON User Manual
Revision
RETURN
NAME
RETURN Return program control from batch file function calling code
SYNOPSIS
RETURN {[arg],., [arg]}
DESCRIPTION
Returns from callable function batch file optionally returns integer arguments. [arg] more optional arguments returned reserved variables ARG1 through ARG32.
RETURN
ERROR command successful, non-zero otherwise.
EXAMPLE
Assume GLOBAL variables: PASS, MSG$, ERRNO, TES
Other recent searches
MBR1030CT-1060CT - MBR1030CT-1060CT MBR1030CT-1060CT Datasheet
MBR1030CT-MBR1060CT - MBR1030CT-MBR1060CT MBR1030CT-MBR1060CT Datasheet
M74HC699 - M74HC699 M74HC699 Datasheet
LX1686E - LX1686E LX1686E Datasheet
ILAS-1206-99 - ILAS-1206-99 ILAS-1206-99 Datasheet
ICM107B - ICM107B ICM107B Datasheet
HDBF14004E63SP02 - HDBF14004E63SP02 HDBF14004E63SP02 Datasheet
FS10R12VT3 - FS10R12VT3 FS10R12VT3 Datasheet
DMD1006 - DMD1006 DMD1006 Datasheet
DMD1006-A - DMD1006-A DMD1006-A Datasheet
A1391 - A1391 A1391 Datasheet
A1392 - A1392 A1392 Datasheet
A1393 - A1393 A1393 Datasheet
A1395 - A1395 A1395 Datasheet
Privacy Policy | Disclaimer
© 2012 Datasheet Archive
