CobraNet Digital Audio Networking Processor CobraNet ™ Programmer’s Reference Version 2.5 Preliminary Product Information This document contains information for a new product. Cirrus Logic reserves the right to modify this product without notice. ©Copyright 2006 Cirrus Logic, Inc. http://www.cirrus.
CobraNet Features Digital Audio Networking Processor CobraNet Asynchronous serial interface ❒ ❒ ❒ ❒ ❒ ❒ ❒ ❒ ❒ ❒ ❒ ❒ ❒ ❒ ❒ ❒ ❒ Real-time Digital Audio Distribution via Ethernet No Overall Limit on Network Channel Capacity Supports Switched and Repeater Fast Ethernet Networks Fully IEEE 802.3 Ethernet Standards Compliant Fiber Optic and Gigabit Ethernet Variants Supported Ethernet infrastructure can be used simultaneously for audio and data communications.
CobraNet General Description Digital Audio Networking Processor CobraNet is a combination of hardware (the CobraNet interface), network protocol, and firmware. CobraNet operates on a switched Ethernet network or on a dedicated Ethernet repeater network. CobraNet provides the following additional communications services for an Ethernet network.
CobraNet Programmer’s Reference Contacting Cirrus Logic Support For all product questions and inquiries contact a Cirrus Logic Sales Representative. To find the one nearest to you go to www.cirrus.com IMPORTANT NOTICE Cirrus Logic, Inc. and its subsidiaries ("Cirrus") believe that the information contained in this document is accurate and reliable. However, the information is subject to change without notice and is provided "AS IS" without warranty of any kind (express or implied).
CobraNet Programmer’s Reference Table of Contents Table of Contents Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 General Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CobraNet Programmer’s Reference Table of Contents 6.2.6 Counter ............................................................................................................. 31 6.2.7 Counter2 ...........................................................................................................31 6.2.8 Integer ............................................................................................................... 31 6.2.9 Integer16 ................................................................
CobraNet Programmer’s Reference Overview 1. Overview 1.1 CobraNet Terminology CobraNet is a technology that combines state of the art audio and communications technologies. While each have their own terminology, the following terms are used to refer to elements specific to CobraNet. Audio Channel—A CobraNet digital audio channel operates with a sample rate 48 kHz or 96 kHz and a sample size of 16, 20, or 24 bits.
CobraNet Programmer’s Reference Overview Host Management Interface (HMI) - The hardware (8-bit bi-directional parallel interface) and protocol for accessing MI variables locally. The HMI is described in detail in the CS4961xx/CS1810xx Hardware Manual and CM-1 Hardware Manual. Management Interface (MI) - The set of variables used to control and monitor the CobraNet interface.
CobraNet Programmer’s Reference Overview 1.2 Protocol The CobraNet protocol operates at the Data Link Layer also referred to as OSI Layer 2 or MAC layer. CobraNet uses four basic packet types described below. All CobraNet packets are identified with a unique Ethernet protocol identifier (0x8819) assigned to Cirrus Logic. As CobraNet is a Local Area Network (LAN) technology and not a Wide Area Network (WAN) technology, CobraNet does not utilize Internet Protocol (IP) to transport audio.
CobraNet Programmer’s Reference Overview 1.3 Timing and Performance CobraNet provides real-time audio delivery and requires real-time performance from the network on which it is deployed. The best means of insuring a network will deliver the performance required by CobraNet is to verify the design using Cirrus Logic’s CobraCAD CobraNet modeling software (available for download at www.cirrus.com).
CobraNet Programmer’s Reference Overview 1.4 Bundle Addressing types Multicast bundles represent a least common denominator for audio interoperability in CobraNet networks. Bundles sent with multicast destination addresses are delivered indiscriminately to all CobraNet interfaces and thus have the potential of overloading a network. Care should be taken to insure that an excessive number of multicast bundles are not used. See Bundle Assignments in CobraNet Systems (available for download at www.cirrus.
CobraNet Programmer’s Reference Control Communications 2. Control Communications 2.1 Serial Bridge Asynchronous serial data may be bridged across the network using the serial bridge hardware and software. The CobraNet interface has a two wire logic-level asynchronous interface. Characters received on the interface are buffered and placed in the payload of a special serial bridge Ethernet packet. The packet is then transmitted onto the network with unicast or multicast addressing as configured.
CobraNet Programmer’s Reference Control Communications Although the serial bridging feature strives to transmit data at wire speed, delays are introduced by the process of serializing, de-serializing, and prioritizing the serial bridge packets. These delays are typically on the order of 10ms or less. See Table 6.4.8 on page 86 for details on the MI variables used to control serial bridging. 2.
CobraNet Programmer’s Reference Control Communications Table 3.
CobraNet Programmer’s Reference Control Communications 2.2.2 Packet Bridge Receive Filtering The packet bridge can allow only selected packets to be passed to the bridge buffer or allow copies of packets to be sent to the bridge buffer. The value of the bridgeRxFilter variable controls the filter mode. With bridgeRxFilter = 0x10 or 0x01 the packet bridge sends selected packets of unknown protocol to the HMI interface via the packet bridge buffer.
CobraNet Programmer’s Reference Network Stack 3. Network Stack Internet Protocol Suite CobraNet Services Application BOOTP Transport Network SNMP TFTP UDP RARP Logical Link Physical ARP ICMP CobraNet Audio Serial Bridge Packet Bridge IP 802.3 Ethernet Fast Ethernet Interface Figure 5. CobraNet Network Stack 3.
CobraNet Programmer’s Reference Network Stack down to an approximate 2-per-minute minimum rate. Two conditions must be met before a CobraNet device will send out BOOTP requests: • The device must not already have an IP address. Apart from BOOTP, there are two other means for a CobraNet interface to obtain an IP address - RARP and the ipMonitor variables. • The device must be attached to a switched network.
CobraNet Programmer’s Reference Network Stack The CobraNet implementation of IP has the following limitations: • Segmentation and reassembly is not supported. Segmentation is primarily utilized by stream based TCP protocols that can generate large data packets. Reassembly capability can be necessary on heterogeneous networks (those comprising multiple network technologies such as Ethernet, FDDI, and ISDN). • Cannot initiate IP communications; can only respond to incoming messages.
CobraNet Programmer’s Reference Audio Paths Audio Paths TX1 TX2 TX3 TX4 Synchronous Serial Transmitters TxSubMap - Outgoing Audio Bundles Audio Output Metering 1 31 audioMeterMap audioLoopSrc Loop Variables 2 audioLoopDst RX4 Transmitters audioDupSrc RX3 0 (Silence) 1 8 16 24 32 33 40 48 56 64 audioDupDst RX2 - Ethernet Dup Variables RX1 Audio Routing Channels 32 33 34 63 64 Audio Input Metering RxSubMap Up to 8 Channels Each Up to 8 Channels Each Synchronous Serial Receivers
CobraNet Programmer’s Reference Audio Paths the network receivers to the SSI outputs. Routing channel 0 is a special logical channel used to supply silence to a transmitted channel or serve as a “bit bucket” when receiving from the network. Audio arrives and leaves the interface through the SSI receivers and transmitters. As each sample arrives it is buffered. The mapping of audio input and output channels to audio I/O buffer offsets is fixed (and non-intuitive).
CobraNet Programmer’s Reference Audio Paths by audioDupSource and audioDupDest variables. An output can be specified as the source for a duplication by multiple “dup” paths. Output duplication is accomplished without incurring additional audio latency. See Section 6.4.10 "Audio" on page 92 for more information. 4.6 Meters Metering is provided for all 64 audio routing channels. The first 32 meters can be mapped to the 32 input routing channels.
CobraNet Programmer’s Reference Audio Paths the maximum size of an Ethernet packet. Therefore Lower-latency modes have relaxed restrictions in this area. Audio channel count restrictions are summarized below. Table 5.
CobraNet Programmer’s Reference Audio Paths A CobraNet interface operates at a single latency and sample rate mode as specified by the modeRateControl variable. This latency mode applies to all incoming and outgoing audio at the interface. Table 6.
CobraNet Programmer’s Reference Audio Paths Sample rate is selected by the modeRateControl variable. modeRateControl selects both sample rate and audio latency. 96 kHz sample rate and low-latency modes can be used together. rxSubFormat indicates the type and status of audio date being received. The LS bit of this variable indicates whether data in the sub channel is being decoded. A value of 0 indicates inability of the interface to decode the received data.
CobraNet Programmer’s Reference Management Interface 5. Management Interface The Management Interface (MI) is the means by which the CobraNet interface is controlled and monitored. Integral to the management interface are the MI variables. The MI variables are read and written via the Host Management Interface (HMI) or remotely over the audio network via SNMP. Both methods operate on the same common set of MI variables. The CobraNet device is configured in real time as the variables are changed.
CobraNet Programmer’s Reference Management Interface On 32-bit CobraNet platforms, the transmit buffer is comprised of 4-byte words. The mapping between the byte-wide flash data and the wider buffer memory is as follows. Table 9. Flash Layout, 32-bit Platforms 5.
CobraNet Programmer’s Reference Management Interface 5.4 SNMP Extension Agent CobraNet’s SNMP agent feature allows the CobraNet interface to be monitored and configured over the Ethernet network by an SNMP manager (or managers). An enhancement of this capability is the SNMP extension agent which allows these monitoring and control capabilities to be extended to product-specific features and functionality. SNMP extensions require use of a host processor attached to the CobraNet interface.
CobraNet Programmer’s Reference Management Interface Variable Reference 6. Management Interface Variable Reference CobraNet interfaces are configured and monitored by reading and writing Management Interface variables. MI variables may be accessed directly via a processor attached to the Host Management Interface or via the network using SNMP.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.2 Data Types 6.2.1 DisplayString A DisplayString is an ASCII string comprised entirely of printable characters. 24-bit HMI: The first word indicates the length of the string in characters. Data is stored three characters per 24-bit word. Character order is MS, Middle, LS. For DisplayString variables, documented Size indicates the largest possible word size of the variable. Size includes the length field.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.2.4 PhysAddress A 48-bit Ethernet media access control (MAC) address. 24-bit HMI: Data is stored in the most-significant 16 bits of 3 consecutive memory locations as illustrated below. The least-significant 8 bits of each location are read as zero and must be written as zero. Table 12.
CobraNet Programmer’s Reference Management Interface Variable Reference be used to extend the useful range of the timer. Both may be safely ignored for most applications. Table 15. TimeTicks Layout, 32-bit Platforms MS MH ML LS Word 1 Rollover MS Rollover LS Timer MS Timer MH Word 2 Timer ML Timer LS Fractional LS Fractional MS SNMP: TimeTicks is reported as a 32-bit integer in units of 100ths of a second. For example, a reported value of 1000 indicates a 10-second timer reading.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.2.9 Integer16 A signed, 16-bit integer. Valid range is -215 (-32,768) to 215-1 (32,767). 24-bit HMI: Signed data is represented in 2's complement form. The most significant 16 bits of the 24-bit host data contain the significant bits. The LS 8 bits are read as zero and must be written as zero. 32-bit HMI: Same as 32-bit Integer type with useful values less than 216 (65,536).
CobraNet Programmer’s Reference Management Interface Variable Reference 6.3 MIB-II Variables These variables are common to all SNMP implementations. This common set of management variables is defined in the Internet Engineering Task Force (IETF) standards document RFC 1213. 6.3.1 System Name sysDescr Describes type of interface as ASCII text. Format for 24-bit platforms: CobraNet version ..[.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address The vendor's authoritative identification of the network management subsystem contained in the entity. This value is allocated within the SMI enterprise sub-tree (1.3.6.1.4.1) and provides an easy and unambiguous means for determining `what kind of box' is being managed. For example, if vendor `Cirrus Logic' was assigned the sub-tree 1.3.6.1.4.1.2680, the identifier `CM-2' could be assigned to 1.3.6.1.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address sysName A name assigned to this managed node. By convention, this is the node's fully qualified domain name. 0x100300 SNMP Object ID 1.3.6.1.2.1.1.5 Size 60 characters Type DisplayString Attributes Default Value Implemented Version Name Description Host Address Read/write - Persistent Product specific 2.6.3 sysLocation The physical location of this node (e.g.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 36 sysServices A value which indicates the set of services supported by this entity. The value is a sum. This sum initially takes the value zero, For each layer, L, in the range 1 through 7, that this node performs transactions for, 2 raised to (L - 1) is added.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.3.2 Interface Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID ifNumber The number of network interfaces (regardless of their current state) present on this system. 0x110000 1.3.6.1.2.1.2.1 Integer Read-only 1 2.1.0 ifDescr A string containing information about the interface.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes The size of the largest datagram or ‘packet’ that can be sent/received by the interface, specified in octets. For interfaces that are used for transmitting network datagrams, this is the size of the largest network datagram that can be sent on the interface. 0x11000B 1.3.6.1.2.1.2.2.1.4 Integer Read-only Default Value 1500 Implemented Version 2.1.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID ifAdminStatus The desired state of the interface. The testing(3) state indicates that no operational packets can be passed up(1) -- ready to pass packets down(0) 0x111000 1.3.6.1.2.1.2.2.1.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID The total number of octets received on the interface, including framing characters. 0x112016 1.3.6.1.2.1.2.2.1.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 ifInDiscards The number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their delive
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID The total number of octets transmitted by the interface, including framing characters. 0x11201D - 0x11201E 1.3.6.1.2.1.2.2.1.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes ifOutDiscards The number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their transmission.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID A reference to MIB definitions specific to the particular media being used to implement the interface. For example, if the interface is implemented by Ethernet, then the value of this object refers to a document defining objects specific to Ethernet.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.3.3 Address Translation The Address Translations are deprecated. These variables are no longer available via SNMP. Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID The interface on which this entry's equivalence is effective.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.3.4 IP Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes The indication of whether this entity is acting as an IP gateway to forward of datagrams received by, but not addressed to, this entity. IP gateways forward datagrams. IP hosts do not (except those source-routed via the host). 0x130000 1.3.6.1.2.1.4.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 ipInHdrErrors The number of input datagrams discarded due to errors in their IP headers, including bad checksums, version number mismatch,
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 48 ipInUnknownProtos The number of locally-addressed datagrams received successfully but discarded because of an unknown or unsupported protocol.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 ipOutRequests The total number of IP datagrams which local IP user-protocols (including ICMP) supplied to IP in requests for transmission.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 50 ipReasmTimeout The maximum number of seconds which received fragments are held while they are awaiting reassembly. Not available 1.3.6.1.2.1.4.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 ipReasmFails The number of failures detected by the IP re- assembly algorithm (for whatever reason: timed out, errors, etc).
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 52 ipFragCreates The number of IP datagram fragments that have been generated as a result of fragmentation at this entity. The CobraNet interface does not support fragmentation. This variable will always read 0. Not available 1.3.6.1.2.1.4.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.3.5 UDP Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 udpInDatagrams The total number of UDP datagrams delivered to UDP users. 0x140000 1.3.6.1.2.1.7.1 Counter Read-only 0 2.6.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description The total number of UDP datagrams sent from this entity. 0x140003 1.3.6.1.2.1.7.4 Counter Read-only 0 2.6.0 udpLocalAddress The local IP address for this UDP listener. In the case of a UDP listener which is willing to accept datagrams for any IP interface associated with the node, the value 0.0.0.0 is used.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.3.6 SNMP Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 snmpInPkts The total number of SNMP Messages received from the transport service 0x150000 1.3.6.1.2.1.11.1 Counter Read-only 0 2.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 56 snmpInBadCommunityNames The total number of SNMP Messages received which used an unknown community name. 0x150003 1.3.6.1.2.1.11.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 snmpInTooBigs The total number of SNMP PDUs received for which the value of the error-status field was `tooBig'. Not available 1.3.6.1.2.1.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 58 snmpInReadOnlys The total number of valid SNMP PDUs received for which the value of the error-status field was `readOnly'.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 snmpInTotalSetVars The total number of MIB objects which have been altered successfully as a result of receiving valid SNMP Set-Request PDUs
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 60 snmpInSetRequests The total number of SNMP Set-Request PDUs which have been accepted and processed. 0x15000A 1.3.6.1.2.1.11.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 snmpOutTooBigs The total number of SNMP PDUs generated for which the value of the error-status field was `tooBig.' 0x15000B 1.3.6.1.2.1.11.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 62 snmpOutGenErrs The total number of SNMP PDUs generated for which the value of the error-status field was `genErr'. 0x15000E 1.3.6.1.2.1.11.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 snmpOutSetRequests The total number of SNMP Set-Request PDUs generated. Not available 1.3.6.1.2.1.11.27 Counter Read-only Always reads 0 2.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 64 snmpEnableAuthenTraps Indicates whether the SNMP agent process is permitted to generate authentication-failure traps.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4 CobraNet Variables 6.4.1 Firmware Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version DS651PM25 firmwareProtocolVersion Highest CobraNet protocol version supported by firmware. Current protocol version is 2.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version 66 firmwareBootVersion Configuration record revision number. The configuration record contains the MAC address for the interface and other permanent initialization parameters. 0x3 1.3.6.1.4.1.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version DS651PM25 firmwareMfgVersion A manufacturer assigned minor revision number for firmware.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.2 Hardware Identification Different platforms and hardware version have different channel and processing capacities. By recognizing the capabilities of the interface, the host may optimize the configuration to take advantage of the capabilities. Before the introduction of the variables documented below, the host could use sysDescr, sysObjectID and firmwareVersion* to determine the capabilities.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.3 Flash Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version DS651PM25 flashTotalSize Total flash memory size in bytes. 0x1000 1.3.6.1.4.1.2680.1.1.2.1 Integer Read-only 2.1.0 flashSectorSize Largest flash sector size in bytes.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 70 flashPersistType Indicates the type identifier for the persistent store dataset.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object Identifier Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 flashTAcknowledge A semaphore variable updated to the value of flashTRequest on completion of a flash write.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object Identifier Type Attributes Implemented Version Name Description Host Address SNMP Object Identifier Type Attributes Implemented Version Name Description Host Address SNMP Object Identifier Type Attributes Implemented Version 72 flashTRequest When changed, causes data transfer to begin between flash memory and bridgeTxPktBuffer.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object Identifier Type Attributes Implemented Version DS651PM25 flashTDirection Specifies whether the transaction is a flash sector read, write or erase. 0 - Read flash to transmit buffer 1 - Write flash from transmit buffer 2 - Erase flash sector 0x1204 Not available via SNMP Integer Read/Write 2.8.6 ©Copyright 2006 Cirrus Logic, Inc.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.4 Errors Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 74 errorPOSTResults Power on self-test results. 0 - no errors detected. Currently the CobraNet interface does not recover from a POST failure.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version DS651PM25 errorCount Number of errors reported during sysUpTime. Some errors are warnings and do not affect errorIndicators. 0x2003 1.3.6.1.4.1.2680.1.1.3.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes 76 modeRateControl Selects latency and sample rate mode for the interface.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.5 Conductor These variables determine the values transmitted in the header of the Beat Packet when the CobraNet interface is acting as the network conductor. Name Description Host Address SNMP Object ID Type Attributes conductorCycleRate Number of isochronous cycles per second as a 16.16 fixed point number. This is a legacy variable. It always reports default value and should not be changed. 0x10000 1.3.6.1.4.1.2680.1.1.4.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version 78 conductorGaps These timing specifications are applicable only to repeater networks and therfore do not apply to most CobraNet applications. This variable is changed on the active conductor in order to reduce the probability of collisions.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.6 Conductor Information These conductor variables give a description and status of the current conductor of the CobraNet network. Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Conductor priority of the current conductor.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Implemented Version 80 condInfoChanges Count of condInfoMAC changes since boot. A single conductor arbitration event may produce multiple increments. 0x11007 1.3.6.1.4.1.2680.1.1.4.8 Counter Read-only 2.9.12 (24-bit platforms only.) Not available on 32-bit patforms. ©Copyright 2006 Cirrus Logic, Inc.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.7 Packet Bridge Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 bridgeTxPkt Variable is used in conjunction with bridgeTxDone.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID This variable is used to calculate a hash value based on the address in bridgeMMAC. Writing a value different than bridgeMMACHashDone to this variable causes the calculation to begin.
CobraNet Programmer’s Reference Management Interface Variable Reference Name bridgeRxFilter Selects which types of received packets will be passed to the host via the packet bridge. The following values may be ORed together. See Figure 4 on page 15.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Count Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 84 bridgeRxPktBuffer Buffer to read received packet. The data format for packet data is the same as used in bridgeTxPktBuffer.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 bridgeMMACHashDone Refer to bridgeCalcMMACHash documentation. This variable is used in conjunction with bridgeCalcMMACHash. 0x23002 Not available via SNMP Integer Read-only 0 2.2.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.8 Serial Bridge Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 86 serialFormat This variable is used to enable or disable the Serial Communications Interface (a.k.a SCI or Serial Bridge) and to set the data format for both transmit and receive directions.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 serialPPeriod Time in 256ths of a millisecond before a character received at the SCI port is placed in a packet and transmitted. Shorter periods to achieve lower latency are appropriate for real time connections such as MIDI.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 88 serialTxPriority Serial bridging bundle priority in MS byte.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.9 Interrupt Control Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 hackEnable Enable conditions for asserting HACK. HACK is de-asserted by issuing an Interrupt Acknowledge HMI command.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version 90 hackStatus Indicates the source of a HACK assertion requiring acknowledge. The following values may be OR’d together.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version DS651PM25 hackReadLength Size of readable area in words for the last address traslation. 0 if read permission is denied (invalid address).
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.10 Audio Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 92 audioMeterDropouts This counter is incremented each isochronous cycle that metering is not performed.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 audioTxChannels Number of unique audio channels currently being transmitted to the network. On CS4961xx and CS1810xx this variable always reads 0. 0x30003 1.3.6.1.4.1.2680.1.1.5.8 Integer Read-only 0 2.8.3.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Count Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Count Type Attributes Default Value Implemented Version 94 audioMeterMap Maps audio routing channels to audio metering. Meters 0-31 are designated for metering audio inputs. Meters 32-63 are designated for metering outputs.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Count Type Attributes Implemented Version Name Description Host Address SNMP Object ID Count Type Attributes Default Value Implemented Version DS651PM25 audioMeters Allows reading current audio levels. Ballistics for metering comprise an instantaneous attack and exponential decay time programmable via audioMeterDecay. All level measurements are peak level (as opposed to RMS).
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Count Type Attributes Default Value Implemented Version Name Description Host Address Efficiently retrieves all audioMeters values in a single Get operation. On 24-bit platforms, audioMeterPeakRaw and audioMeterRaw values are packed in 3 octet words. On CS4961xx- and CS1810xx-based platforms the values are packed in 4 octet words. Byte ordering for 24-bit is MS, Middle, LS.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address audioLoopDst Describes destination audio routing channels for performing a local audio loopback function. See audioLoopSrc for a complete description. 0x35000 SNMP Object ID 1.3.6.1.4.1.2680.1.1.5.3.1.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Count Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Count Type Attributes Implemented Version 98 audioMap Audio routing channel to synchronous serial audio channel mapping. Each entry specifies an SSI audio buffer offset corresponding to a routing channel. The first audioMap entry corresponds to routing channel 1.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Count Type Attributes Implemented Version Name Description Host Address SNMP Object ID A vector used to specify the source audio routing channels used in audio channel duplication. See audioDupSrc. 0x39000 1.3.6.1.4.1.2680.1.1.5.9.1.3 0 in standard CM-1 firmware, 8 in CS4961xx and CS1810xx firmware. Integer Read/Write 2.8.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description audioSSIFormat Format of SSI channel data. 0 - Normal Mode 1 - I2S Mode 2 - Standard Mode Default is Normal Mode See Hardware User's Manual for SSI mode descriptions. Host Address SNMP Object ID Type Attributes Implemented Version 100 0x30004 1.3.6.1.4.1.2680.1.1.5.12 Integer Read-only 2.9.10, 2.10.5 ©Copyright 2006 Cirrus Logic, Inc.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.11 Receivers Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version DS651PM25 rxStatus Indicates bundle reception. Bundle reception does not necessarily indicate audio reception.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address Count SNMP Object ID Type Attributes Implemented Version 102 rxMinDelay Selects a minimum additional delay imposed on the received audio. Delay is expressed in units of isochronous cycles (1-1/3ms for standard 5-1/3ms latency mode, 2/3ms for 2-2/3ms latency mode and 1/3ms for 1-1/3ms latency mode).
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 rxBundle Receive bundle assignment. 0x4n100 (n is 0 based receiver number) 1.3.6.1.4.1.2680.1.1.6.1.1.2.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address Count SNMP Object ID Type Attributes Default Value Implemented Version 104 rxBuddyExclude Controls BuddyLink operation for this receiver: 0 - Reverse reservations for this receiver are suspended when BuddyLink signal is detected. i.e.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.12 Transmitters Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version DS651PM25 txDropouts Count of times channel transmission has been interrupted.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 106 txBundle Transmit bundle assignment. 0x5n100 (n is 0 based transmitter number) 1.3.6.1.4.1.2680.1.1.7.1.1.2.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 txSubCount Number of audio channels to transmit in a bundle. Valid values are 0 through 8. Reducing txSubCount is the preferred means for transmitting bundles with less than the maximum 8 audio channels.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 108 txUnicastMode Specifies the number of unicast destinations served before automatically switching to multicast bundle transmission. Multicast transmission is useful for efficient point to multipoint routing.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address Count SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address Count SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 txSubMap Transmit audio channel (channel within bundle) to audio routing channel (channel of SSI) mapping. This vector contains the routing channel source specifiers per audio channel in the transmitted bundle.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.13 Synchronization Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 110 syncConductorClock Selects sample clock source when acting as network conductor. 0x0 - Internal mode. 0x1 - External Word Clock mode. 0x10 - Not supported on CobraNetSilicon Series devices.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 syncClockTrim Allows fine control of clock rate when acting as a network conductor in internal synchronization mode (syncConductorClock = 0x00).
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Implemented Version 112 syncStatus Indicates current audio clock synchronization status. The following values may be ORed together: Unspecified bits should be ignored.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.14 SNMP Monitor Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID This variable enables write access to all read-write SNMP variables. 0 - all SNMP variables read-only; write disabled non-zero - writes enabled for read-write SNMP variables 0x70000 Not available via SNMP Integer Read/write - Persistent 1 2.6.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.15 MI Monitor Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version 114 miMonDirty Incremented when a management interface variable is modified either via SNMP or HMI.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Host interface mode. 0 - Motorola mode 1 - Intel mode -1 - default mode (Motorola mode, otherwise undefined) 0x71003 1.3.6.1.4.1.2680.1.1.9.1.4 Type Integer32 Attributes Read-only Default Value Implemented Version DS651PM25 miMonHMIMode -1 2.10.5 (32-bit platforms only). Not available on 24-bit platforms. ©Copyright 2006 Cirrus Logic, Inc.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.16 IP Monitor Name Description Host Address SNMP Object ID The current IP address for the CobraNet interface. Changing the current IP address has an immediate effect on IP communications. A value of 0.0.0.0 indicates no IP address assignment for the interface. An IP address can be assigned (or reassigned) to the interface by any of the following means: A value loaded from ipMonStaticIP during power-up.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.4.17 IF Monitor MI interface for monitoring redundant Ethernet connection (Dual Link) feature. These variables are only available on the CM-1, CM-2, and CS4961xx/CS1810xx-based hardware. Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Index of the current, active Ethernet connection.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Count Type Attributes Implemented Version Name Description Host Address SNMP Object ID Count Status of Ethernet connection. The following values may be OR’d together: 1 - Ethernet link established 2 - Connection is full-duplex 4 - Ethernet packets being received at a rate of at least 1 packet every two seconds.
CobraNet Programmer’s Reference Management Interface Variable Reference 6.5 DSP Extensions The CS4961xx family of CobraNet interface chips features a MIB extension for control and monitoring of the digital signal processing capabilities. 6.5.1 Processor The proc variables provide general control and monitoring of the digital signal processing.
CobraNet Programmer’s Reference Management Interface Variable Reference Name procFreeCycles Free CPU cycles in thousandths (1000=100.0%, 256=25.6%). Description Negative values indicate inadequate free cycles. This condition is normally accompanied by errors (advancing errorCount). Host Address SNMP Object ID Type Attributes Implemented Version 0x75201 1.3.6.1.4.1.2680.1.4.1.3 Integer Read Only 2.11.1 6.5.2 Control The control variables are for control and monitoring of DSP parameters.
CobraNet Programmer’s Reference Management Interface Variable Reference Name Description Host Address SNMP Object ID Type Attributes Implemented Version Name Description Host Address SNMP Object ID Type Attributes Default Value Implemented Version DS651PM25 controlROLength Length of read-write control variable set instantiated in controlROValue. 0x75301 1.3.6.1.4.1.2680.1.4.2.3 Integer Read Only 2.11.1 controlROValue Read-only DSP parameters. 0x7A000+n (n is the 0-based parameter offset) 1.3.6.1.4.1.
CobraNet Programmer’s Reference Recommended User Interface Practices 7. Recommended User Interface Practices 7.1 Channel Assignments and Labeling There are at least five layers where audio channels are numbered: • User labels on the back panel of a device. • As synchronous serial time slot and interface assignments. This is determined by how the audio I/O is physically connected and multiplexed. • As audio buffer offsets within the CobraNet interface.
CobraNet Programmer’s Reference Recommended User Interface Practices provided. Optional user interface control of receiver functionality may include any combination of the following: • Audio destination channel mapping per receiver audio channel • Bundle and request priority 7.2 Conductor Priority It is not necessary to give users the ability to change conductor priority via a front panel interface.
CobraNet Programmer’s Reference Error Reporting 8. Error Reporting 8.1 Recoverable Errors Recoverable errors are indicated by an increment of errorCount, update of errorCode, errorIndicators and illumination of the TX error, RX error and/or Fault indicators, if available. Note that some CobraNet devices do not present all indicators to the user. For example, the CM-1 provides only the Fault indicator. There are numerous recoverable error conditions that can cause an error indication.
CobraNet Programmer’s Reference Error Reporting 8.2.2 POST Failure Power on self-tests are performed during the boot process. If one of these tests fails, an error code is displayed as a flashing pattern on the Fault indicator. Once the code has been displayed, the interface will automatically attempt to reset itself. Typically the same test will fail again resulting in repeated display of the failing error code. Table 16.
CobraNet Programmer’s Reference Error Code Reference 9. Error Code Reference 9.1 Legend Byte Code - Numeric error code. Error codes reported through SNMP or HMI are of varying form must be converted to this common byte code representation as per instructions give in section 9.2 below. Flash Code - Code as reported in a fatal fault situation. Flash codes are typically only displayed for fatal errors. Type - Classification and behavior of the error condition. Table 17.
CobraNet Programmer’s Reference Error Code Reference 9.2 Error Code Interpretation Errors are listed and described in section 9.3 below. Errors are keyed by Byte Code and Flash Code. Flash codes are used when a fatal fault is reported (see section 9.1 above). Byte codes are used for all other runtime error reporting. A conversion between raw error codes reported via the errorCode MI variable and the byte code key values is required to correctly interpret error conditions.
CobraNet Programmer’s Reference Error Code Reference 9.3 Error Codes Listing Byte Flash Code Code 0 1 2 3 4 5 6 7 8 128 1,1,1 3,1,1 5,1,1 7,1,1 1,2,1 3,2,1 5,2,1 7,2,1 1,3,1 Type Name Description Expected Conditions Unexpected Conditions NONE NO_ERROR No error has been reported. - - NO_CODE No valid runtime code to load from flash memory. BOOT_CSUM Bad boot sector checksum. FATAL FATAL FATAL FATAL FATAL FATAL FATAL FATAL Corrupted flash No code has ever contents.
CobraNet Programmer’s Reference Error Code Reference Byte Flash Code Code 9 10 11 12 13 14 15 3,3,1 5,3,1 7,3,1 1,4,1 3,4,1 5,4,1 7,4,1 Type FATAL FATAL FATAL FATAL FATAL FATAL FATAL Expected Conditions Unexpected Conditions - Memory chip problem. Data bus problem. Address bus problem. - Memory chip problem. Data bus problem. Address bus problem. - Memory chip problem. Data bus problem. Address bus problem. - Memory chip problem. Data bus problem. Address bus problem.
CobraNet Programmer’s Reference Error Code Reference Byte Flash Code Code 20 21 22 23 3,6,1 5,6,1 7,6,1 FATAL FATAL FATAL FATAL Expected Conditions Unexpected Conditions XILINX_ID Xilinx does not report expected identification. - Problem with Xilinx. Problem with Xilinx configuration file in flash. XILINX_VERSION Reported Xilinx version not supported by boot code. - Mismatched files used during code build. POST_CLOCK_RANGE Sample clock pull range test failure.
CobraNet Programmer’s Reference Error Code Reference Byte Flash Code Code 34 35 5,1,2 7,1,2 Type RX TX Description Expected Conditions Unexpected Conditions BEAT_FLOODED Beat packet received while previous beat packet still being processed. Occurs normally while synchronizing to the network. Late collisions on an oversized (>200 meter) repeater network are occurring profusely. multiple units may be conducting in this scenario. Conductor is misbehaving.
CobraNet Programmer’s Reference Error Code Reference Byte Flash Code Code Name Description Expected Conditions Unexpected Conditions 44 1,4,2 FATAL FLASHREQ_ASSERTFAIL Programmer assertion failed in flashreq.asm - - 45 3,4,2 RX QUEUEPUT_RXCONTROL Too many control packets received. Excessive broadcast control traffic on network. - - Two devices are mistakenly transmitting onto the same bundle. 46 5,4,2 RX QUEUEPUT_RX Too much audio data received for a network isochronous channel.
CobraNet Programmer’s Reference Error Code Reference Byte Flash Code Code 58 59 60 5,7,2 7,7,2 1,8,2 Type Name Description Expected Conditions Unexpected Conditions TXFAULT QUEUEPUT_ORDER Queue overflow preparing packets for transmission. - - RXQUIET TXQUIET MISMATCH_CNVERSION TXAUDIO_DROPOUT CobraNet silicon receiver running Protocol minor pre-2.10.4 firmware version mismatch. connected to CM-1 or Refer running pre 2.9.0 firmware. - Audio dropout occurred on transmission.
CobraNet Programmer’s Reference Error Code Reference Byte Flash Code Code Name Description Expected Conditions Unexpected Conditions 67 7,1,3 FATAL PROCSTACK_OVER Processor internal stack overflow. - - 68 1,2,3 FATAL PROCSTACK_UNDER Processor internal stack underflow. - - Duplicate MACs detected on network detected during conductor Loop in network resulting in arbitration. MAC addresses are broadcast storm and subsequent supposed to be globally unique. receipt of own beat packets.
CobraNet Programmer’s Reference Error Code Reference Byte Flash Code Code 79 79 80 7,4,3 7,4,3 1,5,3 Type RX RXFAULT RX Name Description Expected Conditions Unexpected Conditions ETHERRX_OVERRUN Could not keep up with Ethernet receive data transfer requirements. Ethernet receive data transfers deferred by transmissions. - ETHERRX_OVERRUN Could not keep up with Ethernet receive data transfer requirements. - Problem with Ethernet receive DMA.
CobraNet Programmer’s Reference Error Code Reference Byte Flash Code Code 85 86 5,6,3 TX TXQUIET Name Description Expected Conditions Unexpected Conditions ETHERTX_CRS Ethernet carrier sense did not assert in response to transmission. May be reported if transmission is in progress when Ethernet is disconnected. - ETHERTX_LATECOLL Late collision occurred during transmission. Late collisions can occur on a repeater network if network diameter exceeds 200 meters.
CobraNet Programmer’s Reference Error Code Reference Byte Flash Code Code 92 93 1,8,3 3,8,3 Type RX RXFAULT Name Description ETHERRX_PHY_LAYER Physical layer error reported by Ethernet controller. RXPACKET_TOOLONG DMA reports receiving an illegally long packet. Expected Conditions Unexpected Conditions - Poor signal integrity in onboard Ethernet circuits. - Ethernet DMA misbehaving or incorrect handling of receive discard or late collision condition.
CobraNet Programmer’s Reference Error Code Reference Byte Flash Code Code 104 1,3,4 Type Name Description Expected Conditions Unexpected Conditions FATAL MODE_ASSERTFAIL Programmer assertion failed in mi.a - - Packet length greater than 2048 bytes detected. Signal integrity problem in Ethernet receive circuitry. ETHERRX_WATCHDOG_TIME Receive watchdog OUT time-out.
CobraNet Programmer’s Reference Error Code Reference Byte Flash Code Code Type Name Description Expected Conditions Unexpected Conditions 124 1,8,4 FATAL UNUSED - - - 126 5,8,4 RX SECTIONLENGTH_UNEXPEC TED Unexpected packet structure encountered. Defective transmitter may spew corrupt packets - ETHERRX_ABORT Unexpected packet receipt aborted; receive abort mechanism unimplemented. - - ETHERRX_INTERNAL Internal receive error reported Ethernet controller (MAC).
CobraNet Programmer’s Reference Error Code Reference Byte Flash Code Code Type Name Description Expected Conditions Unexpected Conditions 148 1,6,5 FATAL DSPB_EXTSTACK_OVER DSPB external stack overflow. - - 149 3,6,5 FATAL DSPB_EXTSTACK_UNDER DSPB external stack underflow. - - 150 5,6,5 FATAL DSPB_ASSERT_FAIL Programmer assertion failure on DSPB. - - 151 7,6,5 RXQUIET DSPB_CYCLES DSPB processing cycles exhausted.
CobraNet Programmer’s Reference Glossary of Terms 10. Glossary of Terms 100BASE-T See Fast Ethernet 1000BASE-T See Gigabit Ethernet Audio Channel A single audio signal. Audio channels on CobraNet have a 48 kHz sampling rate and may be 16, 20 or 24 bit resolution. Multiple audio channels may be carried in a Bundle.
CobraNet Programmer’s Reference Glossary of Terms CobraNet Device A device in compliance with the CobraNet specification for transmission and/or reception of digital audio and associated sample clock. Conductor CobraNet Device on the network supplying master clock. A conductor arbitration procedure insures that at any time there is one and only one conductor per network. Crossover Cable A crossover cable can be used to directly connect two network devices.
CobraNet Programmer’s Reference Glossary of Terms Mbps Short for megabits per second, it is a measure of data transfer speed. Media Converter A Media Converter is typically a two port device that accepts one type of media on one port and a different media on the other. Common Ethernet media types are twisted pair, multimode and single mode fiber. Some hubs and switches include media conversion via plug in module options for various media types.
CobraNet Programmer’s Reference Glossary of Terms NIC A NIC or Network Interface Card is an expansion board inserted into a computer in order to connect the computer to a network. Typically, NICs are designed for a particular type of network and media, although some can serve multiple networks. Node A processing location. A node can be a computer, a switch, a CobraNet device, or any other device that has a unique network address. Repeater Hub An Ethernet multi-port repeater.
CobraNet Programmer’s Reference Glossary of Terms Proprietary single mode fiber systems each have their own run length limits; all exceed the 2 kilometer multimode limit. Some systems offer lengths in excess of 100 kilometers. Spanning Tree Protocol An IEEE standard protocol (802.1D) allowing detection and elimination of loops in Ethernet networks. Spanning tree protocol is implemented on most managed switches. More information on spanning tree protocol is available at http://www.peakaudio.com/ Index.htm.
CobraNet Programmer’s Reference Glossary of Terms Unicast Bundle A unicast bundle supports a one-to-one routing of audio on the network. Ethernet unicast addressing is used to deliver a unicast bundle. Because unicast addressing is friendly to Ethernet switches, unicast bundles should be used for audio delivery whenever possible. Unregulated Traffic Refers to any data transmitted onto a network by non-CobraNet devices.
CobraNet Programmer’s Reference Glossary of Terms DS651PM25 ©Copyright 2006 Cirrus Logic, Inc.
