View CM-1_1985239.PDF datasheet online --- IC-ON-LINE

Datasheet File OCR Text:

? copyright 2004 cirrus logic, inc. oct ?04 ds651pm21 http://www.cirrus.com digital audio networking processor cobranet preliminary product information this document contains information for a new product. cirrus logic reserves the right to modify this produ ct without notice. cobranet programmer?s reference version 2.1 replaces ds651pm20 ?
digital audio networking processor cobranet 2 ? copyright 2004 cirrus lo gic, inc. ds651pm21 features cobranet ? 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. ? free cobracad ? audio network design tool ? high-quality audio sample clock delivery over ethernet ? uncompressed 16-, 20-, and 24-bit audio transport ? professional 48-khz and 96-khz sample rate ? low (1-1/3 ms) latency ? flexible many-to-many network audio routing capabilities ? available in a family of modules and low cost devices, most without licensing fees or royalties. cobranet interface ? auto-negotiating, 100-mbit, full-duplex ethernet connections ? up to 64 audio channel i/o capability ? implements cobranet protocol for real-time transport of audio over ethernet. ? local management via 8-bit parallel host port ? udp/ip network stack with dynamic ip address assignment via bootp or rarp ? remote management via simple network management protocol (snmp) ? available module form factor allows for flexible integration into audio products. ? 100-mips digital signal processor ? non-volatile storage of configuration parameters ? safely upgrade firmware over ethernet connection ? led indicators for ethernet link activity, conductor status, and fault annunciation ? watchdog output for system integrity assurance ? comprehensive power-on self test (post) ? error and fault reporting and logging mechanisms host interface ? 8-bit data, 3- or 4-bit address ? virtual 24- or 32-bit data and addressing ? polled, interrupt, and dma modes of operation ? configure and monitor cobranet interface ? transmit and receive ethernet packets at 100-mbit wire speed asynchronous serial interface ? full-duplex capable ? 8- and 9-bit data formats ? standard baud rates up to 115.2 kbps ? transmitter tri-state control for multi-drop networking synchronous serial audio interface ? 4 bi-directional interfaces supporting up to 64 channels of audio i/o ? 48- and 96-khz sample rates ? 64fs, 128fs, and 256fs bit rates supported ? supports numerous synchronous serial formats including i 2 s ? up to 32-bit data resolution audio clock interface ? 4 host audio clocking modes for maximum flexibility in digital audio interface design ? low-jitter, 512fs (24.576 mh z) master clock oscillator ? synchronize to supplied master and/or sample clock ? sophisticated jitter attenuation assures network perturbations do not affect audio performance. audio routing and processing ? single-channel granularity in routing from synchronous serial audio interface to cobranet network ? two levels of audio routing indirection absorbs any quirks in audio i/o interface design in host system. ? local audio loopback and output duplication capability ? peak-reading audio metering with ballistics
digital audio networking processor cobranet ds651pm21 ? copyright 2004 cirru s logic, inc. 3 general description 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. ? isochronous audio data transport ? sample clock distribution ? control and monitoring data transport the cobranet interface performs synchronous-to- isochronous and isochronous-to-synchronous conversions as well as the data formatting required for transporting real-time digital audio over the network. the cobranet interface ut ilizes standard ethernet. it has the added capability to carry and utilize other ethernet and ip compatible protocols for control and monitoring such as simple network management protocol (snmp) and user datagram protocol (udp) through the same network co nnection. this capability is shown below as unregulated traffic. data communications and cobranet applications can coexist on the same physical network in most cases. isochronous data (audio) control data clock unregulated traffic ethernet ethernet control data isochronous data (audio) unregulated traffic clock figure 1. digital audio distribution via ethernet
4 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference - notes -
cobranet programmer?s reference table of contents ds651pm20 ? copyright 2004 cirru s logic, inc. 5 table of contents features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 general description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1. overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 1.1 cobranet terminology ....................................................................................................... .7 1.2 protocol ................................................................................................................... ............ 8 1.2.1 beat packet......................................................................................................... 8 1.2.2 isochronous data packet (or bundle) ................................................................. 8 1.2.3 reservation packet ............................................................................................. 9 1.2.4 serial bridge packet............................................................................................ 9 1.3 timing and performance..................................................................................................... 9 1.4 bundle addressing types .................................................................................................... 9 2. control communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 2.1 serial bridge.............................................................................................................. ........ 11 2.2 packet bridge.............................................................................................................. ...... 12 2.2.1 packet bridge buffer data format .................................................................... 12 processor-dependent layout of packet bridge buffers.............................. 12 24-bit hmi packet bridge buffer data format ............................................ 13 32-bit hmi packet bridge buffer data format ............................................ 13 2.2.2 packet bridge receive filtering ........................................................................ 14 3. synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 3.3 cobranet audio clock block diagram .............................................................................. 16 3.4 synchronization modes..................................................................................................... 1 6 3.4.1 internal .............................................................................................................. 17 3.4.2 internal with external sample synchronization................................................. 17 3.4.3 external word clock ......................................................................................... 17 3.4.4 external master clock ....................................................................................... 17 3.4.5 external master clock with external sample synchronization.......................... 18 4. network stack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4.1 cobranet audio............................................................................................................. .... 19 4.2 serial bridge.............................................................................................................. ........ 19 4.3 packet bridge.............................................................................................................. ...... 19 4.4 bootp...................................................................................................................... ........ 19 4.5 rarp (partial support) ..................................................................................................... .20 4.6 icmp (partial support) ..................................................................................................... .. 20 4.7 arp........................................................................................................................ ........... 20 4.8 ip......................................................................................................................... .............. 20 4.9 udp........................................................................................................................ ........... 21 4.10 tftp ........ ................ ................ ................ ................ ................ ................. ............. ......... 21 4.11 snmp...................................................................................................................... ........ 21 5. audio paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 5.1 audio routing channels ................................................................................................... 23 5.2 bundle transmitters ........................................................................................................ .. 23 5.3 bundle receivers ........................................................................................................... ... 23 5.4 loopback................................................................................................................... ........ 23 5.5 output channel duplication ..............................................................................................24 5.6 meters ..................................................................................................................... .......... 24 5.7 low-latency audio support ............................................................................................... 24 5.8 96-khz sample rate support ........................................................................................... 26 6. management interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 6.1 flash ...................................................................................................................... ........... 28 6.2 persistence ................................................................................................................ ....... 29 6.3 watch dog .................................................................................................................. ...... 29 6.4 snmp extension agent..................................................................................................... 30
6 ? copyright 2004 cirrus lo gic, inc. ds651pm20 cobranet programmer?s reference table of contents 7. management interface variable reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 7.1 legend ..................................................................................................................... ......... 31 7.2 data types................................................................................................................. ....... 31 7.2.1 displaystring ..................................................................................................... 31 7.2.2 oid.................................................................................................................... 32 7.2.3 ipaddress .......................................................................................................... 32 7.2.4 physaddress ..................................................................................................... 32 7.2.5 timeticks.......................................................................................................... 33 7.2.6 counter ............................................................................................................. 34 7.2.7 counter2 ...........................................................................................................34 7.2.8 integer ............................................................................................................... 34 7.2.9 integer16 ...........................................................................................................34 7.2.10 integer48 ......................................................................................................... 35 7.3 mib-ii variables........................................................................................................... ...... 36 7.3.1 system .............................................................................................................. 36 7.3.2 interface ............................................................................................................ 40 7.3.3 address translation .......................................................................................... 48 7.3.4 ip....................................................................................................................... 49 7.3.5 udp................................................................................................................... 56 7.3.6 snmp................................................................................................................ 58 7.4 cobranet variables......................................................................................................... ..68 7.4.1 firmware ...........................................................................................................68 7.4.2 hardware identification ..................................................................................... 71 7.4.3 flash ................................................................................................................. 73 7.4.4 errors ................................................................................................................ 78 7.4.5 conductor.......................................................................................................... 81 7.4.6 packet bridge.................................................................................................... 83 7.4.7 serial bridge...................................................................................................... 88 7.4.8 interrupt control ................................................................................................ 91 7.4.9 audio ................................................................................................................. 94 7.4.10 receivers ......................................................................................................103 7.4.11 transmitters ..................................................................................................107 7.4.12 synchronization.............................................................................................112 7.4.13 snmp monitor...............................................................................................115 7.4.14 mi monitor .....................................................................................................116 7.4.15 ip monitor......................................................................................................117 7.4.16 if monitor ......................................................................................................118 8. recommended user interface practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 8.1 channel assignments and labeling................................................................................120 8.1.1 audio i/o map .................................................................................................120 8.1.2 bundle assignments .......................................................................................120 8.2 conductor priority ......................................................................................................... ..121 8.3 name....................................................................................................................... ........121 9. error reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 9.1 recoverable errors ......................................................................................................... 122 9.1.1 receive and transmit errors ..........................................................................122 9.1.2 faults ..............................................................................................................122 9.2 unrecoverable errors ......................................................................................................1 22 9.2.1 fatal faults .....................................................................................................122 9.2.2 post failure ..................................................................................................123 10. error code reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 10.1 legend .................................................................................................................... ......124 10.2 error code interpretation ..............................................................................................124 10.2.1 extraction of byte code for 32-bit interfaces ................................................124 10.2.2 optional extraction of byte code for 24-bit interfaces ..................................125 10.3 error codes listing ....................................................................................................... 125 11. legal notice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
cobranet programmer?s reference overview ds651pm21 ? copyright 2004 cirru s logic, inc. 7 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 terminol ogy, 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. bundle ?a bundle* is the basic cobranet audio routing element and can carry 0 to 8 audio channels. bundles are assigned a number which determines both which interface the bundle is routed to and in what manner. the range within which the bundle number falls determines whether it is routed as a multicast , unicast, or private type . bundles are numbered 1 through 65535. cobranet interfaces are capable of sending and receiving multiple bundles simultaneously. bundle numbers are described in more detail in table 2., "bundle numbering" . * bundles were formerly referred to as channels or network channels and may be seen represented as such in some snmp variable names and older documentation. cobranet device ?a cobranet device is any equipment containing one or more cobranet interfaces. cobranet interface ?the cobranet interface is the hardware (or hardware design) and software supplied by cirrus logic to manu facturers of cobranet enabled equipment. several generations of the cobranet interface exist and will interoperate with each other: cs181xx - a family of cobranet chips containing one or more 32-bit, 100 mips dsp cores, ram and audio i/o circuitry. cm-2 - a modular cobranet interface based on a cs181xx chip family. CM-1 - a modular cobranet interface based on a 24-bit, 100 mips dsp. cs18101 reference design - a cobranet design based on the cs18101. this is essentially a cm-2 without the modular circuit board and host interface connector. 24-bit platform - cobranet interfaces based on 24-bit dsps: reference design, CM-1. 32-bit platform - cobranet interfaces based on 32-bit dsps: cs181xx, cm-2. reference design - a cobranet interface design based on a 24-bit, 40 mips dsp. conductor ?the conductor is the cobranet interface elected to provide master clock and transmission arbitration for the network. the role of the conductor and the means for selecting a conductor are described elsewhere in this document. all cobranet devices other than the conductor operate in a performer role. isochronous cycle - one or more cobranet bundles are transmitted each isochronous cycle. the period of an isochr onous cycle is 750 hz or 1-1/3 ms 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 cs181xx hardware manual and CM-1 hardware manual.
8 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference overview management interface (mi) - the set of variables used to control and monitor the cobranet interface. mi variables are accessible both locally through the host management interface (hmi) and over the network using simple network management protocol (snmp) . mi variables are described in detail in section 7. "management interface variable reference" on page 31 . packet bridge - a function provided by the cobranet protocol which allows a cobranet interface to send and receive raw ethernet packets over the same ethernet media used for audio transmission. performer - a cobranet interface which receives its transmission permissions and master clock from a conductor. in the event a conductor fails, the cobr anet protocol will automatically promote a performer to become the new conductor. receiver - a logical entity within the cobranet interface capable of receiving one bundle. serial bridge - a function provided by the cobranet protocol which allows a cobranet interface to send and receive asynchronous (i.e. rs-232) data over the same ethernet media used for audio transmission. transmitter - a logical entity within the cobranet interface capable of transmitting one bundle. 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. packet bridge packets are generic packets and are not identified as cobranet packets. packet bridging is discuss ed in more detail in section 2.2 "packet bridge" on page 12 . 1.2.1 beat packet a multicast packet with an address of 01:60:2b:ff:ff:00 and which contains network operating parameters, clock and transmi ssion permissions. the beat packet is transmitted from a single cobranet device on the network (the conductor) and indicates the start of an isochronous cycle. since the beat packet carries the clock for the network, it is sensitive to delay variation. if the delay variation specification shown in table 1 on page 9 is not met, cobranet devices may not be able to lock their local sample clocks to the network clock. the beat packet is typically small (on the order of 100 bytes) but can be large on a network with numerous active bundles. 1.2.2 isochronous da ta packet (or bundle) a multicast or unicast packet. the size of the packet/bundle is dependent on the number and format of the audio channels contained in the bundle. because cobranet devices buffer isochronous data packets, out-of-order delivery of data packets is acceptable as long as the packet forwarding delay specifications in table 1 on page 9 are not exceeded.
cobranet programmer?s reference overview ds651pm21 ? copyright 2004 cirru s logic, inc. 9 1.2.3 reservation packet a multicast packet with an address of 01:60 :2b:ff:ff:01 used by the cobranet protocol to allocate bandwidth and establish connections between cobranet interfaces. cobranet devices transmit reservation packes as needed or typically once per second at minimum. 1.2.4 serial bridge packet a multicast or unicast packet used to bridge asynchronous serial data between cobranet interfaces. serial bridging is discussed in more detail in section 2.1 "serial bridge" on page 11 . 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 m eans 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). the design check feature in cobracad assures that the performance requirements shown in table 1 are met and that the network is capable of delivering the bandwidth required to support the modeled application. 1.4 bundle addressing types multicast bundles represent a least common denominator for audio interoperability in cobranet networks. bundles sent with mu lticast 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.com) for a discussion of issues associated with multicast bundles. unicast bundles are sent to only one destination on a network. however, in the event that more than one cobranet interface is set to receive the same bundle number, the cobranet protocol may, according to rules governed by the txunicastmode and txmaxunicast variables, cause unicast bundles to be sent as multicast or multi-unicast when necessary. multi-unicast will use unicast addressing to send up to four copies of the table 1. network performance requirements parameter maximum comments a a. with the exception of the reservation packet, any dropp ed packet will cause an interruption in service. dropped isochronous data packet(s) will affect only the associated bundle(s). dropped beat packets may affect the entire network. beat packet delay variation 250s if delivery of beat packets periodically varies from the nominal delay by more than this value, then the receivers may loose sample lock or fail to meet clock delivery specifications forwarding delay towards achieving 5-1/3ms audio propagation delay in 5-1/3ms operating mode. 400s forwarding delay is the sum of store forward, queuing and propagation delays. forwarding delay includes delay variation i.e. 150s forwarding delay + 250s delay variation = 400s. thus tolerance of forwarding delay is reduced in the presence of delay variation. additional audio latency is added to the audio in increments of 64 sample periods (1-1/3ms ) if the forwarding delay specification is violated. forwarding delay 3800s audio cannot be delivered at any latency with extreme forwarding delays.
10 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference overview same bundle to different cobranet interfaces.the default configuration for txunicastmode insures that unicast bundles are never multicast. private bundles are a special case of unicast or multicast bundles. the transmitter's mac address, in addition to the bundle number, is required to fully qualify a private channel at the receiver. like unicast bundles, these may be either unicast or multicast based on txunicastmode. note: transmitted bundles must have a unique bundle number assigned to them. more than one transmitting interface cannot use the same bundle number. multiple receiving interfaces can receive the same bundles. table 2. bundle numbering hexadecimal bundle number decimal bundle number designation usage transmission addressing transmission mode 0 0 null unused bundle. disables transmission/reception when selected. never transmitted. never transmitted. 1-0xff 1-255 multicast transmitted by a single cobranet interface and received by any number of interfaces. always multicast always transmitted. 0x100- 0xfeff 256-65279 unicast transmitted by a single cobranet interface. dependent on txunicastmode and txmaxunicast settings may be received at a single (default case), a few (multiple unicast case) or a large number (multicast case) of interfaces. generally unicast but may multicast if txunicastmode variable is adjusted. only transmitted when at least one receiver is identified via reverse reservation. 0xff00- 0xffff 65280-65535 private individual transmitters locally allocate private channels. the bundle number is conditioned on the transmitter's mac address. there are 256 of these bundles per transmitter thus the total number of private bundles is virtually unlimited as the bundle numbers are unique to a particular mac address. generally unicast but may multicast if txunicastmode variable is adjusted. only transmitted when at least one receiver is identified via reverse reservation.
cobranet programmer?s reference control communications ds651pm21 ? copyright 2004 cirru s logic, inc. 11 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. it is received at the destination cobranet interface where the data in the packet is re-serialized and presented on the serial interface. many standard asynchronous serial formats are supported. with proper physical interface circuitry, this port can be made to support rs-232, rs-422 or rs-485 standards. multi-drop two-wire interfaces are also supported. the bridging feature can be useful in a cobranet product as either an internal or external control interface. used externally, the appropriate transceiver, such as an rs-232 driver chip, is connected to the logic-level pins and in turn connected to a standard connector, such as a db-9 or db-25, on the back panel. this allows control of external serial interfaced devices remotely over ethernet. figure 2. serial bridging, external application internal application of the serial bridge allows serial communications over the network between host processors which are incorporat ed into cobranet devices. using this communication scheme reduces engineering effort in integrating cobranet into audio products that already accomplish control communications via serial link. cobranet interface ethernet network cobranet interface rs-485 multi-drop n etwor k rs-232 connection ethernet network cobranet interface micro- controller cobranet interface micro- controller figure 3. serial bridging, internal application
12 ? copyright 2004 cirrus lo gic, inc. ds651pm21 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-s erializing, and prioritizing the serial bridge packets. these delays are typically on the order of 10ms or less. see table 7.4.7 on page 88 for details on the mi variables used to control serial bridging. 2.2 packet bridge the packet bridge provides a means for using the cobranet interface as if it were an ethernet controller by providing a basic capability to send and receive raw ethernet packets. a cobranet device utilizing a host processor with network stack can use this feature to transmit and receive both control and audio data over the same network connection. in the simplest implementation, the host sees the packet bridge as several control variables, a receive buffer, and a transmit buffer which are accessed via the hmi interface. ethernet data packets are transferred in both directions over the host port using the same hmi semantics used to read and write other mi variables. more advanced implementations can take advantage of interrupt and dma modes of hmi operation as well as some hmi operations specifically tailored to packet bridge functions. refer to table 7.4.6 on page 83 for details on the mi variables used to control packet bridging. 2.2.1 packet bridge buffer data format packets are transmitted by writing raw packet data to bridgetxpktbuffer . packets are received by reading bridgerxpktbuffer . data in both buffers shares the same format. the first word of the buffer specifies the byte length of the data that follows. byte length includes the14-byte ethernet header. the frame check sequence (fcs) is automatically appended to transmitted packets and automatically checked and stripped from received packets. the fcs is not included in the packet data or byte length specification. byte length should be in the range 14 to 1514. 2.2.1.1. processor-dependent layout of packet bridge buffers refer to ta b l e 3 and table 4 on page 13 for organization of data within bridge buffers for 24- and 32-bit platforms. all data marked as unused/0 will be received as 0 and must be set to 0 when writing the buffer prior to transmission. for both platforms, requested transmissions shorter than the 60-byte ethernet packet minimum will be padded to 60 bytes with indeterminate data.
cobranet programmer?s reference control communications ds651pm21 ? copyright 2004 cirru s logic, inc. 13 2.2.1.2. 24-bit hmi packet bridge buffer data format packet byte length is specified in the two ms bytes of the first word. the ls bytes will read 0 on receipt and must be set to 0 for transmit. transmit byte length is rounded up to the nearest even multiple of 4. receive byte length indicates the actual number of bytes received. 2.2.1.3. 32-bit hmi packet bridge buffer data format packet data begins with the second word. transmission order of each word is mh, ms, ls, ml. table 3. packet bridge buffer layout, 24-bit platforms ms middle ls word 1 packet byte length ms packet byte length ls unused/0 word 2 destination mac byte 2 destination mac byte 3 unused/0 word 2 destination mac byte 4 destination mac byte 3 unused/0 word 3 destination mac byte 6 destination mac byte 5 unused/0 word 4 source mac byte 2 source mac byte 1 unused/0 word 5 source mac byte 4 source mac byte 3 unused/0 word 6 source mac byte 6 source mac byte 5 unused/0 word 7 protocol identifier ls protocol identifier ms unused/0 word 8 payload byte 2 payload byte 1 unused/0 ... ... ... unused/0 word n payload byte n payload byte n-1 unused/0 table 4. packet bridge buffer layout, 32-bit platforms ms mh ml ls word 1 byte length ms byte length ls unused/0 unused/0 word 2 destination mac byte 2 destination mac byte 1 destination mac byte 4 destination mac byte 3 word 3 destination mac byte 6 destination mac byte 5 source mac byte 1 source mac byte 2 word 4 source mac byte 4 source mac byte 3 source mac byte 6 source mac byte 5 word 5 protocol identifier ls protocol identifier ms payload byte 2 payload byte 1 word 6 payload byte 4 payload byte 3 payload byte 6 payload byte 5 ... ... ... ... ... word n payload byte n-2 payload byte n-3 payload byte n payload byte n-1
14 ? copyright 2004 cirrus lo gic, inc. ds651pm21 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. with bridgerxfilter = 0x02 or 0x08, copies of selected packets are passed both to the packet bridge and are processed by the cobranet interface. the packet bridge never passes audio data packets or beat packets to the host. the operation of packet bridge filtering is shown in figure 4 below. figure 4. packet brid ge receive filtering cobranet? 0x8819 reservation request? beat packet? serial bridge packet? audio bundle? ip? packet destinationip= ipmoncurrentip? snmp? tftp? bootp? process reservation request arp/rarp? process arp or rarp request process packet bridge rxpktbuffer snmp agent tftp server bootp client process beat packet process serial bridge packet process audio bundle ethernet packet 0x08 copies all ip packets and forwards to host processor 0x02 copies reservation requests and forwards to host processor 0x01 bridges special 0x8819 non-audio packets 0x10 bridges all packets with unknown protocol (usually custom control protocol) y n y n n y n y y y n y n n y n y n y n=special case y packet dropped
cobranet programmer?s reference control communications ds651pm21 ? copyright 2004 cirru s logic, inc. 15 the default value of bridgerxfilter is 0x01. when bridgerxfilter is set to 0x08 and/or 0x02, the cobranet interface and the hos t processor can independently process the same packets. the host processor can use 0x08 in order to respond to packets with ip addresses other than the address assigned to the cobranet interface. care must be taken in the host processor software when using these modes to ensure that the cobranet interface and host processor do not both respond to the same packets.
16 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference synchronization 3. synchronization 3.3 cobranet audio clock block diagram this diagram shows clock-related circuits on t he cobranet interface. this circuitry allows the synchronization modes documented below to be achieved. modes are distinguished by different settings of the multiplexors and software elements. figure 5. audio clock sub-system 3.4 synchronization modes although the clocking architecture of cobranet interfaces is very flexible, the standard internal synchronization mode will function well for most applications. other modes accommodate specific system needs. cobr anet clock synchronization modes are set independently for conductor and performer roles via the syncconductorclock and syncperformerclock mi variables. refer to figure 5 on page 16 for a graphical representation of the clocking architecture. the role (conductor vs. performer) is determined by the network environment including both the conductor priority ( condpriority ) of the device and of other devices on the network. see section 1.1 "cobranet terminology" on page 7 and section 8.2 "conductor priority" on page 121 for definitions of conductor and performer roles. vcxo 24.576 mhz mclk_out mclk_in mclk_sel aclkconfig refclkenable refclkpolarity refclk_in legend: external software component hardware component (cm2) internal hardware component (cs181xx) cs181xx dac fs1 slck phase detector loop filter sample phase counter edge detect audio clock generator beatreceived
cobranet programmer?s reference synchronization ds651pm21 ? copyright 2004 cirru s logic, inc. 17 3.4.1 internal all cobranet clocks are derived from the onboard voltage controlled crystal oscillator (vcxo). the master clock generated by the vcxo is available to external circuits via mclk_out. conductor ?the vcxo frequency can be adjusted by the syncclocktrim setting. clock trim adjustments are not necessary in most cases. the default syncclocktrim setting is appropriate. performer ?the vcxo frequency is steered to match the clock transmitted by the conductor. 3.4.2 internal with external sample synchronization this mode is identical to internal mode exc ept it allows synchroni zation of audio clocks (fs1, sclk) to an external source via refclk_i n. this additional functionality is useful when adapting the cobranet interface to a devi ce that contains circuitry for generating these audio clocks from the master clock (mclk_out). conductor ?the vcxo frequency can be adjusted by the syncclocktrim setting. performer ?the vxco is steered to match the clock transmitted by the conductor. 3.4.3 external word clock all cobranet clocks are derived from an onboard vcxo which is steered from an external clock supplied to refclk_in. the clock supplied can be any integral factor of the sample clock in the range of 750 hz to 48 khz. external synchronization lock range: +/-5 s. this specification indicates possible drift or wander plus error between the supplied clock and the generated clocks. conductor ?this mode gives a means for synchronizing an entire cobranet network to an external clock. performer ?the interface will disregard the fine timing information delivered over the network from the conductor. fine timing information will instead be supplied by refclk_in. refclk_in must be synchronous with the network conductor. this mode may be useful in installations where a house sync source is readily available. 3.4.4 external master clock the vcxo is disabled and mclk_in is used as the master clock for the interface. this is a ?hard? synchronization mode. the supplied clock is used directly by the cobranet interface for all timing. the supplied cloc k must be 24.576 mhz for cobranet modules and cs181xx or 12.288 mhz for reference design hardware. conductor ?the entire network is synchronized to the supplied clock. performer ?the interface will initially lock to the network clock and will ?jam sync? via the supplied master clock. the exte rnal clock source must be synchronous with the network conductor. this mode is primarily useful for cobranet devices containing multiple cobranet interfaces.
18 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference synchronization 3.4.5 external master clock with external sample synchronization this mode is identical to external master clock mode except that it allows synchronization of the audio clocks (fs1, slcl k) to an external source via refclk_in. this additional functionality is useful when using the cobranet interface with a device that contains circuitry for generating these clocks from the master clock (mclk_out). conductor ?the entire network is synchronized to the supplied clock. performer ?the interface will initially lock to the network clock and will ?jam sync? via the supplied master clock. the exte rnal clock source must be synchronous with the network conductor. this mode is useful for devices with multiple cobranet interfaces.
cobranet programmer?s reference network stack ds651pm21 ? copyright 2004 cirru s logic, inc. 19 4. network stack figure 6. cobranet network stack 4.1 cobranet audio this includes transmission and reception of audio data packets and reservation requests, implementation of conductor arbitration, and the ability to serve in either conductor or performer roles. cobranet audio is a self-contained service that spans from logical link (2) to application (7) layers. 4.2 serial bridge this service provides bridging of asynchronous serial streams over the ethernet network. this self-contained service spans from the logica l link to the application layer. the serial bridge service is discussed in section 2.1 "serial bridge" on page 11 . 4.3 packet bridge this service simply allows the cobranet interf ace to operate as an ethernet controller for a connected host. this service works at the logical link layer and provides access to the network without providing any actual network services. the packet bridge feature is discussed in section 2.2 "packet bridge" on page 12 . 4.4 bootp the boot protocol (bootp) is supported as specified in rfcs 951 and 1542. network clients use bootp to receive an ip address from a bootp server. clients needing an ip address will broadcast a bootp request packet. a bootp server on the network will respond with a bootp response containing the preferred ip address for the client to use. use of bootp simplifi es the error-prone task of assigning unique ip addresses to devices on a large network. bootp is carried via udp/ip and, as such, is able to pass through properly configured routers. bootp requests are transmitted by the cobranet interface on a randomized schedule as recommended in the rfcs. requests are sent out frequently at startup and then taper cobranet services internet protocol suite fast ethernet interface 802.3 ethernet ip rarp arp udp bootp snmp tftp icmp packet bridge cobranet audio serial bridge physica l logical link network transport applicatio n
20 ? copyright 2004 cirrus lo gic, inc. ds651pm21 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. in order to avoid producing unregulated traffic, bootp requests are not transmitted on a repeater network. upon receipt of a valid bootp response, a c obranet device will change its ip address to the ip address indicated by the bootp response. it is not necessary for a response to be paired with a specific request to be considered valid. 4.5 rarp (partial support) rfc 903 defines reverse address resolution prot ocol (rarp). network clients use rarp to receive an ip address from a central server. rarp differs from bootp in that it is carried at the logical link layer (layer 2) and thus cannot pass through ip routers. rarp is comprised of request and response packet types. upon receipt of a valid rarp response packet, a cobranet device will change its ip address to the ip address indicated by the rarp response. the cobranet network stack does not transmit rarp request packets. rarp is the means used by the cobranet discovery applicati on (disco) and cndisco object for ip address assignment. 4.6 icmp (partial support) internet control message protocol (icmp) is an administrative protocol defined in rfc 972. cobranet devices which have been assigned an ip address will respond to icmp echo (commonly referred to as ?ping?) requests. no other icmp support is implemented in the cobranet network stack. 4.7 arp address resolution protocol (arp) is used by the ip protocol to translate ip addresses to mac addresses according to rfc 826. a host seeking a mac address associated with an ip address broadcasts an arp request. the device using the specified ip address replies with an arp response packet. in this way the requesting host obtains the mac address for the target device. the cobranet interface responds to arp requests when appropriate. cobranet will not generate arp requests. for this reason the cobranet can only respond to ip messages and cannot initiate ip communications. 4.8 ip the internet protocol (ip) is defined in rfc 791. ip is a network protocol (layer 3 of the osi 7-layer networking model) responsible for routing of packets and segmentation and reassembly of packets.
cobranet programmer?s reference network stack ds651pm21 ? copyright 2004 cirru s logic, inc. 21 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 neces sary on heterogeneous networks (those comprising multiple network technologies such as ethernet, fddi, and isdn). cannot initiate ip communications; can only respond to incoming messages. the cobranet implementation does not support net mask and default gateway concepts required to initiate communications to other subnets. furthermore, cobranet's implementation of arp does not support generation of arp requests. 4.9 udp user datagram protocol (udp) is defined in rfc 768. udp is a transport protocol (layer 4 of the osi 7-layer networking model) responsible for maintaining the integrity of data. udp is an extremely simple protocol which, by design, defers the data integrity problem to application protocols in higher network layers. cobranet fully supports udp. 4.10 tftp trivial file transfer protocol (tftp) is defined in rfc 783. tftp supports file read and write via a udp/ip transport. the cobranet im plementation of tftp supports only binary reads and writes to a specific set of files. this is the mechanism used to update firmware in a cobranet interface. the tftp file names correspond to the different sectors of the flash memory and can differ in name and size for different revisions of cobranet interface hardware. firmware update is a complex process best accomplished by use of an encapsulated software module, such as the pacnfirm object library, or by use of the cobranet discovery program which are aware of the data structures and protocol utilized. 4.11 snmp version 1 of the simple network managemen t protocol (snmp) is defined in rfc 1157. the cobranet snmp interface is version 1 compliant. a management information base (mib) is as sociated with any snmp implementation. cobranet supports the standard mib for network devices as defined in rfc 1213 ?mib-ii? in addition to its own mib for cobranet-specific objects. the cobranet mib file is available for public download in order to facilitate full use of the cobranet snmp interface via sn mpv1 compliant applications.
22 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference audio paths 5. audio paths figure 7. cobranet interface audio model - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - tx1 tx2 tx3 tx4 rx1 rx2 rx3 rx4 - - - - - - - - - - - - - - - - 0 (silence) - - - - - - 1 8 - - - - - - - 16 - - - - - - - 24 - - - - - - - 32 - - - - - - 33 40 - - - - - - - 48 - - - - - - - 56 - - - - - - - 64 audiodupsrc audiodupdst txsubmap rxsubmap audiomap up to 8 channels each up to 8 channels each audio output metering transmitters receivers audio routing channels audio buffering synchronous serial transmitters synchronous serial receivers audio input metering outgoing audio bundles incoming audio bundles ethernet ethernet 1 2 31 32 33 34 63 64 audiometermap notes: 1. do not alter audiomap, use txsubmap and rxsubmap to control routing to/from bundles and ssi. 2. the number of transmitters and receivers may vary depending on the implementation. dup variables audioloopsrc audioloopdst loop variables
cobranet programmer?s reference audio paths ds651pm21 ? copyright 2004 cirru s logic, inc. 23 5.1 audio routing channels there are 65 audio routing channels within a cobranet interface numbered from 0 to 64. channels 1 through 32 are used to route audio from the synchronous serial interface (ssi) to the network transmitters. channels 33 through 64 are used to route audio from the network receivers to the ssi outputs. r outing channel 0 is a s pecial 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 thro ugh 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). to accommodate channel numbering differences of different cobranet devices, the audiomap variables allow a mapping from audio i/o buffer offsets to routing channel numbers. this mapping is preset by the manufacturer and should never need to be altered. 5.2 bundle transmitters a transmitter is a logical entity within the co branet interface capable of transmitting one bundle of up to 8 audio channels. input audio routing channels (0, 1 through 32) are mapped into bundles associated with a particular transmitter via the txsubmap variables associated with that transmitter. there are 8 txsubmap variables associated with each transmitter, each of which can be set to a particular routing channel number. the first txsubmap variable sets the routing channel that will be transmitted in the first audio channel in the bundle. the second txsubmap variable selects the source for the second audio channel to be transmitted in the bundle...and so on. audio resolution (sample size) and sample rate (48 khz or 96 khz) are determined by other transmitter parameters discussed in this document. 5.3 bundle receivers a receiver is a logical entity within the cobranet interface capable of receiving one bundle of up to 8 audio channels. output audio routing channels (0, 33 through 64) are mapped from the receiver via the rxsubmap variables. there are 8 rxsubmap variables associated with each receiver, each of which can be set to a particular routing channel number. the first rxsubmap variable selects the routing channel that will receive the first audio channel in the bundle. the second rxsubmap variable specifies mapping the second audio channel in the bundle...and so on. 5.4 loopback the loopback object provides a means for the interface to transfer audio channels internally. loopback overcomes the limitation that a device cannot receive its own transmission and also allows the aud io i/o system to be tested locally. the audioloopsource and audioloopdest variables control this feature.
24 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference audio paths 5.5 output channel duplication the audio routing channel mapping facilities allow a single routing channel to be mapped to any number of audio channels in any number of network transmitters (bundles). it is, however, not possible to direct an audio channel in a network receiver to multiple audio routing channels for output through multiple ssi channels or ports. output channel duplication allows output routing channels to be copied to other output routing channels. this feature is implemented as a separate set of ?dup? paths controlled 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 7.4.9 "audio" on page 94 for more information. 5.6 meters metering is provided for all 64 audio routing channels. the first 32 meters can be mapped to the 32 input routing channels. the second 32 meters are used to meter the output routing channels. mapping is controlled by the audiometermap variable . metering is disabled by default to conserve processing cycles. meters are peak detecting with simple first-order decay ballistics. balli stics are comprised of an instantaneous attack and exponential decay time programmable via audiometerdecay variable. ballistics are adjusted globally for all meters. all level measurements are peak level (as opposed to rms, for instance). level is indicated in 24-or 32-bit positive signed values. a cumulative peak hold element on each meter allows accura te detection of any clipping condition. see section 7.4.9 "audio" on page 94 for more information. 5.7 low-latency audio support low-latency modes are supported on cobranet interfaces without need for hardware changes to the cobranet interface or cobranet device. the default mode of operation is 5-1/3 ms latency at 48-khz sample rate. running in low-latency mode requires more processing power, implying a trade-off between the number of channels supported and reduction of latency. some reference- design-based products need to operate at reduced channel count to support lower latency. depending on selected sample size, sample rate, and latency, newer cobranet interfaces may be subject to some limitation in channel capacity, number of transmitters and receivers, and multiple unicast transmission count. the following table shows CM-1 channel capacity for several latency and sample rate operating modes. eight-channel bundles with 20-bit resolution, unicast to a single destination or multicast is assumed. low-latency modes also place additional dem ands on network performance. specifically, in order to achieve the desired latency, forw arding delay across the network needs to be reduced by approximately the same factor that audio latency is reduced. these requirements bring into play new network design rules. lower latency is achieved by transmitting smaller audio packets at a higher rate. a restriction on the number of audio channels allowed in a bundle is due to a restriction on
cobranet programmer?s reference audio paths ds651pm21 ? copyright 2004 cirru s logic, inc. 25 the maximum size of an ethernet packet. therefore lower-latency modes have relaxed restrictions in this area. audio channel count restrictions are summarized below. bundle capacity or maximum channel count ma y be limited in some cases by both the allowable ethernet packet size and by the processor bandwidth required to handle lower latency and/or higher sample rate modes. limitations imposed by packet size are illustrated in ta bl e 5 . limitations imposed by additional bandwidth requirements are discussed in the hardware reference manual applicable to the particular cobranet interface. table 5. bundle capacity limits as a function of ethernet packet size latency channels per bundle 16 bit, 48 khz 20 bit, 48 khz 24 bit, 48 khz 16 bit, 96 khz 20 bit, 96 khz 24 bit, 96 khz 5-1/3 ms 8 8 7 5 4 3 2-2/3ms 888887 1-1/3ms 888888
26 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference audio paths a cobranet interface operates at a single late ncy and sample rate mode as specified by the moderatecontrol variable. this latency mode applies to all incoming and outgoing audio at the interface. 1 rxsubformat is a read only variable indicating the format of the audio data being received and decoded. it will have the same value as txsubformat with the exception of the least-significant bit. i.e. 16-bit, 48-khz sample rate, 5 1/3-ms latency = 0x44001 when the data is being successfully decoded. 2 moderatecontrol must also be set to the correct value necessary to support the mode selected by txsubformat . 5.8 96-khz sample rate support a cobranet interface may operate at either 48 khz or 96 khz but not both rates simultaneously. a device operating at 48 khz cannot receive audio from a device operating at 96 khz and vice versa. however, cobranet interfaces operating at 96 khz and 48 khz audio may co-exist on the same network. cs181xx, cm-2, and CM-1 based interfaces are required for 96-khz sample rate operation. no hardware changes are required to support the increased sample rate on these platforms. 96 khz is not supported in the legacy cobranet reference design. table 6. txsubformat and rxsubformat 1 values 2 txsubformat value resolution sample rate latency 0 no signal 0x044000 16 bit 48 khz 5-1/3 ms 0x054000 20 bit 48 khz 5-1/3 ms 0x064000 24 bit 48 khz 5-1/3 ms 0x148000 16 bit 96 khz 5-1/3 ms 0x158000 20 bit 96 khz 5-1/3 ms 0x168000 24 bit 96 khz 5-1/3 ms 0x042000 16 bit 48 khz 2-2/3 ms 0x052000 20 bit 48 khz 2-2/3 ms 0x062000 24 bit 48 khz 2-2/3 ms 0x144000 16 bit 96 khz 2-2/3 ms 0x154000 20 bit 96 khz 2-2/3 ms 0x164000 24 bit 96 khz 2-2/3 ms 0x041000 16 bit 48 khz 1-1/3 ms 0x051000 20 bit 48 khz 1-1/3 ms 0x061000 24 bit 48 khz 1-1/3 ms 0x142000 16 bit 96 khz 1-1/3 ms 0x152000 20 bit 96 khz 1-1/3 ms 0x162000 24 bit 96 khz 1-1/3 ms
cobranet programmer?s reference audio paths ds651pm21 ? copyright 2004 cirru s logic, inc. 27 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 dat e 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. an interface operating at 48 khz cannot decode 96-khz audio. an interface operating at 96 khz cannot decode 48-khz audio. processing 96-khz audio requires twice the bandwidt h. at 5-1/3 ms latency, all of the data is transmitted in one packet and thus the number of channels that can be transferred per bundle may be reduced. lower latency modes can support more channels at 96 khz, as the data is distributed across 4 packets at 1-1/3 ms and 2 packets at 2-2/3 ms latency. see table 5., "bundle capacity limits as a function of ethernet packet size" for more detail on this topic. when operating in 96-khz mode, the master clock remains at the standard 24.576 mhz. however, in 96-khz mode, the sample clock output (fs1) will change to support a 96-khz signal. if a sample clock cascade and/or reference clock input is supplied, this signal may be either 48 khz or 96 khz in 96-khz mode but must be 48 khz in 48-khz mode. table 7. bit clock rates synchronous serial port operating mode 48-khz sck rate 96-khz sck rate 64fs (2 channels x 4 interfaces) 3.072 mhz 6.144 mhz 128fs (4 channels x 4 interfaces) 6.144 mhz 12.288 mhz 256fs (8 channels x 4 interfaces) 12.288 mhz 24.576 mhz
28 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface 6. 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 configur ed in real time as the variables are changed. variables may have read-only, read/write, or read/write-persistent attributes. all variables are given an initial value at startup. the value of all variables can be read. read/write and read/write-persistent variable types can be both read and written. the value of persistent variables is saved in flash memory and the variable is restored at startup to the last value written. see section 6.2 "persistence" on page 29 for more detail on persistent variables. all mi variables are documented in the section 7. "management interface variable reference" on page 31 . mi variables fall into three classes. cobranet-specific variables allow for configuration and monitoring of cobranet functionality such as audio transmission and reception. a second class of variables known as snmp mib-ii variables provides a uniform means of monitoring a network device. these variables are primarily concerned with performance and configuration of the network interface and associated protocols. a third class of product-specific variables may exist when a manufacturer makes use of snmp extension agent capabilities. this third class of variab les is used for controlling and monitoring product-specific features and functions. 6.1 flash flash memory may be updated via tftp or through hmi. the hmi flash memory access mechanism allows flash contents to be read an d written via the host port. this provides functionality for the hmi similar to that which tftp provides via the network. the mechanism cannot allow direct access to the flash memory. instead a request to read or write flash is performed by supplying the flash address ( flashtaddress ), byte length ( flashtlength ), transfer direction ( flashtdirection ), and data ( bridgetxpktbuffer) . the request is then initiated by writing to flashtrequest . the flash memory is a byte-wide device. on 24-bit cobranet platforms, the transmit buffer is comprised of 3-byte words. the mapping between the byte-wide flash data and the wider buffer memory is as follows. table 8. flash layout, 24-bit platforms ms middle ls first word byte 3 byte 2 byte 1 second word byte 6 byte 5 byte 4
cobranet programmer?s reference management interface ds651pm21 ? copyright 2004 cirru s logic, inc. 29 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. 6.2 persistence the persistence feature causes values writte n to read/write-persistent type variables to be written to flash and for these stored values to be restored during startup. with the persistence feature disabled, read/write and read/write-persistent variables behave identically. persistence is enabled by setting the flashpersistenable variable. with persistence enabled, values written to r ead/write-persistent variables are written to flash by a background task according to a schedule designed to prevent excessive write cycles on the memory and to avoid interference with other critical functions. in extreme cases it can take up to 1 minute to store changed values. however, the persistence feature is implemented such that it is safe to remove power at any time with the caveat that the values recalled may not include changes made immediately prior to removal of power. variable values will never become corrupted due to unexpected loss of power or network connection. flashpersistack can be used to ensure that variables have been stored to non-volatile memory prior to removal of power. 6.3 watch dog the watch dog is a digital signal from the cobranet interface provided to allow fault detection. the watch dog signal is toggled peri odically by firmware to indicate normal operation. the toggle rate may drop to as low as 5 hz on occasion, depending on processor load. actual minimum, maximum, and nominal toggle rates can be found in the hardware reference manual applicable to the particular cobranet interface.the watch dog signal will stop toggling following detecti on and reporting of a fatal error condition. the interface should be reset and re-initialized when absence of the watchdog signal is detected. use of the watchdog requires external hardware and/or software. a hardware solution may be implemented with a ?microprocessor manager? chip such as the ds1236 from dallas/maxim. a software solution could involve wiring the watch dog signal to an i/o port, timer, or interrupt on the host processor and then wiring the cobranet reset signal to a general purpose output. software on the host processor would monitor the interval between watch dog transitions and assert the reset signal if the interval exceeds the maximum period. implementation of the watch dog feature is not mandatory but is recommended. esd, emi, and power fluctuation events are not uncom mon in audio installa tions and the ability to survive and recover from such conditions is a prerequisite for pas sing many electrical certification programs. table 9. flash layout, 32-bit platforms ms mh ml ls first word byte 4byte 3byte 2byte 1 second word byte 8byte 7byte 6byte 5
30 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface 6.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 sn mp 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 proc essor attached to the cobranet interface. the extension agent appears to the processor as additional product-specific variables in the hmi memory space. for status reporting, the host microcontroller writes updated values to the associated hmi locations. sn mp requests can then be used to read these values at any time. extension values can al so be written via snmp and monitored by the host processor in order to provide a control path to the host processor via snmp. extensions implemented along with the appropriate hardware and host software can be used to control and monitor many useful functions. for example, extension variables can be used to remotely monitor metrics such as gain, clipping and temperature. they can also be used to control functions such as gain, noise gates, and compression. the system will also benefit from the persist ence feature, allowing settings for the entire product, not just the cobranet interface, to be retained through a power-cycle. by using the extension agent, the entire product may be made snmp manageable without need for the host processor to be burdened with the complexity of running a network stack and snmp agent.
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 31 7. 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. the method of using the hmi is similar for all cobranet interfaces but may require specific semantics and may have different word sizes depending on the actual implementation. the hmi interface is described in more detail in the hardware reference manual applicable to the particular cobranet interface. following are detailed descriptions of the size, contents, and effects of the mi variables as well as their hmi addresses and snmp object identifier numbers. all mi variables can be accessed via the hmi but some variable properties render them inappropriate for accessing via snmp. these exceptions are noted in the variable descriptions where applicable. 7.1 legend name - name of variable as seen in cobranet mib and cobrami.h header file. description - description of the variable including allowed values and usage discussion. host address - hmi addresses are used to access variables via the host port. hmi addresses have a 24-bit range on both 24- and 32-bit platforms. snmp object id (oid) - the object identifier is the numeric name assigned to a variable according to the snmp protocol. size - size is indicated for varying-length data types such as displaystring and oid . size is not indicated for fixed types whose size is implied by their data type. note that for fixed types, the word size may differ depending on the processor type. count - number of entries for array or buffer-type variables. absence of a count specification implies a single instance variable, and thus a count of 1 . type - data type of the variable. the options and format of data types are described below in detail. attributes - read-only variables can only be read and can not be modified. read/write variables can be read and written. read/write - persistent variables can be read and written. if the persistence feature is enabled, values of these variables will automatically be written to flash for recall at startup. default - value assigned to the variable at startup when persistence is disabled. the values of some read-only variables reflect system conditions and thus may not have a default value. version - firmware version in which the variable was first introduced. unless otherwise noted in this field, one can assume variables will be available in the version indicated and all subsequent versions. 7.2 data types 7.2.1 displaystring a displaystring is an ascii string comprised entirely of printable characters.
32 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 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. the maximum allowable characters for a displaystring variable is ( size -1) 3. 32-bit hmi: the first word indicates the length of the string in characters. data is stored four characters per 32-bit word. char acter order is ms, mh, ml, ls. for displaystring variables, documented size indicates the largest possible word size of the variable. size includes the length field. the maximum allowable characters for a displaystring variable is ( size -1) 4. 7.2.2 oid an snmp object identifier is the numeric nam e of an snmp variable. oids are also used for other purposes including system-unique identifiers. 24-bit hmi : oids are presented in their native ber encoding. the first word indicates the length of the encoding in bytes. data is stored three octets per 24-bit word. character order is ms, middle, ls. for oid variables documented size indicates the largest possible word size for the variable. size includes the length field. the maximum number of octets for the oid variable encoding is ( size -1) 3. 32-bit hmi : oids are presented in their native ber encoding. the first word indicates the length of the encoding in bytes. data is stored four octets per 32-bit word. character order is ms, mh, ml, ls. for oid variables documented size indicates the largest possible word size for the variable. size includes the length field. the maximum number of octets for the oid variable encoding is ( size -1) 4. 7.2.3 ipaddress an ipaddress is a 32-bit internet protocol (ip) address. 24-bit hmi : data is stored in the most-significant 16 bits of 2 consecutive 24-bit words as shown in ta bl e 1 0 . the least-significant 8 bits of each location are read as zero and must be written as zero. 32-bit hmi: data is stored in a single 32- bit word as illustrated below. 7.2.4 physaddress a 48-bit ethernet media access control (mac) address. table 10. ip address layout, 24-bit platforms ms middle ls word 1 ip address byte 2 ip address byte 1 0 word 2 ip address byte 4 ip address byte 3 0 table 11. ip address layout, 32-bit platforms ms mh ml ls ip address byte 2 ip address byte 1 ip address byte 4 ip address byte 3
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 33 24-bit hmi : data is stored in the most-signific ant 16 bits of 3 consecutive memory locations as illustrated below. the least-signific ant 8 bits of each location are read as zero and must be written as zero. 32-bit hmi: data is stored in two consecutive words as shown below. a third word is unused and reserved for addressing compatibility with 24-bit platforms. 7.2.5 timeticks timeticks is an integer encoding for time durations in units of 100ths of a second. 24-bit hmi : an unsigned timer value is available in two successive 24-bit words. a 32-bit timer value and 15-bit fractional extension ar e available as shown below. the fractional extension may be used to gain additional accuracy. it may be safely ignored for most applications. 32-bit hmi: timeticks value is available as two sucessive 32-bit words. a 32-bit timer value, a 16-bit rollover, and 16-bit fractional extension are availabe as shown below. the fractional extension may be used to gain addi tional accuracy. the rollover extension may be used to extend the useful range of the timer. both may be safely ignored for most applications. table 12. mac address layout, 24-bit platforms ms middle ls word 1 mac byte 2 mac byte 1 0 word 2 mac byte 4 mac byte 3 0 word 3 mac byte 6 mac byte 5 0 table 13. mac address layout, 32-bit platforms ms mh ml ls word 1 mac byte 2 mac byte 1 mac byte 4 mac byte 3 word 2 mac byte 6 mac byte 5 unused unused word 3 unused unused unused unused table 14. timeticks layout, 24-bit platforms ms middle ls word 1 timer ms timer mh timer ml word 2 timer ls fractional ls fractional ms 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
34 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 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. as seen through snmp, timeticks variables roll over after 2 32 100ths of a second (42,949,672.96 seconds - over one year). 7.2.6 counter counters are never writable and cannot be reset. they indicate the count value since the interface was last restarted ( sysuptime = 0 ). counters roll over to zero after reaching their maximum value of 2 24 (16,777,216) on 24-bit platforms and 2 32 (4,294,967,296) on 32-bit platforms. 24-bit hmi: counter value is represented as a single 24-bit word. 32-bit hmi: counter value is represented as a single 32-bit word. 7.2.7 counter2 counter2 is specific to 24-bit platforms an d is a 48-bit unsigned event counter. counter2 rolls over after 2 48 counts. counters are never writable. on 32-bit platforms counter2 is identical to the counter type. 24-bit hmi : the counter value is stored in two successive memory locations. the most- significant word appears first. it is suggested that one read the ms word followed by ls word followed by a second read of the ms word and verify that the ms word has not changed during the ls read (if so, start over). 32-bit hmi: counter value is represented in the same single 32-bit word used for the counter type. snmp : only the least-significant 32-bits of t he counter value are reported. the counter appears to wrap at 2 32 and conforms to the expected behavior for the standard snmp counter data type. 7.2.8 integer a single-precision, signed integer. valid range is -2 23 (-8,388,608) to 2 23 -1 (8,388,607) on 24-bit platforms and -2 31 (-2,147,483,648) to 2 31 -1 (2,147,483,647) on 32-bit platforms. hmi : signed data is represented in a single word in 2's complement form. snmp : on 24-bit platforms, bad value error may be reported if the value magnitude exceeds the 24-bit signed integer range on a set operation. 7.2.9 integer16 a signed, 16-bit integer. valid range is -2 15 (-32,768) to 2 15 -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 c ontain 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 2 16 (65,536). snmp : bad value may be reported if value magnitude exceeds 2 16 on a set operation.
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 35 7.2.10 integer48 integer48 is specific to 24-bit platforms. this type is a signed, 48-bit integer. on 32-bit platforms integer48 is identical to the integer type. 24-bit hmi : data is stored in 2 consecutive memo ry locations. the most significant word appears first. signed data is represented in 2's complement form. 32-bit hmi : signed data is represented as the single word in 2's complement form used for the integer type. snmp : only the least-significant 32-bits of the value is reported.
36 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 7.3 mib-ii variables these variables are common to all snmp implementations. this common set of management variables is defined in the inter net engineering task force (ietf) standards document rfc 1213. 7.3.1 system name sysdescr description describes type of interface as ascii text. format for 24-bit platforms: cobranet vers ion ..[.] < hardware platform> rev format for 32-bit platforms: cobranet vers ion ..[.] format for rave platforms: cobranet vers ion ..[.] note: [.] is an additional ma nufacturer-specific string that can be optionally added to the firmware by cirrus logic for 24- bit platforms or added by the oem using the cncustom program for 32-bit platforms. eaxmple for cs18101: cirrus logic ev-2/cm-2 (cm18101) cobranet version 2.10.5 cs181012 host address 0x100000 snmp object id 1.3.6.1.2.1.1.1 size 78 characters for 24-bit platforms. 80 characters for cs181xx-based platforms. type displaystring attributes read-only default value ?[manufacturer name] [product name] cobranet firm ware [protocol version].[major version].[minor version].[manufacturer's version (optional, see note above)]? implemented version 2.9.10, 2.10.5
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 37 name sysobjectid description the vendor's authoritative identification of t he network management subsystem contained in the entity. this value is allocated within the smi ent erprise 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.4.1.2680.1.2.1.1 host address 0x100100 snmp object id 1.3.6.1.2.1.1.2 size 60 characters type oid attributes read-only default value 1.3.6.1.4.1.2680.1.2.(cobranet manufacturer id).(manufacturer product id) implemented version 2.6.3 name syscontact description the identification of the contact person for this managed node, together with information on how to contact this person. host address 0x100200 snmp object id 1.3.6.1.2.1.1.4 size 60 characters type displaystring attributes read/write - persistent default value zero length string implemented version 2.6.3
38 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name sysname description a name assigned to this managed node. by convent ion, this is the node' s fully qualified domain name. host address 0x100300 snmp object id 1.3.6.1.2.1.1.5 size 60 characters type displaystring attributes read/write - persistent default value product specific implemented version 2.6.3 name syslocation description the physical location of this n ode (e.g., ?telephone closet, 3rd floor?) host address 0x100400 snmp object id 1.3.6.1.2.1.1.6 size 60 characters type displaystring attributes read/write - persistent default value zero length string implemented version 2.6.3 name sysuptime description time in 100ths of a second since the network management portion of the system was last re- initialized. host address 0x100500 snmp object id 1.3.6.1.2.1.1.3 type timeticks attributes read-only default value 0 implemented version 2.6.3
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 39 name sysservices description a value which indicates the set of services supporte d 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. for example, a node which per forms primarily routing functions would have a value of 4 which is equal to (2^(3-1)). a node which is a host offering application services would have a va lue of 72 or (2^(4-1) + 2^(7-1)). in the context of the internet suite of protocols, the following service layers are commonly supported: 1 physical (e.g., repeaters), 2 datalink/subnetwork (e.g., bridges), 3 internet (e.g., ip gateways), 4 end-to-end (e.g., ip hosts), 7 applications (e.g., mail relays). for systems incl uding osi protocols, layers 5 and 6 may also be counted. host address 0x100502 snmp object id 1.3.6.1.2.1.1.7 type integer attributes read-only default value 72 implemented version 2.6.3
40 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 7.3.2 interface name ifnumber description the number of network interfac es (regardless of their current state) present on this system. host address 0x110000 snmp object id 1.3.6.1.2.1.2.1 type integer attributes read-only default value 1 implemented version 2.1.0 name ifdescr description a string containing information about the interface. this string should include the name of the manufacturer, the product name and the version of the hardware interface. host address 0x110001 snmp object id 1.3.6.1.2.1.2.2.1.2 size up to 60 characters. type displaystring attributes read-only default value ?cobranet? implemented version 2.1.0 name iftype description the type of interface, distinguished according to the physical/link protocol (s) immediately `below' the network layer in the protocol stack. reference rfc 1213 for all type identifiers host address 0x11000a snmp object id 1.3.6.1.2.1.2.2.1.3 type integer attributes read-only default value 7 implemented version 2.1.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 41 name ifmtu description 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 net work datagrams, this is the size of the largest network datagram that can be sent on the interface. host address 0x11000b snmp object id 1.3.6.1.2.1.2.2.1.4 type integer attributes read-only default value 1500 implemented version 2.1.0 name ifspeed description an estimate of the interface's current bandwidth in bits per second or mbits per second (see notes below). for interfaces which do not vary in bandwidth or for those where no accurate estimation can be made, this object should c ontain the nominal bandwidth. host address 0x11000c snmp object id 1.3.6.1.2.1.2.2.1.5 type integer attributes read-only default value 100 implemented version 2.1.0, corrected is 2.6.5 (see notes below) notes prior to cobranet firmware version 2.6.5, ifspeed was incorrectly reported via snnp in mbit/second units (100mbit interface ifspeed reported as ?100?). 2.6.5 correctly reports ifspeed in bits per second units via snmp but due to space constraints, ifspeed is still reported in mbit per second units via hmi on 24-bit platforms. if speed is reported consistently in bits per second units on 32-bit platforms. name ifphysaddress description the interface's address at the prot ocol layer immediately `below' th e network layer in the protocol stack. host address 0x11000d snmp object id 1.3.6.1.2.1.2.2.1.6 type physaddress attributes read-only default value n.a. implemented version 2.1.0
42 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name ifadminstatus description 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) host address 0x111000 snmp object id 1.3.6.1.2.1.2.2.1.7 type integer attributes read/write default value 1 implemented version 2.1.0 name ifoperstatus description the current operational state of the interface. the testing(3) state indicates that no operational packets can be passed. up(1) - ready to pass packets down(0) host address 0x112000 snmp object id 1.3.6.1.2.1.2.2.1.8 type integer attributes read-only default value 1 implemented version 2.1.0 name iflastchange description the value of sysuptime at the time the interface entered its current operational state. if the current state was entered prior to the last re- initialization of the local network management subsystem, then this object contains a zero value. host address 0x112001 snmp object id 1.3.6.1.2.1.2.2.1.9 type timeticks attributes read-only default value n.a. implemented version 2.1.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 43 name ifinoctets description the total number of octets received on the interface, including framing characters. host address 0x112016 snmp object id 1.3.6.1.2.1.2.2.1.10 type counter48 attributes read-only default value 0 implemented version 2.1.0 name ifinucastpkts description the number of subnetwork-unicast packets delivered to a higher-layer protocol. host address 0x112018 snmp object id 1.3.6.1.2.1.2.2.1.11 type counter attributes read-only default value 0 implemented version 2.1.0 name ifinnucastpkts description the number of non-unicast (i.e., subnetwork- br oadcast or subnetwork-multicast) packets delivered to a higher-layer protocol. host address 0x112019 snmp object id 1.3.6.1.2.1.2.2.1.12 type counter attributes read-only default value 0 implemented version 2.1.0
44 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name ifindiscards description the number of inbound packets which were c hosen to be discarded even though no errors had been detected to prevent their delivery to a higher-l ayer protocol. one possibl e reason for discarding such a packet could be lack of buffer space. host address 0x11201a snmp object id 1.3.6.1.2.1.2.2.1.13 type counter attributes read-only default value 0 implemented version 2.1.0 name ifinerrors description the number of inbound packets that contained errors preventing delivery to a higher-layer protocol. host address 0x11201b snmp object id 1.3.6.1.2.1.2.2.1.14 type counter attributes read-only default value 0 implemented version 2.1.0 name ifinunknownprotos description the number of packets received which were di scarded due to an unknown or unsupported protocol. host address 0x11201c snmp object id 1.3.6.1.2.1.2.2.1.15 type counter attributes read-only default value 0 implemented version 2.1.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 45 name ifoutoctets description the total number of octets transmitted by the interface, including framing characters. host address 0x11201d - 0x11201e snmp object id 1.3.6.1.2.1.2.2.1.16 type counter48 attributes read-only default value 0 implemented version 2.1.0 name ifoutucastpkts description the total number of packets that higher-level protocols requested be transmitted to a subnetwork- unicast address, including those that were discarded or not sent. host address 0x11201f snmp object id 1.3.6.1.2.1.2.2.1.17 type counter attributes read-only default value 0 implemented version 2.1.0 name ifoutnucastpkts description the total number of packets that higher-level protocols requested be transmitted to a non- unicast (i.e., a subnetwork-broadcast or s ubnetwork-multicast) address, includ ing those that were discarded or not sent. host address 0x112020 snmp object id 1.3.6.1.2.1.2.2.1.18 type counter attributes read-only default value 0 implemented version 2.1.0
46 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name ifoutdiscards description the number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their transmission. one pos sible reason for discarding such a packet could be to free up buffer space. host address 0x112021 snmp object id 1.3.6.1.2.1.2.2.1.19 type counter attributes read-only default value 0 implemented version 2.1.0 name ifouterrors description the number of outbound packets that could not be transmitted due to errors. host address 0x112022 snmp object id 1.3.6.1.2.1.2.2.1.20 type counter attributes read-only default value 0 implemented version 2.1.0 name ifoutqlen description the length of the output packet queue (in packets) host address 0x112023 snmp object id 1.3.6.1.2.1.2.2.1.21 type integer attributes read-only default value n.a. implemented version 2.6.1
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 47 name ifspecific description a reference to mib definitions specific to the parti cular 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. if th is information is not present, its value should be set to the object identifier { 0 0 }, which is a syntactically valid object identifier, and any conformant implementation of asn.1 and ber must be able to generate and recognize this value. host address 0x112024 snmp object id 1.3.6.1.2.1.2.2.1.22 size 2 type oid attributes read-only default value 0.0 implemented version 2.6.1
48 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 7.3.3 address translation the address translations are deprecated. these variables are no longer available via snmp. name atifindex description the interface on which this entry's equivalence is effective. the interface identified by a particular value of this index is the same interface as identified by the same value of ifindex . host address 0x120000 snmp object id not available via snmp type integer attributes read-only default value 1 implemented version 2.1.0 name atphysaddress description mac address of the device. use of ifphysaddress is preferred for determining the mac address. host address 0x120001 snmp object id not available via snmp type physaddress attributes read-only default value as assigned by manufacturer implemented version 2.1.0 name atnetaddress description ip address of the device. obtaining the ip addre ss via snmp should not be a necessary operation - you need to know the ip address in order to send the query. via hmi, the ip address may be monitored and manipulated via the ip monitor variables. host address 0x120004 snmp object id not available via snmp type ipaddress attributes read-only default value as assigned by rarp, bootp or ip monitor variables. implemented version 2.1.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 49 7.3.4 ip name ipforwarding description 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). host address 0x130000 snmp object id 1.3.6.1.2.1.4.1 type integer attributes read/write default value always reads 2 implemented version 2.6.0 name ipdefaultttl description the default value inserted into the time-to-live fi eld of the ip header of datagrams originated at this entity when a ttl value is not s upplied by the transport layer protocol. host address 0x130001 snmp object id 1.3.6.1.2.1.4.2 type integer attributes read/write default value 128 implemented version 2.6.0 name ipinreceives description the total number of input datagrams received, including those received in error. host address 0x131000 snmp object id 1.3.6.1.2.1.4.3 type counter attributes read-only default value 0 implemented version 2.6.0
50 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name ipinhdrerrors description the number of input datagrams discarded due to errors in their ip headers, including bad checksums, version number mismat ch, other format errors, time-to- live exceeded, errors discovered in processing their ip options, etc. host address 0x131001 snmp object id 1.3.6.1.2.1.4.4 type counter attributes read-only default value 0 implemented version 2.6.0 name ipinaddrerrors description the number of input datagrams discarded becaus e the ip address in the ip header's destination field was not a valid address to be received at this entity. this count includes invalid addresses (e.g., 0.0.0.0) and addresses of unsupported classes (e.g ., class e). for entities which are not ip gateways and therefore do not forward datagrams, this counter includes datagrams discarded because the destination address was not a local address. host address 0x131002 snmp object id 1.3.6.1.2.1.4.5 type counter attributes read-only default value 0 implemented version 2.6.0 name ipforwdatagrams description the number of input datagrams for which this entity was not the final ip destination, as a result of which an attempt was made to find a route to forward them to the final destination. in entities which do not act as ip gateways, this counter will include onl y those packets which were source-routed via this entity, and the source- route option processing was successful. host address not available snmp object id 1.3.6.1.2.1.4.6 type counter attributes read-only default value 0 implemented version 2.6.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 51 name ipinunknownprotos description the number of locally-addressed datagrams re ceived successfully but discarded because of an unknown or unsupported protocol. host address 0x131003 snmp object id 1.3.6.1.2.1.4.7 type counter attributes read-only default value 0 implemented version 2.6.0 name ipindiscards description the number of ip datagrams received successfully bu t which were discarded (e.g., for lack of buffer space). note that this counter does not include datagrams discar ded while awaiting re-assembly. host address 0x131004 snmp object id 1.3.6.1.2.1.4.8 type counter attributes read-only default value 0 implemented version 2.6.0 name ipindelivers description the total number of input datagrams successfully delivered to ip user-protocols (including icmp) host address 0x131005 snmp object id 1.3.6.1.2.1.4.9 type counter attributes read-only default value 0 implemented version 2.6.0
52 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name ipoutrequests description the total number of ip datagrams which local ip user-protocols (including icmp) supplied to ip in requests for transmission. note that th is does not include datagrams counted in ipforwdatagrams . host address 0x131006 snmp object id 1.3.6.1.2.1.4.10 type counter attributes read-only default value 0 implemented version 2.6.0 name ipoutdiscards description the number of ip datagrams for which no problem existed to prevent their transmission, but which were discarded (e.g., for lack of buffer space). note that this counter would include datagrams counted in ipforwdatagrams if any such packets met this (discretionary) di scard criterion. host address not available snmp object id 1.3.6.1.2.1.4.11 type counter attributes read-only default value 0 implemented version 2.6.0 name ipoutnoroutes description the number of ip datagrams di scarded because no route could be f ound to transmit them to their destination. note that this counter includes packets counted in ipforwdatagrams which meet this `no-route' criterion. this includes any datagra ms which cannot route because all of its default gateways are down. host address not available snmp object id 1.3.6.1.2.1.4.12 type counter attributes read-only default value 0 implemented version 2.6.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 53 name ipreasmtimeout description the maximum number of seconds which receiv ed fragments are held while they are awaiting reassembly. host address not available snmp object id 1.3.6.1.2.1.4.13 type integer attributes read-only default value 0 implemented version 2.6.0 name ipreasmreqds description the number of ip fragments received which needed to be reassembled. host address 0x131007 snmp object id 1.3.6.1.2.1.4.14 type counter attributes read-only default value 0 implemented version 2.6.0 name ipreasmoks description the number of ip datagrams successfully re-assembled. host address not available snmp object id 1.3.6.1.2.1.4.15 type counter attributes read-only default value 0 implemented version 2.6.0
54 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name ipreasmfails description the number of failures detected by the ip re- assembly algorithm (for whatever reason: timed out, errors, etc). note that this is not necessarily a count of discarded ip fragments since some algorithms (notably the algorithm in rfc 815) c an lose track of the number of fragments by combining them as they are received. this val ue will always increment on receipt of a fragmented packet as cobranet does not support packet re-assembly host address 0x131007 (same as ipreasmreqds) snmp object id 1.3.6.1.2.1.4.16 type counter attributes read-only default value 0 implemented version 2.6.0 name ipfragoks description the number of ip datagrams that have been successfully fragmented at this entity. the cobranet interface does not support fragmentation. this variable will always read 0. host address not available snmp object id 1.3.6.1.2.1.4.17 type counter attributes read-only default value 0 implemented version 2.6.0 name ipfragfails description the number of ip datagrams that have been discarded because they needed to be fragmented at this entity but could not be, e.g., because their don't fragment flag was set. the cobranet interface does not support fragmentation. this variable will always read 0. host address not available snmp object id 1.3.6.1.2.1.4.18 type counter attributes read-only default value 0 implemented version 2.6.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 55 name ipfragcreates description the number of ip datagram fragments that have been generated as a result of fragmentation at this entity. the cobranet interface does not support fr agmentation. this variable will always read 0. host address not available snmp object id 1.3.6.1.2.1.4.19 type counter attributes read-only default value 0 implemented version 2.6.0 name iproutingdiscards description the number of routing entries which were chosen to be discarded even though they are valid. one possible reason for discarding such an entry could be to free-up bu ffer space for other routing entries. the cobranet interface does not support routing. this variable will always read 0. host address not available snmp object id 1.3.6.1.2.1.4.23 type counter attributes read-only default value 0 implemented version 2.6.0
56 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 7.3.5 udp name udpindatagrams description the total number of udp datagrams delivered to udp users. host address 0x140000 snmp object id 1.3.6.1.2.1.7.1 type counter attributes read-only default value 0 implemented version 2.6.0 name udpnoports description the total number of received udp datagrams for which there was no applicat ion at the destination port. host address 0x140001 snmp object id 1.3.6.1.2.1.7.2 type counter attributes read-only default value 0 implemented version 2.6.0 name udpinerrors description the number of received udp datagrams that could not be delivered for reasons other than lack of an application at the destination port. host address 0x140002 snmp object id 1.3.6.1.2.1.7.3 type counter attributes read-only default value 0 implemented version 2.6.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 57 name udpoutdatagrams description the total number of udp datagrams sent from this entity. host address 0x140003 snmp object id 1.3.6.1.2.1.7.4 type counter attributes read-only default value 0 implemented version 2.6.0 name udplocaladdress description 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. host address n.a. snmp object id n.a. type ipaddress attributes read-only default value n.a. implemented version not supported name udplocalport description the local port number for this udp listener. host address n.a. snmp object id n.a. type integer16 attributes read-only default value n.a. implemented version not supported
58 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 7.3.6 snmp name snmpinpkts description the total number of snmp messages received from the transport service host address 0x150000 snmp object id 1.3.6.1.2.1.11.1 type counter attributes read-only default value 0 implemented version 2.6.0 name snmpoutpkts description the total number of snmp messages passed to the transport service. host address 0x150001 snmp object id 1.3.6.1.2.1.11.2 type counter attributes read-only default value 0 implemented version 2.6.0 name snmpinbadversions description the total number of snmp messages received which were for an unsupported snmp version. host address 0x150002 snmp object id 1.3.6.1.2.1.11.3 type counter attributes read-only default value 0 implemented version 2.6.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 59 name snmpinbadcommunitynames description the total number of snmp messages received which used an unknown community name. host address 0x150003 snmp object id 1.3.6.1.2.1.11.4 type counter attributes read-only default value 0 implemented version 2.6.0 name snmpinbadcommunityuses description the total number of snmp messages received for which an operation was not allowed by the snmp community named in the message. host address 0x150004 snmp object id 1.3.6.1.2.1.11.5 type counter attributes read-only default value 0 implemented version 2.6.0 name snmpinasnparseerrs description the total number of asn.1 or ber errors encountered when decoding received snmp messages. host address 0x150005 snmp object id 1.3.6.1.2.1.11.6 type counter attributes read-only default value 0 implemented version 2.6.0
60 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name snmpintoobigs description the total number of snmp pdus received for which the value of the error-status field was `toobig'. host address not available snmp object id 1.3.6.1.2.1.11.8 type counter attributes read-only default value always reads 0 implemented version 2.6.0 name snmpinnosuchnames description the total number of snmp pdus received for which the value of the error-status field was `nosuchname'. host address not available snmp object id 1.3.6.1.2.1.11.9 type counter attributes read-only default value always reads 0 implemented version 2.6.0 name snmpinbadvalues description the total number of snmp pdus received for which the value of the error-status field was `badvalue'. host address not available snmp object id 1.3.6.1.2.1.11.10 type counter attributes read-only default value always reads 0 implemented version 2.6.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 61 name snmpinreadonlys description the total number of valid snmp pdus received for which the value of the error-status field was `readonly'. note that it is a protocol error to generate an snmp pdu which contains the value `readonly' in the error-status fi eld. this object is provided as a means of detecting incorrect implementations of snmp. host address not available snmp object id 1.3.6.1.2.1.11.11 type counter attributes read-only default value always reads 0 implemented version 2.6.0 name snmpingenerrs description the total number of snmp pdus received for whic h the value of the error-status field was `generr'. host address not available snmp object id 1.3.6.1.2.1.11.12 type counter attributes read-only default value always reads 0 implemented version 2.6.0 name snmpintotalreqvars description the total number of mib objects which have been re trieved successfully as a result of receiving valid snmp get-request and get-next pdus. host address 0x150006 snmp object id 1.3.6.1.2.1.11.13 type counter attributes read-only default value 0 implemented version 2.6.0
62 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name snmpintotalsetvars description the total number of mib objects which have been alte red successfully as a result of receiving valid snmp set-request pdus. host address 0x150007 snmp object id 1.3.6.1.2.1.11.14 type counter attributes read-only default value 0 implemented version 2.6.0 name snmpingetrequests description the total number of snmp get-request pdus which have been accepted and processed. host address 0x150008 snmp object id 1.3.6.1.2.1.11.15 type counter attributes read-only default value 0 implemented version 2.6.0 name snmpingetnexts description the total number of snmp get-next pdus which have been accepted and processed. host address 0x150009 snmp object id 1.3.6.1.2.1.11.16 type counter attributes read-only default value 0 implemented version 2.6.3
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 63 name snmpinsetrequests description the total number of snmp set-request p dus which have been accepted and processed. host address 0x15000a snmp object id 1.3.6.1.2.1.11.17 type counter attributes read-only default value 0 implemented version 2.6.3 name snmpingetresponses description the total number of snmp get-response pdus which have been accepted and processed. host address not available snmp object id 1.3.6.1.2.1.11.18 type counter attributes read-only default value always reads 0 implemented version 2.6.3 name snmpintraps description the total number of snmp trap pdus which have been accepted and processed. host address not available snmp object id 1.3.6.1.2.1.11.19 type counter attributes read-only default value always reads 0 implemented version 2.6.3
64 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name snmpouttoobigs description the total number of snmp pdus generated for which the value of the error-status field was `toobig.' host address 0x15000b snmp object id 1.3.6.1.2.1.11.20 type counter attributes read-only default value 0 implemented version 2.6.3 name snmpoutnosuchnames description the total number of snmp pdus generated for which the value of the error-status was `nosuchname'. host address 0x15000c snmp object id 1.3.6.1.2.1.11.21 type counter attributes read-only default value 0 implemented version 2.6.3 name snmpoutbadvalues description the total number of snmp pdus generated for which the value of the error-status field was `badvalue'. host address 0x15000d snmp object id 1.3.6.1.2.1.11.22 type counter attributes read-only default value 0 implemented version 2.6.3
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 65 name snmpoutgenerrs description the total number of snmp pdus generated for which the value of the error-status field was `generr'. host address 0x15000e snmp object id 1.3.6.1.2.1.11.24 type counter attributes read-only default value 0 implemented version 2.6.3 name snmpoutgetrequests description the total number of snmp get-request pdus generated. host address not available snmp object id 1.3.6.1.2.1.11.25 type counter attributes read-only default value always reads 0 implemented version 2.6.3 name snmpoutgetnexts description the total number of snmp get-next pdus generated. host address not available snmp object id 1.3.6.1.2.1.11.26 type counter attributes read-only default value always reads 0 implemented version 2.6.3
66 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name snmpoutsetrequests description the total number of snmp set-request pdus generated. host address not available snmp object id 1.3.6.1.2.1.11.27 type counter attributes read-only default value always reads 0 implemented version 2.6.3 name snmpoutgetresponses description the total number of snmp get-response pdus generated. host address 0x150001 (same as snmpoutpackets ) snmp object id 1.3.6.1.2.1.11.28 type counter attributes read-only default value 0 implemented version 2.6.3 name snmpouttraps description the total number of snmp trap pdus generated. host address not available snmp object id 1.3.6.1.2.1.11.29 type counter attributes read-only default value always reads 0 implemented version 2.6.3
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 67 name snmpenableauthentraps description indicates whether the snmp agent process is permitted to generate authentication-failure traps. the value of this object overrides any configurati on information. it provides a means to disable all authentication-failure traps. host address 0x15000f snmp object id 1.3.6.1.2.1.11.30 type integer attributes read-only default value always reads 2 implemented version 2.6.0 name snmpsilentdrops description the total number of getrequest-pdus, getnextrequest-pdus, getbulkrequest-pdus, setrequest-pdus, and informrequest-pdus received which were silently dropped because the size of a reply containing an alternate response- pdu with an empty variable-bindings field was greater than either a local constraint or the maxi mum message size associated with the originator of the request. host address not available snmp object id 1.3.6.1.2.1.11.31 type counter attributes read-only default value always reads 0 implemented version 2.6.3 name snmpproxydrops description the total number of getrequest-pdus, getnextrequest-pdus, getbulkrequest-pdus, setrequest-pdus, and informrequest-pdus received which were silently dropped because the transmission of the (possibly translated) message to a proxy target failed in a manner (other than a time-out) such that no response-pdu could be returned. host address not available snmp object id 1.3.6.1.2.1.11.32 type counter attributes read-only default value always reads 0 implemented version 2.6.3
68 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 7.4 cobranet variables 7.4.1 firmware name firmwareprotocolversion description highest cobranet protocol version supported by firmware. current prot ocol version is 2. a protocol version of 0 indicates an unsuppor ted test version of firmware. host address 0x0 snmp object id 1.3.6.1.4.1.2680.1.1.1.1 type integer attributes read-only implemented version 2.1.0 name firmwaremajorversion description cobranet firmware major revision number. host address 0x1 snmp object id 1.3.6.1.4.1.2680.1.1.1.2 type integer attributes read-only implemented version 2.1.0 name firmwareminorversion description cobranet firmware minor revision number. host address 0x2 snmp object id 1.3.6.1.4.1.2680.1.1.1.3 type integer attributes read-only implemented version 2.1.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 69 name firmwarebootversion description configuration record revision number. the confi guration record contains the mac address for the interface and other permanent initialization parameters. host address 0x3 snmp object id 1.3.6.1.4.1.2680.1.1.1.4 type integer attributes read-only implemented version 2.1.0 name firmwaremfgid description identifies the manufacturer of the cobranet device. 0 represents unknown. host address 0x4 snmp object id 1.3.6.1.4.1.2680.1.1.1.5 type integer attributes read-only implemented version 2.1.0 name firmwaremfgproductid description identifies product type per manufacturer. product ident ifiers are unique per manufacturer identifier. 0 represents unknown product. host address 0x5 snmp object id 1.3.6.1.4.1.2680.1.1.1.6 type integer attributes read-only implemented version 2.1.0
70 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name firmwaremfgversion description a manufacturer assigned minor revision number for firmware. a non-zero value indicates manufacturer has made some modification to the standard firmware as released by cirrus logic. host address 0x6 snmp object id 1.3.6.1.4.1.2680.1.1.1.7 type integer attributes read-only implemented version 2.1.0 name firmwarerestart description reboots the interface when set to a non-zero value. invoking this function will cause loss of communications. the interface will attempt to send a response to an snmp set request before restarting. due to the nature of snmp, receipt of such a response by the manager is not guaranteed. invoking this feature via hmi will cause the hmi to become inoperable until the interface has completed re-initialization. a succ essful restart can be verified by reading the sysuptime variable. sysuptime returns to 0 following a restart. a restart via snmp may adversely affect an hmi co nnected host processor. care should be taken to insure that a host processor attempting to comm unicate via hmi during rese t can recover from the hmi?s failure to respond and, further, that the ho st processor will continue to function properly following reinitialization of the mi variab les to their default or persistent values. host address 0x100 snmp object id 1.3.6.1.4.1.2680.1.1.1.8 type integer attributes read/write default value 0 implemented version 2.6.3. not implemented on cs18xx-based platforms.
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 71 7.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 determin e the capabilities. with the introduction of the CM-1 rev f, these variables no longer fu lly characterize the interface. CM-1 rev f features a memory speed increase and thus a capacity improvement over CM-1 rev e and previous revisions. name firmwarehardwareplatform description cobranet interface hardware platform. 1 - rave 2 - reference design 3 - high capacity reference design 4 - CM-1 with amd flash memory (alternate supplier) 5 - CM-1 with micron flash memory (standard supplier) 18100 - cs18100 18101 - cs18101 18102 - cs18102 18110 - cs18110 18111 - cs18111 18112 - cs18112 host address 0x7 snmp object id 1.3.6.1.4.1.2680.1.1.1.9 type integer attributes read-only implemented version 2.9.10, 2.10.5 name firmwarehardwareversion description version number specific to platform. 1 - reported for all rave and reference design hardw are as these platforms lack hardware version identification feature: CM-1 rev a-c (95mhz) and cs18101 rev 1 (prototypes). 2 - CM-1 rev c-e (100 mhz-capable) and cs181xx rev 2 3 - CM-1 rev f (1 ws-capable) host address 0x8 snmp object id 1.3.6.1.4.1.2680.1.1.1.10 type integer attributes read-only implemented version 2.9.10, 2.10.5
72 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 7.4.3 flash name flashtotalsize description total flash memory size in bytes. host address 0x1000 snmp object id 1.3.6.1.4.1.2680.1.1.2.1 type integer attributes read-only implemented version 2.1.0 name flashsectorsize description largest flash sector size in bytes. sector size is visible via tftp where eac h sector is presented as a system file. some flash memories have sectors t hat vary in size and it is not safe to use this variable to determine sector size. the safe way to determine sector size is to read each sector via tftp. the amount of data returned will indicate the sector size. host address 0x1001 snmp object id 1.3.6.1.4.1.2680.1.1.2.2 type integer attributes read-only implemented version 2.1.0 name flashpersistsequence description sequence number for persistence storage. this give s an approximate indication of the wear on the flash memory from persistent stores. the sequenc e number is incremented each time a sector is erased to make room for a persistent store. typi cally two sectors are used for persistent storage. the sequence number divided by the number of se ctors used for persistence yields the approximate erase cycle count each sector ha s experienced. flash memory is typically rated for no less than 100,000 erase cycles. host address 0x1002 snmp object id 1.3.6.1.4.1.2680.1.1.2.3 type counter attributes read-only implemented version 2.8.1
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 73 name flashpersisttype description indicates the type identifier for the persistent stor e dataset. if firmware is updated to a version that uses a different dataset type (or different size), persistent sett ings will be lost. host address 0x1003 snmp object id 1.3.6.1.4.1.2680.1.1.2.4 type integer attributes read-only implemented version 2.8.1 name flashpersistsize description size in words of the persistent store dataset. if firm ware is updated to a version that uses a different dataset size (or different type), persistent settings will be lost. host address 0x1004 snmp object id 1.3.6.1.4.1.2680.1.1.2.5 type integer attributes read-only implemented version 2.8.1 name flashpersiststores description the number of times variables have been written to flash during sysuptime . use of flashpersistack is preferred to determine completi on of a persistent save operation. host address 0x1005 snmp object id 1.3.6.1.4.1.2680.1.1.2.6 type counter attributes read-only default value 0 implemented version 2.8.1
74 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name flashtacknowledge description a semaphore variable updated to the value of flashtrequest on completion of a flash write. host address 0x1006 snmp object identifier not available via snmp type integer attributes read-only implemented version 2.8.6 name flashpersistenable description non-zero value enables variable persistence feature. read/write - persistent type variables will be automatically written to non-volatile memory when changed. values will be restored on power-up. host address 0x1100 snmp object id 1.3.6.1.4.1.2680.1.1.2.7 type integer attributes read/write - persistent default value 0 implemented version 2.8.1 name flashpersistack description forces a write of variables to non-volatile memory when set to a non-zero value. value returns to zero when write has completed. this value will not change if persistence is disabled. this feature is recommended for use during factory configuration wh ere writing and confirmation of success must be done in a timely manner. in normal use it is best to let the interface schedule writes to non- volatile memory. over-use of this feature can result in excessive wear on the flash device. host address 0x1200 snmp object id 1.3.6.1.4.1.2680.1.1.2.8 type integer attributes read/write default value 0 implemented version 2.8.1
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 75 name flashtrequest description when changed, causes data transfer to begin between flash memory and bridgetxpktbuffer . transfer begins when set to a value different than flashtacknowledge. host address 0x1201 snmp object identifier not available via snmp type integer attributes read/write implemented version 2.8.6 name flashtaddress description specifies the source (read) or des tination (write) address in flash memory. this address is a byte offset into flash memory. for an erase operations th is variable can be set to any address within the sector to be erased. follow ing read and write operations flashtaddress is incremented by flashtlength ( flashtaddress += flashtlength ) host address 0x1202 snmp object identifier not available via snmp type integer attributes read/write implemented version 2.8.6 name flashtlength description specifies the number of bytes to be transferred be tween flash and transmit bu ffer. this value should never exceed the byte size of bridgetxpktbuffer . a flash operation is not allowed to straddle a sector boundary. this variable is ignored for erase operations. host address 0x1203 snmp object identifier not available via snmp type integer attributes read/write implemented version 2.8.6
76 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name flashtdirection description 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 host address 0x1204 snmp object identifier not available via snmp type integer attributes read/write implemented version 2.8.6
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 77 7.4.4 errors name errorpostresults description power on self-test results. 0 - no errors detected. currently the cobranet interface does not recover from a post failure. this variable will always r eport 0. a post failure is reported by the indicator led?s. a self-reset will be atte mpted following the error report. host address 0x2000 snmp object id 1.3.6.1.4.1.2680.1.1.3.1 type integer attributes read-only default value 0 implemented version 2.1.0 name errorindicators description this value is a sum of exclusive binary values which can be or?d to represent multiple errors. 0x01 - fault 0x04 - receive error 0x08 - transmit error 0x10000 - audio mute (audio output may be corrupt) 0x20000 - buddylink output disabled (fault or lost contact with the network) 0x40000 - unexpected system error (d iagnostic information on firmware fault may be available in errordisplay ) host address 0x2001 snmp object id 1.3.6.1.4.1.2680.1.1.3.2 type integer attributes read-only implemented version 2.1.0 name errorcode description last error code reported. on 24-bit platforms, error code is a byte in ms byte position of this variable. on 32-bit platforms, error code is a byte in ls byte position of this variable. some values are warnings and will not affect errorindicators . see error table. note: this variable has also been referred to as errorlast in older documentation and mib files. host address 0x2002 snmp object id 1.3.6.1.4.1.2680.1.1.3.3 type integer attributes read-only default value 0 implemented version 2.1.0
78 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name errorcount description number of errors reported during sysuptime . some errors are warnings and do not affect errorindicators . host address 0x2003 snmp object id 1.3.6.1.4.1.2680.1.1.3.4 type counter attributes read-only default value 0 implemented version 2.1.0 name errordisplay description error code to display on a user interface. error codes are displayed for se rious and unexpected error conditions. a value of 0 indicates th ere is no error code to display. host address 0x2004 snmp object id 1.3.6.1.4.1.2680.1.1.3.5 type integer attributes read-only default value 0 implemented version 2.1.0 name moderatestatus description indicates the latency and sample rate operating mode currently in effect for the interface. moderatestatus and moderatecontrol will differ if an unsupported mode value is written to moderatecontrol host address 0x2005 snmp object id 1.3.6.1.4.1.2680.1.1.3.6.2 type integer attributes read-only implemented version 2.9.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 79 name moderatecontrol description selects latency and sample rate mode for the interface. the following modes are supported: 0x701 - 5-1/3 ms latency, 96-khz sample rate 0x600 - 5-1/3 ms latency, 48-khz sample rate 0x601 - 2-2/3 ms latency, 96-khz sample rate 0x500 - 2-2/3 ms latency, 48-khz sample rate 0x501 - 1-1/3 ms latency, 96-khz sample rate 0x400 - 1-1/3 ms latency, 48-khz sample rate host address 0x2100 snmp object id 1.3.6.1.4.1.2680.1.1.3.6.1 type integer attributes read/write - persistent default value 0x600 implemented version 2.9.0
80 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 7.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 conductorcyclerate description number of isochronous cyc les per second as a 16.16 fixed point number. this is a legacy variable. it always reports default value and should not be changed. host address 0x10000 snmp object id 1.3.6.1.4.1.2680.1.1.4.1 type integer48 attributes read/write - persistent default value 750 implemented version 2.2.0 name conductorpriority description specifies the conductor priority for a cobranet de vice. the device with the highest priority will become the conductor for the network. ms byte must be 0. 0 - never conduct 0x1 - lowest conductor priority 0xff - highest conductor priority host address 0x10002 snmp object id 1.3.6.1.4.1.2680.1.1.4.2 type integer16 attributes read/write - persistent default value 0x20 for reference design, 0x30 for CM-1 and cs181xx. implemented version 2.2.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 81 name conductorgaps description 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. in most cases the def ault value works well. useful values other than the default are dependant on the specific network topology used. channel gap in ls byte - larger channel gaps allow greater network diameter. packet gap in ms byte - larger packet g aps increase resilience to unregulated traffic. host address 0x10003 snmp object id 1.3.6.1.4.1.2680.1.1.4.3 type integer16 attributes read/write - persistent default value 0x0306 implemented version 2.2.0 name conductorstatus description conductor status: 0 - this interface is not the conductor 1 - this interface is the conductor host address 0x11000 snmp object id 1.3.6.1.4.1.2680.1.1.4.4 type integer attributes read-only implemented version 2.1.0
82 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 7.4.6 packet bridge name bridgetxpkt description variable is used in conjunction with bridgetxdone . if bridgetxpkt and bridgetxdone are equal, then it is permitted to write new packet data to bridgetxpktbuffer . setting bridgetxpkt different than bridgetxdone will cause the contents of the packet buffer to be transmitted. upon transmit completion, bridgetxdone will be updated to match bridgetxpkt . packet transmission can also be initiated by issuing a packet transmit command via hmi. host address 0x20000 snmp object id not available via snmp type integer attributes read/write default value 0 implemented version 2.2.0 name bridgerxpkt description this variable is used in conjunction with bridgerxready . if values of bridgerxpkt and bridgerxready differ, then bridgerxpktbuffer contains received data and may be read by the host. setting bridgerxpkt equal to bridgerxready will release the buffer to the cobranet interface so that the next packet can be received. host address 0x20001 snmp object id not available via snmp type integer attributes read/write default value 0 implemented version 2.2.0 name bridgemmac description specifies the source multicast mac address of packets to be received via the packet bridge. to receive multicast addressed packets, it is necessary to compute and load a multicast hash filter table into bridgehashbuffer . host address 0x20002 - 0x20004 snmp object id not available via snmp type physaddress attributes read/write default value 00:00:00:00:00:00 implemented version 2.2.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 83 name bridgecalcmmachash description 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. when complete, bridgemmachashdone will be updated with the value written here and bridgemachashbuf will contain the new hash value. folding bridgemachashbuf resuls into bridgehashbuf will then allow receipt of packets fr om the multicast address specified in bridgemmac . host address 0x20005 snmp object id not available via snmp type integer attributes read/write default value 0 implemented version 2.2.0 name bridgemmachashbuffer description this is the calculated hash value for the mac address entered in bridgemmac. host address 0x20006 - 0x20009 snmp object id not available via snmp size 4 words type octet string attributes read/write default value 0 implemented version 2.2.0 name bridgehashbuffer description this is the value loaded to the hash table of the ethernet controller which determines the range of multicast addresses the host will receive. host address 0x2000a - 0x2000d snmp object id not available via snmp size 4 words type octet string attributes read/write default value 0 implemented version 2.2.0
84 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name bridgerxfilter description 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 14 . 0x1 - bridge unprocessed cobranet packets 0x2 1 - bridge all cobranet reservation packets 0x8 1 - bridge all ip packets (ip, arp and rarp) 0x10 - bridge all packets with unknown protocol identifier 1 copies of packets are passed to the packet bri dge and the originals are st ill processed by the cobranet interface. care must be taken that redundant replies are not generated. host address 0x2000e snmp object id not available via snmp type integer attributes read/write default value 1 implemented version 2.6.9 name bridgetxpktbuffer description buffer for bridge packet transmission. the first wo rd contains the length of the packet in bytes exclusive of the length field itself. ethernet packet data, including complete header and payload, follows the length. the fcs field is computed and appended by the ethernet controller and is not included as part of the packet data or length. see section 2.2 "packet bridge" on page 12 for more information on the format and use of this buffer host address 0x21000 snmp object id not available via snmp count 758 on 24-bit platforms, 380 on 32-bit platforms. type integer16 attributes read/write implemented version 2.2.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 85 name bridgerxpktbuffer description buffer to read received packet. the data format for packet data is the same as used in bridgetxpktbuffer . host address 0x22000 snmp object id not available via snmp count 1 + actual packet size in words. type integer16 attributes read/write implemented version 2.2.0 name bridgetxdone description please refer to bridgetxpkt documentation. this variable is used in conjunction with bridgetxpkt . host address 0x23000 snmp object id not available via snmp type integer attributes read-only default value 0 implemented version 2.2.0 name bridgerxready description please refer to bridgerxpkt documentation. this variable is used in conjunction with bridgerxpkt . host address 0x23001 snmp object id not available via snmp type integer attributes read-only default value 0 implemented version 2.2.0
86 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name bridgemmachashdone description refer to bridgecalcmmachash documentation. this variable is used in conjunction with bridgecalcmmachash . host address 0x23002 snmp object id not available via snmp type integer attributes read-only default value 0 implemented version 2.2.0 name bridgerxdropped description counts the number of received packet bridge packets dropped due to the receive buffer being unavailable. packets which could be received vi a the packet bridge will be dropped if the host has ownership of the receive buffer ( bridgerxpktbuffer ). host address 0x23003 snmp object id not available via snmp type counter attributes read-only default value 0 implemented version 2.5.7
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 87 7.4.7 serial bridge name serialformat description this variable is used to enable or disable the seri al communications interface (a.k.a sci or serial bridge) and to set the data format for both transmit and receive directions. format may only be changed while the sci is disabled (ls bit = 0). it is recommended to set serialformat to 0, wait at least 100ms then set serialformat to the desired value with the enable bit set. the sci can take up to 100ms to recognize a change.this procedure insures that the change is recognized and the port is properly configured. the follow ing values may be or?d together: 0x01 - enable serial bridging. txd pin is tri-stated when disabled. 0x02 - use nine-bit data format. the 9th data bit is bridged over the ethernet along with the standard 8 data bits. 9 bit format is appropriate for the following standard serial data formats: n,9,1 e,8,1 o,8,1 m,8,1 s,8,1 n,7,2. the 8 bit data format supports the following standard serial data formats: n,8,1 e,7,1 o,7,1 m,7,1 s,7,1. if the 8th or 9th bit is used as a parity bit, it is simply bridged across the network and must be generated and/or ch ecked by the device connected to the bridge interface. cs181 xx-based h ardware does not support 9-bit format; this bit is ignored. 0x04 - use sci_sclk to control transmit enable for multi-drop (rs485) operation. sci_sclk is an active high signal; transmitter shoul d be enabled when sci_sclk is high. cs181xx firmware does not currently support tri-state control format; this bit is ignored. 0x08 - enable local loopback. this feature is intended primarily for factory test. sci bridging must also be enabled for loopback to operate. when loopback is enabled, received characters are directed to the sci transmitter instead of to the network. serialrxmac should be set to 00:00:00:00:00:00 to avoid transmitter contention when loopback is enabled. 0x10 - accept properly unicast addressed data in addition to data addressed in accordance to serialrxmac setting. host address 0x24000 snmp object id 1.3.6.1.4.1.2680.1.1.10.1.1 type integer attributes read/write - persistent default value 0 implemented version 2.4.7. available via snmp in 2.6.4. acc ept unicast (0x10 bit) implemented in 2.8.8. name serialbaud description baud rate for transmission and reception. the baud rate is specified in bits per second. the minimum baud rate is 600 baud. maximum baud rate is 57,600. cs181xx-based interfaces will support baud rates up to 115,200 host address 0x24001 snmp object id 1.3.6.1.4.1.2680.1.1.10.1.2 type integer attributes read/write - persistent default value 19200 implemented version 2.4.7 (available via snmp in 2.6.4)
88 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name serialpperiod description 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 late ncy are appropriate for real time connections such as midi. with higher settings more characters ca n be packed into a packet before it is transmitted resulting in increased effici ency. higher settings are re commended for bulk data transfer applications. the isochronous cycle period (1-1 /3 ms) determines the minimum serialpperiod . setting serialpperiod below the isochronous cycle rate does not further improve responsiveness. the upper limit of responsiveness can also affected by control channel accessi bility and pipeline delays. the depth of the receive sci character queue in combination with the baud rate determines the maximum allowed setting. the character buffer can accommodate 100 characte rs. this allows for operation at the default 10ms period at a baud rate of 57,600. at this baud rate, larger settings will result in buffer overflow and loss of data. host address 0x24002 snmp object id 1.3.6.1.4.1.2680.1.1.10.1.3 type integer attributes read/write - persistent default value 2560 (10ms) implemented version 2.4.7 (available via snmp in 2.6.4) name serialrxmac description mac address of the cobranet interface from wh ich sci data will be accepted. this may be any multicast address though 01:60:2b:fd:00:00 through 01:60:2b:fd:ff:ff have been reserved by cirrus logic for use as "a synchronous global channels." ifphysaddress is the only usable unicast address (cobranet does not support ethernet promiscuous mode). host address 0x24003 snmp object id 1.3.6.1.4.1.2680.1.1.10.1.4 type physaddress attributes read/write - persistent default value 01:60:2b:fd:00:00 implemented version 2.4.7 (available via snmp in 2.6.4)
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 89 name serialtxpriority description serial bridging bundle priority in ms byte. hi gher priority bundles are transmitted earlier in the isochronous cycle and are thus le ss susceptible to dropouts in the event network bandwidth is exhausted. request priority in ls byte. content ion for transmission on a bundle is resolved via request priority. this variable has no effect when serialtxbundle is 0. the reference design, CM-1,cm-2 and cs181 xx-based d esigns do not support isochronous transmission of serial data and ignore setti ngs for serialtxbundle and serialtxpriority. host address 0x24006 snmp object id 1.3.6.1.4.1.2680.1.1.10.1.5 type integer16 attributes read/write - persistent default value 0x0110 implemented version 2.4.7 (available via snmp in 2.6.4) name serialtxbundle description on legacy repeater ethernet networks and cobranet in terface hardware, serialtxbundle is used to specify a bundle number for use in transmitting se rial data reliably over cobranet's isochronous audio transport service. specifyi ng bundle 0 causes serial data to be delivered normally via the asynchronous transport. this is the default and recommended setting. the reference design, CM-1,cm-2 and cs181 xx-based d esigns do not support isochronous transmission of serial data and ignore setti ngs for serialtxbundle and serialtxpriority. host address 0x24007 snmp object id 1.3.6.1.4.1.2680.1.1.10.1.6 type integer16 attributes read/write - persistent default value 0 implemented version 2.4.7 (available via snmp in 2.6.4) name serialtxmac description mac address of the cobranet interface to which seri al data is sent. may be any multicast or unicast address. host address 0x24100 snmp object id 1.3.6.1.4.1.2680.1.1.10.1.7 type physaddress attributes read/write - persistent default value 01:60:2b:fd:00:00 implemented version 2.4.7 (available via snmp in 2.6.4)
90 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 7.4.8 interrupt control name hackenable description enable conditions for asserting hack. hack is de-asserted by issuing an interrupt acknowledge hmi command. the following values may be or?ed together 0x4 - activate hack on bridge packet receipt (change in bridgerxready ). 0x8 - activate hack on bridge packet transmission complete (change in bridgetxdone ). 0x10 - activate hack on hmi address translation completion (change in hacktranslations ). 0x20 - activate hack on mi variable change via snmp (change in mimonsnmpdirty or hacksnmpmodify ). 0x40 - enable hack timer. host address 0x25000 snmp object id not available via snmp type integer attributes read/write default value 0 implemented version 2.10.4 name hacktimerinterval description a mask defining which bits of the network time should be locked to generate a hack timer interrupt. the hacktimerinterval variable will be limited to powe rs of 2, in units of isochronous cycle intervals. the isochronous cycle interval is 1-1/3 ms. the correct mask value will be a power of 2 minus one. for example, a value of 0xffff will generate an interrupt every 256*1-1/3 = 341.33 ms. host address 0x25001 snmp object id not available via snmp type integer attributes read/write default value 0xffffffff implemented version 2.10.4
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 91 name hackstatus description indicates the source of a hack assertion requi ring acknowledge. the following values may be or?d together. undocumented bits should be ignored: 0x01 - a new receive packet is available in the receive buffer. host should read packet data from receive buffer and then acknowledge receipt. 0x02 - no transmission in progress. host may write transmit packet data into the transmit buffer. on 32-bit platforms, these bits may also be read in the hmi status register received packet available and packet transmission complete . host address 0x25100 snmp object id not available via snmp type integer attributes read-only implemented version 2.8.5 name hacktranslations description incremented when a translate address command completes. on 32-bit platforms, this information is also available through the translation complete bit in the hmi status register. host address 0x25101 snmp object id not available via snmp type counter attributes read-only implemented version 2.8.5 name hacksnmpmodify description copy of mimonsnmpdirty . host address 0x25102 snmp object id not available via snmp type counter attributes read-only implemented version 2.8.5
92 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name hackreadlength description size of readable area in words for the last address traslation. 0 if read permi ssion is denied (invalid address). this variable is updated upon completion of a translate address operation. on 32-bit platforms, this information is also available through the region length field in the status register. host address 0x25103 snmp object id not available via snmp type integer attributes read-only implemented version 2.8.5 name hackwritelength description size of writable area in words for the last address traslation. 0 if write permission is denied (invalid address or read only region). this variable is updated upon completion of a translate address operation. on 32-bit platforms, this information is also available through the region length field in the status register. host address 0x25104 snmp object id not available via snmp type integer attributes read-only implemented version 2.8.5 name hackntime description cobranet network time - a copy of syncntime . cs181xx only. host address 0x25105 snmp object id not available via snmp type integer attributes read-only implemented version 2.9.9, 2.10.4
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 93 7.4.9 audio name audiometerdropouts description this counter is incremented each isochronous cycl e that metering is not performed. metering may be skipped when processor cycles ar e in high demand on the interface. host address 0x30000 snmp object id 1.3.6.1.4.1.2680.1.1.5.1 type counter attributes read-only default value 0 implemented version 2.2.0 name audioallowedchannels description number of audio channels this cobranet interface is licensed to handle. audioallowedchannels < audiorxchannels + audiotxchannels indicates a licensing violation. there are no license fees on cs181 xx-based i nterfaces. channel accounting is not implemented. on cs181x x , audioallowedchannels, audiorxchannels and audiotxchannels always read 0. host address 0x30001 snmp object id 1.3.6.1.4.1.2680.1.1.5.6 type integer attributes read-only default value read from flash configuration record. implemented version 2.8.3. name audiorxchannels description number of unique audio channels currently being received from the network. on cs181 xx-based i nterfaces this variable always reads 0 . host address 0x30002 snmp object id 1.3.6.1.4.1.2680.1.1.5.7 type integer attributes read-only default value 0 implemented version 2.8.3.
94 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name audiotxchannels description number of unique audio channels currently being transmitted to the network. on cs181 x x this variable always reads 0. host address 0x30003 snmp object id 1.3.6.1.4.1.2680.1.1.5.8 type integer attributes read-only default value 0 implemented version 2.8.3. name audiometerdecay description decay time constant for audiometers . meters have an instantaneous attack time that cannot be adjusted. this constant can be computed from the desired decay time (t) as: 24-bit platforms : 0x800000 ((1-tan(1/(1500 t)))/(1+tan(1/(1500*t)))) 32-bit platforms: 0x80000000 ((1-tan(1/(1500 t)))/(1+tan(1/(1500*t)))) for reasonably large decay times (>50m s) this can be approximated as: 24-bit platforms : 0x800000 (((1500 t)-1)/((1500 t)+1)) 32-bit platforms: 0x800000 00 (((1500 t)-1)/((1500 t)+1)) example decay settings: 0 - instantaneous 8170671 (0x7cacaf) 24-bit, 2091691776 (0x7cacaf00) 32-bit - 50ms 8333053 (0x7f26fd) 24-bit, 2133261568 (0x7f26fd00) 32-bit - 200ms 8377430 (0x7fd456) 24-bit, 2144622080 (0x7fd45600) 32-bit - 1 second 8388235 (0x7ffe86) 24-bit, 2147388160 (0x7ffe8600) 32-bit - 30 seconds host address 0x30100 snmp object id 1.3.6.1.4.1.2680.1.1.5.5 type integer attributes read/write - persistent default value 0 implemented version 2.6.9
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 95 name audiometermap description maps audio routing channels to audio metering. meters 0-31 are designated for metering audio inputs. meters 32-63 are designated for metering outputs. the first unassigned (null or unconnected routing channel) in each section terminates meter pr ocessing. it is not possible to activate meter 3 without first activating meter 2, for instance. host address 0x31000 snmp object id 1.3.6.1.4.1.2680.1.1.5.2.1.2 count 64 type integer attributes read/write - persistent default value 0 implemented version 2.2.0 name audiometerpeaks description the peak level is the highest level recorded since the last time the meters were reset. level is represented as a 24- of 32-bit posit ive value. 0 indicating the absence of signal and 0x7fffff or 0x7fffffff indicating a full-scale signal. reset is accomplished by writ ing 0 to the peak level. it is not possible to determined if a peak level is missed between the time the variable is read and when it is cleared. also it should be recognised that it is possible for another manager to clear this variable. there is no way of determining when this has happened. host address 0x32000 snmp object id 1.3.6.1.4.1.2680.1.1.5.2.1.3 count 64 type integer attributes read/write default value 0 implemented version 2.1.0
96 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name audiometers description 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). level is reported as a 24- or 32-bit positive value. 0 indicates the complete absence of signal and 0x7ffff f or 0x7ffffffff indicates a full-scale signal. host address 0x33000 snmp object id 1.3.6.1.4.1.2680.1.1.5.2.1.4 count 64 type integer attributes read-only implemented version 2.1.0 name audiometerpeakraw description efficiently retrieve allaudiometerpeaks values in a single get operation. on 24-bit platforms, audiometerpeakraw and audiometerraw values ar e packed in 3 octet words. on cs181xx-based platforms the values are packed in 4 octet words. byte ordering for 24-bit platforms is ms, middle, ls. byte ordering for 32-bit platforms is ms, middle high, middle low, ls. host address 0x32000 snmp object id 1.3.6.1.4.1.2680.1.1.5.2.1.5 count 64 type integer attributes read/write default value 0 implemented version 2.10.4
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 97 name audiometerraw description efficiently retrieve allaudiometers values in a single get operation. on 24-bit platforms, audiometerpeakraw and audiometerraw values ar e packed in 3 octet words. on cs181xx-based platforms the values are packed in 4 octet words. byte ordering for 24-bit platforms is ms, middle, ls. byte ordering for 32-bit platforms is ms, middle high, middle low, ls. host address 0x32000 snmp object id 1.3.6.1.4.1.2680.1.1.5.2.1.6 count 64 type integer attributes read/write default value 0 implemented version 2.10.4 name audioloopsrc description describes source audio routing channels for per forming a local audio loopback function. the first unassigned (null or unconnected routing channel) l oopback entry terminates loopback processing. it is not possible to activate loopback element 3 without first activating loopback 2, for instance. host address 0x34000 snmp object id 1.3.6.1.4.1.2680.1.1.5.3.1.2 count 8 in standard firmware build. type integer attributes read/write - persistent default value 0 implemented version 2.1.0
98 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name audioloopdst description describes destination audio routi ng channels for performing a local audio loopback function. see audioloopsrc for a complete description. host address 0x35000 snmp object id 1.3.6.1.4.1.2680.1.1.5.3.1.3 count 8 in standard firmware build type integer attributes read/write - persistent default value 0 implemented version 2.1.0 name audiooutputs description list of audio output routing channels. audio output data must be cleared to silence if data is not received over the network for the channels. by default 33 - 64 are used as outputs but these variables may be configured by the manufacturer according to the audio i/o configuration of the hardware. the user should not change these values . host address 0x36000 snmp object id 1.3.6.1.4.1.2680.1.1.5.4.1.2 count 32 type integer attributes read/write - persistent default value {33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64} implemented version 2.1.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 99 name audiomap description audio routing channel to synchr onous 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. these variables are configured by the manufacturer according to the audio i/o configuration of the hardware. cirrus logic c an assist manufacturers in determining proper configuration of these variable s to match audio i/o hardware. the user should not change these values . host address 0x37000 snmp object id 1.3.6.1.4.1.2680.1.1.5.2.1.5 count 64 type integer attributes read/write - persistent default value product specific implemented version 2.1.0 name audiodupsrc description a vector used to specify the source audio rout ing channels used in audio channel duplication. each audiodupsrc vector member will have a corr esponding audiodupdst member corresponding to each available duplication channel. audiodupsrc wi ll contain the source audio routing channel number and audiodupdst will contain the corr esponding destination audio routing channel. the audio routing channel chosen as ei ther a source or destination must be an output channel (i.e. appear in audiooutputs which, by default, consists of audio r outing channels 33-64). the first unassigned entry (null or unc onnected routing channel for either sour ce or destination) terminates dup processing. for instance, it is not possible to specify dup channel 3 wi thout first specifying dup channel 2. host address 0x38000 snmp object id 1.3.6.1.4.1.2680.1.1.5.9.1.2 count 0 in standard CM-1 firmware, 8 in cs181xx firmware. type integer attributes read/write implemented version 2.8.5
100 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name audiodupdst description a vector used to specify the source audio rout ing channels used in audio channel duplication. see audiodupsrc. host address 0x39000 snmp object id 1.3.6.1.4.1.2680.1.1.5.9.1.3 count 0 in standard CM-1 firmware, 8 in cs181xx firmware. type integer attributes read/write implemented version 2.8.5 name audiometerpeaksraw description efficiently retrieve all audiometerpeaks values in a single get operation. 24-bit platforms: values are packed in 3 octet words. by te ordering is most significant, middle, least significant. 32-bit platforms: values are packed in 4 octet words. by te ordering is most significant, middle high, middle low, least significant. host address not available via hmi snmp object id 1.3.6.1.4.1.2680.1.1.5.10 type octet string attributes read-only implemented version 2.9.3, 2.10.5 name audiometersraw description efficiently retrieve all audiometers values in a single get operation. 24-bit platforms: values are packed in 3 octet words. by te ordering is most significant, middle, least significant. 32-bit platforms: values are packed in 4 octet words. by te ordering is most significant, middle high, middle low, least significant. host address not available via hmi snmp object id 1.3.6.1.4.1.2680.1.1.5.11 type octet string attributes read-only implemented version 2.9.3, 2.10.5
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 101 name audiossiformat description 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 0x30004 snmp object id 1.3.6.1.4.1.2680.1.1.5.12 type integer attributes read-only implemented version 2.9.10, 2.10.5
102 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 7.4.10 receivers name rxstatus description indicates bundle reception. bundle reception does not neces sarily indicate audio reception. consult rxsubformat variables for audio reception status. 0 - bundle is not being received 1 - bundle is being received host address 0x4n000 (n is 0 based receiver number) snmp object id 1.3.6.1.4.1.2680.1.1.6.1.1.6.n (n is 1 based receiver number) type integer attributes read-only implemented version 2.1.0 name rxdropouts description counts number of times bundle reception has been interrupted. interruptions can be caused by transmitter failure or by reconfiguring the receiv er. this variable is implemented by counting transitions to 0 of rxstatus . host address 0x4n001 (n is 0 based receiver number) snmp object id 1.3.6.1.4.1.2680.1.1.6.1.1.7.n (n is 1 based receiver number) type counter attributes read-only default value 0 implemented version 2.1.0 name rxdelay description indicates additional group delay imposed on the re ceived audio due to network forwarding delays. delay is expressed in units of audio transmissio n 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). forwarding delay is continuously monitored by the receiver. if forwarding delay changes due to a network reconfiguration or change in rxbundle, the receiver delay will adapt to the new conditions. a discontinuity in the audio stream will be experienced whenever the receiver delay is adjusted in this manner. normal propagation delay is 4 isoc hronous cycle periods. this normal condition is indicated by a 0 reading in rxdelay . a reading of 1 indicates an additional is ochronous cycle period delay (for a total of 5 cycles) has been inserted due to network forwarding delay. host address 0x4n002 (n is 0 based receiver number) snmp object id 1.3.6.1.4.1.2680.1.1.6.1.1.8.n (n is 1 based receiver number) type integer16 attributes read-only implemented version 2.6.3
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 103 name rxmindelay description selects a minimum additional delay imposed on the rece ived 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). this variab le is designed to allow configuration of a deterministic common delay for all cobranet in terfaces in larger network installations. rxdelay will never be reduced below this setting. this variable is not designed for actively delaying audio for architectural applications . the maximum setting for rxmindelay is determined by the amount of ethernet packet buffering available on the inte rface. excessive settings will result in error_rxbuffer_overflow errors and accompanying audio dropouts. host address 0x4n106 (n is 0 based receiver number) snmp object id 1.3.6.1.4.1.2680.1.1.6.1.1.9.n (n is 1 based receiver number) type integer16 attributes read/write - persistent default value 0 implemented version 2.8.3 name rxsubformat description vector of received audio format for each sub-channel. see table 6 on page 26 for a complete listing of valid format values. the least significant bit of these variables is se t when the received format is supported for reception by the cobranet interface. a test of this leas t significant bit can be used to determine correct reception on a per audio channel basis. all entries in this vector will be 0 if rxstatus is zero. host address 0x4n30m (n is 0 based receiver num ber, m is 0 based audio channel number) count 8 snmp object id 1.3.6.1.4.1.2680.1.1.6.2.1.3.n.m (n is 1 based re ceiver number, m is the 1 based sub-channel number) type integer attributes read-only implemented version 2.2.0
104 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name rxbundle description receive bundle assignment. host address 0x4n100 (n is 0 based receiver number) snmp object id 1.3.6.1.4.1.2680.1.1.6.1.1.2.n (n is 1 based receiver number) type integer16 attributes read/write - persistent default value 0 implemented version 2.1.0 name rxsourcemac description source mac address for private channel reception. must be set to 00:00:00:00:00:00 for public and broadcast channel reception. host address 0x4n101 - 0x4n103 (n is 0 based receiver number) snmp object id 1.3.6.1.4.1.2680.1.1.6.1.1.3.n (n is 1 based receiver number) type physaddress attributes read/write - persistent default value 00:00:00:00:00:00 implemented version 2.1.0 name rxpriority description suggested channel priority in ms byte. transmi tter may use this suggestion when submitting forward reservations. request priority in ls byte. if a transmitter is able to service a limited number of receivers due to txunicastmode selection, the request priority det ermines which receivers are serviced. host address 0x4n104 (n is 0 based receiver number) snmp object id 1.3.6.1.4.1.2680.1.1.6.1.1.4.n (n is 1 based receiver number) type integer16 attributes read/write - persistent default value 0x1010 implemented version 2.4.8
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 105 name rxbuddyexclude description controls buddylink operation for this receiver: 0 - reverse reservations for this receiver are suspended when buddylink signal is detected. i.e. the interface will not be able to receive audio bundles when buddylink signal is detected. 1 - reverse reservations are never suspended. also see syncbuddylinkcontrol. host address 0x4n105 (n is 0 based receiver number) snmp object id 1.3.6.1.4.1.2680.1.1.6.1.1.5.n (n is 1 based receiver number) type integer attributes read/write - persistent default value 0 implemented version 2.5.0 name rxsubmap description audio routing channel destinations for each audio channel in a received bundle. host address 0x4n20m (n is 0 based receiver num ber, m is 0 based audio channel number) count 8 snmp object id 1.3.6.1.4.1.2680.1.1.6.2.1.2.n.m (n is 1 based receiver number, m is the 1 based audio channel number) type integer attributes read/write - persistent default value first receiver {33, 34, 35, 36, 37, 38, 39, 40} second receiver {41, 42, 43, 44, 45, 46, 47, 48} third receiver {49, 50, 51, 52, 53, 54, 55, 56} fourth receiver {57, 58, 59, 60, 61, 62, 63, 64} implemented version 2.1.0
106 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 7.4.11 transmitters name txdropouts description count of times channel transmission has been interrup ted. interruptions can be caused by loss of transmit permission from cond uctor or by changes to txbundle . implemented by counting transitions to 0 of txposition . host address 0x5n000 (n is 0 based transmitter number) snmp object id 1.3.6.1.4.1.2680.1.1.7.1.1.7.n (n is 1 based transmitter number) type counter attributes read-only default value 0 implemented version 2.1.0 name txposition description transmission permission position. 0 indicates no tr ansmission either because the conductor has not granted permission (due to bandwidth c onstraints or bundle conflict) or txbundle is set to 0. valid values are 0 through the number of bundles acti ve on the network. a value of 1 indicates the transmitter has the highest priority on the network and will be the last to be dropped if bandwidth is exhausted. host address 0x5n001 (n is 0 based transmitter number) snmp object id 1.3.6.1.4.1.2680.1.1.7.1.1.8.n (n is 1 based transmitter number) type integer attributes read-only default value 0 implemented version 2.1.0 name txreceivers description number of receivers requesting this bundle. this may not be valid for multicast bundles as receivers of multicast bundles are not requi red to issue a reverse reservation although all receivers currently do. a transmitter will track no more than 4 receivers. txreceivers will never exceed 4. host address 0x5n002 (n is 0 based transmitter number) snmp object id 1.3.6.1.4.1.2680.1.1.7.1.1.9.n (n is 1 based transmitter number) type integer attributes read-only implemented version 2.5.7
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 107 name txbundle description transmit bundle assignment. host address 0x5n100 (n is 0 based transmitter number) snmp object id 1.3.6.1.4.1.2680.1.1.7.1.1.2.n (n is 1 based transmitter number) type integer16 attributes read/write - persistent default value 0 implemented version 2.1.0 name txdestinationmac description this variable is unused and should not be changed from its default value. host address 0x5n101 (n is 0 based transmitter number) snmp object id 1.3.6.1.4.1.2680.1.1.7.1.1.3.n (n is 1 based transmitter number) type physaddress attributes read/write - persistent default value 00:00:00:00:00:00 implemented version 2.2.0 name txpriority description this is a two part variable used to set the prefer red time within an isochronous cycle that a bundle is sent and also the priority this bundle should be give n in the event that more than one interface is attempting to transmit using the same bundle number. ms byte: bundle priority. higher priority bundles are transmitte d earlier in the cycle. this can be reflected in txposition . on a repeater network, and to some extent on a switched network, bundles transmitted earlier may be less susceptible to dropouts in the event network bandwidth is exhausted. ls byte: request priority. only one transmitter is permitted per bundle. if two transmitters attempt to transmit using the same bundle number, request priority is used to resolve the contention. if request priority is the same for both transmitters , contention resolution is first-come-first-serve. host address 0x5n104 (n is 0 based transmitter number) snmp object id 1.3.6.1.4.1.2680.1.1.7.1.1.4.n (n is 1 based transmitter number) type integer16 attributes read/write - persistent default value 0x1010 implemented version 2.2.0
108 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name txsubcount description number of audio channels to transmit in a bundl e. valid values are 0 through 8. reducing txsubcount is the preferred means for transmitting b undles with less than the maximum 8 audio channels. short bundles may also be transmitted by setting txsubformat or txsubmap entries to 0. host address 0x5n105 (n is 0 based transmitter number) snmp object id 1.3.6.1.4.1.2680.1.1.7.1.1.5.n (n is 1 based transmitter number) type integer attributes read/write - persistent default value 8 implemented version 2.1.0 name txbuddyexclude description control buddylink operation on this channel: 0 - transmission suspended when buddy link signal is detected. 1 - transmission is never suspended. also see syncbuddylinkcontrol host address 0x5n106 (n is 0 based transmitter number) snmp object id 1.3.6.1.4.1.2680.1.1.7.1.1.6.n (n is 1 based transmitter number) type integer attributes read/write - persistent default value 0 implemented version 2.5.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 109 name txunicastmode description specifies the number of unicast destinations serv ed before automatically switching to multicast bundle transmission. multicast transmission is usef ul for efficient point to multipoint routing. however, multicast addressing consumes bandwidth on all ports on a switched network. this variable allows control of multicast traffic from transmitters. 0 - multicast addressing used at all times. note : multicast bundles do not transmit data until a receiver is assigned to the same bundle number. 1 - unicast addressing used to single receiver. mu lticast addressing used for multiple receivers. 0x7fffff - multicast addressing is never used. maximum number of unicast destinations is set by txmaxunicast . receiver request priority is used to determ ine which receivers are serviced if multiple receivers are assigned to this bundle. host address 0x5n107 (n is 0 based transmitter number) snmp object id 1.3.6.1.4.1.2680.1.1.7.1.1.10.n (n is 1 based transmitter number) type integer attributes read/write - persistent default value 0x7fffff implemented version 2.6.3 name txmaxunicast description specifies maximum number of unicast destinati ons supported simultaneously by the transmitter. receivers in excess of this setting will not receive the bundle. a transmitter can service up to 4 receivers. the nu mber of unicast destinations transmitted to will never exceed this internal capacity limitation. if txunicastmode is set lower than txmaxunicast , the bundle will switch to multicast before the limitation on unicast destinations is reached. host address 0x5n108 (n is 0 based transmitter number) snmp object id 1.3.6.1.4.1.2680.1.1.7.1.1.11.n (n is 1 based transmitter number) type integer attributes read/write - persistent default value 1 implemented version 2.8.3
110 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name txsubmap description transmit audio channel (channel within bundle) to audio routing channel (channel of ssi) mapping. this vector contains the routi ng channel source specifiers per a udio channel in the transmitted bundle. host address 0x5n20m (n is 0 based transmitter number , m is 0 based sub-channel number) count 8 snmp object id 1.3.6.1.4.1.2680.1.1.7.2.1.2.n .m (n is 1 bas ed transmitter number, m is 1 based audio channel) type integer attributes read/write - persistent default value first transmitter {1, 2, 3, 4, 5, 6, 7, 8} second transmitter {9, 10, 11, 12, 13, 14, 15, 16} third transmitter {17, 18, 19, 20, 21, 22, 23, 24} fourth transmitter {25, 26, 27, 28, 29, 30, 31, 32} implemented version 2.1.0 name txsubformat description specifies data format for each sub-channel in the transmitted bundle. please see table 6 on page 26 for a complete list of valid format values. moderatecontrol must also be set correctly to support the configured format. host address 0x5n30m - 0x5n30m (n is 0 based transmitter number, m is 0 based sub-channel number) count 8 snmp object id 1.3.6.1.4.1.2680.1.1.7.2.1.3.n .m (n is 1 bas ed transmitter number, m is 1 based sub-channel number) type integer attributes read/write - persistent default value 0x54000 implemented version 2.2.0
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 111 7.4.12 synchronization name syncconductorclock description selects sample clock source when acting as network conductor. 0x0 - internal mode. see section 3.4.1 "internal" on page 17 0x1 - external word clock mode. see section 3.4.3 "external word clock" on page 17 0x4 - external master clock mode. section 3.4.4 "external master clock" on page 17 0x10 - internal with external sample synchronization mode. see section 3.4.2 "internal with external sample synchronization" on page 17 0x14 - external master clock with exte rnal sample synchronization mode. see section 3.4.5 "external master clock with exter nal sample synchronization" on page 18 reference design only: add 0x40 to the clock selection value fo r hardware utilizing an external clock selection multiplexor. host address 0x60000 snmp object id 1.3.6.1.4.1.2680.1.1.8.1 type integer attributes read/write - persistent default value 0 implemented version 2.2.1 name syncperformerclock description selects sample clock source when acting as a performer. values are the same as documented above for syncconductorclock . external clocks applied must be externally synchronized to the conductor. host address 0x60001 snmp object id 1.3.6.1.4.1.2680.1.1.8.2 type integer attributes read/write - persistent default value 0 implemented version 2.2.1
112 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name syncclocktrim description allows fine control of clock rate when acting as a network conductor in internal synchronization mode (syncconductorclock = 0x00). range of control is on the order +/-37ppm a trim value of 0xffffff is sufficient for most applications. 0xffffff - normal 0x800000 - minimum frequency 0x7fffff - maximum frequency for rave only: 0x500000 - normal 0x7fffff - minimum frequency 0 - maximum frequency host address 0x60002 snmp object id 1.3.6.1.4.1.2680.1.1.8.3 type integer attributes read/write - persistent default value read from flash configuration record. implemented version 2.2.1 name syncbuddylinkcontrol description buddylink allows two cobranet interfaces to op erate as a redundant pair with fail-over capability. the buddylink signal must be synthesized in hardware by anding together the fs1 clock and mute signals from the primary interface. presen ce of this gated clock signal at the refclk_in input of the secondary unit indicates proper op eration of the primary unit. mute is asserted (dropped) when a fault is detected by the primary, which then gates off the clock signal to the secondary. as long as the buddylink signal is detected by the secondary unit, it will send empty reservation requests preventing the unit from trans mitting and, in most cases, receiving audio. when absence of the clock is detected, the seco ndary will begin transmitting valid reservation packets, thus allowing it to process bundles. an idle secondary unit may still receive multicast bundles. the following values may be or?d together: 0x2 - disable reference clock input. this master disable feature should be invoked on designs where the reference clock input is not connected. disabling the refe rence clock input prevents noise from interfering with operation of the interface. 0x4 - enable buddylink. presence of a clock at re fclk_in will disable network transmitters and receivers. 0x8 - force buddy link presence. a pplicable in secondary buddylink in terfaces to simulate failure of a primary buddylink partner. enable buddylink bit is overridden. host address 0x60003 snmp object id 1.3.6.1.4.1.2680.1.1.8.4 type integer attributes read/write - persistent default value 2 implemented version 2.4.7
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 113 name syncstatus description indicates current audio clock sync hronization status. the following values may be ored together: unspecified bits should be ignored. 0x01 - locked to external or network clock reference. 0x02 - valid clock present at refclk_in. 0x04 - mute is not asserted. indicates proper oper ation of cobranet interface as mute is asserted on detection of a fault conditi on or loss of connection to the network. host address 0x61000 snmp object id 1.3.6.1.4.1.2680.1.1.8.5 type integer attributes read-only default value n.a. implemented version variable implemented 2.5.9. extwrdclkout presence indication added 2.6.4. name synccounter description incremented each time network sync is lost. host address 0x61001 snmp object id 1.3.6.1.4.1.2680.1.1.8.6 type counter attributes read-only default value 0 implemented version 2.6.5 name syncntime description cobranet network time. advances 256 every 1-1/ 3ms. network time rolls over after reaching 0xffff00 (16,776,960) on 24- and 32-bit platforms. host address 0x61002 snmp object id 1.3.6.1.4.1.2680.1.1.8.7 type integer (only lower 24 bits are vali d. upper byte is always zero.) attributes read-only implemented version 2.9.9, 2.10.4
114 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 7.4.13 snmp monitor name snmpwriteenable description 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 host address 0x70000 snmp object id not available via snmp type integer attributes read/write - persistent default value 1 implemented version 2.6.3 name snmprocommunity description the community name the snmp agent requires for reading variables (get and get-next snmp requests). host address 0x70001 snmp object id not available via snmp size 60 characters type displaystring attributes read/write - persistent default value "public" implemented version 2.6.3 name snmprwcommunity description the community name the snmp agent requires for wr iting variables (set snmp requests). reading of variables is also allowed using this community name. host address 0x70017 snmp object id not available via snmp size 60 characters type displaystring attributes read/write - persistent default value "private" implemented version 2.6.3
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 115 7.4.14 mi monitor name mimondirty description incremented when a management interface variable is modified either via snmp or hmi. multiple modifications may result in a single increment of th is counter. the act of writing a variable, even if written with its current value, is considered a modification for the purposes of this counter. host address 0x71000 snmp object id 1.3.6.1.4.1.2680.1.1.9.1.1 type counter attributes read-only default value 0 implemented version 2.6.3 (available via snmp in 2.6.4) name mimonsnmpdirty description incremented if a management interface variable is modified through snmp. the counter is intended to allow detection of variable modification by an y snmp manager. multiple modifications may result in a single increment of this variable. the act of setti ng a variable, even if set to its current value, is considered a modification for the purposes of this counter. host address 0x71001 snmp object id 1.3.6.1.4.1.2680.1.1.9.1.2 type counter attributes read-only default value 0 implemented version 2.6.5 name mimonhmidirty description incremented if a management interface variable is modified through hmi. the counter is intended to allow detection of variable modification by a loca l manager. multiple modifications may result in a single increment of this variable. the act of writing a variable, even if written with its current value, is considered a modification for the purposes of this counter. host address 0x71002 snmp object id 1.3.6.1.4.1.2680.1.1.9.1.3 type counter attributes read-only default value 0 implemented version 2.6.5
116 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference 7.4.15 ip monitor name ipmoncurrentip description 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. a host processor writing to pmoncurrentip via the hmi. receipt of a bootp response packet (typically in response to a transmitted bootp request) receipt of a rarp response packet (rarp requests are not transmitted) host address 0x72000 snmp object id 1.3.6.1.4.1.2680.1.1.9.2.2 type ipaddress attributes read/write default value ipmonstaticip implemented version 2.6.3 name ipmonstaticip description a power-up static ip address assignment for the inte rface. a value of 0.0.0.0 indicates no power-up ip address assignment. host address 0x72002 snmp object id 1.3.6.1.4.1.2680.1.1.9.2.1 type ipaddress attributes read/write - persistent default value 0.0.0.0 implemented version 2.8.2
cobranet programmer?s reference management interface variable reference ds651pm21 ? copyright 2004 cirru s logic, inc. 117 7.4.16 if monitor mi interface for monitoring redundant ether net connection (dual link) feature. these variables are only available on the CM-1, cm-2 and cs181xx-based hardware. name ifmcurrentif description index of the current, active ethernet connection. 1 - primary 2 - secondary on platforms with only one interface, this value will always be one. host address 0x73000 snmp object id 1.3.6.1.4.1.2680.1.1.9.3.1 type integer attributes read only implemented version tbd name ifmlastchange description the value of sysuptime at the time the ifmcurrentif was established. if the current state was entered prior to or concurrent with the last re-initialization of the local network management subsystem, then this value will be zero. on platform s with only one interface, this value will always be zero. host address 0x73001 snmp object id 1.3.6.1.4.1.2680.1.1.9.3.2 type time ticks attributes read only implemented version tbd name ifmswitchmode description controls duallink behavior. this variable applie s only to interfaces which support two ethernet ports. 0 - automatic switchover to secondary on failure of primary. 1 - always use primary port. 2 - always use secondary port. 3 - if one port is woking properly and the other has fail ed, switch to the port that is working properly. if both are working properly or both have failed, do not change ports. on boot, start with the primary port. on platforms with only one interface, a value of ?3? is ignored. host address 0x73100 snmp object id 1.3.6.1.4.1.2680.1.1.9.3.4 type integer attributes read/write implemented version 2.9.9
118 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference management interface variable reference name ifmtstatus description 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. host address 0x74n00 where: n = 0 = primary ethernet interface n = 1 = secondary ethernet interface snmp object id 1.3.6.1.4.1.2680.1.1.9.3.3.1.2.n count 2 type integer attributes read only implemented version 2.9.9 name ifmtlastchange description the value of sysuptime at the time ifmtstatus was established. if the current state was entered prior to or concurrent with the last re-initialization of the loca l network management subsystem, then this object contains a zero value. host address 0x74n01 where: n = 0 = primary ethernet interface n = 1 = secondary ethernet interface snmp object id 1.3.6.1.4.1.2680.1.1.9.3.3.1.3.n count 2 type time ticks attributes read only implemented version 2.9.9
cobranet programmer?s reference recommended user interface practices ds651pm21 ? copyright 2004 cirru s logic, inc. 119 8. recommended user interface practices 8.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 physic ally connected and multiplexed. as audio buffer offsets within the cobranet interface. there is a fixed mapping between the time slot and interface assignments and the audio buffer offsets for each basic cobranet i/o configuration supported. as audio routing channels within the cobranet interface. valid routing channels are in the range 1-64. channel 0 is reserved to indicate an unused channel. the mapping between i/o indices and audio buffer offsets is determined by the audiomap mi variable. as bundle and audio channel assignments. valid bundle numbers are 1-65535. bundle 0 indicates an unused transmitter or receiver. a bundle may carry up to 8 audio channels. routing channels are assigned to bundles through the txsubmap and rxsubmap mi variables. 8.1.1 audio i/o map the audiomap variables may need to be set up by the manufacturer. audio inputs starting from the channel labeled 1 should be assigne d starting at routing channel 1. audio outputs starting from the channel labeled 1 should be assigned starti ng at routing channel 33. the audiomap values may be initialized through firmware customization or the hmi. 8.1.2 bundle assignments it is recommended that all front panel interfaces allow selection of multicast bundles in the range 1-255 and unicast bundles in the range 256-65279. we recommend against allowing private bundle assignments from a front panel user interface since these are conditioned on a 48-bit mac address. private bundle assignments are best left to a central graphical user interface operating via snmp. transmitters ?audio channels are transmitted in groups of up to 8 onto the network via a bundle. it is an advisable policy to pack as many audio channels into a bundle as possible as this improves network efficiency. this d oes strategey does not necessarily limit routing flexibility as complex routing functionality can be readily accomplished at the receiver side. at a minimum, user control of bundl e assignments per network transmitter should be provided. optional user interface control of transmitter functionality may include any combination of the following: audio resolution on a per-audio-channel basis audio source channel mapping per transmitter audio channel number of audio channels to include in bundle transmission bundle and request priority receivers ?the receiver can extract up to 8 audio channels from a bundle. the receiver decodes the data according to the tags attached to the bundle by the transmitter. at a minimum, user control of the bundle assignment per network receivers should be
120 ? copyright 2004 cirrus lo gic, inc. ds651pm21 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 mappi ng per receiver audio channel bundle and request priority 8.2 conductor priority it is not necessary to give users the ability to change conductor priority via a front panel interface. if manipulation of conductor priori ty is desired, allowing three options with regard to conductor priority selection is recommended: never - conductorpriority = 0 normal - conductorpriority = 32 high - conductorpriority = 128 8.3 name users should be able to either select and display or simply display a network name for the device. this network name is stored in the sysname management variable as an ascii string that is 4 to 16 characters in length. a-z, a-z, 0-9 and - [hyphen] are allowed characters. names are not case sensitive. a name may be as simple as 4 numeric characters. a set of thumb wheel switches can be used to provide a unique numerical name. names containing only 0's (zeros) and "noname" are reserved names indicating that no name has been assigned to the unit.
cobranet programmer?s reference error reporting ds651pm21 ? copyright 2004 cirru s logic, inc. 121 9. error reporting 9.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 indi cation. it is possible to determine the exact cause of the most recently reported error conditions by reading the errorcode variable through the management interface. 9.1.1 receive and transmit errors receive and transmit errors illuminate the rx error and/or tx error indicators. these errors are reported with respect to the ethernet interface. an rx error indicates trouble receiving audio or control data from the network. a tx error indicates trouble transmitting audio or control data onto the network. these errors may originate at peripherals attached to the cobranet interface. a framing error detected at the asynchronous serial port is reported as a tx error because an inability to correctly receive asynchronous serial data means that it can't be properly transmitted onto the ethernet. difficulty locking to the conductor clock is reported by simu ltaneous illumination of the rx error and tx error indicators as a failure to lock affects both transmission and reception. 9.1.2 faults illumination of the fault indicator indicates detection of an unexpected condition. some fault conditions will also light the rx error and/ or tx error indicators to give more specific indication if the unexpected condition is in the receive or transmit processes. 9.2 unrecoverable errors 9.2.1 fatal faults a fatal fault halts the cobranet interface. audio and control data delivery is suspended while an error code is displayed as a flashi ng pattern on the fault indicator. once the code has been displayed several times, the interface will automatically attempt to reset itself. the fatal fault code is displayed as a repeat ing set of three flash sequences. these three flash sequences represent three digits of an octal error code. a single flash represents a 0 digit and 8 flashes represent a 7 digit. the three digits are delivered least significant first. convert from octal to decimal and divide by two to get the error code. or the flash sequences may be looked up directly in t he error codes section of this document as an example, a repeating pattern of 5 fl ashes then 2 flashes followed by 3 flashes represents an octal code of 214. converting to decimal and dividing by 2 yields error code 70.
122 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference error reporting 9.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 is automatically attempt to reset itself. typically the same test will fail again resulting in repeated display of the failing error code. table 16. post failure error codes number of fault indicator flashes failed test 1 runtime code checksum error 2 boot code checksum error 3 xilinx configuration load failure 4 error in mac register access 5 data error in phy register access 6 timeout error in phy register access 8 sram error: bank 0 ls byte 9 sram error: bank 0 middle byte 10 sram error: bank 0 ms byte 11 sram error: bank 1 ls byte 12 sram error: bank 1 middle byte 13 sram error: bank 1 ms byte 14 address or data bus data dependent failure 15 ethernet loopback test failure 19 unexpected interrupt occurred 20 unexpected xilinx configuration identification 21 unexpected xilinx configuration version 22 sample clock range test failure 23 sample clock not running
cobranet programmer?s reference error code reference ds651pm21 ? copyright 2004 cirru s logic, inc. 123 10. error code reference 10.1 legend 32-bit code - error code as reported on 32-bit platforms (cs181xx and cm-2) 24-bit code - error code as reported on 24-bit platforms (reference designs and CM-1) 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. name - name assigned to the error by the firmware programmer. description - description of the error condition. expected conditions - foreseeable conditions under which the error condition would occur on normally functioning an d properly connected hardware. unexpected conditions - conditions indicating a hardware of firmware fault. 10.2 error code interpretation 24-bit and 32-bit interfaces present their error codes differently. for 24-bit interfaces (reference design and CM-1) the decimal error code presented will fall within the ranges shown in the 24-bit code column of the error codes table and may be looked up directly. for 32-bit interfaces (cm-2, cs181xx) the byte code must be extracted from the returned value. the same byte code is also valid for 24-bit interfaces but is extracted from the error code differently than for 32-bit interfaces. 10.2.1 extraction of byte code for 32-bit interfaces 1) convert the decimal error code to hexadeci mal. this will yield a 3 or 4 digit value. 2) use the 2 least significant digi ts to look up the code in the byte code column. table 17. error types type description tx recoverable and expected transmit error txquiet informative transmit incident txfault unexpected but recoverable transmit error rx recoverable and expected receive error rxquiet informative receive incident rxfault unexpected but recoverable receive error txrx recoverable and expected error simultaneously affecting transmit and receive fault unexpected but recoverable error fatal unrecoverable error condition. reported as a flash code on the fault indicator.
124 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference error code reference for example:, a returned code of 2133 = 0x855 in hexadecimal. looking up 0x55 hexadecimal (0x55 hex also equals 85 decimal) reveals that an ethernet transmission error occurred where the interface failed to detect a carrier. 10.2.2 optional extraction of by te code for 24-bit interfaces 1) convert the decimal error code to hexadecimal. when displayed, the value may be less than 6 hex digits. any missing l eading digit is implied to equal zero. 2) use the most significant 2 digits, reme mbering that there could be an implied 0. for example: a returned code of 262144 = 0x40000 in hexadecimal. taking the most significant 2 digits = 0x04. the leading 0 is implied as the hexadecim al translation yields only 5 digits. looking up 0x04 (0x04 hex also equals 4 decimal) reveals that the ethernet interface could not be accessed. 10.3 error codes listing byte code 24-bit code flash code type name description expected conditions unexpected conditions 0 0x00 0-65535 1,1,1 none no error no error has been reported. -- 1 0x01 65536-131071 1 post no code no valid runtime code to load from flash memory. no code has ever been loaded in the flash. corrupted flash contents. hardware failure in flash memory or address/data bus. 2 0x02 131072- 196607 2 post boot csum bad boot sector checksum. - corrupted flash contents. hardware failure in flash memory or address/data bus. 3 0x03 196608- 262143 3 post xilinx config xilinx configuration load failure. - hardware problem with xilinx pld or configuration interface. corrupted xilinx configuration file in flash. 4 0x04 262144- 327679 4 post post mac ethernet media access controller (mac) register access failure. - problem with ethernet mac or mac <-> dsp interface.
cobranet programmer?s reference error code reference ds651pm21 ? copyright 2004 cirru s logic, inc. 125 5 0x05 327680- 393215 5 post post phy data ethernet physical interface (phy) register access failure. data read does not match data written. - problem with phy, ethernet mac or mac <-> phy interface (mii). 6 0x06 393216- 458751 6 post post phy timeout phy register access failure. phy did not respond to read or write request. - problem with phy, mac or mac <-> phy interface (mii). 8 0x08 524288- 589823 8 post post b0l main memory failure; low byte, main bank. - memory chip problem. data bus problem. address bus problem. 9 0x09 589824- 655359 9 post post b0m memory failure; middle byte, main bank. - memory chip problem. data bus problem. address bus problem. 10 0x0a 655360- 720895 10 post post b0h memory failure; high byte, main bank. - memory chip problem. data bus problem. address bus problem. 11 0x0b 720896- 786431 11 post post b1l memory failure; low byte, high bank. - memory chip problem. data bus problem. address bus problem. 12 0x0c 786432- 851967 12 post post b1m memory failure; middle byte, high bank. - memory chip problem. data bus problem. address bus problem. 13 0x0d 851968- 917503 13 post post b1h memory failure; high byte, high bank. - memory chip problem. data bus problem. address bus problem. 14 0x0e 917504- 983039 14 post post bus address/data bus test failure during bus stress test. - address and/or data bus performance is marginal. 15 0x0f 983040- 1048575 15 post post loopback ethernet physical interface (phy) loopback test failure. cannot transmit and receive packet correctly. - problem with ethernet controller (mac or phy). problem with ethernet dma (pld). byte code 24-bit code flash code type name description expected conditions unexpected conditions
126 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference error code reference 16 0x10 1048576- 1114111 1,5,1 fault flash failure failure during flash erase or write operation. flash device has fatigued due to excessive write/erase operations. problem with flash device or flash <-> dsp interface. 17 0x11 1114112- 1179647 3,5,1 fault flash write attempt to program flash location before erase. - flash erase failure. 18 0x12 1179648- 1245183 5,5,1 fatal bad config bad configuration record in flash no configuration parameters specified during boot bank programming and an existing configuration record could not be found. the configuration record does not match the main code. either the flash is improperly programmed or there is a problem with the flash bank selection logic or other address decode logic. 19 0x13 1245184- 1310719 7,5,1 fault int unexpected interrupt occurred while interrupts were disabled. - - 20 0x14 1310720- 1376255 1,6,1 fatal xilinx id xilinx does not report expected identification. - problem with xilinx pld. problem with xilinx configuration file in flash. 21 0x15 1376256- 1441791 21 post xilinx version reported xilinx version not supported by boot code. - mismatched files used during code build. 22 0x16 1441792- 1507327 22 post post clock range sample clock pull range test failure. the voltage controlled sample clock crystal oscillator (vcxo) pull range does not meet minimum requirements. - the vcxo device does not meet specification. problem with vcxo control voltage circuitry. 23 0x17 1507328- 1572863 23 post post clock stopped sample clock not running. timeout waiting for measurement edge. - vcxo is not oscillating. problem with fs1 circuitry or pld. byte code 24-bit code flash code type name description expected conditions unexpected conditions
cobranet programmer?s reference error code reference ds651pm21 ? copyright 2004 cirru s logic, inc. 127 24 0x18 1572864- 1638399 1,7,1 fatal unused - - - 26 0x1a 1703936- 1769471 5,7,1 fatal unused - - - 28 0x1c 1835008- 1900543 1,8,1 fatal unused - - - 30 0x1e 1966080- 2031615 5,8,1 fatal unused - - - 32 0x20 2097152- 2162687 1,1,2 txrx cycles dsp processing cycles exhausted. broadcast storm in progress on network. processor running slow. sample clock running fast. dma controller malfunctioning. unable to acknowledge an interrupt. 33 0x21 2162688- 2228223 3,1,2 rx rx storm broadcast storm detected. loop in network producing overwhelming amount of broadcast or multicast network traffic. - 34 0x22 2228224- 2293759 5,1,2 rx 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. 35 0x23 2293760- 2359295 7,1,2 tx bad handle out of range permission handle received in beat packet. - conductor is misbehaving. 36 0x24 2359296- 2424831 1,2,2 tx tx toobig attempt to generate an oversize outgoing packet. too many 24 bit audio channels specified for transmitter. - 37 0x25 2424832- 2490367 3,2,2 fatal intreenter ed unexpected interrupt service routine reentry. - processor running slow. sample clock running fast. byte code 24-bit code flash code type name description expected conditions unexpected conditions
128 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference error code reference 38 0x26 2490368- 2555903 5,2,2 tx etxunexpec ted unexpected ethernet transmit complete interrupt; no transmit in progress. collisions occurring on repeater network. - 39 0x27 2555904- 2621439 7,2,2 txrx lost lock lost lock to network clock. initial synchronizatio n to the network. change of conductor. conductor is attempting to synchronize to bad external reference clock. sample clock crystal of either this unit or the conductor does not meet specification. 40 0x28 2621440- 2686975 1,3,2 rx early packet received an audio packet with eager timestamp. excessive delay variation through the network. - 41 0x29 2686976- 2752511 3,3,2 fault frame assertfail programmer assertion failed in frame.asm - - 42 0x2a 2752512- 2818047 5,3,2 txfault queueput beatdiscar ds packet queue overflow discarding un- transmitted packets. - - 43 0x2b 2818048- 2883583 7,3,2 tx queueget txfree free transmit buffers exhausted. a unit is kept from transmitting because network bandwidth is exhausted. - 44 0x2c 2883584- 2949119 1,4,2 fatal flashreq assertfail programmer assertion failed in flashreq.asm - - 45 0x2d 2949120- 3014655 3,4,2 rx queueput rxcontrol too many control packets received. excessive broadcast control traffic on network. - 46 0x2e 3014656- 3080191 5,4,2 rx queueput rx too much audio data received for a network isochronous channel. - two devices are mistakenly transmitting onto the same bundle. 47 0x2f 3080192- 3145727 7,4,2 rx queueput rxpackets receive packets backlogged. excessive broadcast traffic on network. - byte code 24-bit code flash code type name description expected conditions unexpected conditions
cobranet programmer?s reference error code reference ds651pm21 ? copyright 2004 cirru s logic, inc. 129 48 0x30 3145728- 3211263 1,5,2 tx queueput tx packet queue overflow at bundle transmitter. a unit is kept from transmitting because network bandwidth is exhausted. - 49 0x31 3211264- 3276799 3,5,2 txfault queueput txfree packet queue overflow while freeing a transmit buffer. - freed a buffer twice. 50 0x32 3276800- 3342335 5,5,2 txfault queueput txpackets transmit packets backlogged. - - 51 0x33 3342336- 3407871 7,5,2 fault ipbuf freetwice freed the same ip buffer twice. - - 52 0x34 3407872- 3473407 1,6,2 rx rxbuffer overflow receive buffers exhausted. excessive broadcast traffic on network. setting of rxmindelay is too high. excessive delay variation through network. - 53 0x35 3473408- 3538943 3,6,2 txfault ssirx overrun synchronous serial (ssi) audio data receive overrun. - excessive interrupt latency. 54 0x36 3538944- 3604479 5,6,2 rxfault ssitx underrun synchronous serial (ssi) audio data transmit underrun. - excessive interrupt latency. 55 0x37 3604480- 3670015 7,6,2 fatal extstack over processor external stack overflow. - - 56 0x38 3670016- 3735551 1,7,2 fatal extstack under processor external stack underflow. - - 57 0x39 3735552- 3801087 3,7,2 tx tx chancount unable to transmit all outbound audio packets within an isochronous cycle period. bandwidth is exhausted on a repeater network. - 58 0x3a 3801088- 3866623 5,7,2 txfault queueput order queue overflow preparing packets for transmission. - - byte code 24-bit code flash code type name description expected conditions unexpected conditions
130 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference error code reference 59 0x3b 3866624- 3932159 7,7,2 fatal unused - - - 60 0x3c 3932160- 3997695 1,8,2 txquiet txaudio dropout audio dropout occurred on transmission. conductor revoked permission, channel number changed or turned off by user. a beat packet did not arrive either due to a conductor change or a problem on the network. - 61 0x3d 3997696- 4063231 3,8,2 rxquiet rxaudio dropout audio dropout occurred on reception. conductor revoked permission, channel number changed or turned off by user. audio packet was dropped by the network. - 62 0x3e 4063232- 4128767 5,8,2 txfault txfree twice a transmit buffer was freed twice. - - 63 0x3f 4128768- 4194303 7,8,2 rxfault rxpacket bounds dma reports receiving an packet outside designated receive buffer address range. - dma hardware is misbehaving. 64 0x40 4194304- 4259839 1,1,3 tx queueput scicrx serial bridge can't packetize and transmit characters as fast as they're being received from the serial port. serialpperiod setting too high for selected baud rate. - 65 0x41 4259840- 4325375 3,1,3 fatal ip assertfail programmer assertion failure in ip.asm - - byte code 24-bit code flash code type name description expected conditions unexpected conditions
cobranet programmer?s reference error code reference ds651pm21 ? copyright 2004 cirru s logic, inc. 131 66 0x42 4325376- 4390911 5,1,3 fatal queueput flashreq queue overflow initiating a flash read, write or erase. - a request has been resubmitted before it was completed. flash request queue size needs to be increased due to software expansion. 67 0x43 4390912- 4456447 7,1,3 fatal procstack over processor internal stack overflow. - - 68 0x44 4456448- 4521983 1,2,3 fatal procstack under processor internal stack underflow. - - 69 0x45 4521984- 4587519 3,2,3 tx dup mac duplicate macs detected on network detected during conductor arbitration. mac addresses are supposed to be globally unique. the two (or more) units may not be able to resolve this conflict peacefully. loop in network resulting in broadcast storm and subsequent receipt of own beat packets. - 70 0x46 4587520- 4653055 5,2,3 fatal stack corrupt processor external stack corrupted. - - 71 0x47 4653056- 4718591 7,2,3 fatal unused - - - 72 0x48 4718592- 4784127 1,3,3 fatal txfree corrupt a transmit buffer was modified after being freed. - - 73 0x49 4784128- 4849663 3,3,3 rx queueput scitxc serial bridging received more characters from the network faster than it can transmit them out the serial port. from sci. characters are being received simultaneously over the network from two transmitters. baud rate at transmitter is set higher than at receiver. - byte code 24-bit code flash code type name description expected conditions unexpected conditions
132 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference error code reference 74 0x4a 4849664- 4915199 5,3,3 rxquiet rxidle loss of receive activity detected. there are no longer any other cobranet devices on the network. - 75 0x4b 4915200- 4980735 7,3,3 fatal unused - - - 77 0x4d 5046272- 5111807 3,4,3 fatal illegal inst illegal instruction encountered. - hardware problem with main memory or address/ data busses. 78 0x4e 5111808- 5177343 5,4,3 fatal unused - - - 79 0x4f 5177344- 5242879 7,4,3 rx etherrx overrun could not keep up with ethernet receive data transfer requirements. ethernet receive data transfers deferred by transmissions. problem with ethernet receive dma. 80 0x50 5242880- 5308415 1,5,3 rx etherrx crc corrupted ethernet packet received (crc error). late collisions on an oversized (>200 meter) repeater network. cabling, equipment or electromagneti c interference problem on the network. a cut- through switch may convert collision fragments into packets with bad crc. problem with ethernet controller. 81 0x51 5308416- 5373951 3,5,3 rx etherrx dribble received packet with incomplete last byte. cabling, equipment or electromagneti c interference problem on the network. late collisions on an oversized (>200 meter) repeater network. problem with ethernet controller. 82 0x52 5373952- 5439487 5,5,3 rx etherrx bigpacket received an illegally large packet. equipment problem on the network. - byte code 24-bit code flash code type name description expected conditions unexpected conditions
cobranet programmer?s reference error code reference ds651pm21 ? copyright 2004 cirru s logic, inc. 133 83 0x53 5439488- 5505023 7,5,3 tx ethertx under could not keep up with ethernet transmit data requirements. late collisions on an oversized (>200 meter) repeater network disrupt transmit in progress leading to this condition problem in ethernet dma. 84 0x54 5505024- 5570559 1,6,3 tx ethertx 16coll 16 successive collisions on transmission attempt; transmission aborted. - repeater network is saturated with traffic. problem with collision detection mechanism in the ethernet controller. 85 0x55 5570560- 5636095 3,6,3 tx ethertx crs ethernet carrier sense did not assert in response to transmission. may be reported if transmission is in progress when ethernet is disconnected. - byte code 24-bit code flash code type name description expected conditions unexpected conditions
134 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference error code reference 86 0x56 5636096- 5701631 5,6,3 txquiet ethertx latecoll late collision occurred during transmission. late collisions can occur on a repeater network if network diameter exceeds 200 m. cobranet's collision avoidance mechanism for repeaters allows network diameters up to 2 km. on such networks, late collisions are expected in transmission of control data. this could indicate that the collision detection mechanism of a device is inoperative or a device is mistakenly manually configured for full-duplex operation on a repeater network. - 87 0x57 5701632- 5767167 7,6,3 rxquiet etherrx shortpacke t received an illegally short ethernet packet. collisions are occurring on the network. a transmitter on the network is misbehaving. problem with ethernet controller. 88 0x58 5767168- 5832703 1,7,3 tx sci rxover asynchronous serial receive overrun error. bad serial baud rate selected. - 89 0x59 5832704- 5898239 3,7,3 fatal unused - - - 90 0x5a 5898240- 5963775 5,7,3 tx sci rxframing asynchronous serial receive framing error. wrong serial data format or baud rate selected. - 91 0x5b 5963776- 6029311 7,7,3 fatal unused - - - 93 0x5d 6094848- 6160383 3,8,3 rxfault rxpacket toolong dma reports receiving an illegally long packet. - ethernet dma misbehaving or incorrect handling of receive discard or late collision condition. byte code 24-bit code flash code type name description expected conditions unexpected conditions
cobranet programmer?s reference error code reference ds651pm21 ? copyright 2004 cirru s logic, inc. 135 94 0x5e 6160384- 6225919 5,8,3 tx transmittin g attempt to transmit while we're already transmitting. may be reported during synchronizatio n to network conductor. - 95 0x5f 6225920- 6291455 7,8,3 txfault unprepared transmitted a packet before it was fully prepared. - - 96 0x60 6291456- 6356991 1,1,4 txfault already prepared prepared a packet for transmission that was already previously prepared. - - 97 0x61 6356992- 6422527 3,1,4 txfault already unprepared unprepared a packet for transmission that was already unprepared. - - 98 0x62 6422528- 6488063 5,1,4 txfault queueput txrecycle queue overflow discarding or recycling an un-transmitted packet. - - 99 0x63 6488064- 6553599 7,1,4 fatal beat assertfail programmer assertion failed in beat.asm - - 100 0x64 6553600- 6619135 1,2,4 fatal unused - - - 102 0x66 6684672- 6750207 5,2,4 tx beat busy beat packet is still being updated when it is time to transmit it. transmission is protracted on loss of link. a task is not running or processor cycles exhausted. 103 0x67 6750208- 6815743 7,2,4 fatal snmp assertfail programmer assertion failed in snmp.a - - 104 0x68 6815744- 6881279 1,3,4 fatal unused - - - 106 0x6a 6946816- 7012351 5,3,4 fatal unused - - - 108 0x6c 7077888- 7143423 1,4,4 fatal unused - - - 110 0x6e 7208960- 7274495 5,4,4 fatal unused - - - 111 0x6f 7274496- 7340031 7,4,4 fault order mismatch inconsistency detected in transmission queues. - - byte code 24-bit code flash code type name description expected conditions unexpected conditions
136 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference error code reference 112 0x70 7340032- 7405567 1,5,4 fatal unused - - - 114 0x72 7471104- 7536639 5,5,4 rx no beat header could not find header section in beat packet. - conductor has transmitted an ill formed beat packet. 115 0x73 7536640- 7602175 7,5,4 rx no iso header could not find header section in isochronous data packet. device has transmitted an ill formed isochronous data packet - 116 0x74 7602176- 7667711 1,6,4 fatal unused - - - 117 0x75 7667712- 7733247 3,6,4 tx bridge tx size packet bridge transmission is too big (>1514 bytes) or too small (<14 bytes). host processor has specified a size out of range. - 118 0x76 7733248- 7798783 5,6,4 txquiet hmi address invalid invalid host mi address specified. host processor lost its mind or assumes a different mi version. - 119 0x77 7798784- 7864319 7,6,4 txfault queueput txcontrol queue overflow transmitting control packets. - - 120 0x78 7864320- 7929855 1,7,4 fault ssiptr slip unexpected audio dma pointer location. - problem with audio dma. problems with audio clocks. possible contention of clock signals with external connections. 121 0x79 7929856- 7995391 3,7,4 rx scidata missing serial bridge packet contained no data section. - malformed packet transmitted by another station or packet was truncated on receipt. 122 0x7a 7995392- 8060927 5,7,4 fault frame flooded frame advance processing not completed before beginning of next frame. - - 123 0x7b 8060928- 8126463 7,7,4 tx order locked transmit packets not available at transmission time. synchronizatio n to network scenario. - byte code 24-bit code flash code type name description expected conditions unexpected conditions
cobranet programmer?s reference error code reference ds651pm21 ? copyright 2004 cirru s logic, inc. 137 124 0x7c 8126464- 8191999 1,8,4 fatal unused - - - 126 0x7e 8257536- 8323071 5,8,4 rx sectionlen gth unexpected unexpected packet structure encountered. defective transmitter may spew corrupt packets - 127 0x7f 8323072- 8388607 7,8,4 rxfault etherrx abort unexpected packet receipt aborted; receive abort mechanism unimplemented . - - 128 0x80 8388608- 8454143 1,1,5 rx etherrx internal internal receive error reported ethernet controller (mac). accompanies receiver data overrun in some cases. ethernet receive data transfers deferred by transmissions. problem in ethernet receive dma. 129 0x81 8454144- 8519679 3,1,5 rx ip dropped ip packet dropped on receive. ip packets arriving more frequently than they can be processed. - 130 0x82 8519680- 8585215 5,1,5 fatal unused - - - 131 0x83 8585216- 8650751 7,1,5 rx snmp noparse unable to parse snmp packet. ill-formed snmp packet transmitted by a manager. - 170 0xaa 11141120- 11206655 5,3,6 txfault protocol incompatibl e incompatible cobranet protocol version detected on network. at least one version 1 cobranet protocol device on network. - byte code 24-bit code flash code type name description expected conditions unexpected conditions
138 ? copyright 2004 cirrus lo gic, inc. ds651pm21 cobranet programmer?s reference legal notice 11. legal notice 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 "preliminary" product information describes products that are in production, but for which full characterization data is not ye t available. cirrus logic, inc. and its subsidiaries ("cirrus") believe that the information contained in this document is accur ate and reliable. however, the inform ation is subject to change without notice and is provided "as is" without warranty of any kind (express or implied). customers are advised to obtain the latest version of relevant information to verify, before placing orde rs, that information being relied on is current and complete. all products are sold subject to the terms and conditions of sale sup plied at the time of order acknowledgment, including those pertaining to warranty, patent infringement, and limitation of liability. no responsibility is assumed by cirrus for the use of this information, including use of this information as the basis for manufac ture o r sale of any items, or for infringement of patents or other rights of third parties. this document is the property of cirrus and by furnishing this information, cirrus grants no license, express or implied under any patents, mask work rights, copyrights, trademarks, trade secrets or other intellectual property rights. cirrus owns the copyrights associated with the information contained herein and gives consent for copies to be made of the information only for use within your organization with respect t o cirrus integrated circuits or other products of cirrus. this consent does not extend to other copying such as copying for gener al distribution, advertising or promotional purposes, or for creating any work for resale. certain applications using semiconductor products may involve potential risks of death, personal injury, or severe property or environmental damage (?critical applications?). cirrus products are not designed, authorized or warranted for use in aircraft systems, military a pplications, products surgically implanted into the body, life support products or other critical applications (including medical devices, aircraft systems or components and personal or a utomotive safety or security devices). inclusion of cirrus products in such applications is understood to be fully at the customer?s risk and cirrus disclaims and makes no warranty, express, statutory or implied, including the implied warranties of merchantability and fitness for particular purpose, with regard to any cirrus product that is used in such a manner. if the customer or customer?s customer uses or permits the use of cirrus products in critical a pplications, customer agrees, by such use, to fully indemnify cirrus, its officers, directors, employees, distributors and other agents from any and all liability, including attorneys? fees and costs, that may result from or arise in connection with these uses. cirrus logic, cirrus, the cirrus logic logo designs, cobranet, and cobracad are trademarks of cirrus logic, inc. all other bra nd and product names in this document may be trademarks or service marks of their respective owners. i 2 c is a registered trademark of philips semiconductor. purchase of i 2 c components of cirrus logic, inc., or one of its sublicensed associated companies conveys a license under the philips i 2 c patent rights to use those components in a standard i 2 c system.

▲Up To Search▲

Price & Availability of CM-1

	To Download CM-1 Datasheet File
If you can't view the Datasheet, Please click here to try to view without PDF Reader .